---
title: "JSON Schema"
description: "すべての --json 結果の元になる zod スキーマと、それを公開用の JSON Schema ドキュメントに変換する関数を説明します。"
type: "reference"
---
# JSON Schema

すべての --json 結果の元になる zod スキーマと、それを公開用の JSON Schema ドキュメントに変換する関数を説明します。

<AvailableFrom version="0.12.0" />

CLI が `--json` で出力するすべての `result` には、SDK に zod 4 のスキーマがあり、コンパイル時に、それが表す TypeScript の型と一致するよう固定されています。フィールド、省略可能なフィールド、値の型が同じなので、片方だけを変更するとビルドが失敗します。その `parse` は、より新しい verbatra の値も受け付けます。列挙されていないフィールドを許可し、結果からは取り除きます。同じスキーマが JSON Schema のドキュメントとして公開されています。その URL とバージョニングの規則は、[終了コードと JSON 出力](https://verbatra.kreitz-webdev.de/ja/docs/cli/output.md#スキーマ)にあります。

## 結果のスキーマ [#結果のスキーマ]

### runSummarySchema [#runsummaryschema]

`translate`、`watch`、`import` の `result` である [`RunSummary`](https://verbatra.kreitz-webdev.de/ja/docs/sdk/run-summary.md) を表します。`run-summary.json` として公開されます。

```ts title="シグネチャ"
const runSummarySchema: z.ZodObject<{ ... }, z.core.$strip>;
```

### checkSummarySchema [#checksummaryschema]

[`check`](https://verbatra.kreitz-webdev.de/ja/docs/sdk/inspect.md#check) の `result` である `CheckSummary` を表します。`check-summary.json` として公開されます。

```ts title="シグネチャ"
const checkSummarySchema: z.ZodObject<{ ... }, z.core.$strip>;
```

### checkFileSummarySchema [#checkfilesummaryschema]

[`checkFile`](https://verbatra.kreitz-webdev.de/ja/docs/sdk/inspect.md#checkfile) の `result` である `CheckFileSummary` を表します。`check-file-summary.json` として公開されます。

```ts title="シグネチャ"
const checkFileSummarySchema: z.ZodObject<{ ... }, z.core.$strip>;
```

### diffSummarySchema [#diffsummaryschema]

[`diff`](https://verbatra.kreitz-webdev.de/ja/docs/sdk/inspect.md#diff) の `result` である `DiffSummary` を表します。`diff-summary.json` として公開されます。

```ts title="シグネチャ"
const diffSummarySchema: z.ZodObject<{ ... }, z.core.$strip>;
```

### doctorResultSchema [#doctorresultschema]

[`doctor`](https://verbatra.kreitz-webdev.de/ja/docs/sdk/inspect.md#doctor) の `result` である `DoctorResult` を表します。`dataFlow` フィールドは [`dataFlowManifestSchema`](https://verbatra.kreitz-webdev.de/ja/docs/sdk/inspect.md#dataflowmanifestschema) なので、`doctor-result.json` は `data-flow-manifest.json` を繰り返さずに参照します。

```ts title="シグネチャ"
const doctorResultSchema: z.ZodObject<{ ... }, z.core.$strip>;
```

### provenanceReportResultSchema [#provenancereportresultschema]

[`provenanceReport`](https://verbatra.kreitz-webdev.de/ja/docs/sdk/inspect.md#provenancereport) の `result` である `ProvenanceReportResult` を表します。`available: false` のバリアントも含みます。`provenance-report.json` として公開されます。

```ts title="シグネチャ"
const provenanceReportResultSchema: z.ZodUnion<readonly [...]>;
```

### pseudolocalizeResultSchema [#pseudolocalizeresultschema]

[`pseudolocalize`](https://verbatra.kreitz-webdev.de/ja/docs/sdk/run.md#pseudolocalize) の `result` である `PseudolocalizeResult` を表します。`pseudolocalize-result.json` として公開されます。

```ts title="シグネチャ"
const pseudolocalizeResultSchema: z.ZodObject<{ ... }, z.core.$strip>;
```

### generateTypesResultSchema [#generatetypesresultschema]

[`generateTypes`](https://verbatra.kreitz-webdev.de/ja/docs/sdk/run.md#generatetypes) の `result` である `GenerateTypesResult` を表します。`generate-types-result.json` として公開されます。

```ts title="シグネチャ"
const generateTypesResultSchema: z.ZodObject<{ ... }, z.core.$strip>;
```

### extractResultSchema [#extractresultschema]

[`extract`](https://verbatra.kreitz-webdev.de/ja/docs/sdk/inspect.md#extract) の `result` である `ExtractResult` を表します。`extract-result.json` として公開されます。

```ts title="シグネチャ"
const extractResultSchema: z.ZodObject<{ ... }, z.core.$strip>;
```

### exportWorkbookResultSchema [#exportworkbookresultschema]

[`exportWorkbook`](https://verbatra.kreitz-webdev.de/ja/docs/sdk/exchange.md#exportworkbook) の `result` である `ExportWorkbookResult` を表します。`export-workbook-result.json` として公開されます。

```ts title="シグネチャ"
const exportWorkbookResultSchema: z.ZodObject<{ ... }, z.core.$strip>;
```

### importTmxResultSchema [#importtmxresultschema]

[`importTmx`](https://verbatra.kreitz-webdev.de/ja/docs/sdk/exchange.md#importtmx) の `result` である `ImportTmxResult` を表します。`import-tmx-result.json` として公開されます。

```ts title="シグネチャ"
const importTmxResultSchema: z.ZodObject<{ ... }, z.core.$strip>;
```

### exportTmxResultSchema [#exporttmxresultschema]

[`exportTmx`](https://verbatra.kreitz-webdev.de/ja/docs/sdk/exchange.md#exporttmx) の `result` である `ExportTmxResult` を表します。`export-tmx-result.json` として公開されます。

```ts title="シグネチャ"
const exportTmxResultSchema: z.ZodObject<{ ... }, z.core.$strip>;
```

### runHistoryResultSchema [#runhistoryresultschema]

[`runHistory`](https://verbatra.kreitz-webdev.de/ja/docs/sdk/history.md#runhistory) の結果である `RunHistoryResult` を表します。`run-history-result.json` として公開されます。

```ts title="シグネチャ"
const runHistoryResultSchema: z.ZodObject<{ ... }, z.core.$strip>;
```

## 共通のスキーマ [#共通のスキーマ]

### localeSummarySchema [#localesummaryschema]

実行サマリーの `locales` の 1 エントリである `LocaleSummary` を表します。

```ts title="シグネチャ"
const localeSummarySchema: z.ZodObject<{ ... }, z.core.$strip>;
```

### keyProvenanceSchema [#keyprovenanceschema]

1 つのキーの記録された出どころとレビューの状態である `KeyProvenance` を表します。

```ts title="シグネチャ"
const keyProvenanceSchema: z.ZodObject<{ ... }, z.core.$strip>;
```

### provenanceSummarySchema [#provenancesummaryschema]

`check` のロケールが持つ、出どころごと、レビューの状態ごとのキーの件数である `ProvenanceSummary` を表します。

```ts title="シグネチャ"
const provenanceSummarySchema: z.ZodObject<{ ... }, z.core.$strip>;
```

### keyOriginSchema [#keyoriginschema]

キーの現在の値を誰が、または何が書いたかを示す `KeyOrigin` を表します。

```ts title="シグネチャ"
const keyOriginSchema: z.ZodEnum<{ ... }>;
```

## ストリームのレコード [#ストリームのレコード]

### progressEventSchema [#progresseventschema]

`onProgress` が受け取るイベントである `ProgressEvent` を表します。CLI は `--json` のとき、これらのイベントの一部を stderr に出力します。`progress-event.json` として公開されます。

```ts title="シグネチャ"
const progressEventSchema: z.ZodUnion<readonly [...]>;
```

### lockWaitEventSchema [#lockwaiteventschema]

実行がロケールの書き込みロックを待つ間に `onLockWait` が受け取るイベントである `LockWaitEvent` を表します。CLI は `type: "lock-wait"` を加えて stderr に出力します。`lock-wait-event.json` として公開されます。

```ts title="シグネチャ"
const lockWaitEventSchema: z.ZodObject<{ ... }, z.core.$strip>;
```

## 公開 [#公開]

`SDK_JSON_SCHEMAS` は、`@verbatra/sdk/schemas/` の下で SDK が公開するすべてのドキュメントを、それぞれの `name`、`title`、`io`、zod の `schema` とともに一覧にしたものです。`JSON_SCHEMA_BASE_URL` は `https://verbatra.kreitz-webdev.de/schema/v1/` です。`KNOWN_ERROR_CODES` は、SDK、プロバイダー、アダプターのすべてのエラーコードを一覧にしたものです。エラーエンベロープのスキーマは、これらをヒントとして示しつつ、どのコードも受け付けます。

### renderJsonSchemas [#renderjsonschemas]

`JsonSchemaDocument` のリストから、verbatra 自身の JSON Schema ドキュメント（draft 2020-12）を、名前をキーにして生成します。各ドキュメントには、`jsonSchemaUrl` がその名前に対して返す `$id`（このサイトの URL）が付きます。そのため、これは verbatra のドキュメント専用に使い、自分のスキーマには `renderOutputJsonSchema` を使ってください。出力ドキュメントは、列挙されていないプロパティをすべて許可します。設定のような入力ドキュメントは、閉じたオブジェクトのままです。どちらかのリストのドキュメントを埋め込むスキーマは、そのドキュメントを URL で参照します。

```ts title="シグネチャ"
function renderJsonSchemas(
  documents: readonly JsonSchemaDocument[],
  references?: readonly JsonSchemaDocument[],
): Readonly<Record<string, JsonSchemaObject>>;
```

**戻り値**：`documents` の各エントリに対応する 1 つのドキュメントで、それぞれ `$schema`、`$id`、`title` を持ちます。

### renderOutputJsonSchema [#renderoutputjsonschema]

1 つの zod スキーマの JSON Schema を、出力ドキュメントと同じ方法で、`$id` なしで生成します。たとえば MCP ツールの `outputSchema` に使えます。

```ts title="シグネチャ"
function renderOutputJsonSchema(schema: z.ZodType): JsonSchemaObject;
```

**戻り値**：`JsonSchemaObject`

### jsonSchemaUrl [#jsonschemaurl]

公開されているドキュメントの公開 URL を返します。これは `$id` でもあります。`jsonSchemaUrl("run-summary")` は `https://verbatra.kreitz-webdev.de/schema/v1/run-summary.json` です。

```ts title="シグネチャ"
function jsonSchemaUrl(name: string): string;
```

**戻り値**：`string`
