@x12i/ai-dispatcher 2.0.0 → 2.2.0

package/dist/index.d.cts

@@ -1,6 +1,6 @@
 import * as _x12i_openrouter_runtime from '@x12i/openrouter-runtime';
 import { RuntimeToolExecutor, RuntimeLogger, RuntimeRequest, RuntimeResponse, RuntimeUsage, RuntimeStreamEvent, CompiledOpenRouterRequest, OpenRouterRuntimeOptions } from '@x12i/openrouter-runtime';
-export { CompiledOpenRouterRequest, OpenRouterRuntimeOptions, RuntimeDefaults, RuntimeLogger, RuntimeMessage, RuntimeRequest, RuntimeResponse, RuntimeServerToolsPolicy, RuntimeStreamEvent, decodeProviderMetadata } from '@x12i/openrouter-runtime';
+export { CompiledOpenRouterRequest, METADATA_NORMALIZATION_MAP, NormalizedMetadataKey, OpenRouterRuntimeOptions, RuntimeDefaults, RuntimeLogger, RuntimeMessage, RuntimeRequest, RuntimeResponse, RuntimeServerToolsPolicy, RuntimeStreamEvent, canonicalMetadataKey, decodeProviderMetadata, normalizeMetadata } from '@x12i/openrouter-runtime';
 import { ReasoningEffort, ReasoningOutcome } from '@x12i/ai-profiles';
 export { ReasoningEffort, ReasoningOutcome } from '@x12i/ai-profiles';
 import { CompiledBedrockRequest, BedrockRuntimeOptions } from '@x12i/bedrock-runtime';
@@ -215,6 +215,13 @@ interface AiDispatcherOptions {
     cloudflare?: CloudflareRuntimeOptions;
     /** Connected MCP servers. The dispatcher does not open transports. */
     mcp?: DispatcherMcpOptions;
+    /**
+     * Highest priority first for the one metadata record.
+     * Listed keys are kept ahead of keys that are not in the list.
+     * The dispatcher trims on every call and adds a `METADATA_RECORD_TRIMMED` warning when it drops keys.
+     * The default keeps `agentId`, `orgId`, `stepId`, `skillId`, `recordId`, and `objectType`.
+     */
+    metadataPriority?: readonly string[];
     logger?: RuntimeLogger;
 }
 interface CompiledOpenAiRequest {
@@ -294,6 +301,8 @@ interface AiDispatcher {
     readonly provider: AiProviderId;
 }
 
+/** Identity keys stay when a record has to be trimmed. Earlier entries are kept ahead of later ones. */
+declare const DEFAULT_METADATA_PRIORITY: readonly ["agentId", "orgId", "stepId", "skillId", "recordId", "objectType"];
 declare function createAiDispatcher(options?: AiDispatcherOptions): AiDispatcher;
 
 declare class AiDispatcherError extends Error {
@@ -311,4 +320,4 @@ declare function stripReasoningHistoryFields<T>(message: T, paths: readonly stri
 
 declare function resolveProvider(requestProvider: AiProviderId | undefined, defaultProvider: AiProviderId): ImplementedAiProvider;
 
-export { type AiDispatcher, AiDispatcherError, type AiDispatcherOptions, type AiDispatcherRequest, type AiDispatcherResponse, type AiDispatcherUsage, type AiProviderAdapter, type AiProviderId, type CacheMode, type CacheOutcome, type CachePolicy, type CacheResolution, type CacheTtl, type CloudflareBackoff, type CloudflareCallContext, type CloudflareEndpoint, type CloudflareEndpointChoice, type CloudflareGatewayControls, type CloudflareRequestOptions, type CloudflareRunOptions, type CloudflareRuntimeOptions, type CloudflareWebhookFormat, type CompiledAiRequest, type CompiledCloudflareRequest, type CompiledOpenAiRequest, type DispatcherMcpOptions, type DispatcherMcpServer, type DispatcherMcpTool, IMPLEMENTED_AI_PROVIDERS, type ImplementedAiProvider, type OpenAiRuntimeOptions, type ReasoningResolution, createAiDispatcher, isImplementedAiProvider, providerNotImplemented, resolveProvider, stripReasoningHistoryFields };
+export { type AiDispatcher, AiDispatcherError, type AiDispatcherOptions, type AiDispatcherRequest, type AiDispatcherResponse, type AiDispatcherUsage, type AiProviderAdapter, type AiProviderId, type CacheMode, type CacheOutcome, type CachePolicy, type CacheResolution, type CacheTtl, type CloudflareBackoff, type CloudflareCallContext, type CloudflareEndpoint, type CloudflareEndpointChoice, type CloudflareGatewayControls, type CloudflareRequestOptions, type CloudflareRunOptions, type CloudflareRuntimeOptions, type CloudflareWebhookFormat, type CompiledAiRequest, type CompiledCloudflareRequest, type CompiledOpenAiRequest, DEFAULT_METADATA_PRIORITY, type DispatcherMcpOptions, type DispatcherMcpServer, type DispatcherMcpTool, IMPLEMENTED_AI_PROVIDERS, type ImplementedAiProvider, type OpenAiRuntimeOptions, type ReasoningResolution, createAiDispatcher, isImplementedAiProvider, providerNotImplemented, resolveProvider, stripReasoningHistoryFields };

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import * as _x12i_openrouter_runtime from '@x12i/openrouter-runtime';
 import { RuntimeToolExecutor, RuntimeLogger, RuntimeRequest, RuntimeResponse, RuntimeUsage, RuntimeStreamEvent, CompiledOpenRouterRequest, OpenRouterRuntimeOptions } from '@x12i/openrouter-runtime';
-export { CompiledOpenRouterRequest, OpenRouterRuntimeOptions, RuntimeDefaults, RuntimeLogger, RuntimeMessage, RuntimeRequest, RuntimeResponse, RuntimeServerToolsPolicy, RuntimeStreamEvent, decodeProviderMetadata } from '@x12i/openrouter-runtime';
+export { CompiledOpenRouterRequest, METADATA_NORMALIZATION_MAP, NormalizedMetadataKey, OpenRouterRuntimeOptions, RuntimeDefaults, RuntimeLogger, RuntimeMessage, RuntimeRequest, RuntimeResponse, RuntimeServerToolsPolicy, RuntimeStreamEvent, canonicalMetadataKey, decodeProviderMetadata, normalizeMetadata } from '@x12i/openrouter-runtime';
 import { ReasoningEffort, ReasoningOutcome } from '@x12i/ai-profiles';
 export { ReasoningEffort, ReasoningOutcome } from '@x12i/ai-profiles';
 import { CompiledBedrockRequest, BedrockRuntimeOptions } from '@x12i/bedrock-runtime';
@@ -215,6 +215,13 @@ interface AiDispatcherOptions {
     cloudflare?: CloudflareRuntimeOptions;
     /** Connected MCP servers. The dispatcher does not open transports. */
     mcp?: DispatcherMcpOptions;
+    /**
+     * Highest priority first for the one metadata record.
+     * Listed keys are kept ahead of keys that are not in the list.
+     * The dispatcher trims on every call and adds a `METADATA_RECORD_TRIMMED` warning when it drops keys.
+     * The default keeps `agentId`, `orgId`, `stepId`, `skillId`, `recordId`, and `objectType`.
+     */
+    metadataPriority?: readonly string[];
     logger?: RuntimeLogger;
 }
 interface CompiledOpenAiRequest {
@@ -294,6 +301,8 @@ interface AiDispatcher {
     readonly provider: AiProviderId;
 }
 
+/** Identity keys stay when a record has to be trimmed. Earlier entries are kept ahead of later ones. */
+declare const DEFAULT_METADATA_PRIORITY: readonly ["agentId", "orgId", "stepId", "skillId", "recordId", "objectType"];
 declare function createAiDispatcher(options?: AiDispatcherOptions): AiDispatcher;
 
 declare class AiDispatcherError extends Error {
@@ -311,4 +320,4 @@ declare function stripReasoningHistoryFields<T>(message: T, paths: readonly stri
 
 declare function resolveProvider(requestProvider: AiProviderId | undefined, defaultProvider: AiProviderId): ImplementedAiProvider;
 
-export { type AiDispatcher, AiDispatcherError, type AiDispatcherOptions, type AiDispatcherRequest, type AiDispatcherResponse, type AiDispatcherUsage, type AiProviderAdapter, type AiProviderId, type CacheMode, type CacheOutcome, type CachePolicy, type CacheResolution, type CacheTtl, type CloudflareBackoff, type CloudflareCallContext, type CloudflareEndpoint, type CloudflareEndpointChoice, type CloudflareGatewayControls, type CloudflareRequestOptions, type CloudflareRunOptions, type CloudflareRuntimeOptions, type CloudflareWebhookFormat, type CompiledAiRequest, type CompiledCloudflareRequest, type CompiledOpenAiRequest, type DispatcherMcpOptions, type DispatcherMcpServer, type DispatcherMcpTool, IMPLEMENTED_AI_PROVIDERS, type ImplementedAiProvider, type OpenAiRuntimeOptions, type ReasoningResolution, createAiDispatcher, isImplementedAiProvider, providerNotImplemented, resolveProvider, stripReasoningHistoryFields };
+export { type AiDispatcher, AiDispatcherError, type AiDispatcherOptions, type AiDispatcherRequest, type AiDispatcherResponse, type AiDispatcherUsage, type AiProviderAdapter, type AiProviderId, type CacheMode, type CacheOutcome, type CachePolicy, type CacheResolution, type CacheTtl, type CloudflareBackoff, type CloudflareCallContext, type CloudflareEndpoint, type CloudflareEndpointChoice, type CloudflareGatewayControls, type CloudflareRequestOptions, type CloudflareRunOptions, type CloudflareRuntimeOptions, type CloudflareWebhookFormat, type CompiledAiRequest, type CompiledCloudflareRequest, type CompiledOpenAiRequest, DEFAULT_METADATA_PRIORITY, type DispatcherMcpOptions, type DispatcherMcpServer, type DispatcherMcpTool, IMPLEMENTED_AI_PROVIDERS, type ImplementedAiProvider, type OpenAiRuntimeOptions, type ReasoningResolution, createAiDispatcher, isImplementedAiProvider, providerNotImplemented, resolveProvider, stripReasoningHistoryFields };

package/dist/index.js

@@ -1,5 +1,13 @@
 // src/index.ts
-import { decodeProviderMetadata } from "@x12i/openrouter-runtime";
+import {
+  decodeProviderMetadata,
+  METADATA_NORMALIZATION_MAP,
+  canonicalMetadataKey,
+  normalizeMetadata
+} from "@x12i/openrouter-runtime";
+
+// src/create-dispatcher.ts
+import { createMetadataPacker } from "@x12i/provider-metadata";
 
 // src/cache-usage.ts
 function readCacheTokens(source) {
@@ -1125,8 +1133,7 @@ function isRouterImplicit(id) {
 
 // src/providers/cloudflare.ts
 import {
-  OPENROUTER_METADATA_LIMITS,
-  toProviderMetadata
+  packProviderRecord
 } from "@x12i/openrouter-runtime";
 var DEFAULT_BASE_URL = "https://api.cloudflare.com/client/v4";
 var DEFAULT_TIMEOUT_MS = 12e4;
@@ -1154,8 +1161,8 @@ function restoreCloudflareModel(model, prefix) {
   if (!prefix || model.includes("/")) return model;
   return `${prefix}${model}`;
 }
-function createCloudflareProviderAdapter(options = {}) {
-  const resolved = resolveCloudflareOptions(options);
+function createCloudflareProviderAdapter(options = {}, packer) {
+  const resolved = resolveCloudflareOptions(options, packer);
   return {
     compile(request, call) {
       return compileCloudflareRequest(request, resolved, call, false);
@@ -1208,12 +1215,13 @@ function compileCloudflareRequest(request, options, call, streaming) {
   if (endpoint !== "run") body = { ...body, stream: streaming };
   const gateway = mergeGateway(options.gateway, call?.cloudflare?.gateway);
   const fromBody = isRecord5(body.metadata) ? body.metadata : void 0;
-  const record2 = toProviderMetadata(
+  const packed = packProviderRecord(
     request.metadata,
     request.agentId,
-    OPENROUTER_METADATA_LIMITS,
-    overlayMetadata(gateway?.metadata, fromBody)
+    overlayMetadata(gateway?.metadata, fromBody),
+    options.metadataPacker
   );
+  const record2 = packed.wire;
   body = applyProviderRecord(body, record2);
   if (endpoint === "run") body = wrapRun(body, run);
   return {
@@ -1221,7 +1229,7 @@ function compileCloudflareRequest(request, options, call, streaming) {
     url: endpointUrl(options, endpoint),
     headers: buildHeaders(options, call?.cloudflare, model, record2),
     body,
-    warnings: []
+    warnings: packed.warning ? [packed.warning] : []
   };
 }
 function compileResponsesBody(request, model) {
@@ -2270,7 +2278,7 @@ function parseSsePart(part) {
     return void 0;
   }
 }
-function resolveCloudflareOptions(options) {
+function resolveCloudflareOptions(options, packer) {
   const {
     apiToken,
     accountId,
@@ -2299,7 +2307,8 @@ function resolveCloudflareOptions(options) {
     maxAttempts: maxAttempts ?? 2,
     fetch: fetch ?? globalThis.fetch,
     ...tools ? { tools } : {},
-    ...logger ? { logger } : {}
+    ...logger ? { logger } : {},
+    ...packer ? { metadataPacker: packer } : {}
   };
 }
 function hasGateway(gateway) {
@@ -2814,13 +2823,12 @@ function isBedrockToolChoice(toolChoice) {
 
 // src/providers/openai.ts
 import {
-  OPENROUTER_METADATA_LIMITS as OPENROUTER_METADATA_LIMITS2,
-  toProviderMetadata as toProviderMetadata2
+  packProviderRecord as packProviderRecord2
 } from "@x12i/openrouter-runtime";
 var DEFAULT_BASE_URL2 = "https://api.openai.com/v1";
 var DEFAULT_TIMEOUT_MS2 = 12e4;
-function createOpenAiProviderAdapter(options = {}) {
-  const resolved = resolveOpenAiOptions(options);
+function createOpenAiProviderAdapter(options = {}, packer) {
+  const resolved = resolveOpenAiOptions(options, packer);
   return {
     compile(request, call) {
       return compileOpenAiRequest(request, resolved, call, false);
@@ -2873,12 +2881,13 @@ function compileOpenAiRequest(request, options, call, streaming) {
   if (call?.finalizeBody) body = call.finalizeBody(body);
   if (streaming) body = { ...body, stream: true };
   else body = { ...body, stream: false };
-  body = attachProviderMetadata(body, request);
+  const packed = attachProviderMetadata(body, request, options.metadataPacker);
+  body = packed.body;
   return {
     url: `${options.baseUrl}/responses`,
     headers: buildHeaders2(options),
     body,
-    warnings: []
+    warnings: packed.warning ? [packed.warning] : []
   };
 }
 function assertSupported2(request) {
@@ -3378,14 +3387,14 @@ function messageFrom2(body) {
 function numberValue2(value) {
   return typeof value === "number" && Number.isFinite(value) ? value : void 0;
 }
-function attachProviderMetadata(body, request) {
+function attachProviderMetadata(body, request, packer) {
   const fromBody = isRecord7(body.metadata) ? body.metadata : void 0;
-  const metadata = toProviderMetadata2(request.metadata, request.agentId, OPENROUTER_METADATA_LIMITS2, fromBody);
-  if (metadata) return { ...body, metadata };
-  if (body.metadata === void 0) return body;
+  const packed = packProviderRecord2(request.metadata, request.agentId, fromBody, packer);
+  if (packed.wire) return { body: { ...body, metadata: packed.wire }, ...packed.warning ? { warning: packed.warning } : {} };
+  if (body.metadata === void 0) return { body, ...packed.warning ? { warning: packed.warning } : {} };
   const rest = { ...body };
   delete rest.metadata;
-  return rest;
+  return { body: rest, ...packed.warning ? { warning: packed.warning } : {} };
 }
 function clean2(body) {
   return Object.fromEntries(Object.entries(body).filter(([, value]) => value !== void 0));
@@ -3433,7 +3442,7 @@ function parseSsePart2(part) {
     return void 0;
   }
 }
-function resolveOpenAiOptions(options) {
+function resolveOpenAiOptions(options, packer) {
   const baseUrl = (options.baseUrl ?? DEFAULT_BASE_URL2).replace(/\/+$/, "");
   return {
     apiKey: options.apiKey ?? readEnv3("OPENAI_API_KEY") ?? "",
@@ -3445,7 +3454,8 @@ function resolveOpenAiOptions(options) {
     maxAttempts: options.maxAttempts ?? 3,
     fetch: options.fetch ?? globalThis.fetch,
     ...options.tools ? { tools: options.tools } : {},
-    ...options.logger ? { logger: options.logger } : {}
+    ...options.logger ? { logger: options.logger } : {},
+    ...packer ? { metadataPacker: packer } : {}
   };
 }
 function readEnv3(name) {
@@ -3500,7 +3510,9 @@ function resolveProvider(requestProvider, defaultProvider) {
 
 // src/create-dispatcher.ts
 var SECRET_HEADERS = /* @__PURE__ */ new Set(["authorization", "x-api-key", "api-key"]);
+var DEFAULT_METADATA_PRIORITY = ["agentId", "orgId", "stepId", "skillId", "recordId", "objectType"];
 function createAiDispatcher(options = {}) {
+  const packer = createMetadataPacker({ priority: options.metadataPriority ?? DEFAULT_METADATA_PRIORITY });
   const defaultProvider = resolveProvider(options.provider, "openrouter");
   const catalog = createMcpCatalog(options.mcp);
   let refreshChain = Promise.resolve();
@@ -3509,6 +3521,7 @@ function createAiDispatcher(options = {}) {
     if (provider === "openrouter") {
       const openrouterOptions = {
         ...options.openrouter,
+        metadataPacker: packer,
         ...options.logger && !options.openrouter?.logger ? { logger: options.logger } : {}
       };
       return createOpenRouterProviderAdapter(openrouterOptions);
@@ -3516,6 +3529,7 @@ function createAiDispatcher(options = {}) {
     if (provider === "bedrock") {
       const bedrockOptions = {
         ...options.bedrock,
+        metadataPacker: packer,
         ...options.logger && !options.bedrock?.logger ? { logger: options.logger } : {}
       };
       return createBedrockProviderAdapter(bedrockOptions);
@@ -3525,14 +3539,14 @@ function createAiDispatcher(options = {}) {
         ...options.openai,
         ...options.logger && !options.openai?.logger ? { logger: options.logger } : {}
       };
-      return createOpenAiProviderAdapter(openaiOptions);
+      return createOpenAiProviderAdapter(openaiOptions, packer);
     }
     if (provider === "cloudflare") {
       const cloudflareOptions = {
         ...options.cloudflare,
         ...options.logger && !options.cloudflare?.logger ? { logger: options.logger } : {}
       };
-      return createCloudflareProviderAdapter(cloudflareOptions);
+      return createCloudflareProviderAdapter(cloudflareOptions, packer);
     }
     throw new AiDispatcherError(
       "PROVIDER_ADAPTER_MISSING",
@@ -3652,10 +3666,14 @@ function stripReasoningHistoryFields(message, paths) {
 }
 export {
   AiDispatcherError,
+  DEFAULT_METADATA_PRIORITY,
   IMPLEMENTED_AI_PROVIDERS,
+  METADATA_NORMALIZATION_MAP,
+  canonicalMetadataKey,
   createAiDispatcher,
   decodeProviderMetadata,
   isImplementedAiProvider,
+  normalizeMetadata,
   providerNotImplemented,
   resolveProvider,
   stripReasoningHistoryFields