@x12i/provider-metadata 1.1.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
@@ -4,6 +4,8 @@ Pack and open one metadata record. The keys are whatever the caller stored.
4
4
 
5
5
  `packMetadata` writes the same object for every provider. `openMetadata` reads that object back. A reader passes the log object and gets every stored pair, for any provider and any set of keys.
6
6
 
7
+ Repeating concepts are normalized to one canonical key. Vendor prefixes may stay (`openrouter.api_key_name`), and the shared key is always available (`api_key_name`). Grow `METADATA_NORMALIZATION_MAP` as more aliases appear.
8
+
7
9
  The package runs on Node 20 or newer and publishes ESM and CommonJS from the same entry.
8
10
 
9
11
  ## Install
@@ -30,6 +32,27 @@ const record = openMetadata(wire);
30
32
 
31
33
  `record` is the full string map. Another caller map, with different keys, packs and opens the same way.
32
34
 
35
+ ## Normalization
36
+
37
+ Use `normalizeMetadata` on provider logs, OTLP attribute bags, or nested vendor objects. Known aliases are promoted to canonical keys. The vendor key remains when it was present.
38
+
39
+ ```ts
40
+ import { METADATA_NORMALIZATION_MAP, normalizeMetadata } from "@x12i/provider-metadata";
41
+
42
+ const record = normalizeMetadata({
43
+ "trace.metadata.openrouter.api_key_name": "prod-key",
44
+ "trace.metadata.tenant": "acme"
45
+ });
46
+ // { api_key_name: "prod-key", "openrouter.api_key_name": "prod-key", tenant: "acme" }
47
+
48
+ record.api_key_name;
49
+ METADATA_NORMALIZATION_MAP.api_key_name; // ["openrouter.api_key_name", ...]
50
+ ```
51
+
52
+ `packMetadata` and `openMetadata` apply the same map. Nested objects under known provider namespaces (for example `openrouter`) are flattened onto the wire. Other nested objects stay off the wire.
53
+
54
+ Current canonical keys include `api_key_name`, `provider_slug`, `provider_name`, `entity_id`, `user_id`, `finish_reason`, `input_unit_price`, `output_unit_price`, `source`, and `session_id`.
55
+
33
56
  ## Automatic trim
34
57
 
35
58
  Writers create one packer at initialization. `pack` keeps the record inside 4096 base64 characters. It drops the lowest-priority pair, then the next, and reports every key it removed.
@@ -60,7 +83,7 @@ const record = openMetadata(packed.wire);
60
83
 
61
84
  `packMetadata` does not drop keys. A record that does not fit throws `METADATA_RECORD_TOO_LARGE`.
62
85
 
63
- `packMetadata(...layers)` accepts `Record<string, unknown> | undefined`. Later layers win on the same key. String, number, and boolean values are stored. A number becomes its decimal string, and a boolean becomes `"true"` or `"false"`. Objects and arrays are omitted. When a later value is an object or array, the earlier scalar for that key stays. An empty result is `undefined`.
86
+ `packMetadata(...layers)` accepts `Record<string, unknown> | undefined`. Later layers win on the same key. String, number, and boolean values are stored. A number becomes its decimal string, and a boolean becomes `"true"` or `"false"`. Nested objects under known provider namespaces are flattened and normalized. Other objects and arrays are omitted. When a later value is an object or array for a non-provider key, the earlier scalar for that key stays. An empty result is `undefined`.
64
87
 
65
88
  ## Wire object
66
89
 
@@ -73,7 +96,7 @@ The stored value is UTF-8 JSON of the string map, with keys sorted, then base64.
73
96
 
74
97
  The limit is 4096 base64 characters. `createMetadataPacker` drops pairs until the record fits. `packMetadata` throws `METADATA_RECORD_TOO_LARGE` instead.
75
98
 
76
- `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 `{}`.
77
100
 
78
101
  These provider slots hold that same object:
79
102
 
@@ -82,6 +105,6 @@ These provider slots hold that same object:
82
105
  | OpenRouter | Body `metadata` |
83
106
  | OpenAI | Responses body `metadata` |
84
107
  | Bedrock | `requestMetadata` |
85
- | Cloudflare | Body `metadata` and the `cf-aig-metadata` header |
108
+ | Cloudflare | Body `metadata` and the `cf-aig-metadata` header (JSON string) |
86
109
 
87
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
@@ -20,15 +20,125 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
20
20
  // src/index.ts
21
21
  var index_exports = {};
22
22
  __export(index_exports, {
23
+ METADATA_NORMALIZATION_MAP: () => METADATA_NORMALIZATION_MAP,
23
24
  METADATA_RECORD_TRIMMED: () => METADATA_RECORD_TRIMMED,
24
25
  PROVIDER_METADATA_CHUNK_SIZE: () => PROVIDER_METADATA_CHUNK_SIZE,
25
26
  PROVIDER_METADATA_MAX_CHUNKS: () => PROVIDER_METADATA_MAX_CHUNKS,
27
+ canonicalMetadataKey: () => canonicalMetadataKey,
26
28
  createMetadataPacker: () => createMetadataPacker,
27
29
  metadataTrimWarning: () => metadataTrimWarning,
30
+ normalizeMetadata: () => normalizeMetadata,
28
31
  openMetadata: () => openMetadata,
29
32
  packMetadata: () => packMetadata
30
33
  });
31
34
  module.exports = __toCommonJS(index_exports);
35
+
36
+ // src/normalize.ts
37
+ var METADATA_NORMALIZATION_MAP = {
38
+ api_key_name: ["openrouter.api_key_name"],
39
+ provider_slug: ["openrouter.provider_slug"],
40
+ provider_name: ["openrouter.provider_name", "gen_ai.provider.name"],
41
+ entity_id: ["openrouter.entity_id"],
42
+ user_id: ["openrouter.user_id", "user.id", "cf.user_id"],
43
+ finish_reason: ["openrouter.finish_reason", "gen_ai.response.finish_reason"],
44
+ input_unit_price: ["openrouter.input_unit_price"],
45
+ output_unit_price: ["openrouter.output_unit_price"],
46
+ source: ["openrouter.source"],
47
+ session_id: ["session.id"]
48
+ };
49
+ var TRACE_METADATA_PREFIX = "trace.metadata.";
50
+ var SPAN_METADATA_PREFIX = "span.metadata.";
51
+ var ALIAS_TO_CANONICAL = buildAliasIndex(METADATA_NORMALIZATION_MAP);
52
+ var KNOWN_PROVIDER_NAMESPACES = new Set(
53
+ Object.values(METADATA_NORMALIZATION_MAP).flatMap(
54
+ (aliases) => aliases.map((alias) => alias.split(".")[0]).filter((part) => Boolean(part))
55
+ )
56
+ );
57
+ function normalizeMetadata(input) {
58
+ return promoteCanonicalKeys(flattenMetadataInput(input));
59
+ }
60
+ function collectNormalizedStrings(layers) {
61
+ const map = {};
62
+ for (const layer of layers) {
63
+ if (!layer) continue;
64
+ for (const [key, value] of Object.entries(layer)) {
65
+ const asString = asMetadataString(value);
66
+ if (asString !== void 0) {
67
+ map[key] = asString;
68
+ continue;
69
+ }
70
+ if (!isRecord(value) || !KNOWN_PROVIDER_NAMESPACES.has(key)) continue;
71
+ for (const [childKey, childValue] of Object.entries(value)) {
72
+ if (!childKey) continue;
73
+ const childString = asMetadataString(childValue);
74
+ if (childString !== void 0) map[`${key}.${childKey}`] = childString;
75
+ }
76
+ }
77
+ }
78
+ return promoteCanonicalKeys(map);
79
+ }
80
+ function canonicalMetadataKey(key) {
81
+ return ALIAS_TO_CANONICAL.get(key) ?? key;
82
+ }
83
+ function promoteCanonicalKeys(flat) {
84
+ const out = { ...flat };
85
+ for (const [canonical, aliases] of Object.entries(METADATA_NORMALIZATION_MAP)) {
86
+ if (Object.prototype.hasOwnProperty.call(out, canonical)) continue;
87
+ for (const alias of aliases) {
88
+ const value = out[alias];
89
+ if (value !== void 0) {
90
+ out[canonical] = value;
91
+ break;
92
+ }
93
+ }
94
+ }
95
+ return out;
96
+ }
97
+ function flattenMetadataInput(input) {
98
+ if (!isRecord(input)) return {};
99
+ const flat = {};
100
+ for (const [rawKey, value] of Object.entries(input)) {
101
+ const key = stripObservabilityPrefix(rawKey);
102
+ if (!key) continue;
103
+ collectFlat(flat, key, value);
104
+ }
105
+ return flat;
106
+ }
107
+ function collectFlat(out, key, value) {
108
+ const asString = asMetadataString(value);
109
+ if (asString !== void 0) {
110
+ out[key] = asString;
111
+ return;
112
+ }
113
+ if (!isRecord(value)) return;
114
+ for (const [childKey, childValue] of Object.entries(value)) {
115
+ if (!childKey) continue;
116
+ collectFlat(out, `${key}.${childKey}`, childValue);
117
+ }
118
+ }
119
+ function stripObservabilityPrefix(key) {
120
+ if (key.startsWith(TRACE_METADATA_PREFIX)) return key.slice(TRACE_METADATA_PREFIX.length);
121
+ if (key.startsWith(SPAN_METADATA_PREFIX)) return key.slice(SPAN_METADATA_PREFIX.length);
122
+ return key;
123
+ }
124
+ function asMetadataString(value) {
125
+ if (typeof value === "string") return value;
126
+ if (typeof value === "boolean") return value ? "true" : "false";
127
+ if (typeof value === "number" && Number.isFinite(value)) return String(value);
128
+ return void 0;
129
+ }
130
+ function isRecord(value) {
131
+ return typeof value === "object" && value !== null && !Array.isArray(value);
132
+ }
133
+ function buildAliasIndex(map) {
134
+ const index = /* @__PURE__ */ new Map();
135
+ for (const [canonical, aliases] of Object.entries(map)) {
136
+ for (const alias of aliases) index.set(alias, canonical);
137
+ }
138
+ return index;
139
+ }
140
+
141
+ // src/index.ts
32
142
  var PROVIDER_METADATA_CHUNK_SIZE = 256;
33
143
  var PROVIDER_METADATA_MAX_CHUNKS = 16;
34
144
  var MAX_ENCODED_LENGTH = PROVIDER_METADATA_CHUNK_SIZE * PROVIDER_METADATA_MAX_CHUNKS;
@@ -42,7 +152,7 @@ function createMetadataPacker(options) {
42
152
  }
43
153
  return {
44
154
  pack(...layers) {
45
- const map = collectStrings(layers);
155
+ const map = collectNormalizedStrings(layers);
46
156
  const dropped = [];
47
157
  let encoded = encodeProviderRecord(map);
48
158
  while (encoded.tooLarge) {
@@ -68,7 +178,7 @@ function metadataTrimWarning(dropped) {
68
178
  };
69
179
  }
70
180
  function packMetadata(...layers) {
71
- const encoded = encodeProviderRecord(collectStrings(layers));
181
+ const encoded = encodeProviderRecord(collectNormalizedStrings(layers));
72
182
  if (encoded.tooLarge) {
73
183
  throw new Error(
74
184
  `METADATA_RECORD_TOO_LARGE: provider metadata is ${encoded.encodedLength} base64 characters; the maximum is ${MAX_ENCODED_LENGTH}.`
@@ -77,32 +187,32 @@ function packMetadata(...layers) {
77
187
  return encoded.wire;
78
188
  }
79
189
  function openMetadata(wire) {
80
- if (!isRecord(wire)) return {};
190
+ const object = coerceWireObject(wire);
191
+ if (!object) return {};
81
192
  const parts = [];
82
193
  for (let index = 0; ; index += 1) {
83
- const chunk = wire[`m.${index}`];
194
+ const chunk = object[`m.${index}`];
84
195
  if (typeof chunk !== "string") break;
85
196
  parts.push(chunk);
86
197
  }
87
198
  if (!parts.length) return {};
88
199
  const parsed = JSON.parse(Buffer.from(parts.join(""), "base64").toString("utf8"));
89
- if (!isRecord(parsed)) return {};
200
+ if (!isRecord2(parsed)) return {};
90
201
  const record = {};
91
202
  for (const [key, value] of Object.entries(parsed)) {
92
203
  if (typeof value === "string") record[key] = value;
93
204
  }
94
- return record;
205
+ return normalizeMetadata(record);
95
206
  }
96
- function collectStrings(layers) {
97
- const map = {};
98
- for (const layer of layers) {
99
- if (!layer) continue;
100
- for (const [key, value] of Object.entries(layer)) {
101
- const asString = asMetadataString(value);
102
- if (asString !== void 0) map[key] = asString;
103
- }
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;
104
215
  }
105
- return map;
106
216
  }
107
217
  function encodeProviderRecord(map) {
108
218
  const keys = Object.keys(map).sort();
@@ -141,22 +251,19 @@ function leastImportantKey(map, rank, unlistedRank) {
141
251
  }
142
252
  return chosen;
143
253
  }
144
- function asMetadataString(value) {
145
- if (typeof value === "string") return value;
146
- if (typeof value === "boolean") return value ? "true" : "false";
147
- if (typeof value === "number" && Number.isFinite(value)) return String(value);
148
- return void 0;
149
- }
150
- function isRecord(value) {
254
+ function isRecord2(value) {
151
255
  return typeof value === "object" && value !== null && !Array.isArray(value);
152
256
  }
153
257
  // Annotate the CommonJS export names for ESM import in node:
154
258
  0 && (module.exports = {
259
+ METADATA_NORMALIZATION_MAP,
155
260
  METADATA_RECORD_TRIMMED,
156
261
  PROVIDER_METADATA_CHUNK_SIZE,
157
262
  PROVIDER_METADATA_MAX_CHUNKS,
263
+ canonicalMetadataKey,
158
264
  createMetadataPacker,
159
265
  metadataTrimWarning,
266
+ normalizeMetadata,
160
267
  openMetadata,
161
268
  packMetadata
162
269
  });
@@ -1 +1 @@
1
- {"version":3,"sources":["../src/index.ts"],"sourcesContent":["export 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 = collectStrings(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. Objects and arrays are omitted.\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(collectStrings(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. 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 record;\r\n}\r\n\r\nfunction collectStrings(layers: Array<Record<string, unknown> | undefined>): 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) map[key] = asString;\r\n }\r\n }\r\n return map;\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 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"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAO,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,eAAe,MAAM;AACjC,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;AAWO,SAAS,gBACX,QACiC;AACpC,QAAM,UAAU,qBAAqB,eAAe,MAAM,CAAC;AAC3D,MAAI,QAAQ,UAAU;AACpB,UAAM,IAAI;AAAA,MACR,mDAAmD,QAAQ,aAAa,sCAAsC,kBAAkB;AAAA,IAClI;AAAA,EACF;AACA,SAAO,QAAQ;AACjB;AAMO,SAAS,aAAa,MAAuC;AAClE,MAAI,CAAC,SAAS,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,CAAC,SAAS,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;AACT;AAEA,SAAS,eAAe,QAA4E;AAClG,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,OAAW,KAAI,GAAG,IAAI;AAAA,IACzC;AAAA,EACF;AACA,SAAO;AACT;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,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;","names":[]}
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
@@ -1,3 +1,40 @@
1
+ /**
2
+ * Canonical metadata keys shared across providers.
3
+ * Each entry lists known provider-namespaced aliases that mean the same thing.
4
+ * Prefer the canonical key when reading or writing. Provider aliases may remain.
5
+ *
6
+ * Grow this map as repeating fields appear under a vendor prefix
7
+ * (for example `openrouter.api_key_name` → `api_key_name`).
8
+ */
9
+ declare const METADATA_NORMALIZATION_MAP: {
10
+ readonly api_key_name: readonly ["openrouter.api_key_name"];
11
+ readonly provider_slug: readonly ["openrouter.provider_slug"];
12
+ readonly provider_name: readonly ["openrouter.provider_name", "gen_ai.provider.name"];
13
+ readonly entity_id: readonly ["openrouter.entity_id"];
14
+ readonly user_id: readonly ["openrouter.user_id", "user.id", "cf.user_id"];
15
+ readonly finish_reason: readonly ["openrouter.finish_reason", "gen_ai.response.finish_reason"];
16
+ readonly input_unit_price: readonly ["openrouter.input_unit_price"];
17
+ readonly output_unit_price: readonly ["openrouter.output_unit_price"];
18
+ readonly source: readonly ["openrouter.source"];
19
+ readonly session_id: readonly ["session.id"];
20
+ };
21
+ type NormalizedMetadataKey = keyof typeof METADATA_NORMALIZATION_MAP;
22
+ /**
23
+ * Flattens a metadata bag and promotes known provider aliases to canonical keys.
24
+ *
25
+ * Accepts:
26
+ * - flat string maps (`{ api_key_name: "prod" }`)
27
+ * - dotted provider keys (`{ "openrouter.api_key_name": "prod" }`)
28
+ * - nested provider objects (`{ openrouter: { api_key_name: "prod" } }`)
29
+ * - OTLP attribute bags (`{ "trace.metadata.openrouter.api_key_name": "prod" }`)
30
+ *
31
+ * Provider-namespaced keys stay when present. Canonical keys are added when an
32
+ * alias is known and the canonical key is missing. An explicit canonical value wins.
33
+ */
34
+ declare function normalizeMetadata(input: unknown): Record<string, string>;
35
+ /** Returns the canonical key for a known alias, or the key itself. */
36
+ declare function canonicalMetadataKey(key: string): string;
37
+
1
38
  declare const PROVIDER_METADATA_CHUNK_SIZE = 256;
2
39
  declare const PROVIDER_METADATA_MAX_CHUNKS = 16;
3
40
  declare const METADATA_RECORD_TRIMMED = "METADATA_RECORD_TRIMMED";
@@ -35,7 +72,11 @@ declare function metadataTrimWarning(dropped: readonly string[]): MetadataTrimWa
35
72
  /**
36
73
  * Packs caller maps into one provider metadata object.
37
74
  * Later layers win on the same key. String, number, and boolean values are stored.
38
- * Numbers and booleans are stored as their string form. Objects and arrays are omitted.
75
+ * Numbers and booleans are stored as their string form.
76
+ * Nested objects under known provider namespaces (for example `openrouter`) are
77
+ * flattened, and known aliases are promoted to canonical keys
78
+ * (`openrouter.api_key_name` also becomes `api_key_name`). Other objects and
79
+ * arrays are omitted from the wire record.
39
80
  * An empty result is `undefined`.
40
81
  * A record over the size limit throws `METADATA_RECORD_TOO_LARGE`.
41
82
  * Writers that should drop pairs instead use `createMetadataPacker`.
@@ -44,8 +85,10 @@ declare function metadataTrimWarning(dropped: readonly string[]): MetadataTrimWa
44
85
  declare function packMetadata(...layers: Array<Record<string, unknown> | undefined>): Record<string, string> | undefined;
45
86
  /**
46
87
  * Opens the `m.0`, `m.1`, ... object from a provider log.
47
- * Returns every stored pair. A missing record returns `{}`.
88
+ * Accepts the wire object or its JSON string (for example Cloudflare `cf-aig-metadata`).
89
+ * Returns every stored pair with known aliases promoted to canonical keys.
90
+ * A missing or unreadable record returns `{}`.
48
91
  */
49
92
  declare function openMetadata(wire: unknown): Record<string, string>;
50
93
 
51
- export { METADATA_RECORD_TRIMMED, type MetadataPacker, type MetadataPackerOptions, type MetadataTrimWarning, PROVIDER_METADATA_CHUNK_SIZE, PROVIDER_METADATA_MAX_CHUNKS, type PackedMetadata, createMetadataPacker, metadataTrimWarning, openMetadata, packMetadata };
94
+ export { METADATA_NORMALIZATION_MAP, METADATA_RECORD_TRIMMED, type MetadataPacker, type MetadataPackerOptions, type MetadataTrimWarning, type NormalizedMetadataKey, PROVIDER_METADATA_CHUNK_SIZE, PROVIDER_METADATA_MAX_CHUNKS, type PackedMetadata, canonicalMetadataKey, createMetadataPacker, metadataTrimWarning, normalizeMetadata, openMetadata, packMetadata };
package/dist/index.d.ts CHANGED
@@ -1,3 +1,40 @@
1
+ /**
2
+ * Canonical metadata keys shared across providers.
3
+ * Each entry lists known provider-namespaced aliases that mean the same thing.
4
+ * Prefer the canonical key when reading or writing. Provider aliases may remain.
5
+ *
6
+ * Grow this map as repeating fields appear under a vendor prefix
7
+ * (for example `openrouter.api_key_name` → `api_key_name`).
8
+ */
9
+ declare const METADATA_NORMALIZATION_MAP: {
10
+ readonly api_key_name: readonly ["openrouter.api_key_name"];
11
+ readonly provider_slug: readonly ["openrouter.provider_slug"];
12
+ readonly provider_name: readonly ["openrouter.provider_name", "gen_ai.provider.name"];
13
+ readonly entity_id: readonly ["openrouter.entity_id"];
14
+ readonly user_id: readonly ["openrouter.user_id", "user.id", "cf.user_id"];
15
+ readonly finish_reason: readonly ["openrouter.finish_reason", "gen_ai.response.finish_reason"];
16
+ readonly input_unit_price: readonly ["openrouter.input_unit_price"];
17
+ readonly output_unit_price: readonly ["openrouter.output_unit_price"];
18
+ readonly source: readonly ["openrouter.source"];
19
+ readonly session_id: readonly ["session.id"];
20
+ };
21
+ type NormalizedMetadataKey = keyof typeof METADATA_NORMALIZATION_MAP;
22
+ /**
23
+ * Flattens a metadata bag and promotes known provider aliases to canonical keys.
24
+ *
25
+ * Accepts:
26
+ * - flat string maps (`{ api_key_name: "prod" }`)
27
+ * - dotted provider keys (`{ "openrouter.api_key_name": "prod" }`)
28
+ * - nested provider objects (`{ openrouter: { api_key_name: "prod" } }`)
29
+ * - OTLP attribute bags (`{ "trace.metadata.openrouter.api_key_name": "prod" }`)
30
+ *
31
+ * Provider-namespaced keys stay when present. Canonical keys are added when an
32
+ * alias is known and the canonical key is missing. An explicit canonical value wins.
33
+ */
34
+ declare function normalizeMetadata(input: unknown): Record<string, string>;
35
+ /** Returns the canonical key for a known alias, or the key itself. */
36
+ declare function canonicalMetadataKey(key: string): string;
37
+
1
38
  declare const PROVIDER_METADATA_CHUNK_SIZE = 256;
2
39
  declare const PROVIDER_METADATA_MAX_CHUNKS = 16;
3
40
  declare const METADATA_RECORD_TRIMMED = "METADATA_RECORD_TRIMMED";
@@ -35,7 +72,11 @@ declare function metadataTrimWarning(dropped: readonly string[]): MetadataTrimWa
35
72
  /**
36
73
  * Packs caller maps into one provider metadata object.
37
74
  * Later layers win on the same key. String, number, and boolean values are stored.
38
- * Numbers and booleans are stored as their string form. Objects and arrays are omitted.
75
+ * Numbers and booleans are stored as their string form.
76
+ * Nested objects under known provider namespaces (for example `openrouter`) are
77
+ * flattened, and known aliases are promoted to canonical keys
78
+ * (`openrouter.api_key_name` also becomes `api_key_name`). Other objects and
79
+ * arrays are omitted from the wire record.
39
80
  * An empty result is `undefined`.
40
81
  * A record over the size limit throws `METADATA_RECORD_TOO_LARGE`.
41
82
  * Writers that should drop pairs instead use `createMetadataPacker`.
@@ -44,8 +85,10 @@ declare function metadataTrimWarning(dropped: readonly string[]): MetadataTrimWa
44
85
  declare function packMetadata(...layers: Array<Record<string, unknown> | undefined>): Record<string, string> | undefined;
45
86
  /**
46
87
  * Opens the `m.0`, `m.1`, ... object from a provider log.
47
- * Returns every stored pair. A missing record returns `{}`.
88
+ * Accepts the wire object or its JSON string (for example Cloudflare `cf-aig-metadata`).
89
+ * Returns every stored pair with known aliases promoted to canonical keys.
90
+ * A missing or unreadable record returns `{}`.
48
91
  */
49
92
  declare function openMetadata(wire: unknown): Record<string, string>;
50
93
 
51
- export { METADATA_RECORD_TRIMMED, type MetadataPacker, type MetadataPackerOptions, type MetadataTrimWarning, PROVIDER_METADATA_CHUNK_SIZE, PROVIDER_METADATA_MAX_CHUNKS, type PackedMetadata, createMetadataPacker, metadataTrimWarning, openMetadata, packMetadata };
94
+ export { METADATA_NORMALIZATION_MAP, METADATA_RECORD_TRIMMED, type MetadataPacker, type MetadataPackerOptions, type MetadataTrimWarning, type NormalizedMetadataKey, PROVIDER_METADATA_CHUNK_SIZE, PROVIDER_METADATA_MAX_CHUNKS, type PackedMetadata, canonicalMetadataKey, createMetadataPacker, metadataTrimWarning, normalizeMetadata, openMetadata, packMetadata };
package/dist/index.js CHANGED
@@ -1,3 +1,108 @@
1
+ // src/normalize.ts
2
+ var METADATA_NORMALIZATION_MAP = {
3
+ api_key_name: ["openrouter.api_key_name"],
4
+ provider_slug: ["openrouter.provider_slug"],
5
+ provider_name: ["openrouter.provider_name", "gen_ai.provider.name"],
6
+ entity_id: ["openrouter.entity_id"],
7
+ user_id: ["openrouter.user_id", "user.id", "cf.user_id"],
8
+ finish_reason: ["openrouter.finish_reason", "gen_ai.response.finish_reason"],
9
+ input_unit_price: ["openrouter.input_unit_price"],
10
+ output_unit_price: ["openrouter.output_unit_price"],
11
+ source: ["openrouter.source"],
12
+ session_id: ["session.id"]
13
+ };
14
+ var TRACE_METADATA_PREFIX = "trace.metadata.";
15
+ var SPAN_METADATA_PREFIX = "span.metadata.";
16
+ var ALIAS_TO_CANONICAL = buildAliasIndex(METADATA_NORMALIZATION_MAP);
17
+ var KNOWN_PROVIDER_NAMESPACES = new Set(
18
+ Object.values(METADATA_NORMALIZATION_MAP).flatMap(
19
+ (aliases) => aliases.map((alias) => alias.split(".")[0]).filter((part) => Boolean(part))
20
+ )
21
+ );
22
+ function normalizeMetadata(input) {
23
+ return promoteCanonicalKeys(flattenMetadataInput(input));
24
+ }
25
+ function collectNormalizedStrings(layers) {
26
+ const map = {};
27
+ for (const layer of layers) {
28
+ if (!layer) continue;
29
+ for (const [key, value] of Object.entries(layer)) {
30
+ const asString = asMetadataString(value);
31
+ if (asString !== void 0) {
32
+ map[key] = asString;
33
+ continue;
34
+ }
35
+ if (!isRecord(value) || !KNOWN_PROVIDER_NAMESPACES.has(key)) continue;
36
+ for (const [childKey, childValue] of Object.entries(value)) {
37
+ if (!childKey) continue;
38
+ const childString = asMetadataString(childValue);
39
+ if (childString !== void 0) map[`${key}.${childKey}`] = childString;
40
+ }
41
+ }
42
+ }
43
+ return promoteCanonicalKeys(map);
44
+ }
45
+ function canonicalMetadataKey(key) {
46
+ return ALIAS_TO_CANONICAL.get(key) ?? key;
47
+ }
48
+ function promoteCanonicalKeys(flat) {
49
+ const out = { ...flat };
50
+ for (const [canonical, aliases] of Object.entries(METADATA_NORMALIZATION_MAP)) {
51
+ if (Object.prototype.hasOwnProperty.call(out, canonical)) continue;
52
+ for (const alias of aliases) {
53
+ const value = out[alias];
54
+ if (value !== void 0) {
55
+ out[canonical] = value;
56
+ break;
57
+ }
58
+ }
59
+ }
60
+ return out;
61
+ }
62
+ function flattenMetadataInput(input) {
63
+ if (!isRecord(input)) return {};
64
+ const flat = {};
65
+ for (const [rawKey, value] of Object.entries(input)) {
66
+ const key = stripObservabilityPrefix(rawKey);
67
+ if (!key) continue;
68
+ collectFlat(flat, key, value);
69
+ }
70
+ return flat;
71
+ }
72
+ function collectFlat(out, key, value) {
73
+ const asString = asMetadataString(value);
74
+ if (asString !== void 0) {
75
+ out[key] = asString;
76
+ return;
77
+ }
78
+ if (!isRecord(value)) return;
79
+ for (const [childKey, childValue] of Object.entries(value)) {
80
+ if (!childKey) continue;
81
+ collectFlat(out, `${key}.${childKey}`, childValue);
82
+ }
83
+ }
84
+ function stripObservabilityPrefix(key) {
85
+ if (key.startsWith(TRACE_METADATA_PREFIX)) return key.slice(TRACE_METADATA_PREFIX.length);
86
+ if (key.startsWith(SPAN_METADATA_PREFIX)) return key.slice(SPAN_METADATA_PREFIX.length);
87
+ return key;
88
+ }
89
+ function asMetadataString(value) {
90
+ if (typeof value === "string") return value;
91
+ if (typeof value === "boolean") return value ? "true" : "false";
92
+ if (typeof value === "number" && Number.isFinite(value)) return String(value);
93
+ return void 0;
94
+ }
95
+ function isRecord(value) {
96
+ return typeof value === "object" && value !== null && !Array.isArray(value);
97
+ }
98
+ function buildAliasIndex(map) {
99
+ const index = /* @__PURE__ */ new Map();
100
+ for (const [canonical, aliases] of Object.entries(map)) {
101
+ for (const alias of aliases) index.set(alias, canonical);
102
+ }
103
+ return index;
104
+ }
105
+
1
106
  // src/index.ts
2
107
  var PROVIDER_METADATA_CHUNK_SIZE = 256;
3
108
  var PROVIDER_METADATA_MAX_CHUNKS = 16;
@@ -12,7 +117,7 @@ function createMetadataPacker(options) {
12
117
  }
13
118
  return {
14
119
  pack(...layers) {
15
- const map = collectStrings(layers);
120
+ const map = collectNormalizedStrings(layers);
16
121
  const dropped = [];
17
122
  let encoded = encodeProviderRecord(map);
18
123
  while (encoded.tooLarge) {
@@ -38,7 +143,7 @@ function metadataTrimWarning(dropped) {
38
143
  };
39
144
  }
40
145
  function packMetadata(...layers) {
41
- const encoded = encodeProviderRecord(collectStrings(layers));
146
+ const encoded = encodeProviderRecord(collectNormalizedStrings(layers));
42
147
  if (encoded.tooLarge) {
43
148
  throw new Error(
44
149
  `METADATA_RECORD_TOO_LARGE: provider metadata is ${encoded.encodedLength} base64 characters; the maximum is ${MAX_ENCODED_LENGTH}.`
@@ -47,32 +152,32 @@ function packMetadata(...layers) {
47
152
  return encoded.wire;
48
153
  }
49
154
  function openMetadata(wire) {
50
- if (!isRecord(wire)) return {};
155
+ const object = coerceWireObject(wire);
156
+ if (!object) return {};
51
157
  const parts = [];
52
158
  for (let index = 0; ; index += 1) {
53
- const chunk = wire[`m.${index}`];
159
+ const chunk = object[`m.${index}`];
54
160
  if (typeof chunk !== "string") break;
55
161
  parts.push(chunk);
56
162
  }
57
163
  if (!parts.length) return {};
58
164
  const parsed = JSON.parse(Buffer.from(parts.join(""), "base64").toString("utf8"));
59
- if (!isRecord(parsed)) return {};
165
+ if (!isRecord2(parsed)) return {};
60
166
  const record = {};
61
167
  for (const [key, value] of Object.entries(parsed)) {
62
168
  if (typeof value === "string") record[key] = value;
63
169
  }
64
- return record;
170
+ return normalizeMetadata(record);
65
171
  }
66
- function collectStrings(layers) {
67
- const map = {};
68
- for (const layer of layers) {
69
- if (!layer) continue;
70
- for (const [key, value] of Object.entries(layer)) {
71
- const asString = asMetadataString(value);
72
- if (asString !== void 0) map[key] = asString;
73
- }
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;
74
180
  }
75
- return map;
76
181
  }
77
182
  function encodeProviderRecord(map) {
78
183
  const keys = Object.keys(map).sort();
@@ -111,21 +216,18 @@ function leastImportantKey(map, rank, unlistedRank) {
111
216
  }
112
217
  return chosen;
113
218
  }
114
- function asMetadataString(value) {
115
- if (typeof value === "string") return value;
116
- if (typeof value === "boolean") return value ? "true" : "false";
117
- if (typeof value === "number" && Number.isFinite(value)) return String(value);
118
- return void 0;
119
- }
120
- function isRecord(value) {
219
+ function isRecord2(value) {
121
220
  return typeof value === "object" && value !== null && !Array.isArray(value);
122
221
  }
123
222
  export {
223
+ METADATA_NORMALIZATION_MAP,
124
224
  METADATA_RECORD_TRIMMED,
125
225
  PROVIDER_METADATA_CHUNK_SIZE,
126
226
  PROVIDER_METADATA_MAX_CHUNKS,
227
+ canonicalMetadataKey,
127
228
  createMetadataPacker,
128
229
  metadataTrimWarning,
230
+ normalizeMetadata,
129
231
  openMetadata,
130
232
  packMetadata
131
233
  };
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"sources":["../src/index.ts"],"sourcesContent":["export 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 = collectStrings(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. Objects and arrays are omitted.\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(collectStrings(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. 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 record;\r\n}\r\n\r\nfunction collectStrings(layers: Array<Record<string, unknown> | undefined>): 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) map[key] = asString;\r\n }\r\n }\r\n return map;\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 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"],"mappings":";AAAO,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,eAAe,MAAM;AACjC,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;AAWO,SAAS,gBACX,QACiC;AACpC,QAAM,UAAU,qBAAqB,eAAe,MAAM,CAAC;AAC3D,MAAI,QAAQ,UAAU;AACpB,UAAM,IAAI;AAAA,MACR,mDAAmD,QAAQ,aAAa,sCAAsC,kBAAkB;AAAA,IAClI;AAAA,EACF;AACA,SAAO,QAAQ;AACjB;AAMO,SAAS,aAAa,MAAuC;AAClE,MAAI,CAAC,SAAS,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,CAAC,SAAS,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;AACT;AAEA,SAAS,eAAe,QAA4E;AAClG,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,OAAW,KAAI,GAAG,IAAI;AAAA,IACzC;AAAA,EACF;AACA,SAAO;AACT;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,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;","names":[]}
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,7 +1,7 @@
1
1
  {
2
2
  "name": "@x12i/provider-metadata",
3
- "version": "1.1.0",
4
- "description": "Pack and open one provider metadata record. The same wire object for every provider.",
3
+ "version": "1.2.1",
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",
7
7
  "module": "./dist/index.js",