@oxyhq/contracts 0.26.0 → 0.27.0

package/dist/esm/inference/errors.js

@@ -0,0 +1,192 @@
+/**
+ * Inference errors and retryability.
+ *
+ * One closed set of codes, shared by the Oxy public edge, the data plane and
+ * every SDK.
+ * Closed because the alternative — a free-form `code` string — makes a client's
+ * error handling a guess about the producer's spelling, and makes "is this
+ * worth retrying" a decision every consumer re-derives from prose.
+ *
+ * Retryability is carried explicitly and is CONSTRAINED by the code: a code
+ * that can never succeed on a bare retry (an invalid request, a denied
+ * permission, an insufficient balance) cannot claim `retryable: true`. Without
+ * that constraint the field is advisory, and one producer setting it optimistically
+ * turns every client into a retry storm against a request that will never pass.
+ *
+ * The provider passthrough exists so a customer can see what the upstream said
+ * without Oxy having to interpret every provider's error vocabulary — but it is
+ * the single most likely place for an upstream credential to escape, because
+ * provider errors routinely echo the request that caused them. It is therefore
+ * a `.strict()` object of four fields with no room for headers or a request
+ * body, and its free text is refused if it looks like it contains a credential.
+ *
+ * Decided in: docs/adr/0010-public-api-compatibility.md.
+ */
+import { z } from 'zod';
+import { inferenceProviderSlugSchema, requestIdSchema } from './identifiers.js';
+/**
+ * The closed set of inference error codes.
+ *
+ * Grouped by who must act: the caller (`invalid_request` … `idempotency_conflict`),
+ * the account owner (`insufficient_balance`, `spending_limit_exceeded`,
+ * `quota_exceeded`, `byok_credential_invalid`), routing/permission policy
+ * (`policy_violation`, `commercial_permission_denied`, `no_route_available`),
+ * and the platform or its upstreams (everything from `deployment_unavailable`).
+ */
+export const INFERENCE_ERROR_CODES = [
+    'invalid_request',
+    'authentication_failed',
+    'permission_denied',
+    'insufficient_scope',
+    'model_not_found',
+    'unsupported_modality',
+    'context_length_exceeded',
+    'request_too_large',
+    'output_limit_exceeded',
+    'idempotency_conflict',
+    'insufficient_balance',
+    'spending_limit_exceeded',
+    'quota_exceeded',
+    'byok_credential_invalid',
+    'policy_violation',
+    'commercial_permission_denied',
+    'no_route_available',
+    'upstream_content_filtered',
+    'cancelled',
+    'rate_limited',
+    'deployment_unavailable',
+    'provider_error',
+    'provider_timeout',
+    'provider_overloaded',
+    'service_unavailable',
+    'internal_error',
+];
+export const inferenceErrorCodeSchema = z.enum(INFERENCE_ERROR_CODES);
+/**
+ * Codes for which an identical retried request cannot succeed.
+ *
+ * `rate_limited` and `quota_exceeded` sit on opposite sides of this line
+ * deliberately: a rate limit clears on its own within the window the response
+ * names, while a quota is an account-level ceiling that only a human raises.
+ * `cancelled` is here because the caller already withdrew the request; a client
+ * that retries it is contradicting its own cancellation.
+ */
+export const NON_RETRYABLE_INFERENCE_ERROR_CODES = [
+    'invalid_request',
+    'authentication_failed',
+    'permission_denied',
+    'insufficient_scope',
+    'model_not_found',
+    'unsupported_modality',
+    'context_length_exceeded',
+    'request_too_large',
+    'output_limit_exceeded',
+    'idempotency_conflict',
+    'insufficient_balance',
+    'spending_limit_exceeded',
+    'quota_exceeded',
+    'byok_credential_invalid',
+    'policy_violation',
+    'commercial_permission_denied',
+    'no_route_available',
+    'upstream_content_filtered',
+    'cancelled',
+];
+const NON_RETRYABLE_CODE_SET = new Set(NON_RETRYABLE_INFERENCE_ERROR_CODES);
+/**
+ * Text that looks like it carries a credential.
+ *
+ * A deliberately narrow set of literal markers — the shapes upstream providers
+ * actually echo — rather than an entropy heuristic, which would reject
+ * legitimate error text (a request id, a base64 image fragment) and teach
+ * producers to strip messages until they pass.
+ */
+const CREDENTIAL_LIKE_TEXT = /(?:bearer\s+[a-z0-9._~+/=-]{8,}|authorization\s*[:=]|api[_-]?key\s*[:=]|\bsk-[a-z0-9_-]{8,}|\bsk_(?:live|test)_[a-z0-9]{8,})/i;
+/**
+ * Free text that is safe to hand a customer: bounded, and refused outright if a
+ * credential marker appears in it. Applied to BOTH the Oxy message and the
+ * upstream one — a leak is no less a leak for having been written by a provider.
+ */
+export const safeErrorTextSchema = z
+    .string()
+    .min(1)
+    .max(2000)
+    .refine((value) => !CREDENTIAL_LIKE_TEXT.test(value), 'error text must not contain credential-shaped material');
+/**
+ * A coarse classification of an upstream failure (ADR 0010's `upstreamCategory`).
+ *
+ * Distinct from {@link providerErrorPassthroughSchema}, which carries the
+ * upstream's OWN code and text: this is Oxy's reading of what kind of failure it
+ * was, in a vocabulary that is the same across every provider, so a client can
+ * branch on it without knowing who served the request.
+ */
+export const upstreamErrorCategorySchema = z.enum([
+    'rate_limit',
+    'quota',
+    'timeout',
+    'overloaded',
+    'server_error',
+    'content_filter',
+    'invalid_request',
+    'authentication',
+    'unknown',
+]);
+/**
+ * What the upstream provider said, reduced to the four fields a customer can
+ * act on.
+ *
+ * `.strict()` is the security control here, not a tidiness preference: it means
+ * a producer cannot widen this by attaching `requestHeaders`, `curl`, `body` or
+ * `raw` and have it silently pass. Adding a field is a contract change with a
+ * version bump and a review, which is the point.
+ */
+export const providerErrorPassthroughSchema = z
+    .object({
+    provider: inferenceProviderSlugSchema,
+    /** The upstream HTTP status, when the upstream spoke HTTP. */
+    status: z.number().int().min(100).max(599).optional(),
+    /** The upstream's own error code, verbatim and uninterpreted. */
+    code: z.string().max(128).optional(),
+    /** The upstream's message, subject to the same credential refusal. */
+    message: safeErrorTextSchema.optional(),
+})
+    .strict();
+/**
+ * The error body every inference surface returns and every stream error event
+ * carries.
+ *
+ * `requestId` is always present — an error a customer cannot correlate with a
+ * log line is an error they have to reproduce to report.
+ */
+export const inferenceErrorSchema = z
+    .object({
+    /** See `version.ts`: this shape appears alone on the wire, so it is versioned. */
+    schemaVersion: z.literal(1),
+    code: inferenceErrorCodeSchema,
+    message: safeErrorTextSchema,
+    retryable: z.boolean(),
+    requestId: requestIdSchema,
+    /** How long to wait before retrying. Only meaningful when `retryable`. */
+    retryAfterMs: z.number().int().nonnegative().safe().optional(),
+    /** The request field at fault, for `invalid_request`. */
+    param: z.string().max(128).optional(),
+    /** Present only when an upstream provider was reached and failed. */
+    upstreamCategory: upstreamErrorCategorySchema.optional(),
+    providerError: providerErrorPassthroughSchema.optional(),
+})
+    .superRefine((error, ctx) => {
+    if (error.retryable && NON_RETRYABLE_CODE_SET.has(error.code)) {
+        ctx.addIssue({
+            code: z.ZodIssueCode.custom,
+            path: ['retryable'],
+            message: `${error.code} can never succeed on an identical retry, so it cannot be retryable`,
+        });
+    }
+    if (error.retryAfterMs !== undefined && !error.retryable) {
+        ctx.addIssue({
+            code: z.ZodIssueCode.custom,
+            path: ['retryAfterMs'],
+            message: 'retryAfterMs tells a client when to retry, so it requires retryable: true',
+        });
+    }
+});

package/dist/esm/inference/identifiers.js

@@ -0,0 +1,186 @@
+/**
+ * Identifiers, references and wire primitives shared by every Oxy↔data-plane
+ * inference contract.
+ *
+ * Two kinds of identifier live here, and the difference matters:
+ *
+ *  - **Principal identifiers** owned by Oxy (`accountId`, `applicationId`,
+ *    `credentialId`, the optional delegated `userId`). The data plane may store
+ *    them as immutable references; it never owns, mints or mutates them.
+ *  - **Catalogue references** (`<publisher>/<model>`, `<publisher>/<model>@<revision>`,
+ *    a routing-profile slug). These are the strings a customer types, so their
+ *    grammar is part of the public contract, not an implementation detail.
+ *
+ * Platform-agnostic — zod only. Every regex here is plain ASCII: this package
+ * is imported by React Native apps running on Hermes, which rejects Unicode
+ * property escapes (`\p{…}`) at runtime.
+ *
+ * Decided in: docs/adr/0007-canonical-request-attribution.md, docs/adr/0008-catalogue-concept-separation.md.
+ */
+import { z } from 'zod';
+/* -------------------------------------------------------------------------- */
+/*  Principal identifiers                                                     */
+/* -------------------------------------------------------------------------- */
+/**
+ * An Oxy account id — the account that owns the workload and is financially
+ * responsible for it.
+ *
+ * Branded, and that brand is load-bearing rather than decorative: it is the
+ * type-level half of the rule that a delegated end-user identity can never
+ * become the billing identity (see {@link delegatedUserIdSchema} and
+ * `billingPrincipalSchema`). A plain `string` — and therefore any id read out
+ * of a header, a JWT claim or a request body — is not assignable to it; the
+ * only way to obtain one is to parse a value through this schema.
+ */
+export const oxyAccountIdSchema = z.string().min(1).max(64).brand();
+/**
+ * A delegated end-user identity (Alia's `X-Oxy-User-Id`), branded with a
+ * DIFFERENT brand from {@link oxyAccountIdSchema} so the two cannot be
+ * substituted for one another in either direction, in any consumer, without a
+ * cast that review would catch.
+ *
+ * It exists for attribution and product-side personalisation only. It is never
+ * a billing principal, never an access-control principal, and its presence
+ * never changes which account is charged.
+ */
+export const delegatedUserIdSchema = z.string().min(1).max(64).brand();
+/**
+ * An Oxy `Application._id`. Not branded: no invariant in this contract turns on
+ * confusing it with another id, and brand inflation costs every producer a
+ * parse call for no safety. The two ids above are branded because ADR 0007's
+ * rule is exactly that they must not be interchangeable.
+ */
+export const oxyApplicationIdSchema = z.string().min(1).max(64);
+/** An Oxy `ApplicationCredential._id` — the credential used for this request. */
+export const oxyCredentialIdSchema = z.string().min(1).max(64);
+/**
+ * A request id generated by the data plane. Correlates the Oxy edge, the data
+ * plane, the financial ledger and the customer-visible receipt, so it appears on
+ * every stream event and every ledger record.
+ */
+export const requestIdSchema = z.string().min(1).max(128);
+/**
+ * A generation id generated by the data plane, present when a request produced
+ * a generation that can be looked up later (`GET /v1/generations/:id`).
+ */
+export const generationIdSchema = z.string().min(1).max(128);
+/**
+ * A caller-supplied idempotency key. Every reserve/settle/refund call is keyed
+ * on one so a retry, a redelivered event or a duplicated webhook can never
+ * charge twice.
+ */
+export const idempotencyKeySchema = z.string().min(1).max(255);
+/** Credential environments. A credential is issued into exactly one of them. */
+export const inferenceEnvironmentSchema = z.enum(['development', 'staging', 'production']);
+/* -------------------------------------------------------------------------- */
+/*  Wire primitives                                                           */
+/* -------------------------------------------------------------------------- */
+/**
+ * An instant, as an ISO 8601 string in UTC (`2026-08-15T09:41:00.000Z`).
+ *
+ * Validated rather than left free-form — unlike the session contracts, which
+ * carry legacy expiry strings no consumer interprets, every instant here is
+ * read: a reservation expires, a price version starts applying, a receipt is
+ * settled. One canonical spelling (UTC, `Z`) so two records that describe the
+ * same moment compare and sort as equal, which a mix of offsets would not.
+ */
+export const inferenceTimestampSchema = z.string().datetime();
+/**
+ * A calendar DATE with no instant attached (`2026-05-01`) — a knowledge cutoff
+ * or a release date, which are published as days and become wrong when a
+ * timezone is invented for them.
+ */
+export const inferenceDateSchema = z
+    .string()
+    .regex(/^[0-9]{4}-[0-9]{2}-[0-9]{2}$/, 'must be an ISO 8601 calendar date (YYYY-MM-DD)');
+/** An absolute https URL, for model cards, licenses and provider documentation. */
+export const inferenceHttpsUrlSchema = z
+    .string()
+    .max(2048)
+    .regex(/^https:\/\/[^\s]+$/, 'must be an absolute https URL');
+/* -------------------------------------------------------------------------- */
+/*  Catalogue references                                                      */
+/* -------------------------------------------------------------------------- */
+/** One path segment of a canonical model id: a lowercase, URL-safe slug. */
+const SLUG_PATTERN = '[a-z0-9](?:[a-z0-9._-]*[a-z0-9])?';
+/** A revision label. Case-preserving, because upstream revisions often are. */
+const REVISION_PATTERN = '[a-zA-Z0-9](?:[a-zA-Z0-9._-]*[a-zA-Z0-9])?';
+/** A publisher slug, e.g. `openai`, `anthropic`, `meta`, `alia`. */
+export const publisherSlugSchema = z
+    .string()
+    .max(64)
+    .regex(new RegExp(`^${SLUG_PATTERN}$`), 'publisher must be a lowercase URL-safe slug');
+/** A model slug within its publisher's namespace, e.g. `gpt-5`, `llama-3.1-70b`. */
+export const modelSlugSchema = z
+    .string()
+    .max(64)
+    .regex(new RegExp(`^${SLUG_PATTERN}$`), 'model must be a lowercase URL-safe slug');
+/**
+ * A canonical model id, `<publisher>/<model>`. This names a MODEL — a
+ * long-lived product identity whose behaviour changes as revisions ship. It
+ * does not name a revision, a deployment or a provider.
+ */
+export const modelIdSchema = z
+    .string()
+    .max(129)
+    .regex(new RegExp(`^${SLUG_PATTERN}/${SLUG_PATTERN}$`), 'model id must be <publisher>/<model>');
+/** An immutable revision label, unique within its model, e.g. `2026-05-01`. */
+export const modelRevisionLabelSchema = z
+    .string()
+    .max(64)
+    .regex(new RegExp(`^${REVISION_PATTERN}$`), 'revision must be a URL-safe label');
+/**
+ * A model reference as a customer writes it: `<publisher>/<model>` (the model's
+ * current revision, chosen by Oxy) or `<publisher>/<model>@<revision>` (an
+ * immutable revision the customer pinned).
+ *
+ * Both forms name a CONCRETE MODEL. Neither can name a routing profile — see
+ * {@link routingProfileSlugSchema} — which is what makes "a request for a
+ * concrete model is never silently replaced with a different model" a
+ * distinction the type system can carry rather than a convention.
+ */
+export const modelReferenceSchema = z
+    .string()
+    .max(194)
+    .regex(new RegExp(`^${SLUG_PATTERN}/${SLUG_PATTERN}(?:@${REVISION_PATTERN})?$`), 'model reference must be <publisher>/<model> or <publisher>/<model>@<revision>');
+/**
+ * A routing-profile slug, e.g. `auto`, `fast`, `quality`.
+ *
+ * Deliberately refuses a `/`, so a profile can never be written in the shape of
+ * a model id and no caller can be confused about whether they asked for a
+ * concrete model or for Oxy to choose one. Modes like `auto`/`fast`/`quality`
+ * are profiles or product presets; they are never model objects.
+ */
+export const routingProfileSlugSchema = z
+    .string()
+    .max(64)
+    .regex(new RegExp(`^${SLUG_PATTERN}$`), 'routing profile must be a lowercase URL-safe slug');
+/** An inference provider slug, e.g. `openai`, `bedrock`, `oxy-hosted`. */
+export const inferenceProviderSlugSchema = z
+    .string()
+    .max(64)
+    .regex(new RegExp(`^${SLUG_PATTERN}$`), 'provider must be a lowercase URL-safe slug');
+/**
+ * A deployment/endpoint id. Opaque to customers: which concrete endpoint served
+ * a request is the data plane's operational detail, and only the customer-safe
+ * subset of it is ever attributed back (see the catalogue's serving-boundary
+ * rules).
+ */
+export const deploymentIdSchema = z.string().min(1).max(128);
+/**
+ * A region identifier, e.g. `us-west-2`, `eu-central-1`. Free-form rather than
+ * a closed enum because the set is provider-defined and grows without any
+ * contract change; residency policies match on exact strings.
+ */
+export const inferenceRegionSchema = z
+    .string()
+    .max(64)
+    .regex(new RegExp(`^${SLUG_PATTERN}$`), 'region must be a lowercase URL-safe slug');
+/**
+ * The publisher namespace reserved for models Alia actually owns or derives.
+ *
+ * `alia/*` is never a re-badged third-party route and never a prompt preset —
+ * enforcing that is the job of `modelSchema`'s provenance refinement, which
+ * this constant exists to be checked against.
+ */
+export const RESERVED_ALIA_PUBLISHER = 'alia';

package/dist/esm/inference/money.js

@@ -0,0 +1,142 @@
+/**
+ * Money and usage units for the inference contracts.
+ *
+ * The non-negotiable invariant this file exists to make structural: **customer
+ * charges never use floating-point values as the financial source of truth.**
+ * A JS `number` cannot represent `0.1 + 0.2` exactly, and an inference ledger
+ * adds millions of small amounts, so a float total is wrong by construction
+ * rather than by accident.
+ *
+ * Every amount and every price is one representation: {@link exactDecimalSchema},
+ * an exact decimal STRING at the scale ADR 0009 declares. Amounts are not
+ * integer minor units, and that is the ADR's decision rather than an oversight:
+ * one token costs several orders of magnitude less than one cent, so rounding
+ * per request would make a customer's bill depend on how their client chunked
+ * its work. Rounding happens ONCE, at the invoice boundary, and is itself a
+ * ledger entry.
+ *
+ * A string is also what the driver hands back — `postgres.js` decodes `NUMERIC`
+ * as a string — so keeping it a string on the wire means accidental JS
+ * arithmetic fails loudly instead of silently losing precision. Money
+ * arithmetic happens in SQL or in a decimal type, never in a JS `number`.
+ *
+ * Units are carried separately from money in every shape: a receipt says both
+ * "204 output tokens" and "0.003060000000 USD", and neither is derived from the
+ * other at read time. That separation is what lets a price version change
+ * without rewriting settled history.
+ *
+ * Decided in: docs/adr/0009-usage-reservation-and-settlement.md.
+ */
+import { z } from 'zod';
+/* -------------------------------------------------------------------------- */
+/*  Money                                                                     */
+/* -------------------------------------------------------------------------- */
+/** ISO 4217 alpha-3 currency code, e.g. `USD`. */
+export const currencyCodeSchema = z
+    .string()
+    .regex(/^[A-Z]{3}$/, 'currency must be an ISO 4217 alpha-3 code');
+/**
+ * The declared fractional scale of every amount and price in this contract, and
+ * of the `NUMERIC` columns the ledger stores them in.
+ *
+ * Twelve digits is sub-minor-unit precision by a wide margin: at $3 per million
+ * input tokens, one token costs `0.000003000000`, which this scale represents
+ * exactly. Amounts are compared and summed NUMERICALLY, never as text — `3.0`
+ * and `3.000000000000` are one amount written two ways.
+ */
+export const INFERENCE_MONEY_SCALE = 12;
+/**
+ * An exact non-negative decimal, carried as a STRING so no parse step can turn
+ * it into a float on the way past. Up to 18 integer digits and
+ * {@link INFERENCE_MONEY_SCALE} fractional digits.
+ *
+ * Non-negative: direction is carried by the SHAPE — a receipt debits, a refund
+ * credits — so a stray sign can never silently invert an entry.
+ *
+ * No exponent form: `1e-6` and `0.000001` are the same number, but only one of
+ * them survives a naive string comparison, a cache key or a log grep intact.
+ *
+ * Branded, so a bare `string` is not assignable and an amount cannot arrive
+ * from string concatenation that was never checked. Producers construct one
+ * with `exactDecimalSchema.parse(value)`.
+ */
+export const exactDecimalSchema = z
+    .string()
+    .regex(/^(?:0|[1-9][0-9]{0,17})(?:\.[0-9]{1,12})?$/, 'must be an exact non-negative decimal string without an exponent')
+    .brand();
+/**
+ * An amount of money: the exact decimal plus the currency it is in.
+ *
+ * `.strict()` so a payload carrying a convenience float beside the exact value
+ * (`{ amount: '18.06', amountFloat: 18.06 }`) is REJECTED rather than stripped.
+ * A stripped float is the more dangerous outcome: it disappears silently here
+ * and survives in the producer, where it is the value somebody eventually
+ * displays.
+ */
+export const moneySchema = z
+    .object({
+    amount: exactDecimalSchema,
+    currency: currencyCodeSchema,
+})
+    .strict();
+/* -------------------------------------------------------------------------- */
+/*  Usage units                                                               */
+/* -------------------------------------------------------------------------- */
+/**
+ * The closed set of units inference is metered in.
+ *
+ * Time is carried in integer MILLISECONDS rather than seconds so that no unit
+ * quantity is ever fractional: a 12.5-second transcription is `12500`, exactly,
+ * and the "units are integers" rule holds for every modality instead of holding
+ * for tokens and being quietly broken by audio.
+ */
+export const USAGE_UNITS = [
+    'input_tokens',
+    'cached_input_tokens',
+    'output_tokens',
+    'reasoning_tokens',
+    'requests',
+    'images',
+    'audio_input_milliseconds',
+    'audio_output_milliseconds',
+    'video_milliseconds',
+    'characters',
+    'embeddings',
+];
+export const usageUnitSchema = z.enum(USAGE_UNITS);
+/**
+ * A metered quantity of ONE unit. Never money — a quantity carries no price and
+ * no currency, so a consumer cannot mistake a token count for an amount owed.
+ */
+export const usageQuantitySchema = z
+    .object({
+    unit: usageUnitSchema,
+    quantity: z.number().int().nonnegative().safe(),
+})
+    .strict();
+/**
+ * Where a metered quantity came from.
+ *
+ * Kept explicit because the three are not interchangeable when a charge is
+ * disputed: `provider_reported` is the upstream's own count, `oxy_measured` is
+ * counted by the platform (streamed bytes, wall-clock milliseconds), and
+ * `estimated` is a reconstruction used when a provider returned no usage at
+ * all. An estimate that is indistinguishable from a reported number is an
+ * estimate nobody can later reconcile or refund against.
+ */
+export const USAGE_SOURCES = ['provider_reported', 'oxy_measured', 'estimated'];
+export const usageSourceSchema = z.enum(USAGE_SOURCES);
+/**
+ * A price for one unit, as `amount` per `per` units — `per` because a price
+ * quoted per single token would need more fractional digits than it is worth
+ * ("$3.00 per 1000000 input_tokens" is how every provider quotes it, and how
+ * every customer reads it).
+ */
+export const unitPriceSchema = z
+    .object({
+    unit: usageUnitSchema,
+    amount: exactDecimalSchema,
+    per: z.number().int().positive().safe(),
+    currency: currencyCodeSchema,
+})
+    .strict();

package/dist/esm/inference/priceVersion.js

@@ -0,0 +1,107 @@
+/**
+ * Price versions — the immutable snapshots customer pricing is quoted and
+ * settled against.
+ *
+ * A price is never edited in place. A change publishes a NEW version that
+ * supersedes the old one, and every settled receipt keeps the id of the version
+ * it was priced with. That is what makes an invoice reproducible a year later:
+ * the receipt does not say "3.00 per million tokens", it says "priced under
+ * `pv_2026_08`", and that version still exists, unchanged, with its own
+ * effective window.
+ *
+ * Prices are exact decimal strings (see `money.ts`), never floats, and they are
+ * quoted per unit. The amount a customer owes is computed from them and is
+ * carried in the same exact form, so no step of the calculation passes through
+ * a representation that cannot hold the value.
+ *
+ * Decided in: docs/adr/0009-usage-reservation-and-settlement.md.
+ */
+import { z } from 'zod';
+import { inferenceTimestampSchema, modelReferenceSchema, inferenceProviderSlugSchema, } from './identifiers.js';
+import { currencyCodeSchema, unitPriceSchema } from './money.js';
+/**
+ * Lifecycle of a price version.
+ *
+ * `draft` is quotable in Console previews but may never price a receipt;
+ * `active` is what live requests are priced with; `superseded` priced receipts
+ * in the past and still resolves for them forever.
+ */
+export const priceVersionStatusSchema = z.enum(['draft', 'active', 'superseded']);
+/**
+ * A published set of customer prices for one model reference on one provider.
+ *
+ * Scoped to a `(modelReference, provider)` pair rather than to a model alone
+ * because the same model costs different amounts on different providers, and a
+ * receipt has to be reproducible against the route that actually served it.
+ */
+export const priceVersionSchema = z
+    .object({
+    /** See `version.ts`: served on its own by the catalogue, so it is versioned. */
+    schemaVersion: z.literal(1),
+    priceVersionId: z.string().min(1).max(128),
+    status: priceVersionStatusSchema,
+    modelReference: modelReferenceSchema,
+    provider: inferenceProviderSlugSchema,
+    currency: currencyCodeSchema,
+    unitPrices: z.array(unitPriceSchema).min(1),
+    effectiveFrom: inferenceTimestampSchema,
+    /** Absent while this version is the current one. */
+    effectiveUntil: inferenceTimestampSchema.optional(),
+    /** The version this one replaced, absent for the first version of a route. */
+    supersedesPriceVersionId: z.string().min(1).max(128).optional(),
+    createdAt: inferenceTimestampSchema,
+})
+    .superRefine((priceVersion, ctx) => {
+    const units = priceVersion.unitPrices.map((price) => price.unit);
+    if (new Set(units).size !== units.length) {
+        ctx.addIssue({
+            code: z.ZodIssueCode.custom,
+            path: ['unitPrices'],
+            message: 'a unit may be priced only once per price version',
+        });
+    }
+    for (const [index, price] of priceVersion.unitPrices.entries()) {
+        if (price.currency !== priceVersion.currency) {
+            ctx.addIssue({
+                code: z.ZodIssueCode.custom,
+                path: ['unitPrices', index, 'currency'],
+                message: 'every unit price must be quoted in the price version currency',
+            });
+        }
+    }
+    // Compared as instants, not as strings: `…T00:00:00Z` and `…T00:00:00.000Z`
+    // are the same moment and sort differently as text.
+    if (priceVersion.effectiveUntil !== undefined &&
+        Date.parse(priceVersion.effectiveUntil) <= Date.parse(priceVersion.effectiveFrom)) {
+        ctx.addIssue({
+            code: z.ZodIssueCode.custom,
+            path: ['effectiveUntil'],
+            message: 'a price version must stop applying after it started applying',
+        });
+    }
+    // A superseded version priced requests during a window that has closed. Left
+    // open, it is indistinguishable from the current one when a receipt is
+    // re-priced years later — which is the one job this record exists to do.
+    if (priceVersion.status === 'superseded' && priceVersion.effectiveUntil === undefined) {
+        ctx.addIssue({
+            code: z.ZodIssueCode.custom,
+            path: ['effectiveUntil'],
+            message: 'a superseded price version must record when it stopped applying',
+        });
+    }
+});
+/**
+ * The price snapshot a settled receipt keeps.
+ *
+ * The unit prices are COPIED onto the receipt, not just referenced, so a receipt
+ * remains readable even if the price version record is later archived, and so
+ * that a mistake in the copy is visible as a disagreement with the version it
+ * names rather than silently invisible.
+ */
+export const priceSnapshotSchema = z
+    .object({
+    priceVersionId: z.string().min(1).max(128),
+    currency: currencyCodeSchema,
+    unitPrices: z.array(unitPriceSchema).min(1),
+})
+    .strict();