Files
WeHub Mirror 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
WeHub snapshot of cb28d14c6f2c081de7a0d8729a8c816c9adef67a
2026-08-10 11:17:50 +08:00

271 lines
8.6 KiB
TypeScript

import { ApiClientError } from '@/lib/api/client/errors'
import type {
AnyApiRouteContract,
ApiSchema,
ContractBodyInput,
ContractHeadersInput,
ContractJsonResponse,
ContractParamsInput,
ContractQueryInput,
EmptySchemaOutput,
} from '@/lib/api/contracts'
// Tuple-wrapped to suppress distributive conditionals: when `Value` is a
// union (e.g. a discriminated union body), naked `Value extends undefined`
// distributes and produces `{ body: A } | { body: B }` instead of
// `{ body: A | B }`. The `[Value] extends [undefined]` form preserves the
// union as-is. See request.test.ts for repro and rationale.
type MaybeField<Key extends string, Value> = [Value] extends [undefined]
? { [K in Key]?: never }
: { [K in Key]: Value }
export type ApiClientRequest<C extends AnyApiRouteContract> = MaybeField<
'params',
ContractParamsInput<C>
> &
MaybeField<'query', ContractQueryInput<C>> &
MaybeField<'body', ContractBodyInput<C>> &
MaybeField<'headers', ContractHeadersInput<C>> & {
signal?: AbortSignal
}
export interface ApiRawRequestOptions {
cache?: RequestCache
headers?: Record<string, string>
}
function replacePathParams(path: string, params: unknown): string {
if (!params || typeof params !== 'object') return path
const values = params as Record<string, unknown>
return path.replace(
/\[\[?(\.\.\.)?([^\][]+)\]\]?/g,
(match, rest: string | undefined, key: string) => {
const value = values[key]
const isOptionalCatchAll = match.startsWith('[[...')
if (rest && Array.isArray(value)) {
return value.map((item) => encodeURIComponent(String(item))).join('/')
}
if (value === undefined && isOptionalCatchAll) return ''
if (typeof value !== 'string' && typeof value !== 'number' && typeof value !== 'boolean') {
throw new Error(`Missing route param "${key}"`)
}
return encodeURIComponent(String(value))
}
)
}
function appendQuery(path: string, query: unknown): string {
if (!query || typeof query !== 'object') return path
const searchParams = new URLSearchParams()
for (const [key, value] of Object.entries(query as Record<string, unknown>)) {
if (value === undefined || value === null || value === '') continue
if (Array.isArray(value)) {
// An array of objects (e.g. a SortSpec) is not repeat-append-able — each
// item would stringify to "[object Object]" and silently corrupt the
// request (the knowledge tagFilters bug). Encode the WHOLE array as one
// JSON string param, mirroring how plain objects are sent below; the
// server-side contract decodes it. Scalar arrays keep repeat-append.
if (value.some((item) => item !== null && typeof item === 'object')) {
searchParams.set(key, JSON.stringify(value))
continue
}
for (const item of value) {
if (item === undefined || item === null || item === '') continue
searchParams.append(key, String(item))
}
continue
}
if (typeof value === 'object') {
searchParams.set(key, JSON.stringify(value))
continue
}
searchParams.set(key, String(value))
}
const queryString = searchParams.toString()
if (!queryString) return path
return `${path}${path.includes('?') ? '&' : '?'}${queryString}`
}
function buildHeaders(headers: unknown, hasBody: boolean): Record<string, string> {
const output: Record<string, string> = {}
if (hasBody) {
output['Content-Type'] = 'application/json'
}
if (headers && typeof headers === 'object') {
for (const [key, value] of Object.entries(headers as Record<string, unknown>)) {
if (typeof value === 'string') output[key] = value
}
}
return output
}
function parseOptionalSchema<S extends ApiSchema | undefined>(
schema: S,
value: unknown
): EmptySchemaOutput<S> {
if (!schema) return undefined as EmptySchemaOutput<S>
return schema.parse(value) as EmptySchemaOutput<S>
}
async function readResponseBody(response: Response): Promise<{ parsed: unknown; raw?: string }> {
const text = await response.text()
if (!text) return { parsed: undefined }
try {
return { parsed: JSON.parse(text) as unknown, raw: text }
} catch {
return { parsed: text, raw: text }
}
}
function messageFromErrorBody(body: unknown, fallback: string): string {
if (body && typeof body === 'object') {
const record = body as Record<string, unknown>
const message = record.message ?? record.error
if (typeof message === 'string' && message.length > 0) return message
}
return fallback
}
function codeFromErrorBody(body: unknown): string | undefined {
if (body && typeof body === 'object') {
const record = body as Record<string, unknown>
if (typeof record.code === 'string' && record.code.length > 0) return record.code
}
return undefined
}
function isSchemaValidationError(error: unknown): boolean {
return Boolean(
error &&
typeof error === 'object' &&
'issues' in error &&
Array.isArray((error as { issues?: unknown }).issues)
)
}
/**
* Compresses a ZodError's issues into a short, readable "field: reason" summary
* so a failed response tells you which field was wrong instead of a bare
* "Response failed contract validation".
*/
function summarizeSchemaIssues(error: unknown): string {
const issues = (error as { issues?: unknown }).issues
if (!Array.isArray(issues)) return ''
const summary = issues
.slice(0, 3)
.map((issue) => {
const path = Array.isArray(issue?.path) ? issue.path.join('.') : ''
const message = typeof issue?.message === 'string' ? issue.message : 'invalid'
return path ? `${path}: ${message}` : message
})
.join('; ')
const extra = issues.length > 3 ? ` (+${issues.length - 3} more)` : ''
return summary ? `${summary}${extra}` : ''
}
export async function requestJson<C extends AnyApiRouteContract>(
contract: C,
input: ApiClientRequest<C>
): Promise<ContractJsonResponse<C>> {
if (contract.response.mode !== 'json') {
throw new Error(`Contract ${contract.method} ${contract.path} does not declare a JSON response`)
}
const parsedParams = parseOptionalSchema(contract.params, input.params)
const parsedQuery = parseOptionalSchema(contract.query, input.query)
const parsedBody = parseOptionalSchema(contract.body, input.body)
const parsedHeaders = parseOptionalSchema(contract.headers, input.headers)
const url = appendQuery(replacePathParams(contract.path, parsedParams), parsedQuery)
const hasBody = parsedBody !== undefined && contract.method !== 'GET'
const response = await fetch(url, {
method: contract.method,
headers: buildHeaders(parsedHeaders, hasBody),
body: hasBody ? JSON.stringify(parsedBody) : undefined,
signal: input.signal,
})
const { parsed, raw } = await readResponseBody(response)
if (!response.ok) {
throw new ApiClientError({
status: response.status,
message: messageFromErrorBody(parsed, `Request failed with ${response.status}`),
body: parsed,
rawBody: raw,
code: codeFromErrorBody(parsed),
})
}
try {
return contract.response.schema.parse(parsed) as ContractJsonResponse<C>
} catch (error) {
if (isSchemaValidationError(error)) {
const details = summarizeSchemaIssues(error)
throw new ApiClientError({
status: response.status,
message: details
? `Response failed contract validation — ${details}`
: 'Response failed contract validation',
body: parsed,
rawBody: raw,
})
}
throw error
}
}
export async function requestRaw<C extends AnyApiRouteContract>(
contract: C,
input: ApiClientRequest<C>,
options: ApiRawRequestOptions = {}
): Promise<Response> {
const parsedParams = parseOptionalSchema(contract.params, input.params)
const parsedQuery = parseOptionalSchema(contract.query, input.query)
const parsedBody = parseOptionalSchema(contract.body, input.body)
const parsedHeaders = parseOptionalSchema(contract.headers, input.headers)
const url = appendQuery(replacePathParams(contract.path, parsedParams), parsedQuery)
const hasBody = parsedBody !== undefined && contract.method !== 'GET'
const headers = {
...buildHeaders(parsedHeaders, hasBody),
...options.headers,
}
const response = await fetch(url, {
method: contract.method,
headers,
body: hasBody ? JSON.stringify(parsedBody) : undefined,
signal: input.signal,
cache: options.cache,
})
if (!response.ok) {
const { parsed, raw } = await readResponseBody(response)
throw new ApiClientError({
status: response.status,
message: messageFromErrorBody(parsed, `Request failed with ${response.status}`),
body: parsed,
rawBody: raw,
})
}
return response
}