mirror of
https://github.com/fluxerapp/fluxer
synced 2026-10-18 13:35:42 +09:00
refactor(schema): simplify validation and OpenAPI generation (#2709)
This commit is contained in:
Hampus authored and GitHub committed
1 parent
4bc5593f9f
commit
de1fd95a99
510 files changed
+29494
-36131
No files matched your search
@@ -1,6 +1,7 @@
|
||||
// SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
|
||||
import {SsoStatusResponse} from '@fluxer/schema/src/domains/auth/AuthSchemas';
|
||||
import {createNamedStringLiteralUnion} from '@fluxer/schema/src/primitives/SchemaPrimitives';
|
||||
import {z} from 'zod';
|
||||
|
||||
const LimitFilterResponse = z.object({
|
||||
@@ -23,116 +24,165 @@ const LimitConfigResponse = z.object({
|
||||
defaultsHash: z.string().describe('Hash of the default limit values for cache invalidation'),
|
||||
});
|
||||
|
||||
const AppPublicConfigResponse = z.object({
|
||||
branding: z
|
||||
.object({
|
||||
product_name: z.string().describe('Public product name shown by client applications'),
|
||||
icon_url: z.string().nullable().describe('Optional image URL for the full application icon'),
|
||||
symbol_url: z.string().nullable().describe('Optional image URL for the compact application symbol'),
|
||||
logo_url: z.string().nullable().describe('Optional image URL for the application logo'),
|
||||
wordmark_url: z.string().nullable().describe('Optional image URL for the application wordmark'),
|
||||
favicon_url: z.string().nullable().describe('Optional favicon URL for browser metadata'),
|
||||
theme_color: z.string().nullable().describe('Optional browser theme color'),
|
||||
})
|
||||
.describe('Branding values safe to expose to clients'),
|
||||
setup: z
|
||||
.object({
|
||||
configured: z.boolean().describe('Whether the instance administrator has completed initial setup'),
|
||||
admin_url: z.string().nullable().describe('Admin panel URL to continue instance setup'),
|
||||
})
|
||||
.describe('Initial setup state for self-hosted instances'),
|
||||
legal: z
|
||||
.object({
|
||||
terms_url: z.string().nullable().describe('Optional public terms of service URL for account registration'),
|
||||
privacy_url: z.string().nullable().describe('Optional public privacy policy URL for account registration'),
|
||||
})
|
||||
.describe('Optional legal document URLs shown during public registration'),
|
||||
registration: z
|
||||
.object({
|
||||
collect_date_of_birth: z.boolean().describe('Whether public registration collects and validates date of birth'),
|
||||
})
|
||||
.describe('Public registration field collection policy'),
|
||||
export const InstanceBrandingSchema = z
|
||||
.object({
|
||||
product_name: z.string().describe('Public product name shown by client applications'),
|
||||
icon_url: z.string().nullable().describe('Optional image URL for the full application icon'),
|
||||
symbol_url: z.string().nullable().describe('Optional image URL for the compact application symbol'),
|
||||
logo_url: z.string().nullable().describe('Optional image URL for the application logo'),
|
||||
wordmark_url: z.string().nullable().describe('Optional image URL for the application wordmark'),
|
||||
favicon_url: z.string().nullable().describe('Optional favicon URL for browser metadata'),
|
||||
theme_color: z.string().nullable().describe('Optional browser theme color'),
|
||||
})
|
||||
.describe('Branding values safe to expose to clients');
|
||||
export type InstanceBranding = z.infer<typeof InstanceBrandingSchema>;
|
||||
|
||||
export const InstanceSetupSchema = z
|
||||
.object({
|
||||
configured: z.boolean().describe('Whether the instance administrator has completed initial setup'),
|
||||
admin_url: z.string().nullable().describe('Admin panel URL to continue instance setup'),
|
||||
})
|
||||
.describe('Initial setup state for self-hosted instances');
|
||||
export type InstanceSetup = z.infer<typeof InstanceSetupSchema>;
|
||||
|
||||
const InstanceLegalSchema = z
|
||||
.object({
|
||||
terms_url: z.string().nullable().describe('Optional public terms of service URL for account registration'),
|
||||
privacy_url: z.string().nullable().describe('Optional public privacy policy URL for account registration'),
|
||||
})
|
||||
.describe('Optional legal document URLs shown during public registration');
|
||||
|
||||
const InstanceAppRegistrationSchema = z
|
||||
.object({
|
||||
collect_date_of_birth: z.boolean().describe('Whether public registration collects and validates date of birth'),
|
||||
})
|
||||
.describe('Public registration field collection policy');
|
||||
|
||||
export const InstanceAppPublicSchema = z.object({
|
||||
branding: InstanceBrandingSchema,
|
||||
setup: InstanceSetupSchema,
|
||||
legal: InstanceLegalSchema,
|
||||
registration: InstanceAppRegistrationSchema,
|
||||
});
|
||||
export type InstanceAppPublic = z.infer<typeof InstanceAppPublicSchema>;
|
||||
|
||||
export const InstanceCaptchaProviderSchema = z.enum(['hcaptcha', 'turnstile', 'none']);
|
||||
export type InstanceCaptchaProvider = z.infer<typeof InstanceCaptchaProviderSchema>;
|
||||
|
||||
export const InstanceEndpointsSchema = z
|
||||
.object({
|
||||
api: z.string().describe('Base URL for authenticated API requests'),
|
||||
api_client: z.string().describe('Base URL for client API requests'),
|
||||
api_public: z.string().describe('Base URL for public API requests'),
|
||||
gateway: z.string().describe('WebSocket URL for the gateway'),
|
||||
media: z.string().describe('Base URL for the media proxy'),
|
||||
static_cdn: z.string().describe('Base URL for static assets (avatars, emojis, etc.)'),
|
||||
marketing: z.string().describe('Base URL for the marketing website'),
|
||||
admin: z.string().describe('Base URL for the admin panel'),
|
||||
invite: z.string().describe('Base URL for invite links'),
|
||||
gift: z.string().describe('Base URL for gift links'),
|
||||
webapp: z.string().describe('Base URL for the web application'),
|
||||
})
|
||||
.describe('Endpoint URLs for various services');
|
||||
export type InstanceEndpoints = z.infer<typeof InstanceEndpointsSchema>;
|
||||
|
||||
export const InstanceCaptchaSchema = z
|
||||
.object({
|
||||
provider: InstanceCaptchaProviderSchema.describe('Captcha provider name (hcaptcha, turnstile, none)'),
|
||||
hcaptcha_site_key: z.string().nullable().describe('hCaptcha site key if using hCaptcha'),
|
||||
turnstile_site_key: z.string().nullable().describe('Cloudflare Turnstile site key if using Turnstile'),
|
||||
})
|
||||
.describe('Captcha configuration');
|
||||
export type InstanceCaptcha = z.infer<typeof InstanceCaptchaSchema>;
|
||||
|
||||
export const InstanceFeaturesSchema = z
|
||||
.object({
|
||||
voice_enabled: z.boolean().describe('Whether voice/video calling is enabled'),
|
||||
stripe_enabled: z.boolean().describe('Whether Stripe payments are enabled'),
|
||||
self_hosted: z.boolean().describe('Whether this is a self-hosted instance'),
|
||||
presigned_attachment_uploads: z.boolean().describe('Whether clients can request presigned attachment upload URLs'),
|
||||
emails_enabled: z.boolean().describe('Whether the instance sends emails (verification, password reset, etc.)'),
|
||||
})
|
||||
.describe('Feature flags for this instance');
|
||||
export type InstanceFeatures = z.infer<typeof InstanceFeaturesSchema>;
|
||||
|
||||
export const InstanceGifSchema = z
|
||||
.object({
|
||||
provider: z.string().describe('Stable machine name of the active GIF provider.'),
|
||||
display_name: z.string().describe('Human-readable provider name shown in the UI'),
|
||||
attribution_required: z
|
||||
.boolean()
|
||||
.describe('Whether the client must show a "Powered by …" watermark for this provider'),
|
||||
})
|
||||
.describe('GIF provider configuration for clients');
|
||||
export type InstanceGif = z.infer<typeof InstanceGifSchema>;
|
||||
|
||||
export const InstanceSsoSchema = SsoStatusResponse.describe('Single sign-on configuration');
|
||||
export type InstanceSso = z.infer<typeof InstanceSsoSchema>;
|
||||
|
||||
export const InstanceRegistrationModeSchema = createNamedStringLiteralUnion(
|
||||
[
|
||||
['open', 'open', 'Anyone can register'],
|
||||
['approval', 'approval', 'Anyone can register, but admins must approve new accounts'],
|
||||
['closed', 'closed', 'Public registration is closed'],
|
||||
],
|
||||
'Registration mode',
|
||||
);
|
||||
export type InstanceRegistrationMode = z.infer<typeof InstanceRegistrationModeSchema>;
|
||||
|
||||
export const InstanceRegistrationSchema = z
|
||||
.object({
|
||||
mode: InstanceRegistrationModeSchema.describe('Public registration mode for this instance'),
|
||||
admin_registration_urls_enabled: z.boolean().describe('Whether admin-issued registration URLs are accepted'),
|
||||
})
|
||||
.describe('Registration policy for this instance');
|
||||
export type InstanceRegistration = z.infer<typeof InstanceRegistrationSchema>;
|
||||
|
||||
export const InstanceCommunitySchema = z
|
||||
.object({
|
||||
single_community: z
|
||||
.boolean()
|
||||
.describe('Whether this instance runs as a single community that every user automatically joins'),
|
||||
single_community_guild_id: z
|
||||
.string()
|
||||
.nullable()
|
||||
.describe('The stock community guild ID when single-community mode is enabled'),
|
||||
direct_messages_disabled: z
|
||||
.boolean()
|
||||
.describe('Whether direct messages and friend requests are disabled instance-wide'),
|
||||
})
|
||||
.describe('Community topology and direct-message policy for this instance');
|
||||
export type InstanceCommunity = z.infer<typeof InstanceCommunitySchema>;
|
||||
|
||||
export const InstanceServicesSchema = z
|
||||
.object({
|
||||
gif_enabled: z.boolean().describe('Whether the GIF picker is enabled for this instance'),
|
||||
youtube_enabled: z.boolean().describe('Whether YouTube link enrichment is enabled for this instance'),
|
||||
bluesky_enabled: z.boolean().describe('Whether Bluesky profile connections are enabled for this instance'),
|
||||
})
|
||||
.describe('Optional third-party service integrations enabled for this instance');
|
||||
export type InstanceServices = z.infer<typeof InstanceServicesSchema>;
|
||||
|
||||
export const InstancePushSchema = z
|
||||
.object({
|
||||
public_vapid_key: z.string().nullable().describe('VAPID public key for web push notifications'),
|
||||
})
|
||||
.describe('Push notification configuration');
|
||||
export type InstancePush = z.infer<typeof InstancePushSchema>;
|
||||
|
||||
export const WellKnownFluxerResponse = z.object({
|
||||
api_code_version: z.number().int().describe('Version of the API server code'),
|
||||
endpoints: z
|
||||
.object({
|
||||
api: z.string().describe('Base URL for authenticated API requests'),
|
||||
api_client: z.string().describe('Base URL for client API requests'),
|
||||
api_public: z.string().describe('Base URL for public API requests'),
|
||||
gateway: z.string().describe('WebSocket URL for the gateway'),
|
||||
media: z.string().describe('Base URL for the media proxy'),
|
||||
static_cdn: z.string().describe('Base URL for static assets (avatars, emojis, etc.)'),
|
||||
marketing: z.string().describe('Base URL for the marketing website'),
|
||||
admin: z.string().describe('Base URL for the admin panel'),
|
||||
invite: z.string().describe('Base URL for invite links'),
|
||||
gift: z.string().describe('Base URL for gift links'),
|
||||
webapp: z.string().describe('Base URL for the web application'),
|
||||
})
|
||||
.describe('Endpoint URLs for various services'),
|
||||
captcha: z
|
||||
.object({
|
||||
provider: z.string().describe('Captcha provider name (hcaptcha, turnstile, none)'),
|
||||
hcaptcha_site_key: z.string().nullable().describe('hCaptcha site key if using hCaptcha'),
|
||||
turnstile_site_key: z.string().nullable().describe('Cloudflare Turnstile site key if using Turnstile'),
|
||||
})
|
||||
.describe('Captcha configuration'),
|
||||
features: z
|
||||
.object({
|
||||
voice_enabled: z.boolean().describe('Whether voice/video calling is enabled'),
|
||||
stripe_enabled: z.boolean().describe('Whether Stripe payments are enabled'),
|
||||
self_hosted: z.boolean().describe('Whether this is a self-hosted instance'),
|
||||
presigned_attachment_uploads: z
|
||||
.boolean()
|
||||
.describe('Whether clients can request presigned attachment upload URLs'),
|
||||
emails_enabled: z.boolean().describe('Whether the instance sends emails (verification, password reset, etc.)'),
|
||||
})
|
||||
.describe('Feature flags for this instance'),
|
||||
gif: z
|
||||
.object({
|
||||
provider: z.string().describe('Stable machine name of the active GIF provider.'),
|
||||
display_name: z.string().describe('Human-readable provider name shown in the UI'),
|
||||
attribution_required: z
|
||||
.boolean()
|
||||
.describe('Whether the client must show a "Powered by …" watermark for this provider'),
|
||||
})
|
||||
.describe('GIF provider configuration for clients'),
|
||||
sso: SsoStatusResponse.describe('Single sign-on configuration'),
|
||||
registration: z
|
||||
.object({
|
||||
mode: z.enum(['open', 'approval', 'closed']).describe('Public registration mode for this instance'),
|
||||
admin_registration_urls_enabled: z.boolean().describe('Whether admin-issued registration URLs are accepted'),
|
||||
})
|
||||
.describe('Registration policy for this instance'),
|
||||
community: z
|
||||
.object({
|
||||
single_community: z
|
||||
.boolean()
|
||||
.describe('Whether this instance runs as a single community that every user automatically joins'),
|
||||
single_community_guild_id: z
|
||||
.string()
|
||||
.nullable()
|
||||
.describe('The stock community guild ID when single-community mode is enabled'),
|
||||
direct_messages_disabled: z
|
||||
.boolean()
|
||||
.describe('Whether direct messages and friend requests are disabled instance-wide'),
|
||||
})
|
||||
.describe('Community topology and direct-message policy for this instance'),
|
||||
services: z
|
||||
.object({
|
||||
gif_enabled: z.boolean().describe('Whether the GIF picker is enabled for this instance'),
|
||||
youtube_enabled: z.boolean().describe('Whether YouTube link enrichment is enabled for this instance'),
|
||||
bluesky_enabled: z.boolean().describe('Whether Bluesky profile connections are enabled for this instance'),
|
||||
})
|
||||
.describe('Optional third-party service integrations enabled for this instance'),
|
||||
endpoints: InstanceEndpointsSchema,
|
||||
captcha: InstanceCaptchaSchema,
|
||||
features: InstanceFeaturesSchema,
|
||||
gif: InstanceGifSchema,
|
||||
sso: InstanceSsoSchema,
|
||||
registration: InstanceRegistrationSchema,
|
||||
community: InstanceCommunitySchema,
|
||||
services: InstanceServicesSchema,
|
||||
limits: LimitConfigResponse.describe('Limit configuration with rules and trait definitions'),
|
||||
push: z
|
||||
.object({
|
||||
public_vapid_key: z.string().nullable().describe('VAPID public key for web push notifications'),
|
||||
})
|
||||
.describe('Push notification configuration'),
|
||||
app_public: AppPublicConfigResponse.describe('Public application configuration for client-side features'),
|
||||
push: InstancePushSchema,
|
||||
app_public: InstanceAppPublicSchema.describe('Public application configuration for client-side features'),
|
||||
});
|
||||
|
||||
export type WellKnownFluxerResponse = z.infer<typeof WellKnownFluxerResponse>;
|
||||
Reference in new issue
Block a user