@x12i/provider-metadata 1.2.0 → 1.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -96,7 +96,7 @@ The stored value is UTF-8 JSON of the string map, with keys sorted, then base64.
96
96
 
97
97
  The limit is 4096 base64 characters. `createMetadataPacker` drops pairs until the record fits. `packMetadata` throws `METADATA_RECORD_TOO_LARGE` instead.
98
98
 
99
- `openMetadata` joins `m.0`, `m.1`, … in order, decodes the base64, and returns every string in that JSON object. A missing record, or a value that is not an object, returns `{}`.
99
+ `openMetadata` joins `m.0`, `m.1`, … in order, decodes the base64, and returns every string in that JSON object. Pass the wire object, or the JSON string of that object (Cloudflare `cf-aig-metadata`). A missing record, invalid JSON, or a value that is not an object returns `{}`.
100
100
 
101
101
  These provider slots hold that same object:
102
102
 
@@ -105,6 +105,6 @@ These provider slots hold that same object:
105
105
  | OpenRouter | Body `metadata` |
106
106
  | OpenAI | Responses body `metadata` |
107
107
  | Bedrock | `requestMetadata` |
108
- | Cloudflare | Body `metadata` and the `cf-aig-metadata` header |
108
+ | Cloudflare | Body `metadata` and the `cf-aig-metadata` header (JSON string) |
109
109
 
110
110
  `@x12i/ai-dispatcher` creates one packer for the caller. The caller sends one map on the request. The dispatcher writes this object onto the provider that runs the call.
package/dist/index.cjs CHANGED
@@ -187,10 +187,11 @@ function packMetadata(...layers) {
187
187
  return encoded.wire;
188
188
  }
189
189
  function openMetadata(wire) {
190
- if (!isRecord2(wire)) return {};
190
+ const object = coerceWireObject(wire);
191
+ if (!object) return {};
191
192
  const parts = [];
192
193
  for (let index = 0; ; index += 1) {
193
- const chunk = wire[`m.${index}`];
194
+ const chunk = object[`m.${index}`];
194
195
  if (typeof chunk !== "string") break;
195
196
  parts.push(chunk);
196
197
  }
@@ -203,6 +204,16 @@ function openMetadata(wire) {
203
204
  }
204
205
  return normalizeMetadata(record);
205
206
  }
207
+ function coerceWireObject(wire) {
208
+ if (isRecord2(wire)) return wire;
209
+ if (typeof wire !== "string") return void 0;
210
+ try {
211
+ const parsed = JSON.parse(wire);
212
+ return isRecord2(parsed) ? parsed : void 0;
213
+ } catch {
214
+ return void 0;
215
+ }
216
+ }
206
217
  function encodeProviderRecord(map) {
207
218
  const keys = Object.keys(map).sort();
208
219
  if (!keys.length) return { encodedLength: 0, tooLarge: false };
@@ -1 +1 @@
1
- {"version":3,"sources":["../src/index.ts","../src/normalize.ts"],"sourcesContent":["export {\r\n METADATA_NORMALIZATION_MAP,\r\n canonicalMetadataKey,\r\n normalizeMetadata,\r\n type NormalizedMetadataKey\r\n} from \"./normalize\";\r\n\r\nimport { collectNormalizedStrings, normalizeMetadata } from \"./normalize\";\r\n\r\nexport const PROVIDER_METADATA_CHUNK_SIZE = 256;\r\nexport const PROVIDER_METADATA_MAX_CHUNKS = 16;\r\n\r\nconst MAX_ENCODED_LENGTH = PROVIDER_METADATA_CHUNK_SIZE * PROVIDER_METADATA_MAX_CHUNKS;\r\n\r\nexport const METADATA_RECORD_TRIMMED = \"METADATA_RECORD_TRIMMED\";\r\n\r\nexport interface MetadataPackerOptions {\r\n /**\r\n * Highest priority first.\r\n * Listed keys are kept ahead of every key that is not in the list.\r\n * Within the list, an earlier key is kept ahead of a later key.\r\n */\r\n priority?: readonly string[];\r\n}\r\n\r\nexport interface PackedMetadata {\r\n /** Provider wire object. Omitted when the map is empty or every pair was dropped. */\r\n wire?: Record<string, string>;\r\n /** Keys removed so the record fits, least important first. Empty when nothing was dropped. */\r\n dropped: readonly string[];\r\n}\r\n\r\nexport interface MetadataTrimWarning {\r\n code: typeof METADATA_RECORD_TRIMMED;\r\n message: string;\r\n details: { dropped: string[] };\r\n}\r\n\r\nexport interface MetadataPacker {\r\n pack(...layers: Array<Record<string, unknown> | undefined>): PackedMetadata;\r\n}\r\n\r\n/**\r\n * One packer for a process.\r\n * Pass the priority list here. Every `pack` call trims to the provider limit and reports dropped keys.\r\n */\r\nexport function createMetadataPacker(options?: MetadataPackerOptions): MetadataPacker {\r\n const priority = [...(options?.priority ?? [])];\r\n const rank = new Map<string, number>();\r\n for (let index = 0; index < priority.length; index += 1) {\r\n const key = priority[index];\r\n if (key !== undefined && !rank.has(key)) rank.set(key, index);\r\n }\r\n\r\n return {\r\n pack(...layers) {\r\n const map = collectNormalizedStrings(layers);\r\n const dropped: string[] = [];\r\n let encoded = encodeProviderRecord(map);\r\n while (encoded.tooLarge) {\r\n const victim = leastImportantKey(map, rank, priority.length);\r\n if (!victim) break;\r\n delete map[victim];\r\n dropped.push(victim);\r\n encoded = encodeProviderRecord(map);\r\n }\r\n return {\r\n ...(encoded.wire ? { wire: encoded.wire } : {}),\r\n dropped\r\n };\r\n }\r\n };\r\n}\r\n\r\n/** Warning for a pack that had to drop keys. Omitted when nothing was dropped. */\r\nexport function metadataTrimWarning(dropped: readonly string[]): MetadataTrimWarning | undefined {\r\n if (!dropped.length) return undefined;\r\n return {\r\n code: METADATA_RECORD_TRIMMED,\r\n message: `Dropped metadata keys so the provider record fits: ${dropped.join(\", \")}.`,\r\n details: { dropped: [...dropped] }\r\n };\r\n}\r\n\r\n/**\r\n * Packs caller maps into one provider metadata object.\r\n * Later layers win on the same key. String, number, and boolean values are stored.\r\n * Numbers and booleans are stored as their string form.\r\n * Nested objects under known provider namespaces (for example `openrouter`) are\r\n * flattened, and known aliases are promoted to canonical keys\r\n * (`openrouter.api_key_name` also becomes `api_key_name`). Other objects and\r\n * arrays are omitted from the wire record.\r\n * An empty result is `undefined`.\r\n * A record over the size limit throws `METADATA_RECORD_TOO_LARGE`.\r\n * Writers that should drop pairs instead use `createMetadataPacker`.\r\n * The packed object is the same for every provider: `m.0`, `m.1`, and so on.\r\n */\r\nexport function packMetadata(\r\n ...layers: Array<Record<string, unknown> | undefined>\r\n): Record<string, string> | undefined {\r\n const encoded = encodeProviderRecord(collectNormalizedStrings(layers));\r\n if (encoded.tooLarge) {\r\n throw new Error(\r\n `METADATA_RECORD_TOO_LARGE: provider metadata is ${encoded.encodedLength} base64 characters; the maximum is ${MAX_ENCODED_LENGTH}.`\r\n );\r\n }\r\n return encoded.wire;\r\n}\r\n\r\n/**\r\n * Opens the `m.0`, `m.1`, ... object from a provider log.\r\n * Returns every stored pair with known aliases promoted to canonical keys.\r\n * A missing record returns `{}`.\r\n */\r\nexport function openMetadata(wire: unknown): Record<string, string> {\r\n if (!isRecord(wire)) return {};\r\n const parts: string[] = [];\r\n for (let index = 0; ; index += 1) {\r\n const chunk = wire[`m.${index}`];\r\n if (typeof chunk !== \"string\") break;\r\n parts.push(chunk);\r\n }\r\n if (!parts.length) return {};\r\n const parsed: unknown = JSON.parse(Buffer.from(parts.join(\"\"), \"base64\").toString(\"utf8\"));\r\n if (!isRecord(parsed)) return {};\r\n const record: Record<string, string> = {};\r\n for (const [key, value] of Object.entries(parsed)) {\r\n if (typeof value === \"string\") record[key] = value;\r\n }\r\n return normalizeMetadata(record);\r\n}\r\n\r\nfunction encodeProviderRecord(map: Record<string, string>): {\r\n wire?: Record<string, string>;\r\n encodedLength: number;\r\n tooLarge: boolean;\r\n} {\r\n const keys = Object.keys(map).sort();\r\n if (!keys.length) return { encodedLength: 0, tooLarge: false };\r\n const ordered: Record<string, string> = {};\r\n for (const key of keys) {\r\n const value = map[key];\r\n if (value !== undefined) ordered[key] = value;\r\n }\r\n const encoded = Buffer.from(JSON.stringify(ordered), \"utf8\").toString(\"base64\");\r\n if (Math.ceil(encoded.length / PROVIDER_METADATA_CHUNK_SIZE) > PROVIDER_METADATA_MAX_CHUNKS) {\r\n return { encodedLength: encoded.length, tooLarge: true };\r\n }\r\n const wire: Record<string, string> = {};\r\n for (let index = 0; index < Math.ceil(encoded.length / PROVIDER_METADATA_CHUNK_SIZE); index += 1) {\r\n wire[`m.${index}`] = encoded.slice(\r\n index * PROVIDER_METADATA_CHUNK_SIZE,\r\n (index + 1) * PROVIDER_METADATA_CHUNK_SIZE\r\n );\r\n }\r\n return { wire, encodedLength: encoded.length, tooLarge: false };\r\n}\r\n\r\nfunction leastImportantKey(\r\n map: Record<string, string>,\r\n rank: Map<string, number>,\r\n unlistedRank: number\r\n): string | undefined {\r\n let chosen: string | undefined;\r\n let chosenRank = -1;\r\n let chosenSize = -1;\r\n for (const [key, value] of Object.entries(map)) {\r\n const keyRank = rank.get(key) ?? unlistedRank;\r\n const size = value.length;\r\n const lessImportant = chosen === undefined\r\n || keyRank > chosenRank\r\n || (keyRank === chosenRank && size > chosenSize)\r\n || (keyRank === chosenRank && size === chosenSize && key > chosen);\r\n if (lessImportant) {\r\n chosen = key;\r\n chosenRank = keyRank;\r\n chosenSize = size;\r\n }\r\n }\r\n return chosen;\r\n}\r\n\r\nfunction isRecord(value: unknown): value is Record<string, unknown> {\r\n return typeof value === \"object\" && value !== null && !Array.isArray(value);\r\n}\r\n","/**\r\n * Canonical metadata keys shared across providers.\r\n * Each entry lists known provider-namespaced aliases that mean the same thing.\r\n * Prefer the canonical key when reading or writing. Provider aliases may remain.\r\n *\r\n * Grow this map as repeating fields appear under a vendor prefix\r\n * (for example `openrouter.api_key_name` → `api_key_name`).\r\n */\r\nexport const METADATA_NORMALIZATION_MAP = {\r\n api_key_name: [\"openrouter.api_key_name\"],\r\n provider_slug: [\"openrouter.provider_slug\"],\r\n provider_name: [\"openrouter.provider_name\", \"gen_ai.provider.name\"],\r\n entity_id: [\"openrouter.entity_id\"],\r\n user_id: [\"openrouter.user_id\", \"user.id\", \"cf.user_id\"],\r\n finish_reason: [\"openrouter.finish_reason\", \"gen_ai.response.finish_reason\"],\r\n input_unit_price: [\"openrouter.input_unit_price\"],\r\n output_unit_price: [\"openrouter.output_unit_price\"],\r\n source: [\"openrouter.source\"],\r\n session_id: [\"session.id\"]\r\n} as const satisfies Record<string, readonly string[]>;\r\n\r\nexport type NormalizedMetadataKey = keyof typeof METADATA_NORMALIZATION_MAP;\r\n\r\nconst TRACE_METADATA_PREFIX = \"trace.metadata.\";\r\nconst SPAN_METADATA_PREFIX = \"span.metadata.\";\r\n\r\nconst ALIAS_TO_CANONICAL = buildAliasIndex(METADATA_NORMALIZATION_MAP);\r\n\r\n/** First path segments that may nest provider-specific metadata objects. */\r\nconst KNOWN_PROVIDER_NAMESPACES = new Set(\r\n Object.values(METADATA_NORMALIZATION_MAP).flatMap((aliases) =>\r\n aliases.map((alias) => alias.split(\".\")[0]).filter((part): part is string => Boolean(part))\r\n )\r\n);\r\n\r\n/**\r\n * Flattens a metadata bag and promotes known provider aliases to canonical keys.\r\n *\r\n * Accepts:\r\n * - flat string maps (`{ api_key_name: \"prod\" }`)\r\n * - dotted provider keys (`{ \"openrouter.api_key_name\": \"prod\" }`)\r\n * - nested provider objects (`{ openrouter: { api_key_name: \"prod\" } }`)\r\n * - OTLP attribute bags (`{ \"trace.metadata.openrouter.api_key_name\": \"prod\" }`)\r\n *\r\n * Provider-namespaced keys stay when present. Canonical keys are added when an\r\n * alias is known and the canonical key is missing. An explicit canonical value wins.\r\n */\r\nexport function normalizeMetadata(input: unknown): Record<string, string> {\r\n return promoteCanonicalKeys(flattenMetadataInput(input));\r\n}\r\n\r\n/**\r\n * Pack-time collection: scalar pairs plus known provider namespaces.\r\n * Arbitrary nested objects stay off the wire (caller response metadata keeps them).\r\n * Known aliases are promoted to canonical keys.\r\n */\r\nexport function collectNormalizedStrings(\r\n layers: Array<Record<string, unknown> | undefined>\r\n): Record<string, string> {\r\n const map: Record<string, string> = {};\r\n for (const layer of layers) {\r\n if (!layer) continue;\r\n for (const [key, value] of Object.entries(layer)) {\r\n const asString = asMetadataString(value);\r\n if (asString !== undefined) {\r\n map[key] = asString;\r\n continue;\r\n }\r\n if (!isRecord(value) || !KNOWN_PROVIDER_NAMESPACES.has(key)) continue;\r\n for (const [childKey, childValue] of Object.entries(value)) {\r\n if (!childKey) continue;\r\n const childString = asMetadataString(childValue);\r\n if (childString !== undefined) map[`${key}.${childKey}`] = childString;\r\n }\r\n }\r\n }\r\n return promoteCanonicalKeys(map);\r\n}\r\n\r\n/** Returns the canonical key for a known alias, or the key itself. */\r\nexport function canonicalMetadataKey(key: string): string {\r\n return ALIAS_TO_CANONICAL.get(key) ?? key;\r\n}\r\n\r\nfunction promoteCanonicalKeys(flat: Record<string, string>): Record<string, string> {\r\n const out: Record<string, string> = { ...flat };\r\n for (const [canonical, aliases] of Object.entries(METADATA_NORMALIZATION_MAP)) {\r\n if (Object.prototype.hasOwnProperty.call(out, canonical)) continue;\r\n for (const alias of aliases) {\r\n const value = out[alias];\r\n if (value !== undefined) {\r\n out[canonical] = value;\r\n break;\r\n }\r\n }\r\n }\r\n return out;\r\n}\r\n\r\nfunction flattenMetadataInput(input: unknown): Record<string, string> {\r\n if (!isRecord(input)) return {};\r\n const flat: Record<string, string> = {};\r\n for (const [rawKey, value] of Object.entries(input)) {\r\n const key = stripObservabilityPrefix(rawKey);\r\n if (!key) continue;\r\n collectFlat(flat, key, value);\r\n }\r\n return flat;\r\n}\r\n\r\nfunction collectFlat(out: Record<string, string>, key: string, value: unknown): void {\r\n const asString = asMetadataString(value);\r\n if (asString !== undefined) {\r\n out[key] = asString;\r\n return;\r\n }\r\n if (!isRecord(value)) return;\r\n for (const [childKey, childValue] of Object.entries(value)) {\r\n if (!childKey) continue;\r\n collectFlat(out, `${key}.${childKey}`, childValue);\r\n }\r\n}\r\n\r\nfunction stripObservabilityPrefix(key: string): string {\r\n if (key.startsWith(TRACE_METADATA_PREFIX)) return key.slice(TRACE_METADATA_PREFIX.length);\r\n if (key.startsWith(SPAN_METADATA_PREFIX)) return key.slice(SPAN_METADATA_PREFIX.length);\r\n return key;\r\n}\r\n\r\nfunction asMetadataString(value: unknown): string | undefined {\r\n if (typeof value === \"string\") return value;\r\n if (typeof value === \"boolean\") return value ? \"true\" : \"false\";\r\n if (typeof value === \"number\" && Number.isFinite(value)) return String(value);\r\n return undefined;\r\n}\r\n\r\nfunction isRecord(value: unknown): value is Record<string, unknown> {\r\n return typeof value === \"object\" && value !== null && !Array.isArray(value);\r\n}\r\n\r\nfunction buildAliasIndex(map: Record<string, readonly string[]>): Map<string, string> {\r\n const index = new Map<string, string>();\r\n for (const [canonical, aliases] of Object.entries(map)) {\r\n for (const alias of aliases) index.set(alias, canonical);\r\n }\r\n return index;\r\n}\r\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACQO,IAAM,6BAA6B;AAAA,EACxC,cAAc,CAAC,yBAAyB;AAAA,EACxC,eAAe,CAAC,0BAA0B;AAAA,EAC1C,eAAe,CAAC,4BAA4B,sBAAsB;AAAA,EAClE,WAAW,CAAC,sBAAsB;AAAA,EAClC,SAAS,CAAC,sBAAsB,WAAW,YAAY;AAAA,EACvD,eAAe,CAAC,4BAA4B,+BAA+B;AAAA,EAC3E,kBAAkB,CAAC,6BAA6B;AAAA,EAChD,mBAAmB,CAAC,8BAA8B;AAAA,EAClD,QAAQ,CAAC,mBAAmB;AAAA,EAC5B,YAAY,CAAC,YAAY;AAC3B;AAIA,IAAM,wBAAwB;AAC9B,IAAM,uBAAuB;AAE7B,IAAM,qBAAqB,gBAAgB,0BAA0B;AAGrE,IAAM,4BAA4B,IAAI;AAAA,EACpC,OAAO,OAAO,0BAA0B,EAAE;AAAA,IAAQ,CAAC,YACjD,QAAQ,IAAI,CAAC,UAAU,MAAM,MAAM,GAAG,EAAE,CAAC,CAAC,EAAE,OAAO,CAAC,SAAyB,QAAQ,IAAI,CAAC;AAAA,EAC5F;AACF;AAcO,SAAS,kBAAkB,OAAwC;AACxE,SAAO,qBAAqB,qBAAqB,KAAK,CAAC;AACzD;AAOO,SAAS,yBACd,QACwB;AACxB,QAAM,MAA8B,CAAC;AACrC,aAAW,SAAS,QAAQ;AAC1B,QAAI,CAAC,MAAO;AACZ,eAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ,KAAK,GAAG;AAChD,YAAM,WAAW,iBAAiB,KAAK;AACvC,UAAI,aAAa,QAAW;AAC1B,YAAI,GAAG,IAAI;AACX;AAAA,MACF;AACA,UAAI,CAAC,SAAS,KAAK,KAAK,CAAC,0BAA0B,IAAI,GAAG,EAAG;AAC7D,iBAAW,CAAC,UAAU,UAAU,KAAK,OAAO,QAAQ,KAAK,GAAG;AAC1D,YAAI,CAAC,SAAU;AACf,cAAM,cAAc,iBAAiB,UAAU;AAC/C,YAAI,gBAAgB,OAAW,KAAI,GAAG,GAAG,IAAI,QAAQ,EAAE,IAAI;AAAA,MAC7D;AAAA,IACF;AAAA,EACF;AACA,SAAO,qBAAqB,GAAG;AACjC;AAGO,SAAS,qBAAqB,KAAqB;AACxD,SAAO,mBAAmB,IAAI,GAAG,KAAK;AACxC;AAEA,SAAS,qBAAqB,MAAsD;AAClF,QAAM,MAA8B,EAAE,GAAG,KAAK;AAC9C,aAAW,CAAC,WAAW,OAAO,KAAK,OAAO,QAAQ,0BAA0B,GAAG;AAC7E,QAAI,OAAO,UAAU,eAAe,KAAK,KAAK,SAAS,EAAG;AAC1D,eAAW,SAAS,SAAS;AAC3B,YAAM,QAAQ,IAAI,KAAK;AACvB,UAAI,UAAU,QAAW;AACvB,YAAI,SAAS,IAAI;AACjB;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACA,SAAO;AACT;AAEA,SAAS,qBAAqB,OAAwC;AACpE,MAAI,CAAC,SAAS,KAAK,EAAG,QAAO,CAAC;AAC9B,QAAM,OAA+B,CAAC;AACtC,aAAW,CAAC,QAAQ,KAAK,KAAK,OAAO,QAAQ,KAAK,GAAG;AACnD,UAAM,MAAM,yBAAyB,MAAM;AAC3C,QAAI,CAAC,IAAK;AACV,gBAAY,MAAM,KAAK,KAAK;AAAA,EAC9B;AACA,SAAO;AACT;AAEA,SAAS,YAAY,KAA6B,KAAa,OAAsB;AACnF,QAAM,WAAW,iBAAiB,KAAK;AACvC,MAAI,aAAa,QAAW;AAC1B,QAAI,GAAG,IAAI;AACX;AAAA,EACF;AACA,MAAI,CAAC,SAAS,KAAK,EAAG;AACtB,aAAW,CAAC,UAAU,UAAU,KAAK,OAAO,QAAQ,KAAK,GAAG;AAC1D,QAAI,CAAC,SAAU;AACf,gBAAY,KAAK,GAAG,GAAG,IAAI,QAAQ,IAAI,UAAU;AAAA,EACnD;AACF;AAEA,SAAS,yBAAyB,KAAqB;AACrD,MAAI,IAAI,WAAW,qBAAqB,EAAG,QAAO,IAAI,MAAM,sBAAsB,MAAM;AACxF,MAAI,IAAI,WAAW,oBAAoB,EAAG,QAAO,IAAI,MAAM,qBAAqB,MAAM;AACtF,SAAO;AACT;AAEA,SAAS,iBAAiB,OAAoC;AAC5D,MAAI,OAAO,UAAU,SAAU,QAAO;AACtC,MAAI,OAAO,UAAU,UAAW,QAAO,QAAQ,SAAS;AACxD,MAAI,OAAO,UAAU,YAAY,OAAO,SAAS,KAAK,EAAG,QAAO,OAAO,KAAK;AAC5E,SAAO;AACT;AAEA,SAAS,SAAS,OAAkD;AAClE,SAAO,OAAO,UAAU,YAAY,UAAU,QAAQ,CAAC,MAAM,QAAQ,KAAK;AAC5E;AAEA,SAAS,gBAAgB,KAA6D;AACpF,QAAM,QAAQ,oBAAI,IAAoB;AACtC,aAAW,CAAC,WAAW,OAAO,KAAK,OAAO,QAAQ,GAAG,GAAG;AACtD,eAAW,SAAS,QAAS,OAAM,IAAI,OAAO,SAAS;AAAA,EACzD;AACA,SAAO;AACT;;;ADzIO,IAAM,+BAA+B;AACrC,IAAM,+BAA+B;AAE5C,IAAM,qBAAqB,+BAA+B;AAEnD,IAAM,0BAA0B;AAgChC,SAAS,qBAAqB,SAAiD;AACpF,QAAM,WAAW,CAAC,GAAI,SAAS,YAAY,CAAC,CAAE;AAC9C,QAAM,OAAO,oBAAI,IAAoB;AACrC,WAAS,QAAQ,GAAG,QAAQ,SAAS,QAAQ,SAAS,GAAG;AACvD,UAAM,MAAM,SAAS,KAAK;AAC1B,QAAI,QAAQ,UAAa,CAAC,KAAK,IAAI,GAAG,EAAG,MAAK,IAAI,KAAK,KAAK;AAAA,EAC9D;AAEA,SAAO;AAAA,IACL,QAAQ,QAAQ;AACd,YAAM,MAAM,yBAAyB,MAAM;AAC3C,YAAM,UAAoB,CAAC;AAC3B,UAAI,UAAU,qBAAqB,GAAG;AACtC,aAAO,QAAQ,UAAU;AACvB,cAAM,SAAS,kBAAkB,KAAK,MAAM,SAAS,MAAM;AAC3D,YAAI,CAAC,OAAQ;AACb,eAAO,IAAI,MAAM;AACjB,gBAAQ,KAAK,MAAM;AACnB,kBAAU,qBAAqB,GAAG;AAAA,MACpC;AACA,aAAO;AAAA,QACL,GAAI,QAAQ,OAAO,EAAE,MAAM,QAAQ,KAAK,IAAI,CAAC;AAAA,QAC7C;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACF;AAGO,SAAS,oBAAoB,SAA6D;AAC/F,MAAI,CAAC,QAAQ,OAAQ,QAAO;AAC5B,SAAO;AAAA,IACL,MAAM;AAAA,IACN,SAAS,sDAAsD,QAAQ,KAAK,IAAI,CAAC;AAAA,IACjF,SAAS,EAAE,SAAS,CAAC,GAAG,OAAO,EAAE;AAAA,EACnC;AACF;AAeO,SAAS,gBACX,QACiC;AACpC,QAAM,UAAU,qBAAqB,yBAAyB,MAAM,CAAC;AACrE,MAAI,QAAQ,UAAU;AACpB,UAAM,IAAI;AAAA,MACR,mDAAmD,QAAQ,aAAa,sCAAsC,kBAAkB;AAAA,IAClI;AAAA,EACF;AACA,SAAO,QAAQ;AACjB;AAOO,SAAS,aAAa,MAAuC;AAClE,MAAI,CAACA,UAAS,IAAI,EAAG,QAAO,CAAC;AAC7B,QAAM,QAAkB,CAAC;AACzB,WAAS,QAAQ,KAAK,SAAS,GAAG;AAChC,UAAM,QAAQ,KAAK,KAAK,KAAK,EAAE;AAC/B,QAAI,OAAO,UAAU,SAAU;AAC/B,UAAM,KAAK,KAAK;AAAA,EAClB;AACA,MAAI,CAAC,MAAM,OAAQ,QAAO,CAAC;AAC3B,QAAM,SAAkB,KAAK,MAAM,OAAO,KAAK,MAAM,KAAK,EAAE,GAAG,QAAQ,EAAE,SAAS,MAAM,CAAC;AACzF,MAAI,CAACA,UAAS,MAAM,EAAG,QAAO,CAAC;AAC/B,QAAM,SAAiC,CAAC;AACxC,aAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ,MAAM,GAAG;AACjD,QAAI,OAAO,UAAU,SAAU,QAAO,GAAG,IAAI;AAAA,EAC/C;AACA,SAAO,kBAAkB,MAAM;AACjC;AAEA,SAAS,qBAAqB,KAI5B;AACA,QAAM,OAAO,OAAO,KAAK,GAAG,EAAE,KAAK;AACnC,MAAI,CAAC,KAAK,OAAQ,QAAO,EAAE,eAAe,GAAG,UAAU,MAAM;AAC7D,QAAM,UAAkC,CAAC;AACzC,aAAW,OAAO,MAAM;AACtB,UAAM,QAAQ,IAAI,GAAG;AACrB,QAAI,UAAU,OAAW,SAAQ,GAAG,IAAI;AAAA,EAC1C;AACA,QAAM,UAAU,OAAO,KAAK,KAAK,UAAU,OAAO,GAAG,MAAM,EAAE,SAAS,QAAQ;AAC9E,MAAI,KAAK,KAAK,QAAQ,SAAS,4BAA4B,IAAI,8BAA8B;AAC3F,WAAO,EAAE,eAAe,QAAQ,QAAQ,UAAU,KAAK;AAAA,EACzD;AACA,QAAM,OAA+B,CAAC;AACtC,WAAS,QAAQ,GAAG,QAAQ,KAAK,KAAK,QAAQ,SAAS,4BAA4B,GAAG,SAAS,GAAG;AAChG,SAAK,KAAK,KAAK,EAAE,IAAI,QAAQ;AAAA,MAC3B,QAAQ;AAAA,OACP,QAAQ,KAAK;AAAA,IAChB;AAAA,EACF;AACA,SAAO,EAAE,MAAM,eAAe,QAAQ,QAAQ,UAAU,MAAM;AAChE;AAEA,SAAS,kBACP,KACA,MACA,cACoB;AACpB,MAAI;AACJ,MAAI,aAAa;AACjB,MAAI,aAAa;AACjB,aAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ,GAAG,GAAG;AAC9C,UAAM,UAAU,KAAK,IAAI,GAAG,KAAK;AACjC,UAAM,OAAO,MAAM;AACnB,UAAM,gBAAgB,WAAW,UAC5B,UAAU,cACT,YAAY,cAAc,OAAO,cACjC,YAAY,cAAc,SAAS,cAAc,MAAM;AAC7D,QAAI,eAAe;AACjB,eAAS;AACT,mBAAa;AACb,mBAAa;AAAA,IACf;AAAA,EACF;AACA,SAAO;AACT;AAEA,SAASA,UAAS,OAAkD;AAClE,SAAO,OAAO,UAAU,YAAY,UAAU,QAAQ,CAAC,MAAM,QAAQ,KAAK;AAC5E;","names":["isRecord"]}
1
+ {"version":3,"sources":["../src/index.ts","../src/normalize.ts"],"sourcesContent":["export {\r\n METADATA_NORMALIZATION_MAP,\r\n canonicalMetadataKey,\r\n normalizeMetadata,\r\n type NormalizedMetadataKey\r\n} from \"./normalize\";\r\n\r\nimport { collectNormalizedStrings, normalizeMetadata } from \"./normalize\";\r\n\r\nexport const PROVIDER_METADATA_CHUNK_SIZE = 256;\r\nexport const PROVIDER_METADATA_MAX_CHUNKS = 16;\r\n\r\nconst MAX_ENCODED_LENGTH = PROVIDER_METADATA_CHUNK_SIZE * PROVIDER_METADATA_MAX_CHUNKS;\r\n\r\nexport const METADATA_RECORD_TRIMMED = \"METADATA_RECORD_TRIMMED\";\r\n\r\nexport interface MetadataPackerOptions {\r\n /**\r\n * Highest priority first.\r\n * Listed keys are kept ahead of every key that is not in the list.\r\n * Within the list, an earlier key is kept ahead of a later key.\r\n */\r\n priority?: readonly string[];\r\n}\r\n\r\nexport interface PackedMetadata {\r\n /** Provider wire object. Omitted when the map is empty or every pair was dropped. */\r\n wire?: Record<string, string>;\r\n /** Keys removed so the record fits, least important first. Empty when nothing was dropped. */\r\n dropped: readonly string[];\r\n}\r\n\r\nexport interface MetadataTrimWarning {\r\n code: typeof METADATA_RECORD_TRIMMED;\r\n message: string;\r\n details: { dropped: string[] };\r\n}\r\n\r\nexport interface MetadataPacker {\r\n pack(...layers: Array<Record<string, unknown> | undefined>): PackedMetadata;\r\n}\r\n\r\n/**\r\n * One packer for a process.\r\n * Pass the priority list here. Every `pack` call trims to the provider limit and reports dropped keys.\r\n */\r\nexport function createMetadataPacker(options?: MetadataPackerOptions): MetadataPacker {\r\n const priority = [...(options?.priority ?? [])];\r\n const rank = new Map<string, number>();\r\n for (let index = 0; index < priority.length; index += 1) {\r\n const key = priority[index];\r\n if (key !== undefined && !rank.has(key)) rank.set(key, index);\r\n }\r\n\r\n return {\r\n pack(...layers) {\r\n const map = collectNormalizedStrings(layers);\r\n const dropped: string[] = [];\r\n let encoded = encodeProviderRecord(map);\r\n while (encoded.tooLarge) {\r\n const victim = leastImportantKey(map, rank, priority.length);\r\n if (!victim) break;\r\n delete map[victim];\r\n dropped.push(victim);\r\n encoded = encodeProviderRecord(map);\r\n }\r\n return {\r\n ...(encoded.wire ? { wire: encoded.wire } : {}),\r\n dropped\r\n };\r\n }\r\n };\r\n}\r\n\r\n/** Warning for a pack that had to drop keys. Omitted when nothing was dropped. */\r\nexport function metadataTrimWarning(dropped: readonly string[]): MetadataTrimWarning | undefined {\r\n if (!dropped.length) return undefined;\r\n return {\r\n code: METADATA_RECORD_TRIMMED,\r\n message: `Dropped metadata keys so the provider record fits: ${dropped.join(\", \")}.`,\r\n details: { dropped: [...dropped] }\r\n };\r\n}\r\n\r\n/**\r\n * Packs caller maps into one provider metadata object.\r\n * Later layers win on the same key. String, number, and boolean values are stored.\r\n * Numbers and booleans are stored as their string form.\r\n * Nested objects under known provider namespaces (for example `openrouter`) are\r\n * flattened, and known aliases are promoted to canonical keys\r\n * (`openrouter.api_key_name` also becomes `api_key_name`). Other objects and\r\n * arrays are omitted from the wire record.\r\n * An empty result is `undefined`.\r\n * A record over the size limit throws `METADATA_RECORD_TOO_LARGE`.\r\n * Writers that should drop pairs instead use `createMetadataPacker`.\r\n * The packed object is the same for every provider: `m.0`, `m.1`, and so on.\r\n */\r\nexport function packMetadata(\r\n ...layers: Array<Record<string, unknown> | undefined>\r\n): Record<string, string> | undefined {\r\n const encoded = encodeProviderRecord(collectNormalizedStrings(layers));\r\n if (encoded.tooLarge) {\r\n throw new Error(\r\n `METADATA_RECORD_TOO_LARGE: provider metadata is ${encoded.encodedLength} base64 characters; the maximum is ${MAX_ENCODED_LENGTH}.`\r\n );\r\n }\r\n return encoded.wire;\r\n}\r\n\r\n/**\r\n * Opens the `m.0`, `m.1`, ... object from a provider log.\r\n * Accepts the wire object or its JSON string (for example Cloudflare `cf-aig-metadata`).\r\n * Returns every stored pair with known aliases promoted to canonical keys.\r\n * A missing or unreadable record returns `{}`.\r\n */\r\nexport function openMetadata(wire: unknown): Record<string, string> {\r\n const object = coerceWireObject(wire);\r\n if (!object) return {};\r\n const parts: string[] = [];\r\n for (let index = 0; ; index += 1) {\r\n const chunk = object[`m.${index}`];\r\n if (typeof chunk !== \"string\") break;\r\n parts.push(chunk);\r\n }\r\n if (!parts.length) return {};\r\n const parsed: unknown = JSON.parse(Buffer.from(parts.join(\"\"), \"base64\").toString(\"utf8\"));\r\n if (!isRecord(parsed)) return {};\r\n const record: Record<string, string> = {};\r\n for (const [key, value] of Object.entries(parsed)) {\r\n if (typeof value === \"string\") record[key] = value;\r\n }\r\n return normalizeMetadata(record);\r\n}\r\n\r\n/** Wire object, or the JSON string Cloudflare stores in `cf-aig-metadata`. */\r\nfunction coerceWireObject(wire: unknown): Record<string, unknown> | undefined {\r\n if (isRecord(wire)) return wire;\r\n if (typeof wire !== \"string\") return undefined;\r\n try {\r\n const parsed: unknown = JSON.parse(wire);\r\n return isRecord(parsed) ? parsed : undefined;\r\n } catch {\r\n return undefined;\r\n }\r\n}\r\n\r\nfunction encodeProviderRecord(map: Record<string, string>): {\r\n wire?: Record<string, string>;\r\n encodedLength: number;\r\n tooLarge: boolean;\r\n} {\r\n const keys = Object.keys(map).sort();\r\n if (!keys.length) return { encodedLength: 0, tooLarge: false };\r\n const ordered: Record<string, string> = {};\r\n for (const key of keys) {\r\n const value = map[key];\r\n if (value !== undefined) ordered[key] = value;\r\n }\r\n const encoded = Buffer.from(JSON.stringify(ordered), \"utf8\").toString(\"base64\");\r\n if (Math.ceil(encoded.length / PROVIDER_METADATA_CHUNK_SIZE) > PROVIDER_METADATA_MAX_CHUNKS) {\r\n return { encodedLength: encoded.length, tooLarge: true };\r\n }\r\n const wire: Record<string, string> = {};\r\n for (let index = 0; index < Math.ceil(encoded.length / PROVIDER_METADATA_CHUNK_SIZE); index += 1) {\r\n wire[`m.${index}`] = encoded.slice(\r\n index * PROVIDER_METADATA_CHUNK_SIZE,\r\n (index + 1) * PROVIDER_METADATA_CHUNK_SIZE\r\n );\r\n }\r\n return { wire, encodedLength: encoded.length, tooLarge: false };\r\n}\r\n\r\nfunction leastImportantKey(\r\n map: Record<string, string>,\r\n rank: Map<string, number>,\r\n unlistedRank: number\r\n): string | undefined {\r\n let chosen: string | undefined;\r\n let chosenRank = -1;\r\n let chosenSize = -1;\r\n for (const [key, value] of Object.entries(map)) {\r\n const keyRank = rank.get(key) ?? unlistedRank;\r\n const size = value.length;\r\n const lessImportant = chosen === undefined\r\n || keyRank > chosenRank\r\n || (keyRank === chosenRank && size > chosenSize)\r\n || (keyRank === chosenRank && size === chosenSize && key > chosen);\r\n if (lessImportant) {\r\n chosen = key;\r\n chosenRank = keyRank;\r\n chosenSize = size;\r\n }\r\n }\r\n return chosen;\r\n}\r\n\r\nfunction isRecord(value: unknown): value is Record<string, unknown> {\r\n return typeof value === \"object\" && value !== null && !Array.isArray(value);\r\n}\r\n","/**\r\n * Canonical metadata keys shared across providers.\r\n * Each entry lists known provider-namespaced aliases that mean the same thing.\r\n * Prefer the canonical key when reading or writing. Provider aliases may remain.\r\n *\r\n * Grow this map as repeating fields appear under a vendor prefix\r\n * (for example `openrouter.api_key_name` → `api_key_name`).\r\n */\r\nexport const METADATA_NORMALIZATION_MAP = {\r\n api_key_name: [\"openrouter.api_key_name\"],\r\n provider_slug: [\"openrouter.provider_slug\"],\r\n provider_name: [\"openrouter.provider_name\", \"gen_ai.provider.name\"],\r\n entity_id: [\"openrouter.entity_id\"],\r\n user_id: [\"openrouter.user_id\", \"user.id\", \"cf.user_id\"],\r\n finish_reason: [\"openrouter.finish_reason\", \"gen_ai.response.finish_reason\"],\r\n input_unit_price: [\"openrouter.input_unit_price\"],\r\n output_unit_price: [\"openrouter.output_unit_price\"],\r\n source: [\"openrouter.source\"],\r\n session_id: [\"session.id\"]\r\n} as const satisfies Record<string, readonly string[]>;\r\n\r\nexport type NormalizedMetadataKey = keyof typeof METADATA_NORMALIZATION_MAP;\r\n\r\nconst TRACE_METADATA_PREFIX = \"trace.metadata.\";\r\nconst SPAN_METADATA_PREFIX = \"span.metadata.\";\r\n\r\nconst ALIAS_TO_CANONICAL = buildAliasIndex(METADATA_NORMALIZATION_MAP);\r\n\r\n/** First path segments that may nest provider-specific metadata objects. */\r\nconst KNOWN_PROVIDER_NAMESPACES = new Set(\r\n Object.values(METADATA_NORMALIZATION_MAP).flatMap((aliases) =>\r\n aliases.map((alias) => alias.split(\".\")[0]).filter((part): part is string => Boolean(part))\r\n )\r\n);\r\n\r\n/**\r\n * Flattens a metadata bag and promotes known provider aliases to canonical keys.\r\n *\r\n * Accepts:\r\n * - flat string maps (`{ api_key_name: \"prod\" }`)\r\n * - dotted provider keys (`{ \"openrouter.api_key_name\": \"prod\" }`)\r\n * - nested provider objects (`{ openrouter: { api_key_name: \"prod\" } }`)\r\n * - OTLP attribute bags (`{ \"trace.metadata.openrouter.api_key_name\": \"prod\" }`)\r\n *\r\n * Provider-namespaced keys stay when present. Canonical keys are added when an\r\n * alias is known and the canonical key is missing. An explicit canonical value wins.\r\n */\r\nexport function normalizeMetadata(input: unknown): Record<string, string> {\r\n return promoteCanonicalKeys(flattenMetadataInput(input));\r\n}\r\n\r\n/**\r\n * Pack-time collection: scalar pairs plus known provider namespaces.\r\n * Arbitrary nested objects stay off the wire (caller response metadata keeps them).\r\n * Known aliases are promoted to canonical keys.\r\n */\r\nexport function collectNormalizedStrings(\r\n layers: Array<Record<string, unknown> | undefined>\r\n): Record<string, string> {\r\n const map: Record<string, string> = {};\r\n for (const layer of layers) {\r\n if (!layer) continue;\r\n for (const [key, value] of Object.entries(layer)) {\r\n const asString = asMetadataString(value);\r\n if (asString !== undefined) {\r\n map[key] = asString;\r\n continue;\r\n }\r\n if (!isRecord(value) || !KNOWN_PROVIDER_NAMESPACES.has(key)) continue;\r\n for (const [childKey, childValue] of Object.entries(value)) {\r\n if (!childKey) continue;\r\n const childString = asMetadataString(childValue);\r\n if (childString !== undefined) map[`${key}.${childKey}`] = childString;\r\n }\r\n }\r\n }\r\n return promoteCanonicalKeys(map);\r\n}\r\n\r\n/** Returns the canonical key for a known alias, or the key itself. */\r\nexport function canonicalMetadataKey(key: string): string {\r\n return ALIAS_TO_CANONICAL.get(key) ?? key;\r\n}\r\n\r\nfunction promoteCanonicalKeys(flat: Record<string, string>): Record<string, string> {\r\n const out: Record<string, string> = { ...flat };\r\n for (const [canonical, aliases] of Object.entries(METADATA_NORMALIZATION_MAP)) {\r\n if (Object.prototype.hasOwnProperty.call(out, canonical)) continue;\r\n for (const alias of aliases) {\r\n const value = out[alias];\r\n if (value !== undefined) {\r\n out[canonical] = value;\r\n break;\r\n }\r\n }\r\n }\r\n return out;\r\n}\r\n\r\nfunction flattenMetadataInput(input: unknown): Record<string, string> {\r\n if (!isRecord(input)) return {};\r\n const flat: Record<string, string> = {};\r\n for (const [rawKey, value] of Object.entries(input)) {\r\n const key = stripObservabilityPrefix(rawKey);\r\n if (!key) continue;\r\n collectFlat(flat, key, value);\r\n }\r\n return flat;\r\n}\r\n\r\nfunction collectFlat(out: Record<string, string>, key: string, value: unknown): void {\r\n const asString = asMetadataString(value);\r\n if (asString !== undefined) {\r\n out[key] = asString;\r\n return;\r\n }\r\n if (!isRecord(value)) return;\r\n for (const [childKey, childValue] of Object.entries(value)) {\r\n if (!childKey) continue;\r\n collectFlat(out, `${key}.${childKey}`, childValue);\r\n }\r\n}\r\n\r\nfunction stripObservabilityPrefix(key: string): string {\r\n if (key.startsWith(TRACE_METADATA_PREFIX)) return key.slice(TRACE_METADATA_PREFIX.length);\r\n if (key.startsWith(SPAN_METADATA_PREFIX)) return key.slice(SPAN_METADATA_PREFIX.length);\r\n return key;\r\n}\r\n\r\nfunction asMetadataString(value: unknown): string | undefined {\r\n if (typeof value === \"string\") return value;\r\n if (typeof value === \"boolean\") return value ? \"true\" : \"false\";\r\n if (typeof value === \"number\" && Number.isFinite(value)) return String(value);\r\n return undefined;\r\n}\r\n\r\nfunction isRecord(value: unknown): value is Record<string, unknown> {\r\n return typeof value === \"object\" && value !== null && !Array.isArray(value);\r\n}\r\n\r\nfunction buildAliasIndex(map: Record<string, readonly string[]>): Map<string, string> {\r\n const index = new Map<string, string>();\r\n for (const [canonical, aliases] of Object.entries(map)) {\r\n for (const alias of aliases) index.set(alias, canonical);\r\n }\r\n return index;\r\n}\r\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACQO,IAAM,6BAA6B;AAAA,EACxC,cAAc,CAAC,yBAAyB;AAAA,EACxC,eAAe,CAAC,0BAA0B;AAAA,EAC1C,eAAe,CAAC,4BAA4B,sBAAsB;AAAA,EAClE,WAAW,CAAC,sBAAsB;AAAA,EAClC,SAAS,CAAC,sBAAsB,WAAW,YAAY;AAAA,EACvD,eAAe,CAAC,4BAA4B,+BAA+B;AAAA,EAC3E,kBAAkB,CAAC,6BAA6B;AAAA,EAChD,mBAAmB,CAAC,8BAA8B;AAAA,EAClD,QAAQ,CAAC,mBAAmB;AAAA,EAC5B,YAAY,CAAC,YAAY;AAC3B;AAIA,IAAM,wBAAwB;AAC9B,IAAM,uBAAuB;AAE7B,IAAM,qBAAqB,gBAAgB,0BAA0B;AAGrE,IAAM,4BAA4B,IAAI;AAAA,EACpC,OAAO,OAAO,0BAA0B,EAAE;AAAA,IAAQ,CAAC,YACjD,QAAQ,IAAI,CAAC,UAAU,MAAM,MAAM,GAAG,EAAE,CAAC,CAAC,EAAE,OAAO,CAAC,SAAyB,QAAQ,IAAI,CAAC;AAAA,EAC5F;AACF;AAcO,SAAS,kBAAkB,OAAwC;AACxE,SAAO,qBAAqB,qBAAqB,KAAK,CAAC;AACzD;AAOO,SAAS,yBACd,QACwB;AACxB,QAAM,MAA8B,CAAC;AACrC,aAAW,SAAS,QAAQ;AAC1B,QAAI,CAAC,MAAO;AACZ,eAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ,KAAK,GAAG;AAChD,YAAM,WAAW,iBAAiB,KAAK;AACvC,UAAI,aAAa,QAAW;AAC1B,YAAI,GAAG,IAAI;AACX;AAAA,MACF;AACA,UAAI,CAAC,SAAS,KAAK,KAAK,CAAC,0BAA0B,IAAI,GAAG,EAAG;AAC7D,iBAAW,CAAC,UAAU,UAAU,KAAK,OAAO,QAAQ,KAAK,GAAG;AAC1D,YAAI,CAAC,SAAU;AACf,cAAM,cAAc,iBAAiB,UAAU;AAC/C,YAAI,gBAAgB,OAAW,KAAI,GAAG,GAAG,IAAI,QAAQ,EAAE,IAAI;AAAA,MAC7D;AAAA,IACF;AAAA,EACF;AACA,SAAO,qBAAqB,GAAG;AACjC;AAGO,SAAS,qBAAqB,KAAqB;AACxD,SAAO,mBAAmB,IAAI,GAAG,KAAK;AACxC;AAEA,SAAS,qBAAqB,MAAsD;AAClF,QAAM,MAA8B,EAAE,GAAG,KAAK;AAC9C,aAAW,CAAC,WAAW,OAAO,KAAK,OAAO,QAAQ,0BAA0B,GAAG;AAC7E,QAAI,OAAO,UAAU,eAAe,KAAK,KAAK,SAAS,EAAG;AAC1D,eAAW,SAAS,SAAS;AAC3B,YAAM,QAAQ,IAAI,KAAK;AACvB,UAAI,UAAU,QAAW;AACvB,YAAI,SAAS,IAAI;AACjB;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACA,SAAO;AACT;AAEA,SAAS,qBAAqB,OAAwC;AACpE,MAAI,CAAC,SAAS,KAAK,EAAG,QAAO,CAAC;AAC9B,QAAM,OAA+B,CAAC;AACtC,aAAW,CAAC,QAAQ,KAAK,KAAK,OAAO,QAAQ,KAAK,GAAG;AACnD,UAAM,MAAM,yBAAyB,MAAM;AAC3C,QAAI,CAAC,IAAK;AACV,gBAAY,MAAM,KAAK,KAAK;AAAA,EAC9B;AACA,SAAO;AACT;AAEA,SAAS,YAAY,KAA6B,KAAa,OAAsB;AACnF,QAAM,WAAW,iBAAiB,KAAK;AACvC,MAAI,aAAa,QAAW;AAC1B,QAAI,GAAG,IAAI;AACX;AAAA,EACF;AACA,MAAI,CAAC,SAAS,KAAK,EAAG;AACtB,aAAW,CAAC,UAAU,UAAU,KAAK,OAAO,QAAQ,KAAK,GAAG;AAC1D,QAAI,CAAC,SAAU;AACf,gBAAY,KAAK,GAAG,GAAG,IAAI,QAAQ,IAAI,UAAU;AAAA,EACnD;AACF;AAEA,SAAS,yBAAyB,KAAqB;AACrD,MAAI,IAAI,WAAW,qBAAqB,EAAG,QAAO,IAAI,MAAM,sBAAsB,MAAM;AACxF,MAAI,IAAI,WAAW,oBAAoB,EAAG,QAAO,IAAI,MAAM,qBAAqB,MAAM;AACtF,SAAO;AACT;AAEA,SAAS,iBAAiB,OAAoC;AAC5D,MAAI,OAAO,UAAU,SAAU,QAAO;AACtC,MAAI,OAAO,UAAU,UAAW,QAAO,QAAQ,SAAS;AACxD,MAAI,OAAO,UAAU,YAAY,OAAO,SAAS,KAAK,EAAG,QAAO,OAAO,KAAK;AAC5E,SAAO;AACT;AAEA,SAAS,SAAS,OAAkD;AAClE,SAAO,OAAO,UAAU,YAAY,UAAU,QAAQ,CAAC,MAAM,QAAQ,KAAK;AAC5E;AAEA,SAAS,gBAAgB,KAA6D;AACpF,QAAM,QAAQ,oBAAI,IAAoB;AACtC,aAAW,CAAC,WAAW,OAAO,KAAK,OAAO,QAAQ,GAAG,GAAG;AACtD,eAAW,SAAS,QAAS,OAAM,IAAI,OAAO,SAAS;AAAA,EACzD;AACA,SAAO;AACT;;;ADzIO,IAAM,+BAA+B;AACrC,IAAM,+BAA+B;AAE5C,IAAM,qBAAqB,+BAA+B;AAEnD,IAAM,0BAA0B;AAgChC,SAAS,qBAAqB,SAAiD;AACpF,QAAM,WAAW,CAAC,GAAI,SAAS,YAAY,CAAC,CAAE;AAC9C,QAAM,OAAO,oBAAI,IAAoB;AACrC,WAAS,QAAQ,GAAG,QAAQ,SAAS,QAAQ,SAAS,GAAG;AACvD,UAAM,MAAM,SAAS,KAAK;AAC1B,QAAI,QAAQ,UAAa,CAAC,KAAK,IAAI,GAAG,EAAG,MAAK,IAAI,KAAK,KAAK;AAAA,EAC9D;AAEA,SAAO;AAAA,IACL,QAAQ,QAAQ;AACd,YAAM,MAAM,yBAAyB,MAAM;AAC3C,YAAM,UAAoB,CAAC;AAC3B,UAAI,UAAU,qBAAqB,GAAG;AACtC,aAAO,QAAQ,UAAU;AACvB,cAAM,SAAS,kBAAkB,KAAK,MAAM,SAAS,MAAM;AAC3D,YAAI,CAAC,OAAQ;AACb,eAAO,IAAI,MAAM;AACjB,gBAAQ,KAAK,MAAM;AACnB,kBAAU,qBAAqB,GAAG;AAAA,MACpC;AACA,aAAO;AAAA,QACL,GAAI,QAAQ,OAAO,EAAE,MAAM,QAAQ,KAAK,IAAI,CAAC;AAAA,QAC7C;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACF;AAGO,SAAS,oBAAoB,SAA6D;AAC/F,MAAI,CAAC,QAAQ,OAAQ,QAAO;AAC5B,SAAO;AAAA,IACL,MAAM;AAAA,IACN,SAAS,sDAAsD,QAAQ,KAAK,IAAI,CAAC;AAAA,IACjF,SAAS,EAAE,SAAS,CAAC,GAAG,OAAO,EAAE;AAAA,EACnC;AACF;AAeO,SAAS,gBACX,QACiC;AACpC,QAAM,UAAU,qBAAqB,yBAAyB,MAAM,CAAC;AACrE,MAAI,QAAQ,UAAU;AACpB,UAAM,IAAI;AAAA,MACR,mDAAmD,QAAQ,aAAa,sCAAsC,kBAAkB;AAAA,IAClI;AAAA,EACF;AACA,SAAO,QAAQ;AACjB;AAQO,SAAS,aAAa,MAAuC;AAClE,QAAM,SAAS,iBAAiB,IAAI;AACpC,MAAI,CAAC,OAAQ,QAAO,CAAC;AACrB,QAAM,QAAkB,CAAC;AACzB,WAAS,QAAQ,KAAK,SAAS,GAAG;AAChC,UAAM,QAAQ,OAAO,KAAK,KAAK,EAAE;AACjC,QAAI,OAAO,UAAU,SAAU;AAC/B,UAAM,KAAK,KAAK;AAAA,EAClB;AACA,MAAI,CAAC,MAAM,OAAQ,QAAO,CAAC;AAC3B,QAAM,SAAkB,KAAK,MAAM,OAAO,KAAK,MAAM,KAAK,EAAE,GAAG,QAAQ,EAAE,SAAS,MAAM,CAAC;AACzF,MAAI,CAACA,UAAS,MAAM,EAAG,QAAO,CAAC;AAC/B,QAAM,SAAiC,CAAC;AACxC,aAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ,MAAM,GAAG;AACjD,QAAI,OAAO,UAAU,SAAU,QAAO,GAAG,IAAI;AAAA,EAC/C;AACA,SAAO,kBAAkB,MAAM;AACjC;AAGA,SAAS,iBAAiB,MAAoD;AAC5E,MAAIA,UAAS,IAAI,EAAG,QAAO;AAC3B,MAAI,OAAO,SAAS,SAAU,QAAO;AACrC,MAAI;AACF,UAAM,SAAkB,KAAK,MAAM,IAAI;AACvC,WAAOA,UAAS,MAAM,IAAI,SAAS;AAAA,EACrC,QAAQ;AACN,WAAO;AAAA,EACT;AACF;AAEA,SAAS,qBAAqB,KAI5B;AACA,QAAM,OAAO,OAAO,KAAK,GAAG,EAAE,KAAK;AACnC,MAAI,CAAC,KAAK,OAAQ,QAAO,EAAE,eAAe,GAAG,UAAU,MAAM;AAC7D,QAAM,UAAkC,CAAC;AACzC,aAAW,OAAO,MAAM;AACtB,UAAM,QAAQ,IAAI,GAAG;AACrB,QAAI,UAAU,OAAW,SAAQ,GAAG,IAAI;AAAA,EAC1C;AACA,QAAM,UAAU,OAAO,KAAK,KAAK,UAAU,OAAO,GAAG,MAAM,EAAE,SAAS,QAAQ;AAC9E,MAAI,KAAK,KAAK,QAAQ,SAAS,4BAA4B,IAAI,8BAA8B;AAC3F,WAAO,EAAE,eAAe,QAAQ,QAAQ,UAAU,KAAK;AAAA,EACzD;AACA,QAAM,OAA+B,CAAC;AACtC,WAAS,QAAQ,GAAG,QAAQ,KAAK,KAAK,QAAQ,SAAS,4BAA4B,GAAG,SAAS,GAAG;AAChG,SAAK,KAAK,KAAK,EAAE,IAAI,QAAQ;AAAA,MAC3B,QAAQ;AAAA,OACP,QAAQ,KAAK;AAAA,IAChB;AAAA,EACF;AACA,SAAO,EAAE,MAAM,eAAe,QAAQ,QAAQ,UAAU,MAAM;AAChE;AAEA,SAAS,kBACP,KACA,MACA,cACoB;AACpB,MAAI;AACJ,MAAI,aAAa;AACjB,MAAI,aAAa;AACjB,aAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ,GAAG,GAAG;AAC9C,UAAM,UAAU,KAAK,IAAI,GAAG,KAAK;AACjC,UAAM,OAAO,MAAM;AACnB,UAAM,gBAAgB,WAAW,UAC5B,UAAU,cACT,YAAY,cAAc,OAAO,cACjC,YAAY,cAAc,SAAS,cAAc,MAAM;AAC7D,QAAI,eAAe;AACjB,eAAS;AACT,mBAAa;AACb,mBAAa;AAAA,IACf;AAAA,EACF;AACA,SAAO;AACT;AAEA,SAASA,UAAS,OAAkD;AAClE,SAAO,OAAO,UAAU,YAAY,UAAU,QAAQ,CAAC,MAAM,QAAQ,KAAK;AAC5E;","names":["isRecord"]}
package/dist/index.d.cts CHANGED
@@ -85,8 +85,9 @@ declare function metadataTrimWarning(dropped: readonly string[]): MetadataTrimWa
85
85
  declare function packMetadata(...layers: Array<Record<string, unknown> | undefined>): Record<string, string> | undefined;
86
86
  /**
87
87
  * Opens the `m.0`, `m.1`, ... object from a provider log.
88
+ * Accepts the wire object or its JSON string (for example Cloudflare `cf-aig-metadata`).
88
89
  * Returns every stored pair with known aliases promoted to canonical keys.
89
- * A missing record returns `{}`.
90
+ * A missing or unreadable record returns `{}`.
90
91
  */
91
92
  declare function openMetadata(wire: unknown): Record<string, string>;
92
93
 
package/dist/index.d.ts CHANGED
@@ -85,8 +85,9 @@ declare function metadataTrimWarning(dropped: readonly string[]): MetadataTrimWa
85
85
  declare function packMetadata(...layers: Array<Record<string, unknown> | undefined>): Record<string, string> | undefined;
86
86
  /**
87
87
  * Opens the `m.0`, `m.1`, ... object from a provider log.
88
+ * Accepts the wire object or its JSON string (for example Cloudflare `cf-aig-metadata`).
88
89
  * Returns every stored pair with known aliases promoted to canonical keys.
89
- * A missing record returns `{}`.
90
+ * A missing or unreadable record returns `{}`.
90
91
  */
91
92
  declare function openMetadata(wire: unknown): Record<string, string>;
92
93
 
package/dist/index.js CHANGED
@@ -152,10 +152,11 @@ function packMetadata(...layers) {
152
152
  return encoded.wire;
153
153
  }
154
154
  function openMetadata(wire) {
155
- if (!isRecord2(wire)) return {};
155
+ const object = coerceWireObject(wire);
156
+ if (!object) return {};
156
157
  const parts = [];
157
158
  for (let index = 0; ; index += 1) {
158
- const chunk = wire[`m.${index}`];
159
+ const chunk = object[`m.${index}`];
159
160
  if (typeof chunk !== "string") break;
160
161
  parts.push(chunk);
161
162
  }
@@ -168,6 +169,16 @@ function openMetadata(wire) {
168
169
  }
169
170
  return normalizeMetadata(record);
170
171
  }
172
+ function coerceWireObject(wire) {
173
+ if (isRecord2(wire)) return wire;
174
+ if (typeof wire !== "string") return void 0;
175
+ try {
176
+ const parsed = JSON.parse(wire);
177
+ return isRecord2(parsed) ? parsed : void 0;
178
+ } catch {
179
+ return void 0;
180
+ }
181
+ }
171
182
  function encodeProviderRecord(map) {
172
183
  const keys = Object.keys(map).sort();
173
184
  if (!keys.length) return { encodedLength: 0, tooLarge: false };
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"sources":["../src/normalize.ts","../src/index.ts"],"sourcesContent":["/**\r\n * Canonical metadata keys shared across providers.\r\n * Each entry lists known provider-namespaced aliases that mean the same thing.\r\n * Prefer the canonical key when reading or writing. Provider aliases may remain.\r\n *\r\n * Grow this map as repeating fields appear under a vendor prefix\r\n * (for example `openrouter.api_key_name` → `api_key_name`).\r\n */\r\nexport const METADATA_NORMALIZATION_MAP = {\r\n api_key_name: [\"openrouter.api_key_name\"],\r\n provider_slug: [\"openrouter.provider_slug\"],\r\n provider_name: [\"openrouter.provider_name\", \"gen_ai.provider.name\"],\r\n entity_id: [\"openrouter.entity_id\"],\r\n user_id: [\"openrouter.user_id\", \"user.id\", \"cf.user_id\"],\r\n finish_reason: [\"openrouter.finish_reason\", \"gen_ai.response.finish_reason\"],\r\n input_unit_price: [\"openrouter.input_unit_price\"],\r\n output_unit_price: [\"openrouter.output_unit_price\"],\r\n source: [\"openrouter.source\"],\r\n session_id: [\"session.id\"]\r\n} as const satisfies Record<string, readonly string[]>;\r\n\r\nexport type NormalizedMetadataKey = keyof typeof METADATA_NORMALIZATION_MAP;\r\n\r\nconst TRACE_METADATA_PREFIX = \"trace.metadata.\";\r\nconst SPAN_METADATA_PREFIX = \"span.metadata.\";\r\n\r\nconst ALIAS_TO_CANONICAL = buildAliasIndex(METADATA_NORMALIZATION_MAP);\r\n\r\n/** First path segments that may nest provider-specific metadata objects. */\r\nconst KNOWN_PROVIDER_NAMESPACES = new Set(\r\n Object.values(METADATA_NORMALIZATION_MAP).flatMap((aliases) =>\r\n aliases.map((alias) => alias.split(\".\")[0]).filter((part): part is string => Boolean(part))\r\n )\r\n);\r\n\r\n/**\r\n * Flattens a metadata bag and promotes known provider aliases to canonical keys.\r\n *\r\n * Accepts:\r\n * - flat string maps (`{ api_key_name: \"prod\" }`)\r\n * - dotted provider keys (`{ \"openrouter.api_key_name\": \"prod\" }`)\r\n * - nested provider objects (`{ openrouter: { api_key_name: \"prod\" } }`)\r\n * - OTLP attribute bags (`{ \"trace.metadata.openrouter.api_key_name\": \"prod\" }`)\r\n *\r\n * Provider-namespaced keys stay when present. Canonical keys are added when an\r\n * alias is known and the canonical key is missing. An explicit canonical value wins.\r\n */\r\nexport function normalizeMetadata(input: unknown): Record<string, string> {\r\n return promoteCanonicalKeys(flattenMetadataInput(input));\r\n}\r\n\r\n/**\r\n * Pack-time collection: scalar pairs plus known provider namespaces.\r\n * Arbitrary nested objects stay off the wire (caller response metadata keeps them).\r\n * Known aliases are promoted to canonical keys.\r\n */\r\nexport function collectNormalizedStrings(\r\n layers: Array<Record<string, unknown> | undefined>\r\n): Record<string, string> {\r\n const map: Record<string, string> = {};\r\n for (const layer of layers) {\r\n if (!layer) continue;\r\n for (const [key, value] of Object.entries(layer)) {\r\n const asString = asMetadataString(value);\r\n if (asString !== undefined) {\r\n map[key] = asString;\r\n continue;\r\n }\r\n if (!isRecord(value) || !KNOWN_PROVIDER_NAMESPACES.has(key)) continue;\r\n for (const [childKey, childValue] of Object.entries(value)) {\r\n if (!childKey) continue;\r\n const childString = asMetadataString(childValue);\r\n if (childString !== undefined) map[`${key}.${childKey}`] = childString;\r\n }\r\n }\r\n }\r\n return promoteCanonicalKeys(map);\r\n}\r\n\r\n/** Returns the canonical key for a known alias, or the key itself. */\r\nexport function canonicalMetadataKey(key: string): string {\r\n return ALIAS_TO_CANONICAL.get(key) ?? key;\r\n}\r\n\r\nfunction promoteCanonicalKeys(flat: Record<string, string>): Record<string, string> {\r\n const out: Record<string, string> = { ...flat };\r\n for (const [canonical, aliases] of Object.entries(METADATA_NORMALIZATION_MAP)) {\r\n if (Object.prototype.hasOwnProperty.call(out, canonical)) continue;\r\n for (const alias of aliases) {\r\n const value = out[alias];\r\n if (value !== undefined) {\r\n out[canonical] = value;\r\n break;\r\n }\r\n }\r\n }\r\n return out;\r\n}\r\n\r\nfunction flattenMetadataInput(input: unknown): Record<string, string> {\r\n if (!isRecord(input)) return {};\r\n const flat: Record<string, string> = {};\r\n for (const [rawKey, value] of Object.entries(input)) {\r\n const key = stripObservabilityPrefix(rawKey);\r\n if (!key) continue;\r\n collectFlat(flat, key, value);\r\n }\r\n return flat;\r\n}\r\n\r\nfunction collectFlat(out: Record<string, string>, key: string, value: unknown): void {\r\n const asString = asMetadataString(value);\r\n if (asString !== undefined) {\r\n out[key] = asString;\r\n return;\r\n }\r\n if (!isRecord(value)) return;\r\n for (const [childKey, childValue] of Object.entries(value)) {\r\n if (!childKey) continue;\r\n collectFlat(out, `${key}.${childKey}`, childValue);\r\n }\r\n}\r\n\r\nfunction stripObservabilityPrefix(key: string): string {\r\n if (key.startsWith(TRACE_METADATA_PREFIX)) return key.slice(TRACE_METADATA_PREFIX.length);\r\n if (key.startsWith(SPAN_METADATA_PREFIX)) return key.slice(SPAN_METADATA_PREFIX.length);\r\n return key;\r\n}\r\n\r\nfunction asMetadataString(value: unknown): string | undefined {\r\n if (typeof value === \"string\") return value;\r\n if (typeof value === \"boolean\") return value ? \"true\" : \"false\";\r\n if (typeof value === \"number\" && Number.isFinite(value)) return String(value);\r\n return undefined;\r\n}\r\n\r\nfunction isRecord(value: unknown): value is Record<string, unknown> {\r\n return typeof value === \"object\" && value !== null && !Array.isArray(value);\r\n}\r\n\r\nfunction buildAliasIndex(map: Record<string, readonly string[]>): Map<string, string> {\r\n const index = new Map<string, string>();\r\n for (const [canonical, aliases] of Object.entries(map)) {\r\n for (const alias of aliases) index.set(alias, canonical);\r\n }\r\n return index;\r\n}\r\n","export {\r\n METADATA_NORMALIZATION_MAP,\r\n canonicalMetadataKey,\r\n normalizeMetadata,\r\n type NormalizedMetadataKey\r\n} from \"./normalize\";\r\n\r\nimport { collectNormalizedStrings, normalizeMetadata } from \"./normalize\";\r\n\r\nexport const PROVIDER_METADATA_CHUNK_SIZE = 256;\r\nexport const PROVIDER_METADATA_MAX_CHUNKS = 16;\r\n\r\nconst MAX_ENCODED_LENGTH = PROVIDER_METADATA_CHUNK_SIZE * PROVIDER_METADATA_MAX_CHUNKS;\r\n\r\nexport const METADATA_RECORD_TRIMMED = \"METADATA_RECORD_TRIMMED\";\r\n\r\nexport interface MetadataPackerOptions {\r\n /**\r\n * Highest priority first.\r\n * Listed keys are kept ahead of every key that is not in the list.\r\n * Within the list, an earlier key is kept ahead of a later key.\r\n */\r\n priority?: readonly string[];\r\n}\r\n\r\nexport interface PackedMetadata {\r\n /** Provider wire object. Omitted when the map is empty or every pair was dropped. */\r\n wire?: Record<string, string>;\r\n /** Keys removed so the record fits, least important first. Empty when nothing was dropped. */\r\n dropped: readonly string[];\r\n}\r\n\r\nexport interface MetadataTrimWarning {\r\n code: typeof METADATA_RECORD_TRIMMED;\r\n message: string;\r\n details: { dropped: string[] };\r\n}\r\n\r\nexport interface MetadataPacker {\r\n pack(...layers: Array<Record<string, unknown> | undefined>): PackedMetadata;\r\n}\r\n\r\n/**\r\n * One packer for a process.\r\n * Pass the priority list here. Every `pack` call trims to the provider limit and reports dropped keys.\r\n */\r\nexport function createMetadataPacker(options?: MetadataPackerOptions): MetadataPacker {\r\n const priority = [...(options?.priority ?? [])];\r\n const rank = new Map<string, number>();\r\n for (let index = 0; index < priority.length; index += 1) {\r\n const key = priority[index];\r\n if (key !== undefined && !rank.has(key)) rank.set(key, index);\r\n }\r\n\r\n return {\r\n pack(...layers) {\r\n const map = collectNormalizedStrings(layers);\r\n const dropped: string[] = [];\r\n let encoded = encodeProviderRecord(map);\r\n while (encoded.tooLarge) {\r\n const victim = leastImportantKey(map, rank, priority.length);\r\n if (!victim) break;\r\n delete map[victim];\r\n dropped.push(victim);\r\n encoded = encodeProviderRecord(map);\r\n }\r\n return {\r\n ...(encoded.wire ? { wire: encoded.wire } : {}),\r\n dropped\r\n };\r\n }\r\n };\r\n}\r\n\r\n/** Warning for a pack that had to drop keys. Omitted when nothing was dropped. */\r\nexport function metadataTrimWarning(dropped: readonly string[]): MetadataTrimWarning | undefined {\r\n if (!dropped.length) return undefined;\r\n return {\r\n code: METADATA_RECORD_TRIMMED,\r\n message: `Dropped metadata keys so the provider record fits: ${dropped.join(\", \")}.`,\r\n details: { dropped: [...dropped] }\r\n };\r\n}\r\n\r\n/**\r\n * Packs caller maps into one provider metadata object.\r\n * Later layers win on the same key. String, number, and boolean values are stored.\r\n * Numbers and booleans are stored as their string form.\r\n * Nested objects under known provider namespaces (for example `openrouter`) are\r\n * flattened, and known aliases are promoted to canonical keys\r\n * (`openrouter.api_key_name` also becomes `api_key_name`). Other objects and\r\n * arrays are omitted from the wire record.\r\n * An empty result is `undefined`.\r\n * A record over the size limit throws `METADATA_RECORD_TOO_LARGE`.\r\n * Writers that should drop pairs instead use `createMetadataPacker`.\r\n * The packed object is the same for every provider: `m.0`, `m.1`, and so on.\r\n */\r\nexport function packMetadata(\r\n ...layers: Array<Record<string, unknown> | undefined>\r\n): Record<string, string> | undefined {\r\n const encoded = encodeProviderRecord(collectNormalizedStrings(layers));\r\n if (encoded.tooLarge) {\r\n throw new Error(\r\n `METADATA_RECORD_TOO_LARGE: provider metadata is ${encoded.encodedLength} base64 characters; the maximum is ${MAX_ENCODED_LENGTH}.`\r\n );\r\n }\r\n return encoded.wire;\r\n}\r\n\r\n/**\r\n * Opens the `m.0`, `m.1`, ... object from a provider log.\r\n * Returns every stored pair with known aliases promoted to canonical keys.\r\n * A missing record returns `{}`.\r\n */\r\nexport function openMetadata(wire: unknown): Record<string, string> {\r\n if (!isRecord(wire)) return {};\r\n const parts: string[] = [];\r\n for (let index = 0; ; index += 1) {\r\n const chunk = wire[`m.${index}`];\r\n if (typeof chunk !== \"string\") break;\r\n parts.push(chunk);\r\n }\r\n if (!parts.length) return {};\r\n const parsed: unknown = JSON.parse(Buffer.from(parts.join(\"\"), \"base64\").toString(\"utf8\"));\r\n if (!isRecord(parsed)) return {};\r\n const record: Record<string, string> = {};\r\n for (const [key, value] of Object.entries(parsed)) {\r\n if (typeof value === \"string\") record[key] = value;\r\n }\r\n return normalizeMetadata(record);\r\n}\r\n\r\nfunction encodeProviderRecord(map: Record<string, string>): {\r\n wire?: Record<string, string>;\r\n encodedLength: number;\r\n tooLarge: boolean;\r\n} {\r\n const keys = Object.keys(map).sort();\r\n if (!keys.length) return { encodedLength: 0, tooLarge: false };\r\n const ordered: Record<string, string> = {};\r\n for (const key of keys) {\r\n const value = map[key];\r\n if (value !== undefined) ordered[key] = value;\r\n }\r\n const encoded = Buffer.from(JSON.stringify(ordered), \"utf8\").toString(\"base64\");\r\n if (Math.ceil(encoded.length / PROVIDER_METADATA_CHUNK_SIZE) > PROVIDER_METADATA_MAX_CHUNKS) {\r\n return { encodedLength: encoded.length, tooLarge: true };\r\n }\r\n const wire: Record<string, string> = {};\r\n for (let index = 0; index < Math.ceil(encoded.length / PROVIDER_METADATA_CHUNK_SIZE); index += 1) {\r\n wire[`m.${index}`] = encoded.slice(\r\n index * PROVIDER_METADATA_CHUNK_SIZE,\r\n (index + 1) * PROVIDER_METADATA_CHUNK_SIZE\r\n );\r\n }\r\n return { wire, encodedLength: encoded.length, tooLarge: false };\r\n}\r\n\r\nfunction leastImportantKey(\r\n map: Record<string, string>,\r\n rank: Map<string, number>,\r\n unlistedRank: number\r\n): string | undefined {\r\n let chosen: string | undefined;\r\n let chosenRank = -1;\r\n let chosenSize = -1;\r\n for (const [key, value] of Object.entries(map)) {\r\n const keyRank = rank.get(key) ?? unlistedRank;\r\n const size = value.length;\r\n const lessImportant = chosen === undefined\r\n || keyRank > chosenRank\r\n || (keyRank === chosenRank && size > chosenSize)\r\n || (keyRank === chosenRank && size === chosenSize && key > chosen);\r\n if (lessImportant) {\r\n chosen = key;\r\n chosenRank = keyRank;\r\n chosenSize = size;\r\n }\r\n }\r\n return chosen;\r\n}\r\n\r\nfunction isRecord(value: unknown): value is Record<string, unknown> {\r\n return typeof value === \"object\" && value !== null && !Array.isArray(value);\r\n}\r\n"],"mappings":";AAQO,IAAM,6BAA6B;AAAA,EACxC,cAAc,CAAC,yBAAyB;AAAA,EACxC,eAAe,CAAC,0BAA0B;AAAA,EAC1C,eAAe,CAAC,4BAA4B,sBAAsB;AAAA,EAClE,WAAW,CAAC,sBAAsB;AAAA,EAClC,SAAS,CAAC,sBAAsB,WAAW,YAAY;AAAA,EACvD,eAAe,CAAC,4BAA4B,+BAA+B;AAAA,EAC3E,kBAAkB,CAAC,6BAA6B;AAAA,EAChD,mBAAmB,CAAC,8BAA8B;AAAA,EAClD,QAAQ,CAAC,mBAAmB;AAAA,EAC5B,YAAY,CAAC,YAAY;AAC3B;AAIA,IAAM,wBAAwB;AAC9B,IAAM,uBAAuB;AAE7B,IAAM,qBAAqB,gBAAgB,0BAA0B;AAGrE,IAAM,4BAA4B,IAAI;AAAA,EACpC,OAAO,OAAO,0BAA0B,EAAE;AAAA,IAAQ,CAAC,YACjD,QAAQ,IAAI,CAAC,UAAU,MAAM,MAAM,GAAG,EAAE,CAAC,CAAC,EAAE,OAAO,CAAC,SAAyB,QAAQ,IAAI,CAAC;AAAA,EAC5F;AACF;AAcO,SAAS,kBAAkB,OAAwC;AACxE,SAAO,qBAAqB,qBAAqB,KAAK,CAAC;AACzD;AAOO,SAAS,yBACd,QACwB;AACxB,QAAM,MAA8B,CAAC;AACrC,aAAW,SAAS,QAAQ;AAC1B,QAAI,CAAC,MAAO;AACZ,eAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ,KAAK,GAAG;AAChD,YAAM,WAAW,iBAAiB,KAAK;AACvC,UAAI,aAAa,QAAW;AAC1B,YAAI,GAAG,IAAI;AACX;AAAA,MACF;AACA,UAAI,CAAC,SAAS,KAAK,KAAK,CAAC,0BAA0B,IAAI,GAAG,EAAG;AAC7D,iBAAW,CAAC,UAAU,UAAU,KAAK,OAAO,QAAQ,KAAK,GAAG;AAC1D,YAAI,CAAC,SAAU;AACf,cAAM,cAAc,iBAAiB,UAAU;AAC/C,YAAI,gBAAgB,OAAW,KAAI,GAAG,GAAG,IAAI,QAAQ,EAAE,IAAI;AAAA,MAC7D;AAAA,IACF;AAAA,EACF;AACA,SAAO,qBAAqB,GAAG;AACjC;AAGO,SAAS,qBAAqB,KAAqB;AACxD,SAAO,mBAAmB,IAAI,GAAG,KAAK;AACxC;AAEA,SAAS,qBAAqB,MAAsD;AAClF,QAAM,MAA8B,EAAE,GAAG,KAAK;AAC9C,aAAW,CAAC,WAAW,OAAO,KAAK,OAAO,QAAQ,0BAA0B,GAAG;AAC7E,QAAI,OAAO,UAAU,eAAe,KAAK,KAAK,SAAS,EAAG;AAC1D,eAAW,SAAS,SAAS;AAC3B,YAAM,QAAQ,IAAI,KAAK;AACvB,UAAI,UAAU,QAAW;AACvB,YAAI,SAAS,IAAI;AACjB;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACA,SAAO;AACT;AAEA,SAAS,qBAAqB,OAAwC;AACpE,MAAI,CAAC,SAAS,KAAK,EAAG,QAAO,CAAC;AAC9B,QAAM,OAA+B,CAAC;AACtC,aAAW,CAAC,QAAQ,KAAK,KAAK,OAAO,QAAQ,KAAK,GAAG;AACnD,UAAM,MAAM,yBAAyB,MAAM;AAC3C,QAAI,CAAC,IAAK;AACV,gBAAY,MAAM,KAAK,KAAK;AAAA,EAC9B;AACA,SAAO;AACT;AAEA,SAAS,YAAY,KAA6B,KAAa,OAAsB;AACnF,QAAM,WAAW,iBAAiB,KAAK;AACvC,MAAI,aAAa,QAAW;AAC1B,QAAI,GAAG,IAAI;AACX;AAAA,EACF;AACA,MAAI,CAAC,SAAS,KAAK,EAAG;AACtB,aAAW,CAAC,UAAU,UAAU,KAAK,OAAO,QAAQ,KAAK,GAAG;AAC1D,QAAI,CAAC,SAAU;AACf,gBAAY,KAAK,GAAG,GAAG,IAAI,QAAQ,IAAI,UAAU;AAAA,EACnD;AACF;AAEA,SAAS,yBAAyB,KAAqB;AACrD,MAAI,IAAI,WAAW,qBAAqB,EAAG,QAAO,IAAI,MAAM,sBAAsB,MAAM;AACxF,MAAI,IAAI,WAAW,oBAAoB,EAAG,QAAO,IAAI,MAAM,qBAAqB,MAAM;AACtF,SAAO;AACT;AAEA,SAAS,iBAAiB,OAAoC;AAC5D,MAAI,OAAO,UAAU,SAAU,QAAO;AACtC,MAAI,OAAO,UAAU,UAAW,QAAO,QAAQ,SAAS;AACxD,MAAI,OAAO,UAAU,YAAY,OAAO,SAAS,KAAK,EAAG,QAAO,OAAO,KAAK;AAC5E,SAAO;AACT;AAEA,SAAS,SAAS,OAAkD;AAClE,SAAO,OAAO,UAAU,YAAY,UAAU,QAAQ,CAAC,MAAM,QAAQ,KAAK;AAC5E;AAEA,SAAS,gBAAgB,KAA6D;AACpF,QAAM,QAAQ,oBAAI,IAAoB;AACtC,aAAW,CAAC,WAAW,OAAO,KAAK,OAAO,QAAQ,GAAG,GAAG;AACtD,eAAW,SAAS,QAAS,OAAM,IAAI,OAAO,SAAS;AAAA,EACzD;AACA,SAAO;AACT;;;ACzIO,IAAM,+BAA+B;AACrC,IAAM,+BAA+B;AAE5C,IAAM,qBAAqB,+BAA+B;AAEnD,IAAM,0BAA0B;AAgChC,SAAS,qBAAqB,SAAiD;AACpF,QAAM,WAAW,CAAC,GAAI,SAAS,YAAY,CAAC,CAAE;AAC9C,QAAM,OAAO,oBAAI,IAAoB;AACrC,WAAS,QAAQ,GAAG,QAAQ,SAAS,QAAQ,SAAS,GAAG;AACvD,UAAM,MAAM,SAAS,KAAK;AAC1B,QAAI,QAAQ,UAAa,CAAC,KAAK,IAAI,GAAG,EAAG,MAAK,IAAI,KAAK,KAAK;AAAA,EAC9D;AAEA,SAAO;AAAA,IACL,QAAQ,QAAQ;AACd,YAAM,MAAM,yBAAyB,MAAM;AAC3C,YAAM,UAAoB,CAAC;AAC3B,UAAI,UAAU,qBAAqB,GAAG;AACtC,aAAO,QAAQ,UAAU;AACvB,cAAM,SAAS,kBAAkB,KAAK,MAAM,SAAS,MAAM;AAC3D,YAAI,CAAC,OAAQ;AACb,eAAO,IAAI,MAAM;AACjB,gBAAQ,KAAK,MAAM;AACnB,kBAAU,qBAAqB,GAAG;AAAA,MACpC;AACA,aAAO;AAAA,QACL,GAAI,QAAQ,OAAO,EAAE,MAAM,QAAQ,KAAK,IAAI,CAAC;AAAA,QAC7C;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACF;AAGO,SAAS,oBAAoB,SAA6D;AAC/F,MAAI,CAAC,QAAQ,OAAQ,QAAO;AAC5B,SAAO;AAAA,IACL,MAAM;AAAA,IACN,SAAS,sDAAsD,QAAQ,KAAK,IAAI,CAAC;AAAA,IACjF,SAAS,EAAE,SAAS,CAAC,GAAG,OAAO,EAAE;AAAA,EACnC;AACF;AAeO,SAAS,gBACX,QACiC;AACpC,QAAM,UAAU,qBAAqB,yBAAyB,MAAM,CAAC;AACrE,MAAI,QAAQ,UAAU;AACpB,UAAM,IAAI;AAAA,MACR,mDAAmD,QAAQ,aAAa,sCAAsC,kBAAkB;AAAA,IAClI;AAAA,EACF;AACA,SAAO,QAAQ;AACjB;AAOO,SAAS,aAAa,MAAuC;AAClE,MAAI,CAACA,UAAS,IAAI,EAAG,QAAO,CAAC;AAC7B,QAAM,QAAkB,CAAC;AACzB,WAAS,QAAQ,KAAK,SAAS,GAAG;AAChC,UAAM,QAAQ,KAAK,KAAK,KAAK,EAAE;AAC/B,QAAI,OAAO,UAAU,SAAU;AAC/B,UAAM,KAAK,KAAK;AAAA,EAClB;AACA,MAAI,CAAC,MAAM,OAAQ,QAAO,CAAC;AAC3B,QAAM,SAAkB,KAAK,MAAM,OAAO,KAAK,MAAM,KAAK,EAAE,GAAG,QAAQ,EAAE,SAAS,MAAM,CAAC;AACzF,MAAI,CAACA,UAAS,MAAM,EAAG,QAAO,CAAC;AAC/B,QAAM,SAAiC,CAAC;AACxC,aAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ,MAAM,GAAG;AACjD,QAAI,OAAO,UAAU,SAAU,QAAO,GAAG,IAAI;AAAA,EAC/C;AACA,SAAO,kBAAkB,MAAM;AACjC;AAEA,SAAS,qBAAqB,KAI5B;AACA,QAAM,OAAO,OAAO,KAAK,GAAG,EAAE,KAAK;AACnC,MAAI,CAAC,KAAK,OAAQ,QAAO,EAAE,eAAe,GAAG,UAAU,MAAM;AAC7D,QAAM,UAAkC,CAAC;AACzC,aAAW,OAAO,MAAM;AACtB,UAAM,QAAQ,IAAI,GAAG;AACrB,QAAI,UAAU,OAAW,SAAQ,GAAG,IAAI;AAAA,EAC1C;AACA,QAAM,UAAU,OAAO,KAAK,KAAK,UAAU,OAAO,GAAG,MAAM,EAAE,SAAS,QAAQ;AAC9E,MAAI,KAAK,KAAK,QAAQ,SAAS,4BAA4B,IAAI,8BAA8B;AAC3F,WAAO,EAAE,eAAe,QAAQ,QAAQ,UAAU,KAAK;AAAA,EACzD;AACA,QAAM,OAA+B,CAAC;AACtC,WAAS,QAAQ,GAAG,QAAQ,KAAK,KAAK,QAAQ,SAAS,4BAA4B,GAAG,SAAS,GAAG;AAChG,SAAK,KAAK,KAAK,EAAE,IAAI,QAAQ;AAAA,MAC3B,QAAQ;AAAA,OACP,QAAQ,KAAK;AAAA,IAChB;AAAA,EACF;AACA,SAAO,EAAE,MAAM,eAAe,QAAQ,QAAQ,UAAU,MAAM;AAChE;AAEA,SAAS,kBACP,KACA,MACA,cACoB;AACpB,MAAI;AACJ,MAAI,aAAa;AACjB,MAAI,aAAa;AACjB,aAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ,GAAG,GAAG;AAC9C,UAAM,UAAU,KAAK,IAAI,GAAG,KAAK;AACjC,UAAM,OAAO,MAAM;AACnB,UAAM,gBAAgB,WAAW,UAC5B,UAAU,cACT,YAAY,cAAc,OAAO,cACjC,YAAY,cAAc,SAAS,cAAc,MAAM;AAC7D,QAAI,eAAe;AACjB,eAAS;AACT,mBAAa;AACb,mBAAa;AAAA,IACf;AAAA,EACF;AACA,SAAO;AACT;AAEA,SAASA,UAAS,OAAkD;AAClE,SAAO,OAAO,UAAU,YAAY,UAAU,QAAQ,CAAC,MAAM,QAAQ,KAAK;AAC5E;","names":["isRecord"]}
1
+ {"version":3,"sources":["../src/normalize.ts","../src/index.ts"],"sourcesContent":["/**\r\n * Canonical metadata keys shared across providers.\r\n * Each entry lists known provider-namespaced aliases that mean the same thing.\r\n * Prefer the canonical key when reading or writing. Provider aliases may remain.\r\n *\r\n * Grow this map as repeating fields appear under a vendor prefix\r\n * (for example `openrouter.api_key_name` → `api_key_name`).\r\n */\r\nexport const METADATA_NORMALIZATION_MAP = {\r\n api_key_name: [\"openrouter.api_key_name\"],\r\n provider_slug: [\"openrouter.provider_slug\"],\r\n provider_name: [\"openrouter.provider_name\", \"gen_ai.provider.name\"],\r\n entity_id: [\"openrouter.entity_id\"],\r\n user_id: [\"openrouter.user_id\", \"user.id\", \"cf.user_id\"],\r\n finish_reason: [\"openrouter.finish_reason\", \"gen_ai.response.finish_reason\"],\r\n input_unit_price: [\"openrouter.input_unit_price\"],\r\n output_unit_price: [\"openrouter.output_unit_price\"],\r\n source: [\"openrouter.source\"],\r\n session_id: [\"session.id\"]\r\n} as const satisfies Record<string, readonly string[]>;\r\n\r\nexport type NormalizedMetadataKey = keyof typeof METADATA_NORMALIZATION_MAP;\r\n\r\nconst TRACE_METADATA_PREFIX = \"trace.metadata.\";\r\nconst SPAN_METADATA_PREFIX = \"span.metadata.\";\r\n\r\nconst ALIAS_TO_CANONICAL = buildAliasIndex(METADATA_NORMALIZATION_MAP);\r\n\r\n/** First path segments that may nest provider-specific metadata objects. */\r\nconst KNOWN_PROVIDER_NAMESPACES = new Set(\r\n Object.values(METADATA_NORMALIZATION_MAP).flatMap((aliases) =>\r\n aliases.map((alias) => alias.split(\".\")[0]).filter((part): part is string => Boolean(part))\r\n )\r\n);\r\n\r\n/**\r\n * Flattens a metadata bag and promotes known provider aliases to canonical keys.\r\n *\r\n * Accepts:\r\n * - flat string maps (`{ api_key_name: \"prod\" }`)\r\n * - dotted provider keys (`{ \"openrouter.api_key_name\": \"prod\" }`)\r\n * - nested provider objects (`{ openrouter: { api_key_name: \"prod\" } }`)\r\n * - OTLP attribute bags (`{ \"trace.metadata.openrouter.api_key_name\": \"prod\" }`)\r\n *\r\n * Provider-namespaced keys stay when present. Canonical keys are added when an\r\n * alias is known and the canonical key is missing. An explicit canonical value wins.\r\n */\r\nexport function normalizeMetadata(input: unknown): Record<string, string> {\r\n return promoteCanonicalKeys(flattenMetadataInput(input));\r\n}\r\n\r\n/**\r\n * Pack-time collection: scalar pairs plus known provider namespaces.\r\n * Arbitrary nested objects stay off the wire (caller response metadata keeps them).\r\n * Known aliases are promoted to canonical keys.\r\n */\r\nexport function collectNormalizedStrings(\r\n layers: Array<Record<string, unknown> | undefined>\r\n): Record<string, string> {\r\n const map: Record<string, string> = {};\r\n for (const layer of layers) {\r\n if (!layer) continue;\r\n for (const [key, value] of Object.entries(layer)) {\r\n const asString = asMetadataString(value);\r\n if (asString !== undefined) {\r\n map[key] = asString;\r\n continue;\r\n }\r\n if (!isRecord(value) || !KNOWN_PROVIDER_NAMESPACES.has(key)) continue;\r\n for (const [childKey, childValue] of Object.entries(value)) {\r\n if (!childKey) continue;\r\n const childString = asMetadataString(childValue);\r\n if (childString !== undefined) map[`${key}.${childKey}`] = childString;\r\n }\r\n }\r\n }\r\n return promoteCanonicalKeys(map);\r\n}\r\n\r\n/** Returns the canonical key for a known alias, or the key itself. */\r\nexport function canonicalMetadataKey(key: string): string {\r\n return ALIAS_TO_CANONICAL.get(key) ?? key;\r\n}\r\n\r\nfunction promoteCanonicalKeys(flat: Record<string, string>): Record<string, string> {\r\n const out: Record<string, string> = { ...flat };\r\n for (const [canonical, aliases] of Object.entries(METADATA_NORMALIZATION_MAP)) {\r\n if (Object.prototype.hasOwnProperty.call(out, canonical)) continue;\r\n for (const alias of aliases) {\r\n const value = out[alias];\r\n if (value !== undefined) {\r\n out[canonical] = value;\r\n break;\r\n }\r\n }\r\n }\r\n return out;\r\n}\r\n\r\nfunction flattenMetadataInput(input: unknown): Record<string, string> {\r\n if (!isRecord(input)) return {};\r\n const flat: Record<string, string> = {};\r\n for (const [rawKey, value] of Object.entries(input)) {\r\n const key = stripObservabilityPrefix(rawKey);\r\n if (!key) continue;\r\n collectFlat(flat, key, value);\r\n }\r\n return flat;\r\n}\r\n\r\nfunction collectFlat(out: Record<string, string>, key: string, value: unknown): void {\r\n const asString = asMetadataString(value);\r\n if (asString !== undefined) {\r\n out[key] = asString;\r\n return;\r\n }\r\n if (!isRecord(value)) return;\r\n for (const [childKey, childValue] of Object.entries(value)) {\r\n if (!childKey) continue;\r\n collectFlat(out, `${key}.${childKey}`, childValue);\r\n }\r\n}\r\n\r\nfunction stripObservabilityPrefix(key: string): string {\r\n if (key.startsWith(TRACE_METADATA_PREFIX)) return key.slice(TRACE_METADATA_PREFIX.length);\r\n if (key.startsWith(SPAN_METADATA_PREFIX)) return key.slice(SPAN_METADATA_PREFIX.length);\r\n return key;\r\n}\r\n\r\nfunction asMetadataString(value: unknown): string | undefined {\r\n if (typeof value === \"string\") return value;\r\n if (typeof value === \"boolean\") return value ? \"true\" : \"false\";\r\n if (typeof value === \"number\" && Number.isFinite(value)) return String(value);\r\n return undefined;\r\n}\r\n\r\nfunction isRecord(value: unknown): value is Record<string, unknown> {\r\n return typeof value === \"object\" && value !== null && !Array.isArray(value);\r\n}\r\n\r\nfunction buildAliasIndex(map: Record<string, readonly string[]>): Map<string, string> {\r\n const index = new Map<string, string>();\r\n for (const [canonical, aliases] of Object.entries(map)) {\r\n for (const alias of aliases) index.set(alias, canonical);\r\n }\r\n return index;\r\n}\r\n","export {\r\n METADATA_NORMALIZATION_MAP,\r\n canonicalMetadataKey,\r\n normalizeMetadata,\r\n type NormalizedMetadataKey\r\n} from \"./normalize\";\r\n\r\nimport { collectNormalizedStrings, normalizeMetadata } from \"./normalize\";\r\n\r\nexport const PROVIDER_METADATA_CHUNK_SIZE = 256;\r\nexport const PROVIDER_METADATA_MAX_CHUNKS = 16;\r\n\r\nconst MAX_ENCODED_LENGTH = PROVIDER_METADATA_CHUNK_SIZE * PROVIDER_METADATA_MAX_CHUNKS;\r\n\r\nexport const METADATA_RECORD_TRIMMED = \"METADATA_RECORD_TRIMMED\";\r\n\r\nexport interface MetadataPackerOptions {\r\n /**\r\n * Highest priority first.\r\n * Listed keys are kept ahead of every key that is not in the list.\r\n * Within the list, an earlier key is kept ahead of a later key.\r\n */\r\n priority?: readonly string[];\r\n}\r\n\r\nexport interface PackedMetadata {\r\n /** Provider wire object. Omitted when the map is empty or every pair was dropped. */\r\n wire?: Record<string, string>;\r\n /** Keys removed so the record fits, least important first. Empty when nothing was dropped. */\r\n dropped: readonly string[];\r\n}\r\n\r\nexport interface MetadataTrimWarning {\r\n code: typeof METADATA_RECORD_TRIMMED;\r\n message: string;\r\n details: { dropped: string[] };\r\n}\r\n\r\nexport interface MetadataPacker {\r\n pack(...layers: Array<Record<string, unknown> | undefined>): PackedMetadata;\r\n}\r\n\r\n/**\r\n * One packer for a process.\r\n * Pass the priority list here. Every `pack` call trims to the provider limit and reports dropped keys.\r\n */\r\nexport function createMetadataPacker(options?: MetadataPackerOptions): MetadataPacker {\r\n const priority = [...(options?.priority ?? [])];\r\n const rank = new Map<string, number>();\r\n for (let index = 0; index < priority.length; index += 1) {\r\n const key = priority[index];\r\n if (key !== undefined && !rank.has(key)) rank.set(key, index);\r\n }\r\n\r\n return {\r\n pack(...layers) {\r\n const map = collectNormalizedStrings(layers);\r\n const dropped: string[] = [];\r\n let encoded = encodeProviderRecord(map);\r\n while (encoded.tooLarge) {\r\n const victim = leastImportantKey(map, rank, priority.length);\r\n if (!victim) break;\r\n delete map[victim];\r\n dropped.push(victim);\r\n encoded = encodeProviderRecord(map);\r\n }\r\n return {\r\n ...(encoded.wire ? { wire: encoded.wire } : {}),\r\n dropped\r\n };\r\n }\r\n };\r\n}\r\n\r\n/** Warning for a pack that had to drop keys. Omitted when nothing was dropped. */\r\nexport function metadataTrimWarning(dropped: readonly string[]): MetadataTrimWarning | undefined {\r\n if (!dropped.length) return undefined;\r\n return {\r\n code: METADATA_RECORD_TRIMMED,\r\n message: `Dropped metadata keys so the provider record fits: ${dropped.join(\", \")}.`,\r\n details: { dropped: [...dropped] }\r\n };\r\n}\r\n\r\n/**\r\n * Packs caller maps into one provider metadata object.\r\n * Later layers win on the same key. String, number, and boolean values are stored.\r\n * Numbers and booleans are stored as their string form.\r\n * Nested objects under known provider namespaces (for example `openrouter`) are\r\n * flattened, and known aliases are promoted to canonical keys\r\n * (`openrouter.api_key_name` also becomes `api_key_name`). Other objects and\r\n * arrays are omitted from the wire record.\r\n * An empty result is `undefined`.\r\n * A record over the size limit throws `METADATA_RECORD_TOO_LARGE`.\r\n * Writers that should drop pairs instead use `createMetadataPacker`.\r\n * The packed object is the same for every provider: `m.0`, `m.1`, and so on.\r\n */\r\nexport function packMetadata(\r\n ...layers: Array<Record<string, unknown> | undefined>\r\n): Record<string, string> | undefined {\r\n const encoded = encodeProviderRecord(collectNormalizedStrings(layers));\r\n if (encoded.tooLarge) {\r\n throw new Error(\r\n `METADATA_RECORD_TOO_LARGE: provider metadata is ${encoded.encodedLength} base64 characters; the maximum is ${MAX_ENCODED_LENGTH}.`\r\n );\r\n }\r\n return encoded.wire;\r\n}\r\n\r\n/**\r\n * Opens the `m.0`, `m.1`, ... object from a provider log.\r\n * Accepts the wire object or its JSON string (for example Cloudflare `cf-aig-metadata`).\r\n * Returns every stored pair with known aliases promoted to canonical keys.\r\n * A missing or unreadable record returns `{}`.\r\n */\r\nexport function openMetadata(wire: unknown): Record<string, string> {\r\n const object = coerceWireObject(wire);\r\n if (!object) return {};\r\n const parts: string[] = [];\r\n for (let index = 0; ; index += 1) {\r\n const chunk = object[`m.${index}`];\r\n if (typeof chunk !== \"string\") break;\r\n parts.push(chunk);\r\n }\r\n if (!parts.length) return {};\r\n const parsed: unknown = JSON.parse(Buffer.from(parts.join(\"\"), \"base64\").toString(\"utf8\"));\r\n if (!isRecord(parsed)) return {};\r\n const record: Record<string, string> = {};\r\n for (const [key, value] of Object.entries(parsed)) {\r\n if (typeof value === \"string\") record[key] = value;\r\n }\r\n return normalizeMetadata(record);\r\n}\r\n\r\n/** Wire object, or the JSON string Cloudflare stores in `cf-aig-metadata`. */\r\nfunction coerceWireObject(wire: unknown): Record<string, unknown> | undefined {\r\n if (isRecord(wire)) return wire;\r\n if (typeof wire !== \"string\") return undefined;\r\n try {\r\n const parsed: unknown = JSON.parse(wire);\r\n return isRecord(parsed) ? parsed : undefined;\r\n } catch {\r\n return undefined;\r\n }\r\n}\r\n\r\nfunction encodeProviderRecord(map: Record<string, string>): {\r\n wire?: Record<string, string>;\r\n encodedLength: number;\r\n tooLarge: boolean;\r\n} {\r\n const keys = Object.keys(map).sort();\r\n if (!keys.length) return { encodedLength: 0, tooLarge: false };\r\n const ordered: Record<string, string> = {};\r\n for (const key of keys) {\r\n const value = map[key];\r\n if (value !== undefined) ordered[key] = value;\r\n }\r\n const encoded = Buffer.from(JSON.stringify(ordered), \"utf8\").toString(\"base64\");\r\n if (Math.ceil(encoded.length / PROVIDER_METADATA_CHUNK_SIZE) > PROVIDER_METADATA_MAX_CHUNKS) {\r\n return { encodedLength: encoded.length, tooLarge: true };\r\n }\r\n const wire: Record<string, string> = {};\r\n for (let index = 0; index < Math.ceil(encoded.length / PROVIDER_METADATA_CHUNK_SIZE); index += 1) {\r\n wire[`m.${index}`] = encoded.slice(\r\n index * PROVIDER_METADATA_CHUNK_SIZE,\r\n (index + 1) * PROVIDER_METADATA_CHUNK_SIZE\r\n );\r\n }\r\n return { wire, encodedLength: encoded.length, tooLarge: false };\r\n}\r\n\r\nfunction leastImportantKey(\r\n map: Record<string, string>,\r\n rank: Map<string, number>,\r\n unlistedRank: number\r\n): string | undefined {\r\n let chosen: string | undefined;\r\n let chosenRank = -1;\r\n let chosenSize = -1;\r\n for (const [key, value] of Object.entries(map)) {\r\n const keyRank = rank.get(key) ?? unlistedRank;\r\n const size = value.length;\r\n const lessImportant = chosen === undefined\r\n || keyRank > chosenRank\r\n || (keyRank === chosenRank && size > chosenSize)\r\n || (keyRank === chosenRank && size === chosenSize && key > chosen);\r\n if (lessImportant) {\r\n chosen = key;\r\n chosenRank = keyRank;\r\n chosenSize = size;\r\n }\r\n }\r\n return chosen;\r\n}\r\n\r\nfunction isRecord(value: unknown): value is Record<string, unknown> {\r\n return typeof value === \"object\" && value !== null && !Array.isArray(value);\r\n}\r\n"],"mappings":";AAQO,IAAM,6BAA6B;AAAA,EACxC,cAAc,CAAC,yBAAyB;AAAA,EACxC,eAAe,CAAC,0BAA0B;AAAA,EAC1C,eAAe,CAAC,4BAA4B,sBAAsB;AAAA,EAClE,WAAW,CAAC,sBAAsB;AAAA,EAClC,SAAS,CAAC,sBAAsB,WAAW,YAAY;AAAA,EACvD,eAAe,CAAC,4BAA4B,+BAA+B;AAAA,EAC3E,kBAAkB,CAAC,6BAA6B;AAAA,EAChD,mBAAmB,CAAC,8BAA8B;AAAA,EAClD,QAAQ,CAAC,mBAAmB;AAAA,EAC5B,YAAY,CAAC,YAAY;AAC3B;AAIA,IAAM,wBAAwB;AAC9B,IAAM,uBAAuB;AAE7B,IAAM,qBAAqB,gBAAgB,0BAA0B;AAGrE,IAAM,4BAA4B,IAAI;AAAA,EACpC,OAAO,OAAO,0BAA0B,EAAE;AAAA,IAAQ,CAAC,YACjD,QAAQ,IAAI,CAAC,UAAU,MAAM,MAAM,GAAG,EAAE,CAAC,CAAC,EAAE,OAAO,CAAC,SAAyB,QAAQ,IAAI,CAAC;AAAA,EAC5F;AACF;AAcO,SAAS,kBAAkB,OAAwC;AACxE,SAAO,qBAAqB,qBAAqB,KAAK,CAAC;AACzD;AAOO,SAAS,yBACd,QACwB;AACxB,QAAM,MAA8B,CAAC;AACrC,aAAW,SAAS,QAAQ;AAC1B,QAAI,CAAC,MAAO;AACZ,eAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ,KAAK,GAAG;AAChD,YAAM,WAAW,iBAAiB,KAAK;AACvC,UAAI,aAAa,QAAW;AAC1B,YAAI,GAAG,IAAI;AACX;AAAA,MACF;AACA,UAAI,CAAC,SAAS,KAAK,KAAK,CAAC,0BAA0B,IAAI,GAAG,EAAG;AAC7D,iBAAW,CAAC,UAAU,UAAU,KAAK,OAAO,QAAQ,KAAK,GAAG;AAC1D,YAAI,CAAC,SAAU;AACf,cAAM,cAAc,iBAAiB,UAAU;AAC/C,YAAI,gBAAgB,OAAW,KAAI,GAAG,GAAG,IAAI,QAAQ,EAAE,IAAI;AAAA,MAC7D;AAAA,IACF;AAAA,EACF;AACA,SAAO,qBAAqB,GAAG;AACjC;AAGO,SAAS,qBAAqB,KAAqB;AACxD,SAAO,mBAAmB,IAAI,GAAG,KAAK;AACxC;AAEA,SAAS,qBAAqB,MAAsD;AAClF,QAAM,MAA8B,EAAE,GAAG,KAAK;AAC9C,aAAW,CAAC,WAAW,OAAO,KAAK,OAAO,QAAQ,0BAA0B,GAAG;AAC7E,QAAI,OAAO,UAAU,eAAe,KAAK,KAAK,SAAS,EAAG;AAC1D,eAAW,SAAS,SAAS;AAC3B,YAAM,QAAQ,IAAI,KAAK;AACvB,UAAI,UAAU,QAAW;AACvB,YAAI,SAAS,IAAI;AACjB;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACA,SAAO;AACT;AAEA,SAAS,qBAAqB,OAAwC;AACpE,MAAI,CAAC,SAAS,KAAK,EAAG,QAAO,CAAC;AAC9B,QAAM,OAA+B,CAAC;AACtC,aAAW,CAAC,QAAQ,KAAK,KAAK,OAAO,QAAQ,KAAK,GAAG;AACnD,UAAM,MAAM,yBAAyB,MAAM;AAC3C,QAAI,CAAC,IAAK;AACV,gBAAY,MAAM,KAAK,KAAK;AAAA,EAC9B;AACA,SAAO;AACT;AAEA,SAAS,YAAY,KAA6B,KAAa,OAAsB;AACnF,QAAM,WAAW,iBAAiB,KAAK;AACvC,MAAI,aAAa,QAAW;AAC1B,QAAI,GAAG,IAAI;AACX;AAAA,EACF;AACA,MAAI,CAAC,SAAS,KAAK,EAAG;AACtB,aAAW,CAAC,UAAU,UAAU,KAAK,OAAO,QAAQ,KAAK,GAAG;AAC1D,QAAI,CAAC,SAAU;AACf,gBAAY,KAAK,GAAG,GAAG,IAAI,QAAQ,IAAI,UAAU;AAAA,EACnD;AACF;AAEA,SAAS,yBAAyB,KAAqB;AACrD,MAAI,IAAI,WAAW,qBAAqB,EAAG,QAAO,IAAI,MAAM,sBAAsB,MAAM;AACxF,MAAI,IAAI,WAAW,oBAAoB,EAAG,QAAO,IAAI,MAAM,qBAAqB,MAAM;AACtF,SAAO;AACT;AAEA,SAAS,iBAAiB,OAAoC;AAC5D,MAAI,OAAO,UAAU,SAAU,QAAO;AACtC,MAAI,OAAO,UAAU,UAAW,QAAO,QAAQ,SAAS;AACxD,MAAI,OAAO,UAAU,YAAY,OAAO,SAAS,KAAK,EAAG,QAAO,OAAO,KAAK;AAC5E,SAAO;AACT;AAEA,SAAS,SAAS,OAAkD;AAClE,SAAO,OAAO,UAAU,YAAY,UAAU,QAAQ,CAAC,MAAM,QAAQ,KAAK;AAC5E;AAEA,SAAS,gBAAgB,KAA6D;AACpF,QAAM,QAAQ,oBAAI,IAAoB;AACtC,aAAW,CAAC,WAAW,OAAO,KAAK,OAAO,QAAQ,GAAG,GAAG;AACtD,eAAW,SAAS,QAAS,OAAM,IAAI,OAAO,SAAS;AAAA,EACzD;AACA,SAAO;AACT;;;ACzIO,IAAM,+BAA+B;AACrC,IAAM,+BAA+B;AAE5C,IAAM,qBAAqB,+BAA+B;AAEnD,IAAM,0BAA0B;AAgChC,SAAS,qBAAqB,SAAiD;AACpF,QAAM,WAAW,CAAC,GAAI,SAAS,YAAY,CAAC,CAAE;AAC9C,QAAM,OAAO,oBAAI,IAAoB;AACrC,WAAS,QAAQ,GAAG,QAAQ,SAAS,QAAQ,SAAS,GAAG;AACvD,UAAM,MAAM,SAAS,KAAK;AAC1B,QAAI,QAAQ,UAAa,CAAC,KAAK,IAAI,GAAG,EAAG,MAAK,IAAI,KAAK,KAAK;AAAA,EAC9D;AAEA,SAAO;AAAA,IACL,QAAQ,QAAQ;AACd,YAAM,MAAM,yBAAyB,MAAM;AAC3C,YAAM,UAAoB,CAAC;AAC3B,UAAI,UAAU,qBAAqB,GAAG;AACtC,aAAO,QAAQ,UAAU;AACvB,cAAM,SAAS,kBAAkB,KAAK,MAAM,SAAS,MAAM;AAC3D,YAAI,CAAC,OAAQ;AACb,eAAO,IAAI,MAAM;AACjB,gBAAQ,KAAK,MAAM;AACnB,kBAAU,qBAAqB,GAAG;AAAA,MACpC;AACA,aAAO;AAAA,QACL,GAAI,QAAQ,OAAO,EAAE,MAAM,QAAQ,KAAK,IAAI,CAAC;AAAA,QAC7C;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACF;AAGO,SAAS,oBAAoB,SAA6D;AAC/F,MAAI,CAAC,QAAQ,OAAQ,QAAO;AAC5B,SAAO;AAAA,IACL,MAAM;AAAA,IACN,SAAS,sDAAsD,QAAQ,KAAK,IAAI,CAAC;AAAA,IACjF,SAAS,EAAE,SAAS,CAAC,GAAG,OAAO,EAAE;AAAA,EACnC;AACF;AAeO,SAAS,gBACX,QACiC;AACpC,QAAM,UAAU,qBAAqB,yBAAyB,MAAM,CAAC;AACrE,MAAI,QAAQ,UAAU;AACpB,UAAM,IAAI;AAAA,MACR,mDAAmD,QAAQ,aAAa,sCAAsC,kBAAkB;AAAA,IAClI;AAAA,EACF;AACA,SAAO,QAAQ;AACjB;AAQO,SAAS,aAAa,MAAuC;AAClE,QAAM,SAAS,iBAAiB,IAAI;AACpC,MAAI,CAAC,OAAQ,QAAO,CAAC;AACrB,QAAM,QAAkB,CAAC;AACzB,WAAS,QAAQ,KAAK,SAAS,GAAG;AAChC,UAAM,QAAQ,OAAO,KAAK,KAAK,EAAE;AACjC,QAAI,OAAO,UAAU,SAAU;AAC/B,UAAM,KAAK,KAAK;AAAA,EAClB;AACA,MAAI,CAAC,MAAM,OAAQ,QAAO,CAAC;AAC3B,QAAM,SAAkB,KAAK,MAAM,OAAO,KAAK,MAAM,KAAK,EAAE,GAAG,QAAQ,EAAE,SAAS,MAAM,CAAC;AACzF,MAAI,CAACA,UAAS,MAAM,EAAG,QAAO,CAAC;AAC/B,QAAM,SAAiC,CAAC;AACxC,aAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ,MAAM,GAAG;AACjD,QAAI,OAAO,UAAU,SAAU,QAAO,GAAG,IAAI;AAAA,EAC/C;AACA,SAAO,kBAAkB,MAAM;AACjC;AAGA,SAAS,iBAAiB,MAAoD;AAC5E,MAAIA,UAAS,IAAI,EAAG,QAAO;AAC3B,MAAI,OAAO,SAAS,SAAU,QAAO;AACrC,MAAI;AACF,UAAM,SAAkB,KAAK,MAAM,IAAI;AACvC,WAAOA,UAAS,MAAM,IAAI,SAAS;AAAA,EACrC,QAAQ;AACN,WAAO;AAAA,EACT;AACF;AAEA,SAAS,qBAAqB,KAI5B;AACA,QAAM,OAAO,OAAO,KAAK,GAAG,EAAE,KAAK;AACnC,MAAI,CAAC,KAAK,OAAQ,QAAO,EAAE,eAAe,GAAG,UAAU,MAAM;AAC7D,QAAM,UAAkC,CAAC;AACzC,aAAW,OAAO,MAAM;AACtB,UAAM,QAAQ,IAAI,GAAG;AACrB,QAAI,UAAU,OAAW,SAAQ,GAAG,IAAI;AAAA,EAC1C;AACA,QAAM,UAAU,OAAO,KAAK,KAAK,UAAU,OAAO,GAAG,MAAM,EAAE,SAAS,QAAQ;AAC9E,MAAI,KAAK,KAAK,QAAQ,SAAS,4BAA4B,IAAI,8BAA8B;AAC3F,WAAO,EAAE,eAAe,QAAQ,QAAQ,UAAU,KAAK;AAAA,EACzD;AACA,QAAM,OAA+B,CAAC;AACtC,WAAS,QAAQ,GAAG,QAAQ,KAAK,KAAK,QAAQ,SAAS,4BAA4B,GAAG,SAAS,GAAG;AAChG,SAAK,KAAK,KAAK,EAAE,IAAI,QAAQ;AAAA,MAC3B,QAAQ;AAAA,OACP,QAAQ,KAAK;AAAA,IAChB;AAAA,EACF;AACA,SAAO,EAAE,MAAM,eAAe,QAAQ,QAAQ,UAAU,MAAM;AAChE;AAEA,SAAS,kBACP,KACA,MACA,cACoB;AACpB,MAAI;AACJ,MAAI,aAAa;AACjB,MAAI,aAAa;AACjB,aAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ,GAAG,GAAG;AAC9C,UAAM,UAAU,KAAK,IAAI,GAAG,KAAK;AACjC,UAAM,OAAO,MAAM;AACnB,UAAM,gBAAgB,WAAW,UAC5B,UAAU,cACT,YAAY,cAAc,OAAO,cACjC,YAAY,cAAc,SAAS,cAAc,MAAM;AAC7D,QAAI,eAAe;AACjB,eAAS;AACT,mBAAa;AACb,mBAAa;AAAA,IACf;AAAA,EACF;AACA,SAAO;AACT;AAEA,SAASA,UAAS,OAAkD;AAClE,SAAO,OAAO,UAAU,YAAY,UAAU,QAAQ,CAAC,MAAM,QAAQ,KAAK;AAC5E;","names":["isRecord"]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@x12i/provider-metadata",
3
- "version": "1.2.0",
3
+ "version": "1.2.1",
4
4
  "description": "Pack, open, and normalize one provider metadata record. The same wire object for every provider.",
5
5
  "type": "module",
6
6
  "main": "./dist/index.cjs",