@revenium/openai 1.1.0 → 1.1.2
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/CHANGELOG.md +22 -0
- package/README.md +60 -12
- package/dist/cjs/core/tracking/tool-api-client.js +58 -0
- package/dist/cjs/core/tracking/tool-api-client.js.map +1 -0
- package/dist/cjs/core/tracking/tool-context.js +23 -0
- package/dist/cjs/core/tracking/tool-context.js.map +1 -0
- package/dist/cjs/core/tracking/tool-tracker.js +122 -0
- package/dist/cjs/core/tracking/tool-tracker.js.map +1 -0
- package/dist/cjs/index.js +9 -1
- package/dist/cjs/index.js.map +1 -1
- package/dist/cjs/types/index.js +1 -0
- package/dist/cjs/types/index.js.map +1 -1
- package/dist/cjs/types/tool-metering.js +3 -0
- package/dist/cjs/types/tool-metering.js.map +1 -0
- package/dist/cjs/utils/metadata-builder.js +21 -9
- package/dist/cjs/utils/metadata-builder.js.map +1 -1
- package/dist/esm/core/tracking/tool-api-client.js +55 -0
- package/dist/esm/core/tracking/tool-api-client.js.map +1 -0
- package/dist/esm/core/tracking/tool-context.js +17 -0
- package/dist/esm/core/tracking/tool-context.js.map +1 -0
- package/dist/esm/core/tracking/tool-tracker.js +118 -0
- package/dist/esm/core/tracking/tool-tracker.js.map +1 -0
- package/dist/esm/index.js +2 -0
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/types/index.js +1 -0
- package/dist/esm/types/index.js.map +1 -1
- package/dist/esm/types/tool-metering.js +2 -0
- package/dist/esm/types/tool-metering.js.map +1 -0
- package/dist/esm/utils/metadata-builder.js +21 -9
- package/dist/esm/utils/metadata-builder.js.map +1 -1
- package/dist/types/core/tracking/tool-api-client.d.ts +3 -0
- package/dist/types/core/tracking/tool-api-client.d.ts.map +1 -0
- package/dist/types/core/tracking/tool-context.d.ts +6 -0
- package/dist/types/core/tracking/tool-context.d.ts.map +1 -0
- package/dist/types/core/tracking/tool-tracker.d.ts +4 -0
- package/dist/types/core/tracking/tool-tracker.d.ts.map +1 -0
- package/dist/types/index.d.ts +3 -0
- package/dist/types/index.d.ts.map +1 -1
- package/dist/types/types/index.d.ts +15 -4
- package/dist/types/types/index.d.ts.map +1 -1
- package/dist/types/types/tool-metering.d.ts +47 -0
- package/dist/types/types/tool-metering.d.ts.map +1 -0
- package/dist/types/utils/metadata-builder.d.ts +3 -0
- package/dist/types/utils/metadata-builder.d.ts.map +1 -1
- package/examples/README.md +2 -2
- package/examples/azure/basic.ts +3 -3
- package/examples/azure/responses-basic.ts +4 -4
- package/examples/azure/responses-stream.ts +4 -4
- package/examples/azure/stream.ts +3 -3
- package/examples/getting_started.ts +2 -2
- package/examples/openai/basic.ts +3 -3
- package/examples/openai/metadata.ts +4 -4
- package/examples/openai/prompt-capture.ts +6 -6
- package/examples/openai/responses-basic.ts +4 -4
- package/examples/openai/responses-embed.ts +3 -3
- package/examples/openai/responses-streaming.ts +4 -4
- package/examples/openai/streaming.ts +3 -3
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,28 @@ All notable changes to this project will be documented in this file.
|
|
|
5
5
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
6
6
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
7
|
|
|
8
|
+
## [1.1.2] - 2026-02-19
|
|
9
|
+
|
|
10
|
+
### Added
|
|
11
|
+
|
|
12
|
+
- Tool metering support (meterTool, reportToolCall, setToolContext)
|
|
13
|
+
- outputFields feature for automatic result extraction
|
|
14
|
+
- Fetch timeout to sendToolEvent
|
|
15
|
+
|
|
16
|
+
### Fixed
|
|
17
|
+
|
|
18
|
+
- Remove dead response.text() in sendToolEvent
|
|
19
|
+
|
|
20
|
+
## [1.1.1] - 2026-02-06
|
|
21
|
+
|
|
22
|
+
### Added
|
|
23
|
+
|
|
24
|
+
- Summary printer with human and JSON output formats
|
|
25
|
+
- Region detection from AWS, Azure, GCP environment variables
|
|
26
|
+
- Credential alias configuration support
|
|
27
|
+
- Trace name and trace type validation
|
|
28
|
+
- Retry number tracking
|
|
29
|
+
|
|
8
30
|
## [1.1.0] - 2026-01-20
|
|
9
31
|
|
|
10
32
|
### Added
|
package/README.md
CHANGED
|
@@ -106,22 +106,70 @@ The middleware provides a Go-aligned API with the following main functions:
|
|
|
106
106
|
|
|
107
107
|
**For complete API documentation and usage examples, see [`examples/README.md`](https://github.com/revenium/revenium-middleware-openai-node/blob/HEAD/examples/README.md).**
|
|
108
108
|
|
|
109
|
+
## Tool Metering
|
|
110
|
+
|
|
111
|
+
Track execution of custom tools and external API calls with automatic timing, error handling, and metadata collection.
|
|
112
|
+
|
|
113
|
+
### Quick Example
|
|
114
|
+
|
|
115
|
+
```typescript
|
|
116
|
+
import { meterTool, setToolContext } from '@revenium/openai';
|
|
117
|
+
|
|
118
|
+
setToolContext({
|
|
119
|
+
agent: 'my-agent',
|
|
120
|
+
traceId: 'session-123'
|
|
121
|
+
});
|
|
122
|
+
|
|
123
|
+
const result = await meterTool('weather-api', async () => {
|
|
124
|
+
return await fetch('https://api.example.com/weather');
|
|
125
|
+
}, {
|
|
126
|
+
operation: 'get_forecast',
|
|
127
|
+
outputFields: ['temperature', 'humidity']
|
|
128
|
+
});
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
### Functions
|
|
132
|
+
|
|
133
|
+
**meterTool(toolId, fn, metadata?)**
|
|
134
|
+
|
|
135
|
+
Wraps a function with automatic metering. Captures duration, success/failure, and errors. Returns function result unchanged.
|
|
136
|
+
|
|
137
|
+
**reportToolCall(toolId, report)**
|
|
138
|
+
|
|
139
|
+
Manually report a tool call that was already executed. Useful when wrapping is not possible.
|
|
140
|
+
|
|
141
|
+
**Context Management**
|
|
142
|
+
|
|
143
|
+
- `setToolContext(ctx)` - Set context for all subsequent tool calls
|
|
144
|
+
- `getToolContext()` - Get current context
|
|
145
|
+
- `clearToolContext()` - Clear context
|
|
146
|
+
- `runWithToolContext(ctx, fn)` - Run function with scoped context
|
|
147
|
+
|
|
148
|
+
### Metadata Options
|
|
149
|
+
|
|
150
|
+
| Field | Description |
|
|
151
|
+
|-------|-------------|
|
|
152
|
+
| `operation` | Tool operation name (e.g., "search", "scrape") |
|
|
153
|
+
| `outputFields` | Array of field names to auto-extract from result |
|
|
154
|
+
| `usageMetadata` | Custom metrics (e.g., tokens, results count) |
|
|
155
|
+
| `agent`, `traceId`, etc. | Context fields (inherited from setToolContext) |
|
|
156
|
+
|
|
109
157
|
## Metadata Fields
|
|
110
158
|
|
|
111
159
|
The middleware supports the following optional metadata fields for tracking:
|
|
112
160
|
|
|
113
|
-
| Field | Type | Description
|
|
114
|
-
| ----------------------- | ------ |
|
|
115
|
-
| `traceId` | string | Unique identifier for session or conversation tracking
|
|
116
|
-
| `taskType` | string | Type of AI task being performed (e.g., "chat", "embedding")
|
|
117
|
-
| `agent` | string | AI agent or bot identifier
|
|
118
|
-
| `
|
|
119
|
-
| `
|
|
120
|
-
| `subscriptionId` | string | Subscription plan identifier
|
|
121
|
-
| `responseQualityScore` | number | Custom quality rating (0.0-1.0)
|
|
122
|
-
| `subscriber.id` | string | Unique user identifier
|
|
123
|
-
| `subscriber.email` | string | User email address
|
|
124
|
-
| `subscriber.credential` | object | Authentication credential (`name` and `value` fields)
|
|
161
|
+
| Field | Type | Description |
|
|
162
|
+
| ----------------------- | ------ | ------------------------------------------------------------ |
|
|
163
|
+
| `traceId` | string | Unique identifier for session or conversation tracking |
|
|
164
|
+
| `taskType` | string | Type of AI task being performed (e.g., "chat", "embedding") |
|
|
165
|
+
| `agent` | string | AI agent or bot identifier |
|
|
166
|
+
| `organizationName` | string | Organization or company name (used for lookup/auto-creation) |
|
|
167
|
+
| `productName` | string | Your product or feature name (used for lookup/auto-creation) |
|
|
168
|
+
| `subscriptionId` | string | Subscription plan identifier |
|
|
169
|
+
| `responseQualityScore` | number | Custom quality rating (0.0-1.0) |
|
|
170
|
+
| `subscriber.id` | string | Unique user identifier |
|
|
171
|
+
| `subscriber.email` | string | User email address |
|
|
172
|
+
| `subscriber.credential` | object | Authentication credential (`name` and `value` fields) |
|
|
125
173
|
|
|
126
174
|
**All metadata fields are optional.** For complete metadata documentation and usage examples, see:
|
|
127
175
|
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.sendToolEvent = sendToolEvent;
|
|
4
|
+
const index_js_1 = require("../config/index.js");
|
|
5
|
+
const url_builder_js_1 = require("../../utils/url-builder.js");
|
|
6
|
+
const constants_js_1 = require("../../utils/constants.js");
|
|
7
|
+
const TOOL_EVENTS_ENDPOINT = "/tool/events";
|
|
8
|
+
async function sendToolEvent(payload) {
|
|
9
|
+
const config = (0, index_js_1.getConfig)();
|
|
10
|
+
const logger = (0, index_js_1.getLogger)();
|
|
11
|
+
if (!config) {
|
|
12
|
+
logger.warn("Revenium configuration not found, skipping tool event tracking");
|
|
13
|
+
return;
|
|
14
|
+
}
|
|
15
|
+
const url = (0, url_builder_js_1.buildReveniumUrl)(config.reveniumBaseUrl || constants_js_1.DEFAULT_REVENIUM_BASE_URL, TOOL_EVENTS_ENDPOINT);
|
|
16
|
+
logger.debug("Sending tool event to Revenium", {
|
|
17
|
+
url,
|
|
18
|
+
toolId: payload.toolId,
|
|
19
|
+
transactionId: payload.transactionId,
|
|
20
|
+
operation: payload.operation,
|
|
21
|
+
durationMs: payload.durationMs,
|
|
22
|
+
success: payload.success,
|
|
23
|
+
});
|
|
24
|
+
const controller = new AbortController();
|
|
25
|
+
const timeoutId = setTimeout(() => controller.abort(), 10000);
|
|
26
|
+
const response = await fetch(url, {
|
|
27
|
+
method: "POST",
|
|
28
|
+
headers: {
|
|
29
|
+
"Content-Type": "application/json",
|
|
30
|
+
Accept: "application/json",
|
|
31
|
+
"x-api-key": config.reveniumApiKey,
|
|
32
|
+
},
|
|
33
|
+
body: JSON.stringify(payload),
|
|
34
|
+
signal: controller.signal,
|
|
35
|
+
}).finally(() => clearTimeout(timeoutId));
|
|
36
|
+
logger.debug("Tool event response", {
|
|
37
|
+
status: response.status,
|
|
38
|
+
statusText: response.statusText,
|
|
39
|
+
transactionId: payload.transactionId,
|
|
40
|
+
toolId: payload.toolId,
|
|
41
|
+
});
|
|
42
|
+
if (!response.ok) {
|
|
43
|
+
const responseText = await response.text();
|
|
44
|
+
logger.error("Tool event API error", {
|
|
45
|
+
status: response.status,
|
|
46
|
+
statusText: response.statusText,
|
|
47
|
+
body: responseText,
|
|
48
|
+
transactionId: payload.transactionId,
|
|
49
|
+
toolId: payload.toolId,
|
|
50
|
+
});
|
|
51
|
+
throw new Error(`Revenium tool event API error: ${response.status} ${response.statusText}`);
|
|
52
|
+
}
|
|
53
|
+
logger.debug("Tool event sent successfully", {
|
|
54
|
+
transactionId: payload.transactionId,
|
|
55
|
+
toolId: payload.toolId,
|
|
56
|
+
});
|
|
57
|
+
}
|
|
58
|
+
//# sourceMappingURL=tool-api-client.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"tool-api-client.js","sourceRoot":"","sources":["../../../../src/core/tracking/tool-api-client.ts"],"names":[],"mappings":";;AAOA,sCA4DC;AAlED,iDAA0D;AAC1D,+DAA8D;AAC9D,2DAAqE;AAErE,MAAM,oBAAoB,GAAG,cAAc,CAAC;AAErC,KAAK,UAAU,aAAa,CAAC,OAAyB;IAC3D,MAAM,MAAM,GAAG,IAAA,oBAAS,GAAE,CAAC;IAC3B,MAAM,MAAM,GAAG,IAAA,oBAAS,GAAE,CAAC;IAE3B,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,CAAC,IAAI,CAAC,gEAAgE,CAAC,CAAC;QAC9E,OAAO;IACT,CAAC;IAED,MAAM,GAAG,GAAG,IAAA,iCAAgB,EAC1B,MAAM,CAAC,eAAe,IAAI,wCAAyB,EACnD,oBAAoB,CACrB,CAAC;IAEF,MAAM,CAAC,KAAK,CAAC,gCAAgC,EAAE;QAC7C,GAAG;QACH,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,aAAa,EAAE,OAAO,CAAC,aAAa;QACpC,SAAS,EAAE,OAAO,CAAC,SAAS;QAC5B,UAAU,EAAE,OAAO,CAAC,UAAU;QAC9B,OAAO,EAAE,OAAO,CAAC,OAAO;KACzB,CAAC,CAAC;IAEH,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;IACzC,MAAM,SAAS,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,EAAE,KAAM,CAAC,CAAC;IAE/D,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;QAChC,MAAM,EAAE,MAAM;QACd,OAAO,EAAE;YACP,cAAc,EAAE,kBAAkB;YAClC,MAAM,EAAE,kBAAkB;YAC1B,WAAW,EAAE,MAAM,CAAC,cAAc;SACnC;QACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;QAC7B,MAAM,EAAE,UAAU,CAAC,MAAM;KAC1B,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC;IAE1C,MAAM,CAAC,KAAK,CAAC,qBAAqB,EAAE;QAClC,MAAM,EAAE,QAAQ,CAAC,MAAM;QACvB,UAAU,EAAE,QAAQ,CAAC,UAAU;QAC/B,aAAa,EAAE,OAAO,CAAC,aAAa;QACpC,MAAM,EAAE,OAAO,CAAC,MAAM;KACvB,CAAC,CAAC;IAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,MAAM,YAAY,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QAC3C,MAAM,CAAC,KAAK,CAAC,sBAAsB,EAAE;YACnC,MAAM,EAAE,QAAQ,CAAC,MAAM;YACvB,UAAU,EAAE,QAAQ,CAAC,UAAU;YAC/B,IAAI,EAAE,YAAY;YAClB,aAAa,EAAE,OAAO,CAAC,aAAa;YACpC,MAAM,EAAE,OAAO,CAAC,MAAM;SACvB,CAAC,CAAC;QACH,MAAM,IAAI,KAAK,CAAC,kCAAkC,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,8BAA8B,EAAE;QAC3C,aAAa,EAAE,OAAO,CAAC,aAAa;QACpC,MAAM,EAAE,OAAO,CAAC,MAAM;KACvB,CAAC,CAAC;AACL,CAAC"}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.setToolContext = setToolContext;
|
|
4
|
+
exports.getToolContext = getToolContext;
|
|
5
|
+
exports.clearToolContext = clearToolContext;
|
|
6
|
+
exports.runWithToolContext = runWithToolContext;
|
|
7
|
+
const async_hooks_1 = require("async_hooks");
|
|
8
|
+
const contextStorage = new async_hooks_1.AsyncLocalStorage();
|
|
9
|
+
function setToolContext(ctx) {
|
|
10
|
+
const current = contextStorage.getStore() ?? {};
|
|
11
|
+
contextStorage.enterWith({ ...current, ...ctx });
|
|
12
|
+
}
|
|
13
|
+
function getToolContext() {
|
|
14
|
+
return contextStorage.getStore() ?? {};
|
|
15
|
+
}
|
|
16
|
+
function clearToolContext() {
|
|
17
|
+
contextStorage.enterWith({});
|
|
18
|
+
}
|
|
19
|
+
function runWithToolContext(ctx, fn) {
|
|
20
|
+
const merged = { ...getToolContext(), ...ctx };
|
|
21
|
+
return contextStorage.run(merged, fn);
|
|
22
|
+
}
|
|
23
|
+
//# sourceMappingURL=tool-context.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"tool-context.js","sourceRoot":"","sources":["../../../../src/core/tracking/tool-context.ts"],"names":[],"mappings":";;AAKA,wCAGC;AAED,wCAEC;AAED,4CAEC;AAED,gDAMC;AAxBD,6CAAgD;AAGhD,MAAM,cAAc,GAAG,IAAI,+BAAiB,EAAe,CAAC;AAE5D,SAAgB,cAAc,CAAC,GAAgB;IAC7C,MAAM,OAAO,GAAG,cAAc,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC;IAChD,cAAc,CAAC,SAAS,CAAC,EAAE,GAAG,OAAO,EAAE,GAAG,GAAG,EAAE,CAAC,CAAC;AACnD,CAAC;AAED,SAAgB,cAAc;IAC5B,OAAO,cAAc,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC;AACzC,CAAC;AAED,SAAgB,gBAAgB;IAC9B,cAAc,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;AAC/B,CAAC;AAED,SAAgB,kBAAkB,CAChC,GAAgB,EAChB,EAAwB;IAExB,MAAM,MAAM,GAAG,EAAE,GAAG,cAAc,EAAE,EAAE,GAAG,GAAG,EAAE,CAAC;IAC/C,OAAO,cAAc,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AACxC,CAAC"}
|
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.meterTool = meterTool;
|
|
4
|
+
exports.reportToolCall = reportToolCall;
|
|
5
|
+
const crypto_1 = require("crypto");
|
|
6
|
+
const tool_context_js_1 = require("./tool-context.js");
|
|
7
|
+
const tool_api_client_js_1 = require("./tool-api-client.js");
|
|
8
|
+
const index_js_1 = require("../config/index.js");
|
|
9
|
+
const MIDDLEWARE_SOURCE = "revenium-openai-node";
|
|
10
|
+
function isPromise(value) {
|
|
11
|
+
return value !== null && typeof value === "object" && typeof value.then === "function";
|
|
12
|
+
}
|
|
13
|
+
function extractOutputFields(result, fields) {
|
|
14
|
+
if (typeof result !== "object" || result === null) {
|
|
15
|
+
return {};
|
|
16
|
+
}
|
|
17
|
+
const extracted = {};
|
|
18
|
+
for (const field of fields) {
|
|
19
|
+
if (field in result) {
|
|
20
|
+
extracted[field] = result[field];
|
|
21
|
+
}
|
|
22
|
+
}
|
|
23
|
+
return extracted;
|
|
24
|
+
}
|
|
25
|
+
function buildToolEventPayload(toolId, durationMs, success, metadata, errorMessage) {
|
|
26
|
+
const context = (0, tool_context_js_1.getToolContext)();
|
|
27
|
+
const transactionId = metadata?.transactionId ?? context.transactionId ?? (0, crypto_1.randomUUID)();
|
|
28
|
+
return {
|
|
29
|
+
transactionId,
|
|
30
|
+
toolId,
|
|
31
|
+
operation: metadata?.operation,
|
|
32
|
+
durationMs,
|
|
33
|
+
success,
|
|
34
|
+
timestamp: new Date().toISOString(),
|
|
35
|
+
errorMessage,
|
|
36
|
+
usageMetadata: metadata?.usageMetadata,
|
|
37
|
+
agent: metadata?.agent ?? context.agent,
|
|
38
|
+
organizationName: metadata?.organizationName ?? context.organizationName,
|
|
39
|
+
productName: metadata?.productName ?? context.productName,
|
|
40
|
+
subscriberCredential: metadata?.subscriberCredential ?? context.subscriberCredential,
|
|
41
|
+
workflowId: metadata?.workflowId ?? context.workflowId,
|
|
42
|
+
traceId: metadata?.traceId ?? context.traceId,
|
|
43
|
+
middlewareSource: MIDDLEWARE_SOURCE,
|
|
44
|
+
};
|
|
45
|
+
}
|
|
46
|
+
function dispatchToolEvent(payload) {
|
|
47
|
+
const logger = (0, index_js_1.getLogger)();
|
|
48
|
+
(0, tool_api_client_js_1.sendToolEvent)(payload)
|
|
49
|
+
.then(() => {
|
|
50
|
+
logger.debug("Tool event sent successfully", {
|
|
51
|
+
transactionId: payload.transactionId,
|
|
52
|
+
toolId: payload.toolId,
|
|
53
|
+
});
|
|
54
|
+
})
|
|
55
|
+
.catch((error) => {
|
|
56
|
+
logger.warn("Failed to send tool event", {
|
|
57
|
+
transactionId: payload.transactionId,
|
|
58
|
+
toolId: payload.toolId,
|
|
59
|
+
error: error instanceof Error ? error.message : String(error),
|
|
60
|
+
});
|
|
61
|
+
});
|
|
62
|
+
}
|
|
63
|
+
function meterTool(toolId, fn, metadata) {
|
|
64
|
+
const startTime = performance.now();
|
|
65
|
+
const handleSuccess = (result) => {
|
|
66
|
+
const durationMs = Math.round(performance.now() - startTime);
|
|
67
|
+
let finalMetadata = metadata;
|
|
68
|
+
if (metadata?.outputFields && metadata.outputFields.length > 0) {
|
|
69
|
+
const extracted = extractOutputFields(result, metadata.outputFields);
|
|
70
|
+
finalMetadata = {
|
|
71
|
+
...metadata,
|
|
72
|
+
usageMetadata: {
|
|
73
|
+
...metadata.usageMetadata,
|
|
74
|
+
...extracted,
|
|
75
|
+
},
|
|
76
|
+
};
|
|
77
|
+
}
|
|
78
|
+
const payload = buildToolEventPayload(toolId, durationMs, true, finalMetadata);
|
|
79
|
+
dispatchToolEvent(payload);
|
|
80
|
+
return result;
|
|
81
|
+
};
|
|
82
|
+
const handleError = (error) => {
|
|
83
|
+
const durationMs = Math.round(performance.now() - startTime);
|
|
84
|
+
const errorMessage = error instanceof Error ? error.message : String(error);
|
|
85
|
+
const payload = buildToolEventPayload(toolId, durationMs, false, metadata, errorMessage);
|
|
86
|
+
dispatchToolEvent(payload);
|
|
87
|
+
throw error;
|
|
88
|
+
};
|
|
89
|
+
try {
|
|
90
|
+
const result = fn();
|
|
91
|
+
if (isPromise(result)) {
|
|
92
|
+
return result.then(handleSuccess, handleError);
|
|
93
|
+
}
|
|
94
|
+
return Promise.resolve(handleSuccess(result));
|
|
95
|
+
}
|
|
96
|
+
catch (error) {
|
|
97
|
+
return Promise.reject(handleError(error));
|
|
98
|
+
}
|
|
99
|
+
}
|
|
100
|
+
function reportToolCall(toolId, report) {
|
|
101
|
+
const context = (0, tool_context_js_1.getToolContext)();
|
|
102
|
+
const transactionId = report.transactionId ?? context.transactionId ?? (0, crypto_1.randomUUID)();
|
|
103
|
+
const payload = {
|
|
104
|
+
transactionId,
|
|
105
|
+
toolId,
|
|
106
|
+
operation: report.operation,
|
|
107
|
+
durationMs: report.durationMs,
|
|
108
|
+
success: report.success,
|
|
109
|
+
timestamp: report.timestamp ?? new Date().toISOString(),
|
|
110
|
+
errorMessage: report.errorMessage,
|
|
111
|
+
usageMetadata: report.usageMetadata,
|
|
112
|
+
agent: report.agent ?? context.agent,
|
|
113
|
+
organizationName: report.organizationName ?? context.organizationName,
|
|
114
|
+
productName: report.productName ?? context.productName,
|
|
115
|
+
subscriberCredential: report.subscriberCredential ?? context.subscriberCredential,
|
|
116
|
+
workflowId: report.workflowId ?? context.workflowId,
|
|
117
|
+
traceId: report.traceId ?? context.traceId,
|
|
118
|
+
middlewareSource: MIDDLEWARE_SOURCE,
|
|
119
|
+
};
|
|
120
|
+
dispatchToolEvent(payload);
|
|
121
|
+
}
|
|
122
|
+
//# sourceMappingURL=tool-tracker.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"tool-tracker.js","sourceRoot":"","sources":["../../../../src/core/tracking/tool-tracker.ts"],"names":[],"mappings":";;AAyEA,8BA8CC;AAED,wCAuBC;AAhJD,mCAAoC;AAEpC,uDAAmD;AACnD,6DAAqD;AACrD,iDAA+C;AAE/C,MAAM,iBAAiB,GAAG,sBAAsB,CAAC;AAEjD,SAAS,SAAS,CAAI,KAAc;IAClC,OAAO,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAQ,KAAoB,CAAC,IAAI,KAAK,UAAU,CAAC;AACzG,CAAC;AAED,SAAS,mBAAmB,CAAC,MAAe,EAAE,MAAgB;IAC5D,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;QAClD,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,SAAS,GAA4B,EAAE,CAAC;IAC9C,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,IAAI,KAAK,IAAI,MAAM,EAAE,CAAC;YACpB,SAAS,CAAC,KAAK,CAAC,GAAI,MAAkC,CAAC,KAAK,CAAC,CAAC;QAChE,CAAC;IACH,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,qBAAqB,CAC5B,MAAc,EACd,UAAkB,EAClB,OAAgB,EAChB,QAAuB,EACvB,YAAqB;IAErB,MAAM,OAAO,GAAG,IAAA,gCAAc,GAAE,CAAC;IACjC,MAAM,aAAa,GAAG,QAAQ,EAAE,aAAa,IAAI,OAAO,CAAC,aAAa,IAAI,IAAA,mBAAU,GAAE,CAAC;IAEvF,OAAO;QACL,aAAa;QACb,MAAM;QACN,SAAS,EAAE,QAAQ,EAAE,SAAS;QAC9B,UAAU;QACV,OAAO;QACP,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;QACnC,YAAY;QACZ,aAAa,EAAE,QAAQ,EAAE,aAAa;QACtC,KAAK,EAAE,QAAQ,EAAE,KAAK,IAAI,OAAO,CAAC,KAAK;QACvC,gBAAgB,EAAE,QAAQ,EAAE,gBAAgB,IAAI,OAAO,CAAC,gBAAgB;QACxE,WAAW,EAAE,QAAQ,EAAE,WAAW,IAAI,OAAO,CAAC,WAAW;QACzD,oBAAoB,EAAE,QAAQ,EAAE,oBAAoB,IAAI,OAAO,CAAC,oBAAoB;QACpF,UAAU,EAAE,QAAQ,EAAE,UAAU,IAAI,OAAO,CAAC,UAAU;QACtD,OAAO,EAAE,QAAQ,EAAE,OAAO,IAAI,OAAO,CAAC,OAAO;QAC7C,gBAAgB,EAAE,iBAAiB;KACpC,CAAC;AACJ,CAAC;AAED,SAAS,iBAAiB,CAAC,OAAyB;IAClD,MAAM,MAAM,GAAG,IAAA,oBAAS,GAAE,CAAC;IAC3B,IAAA,kCAAa,EAAC,OAAO,CAAC;SACnB,IAAI,CAAC,GAAG,EAAE;QACT,MAAM,CAAC,KAAK,CAAC,8BAA8B,EAAE;YAC3C,aAAa,EAAE,OAAO,CAAC,aAAa;YACpC,MAAM,EAAE,OAAO,CAAC,MAAM;SACvB,CAAC,CAAC;IACL,CAAC,CAAC;SACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;QACf,MAAM,CAAC,IAAI,CAAC,2BAA2B,EAAE;YACvC,aAAa,EAAE,OAAO,CAAC,aAAa;YACpC,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,KAAK,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC;SAC9D,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACP,CAAC;AAED,SAAgB,SAAS,CACvB,MAAc,EACd,EAAwB,EACxB,QAAuB;IAEvB,MAAM,SAAS,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;IAEpC,MAAM,aAAa,GAAG,CAAC,MAAS,EAAK,EAAE;QACrC,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC,CAAC;QAE7D,IAAI,aAAa,GAAG,QAAQ,CAAC;QAC7B,IAAI,QAAQ,EAAE,YAAY,IAAI,QAAQ,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC/D,MAAM,SAAS,GAAG,mBAAmB,CAAC,MAAM,EAAE,QAAQ,CAAC,YAAY,CAAC,CAAC;YACrE,aAAa,GAAG;gBACd,GAAG,QAAQ;gBACX,aAAa,EAAE;oBACb,GAAG,QAAQ,CAAC,aAAa;oBACzB,GAAG,SAAS;iBACb;aACF,CAAC;QACJ,CAAC;QAED,MAAM,OAAO,GAAG,qBAAqB,CAAC,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;QAC/E,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC3B,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC;IAEF,MAAM,WAAW,GAAG,CAAC,KAAc,EAAS,EAAE;QAC5C,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC,CAAC;QAC7D,MAAM,YAAY,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC5E,MAAM,OAAO,GAAG,qBAAqB,CAAC,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAC;QACzF,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC3B,MAAM,KAAK,CAAC;IACd,CAAC,CAAC;IAEF,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,EAAE,EAAE,CAAC;QAEpB,IAAI,SAAS,CAAI,MAAM,CAAC,EAAE,CAAC;YACzB,OAAO,MAAM,CAAC,IAAI,CAAC,aAAa,EAAE,WAAW,CAAC,CAAC;QACjD,CAAC;QAED,OAAO,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC;IAChD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;IAC5C,CAAC;AACH,CAAC;AAED,SAAgB,cAAc,CAAC,MAAc,EAAE,MAAsB;IACnE,MAAM,OAAO,GAAG,IAAA,gCAAc,GAAE,CAAC;IACjC,MAAM,aAAa,GAAG,MAAM,CAAC,aAAa,IAAI,OAAO,CAAC,aAAa,IAAI,IAAA,mBAAU,GAAE,CAAC;IAEpF,MAAM,OAAO,GAAqB;QAChC,aAAa;QACb,MAAM;QACN,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,UAAU,EAAE,MAAM,CAAC,UAAU;QAC7B,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,SAAS,EAAE,MAAM,CAAC,SAAS,IAAI,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;QACvD,YAAY,EAAE,MAAM,CAAC,YAAY;QACjC,aAAa,EAAE,MAAM,CAAC,aAAa;QACnC,KAAK,EAAE,MAAM,CAAC,KAAK,IAAI,OAAO,CAAC,KAAK;QACpC,gBAAgB,EAAE,MAAM,CAAC,gBAAgB,IAAI,OAAO,CAAC,gBAAgB;QACrE,WAAW,EAAE,MAAM,CAAC,WAAW,IAAI,OAAO,CAAC,WAAW;QACtD,oBAAoB,EAAE,MAAM,CAAC,oBAAoB,IAAI,OAAO,CAAC,oBAAoB;QACjF,UAAU,EAAE,MAAM,CAAC,UAAU,IAAI,OAAO,CAAC,UAAU;QACnD,OAAO,EAAE,MAAM,CAAC,OAAO,IAAI,OAAO,CAAC,OAAO;QAC1C,gBAAgB,EAAE,iBAAiB;KACpC,CAAC;IAEF,iBAAiB,CAAC,OAAO,CAAC,CAAC;AAC7B,CAAC"}
|
package/dist/cjs/index.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* This middleware tracks OpenAI usage and sends metrics to Revenium.
|
|
6
6
|
*/
|
|
7
7
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
8
|
-
exports.getProviderMetadata = exports.validateAzureConfig = exports.hasAzureConfig = exports.detectProvider = exports.trackAudioUsageAsync = exports.trackImageUsageAsync = exports.trackEmbeddingsUsageAsync = exports.trackUsageAsync = exports.AudioSpeechInterface = exports.AudioTranslationsInterface = exports.AudioTranscriptionsInterface = exports.ImagesInterface = exports.StreamingWrapper = exports.ResponsesInterface = exports.EmbeddingsInterface = exports.CompletionsInterface = exports.ChatInterface = exports.ReveniumOpenAI = exports.Configure = exports.Reset = exports.IsInitialized = exports.GetClient = exports.Initialize = void 0;
|
|
8
|
+
exports.runWithToolContext = exports.clearToolContext = exports.getToolContext = exports.setToolContext = exports.reportToolCall = exports.meterTool = exports.getProviderMetadata = exports.validateAzureConfig = exports.hasAzureConfig = exports.detectProvider = exports.trackAudioUsageAsync = exports.trackImageUsageAsync = exports.trackEmbeddingsUsageAsync = exports.trackUsageAsync = exports.AudioSpeechInterface = exports.AudioTranslationsInterface = exports.AudioTranscriptionsInterface = exports.ImagesInterface = exports.StreamingWrapper = exports.ResponsesInterface = exports.EmbeddingsInterface = exports.CompletionsInterface = exports.ChatInterface = exports.ReveniumOpenAI = exports.Configure = exports.Reset = exports.IsInitialized = exports.GetClient = exports.Initialize = void 0;
|
|
9
9
|
// Import type augmentations to extend OpenAI types with usageMetadata
|
|
10
10
|
require("./types/openai-augmentation.js");
|
|
11
11
|
// Note: ExtendedChatCompletionCreateParams and ExtendedEmbeddingCreateParams are no longer exported
|
|
@@ -50,4 +50,12 @@ Object.defineProperty(exports, "detectProvider", { enumerable: true, get: functi
|
|
|
50
50
|
Object.defineProperty(exports, "hasAzureConfig", { enumerable: true, get: function () { return providers_1.hasAzureConfig; } });
|
|
51
51
|
Object.defineProperty(exports, "validateAzureConfig", { enumerable: true, get: function () { return providers_1.validateAzureConfig; } });
|
|
52
52
|
Object.defineProperty(exports, "getProviderMetadata", { enumerable: true, get: function () { return providers_1.getProviderMetadata; } });
|
|
53
|
+
var tool_tracker_js_1 = require("./core/tracking/tool-tracker.js");
|
|
54
|
+
Object.defineProperty(exports, "meterTool", { enumerable: true, get: function () { return tool_tracker_js_1.meterTool; } });
|
|
55
|
+
Object.defineProperty(exports, "reportToolCall", { enumerable: true, get: function () { return tool_tracker_js_1.reportToolCall; } });
|
|
56
|
+
var tool_context_js_1 = require("./core/tracking/tool-context.js");
|
|
57
|
+
Object.defineProperty(exports, "setToolContext", { enumerable: true, get: function () { return tool_context_js_1.setToolContext; } });
|
|
58
|
+
Object.defineProperty(exports, "getToolContext", { enumerable: true, get: function () { return tool_context_js_1.getToolContext; } });
|
|
59
|
+
Object.defineProperty(exports, "clearToolContext", { enumerable: true, get: function () { return tool_context_js_1.clearToolContext; } });
|
|
60
|
+
Object.defineProperty(exports, "runWithToolContext", { enumerable: true, get: function () { return tool_context_js_1.runWithToolContext; } });
|
|
53
61
|
//# sourceMappingURL=index.js.map
|
package/dist/cjs/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;AAEH,sEAAsE;AACtE,0CAAwC;AA8DxC,oGAAoG;AACpG,mGAAmG;AACnG,oFAAoF;AAEpF;;GAEG;AACH,wCAMuB;AALrB,oGAAA,UAAU,OAAA;AACV,mGAAA,SAAS,OAAA;AACT,uGAAA,aAAa,OAAA;AACb,+FAAA,KAAK,OAAA;AACL,mGAAA,SAAS,OAAA;AAGX;;GAEG;AACH,gDAW2B;AAVzB,4GAAA,cAAc,OAAA;AACd,2GAAA,aAAa,OAAA;AACb,kHAAA,oBAAoB,OAAA;AACpB,iHAAA,mBAAmB,OAAA;AACnB,gHAAA,kBAAkB,OAAA;AAClB,8GAAA,gBAAgB,OAAA;AAChB,6GAAA,eAAe,OAAA;AACf,0HAAA,4BAA4B,OAAA;AAC5B,wHAAA,0BAA0B,OAAA;AAC1B,kHAAA,oBAAoB,OAAA;AAGtB;;GAEG;AACH,4CAKyB;AAJvB,2GAAA,eAAe,OAAA;AACf,qHAAA,yBAAyB,OAAA;AACzB,gHAAA,oBAAoB,OAAA;AACpB,gHAAA,oBAAoB,OAAA;AAGtB;;GAEG;AACH,8CAK0B;AAJxB,2GAAA,cAAc,OAAA;AACd,2GAAA,cAAc,OAAA;AACd,gHAAA,mBAAmB,OAAA;AACnB,gHAAA,mBAAmB,OAAA"}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;AAEH,sEAAsE;AACtE,0CAAwC;AA8DxC,oGAAoG;AACpG,mGAAmG;AACnG,oFAAoF;AAEpF;;GAEG;AACH,wCAMuB;AALrB,oGAAA,UAAU,OAAA;AACV,mGAAA,SAAS,OAAA;AACT,uGAAA,aAAa,OAAA;AACb,+FAAA,KAAK,OAAA;AACL,mGAAA,SAAS,OAAA;AAGX;;GAEG;AACH,gDAW2B;AAVzB,4GAAA,cAAc,OAAA;AACd,2GAAA,aAAa,OAAA;AACb,kHAAA,oBAAoB,OAAA;AACpB,iHAAA,mBAAmB,OAAA;AACnB,gHAAA,kBAAkB,OAAA;AAClB,8GAAA,gBAAgB,OAAA;AAChB,6GAAA,eAAe,OAAA;AACf,0HAAA,4BAA4B,OAAA;AAC5B,wHAAA,0BAA0B,OAAA;AAC1B,kHAAA,oBAAoB,OAAA;AAGtB;;GAEG;AACH,4CAKyB;AAJvB,2GAAA,eAAe,OAAA;AACf,qHAAA,yBAAyB,OAAA;AACzB,gHAAA,oBAAoB,OAAA;AACpB,gHAAA,oBAAoB,OAAA;AAGtB;;GAEG;AACH,8CAK0B;AAJxB,2GAAA,cAAc,OAAA;AACd,2GAAA,cAAc,OAAA;AACd,gHAAA,mBAAmB,OAAA;AACnB,gHAAA,mBAAmB,OAAA;AAUrB,mEAGyC;AAFvC,4GAAA,SAAS,OAAA;AACT,iHAAA,cAAc,OAAA;AAGhB,mEAKyC;AAJvC,iHAAA,cAAc,OAAA;AACd,iHAAA,cAAc,OAAA;AACd,mHAAA,gBAAgB,OAAA;AAChB,qHAAA,kBAAkB,OAAA"}
|
package/dist/cjs/types/index.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;;;;;;;;;;;;;;AAEH,qCAAqC;AACrC,2DAAyC;AAEzC,gCAAgC;AAChC,qDAAmC;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;;;;;;;;;;;;;;AAEH,qCAAqC;AACrC,2DAAyC;AAEzC,gCAAgC;AAChC,qDAAmC;AAgGnC;;;;;GAKG;AACH,IAAY,QAKX;AALD,WAAY,QAAQ;IAClB,0BAA0B;IAC1B,6BAAiB,CAAA;IACjB,2BAA2B;IAC3B,yCAA6B,CAAA;AAC/B,CAAC,EALW,QAAQ,wBAAR,QAAQ,QAKnB;AA2MD,qDAAmC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"tool-metering.js","sourceRoot":"","sources":["../../../src/types/tool-metering.ts"],"names":[],"mappings":""}
|
|
@@ -22,13 +22,14 @@ const METADATA_FIELD_MAP = [
|
|
|
22
22
|
{ source: "taskType" },
|
|
23
23
|
{ source: "agent" },
|
|
24
24
|
{ source: "organizationId" },
|
|
25
|
+
{ source: "organizationName" },
|
|
25
26
|
{ source: "productId" },
|
|
26
|
-
{ source: "
|
|
27
|
+
{ source: "productName" },
|
|
28
|
+
{ source: "subscriber" },
|
|
27
29
|
{ source: "subscriptionId" },
|
|
28
30
|
{
|
|
29
31
|
source: "responseQualityScore",
|
|
30
32
|
transform: (value) => {
|
|
31
|
-
// Ensure quality score is between 0.0 and 1.0 (API spec requirement)
|
|
32
33
|
if (typeof value === "number")
|
|
33
34
|
return Math.max(0, Math.min(1, value));
|
|
34
35
|
return value;
|
|
@@ -42,6 +43,9 @@ const METADATA_FIELD_MAP = [
|
|
|
42
43
|
* a clean, testable way to handle metadata transformation.
|
|
43
44
|
* Subscriber object is passed through directly without transformation.
|
|
44
45
|
*
|
|
46
|
+
* Implements field migration: organizationName/productName take priority over
|
|
47
|
+
* organizationId/productId for backward compatibility.
|
|
48
|
+
*
|
|
45
49
|
* @param usageMetadata - Source metadata from request
|
|
46
50
|
* @returns Clean metadata object for payload
|
|
47
51
|
*/
|
|
@@ -49,18 +53,26 @@ function buildMetadataFields(usageMetadata) {
|
|
|
49
53
|
if (!usageMetadata)
|
|
50
54
|
return {};
|
|
51
55
|
const result = {};
|
|
52
|
-
// Process all metadata fields including nested subscriber object
|
|
53
56
|
for (const config of METADATA_FIELD_MAP) {
|
|
54
57
|
const value = usageMetadata[config.source];
|
|
55
|
-
// Skip undefined values (but allow null, empty strings, objects, etc.)
|
|
56
58
|
if (value === undefined)
|
|
57
59
|
continue;
|
|
58
|
-
//
|
|
60
|
+
// Skip deprecated fields - they'll be handled by migration logic below
|
|
61
|
+
if (config.source === "organizationId" || config.source === "productId") {
|
|
62
|
+
continue;
|
|
63
|
+
}
|
|
59
64
|
const transformedValue = config.transform ? config.transform(value) : value;
|
|
60
|
-
// Use target field name or default to source
|
|
61
65
|
const targetField = config.target || config.source;
|
|
62
66
|
result[targetField] = transformedValue;
|
|
63
67
|
}
|
|
68
|
+
// Handle field migration: new names take priority
|
|
69
|
+
if (usageMetadata.organizationName || usageMetadata.organizationId) {
|
|
70
|
+
result.organizationName =
|
|
71
|
+
usageMetadata.organizationName || usageMetadata.organizationId;
|
|
72
|
+
}
|
|
73
|
+
if (usageMetadata.productName || usageMetadata.productId) {
|
|
74
|
+
result.productName = usageMetadata.productName || usageMetadata.productId;
|
|
75
|
+
}
|
|
64
76
|
return result;
|
|
65
77
|
}
|
|
66
78
|
/**
|
|
@@ -151,9 +163,9 @@ function createLoggingContext(usageMetadata) {
|
|
|
151
163
|
traceId: usageMetadata.traceId,
|
|
152
164
|
taskType: usageMetadata.taskType,
|
|
153
165
|
subscriberId: usageMetadata.subscriber?.id,
|
|
154
|
-
subscriberEmail: sanitizedSubscriber?.email,
|
|
155
|
-
|
|
156
|
-
|
|
166
|
+
subscriberEmail: sanitizedSubscriber?.email,
|
|
167
|
+
organizationName: usageMetadata.organizationName || usageMetadata.organizationId,
|
|
168
|
+
productName: usageMetadata.productName || usageMetadata.productId,
|
|
157
169
|
agent: usageMetadata.agent,
|
|
158
170
|
};
|
|
159
171
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"metadata-builder.js","sourceRoot":"","sources":["../../../src/utils/metadata-builder.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;
|
|
1
|
+
{"version":3,"file":"metadata-builder.js","sourceRoot":"","sources":["../../../src/utils/metadata-builder.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;AAuDH,kDAkCC;AASD,4CAmDC;AAQD,sCAUC;AAQD,0CAWC;AASD,oDAuBC;AAQD,gEAmCC;AAnPD;;;;GAIG;AACH,MAAM,kBAAkB,GAA0B;IAChD,EAAE,MAAM,EAAE,SAAS,EAAE;IACrB,EAAE,MAAM,EAAE,UAAU,EAAE;IACtB,EAAE,MAAM,EAAE,OAAO,EAAE;IACnB,EAAE,MAAM,EAAE,gBAAgB,EAAE;IAC5B,EAAE,MAAM,EAAE,kBAAkB,EAAE;IAC9B,EAAE,MAAM,EAAE,WAAW,EAAE;IACvB,EAAE,MAAM,EAAE,aAAa,EAAE;IACzB,EAAE,MAAM,EAAE,YAAY,EAAE;IACxB,EAAE,MAAM,EAAE,gBAAgB,EAAE;IAC5B;QACE,MAAM,EAAE,sBAAsB;QAC9B,SAAS,EAAE,CAAC,KAAc,EAAE,EAAE;YAC5B,IAAI,OAAO,KAAK,KAAK,QAAQ;gBAAE,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;YACtE,OAAO,KAAK,CAAC;QACf,CAAC;KACF;CACF,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,SAAgB,mBAAmB,CACjC,aAA6B;IAE7B,IAAI,CAAC,aAAa;QAAE,OAAO,EAAE,CAAC;IAC9B,MAAM,MAAM,GAA4B,EAAE,CAAC;IAE3C,KAAK,MAAM,MAAM,IAAI,kBAAkB,EAAE,CAAC;QACxC,MAAM,KAAK,GAAG,aAAa,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAE3C,IAAI,KAAK,KAAK,SAAS;YAAE,SAAS;QAElC,uEAAuE;QACvE,IAAI,MAAM,CAAC,MAAM,KAAK,gBAAgB,IAAI,MAAM,CAAC,MAAM,KAAK,WAAW,EAAE,CAAC;YACxE,SAAS;QACX,CAAC;QAED,MAAM,gBAAgB,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;QAE5E,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC;QAEnD,MAAM,CAAC,WAAW,CAAC,GAAG,gBAAgB,CAAC;IACzC,CAAC;IAED,kDAAkD;IAClD,IAAI,aAAa,CAAC,gBAAgB,IAAI,aAAa,CAAC,cAAc,EAAE,CAAC;QACnE,MAAM,CAAC,gBAAgB;YACrB,aAAa,CAAC,gBAAgB,IAAI,aAAa,CAAC,cAAc,CAAC;IACnE,CAAC;IAED,IAAI,aAAa,CAAC,WAAW,IAAI,aAAa,CAAC,SAAS,EAAE,CAAC;QACzD,MAAM,CAAC,WAAW,GAAG,aAAa,CAAC,WAAW,IAAI,aAAa,CAAC,SAAS,CAAC;IAC5E,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,gBAAgB,CAC9B,aAA6B,EAC7B,iBAA0C,EAAE;IAM5C,MAAM,aAAa,GAAa,EAAE,CAAC;IACnC,MAAM,QAAQ,GAAa,EAAE,CAAC;IAE9B,IAAI,CAAC,aAAa,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAChD,OAAO;YACL,OAAO,EAAE,KAAK;YACd,aAAa,EAAE,cAA0B;YACzC,QAAQ,EAAE,CAAC,sBAAsB,CAAC;SACnC,CAAC;IACJ,CAAC;IAED,IAAI,aAAa,EAAE,CAAC;QAClB,wBAAwB;QACxB,KAAK,MAAM,KAAK,IAAI,cAAc,EAAE,CAAC;YACnC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC;gBAAE,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QAC/D,CAAC;QAED,0BAA0B;QAC1B,IAAI,aAAa,CAAC,oBAAoB,EAAE,CAAC;YACvC,MAAM,KAAK,GAAG,aAAa,CAAC,oBAAoB,CAAC;YACjD,4FAA4F;YAC5F,iCAAiC;YACjC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;gBACxD,QAAQ,CAAC,IAAI,CACX,6DAA6D,CAC9D,CAAC;YACJ,CAAC;QACH,CAAC;QAED,IACE,aAAa,CAAC,UAAU,EAAE,KAAK;YAC/B,CAAC,aAAa,CAAC,UAAU,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,EAC7C,CAAC;YACD,QAAQ,CAAC,IAAI,CACX,8DAA8D,CAC/D,CAAC;QACJ,CAAC;IACH,CAAC;IACD,OAAO;QACL,OAAO,EAAE,aAAa,CAAC,MAAM,KAAK,CAAC;QACnC,aAAa;QACb,QAAQ;KACT,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,SAAgB,aAAa,CAC3B,GAAG,OAAsC;IAEzC,MAAM,MAAM,GAAkB,EAAE,CAAC;IAEjC,wDAAwD;IACxD,KAAK,MAAM,MAAM,IAAI,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;QACvC,IAAI,MAAM;YAAE,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC5C,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;GAKG;AACH,SAAgB,eAAe,CAC7B,MAA6C;IAK7C,MAAM,EAAE,aAAa,EAAE,GAAG,WAAW,EAAE,GAAG,MAAM,CAAC;IACjD,OAAO;QACL,QAAQ,EAAE,aAAa;QACvB,WAAW,EAAE,WAAuC;KACrD,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,oBAAoB,CAClC,aAA6B;IAE7B,IAAI,CAAC,aAAa;QAAE,OAAO,EAAE,CAAC;IAE9B,uCAAuC;IACvC,MAAM,SAAS,GAAG,0BAA0B,CAAC,aAAa,CAAC,CAAC;IAC5D,MAAM,mBAAmB,GAAG,SAAS,CAAC,UAIrC,CAAC;IAEF,OAAO;QACL,OAAO,EAAE,aAAa,CAAC,OAAO;QAC9B,QAAQ,EAAE,aAAa,CAAC,QAAQ;QAChC,YAAY,EAAE,aAAa,CAAC,UAAU,EAAE,EAAE;QAC1C,eAAe,EAAE,mBAAmB,EAAE,KAAK;QAC3C,gBAAgB,EACd,aAAa,CAAC,gBAAgB,IAAI,aAAa,CAAC,cAAc;QAChE,WAAW,EAAE,aAAa,CAAC,WAAW,IAAI,aAAa,CAAC,SAAS;QACjE,KAAK,EAAE,aAAa,CAAC,KAAK;KAC3B,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,SAAgB,0BAA0B,CACxC,aAA6B;IAE7B,IAAI,CAAC,aAAa;QAAE,OAAO,EAAE,CAAC;IAE9B,oDAAoD;IACpD,MAAM,EAAE,UAAU,EAAE,GAAG,YAAY,EAAE,GAAG,aAAa,CAAC;IAEtD,MAAM,MAAM,GAA4B,EAAE,GAAG,YAAY,EAAE,CAAC;IAE5D,wCAAwC;IACxC,IAAI,UAAU,EAAE,CAAC;QACf,MAAM,mBAAmB,GAA4B,EAAE,CAAC;QAExD,IAAI,UAAU,CAAC,EAAE,EAAE,CAAC;YAClB,mBAAmB,CAAC,EAAE,GAAG,UAAU,CAAC,EAAE,CAAC;QACzC,CAAC;QAED,IAAI,UAAU,CAAC,KAAK,EAAE,CAAC;YACrB,gEAAgE;YAChE,mBAAmB,CAAC,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,OAAO,CAClD,iBAAiB,EACjB,SAAS,CACV,CAAC;QACJ,CAAC;QAED,IAAI,UAAU,CAAC,UAAU,EAAE,CAAC;YAC1B,mBAAmB,CAAC,UAAU,GAAG;gBAC/B,IAAI,EAAE,UAAU,CAAC,UAAU,CAAC,IAAI;gBAChC,KAAK,EAAE,YAAY;aACpB,CAAC;QACJ,CAAC;QACD,MAAM,CAAC,UAAU,GAAG,mBAAmB,CAAC;IAC1C,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
import { getConfig, getLogger } from "../config/index.js";
|
|
2
|
+
import { buildReveniumUrl } from "../../utils/url-builder.js";
|
|
3
|
+
import { DEFAULT_REVENIUM_BASE_URL } from "../../utils/constants.js";
|
|
4
|
+
const TOOL_EVENTS_ENDPOINT = "/tool/events";
|
|
5
|
+
export async function sendToolEvent(payload) {
|
|
6
|
+
const config = getConfig();
|
|
7
|
+
const logger = getLogger();
|
|
8
|
+
if (!config) {
|
|
9
|
+
logger.warn("Revenium configuration not found, skipping tool event tracking");
|
|
10
|
+
return;
|
|
11
|
+
}
|
|
12
|
+
const url = buildReveniumUrl(config.reveniumBaseUrl || DEFAULT_REVENIUM_BASE_URL, TOOL_EVENTS_ENDPOINT);
|
|
13
|
+
logger.debug("Sending tool event to Revenium", {
|
|
14
|
+
url,
|
|
15
|
+
toolId: payload.toolId,
|
|
16
|
+
transactionId: payload.transactionId,
|
|
17
|
+
operation: payload.operation,
|
|
18
|
+
durationMs: payload.durationMs,
|
|
19
|
+
success: payload.success,
|
|
20
|
+
});
|
|
21
|
+
const controller = new AbortController();
|
|
22
|
+
const timeoutId = setTimeout(() => controller.abort(), 10000);
|
|
23
|
+
const response = await fetch(url, {
|
|
24
|
+
method: "POST",
|
|
25
|
+
headers: {
|
|
26
|
+
"Content-Type": "application/json",
|
|
27
|
+
Accept: "application/json",
|
|
28
|
+
"x-api-key": config.reveniumApiKey,
|
|
29
|
+
},
|
|
30
|
+
body: JSON.stringify(payload),
|
|
31
|
+
signal: controller.signal,
|
|
32
|
+
}).finally(() => clearTimeout(timeoutId));
|
|
33
|
+
logger.debug("Tool event response", {
|
|
34
|
+
status: response.status,
|
|
35
|
+
statusText: response.statusText,
|
|
36
|
+
transactionId: payload.transactionId,
|
|
37
|
+
toolId: payload.toolId,
|
|
38
|
+
});
|
|
39
|
+
if (!response.ok) {
|
|
40
|
+
const responseText = await response.text();
|
|
41
|
+
logger.error("Tool event API error", {
|
|
42
|
+
status: response.status,
|
|
43
|
+
statusText: response.statusText,
|
|
44
|
+
body: responseText,
|
|
45
|
+
transactionId: payload.transactionId,
|
|
46
|
+
toolId: payload.toolId,
|
|
47
|
+
});
|
|
48
|
+
throw new Error(`Revenium tool event API error: ${response.status} ${response.statusText}`);
|
|
49
|
+
}
|
|
50
|
+
logger.debug("Tool event sent successfully", {
|
|
51
|
+
transactionId: payload.transactionId,
|
|
52
|
+
toolId: payload.toolId,
|
|
53
|
+
});
|
|
54
|
+
}
|
|
55
|
+
//# sourceMappingURL=tool-api-client.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"tool-api-client.js","sourceRoot":"","sources":["../../../../src/core/tracking/tool-api-client.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,EAAE,yBAAyB,EAAE,MAAM,0BAA0B,CAAC;AAErE,MAAM,oBAAoB,GAAG,cAAc,CAAC;AAE5C,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,OAAyB;IAC3D,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;IAC3B,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;IAE3B,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,CAAC,IAAI,CAAC,gEAAgE,CAAC,CAAC;QAC9E,OAAO;IACT,CAAC;IAED,MAAM,GAAG,GAAG,gBAAgB,CAC1B,MAAM,CAAC,eAAe,IAAI,yBAAyB,EACnD,oBAAoB,CACrB,CAAC;IAEF,MAAM,CAAC,KAAK,CAAC,gCAAgC,EAAE;QAC7C,GAAG;QACH,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,aAAa,EAAE,OAAO,CAAC,aAAa;QACpC,SAAS,EAAE,OAAO,CAAC,SAAS;QAC5B,UAAU,EAAE,OAAO,CAAC,UAAU;QAC9B,OAAO,EAAE,OAAO,CAAC,OAAO;KACzB,CAAC,CAAC;IAEH,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;IACzC,MAAM,SAAS,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,EAAE,KAAM,CAAC,CAAC;IAE/D,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;QAChC,MAAM,EAAE,MAAM;QACd,OAAO,EAAE;YACP,cAAc,EAAE,kBAAkB;YAClC,MAAM,EAAE,kBAAkB;YAC1B,WAAW,EAAE,MAAM,CAAC,cAAc;SACnC;QACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;QAC7B,MAAM,EAAE,UAAU,CAAC,MAAM;KAC1B,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC;IAE1C,MAAM,CAAC,KAAK,CAAC,qBAAqB,EAAE;QAClC,MAAM,EAAE,QAAQ,CAAC,MAAM;QACvB,UAAU,EAAE,QAAQ,CAAC,UAAU;QAC/B,aAAa,EAAE,OAAO,CAAC,aAAa;QACpC,MAAM,EAAE,OAAO,CAAC,MAAM;KACvB,CAAC,CAAC;IAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,MAAM,YAAY,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QAC3C,MAAM,CAAC,KAAK,CAAC,sBAAsB,EAAE;YACnC,MAAM,EAAE,QAAQ,CAAC,MAAM;YACvB,UAAU,EAAE,QAAQ,CAAC,UAAU;YAC/B,IAAI,EAAE,YAAY;YAClB,aAAa,EAAE,OAAO,CAAC,aAAa;YACpC,MAAM,EAAE,OAAO,CAAC,MAAM;SACvB,CAAC,CAAC;QACH,MAAM,IAAI,KAAK,CAAC,kCAAkC,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,8BAA8B,EAAE;QAC3C,aAAa,EAAE,OAAO,CAAC,aAAa;QACpC,MAAM,EAAE,OAAO,CAAC,MAAM;KACvB,CAAC,CAAC;AACL,CAAC"}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import { AsyncLocalStorage } from "async_hooks";
|
|
2
|
+
const contextStorage = new AsyncLocalStorage();
|
|
3
|
+
export function setToolContext(ctx) {
|
|
4
|
+
const current = contextStorage.getStore() ?? {};
|
|
5
|
+
contextStorage.enterWith({ ...current, ...ctx });
|
|
6
|
+
}
|
|
7
|
+
export function getToolContext() {
|
|
8
|
+
return contextStorage.getStore() ?? {};
|
|
9
|
+
}
|
|
10
|
+
export function clearToolContext() {
|
|
11
|
+
contextStorage.enterWith({});
|
|
12
|
+
}
|
|
13
|
+
export function runWithToolContext(ctx, fn) {
|
|
14
|
+
const merged = { ...getToolContext(), ...ctx };
|
|
15
|
+
return contextStorage.run(merged, fn);
|
|
16
|
+
}
|
|
17
|
+
//# sourceMappingURL=tool-context.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"tool-context.js","sourceRoot":"","sources":["../../../../src/core/tracking/tool-context.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAGhD,MAAM,cAAc,GAAG,IAAI,iBAAiB,EAAe,CAAC;AAE5D,MAAM,UAAU,cAAc,CAAC,GAAgB;IAC7C,MAAM,OAAO,GAAG,cAAc,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC;IAChD,cAAc,CAAC,SAAS,CAAC,EAAE,GAAG,OAAO,EAAE,GAAG,GAAG,EAAE,CAAC,CAAC;AACnD,CAAC;AAED,MAAM,UAAU,cAAc;IAC5B,OAAO,cAAc,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC;AACzC,CAAC;AAED,MAAM,UAAU,gBAAgB;IAC9B,cAAc,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;AAC/B,CAAC;AAED,MAAM,UAAU,kBAAkB,CAChC,GAAgB,EAChB,EAAwB;IAExB,MAAM,MAAM,GAAG,EAAE,GAAG,cAAc,EAAE,EAAE,GAAG,GAAG,EAAE,CAAC;IAC/C,OAAO,cAAc,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AACxC,CAAC"}
|