@xemahq/llm-registry-api-client 0.8.9 → 0.8.12

package/dist/endpoints/embedding-commitment/embedding-commitment.d.ts

@@ -3,7 +3,7 @@
  * LLM Registry API
  * OpenAPI spec version: 0.1.3
  */
-import type { EmbeddingCommitmentActivationDtoDataEnvelope, EmbeddingCommitmentDtoDataEnvelope, EmbeddingMigrationDtoDataEnvelope, EmbeddingMigrationRollbackDtoDataEnvelope, EmbeddingModelOptionDtoDataArrayEnvelope, MigrationAcknowledgementDtoDataEnvelope, MigrationConsumerDoneDto, MigrationConsumerFailedDto, MigrationHeartbeatDto, MigrationProvisionDto, ResolvedEmbeddingCommitmentDtoDataEnvelope, StartEmbeddingMigrationDto, UpsertEmbeddingCommitmentDto } from '../../models';
+import type { EmbeddingCommitmentActivationDtoDataEnvelope, EmbeddingCommitmentDtoDataEnvelope, EmbeddingMigrationDtoDataEnvelope, EmbeddingMigrationRollbackDtoDataEnvelope, EmbeddingModelOptionDtoDataArrayEnvelope, EmbeddingStorageDeclarationAckDtoDataEnvelope, EmbeddingStorageDeclarationDto, MigrationAcknowledgementDtoDataEnvelope, MigrationConsumerDoneDto, MigrationConsumerFailedDto, MigrationHeartbeatDto, MigrationProvisionDto, ResolvedEmbeddingCommitmentDtoDataEnvelope, StartEmbeddingMigrationDto, UpsertEmbeddingCommitmentDto } from '../../models';
 export declare const getEmbeddingCommitmentControllerGetCommitmentUrl: () => string;
 /**
  * @summary Get the org's embedding commitment
@@ -39,6 +39,11 @@ export declare const getEmbeddingCommitmentControllerProvisionUrl: (migrationId:
  * @summary Consumer worker reports that it has provisioned target storage and is ready to dual-write. Records the high-water-mark cursor.
  */
 export declare const embeddingCommitmentControllerProvision: (migrationId: string, migrationProvisionDto: MigrationProvisionDto, options?: RequestInit) => Promise<MigrationAcknowledgementDtoDataEnvelope>;
+export declare const getEmbeddingCommitmentControllerDeclareStorageUrl: () => string;
+/**
+ * @summary A consumer declares what its vector storage can hold. Called on the consumer's boot, which is the moment it has just read its own backend — so the declaration moves exactly when the fact does.
+ */
+export declare const embeddingCommitmentControllerDeclareStorage: (embeddingStorageDeclarationDto: EmbeddingStorageDeclarationDto, options?: RequestInit) => Promise<EmbeddingStorageDeclarationAckDtoDataEnvelope>;
 export declare const getEmbeddingCommitmentControllerHeartbeatUrl: (migrationId: string) => string;
 /**
  * @summary Consumer worker advances the durable cursor after processing a batch. Used by the reconciliation cron to detect stalled walkers.

package/dist/endpoints/embedding-commitment/embedding-commitment.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.embeddingCommitmentControllerResolveOrg = exports.getEmbeddingCommitmentControllerResolveOrgUrl = exports.embeddingCommitmentControllerConsumerFailed = exports.getEmbeddingCommitmentControllerConsumerFailedUrl = exports.embeddingCommitmentControllerConsumerDone = exports.getEmbeddingCommitmentControllerConsumerDoneUrl = exports.embeddingCommitmentControllerHeartbeat = exports.getEmbeddingCommitmentControllerHeartbeatUrl = exports.embeddingCommitmentControllerProvision = exports.getEmbeddingCommitmentControllerProvisionUrl = exports.embeddingCommitmentControllerRollback = exports.getEmbeddingCommitmentControllerRollbackUrl = exports.embeddingCommitmentControllerStartMigration = exports.getEmbeddingCommitmentControllerStartMigrationUrl = exports.embeddingCommitmentControllerActivate = exports.getEmbeddingCommitmentControllerActivateUrl = exports.embeddingCommitmentControllerListAvailableModels = exports.getEmbeddingCommitmentControllerListAvailableModelsUrl = exports.embeddingCommitmentControllerUpsertCommitment = exports.getEmbeddingCommitmentControllerUpsertCommitmentUrl = exports.embeddingCommitmentControllerGetCommitment = exports.getEmbeddingCommitmentControllerGetCommitmentUrl = void 0;
+exports.embeddingCommitmentControllerResolveOrg = exports.getEmbeddingCommitmentControllerResolveOrgUrl = exports.embeddingCommitmentControllerConsumerFailed = exports.getEmbeddingCommitmentControllerConsumerFailedUrl = exports.embeddingCommitmentControllerConsumerDone = exports.getEmbeddingCommitmentControllerConsumerDoneUrl = exports.embeddingCommitmentControllerHeartbeat = exports.getEmbeddingCommitmentControllerHeartbeatUrl = exports.embeddingCommitmentControllerDeclareStorage = exports.getEmbeddingCommitmentControllerDeclareStorageUrl = exports.embeddingCommitmentControllerProvision = exports.getEmbeddingCommitmentControllerProvisionUrl = exports.embeddingCommitmentControllerRollback = exports.getEmbeddingCommitmentControllerRollbackUrl = exports.embeddingCommitmentControllerStartMigration = exports.getEmbeddingCommitmentControllerStartMigrationUrl = exports.embeddingCommitmentControllerActivate = exports.getEmbeddingCommitmentControllerActivateUrl = exports.embeddingCommitmentControllerListAvailableModels = exports.getEmbeddingCommitmentControllerListAvailableModelsUrl = exports.embeddingCommitmentControllerUpsertCommitment = exports.getEmbeddingCommitmentControllerUpsertCommitmentUrl = exports.embeddingCommitmentControllerGetCommitment = exports.getEmbeddingCommitmentControllerGetCommitmentUrl = void 0;
 const custom_fetch_1 = require("../../custom-fetch");
 const getEmbeddingCommitmentControllerGetCommitmentUrl = () => {
     return `/embedding-commitment`;
@@ -106,6 +106,22 @@ const embeddingCommitmentControllerProvision = async (migrationId, migrationProv
     });
 };
 exports.embeddingCommitmentControllerProvision = embeddingCommitmentControllerProvision;
+const getEmbeddingCommitmentControllerDeclareStorageUrl = () => {
+    return `/embedding-commitment/storage-declaration`;
+};
+exports.getEmbeddingCommitmentControllerDeclareStorageUrl = getEmbeddingCommitmentControllerDeclareStorageUrl;
+/**
+ * @summary A consumer declares what its vector storage can hold. Called on the consumer's boot, which is the moment it has just read its own backend — so the declaration moves exactly when the fact does.
+ */
+const embeddingCommitmentControllerDeclareStorage = async (embeddingStorageDeclarationDto, options) => {
+    return (0, custom_fetch_1.customFetch)((0, exports.getEmbeddingCommitmentControllerDeclareStorageUrl)(), {
+        ...options,
+        method: 'POST',
+        headers: { 'Content-Type': 'application/json', ...options?.headers },
+        body: JSON.stringify(embeddingStorageDeclarationDto)
+    });
+};
+exports.embeddingCommitmentControllerDeclareStorage = embeddingCommitmentControllerDeclareStorage;
 const getEmbeddingCommitmentControllerHeartbeatUrl = (migrationId) => {
     return `/embedding-commitment/migrate/${migrationId}/heartbeat`;
 };

package/dist/models/createProviderDto.d.ts

@@ -15,7 +15,14 @@ export interface CreateProviderDto {
     apiType: CreateProviderDtoApiType;
     baseUrl: string;
     authType?: CreateProviderDtoAuthType;
-    apiKey: string;
+    /** Raw API key. ENROLMENT ONLY: it is sealed into the credential plane on arrival and never stored on the provider. Mutually exclusive with `credentialRef`; exactly one of the two is required. Prefer `credentialRef` in declarative configuration, where a raw key would reach a tfvars file, a plan and the state backend. */
+    apiKey?: string;
+    /**
+       * Opaque credential-binding id held by the credential plane. Mutually exclusive with `apiKey`; exactly one of the two is required. The raw key never crosses this door when this form is used.
+       * @minLength 1
+       * @maxLength 200
+       */
+    credentialRef?: string;
     /** Catalog provider slug — used to seed known models on creation */
     catalogSlug?: string;
     /**

package/dist/models/embeddingConsumer.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Generated by @xemahq/api-client-generator — do not edit manually.
+ * LLM Registry API
+ * OpenAPI spec version: 0.1.3
+ */
+export type EmbeddingConsumer = typeof EmbeddingConsumer[keyof typeof EmbeddingConsumer];
+export declare const EmbeddingConsumer: {
+    readonly search_api: "search_api";
+    readonly memory_api: "memory_api";
+};

package/dist/models/embeddingConsumer.js

@@ -0,0 +1,12 @@
+"use strict";
+/**
+ * Generated by @xemahq/api-client-generator — do not edit manually.
+ * LLM Registry API
+ * OpenAPI spec version: 0.1.3
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EmbeddingConsumer = void 0;
+exports.EmbeddingConsumer = {
+    search_api: 'search_api',
+    memory_api: 'memory_api',
+};

package/dist/models/embeddingDimensionVerdict.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Generated by @xemahq/api-client-generator — do not edit manually.
+ * LLM Registry API
+ * OpenAPI spec version: 0.1.3
+ */
+/**
+ * What this deployment's vector storage would do with this model's dimension. `indexed` is fully served; `stored_unindexed` works and is a linear scan; `unsupported` cannot be stored and must not be offered; `unverified` means NO consumer has declared what it can hold — which is an ANSWER, not a synonym for "fine". A client MUST render this rather than deciding from a local list of dimensions: a local list is how 4096 came to be offered with no storage behind it.
+ */
+export type EmbeddingDimensionVerdict = typeof EmbeddingDimensionVerdict[keyof typeof EmbeddingDimensionVerdict];
+export declare const EmbeddingDimensionVerdict: {
+    readonly indexed: "indexed";
+    readonly stored_unindexed: "stored_unindexed";
+    readonly unsupported: "unsupported";
+    readonly unverified: "unverified";
+};

package/dist/models/embeddingDimensionVerdict.js

@@ -0,0 +1,14 @@
+"use strict";
+/**
+ * Generated by @xemahq/api-client-generator — do not edit manually.
+ * LLM Registry API
+ * OpenAPI spec version: 0.1.3
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EmbeddingDimensionVerdict = void 0;
+exports.EmbeddingDimensionVerdict = {
+    indexed: 'indexed',
+    stored_unindexed: 'stored_unindexed',
+    unsupported: 'unsupported',
+    unverified: 'unverified',
+};

package/dist/models/embeddingModelOptionDto.d.ts

@@ -3,6 +3,7 @@
  * LLM Registry API
  * OpenAPI spec version: 0.1.3
  */
+import type { EmbeddingDimensionVerdict } from './embeddingDimensionVerdict.js';
 import type { EmbeddingProviderSummaryDto } from './embeddingProviderSummaryDto.js';
 export interface EmbeddingModelOptionDto {
     id: string;
@@ -12,4 +13,6 @@ export interface EmbeddingModelOptionDto {
     embeddingDimension: number;
     capabilities: string[];
     provider: EmbeddingProviderSummaryDto;
+    /** What this deployment's vector storage would do with this model's dimension. `indexed` is fully served; `stored_unindexed` works and is a linear scan; `unsupported` cannot be stored and must not be offered; `unverified` means NO consumer has declared what it can hold — which is an ANSWER, not a synonym for "fine". A client MUST render this rather than deciding from a local list of dimensions: a local list is how 4096 came to be offered with no storage behind it. */
+    dimensionVerdict: EmbeddingDimensionVerdict;
 }

package/dist/models/embeddingStorageDeclarationAckDto.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Generated by @xemahq/api-client-generator — do not edit manually.
+ * LLM Registry API
+ * OpenAPI spec version: 0.1.3
+ */
+export interface EmbeddingStorageDeclarationAckDto {
+    recorded: boolean;
+    /** When THIS service recorded it, from its own clock rather than the caller's. It is what makes a consumer that stopped re-declaring visible: its row simply stops moving. */
+    declaredAt: string;
+}

package/dist/models/embeddingStorageDeclarationAckDto.js

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * Generated by @xemahq/api-client-generator — do not edit manually.
+ * LLM Registry API
+ * OpenAPI spec version: 0.1.3
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/embeddingStorageDeclarationAckDtoDataEnvelope.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Generated by @xemahq/api-client-generator — do not edit manually.
+ * LLM Registry API
+ * OpenAPI spec version: 0.1.3
+ */
+import type { EmbeddingStorageDeclarationAckDto } from './embeddingStorageDeclarationAckDto.js';
+export interface EmbeddingStorageDeclarationAckDtoDataEnvelope {
+    data: EmbeddingStorageDeclarationAckDto;
+}

package/dist/models/embeddingStorageDeclarationAckDtoDataEnvelope.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/embeddingStorageDeclarationDto.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Generated by @xemahq/api-client-generator — do not edit manually.
+ * LLM Registry API
+ * OpenAPI spec version: 0.1.3
+ */
+import type { EmbeddingConsumer } from './embeddingConsumer.js';
+export interface EmbeddingStorageDeclarationDto {
+    consumer: EmbeddingConsumer;
+    /**
+       * Narrowest vector this consumer can store.
+       * @minimum 1
+       */
+    minDimension: number;
+    /**
+       * Widest vector this consumer can store.
+       * @minimum 1
+       */
+    maxDimension: number;
+    /**
+       * Widest vector it can store AND serve from an ANN index. Between this and `maxDimension` recall is an exact scan: correct, and slower. It is advisory and never causes a refusal — conflating the two ceilings is what made 4096 look unsupported when it was merely unindexable.
+       * @minimum 0
+       */
+    maxIndexedDimension: number;
+    backend: string;
+    /** Provenance for the numbers above. A bare ceiling is a fact with no source; naming the backend and version makes it checkable, and makes a backend change visible instead of silently keeping an old number. */
+    backendVersion: string;
+}

package/dist/models/embeddingStorageDeclarationDto.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/index.d.ts

@@ -140,6 +140,8 @@ export * from './embeddingCommitmentActivationDtoDataEnvelope';
 export * from './embeddingCommitmentDto';
 export * from './embeddingCommitmentDtoDataEnvelope';
 export * from './embeddingCommitmentDtoState';
+export * from './embeddingConsumer';
+export * from './embeddingDimensionVerdict';
 export * from './embeddingMigrationDto';
 export * from './embeddingMigrationDtoDataEnvelope';
 export * from './embeddingMigrationDtoState';
@@ -148,6 +150,9 @@ export * from './embeddingMigrationRollbackDtoDataEnvelope';
 export * from './embeddingModelOptionDto';
 export * from './embeddingModelOptionDtoDataArrayEnvelope';
 export * from './embeddingProviderSummaryDto';
+export * from './embeddingStorageDeclarationAckDto';
+export * from './embeddingStorageDeclarationAckDtoDataEnvelope';
+export * from './embeddingStorageDeclarationDto';
 export * from './exactAgentRevisionAuthorityResponseDto';
 export * from './exactAgentRevisionAuthorityResponseDtoDataEnvelope';
 export * from './exactAgentRevisionAuthorityResponseDtoReachTier';

package/dist/models/index.js

@@ -157,6 +157,8 @@ __exportStar(require("./embeddingCommitmentActivationDtoDataEnvelope"), exports)
 __exportStar(require("./embeddingCommitmentDto"), exports);
 __exportStar(require("./embeddingCommitmentDtoDataEnvelope"), exports);
 __exportStar(require("./embeddingCommitmentDtoState"), exports);
+__exportStar(require("./embeddingConsumer"), exports);
+__exportStar(require("./embeddingDimensionVerdict"), exports);
 __exportStar(require("./embeddingMigrationDto"), exports);
 __exportStar(require("./embeddingMigrationDtoDataEnvelope"), exports);
 __exportStar(require("./embeddingMigrationDtoState"), exports);
@@ -165,6 +167,9 @@ __exportStar(require("./embeddingMigrationRollbackDtoDataEnvelope"), exports);
 __exportStar(require("./embeddingModelOptionDto"), exports);
 __exportStar(require("./embeddingModelOptionDtoDataArrayEnvelope"), exports);
 __exportStar(require("./embeddingProviderSummaryDto"), exports);
+__exportStar(require("./embeddingStorageDeclarationAckDto"), exports);
+__exportStar(require("./embeddingStorageDeclarationAckDtoDataEnvelope"), exports);
+__exportStar(require("./embeddingStorageDeclarationDto"), exports);
 __exportStar(require("./exactAgentRevisionAuthorityResponseDto"), exports);
 __exportStar(require("./exactAgentRevisionAuthorityResponseDtoDataEnvelope"), exports);
 __exportStar(require("./exactAgentRevisionAuthorityResponseDtoReachTier"), exports);

package/dist/models/updateProviderDto.d.ts

@@ -11,7 +11,18 @@ export interface UpdateProviderDto {
     apiType?: UpdateProviderDtoApiType;
     baseUrl?: string;
     authType?: UpdateProviderDtoAuthType;
+    /**
+       * Replace the INLINE credential. Supplying this on a provider that currently
+       * holds a `credentialRef` SWITCHES it to the inline form — the service
+       * clears the reference in the same write, so the row never holds both.
+       */
     apiKey?: string;
+    /**
+       * Opaque credential-binding id held by the credential plane. Supplying it switches this provider to the reference form and clears the stored key. Mutually exclusive with `apiKey` in one request.
+       * @minLength 1
+       * @maxLength 200
+       */
+    credentialRef?: string;
     isActive?: boolean;
     /**
        * Maximum concurrent requests. Set to null to remove the limit.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xemahq/llm-registry-api-client",
-  "version": "0.8.9",
+  "version": "0.8.12",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [