6bf8bebf51
CI / Test and Build (push) Failing after 1s
CI / Migrate Dev DB (push) Has been skipped
CI / Migrate DB (push) Has been skipped
CodeQL / Analyze actions (push) Has been cancelled
CodeQL / Analyze javascript-typescript (push) Has been cancelled
CI / Detect Version (push) Has been cancelled
CI / Detect Desktop Changes (push) Has been cancelled
CI / Build AMD64 (blacksmith-2vcpu-ubuntu-2404, ./docker/cron.Dockerfile, ubuntu-latest, ghcr.io/simstudioai/cron) (push) Has been cancelled
CI / Build AMD64 (blacksmith-2vcpu-ubuntu-2404, ./docker/db.Dockerfile, ECR_MIGRATIONS, ubuntu-latest, ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Build AMD64 (blacksmith-4vcpu-ubuntu-2404, ./docker/pii.Dockerfile, ECR_PII, ubuntu-latest, ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Build AMD64 (blacksmith-4vcpu-ubuntu-2404, ./docker/realtime.Dockerfile, ECR_REALTIME, ubuntu-latest, ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Build AMD64 (blacksmith-8vcpu-ubuntu-2404, ./docker/app.Dockerfile, ECR_APP, linux-x64-8-core, ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (blacksmith-4vcpu-ubuntu-2404-arm, ./docker/cron.Dockerfile, ubuntu-24.04-arm, ghcr.io/simstudioai/cron) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (blacksmith-4vcpu-ubuntu-2404-arm, ./docker/db.Dockerfile, ubuntu-24.04-arm, ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (blacksmith-4vcpu-ubuntu-2404-arm, ./docker/pii.Dockerfile, ubuntu-24.04-arm, ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (blacksmith-4vcpu-ubuntu-2404-arm, ./docker/realtime.Dockerfile, ubuntu-24.04-arm, ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (blacksmith-8vcpu-ubuntu-2404-arm, ./docker/app.Dockerfile, linux-arm64-8-core, ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Check Docs Changes (push) Has been cancelled
Publish CLI Package / publish-npm (push) Has been cancelled
Publish Python SDK / publish-pypi (push) Has been cancelled
CI / Deploy Trigger.dev (Dev) (push) Has been cancelled
Helm Chart / Lint, test, and validate chart (push) Has been cancelled
Helm Chart / Chart version bumped (push) Has been cancelled
Publish TypeScript SDK / publish-npm (push) Has been cancelled
CI / Build Dev ECR (blacksmith-8vcpu-ubuntu-2404, ./docker/app.Dockerfile, ECR_APP, linux-x64-8-core) (push) Has been cancelled
CI / Promote Images (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/cron) (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 / Build Dev ECR (blacksmith-2vcpu-ubuntu-2404, ./docker/db.Dockerfile, ECR_MIGRATIONS, ubuntu-latest) (push) Has been cancelled
CI / Build Dev ECR (blacksmith-4vcpu-ubuntu-2404, ./docker/pii.Dockerfile, ECR_PII, ubuntu-latest) (push) Has been cancelled
CI / Build Dev ECR (blacksmith-4vcpu-ubuntu-2404, ./docker/realtime.Dockerfile, ECR_REALTIME, ubuntu-latest) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Process Docs (push) Has been cancelled
CI / Create GitHub Release (push) Has been cancelled
CI / Check Desktop Signing Secrets (push) Has been cancelled
CI / Desktop Release (push) Has been cancelled
CI / Create Desktop Prerelease (push) Has been cancelled
CI / Desktop Prerelease Build (push) Has been cancelled
CI / Publish Desktop Prerelease (push) Has been cancelled
CI / Prune Desktop Prereleases (push) Has been cancelled
Helm Chart / Install on kind and run helm test (push) Has been cancelled
144 lines
3.8 KiB
TypeScript
144 lines
3.8 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 integrationAvailabilitySchema = z.object({
|
|
type: z.string().min(1),
|
|
state: z.enum(['ready', 'limited', 'unavailable', 'misconfigured']),
|
|
oauthAvailable: z.boolean(),
|
|
})
|
|
|
|
export type IntegrationAvailabilityResponse = z.output<typeof integrationAvailabilitySchema>
|
|
|
|
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(),
|
|
integrationAvailability: z.array(integrationAvailabilitySchema),
|
|
}),
|
|
},
|
|
})
|
|
|
|
export type GetAllowedIntegrationsResponse = z.output<
|
|
typeof getAllowedIntegrationsContract.response.schema
|
|
>
|
|
|
|
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,
|
|
},
|
|
})
|