Pular para o conteúdo
Pular para o conteúdo

Referência / SDK

Página traduzida automaticamente

Esta página foi traduzida automaticamente, então pode ter erros ou soar um pouco estranha. A versão em inglês é a fonte da verdade. Ler o original em inglês.

JSON Schemas

Os schemas zod por trás de cada resultado --json e as funções que os transformam nos documentos JSON Schema publicados.

Todo result que a CLI imprime com --json tem um schema zod 4 no SDK, fixado em tempo de compilação ao tipo TypeScript que ele descreve: os mesmos campos, os mesmos campos opcionais e os mesmos tipos de valor, de modo que uma mudança em um sem o outro quebra o build. O parse dele também aceita um valor de um verbatra mais novo: ele permite campos que não lista e os remove do resultado. Os mesmos schemas são publicados como documentos JSON Schema; as URLs deles e a regra de versionamento estão em Códigos de saída e saída JSON.

Schemas de resultado

runSummarySchema

Descreve um RunSummary, o result de translate, watch e import. Publicado como run-summary.json.

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

checkSummarySchema

Descreve um CheckSummary, o result de check. Publicado como check-summary.json.

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

checkFileSummarySchema

Descreve um CheckFileSummary, o result de checkFile. Publicado como check-file-summary.json.

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

diffSummarySchema

Descreve um DiffSummary, o result de diff. Publicado como diff-summary.json.

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

doctorResultSchema

Descreve um DoctorResult, o result de doctor. O campo dataFlow dele é dataFlowManifestSchema, então doctor-result.json faz referência a data-flow-manifest.json em vez de repeti-lo.

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

provenanceReportResultSchema

Descreve um ProvenanceReportResult, o result de provenanceReport, inclusive a variante available: false. Publicado como provenance-report.json.

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

pseudolocalizeResultSchema

Descreve um PseudolocalizeResult, o result de pseudolocalize. Publicado como pseudolocalize-result.json.

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

generateTypesResultSchema

Descreve um GenerateTypesResult, o result de generateTypes. Publicado como generate-types-result.json.

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

extractResultSchema

Descreve um ExtractResult, o result de extract. Publicado como extract-result.json.

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

exportWorkbookResultSchema

Descreve um ExportWorkbookResult, o result de exportWorkbook. Publicado como export-workbook-result.json.

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

importTmxResultSchema

Descreve um ImportTmxResult, o result de importTmx. Publicado como import-tmx-result.json.

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

exportTmxResultSchema

Descreve um ExportTmxResult, o result de exportTmx. Publicado como export-tmx-result.json.

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

runHistoryResultSchema

Descreve um RunHistoryResult, o resultado de runHistory. Publicado como run-history-result.json.

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

Schemas compartilhados

localeSummarySchema

Descreve um LocaleSummary, uma entrada de locales no resumo de uma execução.

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

keyProvenanceSchema

Descreve um KeyProvenance, o origin registrado e o estado de revisão de uma chave.

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

provenanceSummarySchema

Descreve um ProvenanceSummary, as contagens de chaves por origin e por estado de revisão que um locale do check carrega.

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

keyOriginSchema

Descreve um KeyOrigin: quem ou o que escreveu o valor atual de uma chave.

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

Registros do stream

progressEventSchema

Descreve um ProgressEvent, o que onProgress recebe. A CLI imprime alguns desses eventos no stderr com --json. Publicado como progress-event.json.

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

lockWaitEventSchema

Descreve um LockWaitEvent, o que onLockWait recebe enquanto uma execução espera pela trava de escrita de um locale. A CLI o imprime no stderr com type: "lock-wait" adicionado. Publicado como lock-wait-event.json.

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

Publicação

SDK_JSON_SCHEMAS lista todos os documentos que o SDK publica em @verbatra/sdk/schemas/, cada um com o seu name, title, io e o schema zod. JSON_SCHEMA_BASE_URL é https://verbatra.kreitz-webdev.de/schema/v1/. KNOWN_ERROR_CODES lista todos os códigos de erro do SDK, dos provedores e dos adaptadores; o schema do envelope de erro (o objeto JSON da resposta) os oferece como sugestão, mas aceita qualquer código.

renderJsonSchemas

Gera os próprios documentos JSON Schema do verbatra (draft 2020-12) a partir de uma lista de JsonSchemaDocument, indexados pelo nome. Cada um recebe o $id que jsonSchemaUrl dá ao nome dele, uma URL neste site, então use a função apenas para os documentos do verbatra e renderOutputJsonSchema para um schema seu. Um documento de saída permite toda propriedade que não lista; um documento de entrada, como a configuração, mantém os objetos fechados. Um schema que embute um documento de qualquer uma das listas faz referência a ele por URL.

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

Retorna: um documento por entrada de documents, cada um com $schema, $id e title.

renderOutputJsonSchema

Gera o JSON Schema de um schema zod do mesmo modo que os documentos de saída são gerados, sem um $id, por exemplo para o outputSchema de uma ferramenta MCP.

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

Retorna: JsonSchemaObject

jsonSchemaUrl

Retorna a URL pública de um documento publicado, que também é o $id dele: jsonSchemaUrl("run-summary") é https://verbatra.kreitz-webdev.de/schema/v1/run-summary.json.

Assinatura
function jsonSchemaUrl(name: string): string;

Retorna: string

Editar no GitHub

Nesta página