@marinoscar/platform-contract 0.1.0-next.3 → 0.1.0-next.4

package/dist/cjs/ai/constants.d.ts

@@ -0,0 +1,239 @@
+/**
+ * The id pattern of an AI provider: a lower-case letter, then lower-case
+ * letters, digits and hyphens, 2 to 48 characters. Also the provider part of
+ * an `ai.limits.perModel` key (`AI_LIMIT_MODEL_KEY_PATTERN`). Permanent once a
+ * provider's settings or keys are stored under it.
+ *
+ * @stability experimental
+ */
+export declare const AI_PROVIDER_ID_PATTERN: RegExp;
+/**
+ * The id pattern of an AI model capability: a lower-case letter, then
+ * lower-case letters, digits and underscores, 2 to 48 characters
+ * (`audio_transcription`, `speaker_diarization`). Permanent once a catalog row
+ * or an override stores it. The vocabulary is open (PP-14.17, #935): the
+ * platform's own are `BUILTIN_AI_CAPABILITIES` in `@marinoscar/platform-api/ai`,
+ * an app adds its own with `registerAiCapability`.
+ *
+ * @stability experimental
+ */
+export declare const AI_CAPABILITY_ID_PATTERN: RegExp;
+/**
+ * The id pattern of an AI operation: dot-separated lower-case segments of
+ * letters, digits and underscores, 2 to 64 characters in all
+ * (`responses`, `audio.transcribe`, `audio.diarize`). It is the `operation`
+ * column of a usage row, so it is permanent once one is written. Open
+ * (PP-14.17, #935): an app adds its own with `registerAiOperation`.
+ *
+ * @stability experimental
+ */
+export declare const AI_OPERATION_ID_PATTERN: RegExp;
+/**
+ * The id pattern of a registered AI feature (`registerAiFeature`): lower snake
+ * case, starting with a letter, at most 64 characters. Also the `feature`
+ * column of a usage row and of a run.
+ *
+ * @stability experimental
+ */
+export declare const AI_FEATURE_ID_PATTERN: RegExp;
+/**
+ * The provider ids the platform ships an adapter and a settings slot for.
+ * Permanent strings. An app's own providers are not listed here: ask the API
+ * (`GET /api/admin/ai/config`, `GET /api/ai/config`) for the registered ones.
+ *
+ * @stability experimental
+ */
+export declare const BUILTIN_AI_PROVIDER_IDS: readonly ["openai", "anthropic", "gemini", "azure-openai", "openai-compatible"];
+/**
+ * The provider ids the platform ships.
+ *
+ * @deprecated Use {@link BUILTIN_AI_PROVIDER_IDS}. The list is no longer the set
+ *   of providers a deployment can use (PP-14.6, #924); kept as an alias for one release.
+ * @stability experimental
+ */
+export declare const AI_PROVIDER_IDS: readonly ["openai", "anthropic", "gemini", "azure-openai", "openai-compatible"];
+/**
+ * One of {@link BUILTIN_AI_PROVIDER_IDS}.
+ *
+ * @stability experimental
+ */
+export type BuiltinAiProviderId = (typeof BUILTIN_AI_PROVIDER_IDS)[number];
+/**
+ * An AI provider id: a built-in one (autocompleted) or any string an app or
+ * package registered. See {@link AI_PROVIDER_ID_PATTERN}.
+ *
+ * @stability experimental
+ */
+export type AiProviderId = BuiltinAiProviderId | (string & {});
+/**
+ * How this deployment sources the API key a call actually authenticates
+ * with.
+ *
+ *  - `byok`                    — every call uses the CALLING USER's own key
+ *    (`UserAiKey`). No call succeeds for a user who has not saved one.
+ *  - `byok_with_org_fallback`  — a user's own key is preferred; a user with
+ *    none falls back to a deployment-wide org key. What that org key is, and
+ *    where it lives, is deliberately not modelled here: like the object
+ *    storage secret access key, an org-wide AI key is CREDENTIAL material and
+ *    belongs in the encrypted credential store, never in this JSONB blob that
+ *    `GET /api/system-settings` returns wholesale — see the block comment
+ *    on `systemAiSchema` below.
+ *
+ * @stability experimental
+ */
+export declare const AI_KEY_POLICIES: readonly ["byok", "byok_with_org_fallback"];
+/**
+ * The entries of the key-policy enum (`keyPolicyEnum()`).
+ *
+ * @stability experimental
+ */
+export type AiKeyPolicyEnum = {
+    [K in (typeof AI_KEY_POLICIES)[number]]: K;
+};
+/**
+ * Upper bound on `ai.usageRetentionDays` — ten years; anything longer is "forever" in practice.
+ *
+ * @stability experimental
+ */
+export declare const AI_USAGE_RETENTION_MAX_DAYS = 3650;
+/**
+ * One `ai.hostedTools.mcpAllowedHosts` entry: a hostname (`mcp.example.com`)
+ * or a subdomain wildcard (`*.example.com`). No scheme, port or path — the
+ * scheme is always `https`, and the entry is compared with the URL's host.
+ *
+ * @stability experimental
+ */
+export declare const AI_MCP_ALLOWED_HOST_PATTERN: RegExp;
+/**
+ * Most entries `ai.hostedTools.mcpAllowedHosts` may hold.
+ *
+ * @stability experimental
+ */
+export declare const AI_MCP_ALLOWED_HOSTS_MAX = 100;
+/**
+ * One `ai.limits.perModel` key: `<provider>:<modelId>` — a lower-case
+ * provider id, a colon, then the model id exactly as the catalog lists it
+ * (`openai:gpt-4.1-mini`). The model id may itself contain colons.
+ *
+ * @stability experimental
+ */
+export declare const AI_LIMIT_MODEL_KEY_PATTERN: RegExp;
+/**
+ * Longest accepted `ai.limits.perModel` key.
+ *
+ * @stability experimental
+ */
+export declare const AI_LIMIT_MODEL_KEY_MAX = 256;
+/**
+ * Most entries `ai.limits.perModel` may hold.
+ *
+ * @stability experimental
+ */
+export declare const AI_LIMITS_PER_MODEL_MAX = 500;
+/**
+ * Upper bound on any one `ai.limits` number — a billion is "unlimited" in practice.
+ *
+ * @stability experimental
+ */
+export declare const AI_LIMIT_VALUE_MAX = 1000000000;
+/**
+ * How the deployment sources a call's API key. See {@link AI_KEY_POLICIES}.
+ *
+ * @stability experimental
+ */
+export type AiKeyPolicy = (typeof AI_KEY_POLICIES)[number];
+/**
+ * Longest accepted `baseUrl` for the #448 slots.
+ *
+ * @stability experimental
+ */
+export declare const AI_ENDPOINT_URL_MAX = 2048;
+/**
+ * Why an endpoint URL is refused, or null when it is acceptable. Shared with the admin DTOs.
+ *
+ * @stability experimental
+ */
+export declare function aiEndpointUrlProblem(value: string, schemes: readonly string[]): string | null;
+/**
+ * Schemes a `providers['azure-openai'].baseUrl` may use.
+ *
+ * @stability experimental
+ */
+export declare const AI_AZURE_ENDPOINT_SCHEMES: readonly ["https"];
+/**
+ * Schemes a `providers['openai-compatible'].baseUrl` may use.
+ *
+ * @stability experimental
+ */
+export declare const AI_COMPATIBLE_ENDPOINT_SCHEMES: readonly ["http", "https"];
+/**
+ * Which wire API an OpenAI-family adapter speaks.
+ *
+ * @stability experimental
+ */
+export declare const AI_OPENAI_API_STYLES: readonly ["responses", "chat_completions"];
+/**
+ * The entries of the API-style enum (`apiStyleEnum()`).
+ *
+ * @stability experimental
+ */
+export type AiOpenAiApiStyleEnum = {
+    [K in (typeof AI_OPENAI_API_STYLES)[number]]: K;
+};
+/**
+ * One of `AI_OPENAI_API_STYLES`.
+ *
+ * @stability experimental
+ */
+export type AiOpenAiApiStyle = (typeof AI_OPENAI_API_STYLES)[number];
+/**
+ * An Azure `api-version` query value (`2025-04-01-preview`, `2024-10-21`,
+ * `preview`). A plain token: it is sent as a query parameter and nothing else.
+ *
+ * @stability experimental
+ */
+export declare const AI_AZURE_API_VERSION_PATTERN: RegExp;
+/**
+ * An Azure deployment name: letters, digits, `.`, `_` and `-`, at most 64.
+ *
+ * @stability experimental
+ */
+export declare const AI_AZURE_DEPLOYMENT_PATTERN: RegExp;
+/**
+ * Most entries `providers['azure-openai'].deployments` may hold.
+ *
+ * @stability experimental
+ */
+export declare const AI_AZURE_DEPLOYMENTS_MAX = 200;
+/**
+ * Longest accepted model id key in `deployments`.
+ *
+ * @stability experimental
+ */
+export declare const AI_AZURE_MODEL_ID_MAX = 256;
+/**
+ * The property names a settings namespace must never carry.
+ *
+ * @stability experimental
+ */
+export type AiSecretFieldNames = 'secretAccessKey' | 'secretKey' | 'sessionToken' | 'secret' | 'password' | 'apiKey' | 'apiKeys' | 'key' | 'token';
+/**
+ * Shortest key the org-key route accepts (the deployment-key route's bound).
+ *
+ * @stability experimental
+ */
+export declare const ORG_AI_KEY_MIN = 8;
+/**
+ * Longest key the org-key route accepts.
+ *
+ * @stability experimental
+ */
+export declare const ORG_AI_KEY_MAX = 512;
+/** Field names no org-key response may carry, ever. */
+/**
+ * The property names an organization key view must never carry.
+ *
+ * @stability experimental
+ */
+export type KeyMaterialFieldNames = 'apiKey' | 'key' | 'secret' | 'token' | 'ciphertext';
+//# sourceMappingURL=constants.d.ts.map

package/dist/cjs/ai/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../src/ai/constants.ts"],"names":[],"mappings":"AA0BA;;;;;;;GAOG;AACH,eAAO,MAAM,sBAAsB,QAA2B,CAAC;AAE/D;;;;;;;;;GASG;AACH,eAAO,MAAM,wBAAwB,QAA2B,CAAC;AAEjE;;;;;;;;GAQG;AACH,eAAO,MAAM,uBAAuB,QAA0D,CAAC;AAE/F;;;;;;GAMG;AACH,eAAO,MAAM,qBAAqB,QAA2B,CAAC;AAE9D;;;;;;GAMG;AACH,eAAO,MAAM,uBAAuB,iFAAkF,CAAC;AAEvH;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,iFAA0B,CAAC;AAEvD;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,OAAO,uBAAuB,CAAC,CAAC,MAAM,CAAC,CAAC;AAE3E;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG,mBAAmB,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;AAE/D;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,eAAe,6CAA8C,CAAC;AAE3E;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG;KAAG,CAAC,IAAI,CAAC,OAAO,eAAe,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC;CAAE,CAAC;AAE7E;;;;GAIG;AACH,eAAO,MAAM,2BAA2B,OAAO,CAAC;AAEhD;;;;;;GAMG;AACH,eAAO,MAAM,2BAA2B,QACgE,CAAC;AAEzG;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,MAAM,CAAC;AAE5C;;;;;;GAMG;AACH,eAAO,MAAM,0BAA0B,QAAoB,CAAC;AAE5D;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,MAAM,CAAC;AAE1C;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,MAAM,CAAC;AAE3C;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,aAAgB,CAAC;AAEhD;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,eAAe,CAAC,CAAC,MAAM,CAAC,CAAC;AAE3D;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,OAAO,CAAC;AAExC;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,MAAM,EAAE,GAAG,MAAM,GAAG,IAAI,CAkB7F;AAED;;;;GAIG;AACH,eAAO,MAAM,yBAAyB,oBAAqB,CAAC;AAE5D;;;;GAIG;AACH,eAAO,MAAM,8BAA8B,4BAA6B,CAAC;AAEzE;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,4CAA6C,CAAC;AAE/E;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAAG;KAAG,CAAC,IAAI,CAAC,OAAO,oBAAoB,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC;CAAE,CAAC;AAGvF;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,OAAO,oBAAoB,CAAC,CAAC,MAAM,CAAC,CAAC;AAErE;;;;;GAKG;AACH,eAAO,MAAM,4BAA4B,QAAsC,CAAC;AAEhF;;;;GAIG;AACH,eAAO,MAAM,2BAA2B,QAAsC,CAAC;AAE/E;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,MAAM,CAAC;AAE5C;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,MAAM,CAAC;AAEzC;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAC1B,iBAAiB,GACjB,WAAW,GACX,cAAc,GACd,QAAQ,GACR,UAAU,GACV,QAAQ,GACR,SAAS,GACT,KAAK,GACL,OAAO,CAAC;AAIZ;;;;GAIG;AACH,eAAO,MAAM,cAAc,IAAI,CAAC;AAGhC;;;;GAIG;AACH,eAAO,MAAM,cAAc,MAAM,CAAC;AAElC,uDAAuD;AACvD;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG,QAAQ,GAAG,KAAK,GAAG,QAAQ,GAAG,OAAO,GAAG,YAAY,CAAC"}

package/dist/cjs/ai/constants.js

@@ -0,0 +1,233 @@
+"use strict";
+// =============================================================================
+// The AI slice's zod-free constants (issue #739, PP-8.6)
+// =============================================================================
+//
+// Plain values and string-literal unions only, never zod (the contract
+// convention, test/no-zod-in-constants.test.ts): a consumer that needs only a
+// constant or a type (the web app) never pulls zod into its bundle. The
+// schemas built from these are ./schemas.ts, ./org-keys.ts and ./features.ts.
+// =============================================================================
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ORG_AI_KEY_MAX = exports.ORG_AI_KEY_MIN = exports.AI_AZURE_MODEL_ID_MAX = exports.AI_AZURE_DEPLOYMENTS_MAX = exports.AI_AZURE_DEPLOYMENT_PATTERN = exports.AI_AZURE_API_VERSION_PATTERN = exports.AI_OPENAI_API_STYLES = exports.AI_COMPATIBLE_ENDPOINT_SCHEMES = exports.AI_AZURE_ENDPOINT_SCHEMES = exports.AI_ENDPOINT_URL_MAX = exports.AI_LIMIT_VALUE_MAX = exports.AI_LIMITS_PER_MODEL_MAX = exports.AI_LIMIT_MODEL_KEY_MAX = exports.AI_LIMIT_MODEL_KEY_PATTERN = exports.AI_MCP_ALLOWED_HOSTS_MAX = exports.AI_MCP_ALLOWED_HOST_PATTERN = exports.AI_USAGE_RETENTION_MAX_DAYS = exports.AI_KEY_POLICIES = exports.AI_PROVIDER_IDS = exports.BUILTIN_AI_PROVIDER_IDS = exports.AI_FEATURE_ID_PATTERN = exports.AI_OPERATION_ID_PATTERN = exports.AI_CAPABILITY_ID_PATTERN = exports.AI_PROVIDER_ID_PATTERN = void 0;
+exports.aiEndpointUrlProblem = aiEndpointUrlProblem;
+// =============================================================================
+// AI platform namespace (issue #423, epic #419, umbrella #418)
+// =============================================================================
+//
+// Deployment-wide AI policy — declared on the same terms as `storage` above:
+// all six places in one pass (this file's two schemas, the wire DTOs' two
+// schemas, `DEFAULT_SYSTEM_SETTINGS`, and the hand-written merge in
+// `system-settings.service.ts`), ahead of every consumer. THIS ISSUE OWNS
+// SCHEMA ONLY — nothing in this build reads `ai.enabled` to gate a route, and
+// no controller exists yet that lets a caller actually run a model (#427,
+// #428, #431, #432).
+//
+// `BUILTIN_AI_PROVIDER_IDS` names the providers the platform SHIPS, not a closed
+// set (PP-14.6, #924): an app or package adds its own with `registerAiProvider`
+// (`@marinoscar/platform-api/ai`) and its id is any `AI_PROVIDER_ID_PATTERN`
+// string. Append only to the built-in list: the order is the admin UI's order.
+/**
+ * The id pattern of an AI provider: a lower-case letter, then lower-case
+ * letters, digits and hyphens, 2 to 48 characters. Also the provider part of
+ * an `ai.limits.perModel` key (`AI_LIMIT_MODEL_KEY_PATTERN`). Permanent once a
+ * provider's settings or keys are stored under it.
+ *
+ * @stability experimental
+ */
+exports.AI_PROVIDER_ID_PATTERN = /^[a-z][a-z0-9-]{1,47}$/;
+/**
+ * The id pattern of an AI model capability: a lower-case letter, then
+ * lower-case letters, digits and underscores, 2 to 48 characters
+ * (`audio_transcription`, `speaker_diarization`). Permanent once a catalog row
+ * or an override stores it. The vocabulary is open (PP-14.17, #935): the
+ * platform's own are `BUILTIN_AI_CAPABILITIES` in `@marinoscar/platform-api/ai`,
+ * an app adds its own with `registerAiCapability`.
+ *
+ * @stability experimental
+ */
+exports.AI_CAPABILITY_ID_PATTERN = /^[a-z][a-z0-9_]{1,47}$/;
+/**
+ * The id pattern of an AI operation: dot-separated lower-case segments of
+ * letters, digits and underscores, 2 to 64 characters in all
+ * (`responses`, `audio.transcribe`, `audio.diarize`). It is the `operation`
+ * column of a usage row, so it is permanent once one is written. Open
+ * (PP-14.17, #935): an app adds its own with `registerAiOperation`.
+ *
+ * @stability experimental
+ */
+exports.AI_OPERATION_ID_PATTERN = /^(?=.{2,64}$)[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*){0,3}$/;
+/**
+ * The id pattern of a registered AI feature (`registerAiFeature`): lower snake
+ * case, starting with a letter, at most 64 characters. Also the `feature`
+ * column of a usage row and of a run.
+ *
+ * @stability experimental
+ */
+exports.AI_FEATURE_ID_PATTERN = /^[a-z][a-z0-9_]{0,63}$/;
+/**
+ * The provider ids the platform ships an adapter and a settings slot for.
+ * Permanent strings. An app's own providers are not listed here: ask the API
+ * (`GET /api/admin/ai/config`, `GET /api/ai/config`) for the registered ones.
+ *
+ * @stability experimental
+ */
+exports.BUILTIN_AI_PROVIDER_IDS = ['openai', 'anthropic', 'gemini', 'azure-openai', 'openai-compatible'];
+/**
+ * The provider ids the platform ships.
+ *
+ * @deprecated Use {@link BUILTIN_AI_PROVIDER_IDS}. The list is no longer the set
+ *   of providers a deployment can use (PP-14.6, #924); kept as an alias for one release.
+ * @stability experimental
+ */
+exports.AI_PROVIDER_IDS = exports.BUILTIN_AI_PROVIDER_IDS;
+/**
+ * How this deployment sources the API key a call actually authenticates
+ * with.
+ *
+ *  - `byok`                    — every call uses the CALLING USER's own key
+ *    (`UserAiKey`). No call succeeds for a user who has not saved one.
+ *  - `byok_with_org_fallback`  — a user's own key is preferred; a user with
+ *    none falls back to a deployment-wide org key. What that org key is, and
+ *    where it lives, is deliberately not modelled here: like the object
+ *    storage secret access key, an org-wide AI key is CREDENTIAL material and
+ *    belongs in the encrypted credential store, never in this JSONB blob that
+ *    `GET /api/system-settings` returns wholesale — see the block comment
+ *    on `systemAiSchema` below.
+ *
+ * @stability experimental
+ */
+exports.AI_KEY_POLICIES = ['byok', 'byok_with_org_fallback'];
+/**
+ * Upper bound on `ai.usageRetentionDays` — ten years; anything longer is "forever" in practice.
+ *
+ * @stability experimental
+ */
+exports.AI_USAGE_RETENTION_MAX_DAYS = 3650;
+/**
+ * One `ai.hostedTools.mcpAllowedHosts` entry: a hostname (`mcp.example.com`)
+ * or a subdomain wildcard (`*.example.com`). No scheme, port or path — the
+ * scheme is always `https`, and the entry is compared with the URL's host.
+ *
+ * @stability experimental
+ */
+exports.AI_MCP_ALLOWED_HOST_PATTERN = /^(\*\.)?[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(\.[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$/;
+/**
+ * Most entries `ai.hostedTools.mcpAllowedHosts` may hold.
+ *
+ * @stability experimental
+ */
+exports.AI_MCP_ALLOWED_HOSTS_MAX = 100;
+/**
+ * One `ai.limits.perModel` key: `<provider>:<modelId>` — a lower-case
+ * provider id, a colon, then the model id exactly as the catalog lists it
+ * (`openai:gpt-4.1-mini`). The model id may itself contain colons.
+ *
+ * @stability experimental
+ */
+exports.AI_LIMIT_MODEL_KEY_PATTERN = /^[a-z0-9-]+:.+$/;
+/**
+ * Longest accepted `ai.limits.perModel` key.
+ *
+ * @stability experimental
+ */
+exports.AI_LIMIT_MODEL_KEY_MAX = 256;
+/**
+ * Most entries `ai.limits.perModel` may hold.
+ *
+ * @stability experimental
+ */
+exports.AI_LIMITS_PER_MODEL_MAX = 500;
+/**
+ * Upper bound on any one `ai.limits` number — a billion is "unlimited" in practice.
+ *
+ * @stability experimental
+ */
+exports.AI_LIMIT_VALUE_MAX = 1_000_000_000;
+/**
+ * Longest accepted `baseUrl` for the #448 slots.
+ *
+ * @stability experimental
+ */
+exports.AI_ENDPOINT_URL_MAX = 2048;
+/**
+ * Why an endpoint URL is refused, or null when it is acceptable. Shared with the admin DTOs.
+ *
+ * @stability experimental
+ */
+function aiEndpointUrlProblem(value, schemes) {
+    let url;
+    try {
+        url = new URL(value);
+    }
+    catch {
+        return 'Must be an absolute URL';
+    }
+    if (!schemes.includes(url.protocol.replace(/:$/, ''))) {
+        return `The scheme must be ${schemes.join(' or ')}`;
+    }
+    if (url.username || url.password)
+        return 'Credentials may not be embedded in the URL';
+    if (url.hash || value.includes('#'))
+        return 'A fragment (#...) is not allowed';
+    if (!url.hostname)
+        return 'A host is required';
+    return null;
+}
+/**
+ * Schemes a `providers['azure-openai'].baseUrl` may use.
+ *
+ * @stability experimental
+ */
+exports.AI_AZURE_ENDPOINT_SCHEMES = ['https'];
+/**
+ * Schemes a `providers['openai-compatible'].baseUrl` may use.
+ *
+ * @stability experimental
+ */
+exports.AI_COMPATIBLE_ENDPOINT_SCHEMES = ['http', 'https'];
+/**
+ * Which wire API an OpenAI-family adapter speaks.
+ *
+ * @stability experimental
+ */
+exports.AI_OPENAI_API_STYLES = ['responses', 'chat_completions'];
+/**
+ * An Azure `api-version` query value (`2025-04-01-preview`, `2024-10-21`,
+ * `preview`). A plain token: it is sent as a query parameter and nothing else.
+ *
+ * @stability experimental
+ */
+exports.AI_AZURE_API_VERSION_PATTERN = /^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$/;
+/**
+ * An Azure deployment name: letters, digits, `.`, `_` and `-`, at most 64.
+ *
+ * @stability experimental
+ */
+exports.AI_AZURE_DEPLOYMENT_PATTERN = /^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$/;
+/**
+ * Most entries `providers['azure-openai'].deployments` may hold.
+ *
+ * @stability experimental
+ */
+exports.AI_AZURE_DEPLOYMENTS_MAX = 200;
+/**
+ * Longest accepted model id key in `deployments`.
+ *
+ * @stability experimental
+ */
+exports.AI_AZURE_MODEL_ID_MAX = 256;
+// ---- organization keys (`/api/admin/ai/org-keys`) ---------------------------
+/**
+ * Shortest key the org-key route accepts (the deployment-key route's bound).
+ *
+ * @stability experimental
+ */
+exports.ORG_AI_KEY_MIN = 8;
+/**
+ * Longest key the org-key route accepts.
+ *
+ * @stability experimental
+ */
+exports.ORG_AI_KEY_MAX = 512;
+//# sourceMappingURL=constants.js.map

package/dist/cjs/ai/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/ai/constants.ts"],"names":[],"mappings":";AAAA,gFAAgF;AAChF,yDAAyD;AACzD,gFAAgF;AAChF,EAAE;AACF,uEAAuE;AACvE,8EAA8E;AAC9E,wEAAwE;AACxE,8EAA8E;AAC9E,gFAAgF;;;AA+LhF,oDAkBC;AA/MD,gFAAgF;AAChF,+DAA+D;AAC/D,gFAAgF;AAChF,EAAE;AACF,6EAA6E;AAC7E,0EAA0E;AAC1E,oEAAoE;AACpE,0EAA0E;AAC1E,8EAA8E;AAC9E,0EAA0E;AAC1E,qBAAqB;AACrB,EAAE;AACF,iFAAiF;AACjF,gFAAgF;AAChF,6EAA6E;AAC7E,+EAA+E;AAC/E;;;;;;;GAOG;AACU,QAAA,sBAAsB,GAAG,wBAAwB,CAAC;AAE/D;;;;;;;;;GASG;AACU,QAAA,wBAAwB,GAAG,wBAAwB,CAAC;AAEjE;;;;;;;;GAQG;AACU,QAAA,uBAAuB,GAAG,uDAAuD,CAAC;AAE/F;;;;;;GAMG;AACU,QAAA,qBAAqB,GAAG,wBAAwB,CAAC;AAE9D;;;;;;GAMG;AACU,QAAA,uBAAuB,GAAG,CAAC,QAAQ,EAAE,WAAW,EAAE,QAAQ,EAAE,cAAc,EAAE,mBAAmB,CAAU,CAAC;AAEvH;;;;;;GAMG;AACU,QAAA,eAAe,GAAG,+BAAuB,CAAC;AAiBvD;;;;;;;;;;;;;;;GAeG;AACU,QAAA,eAAe,GAAG,CAAC,MAAM,EAAE,wBAAwB,CAAU,CAAC;AAS3E;;;;GAIG;AACU,QAAA,2BAA2B,GAAG,IAAI,CAAC;AAEhD;;;;;;GAMG;AACU,QAAA,2BAA2B,GACtC,sGAAsG,CAAC;AAEzG;;;;GAIG;AACU,QAAA,wBAAwB,GAAG,GAAG,CAAC;AAE5C;;;;;;GAMG;AACU,QAAA,0BAA0B,GAAG,iBAAiB,CAAC;AAE5D;;;;GAIG;AACU,QAAA,sBAAsB,GAAG,GAAG,CAAC;AAE1C;;;;GAIG;AACU,QAAA,uBAAuB,GAAG,GAAG,CAAC;AAE3C;;;;GAIG;AACU,QAAA,kBAAkB,GAAG,aAAa,CAAC;AAShD;;;;GAIG;AACU,QAAA,mBAAmB,GAAG,IAAI,CAAC;AAExC;;;;GAIG;AACH,SAAgB,oBAAoB,CAAC,KAAa,EAAE,OAA0B;IAC5E,IAAI,GAAQ,CAAC;IAEb,IAAI,CAAC;QACH,GAAG,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC;IACvB,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,yBAAyB,CAAC;IACnC,CAAC;IAED,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC;QACtD,OAAO,sBAAsB,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;IACtD,CAAC;IAED,IAAI,GAAG,CAAC,QAAQ,IAAI,GAAG,CAAC,QAAQ;QAAE,OAAO,4CAA4C,CAAC;IACtF,IAAI,GAAG,CAAC,IAAI,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC;QAAE,OAAO,kCAAkC,CAAC;IAC/E,IAAI,CAAC,GAAG,CAAC,QAAQ;QAAE,OAAO,oBAAoB,CAAC;IAE/C,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;GAIG;AACU,QAAA,yBAAyB,GAAG,CAAC,OAAO,CAAU,CAAC;AAE5D;;;;GAIG;AACU,QAAA,8BAA8B,GAAG,CAAC,MAAM,EAAE,OAAO,CAAU,CAAC;AAEzE;;;;GAIG;AACU,QAAA,oBAAoB,GAAG,CAAC,WAAW,EAAE,kBAAkB,CAAU,CAAC;AAiB/E;;;;;GAKG;AACU,QAAA,4BAA4B,GAAG,mCAAmC,CAAC;AAEhF;;;;GAIG;AACU,QAAA,2BAA2B,GAAG,mCAAmC,CAAC;AAE/E;;;;GAIG;AACU,QAAA,wBAAwB,GAAG,GAAG,CAAC;AAE5C;;;;GAIG;AACU,QAAA,qBAAqB,GAAG,GAAG,CAAC;AAkBzC,gFAAgF;AAEhF;;;;GAIG;AACU,QAAA,cAAc,GAAG,CAAC,CAAC;AAGhC;;;;GAIG;AACU,QAAA,cAAc,GAAG,GAAG,CAAC"}

package/dist/cjs/ai/features.d.ts

@@ -0,0 +1,24 @@
+import { z } from 'zod';
+/**
+ * One registered AI feature, as `GET /api/ai/features` lists it.
+ *
+ * @stability experimental
+ */
+export declare const aiFeatureViewSchema: z.ZodObject<{
+    id: z.ZodString;
+    label: z.ZodString;
+    group: z.ZodNullable<z.ZodString>;
+    needs: z.ZodArray<z.ZodString>;
+    inputModalities: z.ZodArray<z.ZodString>;
+    providers: z.ZodNullable<z.ZodArray<z.ZodString>>;
+    requiresHostedTools: z.ZodArray<z.ZodString>;
+    defaultEffort: z.ZodNullable<z.ZodString>;
+    usable: z.ZodBoolean;
+}, z.core.$strip>;
+/**
+ * One registered AI feature on the wire.
+ *
+ * @stability experimental
+ */
+export type AiFeatureView = z.infer<typeof aiFeatureViewSchema>;
+//# sourceMappingURL=features.d.ts.map

package/dist/cjs/ai/features.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"features.d.ts","sourceRoot":"","sources":["../../../src/ai/features.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;;GAIG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;;iBAmB9B,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC"}

package/dist/cjs/ai/features.js

@@ -0,0 +1,33 @@
+"use strict";
+// The wire shape of `GET /api/ai/features` (issue #739): every AI feature an
+// app registered (`registerAiFeature` of `@marinoscar/platform-api/ai`) and,
+// per feature, whether the caller has a usable model for it right now.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.aiFeatureViewSchema = void 0;
+const zod_1 = require("zod");
+/**
+ * One registered AI feature, as `GET /api/ai/features` lists it.
+ *
+ * @stability experimental
+ */
+exports.aiFeatureViewSchema = zod_1.z.object({
+    /** The feature id (`registerAiFeature`). */
+    id: zod_1.z.string(),
+    /** Its display label. */
+    label: zod_1.z.string(),
+    /** Its group, for a picker. */
+    group: zod_1.z.string().nullable(),
+    /** The capabilities a model must declare. */
+    needs: zod_1.z.array(zod_1.z.string()),
+    /** The input modalities a model must read. */
+    inputModalities: zod_1.z.array(zod_1.z.string()),
+    /** The providers a model must be from; `null` means any. */
+    providers: zod_1.z.array(zod_1.z.string()).nullable(),
+    /** The hosted tools a model must run. */
+    requiresHostedTools: zod_1.z.array(zod_1.z.string()),
+    /** The reasoning effort the feature asks for, if any. */
+    defaultEffort: zod_1.z.string().nullable(),
+    /** Whether the caller has a usable model for it right now. */
+    usable: zod_1.z.boolean(),
+});
+//# sourceMappingURL=features.js.map

package/dist/cjs/ai/features.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"features.js","sourceRoot":"","sources":["../../../src/ai/features.ts"],"names":[],"mappings":";AAAA,6EAA6E;AAC7E,6EAA6E;AAC7E,uEAAuE;;;AAEvE,6BAAwB;AAExB;;;;GAIG;AACU,QAAA,mBAAmB,GAAG,OAAC,CAAC,MAAM,CAAC;IAC1C,4CAA4C;IAC5C,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE;IACd,yBAAyB;IACzB,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;IACjB,+BAA+B;IAC/B,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,6CAA6C;IAC7C,KAAK,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC;IAC1B,8CAA8C;IAC9C,eAAe,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC;IACpC,4DAA4D;IAC5D,SAAS,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACzC,yCAAyC;IACzC,mBAAmB,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC;IACxC,yDAAyD;IACzD,aAAa,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACpC,8DAA8D;IAC9D,MAAM,EAAE,OAAC,CAAC,OAAO,EAAE;CACpB,CAAC,CAAC"}

package/dist/cjs/ai/index.d.ts

@@ -0,0 +1,11 @@
+export { AI_AZURE_API_VERSION_PATTERN, AI_AZURE_DEPLOYMENT_PATTERN, AI_AZURE_DEPLOYMENTS_MAX, AI_AZURE_ENDPOINT_SCHEMES, AI_AZURE_MODEL_ID_MAX, AI_CAPABILITY_ID_PATTERN, AI_COMPATIBLE_ENDPOINT_SCHEMES, AI_ENDPOINT_URL_MAX, AI_FEATURE_ID_PATTERN, AI_KEY_POLICIES, AI_LIMIT_MODEL_KEY_MAX, AI_LIMIT_MODEL_KEY_PATTERN, AI_LIMIT_VALUE_MAX, AI_LIMITS_PER_MODEL_MAX, AI_MCP_ALLOWED_HOST_PATTERN, AI_MCP_ALLOWED_HOSTS_MAX, AI_OPENAI_API_STYLES, AI_OPERATION_ID_PATTERN, AI_PROVIDER_ID_PATTERN, AI_PROVIDER_IDS, BUILTIN_AI_PROVIDER_IDS, AI_USAGE_RETENTION_MAX_DAYS, ORG_AI_KEY_MAX, ORG_AI_KEY_MIN, aiEndpointUrlProblem, } from './constants.js';
+export type { AiKeyPolicy, AiKeyPolicyEnum, AiOpenAiApiStyle, AiOpenAiApiStyleEnum, AiProviderId, BuiltinAiProviderId, AiSecretFieldNames, KeyMaterialFieldNames, } from './constants.js';
+export { orgAiProvidersSchema, orgAiSettingsSchema, tightenAiPolicy, AI_SETTINGS_CARRIES_NO_SECRET, aiAzureDeploymentsSchema, aiEndpointUrlSchema, aiLimitsSettingsSchema, aiProviderIdSchema, aiProviderSlotPatchSchema, aiProviderSlotSchema, aiProvidersResponseSchema, aiLimitValueSchema, aiResponseSchema, aiSettingsPatchSchema, aiSettingsSchema, systemAiAzureProviderSchema, systemAiCompatibleProviderSchema, systemAiLimitsSchema, systemAiPatchSchema, systemAiProviderSchema, systemAiProvidersPatchSchema, systemAiProvidersSchema, systemAiSchema, userAiSettingsPatchSchema, userAiSettingsSchema, } from './schemas.js';
+export type { OrgAiSettingsValue, AiSettingsCarriesNoSecret, SystemAiLimitsValue, SystemAiValue, UserAiSettingsPatchValue, UserAiSettingsValue, } from './schemas.js';
+export { aiFeatureViewSchema } from './features.js';
+export type { AiFeatureView } from './features.js';
+export { ORG_AI_KEY_VIEW_CARRIES_NO_SECRET, orgAiKeyViewSchema, setOrgAiKeySchema } from './org-keys.js';
+export type { OrgAiKeyView, OrgAiKeyViewCarriesNoSecret, SetOrgAiKeyInput } from './org-keys.js';
+export { aiCapabilitiesResponseSchema, aiCapabilityDescriptorSchema, aiCapabilityIdSchema, aiFeatureIdSchema, aiOperationDescriptorSchema, aiOperationIdSchema, aiUsageCostSchema, } from './capabilities.js';
+export type { AiCapabilitiesResponse, AiCapabilityDescriptor, AiOperationDescriptor, AiUsageCost, } from './capabilities.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/cjs/ai/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/ai/index.ts"],"names":[],"mappings":"AAQA,OAAO,EACL,4BAA4B,EAC5B,2BAA2B,EAC3B,wBAAwB,EACxB,yBAAyB,EACzB,qBAAqB,EACrB,wBAAwB,EACxB,8BAA8B,EAC9B,mBAAmB,EACnB,qBAAqB,EACrB,eAAe,EACf,sBAAsB,EACtB,0BAA0B,EAC1B,kBAAkB,EAClB,uBAAuB,EACvB,2BAA2B,EAC3B,wBAAwB,EACxB,oBAAoB,EACpB,uBAAuB,EACvB,sBAAsB,EACtB,eAAe,EACf,uBAAuB,EACvB,2BAA2B,EAC3B,cAAc,EACd,cAAc,EACd,oBAAoB,GACrB,MAAM,gBAAgB,CAAC;AACxB,YAAY,EACV,WAAW,EACX,eAAe,EACf,gBAAgB,EAChB,oBAAoB,EACpB,YAAY,EACZ,mBAAmB,EACnB,kBAAkB,EAClB,qBAAqB,GACtB,MAAM,gBAAgB,CAAC;AAGxB,OAAO,EACL,oBAAoB,EACpB,mBAAmB,EACnB,eAAe,EACf,6BAA6B,EAC7B,wBAAwB,EACxB,mBAAmB,EACnB,sBAAsB,EACtB,kBAAkB,EAClB,yBAAyB,EACzB,oBAAoB,EACpB,yBAAyB,EACzB,kBAAkB,EAClB,gBAAgB,EAChB,qBAAqB,EACrB,gBAAgB,EAChB,2BAA2B,EAC3B,gCAAgC,EAChC,oBAAoB,EACpB,mBAAmB,EACnB,sBAAsB,EACtB,4BAA4B,EAC5B,uBAAuB,EACvB,cAAc,EACd,yBAAyB,EACzB,oBAAoB,GACrB,MAAM,cAAc,CAAC;AACtB,YAAY,EACV,kBAAkB,EAClB,yBAAyB,EACzB,mBAAmB,EACnB,aAAa,EACb,wBAAwB,EACxB,mBAAmB,GACpB,MAAM,cAAc,CAAC;AAGtB,OAAO,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AACpD,YAAY,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,EAAE,iCAAiC,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AACzG,YAAY,EAAE,YAAY,EAAE,2BAA2B,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAGjG,OAAO,EACL,4BAA4B,EAC5B,4BAA4B,EAC5B,oBAAoB,EACpB,iBAAiB,EACjB,2BAA2B,EAC3B,mBAAmB,EACnB,iBAAiB,GAClB,MAAM,mBAAmB,CAAC;AAC3B,YAAY,EACV,sBAAsB,EACtB,sBAAsB,EACtB,qBAAqB,EACrB,WAAW,GACZ,MAAM,mBAAmB,CAAC"}