@verbatra/sdk 0.12.0 → 0.13.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (15) hide show
  1. package/README.md +6 -5
  2. package/dist/index.cjs +4567 -440
  3. package/dist/index.cjs.map +1 -1
  4. package/dist/index.d.cts +1554 -34
  5. package/dist/index.d.ts +1554 -34
  6. package/dist/index.js +4552 -450
  7. package/dist/index.js.map +1 -1
  8. package/dist/schemas/check-file-summary.json +16 -0
  9. package/dist/schemas/check-summary.json +16 -0
  10. package/dist/schemas/data-flow-manifest.json +1 -0
  11. package/dist/schemas/doctor-result.json +1 -0
  12. package/dist/schemas/export-workbook-result.json +16 -0
  13. package/dist/schemas/run-history-result.json +346 -0
  14. package/dist/schemas/run-summary.json +1 -0
  15. package/package.json +15 -14
package/README.md CHANGED
@@ -33,7 +33,7 @@
33
33
  npm install --save-dev @verbatra/sdk
34
34
  ```
35
35
 
36
- Needs Node.js `^22.18.0 || >=24`. The package ships its own TypeScript types and a CommonJS and an ES module build.
36
+ Needs Node.js `^22.22.0 || >=24`. The package ships its own TypeScript types and a CommonJS and an ES module build.
37
37
 
38
38
  ## Quick start
39
39
 
@@ -83,10 +83,11 @@ Every flow takes an `input` object and an optional `deps` object for injecting t
83
83
  | Area | Exports | Reference |
84
84
  | --- | --- | --- |
85
85
  | Run | `translate`, `watch`, `pseudolocalize`, `generateTypes`, `resolveDryRun` | [Run](https://verbatra.kreitz-webdev.de/docs/sdk/run) |
86
- | Inspect, read-only | `check`, `checkFile`, `diff`, `doctor`, `dataFlow`, `extract`, `lockState`, `runStatus`, `reviewQueue`, `provenanceReport`, `localeIntegrity` | [Inspect](https://verbatra.kreitz-webdev.de/docs/sdk/inspect) |
87
- | Single keys and review | `keyValue`, `keyContext`, `keyIntegrity`, `localeValues`, `editEntry`, `retranslateEntry`, `approveEntry`, `rejectEntry`, `approveLocale`, `approveEntries`, `rejectEntries`, `retranslateEntries`, `localeHistory` | [Review](https://verbatra.kreitz-webdev.de/docs/sdk/review) |
88
- | Handoff | `exportWorkbook`, `importWorkbook`, `exportTmx`, `importTmx`, `readLocaleFileSnapshot`, `diffLocaleSnapshots`, `createLocalePathResolver` | [Exchange](https://verbatra.kreitz-webdev.de/docs/sdk/exchange) |
89
- | Config and glossary | `defineConfig`, `loadConfig`, `loadConfigWithMeta`, `detectProject`, `verbatraConfigSchema`, `readGlossaryFile`, `updateGlossaryTerm`, `glossaryHits`, `glossaryDraftCheck`, `isMachineTranslationEnabled`, `assertMachineTranslationEnabled` | [Config](https://verbatra.kreitz-webdev.de/docs/sdk/config) |
86
+ | Inspect, read-only | `check`, `checkFile`, `diff`, `doctor`, `dataFlow`, `extract`, `lockState`, `runStatus`, `reviewQueue`, `provenanceReport`, `localeIntegrity`, `previewIcuMessage` | [Inspect](https://verbatra.kreitz-webdev.de/docs/sdk/inspect) |
87
+ | Single keys and review | `keyValue`, `keyContext`, `keyIntegrity`, `localeValues`, `editEntry`, `retranslateEntry`, `approveEntry`, `rejectEntry`, `approveLocale`, `approveEntries`, `rejectEntries`, `retranslateEntries`, `localeHistory`, `localeGitStatus`, `localeGitDiff`, `previewValueReplace`, `applyValueReplace` | [Review](https://verbatra.kreitz-webdev.de/docs/sdk/review), [Edit](https://verbatra.kreitz-webdev.de/docs/sdk/edit) |
88
+ | Key and run history | `keyHistory`, `runHistory` | [History](https://verbatra.kreitz-webdev.de/docs/sdk/history) |
89
+ | Handoff | `exportWorkbook`, `importWorkbook`, `exportTmx`, `importTmx`, `readLocaleFileSnapshot`, `diffLocaleSnapshots`, `createLocalePathResolver`, `localeWatchPaths` | [Exchange](https://verbatra.kreitz-webdev.de/docs/sdk/exchange) |
90
+ | Config and glossary | `defineConfig`, `loadConfig`, `loadConfigWithMeta`, `detectProject`, `verbatraConfigSchema`, `readGlossaryFile`, `updateGlossaryTerm`, `glossaryHits`, `glossaryDraftCheck`, `isMachineTranslationEnabled`, `assertMachineTranslationEnabled`, `setKeyLengthLimit` | [Config](https://verbatra.kreitz-webdev.de/docs/sdk/config) |
90
91
  | Extension points | `createDefaultRegistry`, `createTreeFileAdapter`, `createFlatFileAdapter`, `AdapterRegistry`, `nodeAdapterFs`, `redact`, `declareProviderKeyEnvVar`, `releaseHeldLocks` | [Extend](https://verbatra.kreitz-webdev.de/docs/sdk/extend) |
91
92
  | JSON schemas | `SDK_JSON_SCHEMAS`, `renderJsonSchemas`, `renderOutputJsonSchema`, `jsonSchemaUrl`, and one zod schema per result, such as `runSummarySchema` and `checkSummarySchema` | [JSON schemas](https://verbatra.kreitz-webdev.de/docs/sdk/json-schemas) |
92
93
  | Constants | `LOCK_FILE_NAME`, `CACHE_FILE_NAME`, `PROVENANCE_FILE_NAME`, `EXCHANGE_FORMATS`, `INTEGRITY_GATE_REASONS`, `REVIEW_REASON_CODES`, `QA_SEVERITIES` | [Inspect](https://verbatra.kreitz-webdev.de/docs/sdk/inspect), [Run](https://verbatra.kreitz-webdev.de/docs/sdk/run), [Exchange](https://verbatra.kreitz-webdev.de/docs/sdk/exchange), [Review](https://verbatra.kreitz-webdev.de/docs/sdk/review) |