JSON Schemas

Cada result que la CLI imprime con --json tiene un esquema de zod 4 en el SDK, fijado en tiempo de compilación al tipo de TypeScript que describe: los mismos campos, los mismos campos opcionales y los mismos tipos de valor, así que cambiar uno sin el otro hace fallar la compilación. Su parse también acepta un valor de un verbatra más nuevo: admite campos que no enumera y los elimina del resultado. Los mismos esquemas se publican como documentos JSON Schema; sus URL y la regla de versiones están en Códigos de salida y salida JSON.

Esquemas de resultadoCopiar enlace a esta sección

runSummarySchemaCopiar enlace a esta sección

Describe un RunSummary, el result de translate, watch e import. Se publica como run-summary.json.

const runSummarySchema: z.ZodObject<{ ... }, z.core.$strip>;

checkSummarySchemaCopiar enlace a esta sección

Describe un CheckSummary, el result de check. Se publica como check-summary.json.

const checkSummarySchema: z.ZodObject<{ ... }, z.core.$strip>;

checkFileSummarySchemaCopiar enlace a esta sección

Describe un CheckFileSummary, el result de checkFile. Se publica como check-file-summary.json.

const checkFileSummarySchema: z.ZodObject<{ ... }, z.core.$strip>;

diffSummarySchemaCopiar enlace a esta sección

Describe un DiffSummary, el result de diff. Se publica como diff-summary.json.

const diffSummarySchema: z.ZodObject<{ ... }, z.core.$strip>;

doctorResultSchemaCopiar enlace a esta sección

Describe un DoctorResult, el result de doctor. Su campo dataFlow es dataFlowManifestSchema, por eso doctor-result.json remite a data-flow-manifest.json en lugar de repetirlo.

const doctorResultSchema: z.ZodObject<{ ... }, z.core.$strip>;

provenanceReportResultSchemaCopiar enlace a esta sección

Describe un ProvenanceReportResult, el result de provenanceReport, incluida la variante available: false. Se publica como provenance-report.json.

const provenanceReportResultSchema: z.ZodUnion<readonly [...]>;

pseudolocalizeResultSchemaCopiar enlace a esta sección

Describe un PseudolocalizeResult, el result de pseudolocalize. Se publica como pseudolocalize-result.json.

const pseudolocalizeResultSchema: z.ZodObject<{ ... }, z.core.$strip>;

generateTypesResultSchemaCopiar enlace a esta sección

Describe un GenerateTypesResult, el result de generateTypes. Se publica como generate-types-result.json.

const generateTypesResultSchema: z.ZodObject<{ ... }, z.core.$strip>;

extractResultSchemaCopiar enlace a esta sección

Describe un ExtractResult, el result de extract. Se publica como extract-result.json.

const extractResultSchema: z.ZodObject<{ ... }, z.core.$strip>;

exportWorkbookResultSchemaCopiar enlace a esta sección

Describe un ExportWorkbookResult, el result de exportWorkbook. Se publica como export-workbook-result.json.

const exportWorkbookResultSchema: z.ZodObject<{ ... }, z.core.$strip>;

importTmxResultSchemaCopiar enlace a esta sección

Describe un ImportTmxResult, el result de importTmx. Se publica como import-tmx-result.json.

const importTmxResultSchema: z.ZodObject<{ ... }, z.core.$strip>;

exportTmxResultSchemaCopiar enlace a esta sección

Describe un ExportTmxResult, el result de exportTmx. Se publica como export-tmx-result.json.

const exportTmxResultSchema: z.ZodObject<{ ... }, z.core.$strip>;

Esquemas compartidosCopiar enlace a esta sección

localeSummarySchemaCopiar enlace a esta sección

Describe un LocaleSummary, una entrada de locales de un resumen de ejecución.

const localeSummarySchema: z.ZodObject<{ ... }, z.core.$strip>;

keyProvenanceSchemaCopiar enlace a esta sección

Describe un KeyProvenance, el origen registrado y el estado de revisión de una clave.

const keyProvenanceSchema: z.ZodObject<{ ... }, z.core.$strip>;

provenanceSummarySchemaCopiar enlace a esta sección

Describe un ProvenanceSummary, los recuentos de claves por origen y por estado de revisión que lleva un locale de check.

const provenanceSummarySchema: z.ZodObject<{ ... }, z.core.$strip>;

keyOriginSchemaCopiar enlace a esta sección

Describe un KeyOrigin: quién o qué escribió el valor actual de una clave.

const keyOriginSchema: z.ZodEnum<{ ... }>;

Registros del flujoCopiar enlace a esta sección

progressEventSchemaCopiar enlace a esta sección

Describe un ProgressEvent, lo que recibe onProgress. La CLI imprime algunos de estos eventos en stderr con --json. Se publica como progress-event.json.

const progressEventSchema: z.ZodUnion<readonly [...]>;

lockWaitEventSchemaCopiar enlace a esta sección

Describe un LockWaitEvent, lo que recibe onLockWait mientras una ejecución espera el bloqueo de escritura de un locale. La CLI lo imprime en stderr con type: "lock-wait" añadido. Se publica como lock-wait-event.json.

const lockWaitEventSchema: z.ZodObject<{ ... }, z.core.$strip>;

PublicaciónCopiar enlace a esta sección

SDK_JSON_SCHEMAS enumera cada documento que el SDK publica en @verbatra/sdk/schemas/, cada uno con su name, title, io y su schema de zod. JSON_SCHEMA_BASE_URL es https://verbatra.kreitz-webdev.de/schema/v1/. KNOWN_ERROR_CODES enumera cada código de error del SDK, de los proveedores y de los adaptadores; el esquema del envoltorio de error los ofrece como sugerencia y acepta cualquier código.

renderJsonSchemasCopiar enlace a esta sección

Genera los documentos JSON Schema propios de verbatra (draft 2020-12) a partir de una lista de JsonSchemaDocument, indexados por nombre. Cada uno recibe el $id que jsonSchemaUrl da a su nombre, una URL de este sitio, así que úsalo solo para los documentos de verbatra y renderOutputJsonSchema para un esquema propio. Un documento de salida admite cualquier propiedad que no enumera; un documento de entrada, como la configuración, conserva sus objetos cerrados. Un esquema que incluye un documento de cualquiera de las dos listas lo referencia por URL.

function renderJsonSchemas(
  documents: readonly JsonSchemaDocument[],
  references?: readonly JsonSchemaDocument[],
): Readonly<Record<string, JsonSchemaObject>>;

Devuelve: un documento por cada entrada de documents, cada uno con $schema, $id y title.

renderOutputJsonSchemaCopiar enlace a esta sección

Genera el JSON Schema de un solo esquema zod tal como se generan los documentos de salida, sin $id, por ejemplo para el outputSchema de una herramienta MCP.

function renderOutputJsonSchema(schema: z.ZodType): JsonSchemaObject;

Devuelve: JsonSchemaObject

jsonSchemaUrlCopiar enlace a esta sección

Devuelve la URL pública de un documento publicado, que también es su $id: jsonSchemaUrl("run-summary") es https://verbatra.kreitz-webdev.de/schema/v1/run-summary.json.

function jsonSchemaUrl(name: string): string;

Devuelve: string