@kaana.ai/contracts 8.16.0 → 8.17.0

package/dist/public/catalogue.d.ts

@@ -911,6 +911,38 @@ export declare const modelListSchema: z.ZodObject<{
         }>>;
     }, z.core.$strip>>;
 }, z.core.$strict>;
+/**
+ * One value `GET /v1/models` gained after a contract set (contract set 8.17.0).
+ *
+ * The catalogue's leaves are strict and its enums closed, so a reader refuses
+ * the WHOLE list on the first field or member its own set lacks. Kaana
+ * therefore renders the catalogue in the set the caller states in
+ * `Kaana-Contract-Version` (`@kaana.ai/sdk` 2.0.0 and later send it on every
+ * request): a value listed here reaches only a caller whose set is `since` or
+ * later. A caller that states no set, or one that does not parse, receives
+ * none of them.
+ *
+ * - `path` names a field of a model; a list on the way is crossed, applying the
+ *   rest of the path to each element.
+ * - Without `member`, the field is the addition and is left out.
+ * - With `member`, the value at `path` is an enum and `member` is the addition:
+ *   the list element that holds it is left out (the member itself in a list of
+ *   members; the object carrying it in a list of objects). When that empties
+ *   the list, the field at `emptied` (the nearest optional field holding the
+ *   list) is left out with it.
+ *
+ * Adding a member to an enum the catalogue reaches, or a field to one of its
+ * strict objects, appends an entry here in the same change; the
+ * `@kaana.ai/sdk` compatibility suite compares this list with the published
+ * releases deployed readers run.
+ */
+export interface CatalogueAddition {
+    readonly since: string;
+    readonly path: readonly string[];
+    readonly member?: string;
+    readonly emptied?: readonly string[];
+}
+export declare const CATALOGUE_ADDITIONS: readonly CatalogueAddition[];
 /**
  * One power level as `GET /v1/power-levels` lists it for the calling
  * credential: the level, the class it draws from, the effort it asks for, and

package/dist/public/catalogue.js

@@ -572,6 +572,22 @@ export const modelSchema = z.object({
 });
 /** `GET /v1/models`. */
 export const modelListSchema = z.object({ data: z.array(modelSchema) }).strict();
+export const CATALOGUE_ADDITIONS = [
+    { since: '8.4.0', path: ['capabilities', 'unreported'] },
+    {
+        since: '8.4.0',
+        path: ['pricing', 'unitPrices', 'unit'],
+        member: 'cache_write_input_tokens',
+        emptied: ['pricing'],
+    },
+    {
+        since: '8.16.0',
+        path: ['capabilities', 'realtime', 'sessionKinds'],
+        member: 'live',
+        emptied: ['capabilities', 'realtime'],
+    },
+    { since: '8.16.0', path: ['capabilities', 'realtime', 'defaultKinds'] },
+];
 /**
  * One power level as `GET /v1/power-levels` lists it for the calling
  * credential: the level, the class it draws from, the effort it asks for, and

package/dist/public/version.d.ts

@@ -100,7 +100,7 @@
  * change to, say, the catalogue reject every in-flight inference request; the
  * per-shape `schemaVersion` is what a message is validated against.
  */
-export declare const INFERENCE_CONTRACT_VERSION = "8.16.0";
+export declare const INFERENCE_CONTRACT_VERSION = "8.17.0";
 /**
  * Contract set 4.0.0 (Kaana ADR 0002) is the first published as
  * `@kaana.ai/contracts`. MAJOR because the set changed hands and split in two:
@@ -276,6 +276,15 @@ export declare const INFERENCE_CONTRACT_VERSION = "8.16.0";
  * session, a command, an event or a catalogue carrying what is new, so Oxy reads
  * them before Kaana serves a `live` line.
  */
+/**
+ * Contract set 8.17.0 publishes `CATALOGUE_ADDITIONS`: the catalogue values a
+ * reader on an earlier set refuses, each with the set that introduced it, and
+ * makes the request's `Kaana-Contract-Version` the set `GET /v1/models` is
+ * rendered in. No shape, field or member changes, and every 8.16.0 message
+ * parses the same; MINOR because Kaana now answers a caller by the set it
+ * states, which is what keeps a value added to the catalogue from refusing a
+ * deployed reader's whole list.
+ */
 /** The public API's one origin and version. */
 export declare const KAANA_API_BASE_URL = "https://kaana.ai/v1";
 /** The response header that carries the request id. */
@@ -283,8 +292,9 @@ export declare const KAANA_REQUEST_ID_HEADER = "Kaana-Request-Id";
 /**
  * The header that carries {@link INFERENCE_CONTRACT_VERSION}: on every
  * response, the set Kaana serves; on a request (`@kaana.ai/sdk` 2.0.0 and
- * later), the set the client parses. Every set since 4.0.0 parses the
- * catalogue Kaana serves.
+ * later), the set the client parses. `GET /v1/models` is rendered in the set
+ * a request states, without any value of {@link CATALOGUE_ADDITIONS} that set
+ * lacks; a request that states none receives none of them.
  */
 export declare const KAANA_CONTRACT_VERSION_HEADER = "Kaana-Contract-Version";
 /**

package/dist/public/version.js

@@ -100,7 +100,7 @@
  * change to, say, the catalogue reject every in-flight inference request; the
  * per-shape `schemaVersion` is what a message is validated against.
  */
-export const INFERENCE_CONTRACT_VERSION = '8.16.0';
+export const INFERENCE_CONTRACT_VERSION = '8.17.0';
 /**
  * Contract set 4.0.0 (Kaana ADR 0002) is the first published as
  * `@kaana.ai/contracts`. MAJOR because the set changed hands and split in two:
@@ -276,6 +276,15 @@ export const INFERENCE_CONTRACT_VERSION = '8.16.0';
  * session, a command, an event or a catalogue carrying what is new, so Oxy reads
  * them before Kaana serves a `live` line.
  */
+/**
+ * Contract set 8.17.0 publishes `CATALOGUE_ADDITIONS`: the catalogue values a
+ * reader on an earlier set refuses, each with the set that introduced it, and
+ * makes the request's `Kaana-Contract-Version` the set `GET /v1/models` is
+ * rendered in. No shape, field or member changes, and every 8.16.0 message
+ * parses the same; MINOR because Kaana now answers a caller by the set it
+ * states, which is what keeps a value added to the catalogue from refusing a
+ * deployed reader's whole list.
+ */
 /** The public API's one origin and version. */
 export const KAANA_API_BASE_URL = 'https://kaana.ai/v1';
 /** The response header that carries the request id. */
@@ -283,8 +292,9 @@ export const KAANA_REQUEST_ID_HEADER = 'Kaana-Request-Id';
 /**
  * The header that carries {@link INFERENCE_CONTRACT_VERSION}: on every
  * response, the set Kaana serves; on a request (`@kaana.ai/sdk` 2.0.0 and
- * later), the set the client parses. Every set since 4.0.0 parses the
- * catalogue Kaana serves.
+ * later), the set the client parses. `GET /v1/models` is rendered in the set
+ * a request states, without any value of {@link CATALOGUE_ADDITIONS} that set
+ * lacks; a request that states none receives none of them.
  */
 export const KAANA_CONTRACT_VERSION_HEADER = 'Kaana-Contract-Version';
 /**

package/openapi.json

@@ -2,7 +2,7 @@
   "openapi": "3.1.0",
   "info": {
     "title": "Kaana API",
-    "version": "8.16.0",
+    "version": "8.17.0",
     "description": "Kaana inference API. Generated from @kaana.ai/contracts; the Zod source is the authority. Accounts, applications, oxy_sk_ keys, limits and billing are managed in Oxy Console: https://console.oxy.so"
   },
   "servers": [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kaana.ai/contracts",
-  "version": "8.16.0",
+  "version": "8.17.0",
   "description": "Kaana inference contract: the Zod schemas of the public API at https://kaana.ai/v1 and, under /internal, of the Oxy-Kaana grant, settlement and signed lane.",
   "type": "module",
   "sideEffects": false,