@copilotkit/shared 2.0.0-rc.7 → 2.0.0-rc.9

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.
Files changed (100) hide show
  1. package/README.md +3 -14
  2. package/dist/index.cjs +1 -2
  3. package/dist/index.cjs.map +1 -1
  4. package/dist/index.d.cts +3 -4
  5. package/dist/index.d.cts.map +1 -1
  6. package/dist/index.d.mts +3 -4
  7. package/dist/index.d.mts.map +1 -1
  8. package/dist/index.mjs +3 -3
  9. package/dist/index.mjs.map +1 -1
  10. package/dist/index.umd.js +25 -95
  11. package/dist/index.umd.js.map +1 -1
  12. package/dist/package.cjs +1 -1
  13. package/dist/package.mjs +1 -1
  14. package/dist/standard-schema.cjs +20 -7
  15. package/dist/standard-schema.cjs.map +1 -1
  16. package/dist/standard-schema.d.cts +15 -16
  17. package/dist/standard-schema.d.cts.map +1 -1
  18. package/dist/standard-schema.d.mts +15 -16
  19. package/dist/standard-schema.d.mts.map +1 -1
  20. package/dist/standard-schema.mjs +20 -8
  21. package/dist/standard-schema.mjs.map +1 -1
  22. package/dist/telemetry/telemetry-disabled.cjs +0 -5
  23. package/dist/telemetry/telemetry-disabled.cjs.map +1 -1
  24. package/dist/telemetry/telemetry-disabled.d.cts +0 -5
  25. package/dist/telemetry/telemetry-disabled.d.cts.map +1 -1
  26. package/dist/telemetry/telemetry-disabled.d.mts +0 -5
  27. package/dist/telemetry/telemetry-disabled.d.mts.map +1 -1
  28. package/dist/telemetry/telemetry-disabled.mjs +0 -5
  29. package/dist/telemetry/telemetry-disabled.mjs.map +1 -1
  30. package/dist/utils/index.d.cts +1 -1
  31. package/dist/utils/index.d.mts +1 -1
  32. package/dist/utils/index.mjs +1 -1
  33. package/dist/utils/json-schema.cjs +0 -79
  34. package/dist/utils/json-schema.cjs.map +1 -1
  35. package/dist/utils/json-schema.d.cts +1 -4
  36. package/dist/utils/json-schema.d.cts.map +1 -1
  37. package/dist/utils/json-schema.d.mts +1 -4
  38. package/dist/utils/json-schema.d.mts.map +1 -1
  39. package/dist/utils/json-schema.mjs +1 -78
  40. package/dist/utils/json-schema.mjs.map +1 -1
  41. package/package.json +7 -28
  42. package/src/__tests__/root-entry-browser-safety.test.ts +5 -7
  43. package/src/__tests__/standard-schema.test.ts +61 -101
  44. package/src/index.ts +3 -16
  45. package/src/standard-schema.ts +24 -27
  46. package/src/telemetry/telemetry-disabled.ts +0 -5
  47. package/src/utils/__tests__/json-schema.test.ts +3 -479
  48. package/src/utils/json-schema.ts +1 -152
  49. package/tsdown.config.ts +2 -10
  50. package/dist/event-transforms/index.cjs +0 -15
  51. package/dist/event-transforms/index.d.cts +0 -4
  52. package/dist/event-transforms/index.d.mts +0 -4
  53. package/dist/event-transforms/index.mjs +0 -5
  54. package/dist/event-transforms/open-generative-ui-middleware.cjs +0 -286
  55. package/dist/event-transforms/open-generative-ui-middleware.cjs.map +0 -1
  56. package/dist/event-transforms/open-generative-ui-middleware.d.cts +0 -60
  57. package/dist/event-transforms/open-generative-ui-middleware.d.cts.map +0 -1
  58. package/dist/event-transforms/open-generative-ui-middleware.d.mts +0 -60
  59. package/dist/event-transforms/open-generative-ui-middleware.d.mts.map +0 -1
  60. package/dist/event-transforms/open-generative-ui-middleware.mjs +0 -283
  61. package/dist/event-transforms/open-generative-ui-middleware.mjs.map +0 -1
  62. package/dist/event-transforms/recorded-events.cjs +0 -59
  63. package/dist/event-transforms/recorded-events.cjs.map +0 -1
  64. package/dist/event-transforms/recorded-events.d.cts +0 -23
  65. package/dist/event-transforms/recorded-events.d.cts.map +0 -1
  66. package/dist/event-transforms/recorded-events.d.mts +0 -23
  67. package/dist/event-transforms/recorded-events.d.mts.map +0 -1
  68. package/dist/event-transforms/recorded-events.mjs +0 -58
  69. package/dist/event-transforms/recorded-events.mjs.map +0 -1
  70. package/dist/telemetry/events.d.cts +0 -72
  71. package/dist/telemetry/events.d.cts.map +0 -1
  72. package/dist/telemetry/events.d.mts +0 -72
  73. package/dist/telemetry/events.d.mts.map +0 -1
  74. package/dist/telemetry/index.cjs +0 -18
  75. package/dist/telemetry/index.d.cts +0 -5
  76. package/dist/telemetry/index.d.mts +0 -5
  77. package/dist/telemetry/index.mjs +0 -6
  78. package/dist/telemetry/telemetry-client.cjs +0 -165
  79. package/dist/telemetry/telemetry-client.cjs.map +0 -1
  80. package/dist/telemetry/telemetry-client.d.cts +0 -87
  81. package/dist/telemetry/telemetry-client.d.cts.map +0 -1
  82. package/dist/telemetry/telemetry-client.d.mts +0 -87
  83. package/dist/telemetry/telemetry-client.d.mts.map +0 -1
  84. package/dist/telemetry/telemetry-client.mjs +0 -164
  85. package/dist/telemetry/telemetry-client.mjs.map +0 -1
  86. package/dist/telemetry/utils.cjs +0 -14
  87. package/dist/telemetry/utils.cjs.map +0 -1
  88. package/dist/telemetry/utils.mjs +0 -13
  89. package/dist/telemetry/utils.mjs.map +0 -1
  90. package/src/__tests__/zod-regression.test.ts +0 -319
  91. package/src/event-transforms/index.ts +0 -5
  92. package/src/event-transforms/open-generative-ui-middleware.ts +0 -392
  93. package/src/event-transforms/recorded-events.test.ts +0 -166
  94. package/src/event-transforms/recorded-events.ts +0 -74
  95. package/src/telemetry/events.ts +0 -68
  96. package/src/telemetry/index.ts +0 -9
  97. package/src/telemetry/telemetry-blank-license-identity.test.ts +0 -128
  98. package/src/telemetry/telemetry-client.test.ts +0 -798
  99. package/src/telemetry/telemetry-client.ts +0 -328
  100. package/src/telemetry/utils.ts +0 -15
@@ -1,328 +0,0 @@
1
- import { Analytics } from "@segment/analytics-node";
2
- import type { AnalyticsEvents } from "./events";
3
- import { flattenObject } from "./utils";
4
- import { randomUUID } from "../utils/random-id";
5
- import {
6
- firstNonBlankTelemetryId,
7
- lambdaClient,
8
- parseAndWarnTelemetryId,
9
- } from "./lambda-client";
10
- import {
11
- computeSamplingMeta,
12
- TELEMETRY_EMITTER_V1,
13
- TELEMETRY_SURFACE_V1,
14
- UNSAMPLED_RATE,
15
- } from "./sampling";
16
- import { isTelemetryDisabled } from "./telemetry-disabled";
17
-
18
- export { isTelemetryDisabled };
19
-
20
- /** Transport identity and sampling authority resolved for one runtime. */
21
- export interface TelemetryIdentity {
22
- telemetryId?: string;
23
- licenseToken?: string;
24
- }
25
-
26
- /** Capture-only telemetry client bound to one runtime identity. */
27
- export interface TelemetryCapture {
28
- capture<K extends keyof AnalyticsEvents>(
29
- event: K,
30
- properties: AnalyticsEvents[K],
31
- ): Promise<void>;
32
- }
33
-
34
- interface ResolvedTelemetryIdentity {
35
- telemetryId: string | null;
36
- licenseToken: string | null;
37
- licenseTelemetryId: string | null;
38
- }
39
-
40
- export class TelemetryClient {
41
- segment: Analytics | undefined;
42
- globalProperties: Record<string, any> = {};
43
- cloudConfiguration: { publicApiKey: string; baseUrl: string } | null = null;
44
- // EIP / Intelligence license token (Ed25519-signed JWT). The lambda
45
- // client decodes its payload to extract telemetry_id. Customer API
46
- // keys are NOT used here — they flow only into Segment.
47
- private licenseToken: string | null = null;
48
- // Standalone analytics identity. This stays separate from the effective
49
- // identity so legacy callers continue sending only their license token to
50
- // the Lambda transport.
51
- private telemetryId: string | null = null;
52
- // License-derived identity used only as sampling authority. A standalone
53
- // telemetry id remains a transport claim and does not bypass the
54
- // Segment gate.
55
- private licenseTelemetryId: string | null = null;
56
- packageName: string;
57
- packageVersion: string;
58
- private telemetryDisabled: boolean = false;
59
- // Client-side sampling rate for anonymous events on the Segment wire
60
- // only. The lambda sink is ours and takes every event; Segment is
61
- // billed per event, so the anonymous population stays capped there.
62
- // Identified events (those whose license token yielded a telemetry_id)
63
- // bypass the gate on both wires.
64
- private segmentSampleRate: number = 0.05;
65
- private anonymousId = `anon_${randomUUID()}`;
66
-
67
- constructor({
68
- packageName,
69
- packageVersion,
70
- telemetryDisabled,
71
- telemetryBaseUrl,
72
- sampleRate,
73
- }: {
74
- packageName: string;
75
- packageVersion: string;
76
- telemetryDisabled?: boolean;
77
- telemetryBaseUrl?: string;
78
- // Anonymous sampling rate for the Segment wire. Named without the
79
- // prefix for backward compatibility; the lambda sink ignores it.
80
- sampleRate?: number;
81
- }) {
82
- this.packageName = packageName;
83
- this.packageVersion = packageVersion;
84
- this.telemetryDisabled = telemetryDisabled || isTelemetryDisabled();
85
-
86
- if (this.telemetryDisabled) {
87
- return;
88
- }
89
-
90
- this.setSampleRate(sampleRate);
91
-
92
- // eslint-disable-next-line
93
- const writeKey =
94
- process.env.COPILOTKIT_SEGMENT_WRITE_KEY ||
95
- "n7XAZtQCGS2v1vvBy3LgBCv2h3Y8whja";
96
-
97
- this.segment = new Analytics({
98
- writeKey,
99
- });
100
-
101
- this.setGlobalProperties({
102
- "copilotkit.package.name": packageName,
103
- "copilotkit.package.version": packageVersion,
104
- });
105
- }
106
-
107
- private shouldSendToSegment() {
108
- const randomNumber = Math.random();
109
- return randomNumber < this.segmentSampleRate;
110
- }
111
-
112
- async capture<K extends keyof AnalyticsEvents>(
113
- event: K,
114
- properties: AnalyticsEvents[K],
115
- ): Promise<void> {
116
- return this.captureWithIdentity(event, properties, {
117
- telemetryId: this.telemetryId,
118
- licenseToken: this.licenseToken,
119
- licenseTelemetryId: this.licenseTelemetryId,
120
- });
121
- }
122
-
123
- private async captureWithIdentity<K extends keyof AnalyticsEvents>(
124
- event: K,
125
- properties: AnalyticsEvents[K],
126
- identity: ResolvedTelemetryIdentity,
127
- ): Promise<void> {
128
- // Re-read the environment: an opt-out set after import (for example a
129
- // dotenv call below the imports) must still stop events.
130
- if (this.telemetryDisabled || isTelemetryDisabled()) {
131
- return;
132
- }
133
-
134
- // The two wires are gated separately. The lambda sink takes every
135
- // event: it is CopilotKit-owned, so anonymous volume costs nothing
136
- // per event there and a real count beats one extrapolated from 5% of
137
- // the population. Segment is billed per event, so it keeps the gate —
138
- // callers without license-derived sampling authority are dropped from
139
- // that copy at segmentSampleRate. Legacy license tokens with a
140
- // telemetry_id send on both wires: the volume is bounded by
141
- // paying-customer count and full fidelity per identified customer is
142
- // worth the marginal cost.
143
- const sendToSegment =
144
- Boolean(identity.licenseTelemetryId) || this.shouldSendToSegment();
145
-
146
- // Sampling metadata is computed in ./sampling so this client and the
147
- // v2 runtime client can't drift apart again — see the note there.
148
- // One call per wire, because the two wires were gated differently and
149
- // a shared block would overweight the lambda copy by 1/sampleRate.
150
- const lambdaSamplingMeta = computeSamplingMeta({
151
- telemetryId: identity.licenseTelemetryId,
152
- sampleRate: UNSAMPLED_RATE,
153
- });
154
- const segmentSamplingMeta = computeSamplingMeta({
155
- telemetryId: identity.licenseTelemetryId,
156
- sampleRate: this.segmentSampleRate,
157
- });
158
-
159
- // Everything below travels identically on both copies of this event.
160
- // The event id is what makes the dual-write dedupable downstream:
161
- // one capture() produces one id, stamped on the lambda copy and the
162
- // Segment copy alike, so consumers no longer have to infer the
163
- // duplication from $lib or from which fields happen to be present
164
- // (OSS-1019).
165
- const eventMeta = {
166
- telemetry_emitter: TELEMETRY_EMITTER_V1,
167
- telemetry_surface: TELEMETRY_SURFACE_V1,
168
- telemetry_event_id: randomUUID(),
169
- };
170
-
171
- const flattenedProperties = flattenObject(properties);
172
- const propertiesWithGlobal: Record<string, any> = {
173
- ...this.globalProperties,
174
- ...eventMeta,
175
- ...segmentSamplingMeta,
176
- telemetry_transport: "segment",
177
- ...flattenedProperties,
178
- };
179
- const orderedPropertiesWithGlobal = Object.keys(propertiesWithGlobal)
180
- .sort()
181
- .reduce(
182
- (obj, key) => {
183
- obj[key] = propertiesWithGlobal[key];
184
- return obj;
185
- },
186
- {} as Record<string, any>,
187
- );
188
-
189
- await lambdaClient.send({
190
- event,
191
- properties: flattenedProperties,
192
- globalProperties: {
193
- ...this.globalProperties,
194
- ...eventMeta,
195
- ...lambdaSamplingMeta,
196
- telemetry_transport: "lambda",
197
- },
198
- packageName: this.packageName,
199
- packageVersion: this.packageVersion,
200
- telemetryId: identity.telemetryId ?? undefined,
201
- licenseToken: identity.licenseToken ?? undefined,
202
- });
203
-
204
- if (this.segment && sendToSegment) {
205
- this.segment.track({
206
- anonymousId: this.anonymousId,
207
- event,
208
- properties: { ...orderedPropertiesWithGlobal },
209
- });
210
- }
211
- }
212
-
213
- setGlobalProperties(properties: Record<string, any>) {
214
- const flattenedProperties = flattenObject(properties);
215
- this.globalProperties = {
216
- ...this.globalProperties,
217
- ...flattenedProperties,
218
- };
219
- }
220
-
221
- setCloudConfiguration(properties: { publicApiKey: string; baseUrl: string }) {
222
- this.cloudConfiguration = properties;
223
-
224
- this.setGlobalProperties({
225
- cloud: {
226
- publicApiKey: properties.publicApiKey,
227
- baseUrl: properties.baseUrl,
228
- },
229
- });
230
- }
231
-
232
- /**
233
- * Atomically configure standalone, legacy, or anonymous telemetry identity.
234
- *
235
- * A standalone id takes transport precedence over a supplied legacy license
236
- * token, but only a license-derived id grants sampling authority. Neither
237
- * value is added to event properties.
238
- *
239
- * @param identity - One standalone id, one legacy license token, or neither.
240
- */
241
- setTelemetryIdentity(identity: {
242
- telemetryId?: string;
243
- licenseToken?: string;
244
- }): void {
245
- const resolvedIdentity = this.resolveTelemetryIdentity(identity);
246
- this.telemetryId = resolvedIdentity.telemetryId;
247
- this.licenseToken = resolvedIdentity.licenseToken;
248
- this.licenseTelemetryId = resolvedIdentity.licenseTelemetryId;
249
- }
250
-
251
- /**
252
- * Configure legacy license-derived telemetry identity.
253
- *
254
- * @param licenseToken - License token whose telemetry claim identifies sends.
255
- */
256
- setLicenseToken(licenseToken: string) {
257
- this.setTelemetryIdentity({ licenseToken });
258
- }
259
-
260
- /**
261
- * Create an immutable capture scope for one runtime.
262
- *
263
- * The scope shares this client's sinks, process-wide opt-out, global
264
- * properties, and Segment sampling rate, but snapshots transport identity and
265
- * license-derived sampling authority. Constructing another runtime cannot
266
- * rewrite an existing scope.
267
- *
268
- * @param identity - The runtime's construction-time telemetry identity.
269
- * @returns A capture-only client bound to that identity.
270
- */
271
- createScope(identity: TelemetryIdentity): TelemetryCapture {
272
- const resolvedIdentity = this.resolveTelemetryIdentity(identity);
273
-
274
- return {
275
- capture: <K extends keyof AnalyticsEvents>(
276
- event: K,
277
- properties: AnalyticsEvents[K],
278
- ) => this.captureWithIdentity(event, properties, resolvedIdentity),
279
- };
280
- }
281
-
282
- private resolveTelemetryIdentity(
283
- identity: TelemetryIdentity,
284
- ): ResolvedTelemetryIdentity {
285
- const telemetryId = firstNonBlankTelemetryId(identity.telemetryId);
286
- if (telemetryId !== undefined) {
287
- return {
288
- telemetryId,
289
- licenseToken: null,
290
- licenseTelemetryId: null,
291
- };
292
- }
293
-
294
- return {
295
- telemetryId: null,
296
- licenseToken: identity.licenseToken ?? null,
297
- licenseTelemetryId: identity.licenseToken
298
- ? parseAndWarnTelemetryId(identity.licenseToken)
299
- : null,
300
- };
301
- }
302
-
303
- private setSampleRate(sampleRate: number | undefined) {
304
- let _sampleRate: number;
305
-
306
- _sampleRate = sampleRate ?? 0.05;
307
-
308
- // eslint-disable-next-line
309
- if (process.env.COPILOTKIT_TELEMETRY_SAMPLE_RATE) {
310
- // eslint-disable-next-line
311
- _sampleRate = parseFloat(process.env.COPILOTKIT_TELEMETRY_SAMPLE_RATE);
312
- }
313
-
314
- // Number.isNaN guards against parseFloat("nonsense") slipping past the
315
- // range check (all NaN comparisons are false), which would silently
316
- // drop every anonymous Segment event with no signal.
317
- if (Number.isNaN(_sampleRate) || _sampleRate < 0 || _sampleRate > 1) {
318
- throw new Error("Sample rate must be between 0 and 1");
319
- }
320
-
321
- this.segmentSampleRate = _sampleRate;
322
- // Per-event sampling metadata (sampleRate/sampleRateAdjustmentFactor/
323
- // sampleWeight) is computed per capture() in ./sampling, once per
324
- // wire. Only license-authorized events get effectiveSampleRate=1 on
325
- // the Segment copy; standalone transport identity stays in the
326
- // sampled population there. The lambda copy is always unsampled.
327
- }
328
- }
@@ -1,15 +0,0 @@
1
- export function flattenObject(
2
- obj: Record<string, any>,
3
- parentKey = "",
4
- res: Record<string, any> = {},
5
- ): Record<string, any> {
6
- for (let key in obj) {
7
- const propName = parentKey ? `${parentKey}.${key}` : key;
8
- if (typeof obj[key] === "object" && obj[key] !== null) {
9
- flattenObject(obj[key], propName, res);
10
- } else {
11
- res[propName] = obj[key];
12
- }
13
- }
14
- return res;
15
- }