Files
simstudioai--sim/apps/sim/lib/api/server/tool-validation.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

76 lines
2.5 KiB
TypeScript

import { type NextRequest, NextResponse } from 'next/server'
import type { AnyApiRouteContract } from '@/lib/api/contracts'
import { parseRequest } from '@/lib/api/server/validation'
export type ToolValidationErrorFormat = 'firstError' | 'details' | 'toolDetails'
interface ToolValidationLogger {
warn(message: string, metadata?: Record<string, unknown>): void
}
export interface ParseToolRequestOptions {
errorFormat?: ToolValidationErrorFormat
logger?: ToolValidationLogger
logMessage?: string
}
/**
* Parse a tool route request against its contract and produce a tool-shaped
* 400 response on validation failure.
*
* Three error envelope variants are supported via `errorFormat`:
* - `firstError` → `{ error: <first issue message> }`
* - `details` → `{ error: 'Invalid request data', details: <issues> }` (default)
* - `toolDetails` → `{ success: false, error: 'Invalid request data', details: <issues> }`
*
* For `toolDetails`, an invalid-JSON body is also wrapped as
* `{ success: false, error: 'Request body must be valid JSON' }` so the caller
* sees a consistent envelope across both failure modes. The other formats fall
* back to the default `{ error: 'Request body must be valid JSON' }` shape.
*/
export async function parseToolRequest<C extends AnyApiRouteContract>(
contract: C,
request: NextRequest,
options: ParseToolRequestOptions = {}
) {
const errorFormat: ToolValidationErrorFormat = options.errorFormat ?? 'details'
return parseRequest(
contract,
request,
{},
{
invalidJsonResponse:
errorFormat === 'toolDetails'
? () =>
NextResponse.json(
{ success: false, error: 'Request body must be valid JSON' },
{ status: 400 }
)
: undefined,
validationErrorResponse: (error) => {
options.logger?.warn(options.logMessage ?? 'Invalid request data', { errors: error.issues })
if (errorFormat === 'firstError') {
return NextResponse.json(
{ error: error.issues[0]?.message ?? 'Invalid request' },
{ status: 400 }
)
}
if (errorFormat === 'toolDetails') {
return NextResponse.json(
{ success: false, error: 'Invalid request data', details: error.issues },
{ status: 400 }
)
}
return NextResponse.json(
{ error: 'Invalid request data', details: error.issues },
{ status: 400 }
)
},
}
)
}