@x12i/provider-metadata 1.0.0 → 1.2.0
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 +56 -3
- package/dist/index.cjs +182 -23
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +79 -3
- package/dist/index.d.ts +79 -3
- package/dist/index.js +175 -24
- package/dist/index.js.map +1 -1
- package/package.json +2 -2
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,7 +32,58 @@ 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
|
|
|
33
|
-
|
|
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
|
+
|
|
56
|
+
## Automatic trim
|
|
57
|
+
|
|
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.
|
|
59
|
+
|
|
60
|
+
`priority` is highest priority first. Listed keys are kept ahead of keys that are not in the list. An earlier list entry is kept ahead of a later one. Among keys with the same priority, the longest value is dropped first.
|
|
61
|
+
|
|
62
|
+
```ts
|
|
63
|
+
import { createMetadataPacker, openMetadata } from "@x12i/provider-metadata";
|
|
64
|
+
|
|
65
|
+
const packer = createMetadataPacker({
|
|
66
|
+
priority: ["agentId", "orgId", "stepId", "skillId", "recordId", "objectType"]
|
|
67
|
+
});
|
|
68
|
+
|
|
69
|
+
const packed = packer.pack({
|
|
70
|
+
objectType: "finding",
|
|
71
|
+
recordId: "rec-1",
|
|
72
|
+
note: veryLongText
|
|
73
|
+
});
|
|
74
|
+
|
|
75
|
+
if (packed.dropped.length) {
|
|
76
|
+
// packed.dropped lists the keys that did not fit, least important first
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
const record = openMetadata(packed.wire);
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
`@x12i/ai-dispatcher` does this on every call. Pass the same list once as `metadataPriority`. A trimmed call adds a `METADATA_RECORD_TRIMMED` warning. `metadataTrimWarning(packed.dropped)` builds that warning from a direct `pack` result.
|
|
83
|
+
|
|
84
|
+
`packMetadata` does not drop keys. A record that does not fit throws `METADATA_RECORD_TOO_LARGE`.
|
|
85
|
+
|
|
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`.
|
|
34
87
|
|
|
35
88
|
## Wire object
|
|
36
89
|
|
|
@@ -41,7 +94,7 @@ The stored value is UTF-8 JSON of the string map, with keys sorted, then base64.
|
|
|
41
94
|
| `PROVIDER_METADATA_CHUNK_SIZE` | 256 characters |
|
|
42
95
|
| `PROVIDER_METADATA_MAX_CHUNKS` | 16 |
|
|
43
96
|
|
|
44
|
-
|
|
97
|
+
The limit is 4096 base64 characters. `createMetadataPacker` drops pairs until the record fits. `packMetadata` throws `METADATA_RECORD_TOO_LARGE` instead.
|
|
45
98
|
|
|
46
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 `{}`.
|
|
47
100
|
|
|
@@ -54,4 +107,4 @@ These provider slots hold that same object:
|
|
|
54
107
|
| Bedrock | `requestMetadata` |
|
|
55
108
|
| Cloudflare | Body `metadata` and the `cf-aig-metadata` header |
|
|
56
109
|
|
|
57
|
-
`@x12i/ai-dispatcher`
|
|
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,28 +20,174 @@ 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,
|
|
24
|
+
METADATA_RECORD_TRIMMED: () => METADATA_RECORD_TRIMMED,
|
|
23
25
|
PROVIDER_METADATA_CHUNK_SIZE: () => PROVIDER_METADATA_CHUNK_SIZE,
|
|
24
26
|
PROVIDER_METADATA_MAX_CHUNKS: () => PROVIDER_METADATA_MAX_CHUNKS,
|
|
27
|
+
canonicalMetadataKey: () => canonicalMetadataKey,
|
|
28
|
+
createMetadataPacker: () => createMetadataPacker,
|
|
29
|
+
metadataTrimWarning: () => metadataTrimWarning,
|
|
30
|
+
normalizeMetadata: () => normalizeMetadata,
|
|
25
31
|
openMetadata: () => openMetadata,
|
|
26
32
|
packMetadata: () => packMetadata
|
|
27
33
|
});
|
|
28
34
|
module.exports = __toCommonJS(index_exports);
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
var
|
|
32
|
-
|
|
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) {
|
|
33
61
|
const map = {};
|
|
34
62
|
for (const layer of layers) {
|
|
35
63
|
if (!layer) continue;
|
|
36
64
|
for (const [key, value] of Object.entries(layer)) {
|
|
37
65
|
const asString = asMetadataString(value);
|
|
38
|
-
if (asString !== void 0)
|
|
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
|
|
142
|
+
var PROVIDER_METADATA_CHUNK_SIZE = 256;
|
|
143
|
+
var PROVIDER_METADATA_MAX_CHUNKS = 16;
|
|
144
|
+
var MAX_ENCODED_LENGTH = PROVIDER_METADATA_CHUNK_SIZE * PROVIDER_METADATA_MAX_CHUNKS;
|
|
145
|
+
var METADATA_RECORD_TRIMMED = "METADATA_RECORD_TRIMMED";
|
|
146
|
+
function createMetadataPacker(options) {
|
|
147
|
+
const priority = [...options?.priority ?? []];
|
|
148
|
+
const rank = /* @__PURE__ */ new Map();
|
|
149
|
+
for (let index = 0; index < priority.length; index += 1) {
|
|
150
|
+
const key = priority[index];
|
|
151
|
+
if (key !== void 0 && !rank.has(key)) rank.set(key, index);
|
|
152
|
+
}
|
|
153
|
+
return {
|
|
154
|
+
pack(...layers) {
|
|
155
|
+
const map = collectNormalizedStrings(layers);
|
|
156
|
+
const dropped = [];
|
|
157
|
+
let encoded = encodeProviderRecord(map);
|
|
158
|
+
while (encoded.tooLarge) {
|
|
159
|
+
const victim = leastImportantKey(map, rank, priority.length);
|
|
160
|
+
if (!victim) break;
|
|
161
|
+
delete map[victim];
|
|
162
|
+
dropped.push(victim);
|
|
163
|
+
encoded = encodeProviderRecord(map);
|
|
164
|
+
}
|
|
165
|
+
return {
|
|
166
|
+
...encoded.wire ? { wire: encoded.wire } : {},
|
|
167
|
+
dropped
|
|
168
|
+
};
|
|
39
169
|
}
|
|
170
|
+
};
|
|
171
|
+
}
|
|
172
|
+
function metadataTrimWarning(dropped) {
|
|
173
|
+
if (!dropped.length) return void 0;
|
|
174
|
+
return {
|
|
175
|
+
code: METADATA_RECORD_TRIMMED,
|
|
176
|
+
message: `Dropped metadata keys so the provider record fits: ${dropped.join(", ")}.`,
|
|
177
|
+
details: { dropped: [...dropped] }
|
|
178
|
+
};
|
|
179
|
+
}
|
|
180
|
+
function packMetadata(...layers) {
|
|
181
|
+
const encoded = encodeProviderRecord(collectNormalizedStrings(layers));
|
|
182
|
+
if (encoded.tooLarge) {
|
|
183
|
+
throw new Error(
|
|
184
|
+
`METADATA_RECORD_TOO_LARGE: provider metadata is ${encoded.encodedLength} base64 characters; the maximum is ${MAX_ENCODED_LENGTH}.`
|
|
185
|
+
);
|
|
40
186
|
}
|
|
41
|
-
return
|
|
187
|
+
return encoded.wire;
|
|
42
188
|
}
|
|
43
189
|
function openMetadata(wire) {
|
|
44
|
-
if (!
|
|
190
|
+
if (!isRecord2(wire)) return {};
|
|
45
191
|
const parts = [];
|
|
46
192
|
for (let index = 0; ; index += 1) {
|
|
47
193
|
const chunk = wire[`m.${index}`];
|
|
@@ -50,50 +196,63 @@ function openMetadata(wire) {
|
|
|
50
196
|
}
|
|
51
197
|
if (!parts.length) return {};
|
|
52
198
|
const parsed = JSON.parse(Buffer.from(parts.join(""), "base64").toString("utf8"));
|
|
53
|
-
if (!
|
|
199
|
+
if (!isRecord2(parsed)) return {};
|
|
54
200
|
const record = {};
|
|
55
201
|
for (const [key, value] of Object.entries(parsed)) {
|
|
56
202
|
if (typeof value === "string") record[key] = value;
|
|
57
203
|
}
|
|
58
|
-
return record;
|
|
204
|
+
return normalizeMetadata(record);
|
|
59
205
|
}
|
|
60
206
|
function encodeProviderRecord(map) {
|
|
61
207
|
const keys = Object.keys(map).sort();
|
|
62
|
-
if (!keys.length) return
|
|
208
|
+
if (!keys.length) return { encodedLength: 0, tooLarge: false };
|
|
63
209
|
const ordered = {};
|
|
64
210
|
for (const key of keys) {
|
|
65
211
|
const value = map[key];
|
|
66
212
|
if (value !== void 0) ordered[key] = value;
|
|
67
213
|
}
|
|
68
214
|
const encoded = Buffer.from(JSON.stringify(ordered), "utf8").toString("base64");
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
throw new Error(
|
|
72
|
-
`METADATA_RECORD_TOO_LARGE: provider metadata is ${encoded.length} base64 characters; the maximum is ${MAX_ENCODED_LENGTH}.`
|
|
73
|
-
);
|
|
215
|
+
if (Math.ceil(encoded.length / PROVIDER_METADATA_CHUNK_SIZE) > PROVIDER_METADATA_MAX_CHUNKS) {
|
|
216
|
+
return { encodedLength: encoded.length, tooLarge: true };
|
|
74
217
|
}
|
|
75
218
|
const wire = {};
|
|
76
|
-
for (let index = 0; index <
|
|
219
|
+
for (let index = 0; index < Math.ceil(encoded.length / PROVIDER_METADATA_CHUNK_SIZE); index += 1) {
|
|
77
220
|
wire[`m.${index}`] = encoded.slice(
|
|
78
221
|
index * PROVIDER_METADATA_CHUNK_SIZE,
|
|
79
222
|
(index + 1) * PROVIDER_METADATA_CHUNK_SIZE
|
|
80
223
|
);
|
|
81
224
|
}
|
|
82
|
-
return wire;
|
|
225
|
+
return { wire, encodedLength: encoded.length, tooLarge: false };
|
|
83
226
|
}
|
|
84
|
-
function
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
227
|
+
function leastImportantKey(map, rank, unlistedRank) {
|
|
228
|
+
let chosen;
|
|
229
|
+
let chosenRank = -1;
|
|
230
|
+
let chosenSize = -1;
|
|
231
|
+
for (const [key, value] of Object.entries(map)) {
|
|
232
|
+
const keyRank = rank.get(key) ?? unlistedRank;
|
|
233
|
+
const size = value.length;
|
|
234
|
+
const lessImportant = chosen === void 0 || keyRank > chosenRank || keyRank === chosenRank && size > chosenSize || keyRank === chosenRank && size === chosenSize && key > chosen;
|
|
235
|
+
if (lessImportant) {
|
|
236
|
+
chosen = key;
|
|
237
|
+
chosenRank = keyRank;
|
|
238
|
+
chosenSize = size;
|
|
239
|
+
}
|
|
240
|
+
}
|
|
241
|
+
return chosen;
|
|
89
242
|
}
|
|
90
|
-
function
|
|
243
|
+
function isRecord2(value) {
|
|
91
244
|
return typeof value === "object" && value !== null && !Array.isArray(value);
|
|
92
245
|
}
|
|
93
246
|
// Annotate the CommonJS export names for ESM import in node:
|
|
94
247
|
0 && (module.exports = {
|
|
248
|
+
METADATA_NORMALIZATION_MAP,
|
|
249
|
+
METADATA_RECORD_TRIMMED,
|
|
95
250
|
PROVIDER_METADATA_CHUNK_SIZE,
|
|
96
251
|
PROVIDER_METADATA_MAX_CHUNKS,
|
|
252
|
+
canonicalMetadataKey,
|
|
253
|
+
createMetadataPacker,
|
|
254
|
+
metadataTrimWarning,
|
|
255
|
+
normalizeMetadata,
|
|
97
256
|
openMetadata,
|
|
98
257
|
packMetadata
|
|
99
258
|
});
|
package/dist/index.cjs.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\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 * 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 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 encodeProviderRecord(map);\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 encodeProviderRecord(map: Record<string, string>): Record<string, string> | undefined {\r\n const keys = Object.keys(map).sort();\r\n if (!keys.length) return undefined;\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 const chunks = Math.ceil(encoded.length / PROVIDER_METADATA_CHUNK_SIZE);\r\n if (chunks > PROVIDER_METADATA_MAX_CHUNKS) {\r\n throw new Error(\r\n `METADATA_RECORD_TOO_LARGE: provider metadata is ${encoded.length} base64 characters; the maximum is ${MAX_ENCODED_LENGTH}.`\r\n );\r\n }\r\n const wire: Record<string, string> = {};\r\n for (let index = 0; index < chunks; 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;\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;AAAO,IAAM,+BAA+B;AACrC,IAAM,+BAA+B;AAE5C,IAAM,qBAAqB,+BAA+B;AASnD,SAAS,gBACX,QACiC;AACpC,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,qBAAqB,GAAG;AACjC;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,qBAAqB,KAAiE;AAC7F,QAAM,OAAO,OAAO,KAAK,GAAG,EAAE,KAAK;AACnC,MAAI,CAAC,KAAK,OAAQ,QAAO;AACzB,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,QAAM,SAAS,KAAK,KAAK,QAAQ,SAAS,4BAA4B;AACtE,MAAI,SAAS,8BAA8B;AACzC,UAAM,IAAI;AAAA,MACR,mDAAmD,QAAQ,MAAM,sCAAsC,kBAAkB;AAAA,IAC3H;AAAA,EACF;AACA,QAAM,OAA+B,CAAC;AACtC,WAAS,QAAQ,GAAG,QAAQ,QAAQ,SAAS,GAAG;AAC9C,SAAK,KAAK,KAAK,EAAE,IAAI,QAAQ;AAAA,MAC3B,QAAQ;AAAA,OACP,QAAQ,KAAK;AAAA,IAChB;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 * 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"]}
|
package/dist/index.d.cts
CHANGED
|
@@ -1,17 +1,93 @@
|
|
|
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;
|
|
40
|
+
declare const METADATA_RECORD_TRIMMED = "METADATA_RECORD_TRIMMED";
|
|
41
|
+
interface MetadataPackerOptions {
|
|
42
|
+
/**
|
|
43
|
+
* Highest priority first.
|
|
44
|
+
* Listed keys are kept ahead of every key that is not in the list.
|
|
45
|
+
* Within the list, an earlier key is kept ahead of a later key.
|
|
46
|
+
*/
|
|
47
|
+
priority?: readonly string[];
|
|
48
|
+
}
|
|
49
|
+
interface PackedMetadata {
|
|
50
|
+
/** Provider wire object. Omitted when the map is empty or every pair was dropped. */
|
|
51
|
+
wire?: Record<string, string>;
|
|
52
|
+
/** Keys removed so the record fits, least important first. Empty when nothing was dropped. */
|
|
53
|
+
dropped: readonly string[];
|
|
54
|
+
}
|
|
55
|
+
interface MetadataTrimWarning {
|
|
56
|
+
code: typeof METADATA_RECORD_TRIMMED;
|
|
57
|
+
message: string;
|
|
58
|
+
details: {
|
|
59
|
+
dropped: string[];
|
|
60
|
+
};
|
|
61
|
+
}
|
|
62
|
+
interface MetadataPacker {
|
|
63
|
+
pack(...layers: Array<Record<string, unknown> | undefined>): PackedMetadata;
|
|
64
|
+
}
|
|
65
|
+
/**
|
|
66
|
+
* One packer for a process.
|
|
67
|
+
* Pass the priority list here. Every `pack` call trims to the provider limit and reports dropped keys.
|
|
68
|
+
*/
|
|
69
|
+
declare function createMetadataPacker(options?: MetadataPackerOptions): MetadataPacker;
|
|
70
|
+
/** Warning for a pack that had to drop keys. Omitted when nothing was dropped. */
|
|
71
|
+
declare function metadataTrimWarning(dropped: readonly string[]): MetadataTrimWarning | undefined;
|
|
3
72
|
/**
|
|
4
73
|
* Packs caller maps into one provider metadata object.
|
|
5
74
|
* Later layers win on the same key. String, number, and boolean values are stored.
|
|
6
|
-
* Numbers and booleans are stored as their string form.
|
|
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.
|
|
7
80
|
* An empty result is `undefined`.
|
|
81
|
+
* A record over the size limit throws `METADATA_RECORD_TOO_LARGE`.
|
|
82
|
+
* Writers that should drop pairs instead use `createMetadataPacker`.
|
|
8
83
|
* The packed object is the same for every provider: `m.0`, `m.1`, and so on.
|
|
9
84
|
*/
|
|
10
85
|
declare function packMetadata(...layers: Array<Record<string, unknown> | undefined>): Record<string, string> | undefined;
|
|
11
86
|
/**
|
|
12
87
|
* Opens the `m.0`, `m.1`, ... object from a provider log.
|
|
13
|
-
* Returns every stored pair
|
|
88
|
+
* Returns every stored pair with known aliases promoted to canonical keys.
|
|
89
|
+
* A missing record returns `{}`.
|
|
14
90
|
*/
|
|
15
91
|
declare function openMetadata(wire: unknown): Record<string, string>;
|
|
16
92
|
|
|
17
|
-
export { PROVIDER_METADATA_CHUNK_SIZE, PROVIDER_METADATA_MAX_CHUNKS, openMetadata, packMetadata };
|
|
93
|
+
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,17 +1,93 @@
|
|
|
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;
|
|
40
|
+
declare const METADATA_RECORD_TRIMMED = "METADATA_RECORD_TRIMMED";
|
|
41
|
+
interface MetadataPackerOptions {
|
|
42
|
+
/**
|
|
43
|
+
* Highest priority first.
|
|
44
|
+
* Listed keys are kept ahead of every key that is not in the list.
|
|
45
|
+
* Within the list, an earlier key is kept ahead of a later key.
|
|
46
|
+
*/
|
|
47
|
+
priority?: readonly string[];
|
|
48
|
+
}
|
|
49
|
+
interface PackedMetadata {
|
|
50
|
+
/** Provider wire object. Omitted when the map is empty or every pair was dropped. */
|
|
51
|
+
wire?: Record<string, string>;
|
|
52
|
+
/** Keys removed so the record fits, least important first. Empty when nothing was dropped. */
|
|
53
|
+
dropped: readonly string[];
|
|
54
|
+
}
|
|
55
|
+
interface MetadataTrimWarning {
|
|
56
|
+
code: typeof METADATA_RECORD_TRIMMED;
|
|
57
|
+
message: string;
|
|
58
|
+
details: {
|
|
59
|
+
dropped: string[];
|
|
60
|
+
};
|
|
61
|
+
}
|
|
62
|
+
interface MetadataPacker {
|
|
63
|
+
pack(...layers: Array<Record<string, unknown> | undefined>): PackedMetadata;
|
|
64
|
+
}
|
|
65
|
+
/**
|
|
66
|
+
* One packer for a process.
|
|
67
|
+
* Pass the priority list here. Every `pack` call trims to the provider limit and reports dropped keys.
|
|
68
|
+
*/
|
|
69
|
+
declare function createMetadataPacker(options?: MetadataPackerOptions): MetadataPacker;
|
|
70
|
+
/** Warning for a pack that had to drop keys. Omitted when nothing was dropped. */
|
|
71
|
+
declare function metadataTrimWarning(dropped: readonly string[]): MetadataTrimWarning | undefined;
|
|
3
72
|
/**
|
|
4
73
|
* Packs caller maps into one provider metadata object.
|
|
5
74
|
* Later layers win on the same key. String, number, and boolean values are stored.
|
|
6
|
-
* Numbers and booleans are stored as their string form.
|
|
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.
|
|
7
80
|
* An empty result is `undefined`.
|
|
81
|
+
* A record over the size limit throws `METADATA_RECORD_TOO_LARGE`.
|
|
82
|
+
* Writers that should drop pairs instead use `createMetadataPacker`.
|
|
8
83
|
* The packed object is the same for every provider: `m.0`, `m.1`, and so on.
|
|
9
84
|
*/
|
|
10
85
|
declare function packMetadata(...layers: Array<Record<string, unknown> | undefined>): Record<string, string> | undefined;
|
|
11
86
|
/**
|
|
12
87
|
* Opens the `m.0`, `m.1`, ... object from a provider log.
|
|
13
|
-
* Returns every stored pair
|
|
88
|
+
* Returns every stored pair with known aliases promoted to canonical keys.
|
|
89
|
+
* A missing record returns `{}`.
|
|
14
90
|
*/
|
|
15
91
|
declare function openMetadata(wire: unknown): Record<string, string>;
|
|
16
92
|
|
|
17
|
-
export { PROVIDER_METADATA_CHUNK_SIZE, PROVIDER_METADATA_MAX_CHUNKS, openMetadata, packMetadata };
|
|
93
|
+
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,20 +1,158 @@
|
|
|
1
|
-
// src/
|
|
2
|
-
var
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
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) {
|
|
6
26
|
const map = {};
|
|
7
27
|
for (const layer of layers) {
|
|
8
28
|
if (!layer) continue;
|
|
9
29
|
for (const [key, value] of Object.entries(layer)) {
|
|
10
30
|
const asString = asMetadataString(value);
|
|
11
|
-
if (asString !== void 0)
|
|
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
|
+
}
|
|
12
41
|
}
|
|
13
42
|
}
|
|
14
|
-
return
|
|
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
|
+
|
|
106
|
+
// src/index.ts
|
|
107
|
+
var PROVIDER_METADATA_CHUNK_SIZE = 256;
|
|
108
|
+
var PROVIDER_METADATA_MAX_CHUNKS = 16;
|
|
109
|
+
var MAX_ENCODED_LENGTH = PROVIDER_METADATA_CHUNK_SIZE * PROVIDER_METADATA_MAX_CHUNKS;
|
|
110
|
+
var METADATA_RECORD_TRIMMED = "METADATA_RECORD_TRIMMED";
|
|
111
|
+
function createMetadataPacker(options) {
|
|
112
|
+
const priority = [...options?.priority ?? []];
|
|
113
|
+
const rank = /* @__PURE__ */ new Map();
|
|
114
|
+
for (let index = 0; index < priority.length; index += 1) {
|
|
115
|
+
const key = priority[index];
|
|
116
|
+
if (key !== void 0 && !rank.has(key)) rank.set(key, index);
|
|
117
|
+
}
|
|
118
|
+
return {
|
|
119
|
+
pack(...layers) {
|
|
120
|
+
const map = collectNormalizedStrings(layers);
|
|
121
|
+
const dropped = [];
|
|
122
|
+
let encoded = encodeProviderRecord(map);
|
|
123
|
+
while (encoded.tooLarge) {
|
|
124
|
+
const victim = leastImportantKey(map, rank, priority.length);
|
|
125
|
+
if (!victim) break;
|
|
126
|
+
delete map[victim];
|
|
127
|
+
dropped.push(victim);
|
|
128
|
+
encoded = encodeProviderRecord(map);
|
|
129
|
+
}
|
|
130
|
+
return {
|
|
131
|
+
...encoded.wire ? { wire: encoded.wire } : {},
|
|
132
|
+
dropped
|
|
133
|
+
};
|
|
134
|
+
}
|
|
135
|
+
};
|
|
136
|
+
}
|
|
137
|
+
function metadataTrimWarning(dropped) {
|
|
138
|
+
if (!dropped.length) return void 0;
|
|
139
|
+
return {
|
|
140
|
+
code: METADATA_RECORD_TRIMMED,
|
|
141
|
+
message: `Dropped metadata keys so the provider record fits: ${dropped.join(", ")}.`,
|
|
142
|
+
details: { dropped: [...dropped] }
|
|
143
|
+
};
|
|
144
|
+
}
|
|
145
|
+
function packMetadata(...layers) {
|
|
146
|
+
const encoded = encodeProviderRecord(collectNormalizedStrings(layers));
|
|
147
|
+
if (encoded.tooLarge) {
|
|
148
|
+
throw new Error(
|
|
149
|
+
`METADATA_RECORD_TOO_LARGE: provider metadata is ${encoded.encodedLength} base64 characters; the maximum is ${MAX_ENCODED_LENGTH}.`
|
|
150
|
+
);
|
|
151
|
+
}
|
|
152
|
+
return encoded.wire;
|
|
15
153
|
}
|
|
16
154
|
function openMetadata(wire) {
|
|
17
|
-
if (!
|
|
155
|
+
if (!isRecord2(wire)) return {};
|
|
18
156
|
const parts = [];
|
|
19
157
|
for (let index = 0; ; index += 1) {
|
|
20
158
|
const chunk = wire[`m.${index}`];
|
|
@@ -23,49 +161,62 @@ function openMetadata(wire) {
|
|
|
23
161
|
}
|
|
24
162
|
if (!parts.length) return {};
|
|
25
163
|
const parsed = JSON.parse(Buffer.from(parts.join(""), "base64").toString("utf8"));
|
|
26
|
-
if (!
|
|
164
|
+
if (!isRecord2(parsed)) return {};
|
|
27
165
|
const record = {};
|
|
28
166
|
for (const [key, value] of Object.entries(parsed)) {
|
|
29
167
|
if (typeof value === "string") record[key] = value;
|
|
30
168
|
}
|
|
31
|
-
return record;
|
|
169
|
+
return normalizeMetadata(record);
|
|
32
170
|
}
|
|
33
171
|
function encodeProviderRecord(map) {
|
|
34
172
|
const keys = Object.keys(map).sort();
|
|
35
|
-
if (!keys.length) return
|
|
173
|
+
if (!keys.length) return { encodedLength: 0, tooLarge: false };
|
|
36
174
|
const ordered = {};
|
|
37
175
|
for (const key of keys) {
|
|
38
176
|
const value = map[key];
|
|
39
177
|
if (value !== void 0) ordered[key] = value;
|
|
40
178
|
}
|
|
41
179
|
const encoded = Buffer.from(JSON.stringify(ordered), "utf8").toString("base64");
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
throw new Error(
|
|
45
|
-
`METADATA_RECORD_TOO_LARGE: provider metadata is ${encoded.length} base64 characters; the maximum is ${MAX_ENCODED_LENGTH}.`
|
|
46
|
-
);
|
|
180
|
+
if (Math.ceil(encoded.length / PROVIDER_METADATA_CHUNK_SIZE) > PROVIDER_METADATA_MAX_CHUNKS) {
|
|
181
|
+
return { encodedLength: encoded.length, tooLarge: true };
|
|
47
182
|
}
|
|
48
183
|
const wire = {};
|
|
49
|
-
for (let index = 0; index <
|
|
184
|
+
for (let index = 0; index < Math.ceil(encoded.length / PROVIDER_METADATA_CHUNK_SIZE); index += 1) {
|
|
50
185
|
wire[`m.${index}`] = encoded.slice(
|
|
51
186
|
index * PROVIDER_METADATA_CHUNK_SIZE,
|
|
52
187
|
(index + 1) * PROVIDER_METADATA_CHUNK_SIZE
|
|
53
188
|
);
|
|
54
189
|
}
|
|
55
|
-
return wire;
|
|
190
|
+
return { wire, encodedLength: encoded.length, tooLarge: false };
|
|
56
191
|
}
|
|
57
|
-
function
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
192
|
+
function leastImportantKey(map, rank, unlistedRank) {
|
|
193
|
+
let chosen;
|
|
194
|
+
let chosenRank = -1;
|
|
195
|
+
let chosenSize = -1;
|
|
196
|
+
for (const [key, value] of Object.entries(map)) {
|
|
197
|
+
const keyRank = rank.get(key) ?? unlistedRank;
|
|
198
|
+
const size = value.length;
|
|
199
|
+
const lessImportant = chosen === void 0 || keyRank > chosenRank || keyRank === chosenRank && size > chosenSize || keyRank === chosenRank && size === chosenSize && key > chosen;
|
|
200
|
+
if (lessImportant) {
|
|
201
|
+
chosen = key;
|
|
202
|
+
chosenRank = keyRank;
|
|
203
|
+
chosenSize = size;
|
|
204
|
+
}
|
|
205
|
+
}
|
|
206
|
+
return chosen;
|
|
62
207
|
}
|
|
63
|
-
function
|
|
208
|
+
function isRecord2(value) {
|
|
64
209
|
return typeof value === "object" && value !== null && !Array.isArray(value);
|
|
65
210
|
}
|
|
66
211
|
export {
|
|
212
|
+
METADATA_NORMALIZATION_MAP,
|
|
213
|
+
METADATA_RECORD_TRIMMED,
|
|
67
214
|
PROVIDER_METADATA_CHUNK_SIZE,
|
|
68
215
|
PROVIDER_METADATA_MAX_CHUNKS,
|
|
216
|
+
canonicalMetadataKey,
|
|
217
|
+
createMetadataPacker,
|
|
218
|
+
metadataTrimWarning,
|
|
219
|
+
normalizeMetadata,
|
|
69
220
|
openMetadata,
|
|
70
221
|
packMetadata
|
|
71
222
|
};
|
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\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 * 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 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 encodeProviderRecord(map);\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 encodeProviderRecord(map: Record<string, string>): Record<string, string> | undefined {\r\n const keys = Object.keys(map).sort();\r\n if (!keys.length) return undefined;\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 const chunks = Math.ceil(encoded.length / PROVIDER_METADATA_CHUNK_SIZE);\r\n if (chunks > PROVIDER_METADATA_MAX_CHUNKS) {\r\n throw new Error(\r\n `METADATA_RECORD_TOO_LARGE: provider metadata is ${encoded.length} base64 characters; the maximum is ${MAX_ENCODED_LENGTH}.`\r\n );\r\n }\r\n const wire: Record<string, string> = {};\r\n for (let index = 0; index < chunks; 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;\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;AASnD,SAAS,gBACX,QACiC;AACpC,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,qBAAqB,GAAG;AACjC;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,qBAAqB,KAAiE;AAC7F,QAAM,OAAO,OAAO,KAAK,GAAG,EAAE,KAAK;AACnC,MAAI,CAAC,KAAK,OAAQ,QAAO;AACzB,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,QAAM,SAAS,KAAK,KAAK,QAAQ,SAAS,4BAA4B;AACtE,MAAI,SAAS,8BAA8B;AACzC,UAAM,IAAI;AAAA,MACR,mDAAmD,QAAQ,MAAM,sCAAsC,kBAAkB;AAAA,IAC3H;AAAA,EACF;AACA,QAAM,OAA+B,CAAC;AACtC,WAAS,QAAQ,GAAG,QAAQ,QAAQ,SAAS,GAAG;AAC9C,SAAK,KAAK,KAAK,EAAE,IAAI,QAAQ;AAAA,MAC3B,QAAQ;AAAA,OACP,QAAQ,KAAK;AAAA,IAChB;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 * 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"]}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@x12i/provider-metadata",
|
|
3
|
-
"version": "1.
|
|
4
|
-
"description": "Pack and
|
|
3
|
+
"version": "1.2.0",
|
|
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",
|