@krizaka/sovkora-client

InstallerCopy Anchor Link

npm install @krizaka/sovkora-client

Le README ci-dessous est celui du paquet sur npm, en anglais.

One client of Sovkora's edge for every Krizaka TypeScript product, instead of one copy per product (Verikora, soon Folioviv): start a Studio run, read its status and its outputs, wait for it. The base URL, the key and the clock are parameters — this package reads no environment and no wall clock.

import { createSovkoraClient, outputOf } from "@krizaka/sovkora-client";

const sovkora = createSovkoraClient({
  baseUrl: "https://api.sovkora.com",
  apiKey: env.AI_API_KEY,
  clock: { now: () => new Date() },
});

const { run } = await sovkora.startRun(
  "compliance-check",
  { document: text },
  { idempotencyKey: `doc-${documentId}-v${version}` },
);
const done = await sovkora.waitForRun(run.id); // or poll `getRun` yourself
if (done.status === "SUCCEEDED") use(outputOf(done, "report"));

• Safe to retry. startRun with an idempotencyKey answers the run already started for the same key and inputs (replayed: true) instead of paying for a second one; the same key for other inputs is SOVKORA_KEY_REUSED.
• Typed errors. Every failure is an SovkoraError with a stable code (SOVKORA_KEY, SOVKORA_CREDITS, SOVKORA_LOCKED, SOVKORA_INPUT, SOVKORA_NOT_FOUND, SOVKORA_BUSY with retryAfterSeconds, SOVKORA_UNAVAILABLE, SOVKORA_TIMEOUT, SOVKORA_SHAPE, SOVKORA_CIRCUIT_OPEN…) and the status a product answers its own caller with. A product translates the codes; none is a sentence. A failed run is not an error: waitForRun gives it back with its errorMessage.
• A time limit and a circuit breaker, as options: timeoutMs (20 s by default) on every call; five failures in a row (no answer, timeout, 5xx) open the circuit for 30 s — it refuses at once, then lets one call probe. A refusal (401, 402, 404, 429…) is an answer and never opens it. circuit: false turns it off.
• Contract-tested against the edge's answers kept as fixtures (test/fixtures): when the edge changes a shape, the fixture changes first.

Run events as a stream (Server-Sent Events, GET /api/v1/studios/runs/{id}/events) come in a later minor; waitForRun polls until then.

ExportsCopy Anchor Link

Les 34 noms que le paquet exporte, lus dans ses types.

PaquetCopy Anchor Link

Journal des versionsCopy Anchor Link

1.0.0Copy Anchor Link

Major changes

• No retired code name anywhere (founder, 2026-11-06, krizaka-internal#2659).

  • @krizaka/org 1.0.0: brand ids are the commercial names (verikora, folioviv, sovkora, kridoc); OrgBrand.codeName becomes id, formerly is gone; CODE_NAMES is the historic table (retired → id) and brandOf(<retired>) throws; findCodeNames and the krizaka-code-names bin refuse the retired names everywhere, in any case, with no allowed span (history: CHANGELOG.md is skipped); org.products, org.family, apps/<id>.json and CastProduct use the new ids; every product's runtime config points at https://dev.<product>.com.
  • @krizaka/sovkora-client replaces the engine client published under its former code name (deprecated): createSovkoraClient, SovkoraClient, SovkoraError, SOVKORA_CODE with SOVKORA_* codes.
  • @krizaka/settings: displayNameSetting(id) and the brand checks take the new ids. @krizaka/config: no-hand-typed-family-name names the products by their commercial names.

0.2.1Copy Anchor Link

Patch changes

• The READMEs, comments and published declarations no longer name the products that left the organisation (krizaka/.github#413, rule no-departed-published). The sources were cleaned in #262 with an empty changeset, so the published tarballs still carried the old text; this release replaces them. No behaviour change.

0.2.0Copy Anchor Link

Minor changes

• New: startCheck(purpose, { subject, consented, runId }) and collectCheck(providerRef, { subjectId, consented }), the calls of Orazaka's HTTP door for external checks (POST /api/v1/checks/{court-records|credit}, GET /api/v1/checks/{providerRef}; orazaka-ai-engine#105). The answer is the closed CheckResult (outcome, refusal, category, providerRef): a refusal (NO_CONSENT, NO_KEY, BUDGET_EXHAUSTED, NOT_CONFIGURED) is a result, never an exception; 401/403/404/429 map to the existing stable codes. Exports the check types, constants and parseCheck.

0.1.0Copy Anchor Link

Minor changes

• New: @krizaka/orazaka-client, the one Orazaka client for the TypeScript products (#33). Start a Studio run (idempotency key), read its status and outputs, wait for it; typed errors with stable codes, a time limit and a circuit breaker as options; base URL, key and clock as parameters; a fixture-based contract test.