JSON Schemas

Jedes result, das die CLI unter --json ausgibt, hat ein zod-4-Schema im SDK, das zur Compile-Zeit an den TypeScript-Typ gebunden ist, den es beschreibt: dieselben Felder, dieselben optionalen Felder und dieselben Werttypen. Eine Änderung an einem ohne das andere lässt den Build scheitern. Sein parse akzeptiert auch einen Wert aus einem neueren verbatra: Es erlaubt Felder, die es nicht aufführt, und entfernt sie aus dem Ergebnis. Dieselben Schemas werden als JSON-Schema-Dokumente veröffentlicht; ihre URLs und die Versionsregel stehen unter Exit-Codes und JSON-Ausgabe.

Ergebnis-SchemasLink zu diesem Abschnitt kopieren

runSummarySchemaLink zu diesem Abschnitt kopieren

Beschreibt eine RunSummary, das result von translate, watch und import. Veröffentlicht als run-summary.json.

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

checkSummarySchemaLink zu diesem Abschnitt kopieren

Beschreibt eine CheckSummary, das result von check. Veröffentlicht als check-summary.json.

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

checkFileSummarySchemaLink zu diesem Abschnitt kopieren

Beschreibt eine CheckFileSummary, das result von checkFile. Veröffentlicht als check-file-summary.json.

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

diffSummarySchemaLink zu diesem Abschnitt kopieren

Beschreibt eine DiffSummary, das result von diff. Veröffentlicht als diff-summary.json.

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

doctorResultSchemaLink zu diesem Abschnitt kopieren

Beschreibt ein DoctorResult, das result von doctor. Sein Feld dataFlow ist dataFlowManifestSchema, deshalb verweist doctor-result.json auf data-flow-manifest.json, statt es zu wiederholen.

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

provenanceReportResultSchemaLink zu diesem Abschnitt kopieren

Beschreibt ein ProvenanceReportResult, das result von provenanceReport, einschließlich der Variante available: false. Veröffentlicht als provenance-report.json.

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

pseudolocalizeResultSchemaLink zu diesem Abschnitt kopieren

Beschreibt ein PseudolocalizeResult, das result von pseudolocalize. Veröffentlicht als pseudolocalize-result.json.

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

generateTypesResultSchemaLink zu diesem Abschnitt kopieren

Beschreibt ein GenerateTypesResult, das result von generateTypes. Veröffentlicht als generate-types-result.json.

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

extractResultSchemaLink zu diesem Abschnitt kopieren

Beschreibt ein ExtractResult, das result von extract. Veröffentlicht als extract-result.json.

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

exportWorkbookResultSchemaLink zu diesem Abschnitt kopieren

Beschreibt ein ExportWorkbookResult, das result von exportWorkbook. Veröffentlicht als export-workbook-result.json.

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

importTmxResultSchemaLink zu diesem Abschnitt kopieren

Beschreibt ein ImportTmxResult, das result von importTmx. Veröffentlicht als import-tmx-result.json.

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

exportTmxResultSchemaLink zu diesem Abschnitt kopieren

Beschreibt ein ExportTmxResult, das result von exportTmx. Veröffentlicht als export-tmx-result.json.

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

Gemeinsame SchemasLink zu diesem Abschnitt kopieren

localeSummarySchemaLink zu diesem Abschnitt kopieren

Beschreibt eine LocaleSummary, einen Eintrag in locales einer Run-Summary.

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

keyProvenanceSchemaLink zu diesem Abschnitt kopieren

Beschreibt eine KeyProvenance, die aufgezeichnete Herkunft und den Review-Status eines Keys.

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

provenanceSummarySchemaLink zu diesem Abschnitt kopieren

Beschreibt eine ProvenanceSummary, die Key-Zahlen pro Herkunft und pro Review-Status, die eine Locale von check trägt.

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

keyOriginSchemaLink zu diesem Abschnitt kopieren

Beschreibt einen KeyOrigin: wer oder was den aktuellen Wert eines Keys geschrieben hat.

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

Datensätze im StreamLink zu diesem Abschnitt kopieren

progressEventSchemaLink zu diesem Abschnitt kopieren

Beschreibt ein ProgressEvent, das, was onProgress erhält. Die CLI gibt einige dieser Ereignisse unter --json auf stderr aus. Veröffentlicht als progress-event.json.

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

lockWaitEventSchemaLink zu diesem Abschnitt kopieren

Beschreibt ein LockWaitEvent, das, was onLockWait erhält, während ein Lauf auf die Schreibsperre einer Locale wartet. Die CLI gibt es mit zusätzlichem type: "lock-wait" auf stderr aus. Veröffentlicht als lock-wait-event.json.

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

VeröffentlichenLink zu diesem Abschnitt kopieren

SDK_JSON_SCHEMAS listet jedes Dokument auf, das das SDK unter @verbatra/sdk/schemas/ veröffentlicht, jeweils mit name, title, io und dem zod-schema. JSON_SCHEMA_BASE_URL ist https://verbatra.kreitz-webdev.de/schema/v1/. KNOWN_ERROR_CODES listet jeden Fehlercode des SDK, der Provider und der Adapter; das Schema des Fehler-Envelopes bietet sie als Hinweis an und akzeptiert trotzdem jeden Code.

renderJsonSchemasLink zu diesem Abschnitt kopieren

Erzeugt verbatras eigene JSON-Schema-Dokumente (Draft 2020-12) aus einer Liste von JsonSchemaDocuments, nach Namen geordnet. Jedes erhält die $id, die jsonSchemaUrl für seinen Namen liefert, eine URL dieser Seite. Nutze es also nur für verbatras Dokumente und renderOutputJsonSchema für ein eigenes Schema. Ein Ausgabedokument erlaubt jede Eigenschaft, die es nicht aufführt; ein Eingabedokument wie die Konfiguration behält seine geschlossenen Objekte. Ein Schema, das ein Dokument aus einer der beiden Listen einbettet, verweist per URL darauf.

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

Rückgabe: ein Dokument pro Eintrag in documents, jeweils mit $schema, $id und title.

renderOutputJsonSchemaLink zu diesem Abschnitt kopieren

Erzeugt das JSON Schema eines einzelnen zod-Schemas so, wie die Ausgabedokumente erzeugt werden, ohne $id, etwa für das outputSchema eines MCP-Tools.

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

Rückgabe: JsonSchemaObject

jsonSchemaUrlLink zu diesem Abschnitt kopieren

Gibt die öffentliche URL eines veröffentlichten Dokuments zurück, die zugleich seine $id ist: jsonSchemaUrl("run-summary") ergibt https://verbatra.kreitz-webdev.de/schema/v1/run-summary.json.

function jsonSchemaUrl(name: string): string;

Rückgabe: string