@x12i/openrouter-runtime 2.0.0 → 2.2.0

package/dist/index.d.cts

@@ -1,3 +1,7 @@
+import * as _x12i_provider_metadata from '@x12i/provider-metadata';
+import { MetadataPacker, MetadataTrimWarning } from '@x12i/provider-metadata';
+export { METADATA_NORMALIZATION_MAP, NormalizedMetadataKey, canonicalMetadataKey, normalizeMetadata } from '@x12i/provider-metadata';
+
 type ApiMode = "chat" | "responses" | "auto";
 type ResolvedApiMode = "chat" | "responses";
 type ToolMode = "disabled" | "allowed" | "required";
@@ -24,6 +28,11 @@ interface OpenRouterRuntime {
 }
 interface OpenRouterRuntimeOptions {
     apiKey?: string;
+    /**
+     * Trims the metadata record to the provider limit and reports dropped keys.
+     * Omit it and an oversized record throws `METADATA_RECORD_TOO_LARGE`.
+     */
+    metadataPacker?: _x12i_provider_metadata.MetadataPacker;
     baseUrl?: string;
     defaultModel?: string;
     defaultHeaders?: Record<string, string>;
@@ -509,6 +518,10 @@ interface ProviderMetadataLimits {
 }
 /** OpenRouter and OpenAI metadata: 16 pairs, 64-character keys, 512-character values. */
 declare const OPENROUTER_METADATA_LIMITS: ProviderMetadataLimits;
+interface PackedProviderRecord {
+    wire?: Record<string, string>;
+    warning?: MetadataTrimWarning;
+}
 /**
  * One provider metadata record.
  * Callers pass `metadata` and `agentId`. Every provider stores the same `m.0`, `m.1`, ...
@@ -516,9 +529,13 @@ declare const OPENROUTER_METADATA_LIMITS: ProviderMetadataLimits;
  * `decodeProviderMetadata` restores that map from any provider log.
  * `limits` stays on the signature for existing callers. The record uses the strictest
  * provider limits, so the pairs do not change between providers.
+ * Without a packer, a record that does not fit throws `METADATA_RECORD_TOO_LARGE`.
+ * A packer drops the lowest-priority pairs and reports them.
  */
 declare function toProviderMetadata(metadata: Record<string, unknown> | undefined, agentId: string | undefined, _limits: ProviderMetadataLimits, base: Record<string, unknown> | undefined): Record<string, string> | undefined;
+/** Packs one record. A packer trims; otherwise an oversized record throws. */
+declare function packProviderRecord(metadata: Record<string, unknown> | undefined, agentId: string | undefined, base: Record<string, unknown> | undefined, packer?: MetadataPacker): PackedProviderRecord;
 /** Restores the string map from the `m.0`, `m.1`, ... pairs stored on a provider log. */
 declare function decodeProviderMetadata(wire: unknown): Record<string, string>;
 
-export { type AdvisorPolicy, type ApplyPatchPolicy, type CompiledOpenRouterRequest, type DatetimePolicy, type FusionPolicy, type ImageGenerationPolicy, OPENROUTER_METADATA_LIMITS, OpenRouterHttpError, type OpenRouterRuntime, type OpenRouterRuntimeOptions, type ProviderMetadataLimits, type RuntimeCallOptions, type RuntimeCitation, RuntimeConfigError, type RuntimeDefaults, type RuntimeError, type RuntimeFunctionToolDefinition, type RuntimeGeneratedImage, type RuntimeLogger, type RuntimeMessage, type RuntimePatchProposal, type RuntimePolicyViolation, type RuntimeRequest, type RuntimeResponse, type RuntimeServerToolsPolicy, type RuntimeStreamDoneEvent, type RuntimeStreamErrorEvent, type RuntimeStreamEvent, type RuntimeStreamEventType, type RuntimeStreamReasoningDeltaEvent, type RuntimeStreamStartEvent, type RuntimeStreamTextDeltaEvent, type RuntimeStreamToolCallDeltaEvent, type RuntimeStreamUsageEvent, type RuntimeStreamWarningEvent, type RuntimeToolExecutor, type RuntimeToolUsage, type RuntimeUsage, type RuntimeWarning, type ServerToolKey, type ServerToolUsage, type SubagentPolicy, type WebFetchPolicy, type WebSearchPolicy, buildOpenRouterServerTools, compileRuntimeRequest, createConsoleLogger, createOpenRouterRuntime, decodeProviderMetadata, isRuntimeLoggingEnabled, toProviderMetadata };
+export { type AdvisorPolicy, type ApplyPatchPolicy, type CompiledOpenRouterRequest, type DatetimePolicy, type FusionPolicy, type ImageGenerationPolicy, OPENROUTER_METADATA_LIMITS, OpenRouterHttpError, type OpenRouterRuntime, type OpenRouterRuntimeOptions, type ProviderMetadataLimits, type RuntimeCallOptions, type RuntimeCitation, RuntimeConfigError, type RuntimeDefaults, type RuntimeError, type RuntimeFunctionToolDefinition, type RuntimeGeneratedImage, type RuntimeLogger, type RuntimeMessage, type RuntimePatchProposal, type RuntimePolicyViolation, type RuntimeRequest, type RuntimeResponse, type RuntimeServerToolsPolicy, type RuntimeStreamDoneEvent, type RuntimeStreamErrorEvent, type RuntimeStreamEvent, type RuntimeStreamEventType, type RuntimeStreamReasoningDeltaEvent, type RuntimeStreamStartEvent, type RuntimeStreamTextDeltaEvent, type RuntimeStreamToolCallDeltaEvent, type RuntimeStreamUsageEvent, type RuntimeStreamWarningEvent, type RuntimeToolExecutor, type RuntimeToolUsage, type RuntimeUsage, type RuntimeWarning, type ServerToolKey, type ServerToolUsage, type SubagentPolicy, type WebFetchPolicy, type WebSearchPolicy, buildOpenRouterServerTools, compileRuntimeRequest, createConsoleLogger, createOpenRouterRuntime, decodeProviderMetadata, isRuntimeLoggingEnabled, packProviderRecord, toProviderMetadata };

package/dist/index.d.ts

@@ -1,3 +1,7 @@
+import * as _x12i_provider_metadata from '@x12i/provider-metadata';
+import { MetadataPacker, MetadataTrimWarning } from '@x12i/provider-metadata';
+export { METADATA_NORMALIZATION_MAP, NormalizedMetadataKey, canonicalMetadataKey, normalizeMetadata } from '@x12i/provider-metadata';
+
 type ApiMode = "chat" | "responses" | "auto";
 type ResolvedApiMode = "chat" | "responses";
 type ToolMode = "disabled" | "allowed" | "required";
@@ -24,6 +28,11 @@ interface OpenRouterRuntime {
 }
 interface OpenRouterRuntimeOptions {
     apiKey?: string;
+    /**
+     * Trims the metadata record to the provider limit and reports dropped keys.
+     * Omit it and an oversized record throws `METADATA_RECORD_TOO_LARGE`.
+     */
+    metadataPacker?: _x12i_provider_metadata.MetadataPacker;
     baseUrl?: string;
     defaultModel?: string;
     defaultHeaders?: Record<string, string>;
@@ -509,6 +518,10 @@ interface ProviderMetadataLimits {
 }
 /** OpenRouter and OpenAI metadata: 16 pairs, 64-character keys, 512-character values. */
 declare const OPENROUTER_METADATA_LIMITS: ProviderMetadataLimits;
+interface PackedProviderRecord {
+    wire?: Record<string, string>;
+    warning?: MetadataTrimWarning;
+}
 /**
  * One provider metadata record.
  * Callers pass `metadata` and `agentId`. Every provider stores the same `m.0`, `m.1`, ...
@@ -516,9 +529,13 @@ declare const OPENROUTER_METADATA_LIMITS: ProviderMetadataLimits;
  * `decodeProviderMetadata` restores that map from any provider log.
  * `limits` stays on the signature for existing callers. The record uses the strictest
  * provider limits, so the pairs do not change between providers.
+ * Without a packer, a record that does not fit throws `METADATA_RECORD_TOO_LARGE`.
+ * A packer drops the lowest-priority pairs and reports them.
  */
 declare function toProviderMetadata(metadata: Record<string, unknown> | undefined, agentId: string | undefined, _limits: ProviderMetadataLimits, base: Record<string, unknown> | undefined): Record<string, string> | undefined;
+/** Packs one record. A packer trims; otherwise an oversized record throws. */
+declare function packProviderRecord(metadata: Record<string, unknown> | undefined, agentId: string | undefined, base: Record<string, unknown> | undefined, packer?: MetadataPacker): PackedProviderRecord;
 /** Restores the string map from the `m.0`, `m.1`, ... pairs stored on a provider log. */
 declare function decodeProviderMetadata(wire: unknown): Record<string, string>;
 
-export { type AdvisorPolicy, type ApplyPatchPolicy, type CompiledOpenRouterRequest, type DatetimePolicy, type FusionPolicy, type ImageGenerationPolicy, OPENROUTER_METADATA_LIMITS, OpenRouterHttpError, type OpenRouterRuntime, type OpenRouterRuntimeOptions, type ProviderMetadataLimits, type RuntimeCallOptions, type RuntimeCitation, RuntimeConfigError, type RuntimeDefaults, type RuntimeError, type RuntimeFunctionToolDefinition, type RuntimeGeneratedImage, type RuntimeLogger, type RuntimeMessage, type RuntimePatchProposal, type RuntimePolicyViolation, type RuntimeRequest, type RuntimeResponse, type RuntimeServerToolsPolicy, type RuntimeStreamDoneEvent, type RuntimeStreamErrorEvent, type RuntimeStreamEvent, type RuntimeStreamEventType, type RuntimeStreamReasoningDeltaEvent, type RuntimeStreamStartEvent, type RuntimeStreamTextDeltaEvent, type RuntimeStreamToolCallDeltaEvent, type RuntimeStreamUsageEvent, type RuntimeStreamWarningEvent, type RuntimeToolExecutor, type RuntimeToolUsage, type RuntimeUsage, type RuntimeWarning, type ServerToolKey, type ServerToolUsage, type SubagentPolicy, type WebFetchPolicy, type WebSearchPolicy, buildOpenRouterServerTools, compileRuntimeRequest, createConsoleLogger, createOpenRouterRuntime, decodeProviderMetadata, isRuntimeLoggingEnabled, toProviderMetadata };
+export { type AdvisorPolicy, type ApplyPatchPolicy, type CompiledOpenRouterRequest, type DatetimePolicy, type FusionPolicy, type ImageGenerationPolicy, OPENROUTER_METADATA_LIMITS, OpenRouterHttpError, type OpenRouterRuntime, type OpenRouterRuntimeOptions, type ProviderMetadataLimits, type RuntimeCallOptions, type RuntimeCitation, RuntimeConfigError, type RuntimeDefaults, type RuntimeError, type RuntimeFunctionToolDefinition, type RuntimeGeneratedImage, type RuntimeLogger, type RuntimeMessage, type RuntimePatchProposal, type RuntimePolicyViolation, type RuntimeRequest, type RuntimeResponse, type RuntimeServerToolsPolicy, type RuntimeStreamDoneEvent, type RuntimeStreamErrorEvent, type RuntimeStreamEvent, type RuntimeStreamEventType, type RuntimeStreamReasoningDeltaEvent, type RuntimeStreamStartEvent, type RuntimeStreamTextDeltaEvent, type RuntimeStreamToolCallDeltaEvent, type RuntimeStreamUsageEvent, type RuntimeStreamWarningEvent, type RuntimeToolExecutor, type RuntimeToolUsage, type RuntimeUsage, type RuntimeWarning, type ServerToolKey, type ServerToolUsage, type SubagentPolicy, type WebFetchPolicy, type WebSearchPolicy, buildOpenRouterServerTools, compileRuntimeRequest, createConsoleLogger, createOpenRouterRuntime, decodeProviderMetadata, isRuntimeLoggingEnabled, packProviderRecord, toProviderMetadata };

package/dist/index.js

@@ -894,77 +894,43 @@ function buildSubagentTool(policy, fallbackReasoning) {
 }
 
 // src/utils/provider-metadata.ts
+import {
+  openMetadata,
+  packMetadata,
+  metadataTrimWarning
+} from "@x12i/provider-metadata";
+import {
+  METADATA_NORMALIZATION_MAP,
+  canonicalMetadataKey,
+  normalizeMetadata
+} from "@x12i/provider-metadata";
 var OPENROUTER_METADATA_LIMITS = {
   maxPairs: 16,
   maxKeyLength: 64,
   maxValueLength: 512
 };
-var PROVIDER_RECORD_CHUNK = 256;
-var PROVIDER_RECORD_MAX_CHUNKS = 16;
 function toProviderMetadata(metadata, agentId, _limits, base) {
-  return encodeProviderRecord(collectProviderStrings(metadata, agentId, base));
+  return packMetadata(base, metadata, agentLayer(agentId));
 }
-function decodeProviderMetadata(wire) {
-  if (!isRecord2(wire)) return {};
-  const parts = [];
-  for (let index = 0; ; index += 1) {
-    const chunk = wire[`m.${index}`];
-    if (typeof chunk !== "string") break;
-    parts.push(chunk);
-  }
-  if (!parts.length) return {};
-  const parsed = JSON.parse(Buffer.from(parts.join(""), "base64").toString("utf8"));
-  if (!isRecord2(parsed)) return {};
-  const record = {};
-  for (const [key, value] of Object.entries(parsed)) {
-    if (typeof value === "string") record[key] = value;
-  }
-  return record;
-}
-function encodeProviderRecord(map) {
-  const keys = Object.keys(map).sort();
-  if (!keys.length) return void 0;
-  const ordered = {};
-  for (const key of keys) {
-    const value = map[key];
-    if (value !== void 0) ordered[key] = value;
-  }
-  const encoded = Buffer.from(JSON.stringify(ordered), "utf8").toString("base64");
-  const chunks = Math.ceil(encoded.length / PROVIDER_RECORD_CHUNK);
-  if (chunks > PROVIDER_RECORD_MAX_CHUNKS) {
-    throw new Error(
-      `METADATA_RECORD_TOO_LARGE: provider metadata is ${encoded.length} base64 characters; the maximum is ${PROVIDER_RECORD_CHUNK * PROVIDER_RECORD_MAX_CHUNKS}.`
-    );
-  }
-  const wire = {};
-  for (let index = 0; index < chunks; index += 1) {
-    wire[`m.${index}`] = encoded.slice(index * PROVIDER_RECORD_CHUNK, (index + 1) * PROVIDER_RECORD_CHUNK);
-  }
-  return wire;
-}
-function collectProviderStrings(metadata, agentId, base) {
-  const map = {};
-  appendStrings(map, base);
-  appendStrings(map, metadata);
-  const trimmedAgentId = agentId?.trim();
-  if (trimmedAgentId) map.agentId = trimmedAgentId;
-  return map;
-}
-function appendStrings(target, metadata) {
-  if (!metadata) return;
-  for (const [key, value] of Object.entries(metadata)) {
-    const asString = asMetadataString(value);
-    if (asString !== void 0) target[key] = asString;
+function packProviderRecord(metadata, agentId, base, packer) {
+  const layers = [base, metadata, agentLayer(agentId)];
+  if (!packer) {
+    const wire = packMetadata(...layers);
+    return wire ? { wire } : {};
   }
+  const packed = packer.pack(...layers);
+  const warning = metadataTrimWarning(packed.dropped);
+  return {
+    ...packed.wire ? { wire: packed.wire } : {},
+    ...warning ? { warning } : {}
+  };
 }
-function asMetadataString(value) {
-  if (typeof value === "string") return value;
-  if (typeof value === "boolean") return value ? "true" : "false";
-  if (typeof value === "number" && Number.isFinite(value)) return String(value);
-  return void 0;
+function decodeProviderMetadata(wire) {
+  return openMetadata(wire);
 }
-function isRecord2(value) {
-  return typeof value === "object" && value !== null && !Array.isArray(value);
+function agentLayer(agentId) {
+  const trimmed = agentId?.trim();
+  return trimmed ? { agentId: trimmed } : void 0;
 }
 
 // src/runtime/runtime.ts
@@ -996,7 +962,7 @@ function compileRuntimeRequest(request, defaults, options = { apiKey: "" }, cont
   const assembled = apiMode === "chat" ? buildChatBody(request, baseBody) : buildResponsesBody(request, baseBody);
   let body = effectiveContext.finalizeBody ? effectiveContext.finalizeBody(assembled) : assembled;
   enforceStreamingPolicyForRun(body, warnings, effectiveContext);
-  body = attachProviderMetadata(body, request);
+  body = attachProviderMetadata(body, request, options, warnings);
   return {
     apiMode,
     url: endpointFor(options.baseUrl ?? "https://openrouter.ai/api/v1", apiMode),
@@ -1005,10 +971,11 @@ function compileRuntimeRequest(request, defaults, options = { apiKey: "" }, cont
     warnings
   };
 }
-function attachProviderMetadata(body, request) {
+function attachProviderMetadata(body, request, options, warnings) {
   const fromBody = isRecord(body.metadata) ? body.metadata : void 0;
-  const metadata = toProviderMetadata(request.metadata, request.agentId, OPENROUTER_METADATA_LIMITS, fromBody);
-  if (metadata) return { ...body, metadata };
+  const packed = packProviderRecord(request.metadata, request.agentId, fromBody, options.metadataPacker);
+  if (packed.warning) warnings.push(packed.warning);
+  if (packed.wire) return { ...body, metadata: packed.wire };
   if (body.metadata === void 0) return body;
   const rest = { ...body };
   delete rest.metadata;
@@ -1908,15 +1875,19 @@ function operatorHintFor(code) {
   }
 }
 export {
+  METADATA_NORMALIZATION_MAP,
   OPENROUTER_METADATA_LIMITS,
   OpenRouterHttpError,
   RuntimeConfigError,
   buildOpenRouterServerTools,
+  canonicalMetadataKey,
   compileRuntimeRequest,
   createConsoleLogger,
   createOpenRouterRuntime,
   decodeProviderMetadata,
   isRuntimeLoggingEnabled,
+  normalizeMetadata,
+  packProviderRecord,
   toProviderMetadata
 };
 //# sourceMappingURL=index.js.map