Files
simstudioai--sim/apps/sim/lib/api/contracts/common.ts
T
wehub-resource-sync d25d482dc2
CI / Migrate Dev DB (push) Has been skipped
CI / Detect Version (push) Has been cancelled
CI / Migrate DB (push) Has been cancelled
CI / Build Dev ECR (./docker/app.Dockerfile, ECR_APP) (push) Has been cancelled
CI / Build Dev ECR (./docker/db.Dockerfile, ECR_MIGRATIONS) (push) Has been cancelled
CI / Build Dev ECR (./docker/pii.Dockerfile, ECR_PII) (push) Has been cancelled
CI / Build Dev ECR (./docker/realtime.Dockerfile, ECR_REALTIME) (push) Has been cancelled
CI / Deploy Trigger.dev (Dev) (push) Has been cancelled
CI / Build AMD64 (./docker/app.Dockerfile, ECR_APP, ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Build AMD64 (./docker/db.Dockerfile, ECR_MIGRATIONS, ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Build AMD64 (./docker/pii.Dockerfile, ECR_PII, ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Build AMD64 (./docker/realtime.Dockerfile, ECR_REALTIME, ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/app.Dockerfile, ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/db.Dockerfile, ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/pii.Dockerfile, ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/realtime.Dockerfile, ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Check Docs Changes (push) Has been cancelled
CI / Process Docs (push) Has been cancelled
CI / Create GitHub Release (push) Has been cancelled
CI / Test and Build (push) Has been cancelled
Publish CLI Package / publish-npm (push) Has been cancelled
Publish Python SDK / publish-pypi (push) Has been cancelled
Publish TypeScript SDK / publish-npm (push) Has been cancelled
chore: import upstream snapshot with attribution
2026-07-13 13:20:55 +08:00

131 lines
3.4 KiB
TypeScript

import { z } from 'zod'
import { jobIdParamsSchema } from '@/lib/api/contracts/primitives'
import { defineRouteContract } from '@/lib/api/contracts/types'
const NO_EMAIL_HEADER_CONTROL_CHARS_REGEX = /^[^\r\n\u0000-\u001F\u007F]+$/
export const helpFormBodySchema = z.object({
subject: z
.string()
.trim()
.min(1, 'Subject is required')
.regex(NO_EMAIL_HEADER_CONTROL_CHARS_REGEX, 'Invalid characters'),
message: z.string().min(1, 'Message is required'),
type: z.enum(['bug', 'feedback', 'feature_request', 'other']),
})
export type HelpFormBody = z.input<typeof helpFormBodySchema>
export const emailPreviewQuerySchema = z.object({
template: z.string().optional(),
})
export const integrationRequestBodySchema = z.object({
integrationName: z
.string()
.trim()
.min(1, 'Integration name is required')
.max(200)
.regex(NO_EMAIL_HEADER_CONTROL_CHARS_REGEX, 'Invalid characters'),
email: z.string().email('A valid email is required'),
useCase: z.string().max(2000).optional(),
})
export type IntegrationRequestBody = z.input<typeof integrationRequestBodySchema>
export const integrationRequestResponseSchema = z.object({
success: z.literal(true),
message: z.string(),
})
export const integrationRequestContract = defineRouteContract({
method: 'POST',
path: '/api/help/integration-request',
body: integrationRequestBodySchema,
response: {
mode: 'json',
schema: integrationRequestResponseSchema,
},
})
export const getAllowedProvidersContract = defineRouteContract({
method: 'GET',
path: '/api/settings/allowed-providers',
response: {
mode: 'json',
schema: z.object({
blacklistedProviders: z.array(z.string()),
}),
},
})
export const getAllowedIntegrationsContract = defineRouteContract({
method: 'GET',
path: '/api/settings/allowed-integrations',
response: {
mode: 'json',
schema: z.object({
// `null` means "no env-derived allowlist" (unrestricted); a non-null
// array narrows the visible integrations.
allowedIntegrations: z.array(z.string()).nullable(),
}),
},
})
export const getVoiceSettingsContract = defineRouteContract({
method: 'GET',
path: '/api/settings/voice',
response: {
mode: 'json',
schema: z.object({
sttAvailable: z.boolean(),
}),
},
})
export const getStarsContract = defineRouteContract({
method: 'GET',
path: '/api/stars',
response: {
mode: 'json',
schema: z.object({
stars: z.string(),
}),
},
})
export const getStatusContract = defineRouteContract({
method: 'GET',
path: '/api/status',
response: {
mode: 'json',
schema: z.object({
status: z.enum(['operational', 'degraded', 'outage', 'maintenance', 'loading', 'error']),
message: z.string(),
url: z.string().url(),
lastUpdated: z.string(),
}),
},
})
const jobStatusSchema = z.enum(['pending', 'processing', 'completed', 'failed'])
const jobStatusResponseSchema = z
.object({
success: z.literal(true),
taskId: z.string(),
status: jobStatusSchema,
metadata: z.record(z.string(), z.unknown()).nullable().optional(),
output: z.unknown().optional(),
error: z.string().optional(),
})
.passthrough()
export const getJobStatusContract = defineRouteContract({
method: 'GET',
path: '/api/jobs/[jobId]',
params: jobIdParamsSchema,
response: {
mode: 'json',
schema: jobStatusResponseSchema,
},
})