JSON Schemas

Chaque result que la CLI affiche avec --json a un schéma zod 4 dans le SDK, lié à la compilation au type TypeScript qu'il décrit : les mêmes champs, les mêmes champs optionnels et les mêmes types de valeur, si bien que changer l'un sans l'autre fait échouer la compilation. Son parse accepte aussi une valeur venant d'un verbatra plus récent : il admet les champs qu'il ne liste pas et les retire du résultat. Les mêmes schémas sont publiés comme documents JSON Schema ; leurs URL et la règle de versions se trouvent sur Codes de sortie et sortie JSON.

Schémas de résultatCopier le lien vers cette section

runSummarySchemaCopier le lien vers cette section

Décrit un RunSummary, le result de translate, watch et import. Publié sous run-summary.json.

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

checkSummarySchemaCopier le lien vers cette section

Décrit un CheckSummary, le result de check. Publié sous check-summary.json.

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

checkFileSummarySchemaCopier le lien vers cette section

Décrit un CheckFileSummary, le result de checkFile. Publié sous check-file-summary.json.

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

diffSummarySchemaCopier le lien vers cette section

Décrit un DiffSummary, le result de diff. Publié sous diff-summary.json.

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

doctorResultSchemaCopier le lien vers cette section

Décrit un DoctorResult, le result de doctor. Son champ dataFlow est dataFlowManifestSchema, donc doctor-result.json renvoie à data-flow-manifest.json au lieu de le répéter.

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

provenanceReportResultSchemaCopier le lien vers cette section

Décrit un ProvenanceReportResult, le result de provenanceReport, y compris la variante available: false. Publié sous provenance-report.json.

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

pseudolocalizeResultSchemaCopier le lien vers cette section

Décrit un PseudolocalizeResult, le result de pseudolocalize. Publié sous pseudolocalize-result.json.

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

generateTypesResultSchemaCopier le lien vers cette section

Décrit un GenerateTypesResult, le result de generateTypes. Publié sous generate-types-result.json.

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

extractResultSchemaCopier le lien vers cette section

Décrit un ExtractResult, le result de extract. Publié sous extract-result.json.

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

exportWorkbookResultSchemaCopier le lien vers cette section

Décrit un ExportWorkbookResult, le result de exportWorkbook. Publié sous export-workbook-result.json.

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

importTmxResultSchemaCopier le lien vers cette section

Décrit un ImportTmxResult, le result de importTmx. Publié sous import-tmx-result.json.

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

exportTmxResultSchemaCopier le lien vers cette section

Décrit un ExportTmxResult, le result de exportTmx. Publié sous export-tmx-result.json.

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

Schémas partagésCopier le lien vers cette section

localeSummarySchemaCopier le lien vers cette section

Décrit un LocaleSummary, une entrée de locales d'un résumé d'exécution.

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

keyProvenanceSchemaCopier le lien vers cette section

Décrit un KeyProvenance, l'origine enregistrée et l'état de relecture d'une clé.

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

provenanceSummarySchemaCopier le lien vers cette section

Décrit un ProvenanceSummary, les nombres de clés par origine et par état de relecture que porte une locale de check.

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

keyOriginSchemaCopier le lien vers cette section

Décrit un KeyOrigin : qui ou quoi a écrit la valeur actuelle d'une clé.

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

Enregistrements du fluxCopier le lien vers cette section

progressEventSchemaCopier le lien vers cette section

Décrit un ProgressEvent, ce que reçoit onProgress. La CLI affiche certains de ces événements sur stderr avec --json. Publié sous progress-event.json.

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

lockWaitEventSchemaCopier le lien vers cette section

Décrit un LockWaitEvent, ce que reçoit onLockWait pendant qu'une exécution attend le verrou d'écriture d'une locale. La CLI l'affiche sur stderr avec type: "lock-wait" en plus. Publié sous lock-wait-event.json.

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

PublicationCopier le lien vers cette section

SDK_JSON_SCHEMAS liste chaque document que le SDK publie sous @verbatra/sdk/schemas/, chacun avec son name, son title, son io et son schema zod. JSON_SCHEMA_BASE_URL vaut https://verbatra.kreitz-webdev.de/schema/v1/. KNOWN_ERROR_CODES liste chaque code d'erreur du SDK, des fournisseurs et des adaptateurs ; le schéma de l'enveloppe d'erreur les propose comme indication tout en acceptant n'importe quel code.

renderJsonSchemasCopier le lien vers cette section

Génère les documents JSON Schema propres à verbatra (draft 2020-12) à partir d'une liste de JsonSchemaDocument, indexés par nom. Chacun reçoit le $id que jsonSchemaUrl donne à son nom, une URL de ce site : utilise-le donc seulement pour les documents de verbatra, et renderOutputJsonSchema pour un schéma à toi. Un document de sortie accepte toute propriété qu'il ne liste pas ; un document d'entrée, comme la configuration, garde ses objets fermés. Un schéma qui intègre un document de l'une des deux listes y renvoie par URL.

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

Renvoie : un document par entrée de documents, chacun avec $schema, $id et title.

renderOutputJsonSchemaCopier le lien vers cette section

Génère le JSON Schema d'un seul schéma zod comme sont générés les documents de sortie, sans $id, par exemple pour l'outputSchema d'un outil MCP.

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

Renvoie : JsonSchemaObject

jsonSchemaUrlCopier le lien vers cette section

Renvoie l'URL publique d'un document publié, qui est aussi son $id : jsonSchemaUrl("run-summary") vaut https://verbatra.kreitz-webdev.de/schema/v1/run-summary.json.

function jsonSchemaUrl(name: string): string;

Renvoie : string