@copilotkit/shared 0.38.0-mme-alpha.1 → 1.0.0-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (46) hide show
  1. package/.turbo/turbo-build.log +62 -31
  2. package/CHANGELOG.md +12 -6
  3. package/dist/chunk-3VA36BKL.mjs +122 -0
  4. package/dist/chunk-3VA36BKL.mjs.map +1 -0
  5. package/dist/chunk-6QGXWNS5.mjs +34 -0
  6. package/dist/chunk-6QGXWNS5.mjs.map +1 -0
  7. package/dist/chunk-P7STFMPO.mjs +1 -0
  8. package/dist/chunk-P7STFMPO.mjs.map +1 -0
  9. package/dist/index.d.ts +3 -0
  10. package/dist/index.js +156 -0
  11. package/dist/index.js.map +1 -1
  12. package/dist/index.mjs +15 -9
  13. package/dist/telemetry/events.d.ts +9 -0
  14. package/dist/telemetry/events.js +19 -0
  15. package/dist/telemetry/events.js.map +1 -0
  16. package/dist/telemetry/events.mjs +1 -0
  17. package/dist/telemetry/events.mjs.map +1 -0
  18. package/dist/telemetry/index.d.ts +3 -0
  19. package/dist/telemetry/index.js +184 -0
  20. package/dist/telemetry/index.js.map +1 -0
  21. package/dist/telemetry/index.mjs +9 -0
  22. package/dist/telemetry/index.mjs.map +1 -0
  23. package/dist/telemetry/security-check.d.ts +2 -0
  24. package/dist/telemetry/security-check.js +2 -0
  25. package/dist/telemetry/security-check.js.map +1 -0
  26. package/dist/telemetry/security-check.mjs +1 -0
  27. package/dist/telemetry/security-check.mjs.map +1 -0
  28. package/dist/telemetry/telemetry-client.d.ts +36 -0
  29. package/dist/telemetry/telemetry-client.js +182 -0
  30. package/dist/telemetry/telemetry-client.js.map +1 -0
  31. package/dist/telemetry/telemetry-client.mjs +8 -0
  32. package/dist/telemetry/telemetry-client.mjs.map +1 -0
  33. package/dist/telemetry/utils.d.ts +8 -0
  34. package/dist/telemetry/utils.js +69 -0
  35. package/dist/telemetry/utils.js.map +1 -0
  36. package/dist/telemetry/utils.mjs +9 -0
  37. package/dist/telemetry/utils.mjs.map +1 -0
  38. package/dist/types/index.mjs +1 -1
  39. package/dist/utils/index.mjs +3 -3
  40. package/package.json +7 -5
  41. package/src/index.ts +1 -0
  42. package/src/telemetry/events.ts +7 -0
  43. package/src/telemetry/index.ts +1 -0
  44. package/src/telemetry/security-check.ts +0 -0
  45. package/src/telemetry/telemetry-client.ts +164 -0
  46. package/src/telemetry/utils.ts +39 -0
@@ -1,8 +1,8 @@
1
1
 
2
- > @copilotkit/shared@0.38.0-mme-alpha.1 build /home/runner/work/CopilotKit/CopilotKit/CopilotKit/packages/shared
2
+ > @copilotkit/shared@1.0.0-beta.1 build /home/runner/work/CopilotKit/CopilotKit/CopilotKit/packages/shared
3
3
  > tsup --clean
4
4
 
5
- CLI Building entry: src/index.ts, src/constants/index.ts, src/types/action.ts, src/types/annotated-function.ts, src/types/copilot-cloud-config.ts, src/types/index.ts, src/types/openai-assistant.ts, src/utils/annotated-function.ts, src/utils/index.ts, src/utils/json-schema.ts
5
+ CLI Building entry: src/index.ts, src/constants/index.ts, src/telemetry/events.ts, src/telemetry/index.ts, src/telemetry/security-check.ts, src/telemetry/telemetry-client.ts, src/telemetry/utils.ts, src/types/action.ts, src/types/annotated-function.ts, src/types/copilot-cloud-config.ts, src/types/index.ts, src/types/openai-assistant.ts, src/utils/annotated-function.ts, src/utils/index.ts, src/utils/json-schema.ts
6
6
  CLI Using tsconfig: tsconfig.json
7
7
  CLI tsup v6.7.0
8
8
  CLI Using tsup config: /home/runner/work/CopilotKit/CopilotKit/CopilotKit/packages/shared/tsup.config.ts
@@ -10,69 +10,95 @@
10
10
  CLI Cleaning output folder
11
11
  ESM Build start
12
12
  CJS Build start
13
+ CJS dist/utils/annotated-function.js 5.84 KB
14
+ CJS dist/index.js 14.35 KB
13
15
  CJS dist/constants/index.js 1.65 KB
14
- CJS dist/index.js 8.66 KB
16
+ CJS dist/telemetry/events.js 805.00 B
17
+ CJS dist/telemetry/index.js 6.72 KB
18
+ CJS dist/telemetry/security-check.js 56.00 B
19
+ CJS dist/telemetry/telemetry-client.js 6.73 KB
20
+ CJS dist/telemetry/utils.js 3.14 KB
15
21
  CJS dist/types/action.js 801.00 B
16
- CJS dist/utils/annotated-function.js 5.84 KB
17
22
  CJS dist/types/annotated-function.js 849.00 B
18
23
  CJS dist/types/copilot-cloud-config.js 857.00 B
19
24
  CJS dist/types/index.js 797.00 B
20
25
  CJS dist/types/openai-assistant.js 841.00 B
21
26
  CJS dist/utils/index.js 8.03 KB
22
27
  CJS dist/utils/json-schema.js 3.23 KB
28
+ CJS dist/utils/annotated-function.js.map 8.45 KB
29
+ CJS dist/index.js.map 22.36 KB
23
30
  CJS dist/constants/index.js.map 564.00 B
24
- CJS dist/index.js.map 13.67 KB
31
+ CJS dist/telemetry/events.js.map 330.00 B
32
+ CJS dist/telemetry/index.js.map 8.84 KB
33
+ CJS dist/telemetry/security-check.js.map 71.00 B
34
+ CJS dist/telemetry/telemetry-client.js.map 8.77 KB
35
+ CJS dist/telemetry/utils.js.map 2.00 KB
25
36
  CJS dist/types/action.js.map 4.84 KB
26
- CJS dist/utils/annotated-function.js.map 8.45 KB
27
37
  CJS dist/types/annotated-function.js.map 871.00 B
28
38
  CJS dist/types/copilot-cloud-config.js.map 356.00 B
29
39
  CJS dist/types/index.js.map 277.00 B
30
40
  CJS dist/types/openai-assistant.js.map 1.53 KB
31
41
  CJS dist/utils/index.js.map 13.23 KB
32
42
  CJS dist/utils/json-schema.js.map 4.75 KB
33
- CJS ⚡️ Build success in 84ms
34
- ESM dist/utils/index.mjs 437.00 B
35
- ESM dist/utils/json-schema.mjs 155.00 B
36
- ESM dist/index.mjs 858.00 B
43
+ CJS ⚡️ Build success in 112ms
44
+ ESM dist/index.mjs 997.00 B
45
+ ESM dist/constants/index.mjs 315.00 B
46
+ ESM dist/telemetry/events.mjs 35.00 B
47
+ ESM dist/types/action.mjs 67.00 B
48
+ ESM dist/chunk-BANDZXMP.mjs 43.00 B
49
+ ESM dist/chunk-YBHX4Y25.mjs 43.00 B
50
+ ESM dist/chunk-MSUB6DGR.mjs 43.00 B
51
+ ESM dist/chunk-IAFBVORQ.mjs 43.00 B
37
52
  ESM dist/chunk-CYDWEPFL.mjs 43.00 B
53
+ ESM dist/chunk-S4HGLK2E.mjs 4.62 KB
38
54
  ESM dist/chunk-CIPF7PMC.mjs 2.20 KB
39
- ESM dist/constants/index.mjs 315.00 B
40
55
  ESM dist/chunk-2VLE6D3W.mjs 468.00 B
41
- ESM dist/types/action.mjs 67.00 B
56
+ ESM dist/telemetry/index.mjs 187.00 B
57
+ ESM dist/chunk-P7STFMPO.mjs 43.00 B
58
+ ESM dist/telemetry/security-check.mjs 43.00 B
59
+ ESM dist/telemetry/telemetry-client.mjs 166.00 B
60
+ ESM dist/chunk-3VA36BKL.mjs 3.67 KB
61
+ ESM dist/telemetry/utils.mjs 165.00 B
62
+ ESM dist/chunk-6QGXWNS5.mjs 1.41 KB
63
+ ESM dist/chunk-NAFEBKSO.mjs 43.00 B
42
64
  ESM dist/types/annotated-function.mjs 79.00 B
43
65
  ESM dist/types/copilot-cloud-config.mjs 81.00 B
44
66
  ESM dist/types/index.mjs 194.00 B
45
- ESM dist/chunk-BANDZXMP.mjs 43.00 B
46
- ESM dist/chunk-NAFEBKSO.mjs 43.00 B
47
- ESM dist/chunk-YBHX4Y25.mjs 43.00 B
48
- ESM dist/chunk-MSUB6DGR.mjs 43.00 B
49
67
  ESM dist/types/openai-assistant.mjs 77.00 B
50
- ESM dist/chunk-IAFBVORQ.mjs 43.00 B
51
68
  ESM dist/utils/annotated-function.mjs 314.00 B
52
- ESM dist/chunk-S4HGLK2E.mjs 4.62 KB
53
- ESM dist/utils/index.mjs.map 71.00 B
54
- ESM dist/utils/json-schema.mjs.map 71.00 B
69
+ ESM dist/utils/index.mjs 437.00 B
70
+ ESM dist/utils/json-schema.mjs 155.00 B
55
71
  ESM dist/index.mjs.map 71.00 B
72
+ ESM dist/constants/index.mjs.map 71.00 B
73
+ ESM dist/telemetry/events.mjs.map 71.00 B
74
+ ESM dist/types/action.mjs.map 71.00 B
75
+ ESM dist/chunk-BANDZXMP.mjs.map 71.00 B
76
+ ESM dist/chunk-YBHX4Y25.mjs.map 71.00 B
77
+ ESM dist/chunk-MSUB6DGR.mjs.map 71.00 B
78
+ ESM dist/chunk-IAFBVORQ.mjs.map 71.00 B
56
79
  ESM dist/chunk-CYDWEPFL.mjs.map 71.00 B
80
+ ESM dist/chunk-S4HGLK2E.mjs.map 8.40 KB
57
81
  ESM dist/chunk-CIPF7PMC.mjs.map 4.71 KB
58
- ESM dist/constants/index.mjs.map 71.00 B
59
82
  ESM dist/chunk-2VLE6D3W.mjs.map 502.00 B
60
- ESM dist/types/action.mjs.map 71.00 B
83
+ ESM dist/telemetry/index.mjs.map 71.00 B
84
+ ESM dist/chunk-P7STFMPO.mjs.map 71.00 B
85
+ ESM dist/telemetry/security-check.mjs.map 71.00 B
86
+ ESM dist/telemetry/telemetry-client.mjs.map 71.00 B
87
+ ESM dist/chunk-3VA36BKL.mjs.map 6.84 KB
88
+ ESM dist/telemetry/utils.mjs.map 71.00 B
89
+ ESM dist/chunk-6QGXWNS5.mjs.map 1.90 KB
90
+ ESM dist/chunk-NAFEBKSO.mjs.map 71.00 B
61
91
  ESM dist/types/annotated-function.mjs.map 71.00 B
62
92
  ESM dist/types/copilot-cloud-config.mjs.map 71.00 B
63
93
  ESM dist/types/index.mjs.map 71.00 B
64
- ESM dist/chunk-BANDZXMP.mjs.map 71.00 B
65
- ESM dist/chunk-NAFEBKSO.mjs.map 71.00 B
66
- ESM dist/chunk-YBHX4Y25.mjs.map 71.00 B
67
- ESM dist/chunk-MSUB6DGR.mjs.map 71.00 B
68
94
  ESM dist/types/openai-assistant.mjs.map 71.00 B
69
- ESM dist/chunk-IAFBVORQ.mjs.map 71.00 B
70
95
  ESM dist/utils/annotated-function.mjs.map 71.00 B
71
- ESM dist/chunk-S4HGLK2E.mjs.map 8.40 KB
72
- ESM ⚡️ Build success in 86ms
96
+ ESM dist/utils/index.mjs.map 71.00 B
97
+ ESM dist/utils/json-schema.mjs.map 71.00 B
98
+ ESM ⚡️ Build success in 128ms
73
99
  DTS Build start
74
- DTS ⚡️ Build success in 4506ms
75
- DTS dist/index.d.ts 937.00 B
100
+ DTS ⚡️ Build success in 4913ms
101
+ DTS dist/index.d.ts 1.03 KB
76
102
  DTS dist/types/openai-assistant.d.ts 1.47 KB
77
103
  DTS dist/types/annotated-function.d.ts 766.00 B
78
104
  DTS dist/types/action.d.ts 2.24 KB
@@ -80,5 +106,10 @@
80
106
  DTS dist/utils/annotated-function.d.ts 600.00 B
81
107
  DTS dist/utils/json-schema.d.ts 884.00 B
82
108
  DTS dist/constants/index.d.ts 410.00 B
109
+ DTS dist/telemetry/telemetry-client.d.ts 1.16 KB
110
+ DTS dist/telemetry/events.d.ts 223.00 B
111
+ DTS dist/telemetry/index.d.ts 102.00 B
112
+ DTS dist/telemetry/security-check.d.ts 12.00 B
113
+ DTS dist/telemetry/utils.d.ts 333.00 B
83
114
  DTS dist/types/index.d.ts 444.00 B
84
115
  DTS dist/utils/index.d.ts 420.00 B
package/CHANGELOG.md CHANGED
@@ -1,16 +1,22 @@
1
1
  # @copilotkit/shared
2
2
 
3
- ## 0.38.0-mme-alpha.1
3
+ ## 1.0.0-beta.1
4
4
 
5
- ### Minor Changes
5
+ ### Patch Changes
6
6
 
7
- - Fix: Missing server action results
7
+ - Introduce anonymous telemetry
8
8
 
9
- ## 0.38.0-mme-alpha.0
9
+ ## 1.0.0-beta.0
10
10
 
11
- ### Minor Changes
11
+ ### Major Changes
12
+
13
+ - V1.0 Release Candidate
12
14
 
13
- - GraphQL based protocol
15
+ - A robust new protocol between the frontend and the Copilot Runtime
16
+ - Support for Copilot Cloud
17
+ - Generative UI
18
+ - Support for LangChain universal tool calling
19
+ - OpenAI assistant API streaming
14
20
 
15
21
  ## 0.37.0
16
22
 
@@ -0,0 +1,122 @@
1
+ import {
2
+ flattenObject,
3
+ printSecurityNotice
4
+ } from "./chunk-6QGXWNS5.mjs";
5
+
6
+ // src/telemetry/telemetry-client.ts
7
+ import { PostHog } from "posthog-node";
8
+ import { randomUUID } from "crypto";
9
+ var TelemetryClient = class {
10
+ constructor({
11
+ packageName,
12
+ packageVersion,
13
+ telemetryDisabled,
14
+ telemetryBaseUrl,
15
+ posthogToken,
16
+ sampleRate
17
+ }) {
18
+ this.globalProperties = {};
19
+ this.cloudConfiguration = null;
20
+ this.telemetryDisabled = false;
21
+ this.sampleRate = 0.05;
22
+ this.packageName = packageName;
23
+ this.packageVersion = packageVersion;
24
+ this.telemetryDisabled = telemetryDisabled || process.env.COPILOTKIT_TELEMETRY_DISABLED === "true" || process.env.COPILOTKIT_TELEMETRY_DISABLED === "1" || process.env.DO_NOT_TRACK === "true" || process.env.DO_NOT_TRACK === "1";
25
+ if (this.telemetryDisabled) {
26
+ return;
27
+ }
28
+ this.setSampleRate(sampleRate);
29
+ this.telemetryBaseUrl = telemetryBaseUrl || process.env.COPILOTKIT_TELEMETRY_BASE_URL || "https://telemetry.copilotkit.ai";
30
+ this.posthog = new PostHog(posthogToken || "token", {
31
+ host: `${this.telemetryBaseUrl}/telemetry/ingest`
32
+ });
33
+ this.setGlobalProperties({
34
+ "copilotkit.package.name": packageName,
35
+ "copilotkit.package.version": packageVersion
36
+ });
37
+ if (typeof globalThis.navigator !== "undefined") {
38
+ globalThis.navigator = {};
39
+ }
40
+ }
41
+ shouldSendEvent() {
42
+ if (!this.telemetryBaseUrl) {
43
+ return false;
44
+ }
45
+ const randomNumber = Math.random();
46
+ return randomNumber < this.sampleRate;
47
+ }
48
+ async capture(event, properties) {
49
+ if (!this.shouldSendEvent() || !this.posthog) {
50
+ return;
51
+ }
52
+ const flattenedProperties = flattenObject(properties);
53
+ const propertiesWithGlobal = {
54
+ ...this.globalProperties,
55
+ ...flattenedProperties
56
+ };
57
+ const orderedPropertiesWithGlobal = Object.keys(propertiesWithGlobal).sort().reduce(
58
+ (obj, key) => {
59
+ obj[key] = propertiesWithGlobal[key];
60
+ return obj;
61
+ },
62
+ {}
63
+ );
64
+ this.posthog.capture({
65
+ distinctId: randomUUID(),
66
+ event,
67
+ properties: { ...orderedPropertiesWithGlobal }
68
+ });
69
+ }
70
+ async checkForUpdates() {
71
+ const url = `${this.telemetryBaseUrl}/check-for-updates?packageName=${this.packageName}&packageVersion=${this.packageVersion}`;
72
+ const response = await fetch(url);
73
+ if (!response.ok) {
74
+ return;
75
+ }
76
+ const result = await response.json();
77
+ const { advisory, severity } = result;
78
+ if (!advisory && (severity === "low" || severity === "none")) {
79
+ return;
80
+ }
81
+ printSecurityNotice(result);
82
+ }
83
+ setTelemetryBaseUrl(url) {
84
+ this.telemetryBaseUrl = url;
85
+ if (this.posthog) {
86
+ this.posthog.host = `${url}/telemetry/ingest`;
87
+ }
88
+ }
89
+ setGlobalProperties(properties) {
90
+ const flattenedProperties = flattenObject(properties);
91
+ this.globalProperties = { ...this.globalProperties, ...flattenedProperties };
92
+ }
93
+ setCloudConfiguration(properties) {
94
+ this.cloudConfiguration = properties;
95
+ this.setGlobalProperties({
96
+ cloud: {
97
+ publicApiKey: properties.publicApiKey,
98
+ baseUrl: properties.baseUrl
99
+ }
100
+ });
101
+ }
102
+ setSampleRate(sampleRate) {
103
+ let _sampleRate;
104
+ _sampleRate = sampleRate ?? 0.05;
105
+ if (process.env.COPILOTKIT_TELEMETRY_SAMPLE_RATE) {
106
+ _sampleRate = parseFloat(process.env.COPILOTKIT_TELEMETRY_SAMPLE_RATE);
107
+ }
108
+ if (_sampleRate < 0 || _sampleRate > 1) {
109
+ throw new Error("Sample rate must be between 0 and 1");
110
+ }
111
+ this.sampleRate = _sampleRate;
112
+ this.setGlobalProperties({
113
+ sampleRate: this.sampleRate,
114
+ sampleRateAdjustmentFactor: 1 - this.sampleRate
115
+ });
116
+ }
117
+ };
118
+
119
+ export {
120
+ TelemetryClient
121
+ };
122
+ //# sourceMappingURL=chunk-3VA36BKL.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/telemetry/telemetry-client.ts"],"sourcesContent":["import { PostHog } from \"posthog-node\";\nimport { AnalyticsEvents } from \"./events\";\nimport { flattenObject, printSecurityNotice } from \"./utils\";\nimport { randomUUID } from \"crypto\";\n\nexport class TelemetryClient {\n posthog: PostHog | undefined;\n globalProperties: Record<string, any> = {};\n cloudConfiguration: { publicApiKey: string; baseUrl: string } | null = null;\n packageName: string;\n packageVersion: string;\n private telemetryDisabled: boolean = false;\n private telemetryBaseUrl: string | undefined;\n private sampleRate: number = 0.05;\n\n constructor({\n packageName,\n packageVersion,\n telemetryDisabled,\n telemetryBaseUrl,\n posthogToken,\n sampleRate,\n }: {\n packageName: string;\n packageVersion: string;\n telemetryDisabled?: boolean;\n telemetryBaseUrl?: string;\n posthogToken?: string;\n sampleRate?: number;\n }) {\n this.packageName = packageName;\n this.packageVersion = packageVersion;\n this.telemetryDisabled =\n telemetryDisabled ||\n (process.env as any).COPILOTKIT_TELEMETRY_DISABLED === \"true\" ||\n (process.env as any).COPILOTKIT_TELEMETRY_DISABLED === \"1\" ||\n (process.env as any).DO_NOT_TRACK === \"true\" ||\n (process.env as any).DO_NOT_TRACK === \"1\";\n\n if (this.telemetryDisabled) {\n return;\n }\n\n this.setSampleRate(sampleRate);\n\n this.telemetryBaseUrl =\n telemetryBaseUrl ||\n (process.env as any).COPILOTKIT_TELEMETRY_BASE_URL ||\n \"https://telemetry.copilotkit.ai\";\n\n this.posthog = new PostHog(posthogToken || \"token\", {\n host: `${this.telemetryBaseUrl}/telemetry/ingest`,\n });\n\n this.setGlobalProperties({\n \"copilotkit.package.name\": packageName,\n \"copilotkit.package.version\": packageVersion,\n });\n\n // Eliminates a PostHog error on Next.js\n if (typeof (globalThis as any).navigator !== \"undefined\") {\n (globalThis as any).navigator = {};\n }\n }\n\n private shouldSendEvent() {\n if (!this.telemetryBaseUrl) {\n return false;\n }\n\n const randomNumber = Math.random();\n return randomNumber < this.sampleRate;\n }\n\n async capture<K extends keyof AnalyticsEvents>(event: K, properties: AnalyticsEvents[K]) {\n if (!this.shouldSendEvent() || !this.posthog) {\n return;\n }\n\n const flattenedProperties = flattenObject(properties);\n const propertiesWithGlobal = {\n ...this.globalProperties,\n ...flattenedProperties,\n };\n const orderedPropertiesWithGlobal = Object.keys(propertiesWithGlobal)\n .sort()\n .reduce(\n (obj, key) => {\n obj[key] = propertiesWithGlobal[key];\n return obj;\n },\n {} as Record<string, any>,\n );\n\n this.posthog.capture({\n distinctId: randomUUID(),\n event,\n properties: { ...orderedPropertiesWithGlobal },\n });\n }\n\n async checkForUpdates() {\n const url = `${this.telemetryBaseUrl}/check-for-updates?packageName=${this.packageName}&packageVersion=${this.packageVersion}`;\n\n const response = await fetch(url);\n\n if (!response.ok) {\n return;\n }\n\n const result = await response.json();\n const { advisory, severity } = result;\n\n if (!advisory && (severity === \"low\" || severity === \"none\")) {\n return;\n }\n\n printSecurityNotice(result);\n }\n\n setTelemetryBaseUrl(url: string) {\n this.telemetryBaseUrl = url;\n\n if (this.posthog) {\n this.posthog.host = `${url}/telemetry/ingest`;\n }\n }\n\n setGlobalProperties(properties: Record<string, any>) {\n const flattenedProperties = flattenObject(properties);\n this.globalProperties = { ...this.globalProperties, ...flattenedProperties };\n }\n\n setCloudConfiguration(properties: { publicApiKey: string; baseUrl: string }) {\n this.cloudConfiguration = properties;\n\n this.setGlobalProperties({\n cloud: {\n publicApiKey: properties.publicApiKey,\n baseUrl: properties.baseUrl,\n },\n });\n }\n\n private setSampleRate(sampleRate: number | undefined) {\n let _sampleRate: number;\n\n _sampleRate = sampleRate ?? 0.05;\n\n if (process.env.COPILOTKIT_TELEMETRY_SAMPLE_RATE) {\n _sampleRate = parseFloat(process.env.COPILOTKIT_TELEMETRY_SAMPLE_RATE);\n }\n\n if (_sampleRate < 0 || _sampleRate > 1) {\n throw new Error(\"Sample rate must be between 0 and 1\");\n }\n\n this.sampleRate = _sampleRate;\n this.setGlobalProperties({\n sampleRate: this.sampleRate,\n sampleRateAdjustmentFactor: 1 - this.sampleRate,\n });\n }\n}\n"],"mappings":";;;;;;AAAA,SAAS,eAAe;AAGxB,SAAS,kBAAkB;AAEpB,IAAM,kBAAN,MAAsB;AAAA,EAU3B,YAAY;AAAA,IACV;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF,GAOG;AAtBH,4BAAwC,CAAC;AACzC,8BAAuE;AAGvE,SAAQ,oBAA6B;AAErC,SAAQ,aAAqB;AAiB3B,SAAK,cAAc;AACnB,SAAK,iBAAiB;AACtB,SAAK,oBACH,qBACC,QAAQ,IAAY,kCAAkC,UACtD,QAAQ,IAAY,kCAAkC,OACtD,QAAQ,IAAY,iBAAiB,UACrC,QAAQ,IAAY,iBAAiB;AAExC,QAAI,KAAK,mBAAmB;AAC1B;AAAA,IACF;AAEA,SAAK,cAAc,UAAU;AAE7B,SAAK,mBACH,oBACC,QAAQ,IAAY,iCACrB;AAEF,SAAK,UAAU,IAAI,QAAQ,gBAAgB,SAAS;AAAA,MAClD,MAAM,GAAG,KAAK;AAAA,IAChB,CAAC;AAED,SAAK,oBAAoB;AAAA,MACvB,2BAA2B;AAAA,MAC3B,8BAA8B;AAAA,IAChC,CAAC;AAGD,QAAI,OAAQ,WAAmB,cAAc,aAAa;AACxD,MAAC,WAAmB,YAAY,CAAC;AAAA,IACnC;AAAA,EACF;AAAA,EAEQ,kBAAkB;AACxB,QAAI,CAAC,KAAK,kBAAkB;AAC1B,aAAO;AAAA,IACT;AAEA,UAAM,eAAe,KAAK,OAAO;AACjC,WAAO,eAAe,KAAK;AAAA,EAC7B;AAAA,EAEA,MAAM,QAAyC,OAAU,YAAgC;AACvF,QAAI,CAAC,KAAK,gBAAgB,KAAK,CAAC,KAAK,SAAS;AAC5C;AAAA,IACF;AAEA,UAAM,sBAAsB,cAAc,UAAU;AACpD,UAAM,uBAAuB;AAAA,MAC3B,GAAG,KAAK;AAAA,MACR,GAAG;AAAA,IACL;AACA,UAAM,8BAA8B,OAAO,KAAK,oBAAoB,EACjE,KAAK,EACL;AAAA,MACC,CAAC,KAAK,QAAQ;AACZ,YAAI,GAAG,IAAI,qBAAqB,GAAG;AACnC,eAAO;AAAA,MACT;AAAA,MACA,CAAC;AAAA,IACH;AAEF,SAAK,QAAQ,QAAQ;AAAA,MACnB,YAAY,WAAW;AAAA,MACvB;AAAA,MACA,YAAY,EAAE,GAAG,4BAA4B;AAAA,IAC/C,CAAC;AAAA,EACH;AAAA,EAEA,MAAM,kBAAkB;AACtB,UAAM,MAAM,GAAG,KAAK,kDAAkD,KAAK,8BAA8B,KAAK;AAE9G,UAAM,WAAW,MAAM,MAAM,GAAG;AAEhC,QAAI,CAAC,SAAS,IAAI;AAChB;AAAA,IACF;AAEA,UAAM,SAAS,MAAM,SAAS,KAAK;AACnC,UAAM,EAAE,UAAU,SAAS,IAAI;AAE/B,QAAI,CAAC,aAAa,aAAa,SAAS,aAAa,SAAS;AAC5D;AAAA,IACF;AAEA,wBAAoB,MAAM;AAAA,EAC5B;AAAA,EAEA,oBAAoB,KAAa;AAC/B,SAAK,mBAAmB;AAExB,QAAI,KAAK,SAAS;AAChB,WAAK,QAAQ,OAAO,GAAG;AAAA,IACzB;AAAA,EACF;AAAA,EAEA,oBAAoB,YAAiC;AACnD,UAAM,sBAAsB,cAAc,UAAU;AACpD,SAAK,mBAAmB,EAAE,GAAG,KAAK,kBAAkB,GAAG,oBAAoB;AAAA,EAC7E;AAAA,EAEA,sBAAsB,YAAuD;AAC3E,SAAK,qBAAqB;AAE1B,SAAK,oBAAoB;AAAA,MACvB,OAAO;AAAA,QACL,cAAc,WAAW;AAAA,QACzB,SAAS,WAAW;AAAA,MACtB;AAAA,IACF,CAAC;AAAA,EACH;AAAA,EAEQ,cAAc,YAAgC;AACpD,QAAI;AAEJ,kBAAc,cAAc;AAE5B,QAAI,QAAQ,IAAI,kCAAkC;AAChD,oBAAc,WAAW,QAAQ,IAAI,gCAAgC;AAAA,IACvE;AAEA,QAAI,cAAc,KAAK,cAAc,GAAG;AACtC,YAAM,IAAI,MAAM,qCAAqC;AAAA,IACvD;AAEA,SAAK,aAAa;AAClB,SAAK,oBAAoB;AAAA,MACvB,YAAY,KAAK;AAAA,MACjB,4BAA4B,IAAI,KAAK;AAAA,IACvC,CAAC;AAAA,EACH;AACF;","names":[]}
@@ -0,0 +1,34 @@
1
+ // src/telemetry/utils.ts
2
+ import chalk from "chalk";
3
+ function flattenObject(obj, parentKey = "", res = {}) {
4
+ for (let key in obj) {
5
+ const propName = parentKey ? `${parentKey}.${key}` : key;
6
+ if (typeof obj[key] === "object" && obj[key] !== null) {
7
+ flattenObject(obj[key], propName, res);
8
+ } else {
9
+ res[propName] = obj[key];
10
+ }
11
+ }
12
+ return res;
13
+ }
14
+ function printSecurityNotice(advisory) {
15
+ const severityColor = {
16
+ low: chalk.blue,
17
+ medium: chalk.yellow,
18
+ high: chalk.red
19
+ }[advisory.severity.toLowerCase()] || chalk.white;
20
+ console.log();
21
+ console.log(`\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501 ${chalk.bold(`CopilotKit`)} \u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501`);
22
+ console.log();
23
+ console.log(`${chalk.bold(`Severity: ${severityColor(advisory.severity.toUpperCase())}`)}`);
24
+ console.log();
25
+ console.log(`${chalk.bold(advisory.message)}`);
26
+ console.log();
27
+ console.log(`\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501`);
28
+ }
29
+
30
+ export {
31
+ flattenObject,
32
+ printSecurityNotice
33
+ };
34
+ //# sourceMappingURL=chunk-6QGXWNS5.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/telemetry/utils.ts"],"sourcesContent":["import chalk from \"chalk\";\n\nexport function flattenObject(\n obj: Record<string, any>,\n parentKey = \"\",\n res: Record<string, any> = {},\n): Record<string, any> {\n for (let key in obj) {\n const propName = parentKey ? `${parentKey}.${key}` : key;\n if (typeof obj[key] === \"object\" && obj[key] !== null) {\n flattenObject(obj[key], propName, res);\n } else {\n res[propName] = obj[key];\n }\n }\n return res;\n}\n\nexport function printSecurityNotice(advisory: {\n advisory: string | null;\n message: string;\n severity: \"low\" | \"medium\" | \"high\" | \"none\";\n}) {\n const severityColor =\n {\n low: chalk.blue,\n medium: chalk.yellow,\n high: chalk.red,\n }[advisory.severity.toLowerCase()] || chalk.white;\n\n console.log();\n console.log(`━━━━━━━━━━━━━━━━━━ ${chalk.bold(`CopilotKit`)} ━━━━━━━━━━━━━━━━━━`);\n console.log();\n console.log(`${chalk.bold(`Severity: ${severityColor(advisory.severity.toUpperCase())}`)}`);\n console.log();\n console.log(`${chalk.bold(advisory.message)}`);\n console.log();\n console.log(`━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━`);\n}\n"],"mappings":";AAAA,OAAO,WAAW;AAEX,SAAS,cACd,KACA,YAAY,IACZ,MAA2B,CAAC,GACP;AACrB,WAAS,OAAO,KAAK;AACnB,UAAM,WAAW,YAAY,GAAG,aAAa,QAAQ;AACrD,QAAI,OAAO,IAAI,GAAG,MAAM,YAAY,IAAI,GAAG,MAAM,MAAM;AACrD,oBAAc,IAAI,GAAG,GAAG,UAAU,GAAG;AAAA,IACvC,OAAO;AACL,UAAI,QAAQ,IAAI,IAAI,GAAG;AAAA,IACzB;AAAA,EACF;AACA,SAAO;AACT;AAEO,SAAS,oBAAoB,UAIjC;AACD,QAAM,gBACJ;AAAA,IACE,KAAK,MAAM;AAAA,IACX,QAAQ,MAAM;AAAA,IACd,MAAM,MAAM;AAAA,EACd,EAAE,SAAS,SAAS,YAAY,CAAC,KAAK,MAAM;AAE9C,UAAQ,IAAI;AACZ,UAAQ,IAAI,gHAAsB,MAAM,KAAK,YAAY,gHAAsB;AAC/E,UAAQ,IAAI;AACZ,UAAQ,IAAI,GAAG,MAAM,KAAK,aAAa,cAAc,SAAS,SAAS,YAAY,CAAC,GAAG,GAAG;AAC1F,UAAQ,IAAI;AACZ,UAAQ,IAAI,GAAG,MAAM,KAAK,SAAS,OAAO,GAAG;AAC7C,UAAQ,IAAI;AACZ,UAAQ,IAAI,kSAAkD;AAChE;","names":[]}
@@ -0,0 +1 @@
1
+ //# sourceMappingURL=chunk-P7STFMPO.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
package/dist/index.d.ts CHANGED
@@ -5,3 +5,6 @@ export { CopilotCloudConfig } from './types/copilot-cloud-config.js';
5
5
  export { actionToChatCompletionFunction, annotatedFunctionToAction, annotatedFunctionToChatCompletionFunction } from './utils/annotated-function.js';
6
6
  export { JSONSchema, JSONSchemaArray, JSONSchemaBoolean, JSONSchemaNumber, JSONSchemaObject, JSONSchemaString, actionParametersToJsonSchema } from './utils/json-schema.js';
7
7
  export { COPILOT_CLOUD_API_URL, COPILOT_CLOUD_CHAT_URL, COPILOT_CLOUD_PUBLIC_API_KEY_HEADER, COPILOT_CLOUD_VERSION } from './constants/index.js';
8
+ export { TelemetryClient } from './telemetry/telemetry-client.js';
9
+ import 'posthog-node';
10
+ import './telemetry/events.js';
package/dist/index.js CHANGED
@@ -1,7 +1,9 @@
1
1
  "use strict";
2
+ var __create = Object.create;
2
3
  var __defProp = Object.defineProperty;
3
4
  var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
4
5
  var __getOwnPropNames = Object.getOwnPropertyNames;
6
+ var __getProtoOf = Object.getPrototypeOf;
5
7
  var __hasOwnProp = Object.prototype.hasOwnProperty;
6
8
  var __export = (target, all) => {
7
9
  for (var name in all)
@@ -15,6 +17,14 @@ var __copyProps = (to, from, except, desc) => {
15
17
  }
16
18
  return to;
17
19
  };
20
+ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
21
+ // If the importer is in node compatibility mode or this is not an ESM
22
+ // file that has been converted to a CommonJS file using a Babel-
23
+ // compatible transform (i.e. "__esModule" has not been set), then set
24
+ // "default" to the CommonJS "module.exports" for node compatibility.
25
+ isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
26
+ mod
27
+ ));
18
28
  var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
19
29
 
20
30
  // src/index.ts
@@ -24,6 +34,7 @@ __export(src_exports, {
24
34
  COPILOT_CLOUD_CHAT_URL: () => COPILOT_CLOUD_CHAT_URL,
25
35
  COPILOT_CLOUD_PUBLIC_API_KEY_HEADER: () => COPILOT_CLOUD_PUBLIC_API_KEY_HEADER,
26
36
  COPILOT_CLOUD_VERSION: () => COPILOT_CLOUD_VERSION,
37
+ TelemetryClient: () => TelemetryClient,
27
38
  actionParametersToJsonSchema: () => actionParametersToJsonSchema,
28
39
  actionToChatCompletionFunction: () => actionToChatCompletionFunction,
29
40
  annotatedFunctionToAction: () => annotatedFunctionToAction,
@@ -269,12 +280,157 @@ var COPILOT_CLOUD_API_URL = "https://api.copilotkit.ai";
269
280
  var COPILOT_CLOUD_VERSION = "v1";
270
281
  var COPILOT_CLOUD_CHAT_URL = `${COPILOT_CLOUD_API_URL}/${COPILOT_CLOUD_VERSION}/copilotkit/runtime/chat`;
271
282
  var COPILOT_CLOUD_PUBLIC_API_KEY_HEADER = "X-CopilotCloud-Public-Api-Key";
283
+
284
+ // src/telemetry/telemetry-client.ts
285
+ var import_posthog_node = require("posthog-node");
286
+
287
+ // src/telemetry/utils.ts
288
+ var import_chalk = __toESM(require("chalk"));
289
+ function flattenObject(obj, parentKey = "", res = {}) {
290
+ for (let key in obj) {
291
+ const propName = parentKey ? `${parentKey}.${key}` : key;
292
+ if (typeof obj[key] === "object" && obj[key] !== null) {
293
+ flattenObject(obj[key], propName, res);
294
+ } else {
295
+ res[propName] = obj[key];
296
+ }
297
+ }
298
+ return res;
299
+ }
300
+ function printSecurityNotice(advisory) {
301
+ const severityColor = {
302
+ low: import_chalk.default.blue,
303
+ medium: import_chalk.default.yellow,
304
+ high: import_chalk.default.red
305
+ }[advisory.severity.toLowerCase()] || import_chalk.default.white;
306
+ console.log();
307
+ console.log(`\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501 ${import_chalk.default.bold(`CopilotKit`)} \u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501`);
308
+ console.log();
309
+ console.log(`${import_chalk.default.bold(`Severity: ${severityColor(advisory.severity.toUpperCase())}`)}`);
310
+ console.log();
311
+ console.log(`${import_chalk.default.bold(advisory.message)}`);
312
+ console.log();
313
+ console.log(`\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501`);
314
+ }
315
+
316
+ // src/telemetry/telemetry-client.ts
317
+ var import_crypto = require("crypto");
318
+ var TelemetryClient = class {
319
+ constructor({
320
+ packageName,
321
+ packageVersion,
322
+ telemetryDisabled,
323
+ telemetryBaseUrl,
324
+ posthogToken,
325
+ sampleRate
326
+ }) {
327
+ this.globalProperties = {};
328
+ this.cloudConfiguration = null;
329
+ this.telemetryDisabled = false;
330
+ this.sampleRate = 0.05;
331
+ this.packageName = packageName;
332
+ this.packageVersion = packageVersion;
333
+ this.telemetryDisabled = telemetryDisabled || process.env.COPILOTKIT_TELEMETRY_DISABLED === "true" || process.env.COPILOTKIT_TELEMETRY_DISABLED === "1" || process.env.DO_NOT_TRACK === "true" || process.env.DO_NOT_TRACK === "1";
334
+ if (this.telemetryDisabled) {
335
+ return;
336
+ }
337
+ this.setSampleRate(sampleRate);
338
+ this.telemetryBaseUrl = telemetryBaseUrl || process.env.COPILOTKIT_TELEMETRY_BASE_URL || "https://telemetry.copilotkit.ai";
339
+ this.posthog = new import_posthog_node.PostHog(posthogToken || "token", {
340
+ host: `${this.telemetryBaseUrl}/telemetry/ingest`
341
+ });
342
+ this.setGlobalProperties({
343
+ "copilotkit.package.name": packageName,
344
+ "copilotkit.package.version": packageVersion
345
+ });
346
+ if (typeof globalThis.navigator !== "undefined") {
347
+ globalThis.navigator = {};
348
+ }
349
+ }
350
+ shouldSendEvent() {
351
+ if (!this.telemetryBaseUrl) {
352
+ return false;
353
+ }
354
+ const randomNumber = Math.random();
355
+ return randomNumber < this.sampleRate;
356
+ }
357
+ async capture(event, properties) {
358
+ if (!this.shouldSendEvent() || !this.posthog) {
359
+ return;
360
+ }
361
+ const flattenedProperties = flattenObject(properties);
362
+ const propertiesWithGlobal = {
363
+ ...this.globalProperties,
364
+ ...flattenedProperties
365
+ };
366
+ const orderedPropertiesWithGlobal = Object.keys(propertiesWithGlobal).sort().reduce(
367
+ (obj, key) => {
368
+ obj[key] = propertiesWithGlobal[key];
369
+ return obj;
370
+ },
371
+ {}
372
+ );
373
+ this.posthog.capture({
374
+ distinctId: (0, import_crypto.randomUUID)(),
375
+ event,
376
+ properties: { ...orderedPropertiesWithGlobal }
377
+ });
378
+ }
379
+ async checkForUpdates() {
380
+ const url = `${this.telemetryBaseUrl}/check-for-updates?packageName=${this.packageName}&packageVersion=${this.packageVersion}`;
381
+ const response = await fetch(url);
382
+ if (!response.ok) {
383
+ return;
384
+ }
385
+ const result = await response.json();
386
+ const { advisory, severity } = result;
387
+ if (!advisory && (severity === "low" || severity === "none")) {
388
+ return;
389
+ }
390
+ printSecurityNotice(result);
391
+ }
392
+ setTelemetryBaseUrl(url) {
393
+ this.telemetryBaseUrl = url;
394
+ if (this.posthog) {
395
+ this.posthog.host = `${url}/telemetry/ingest`;
396
+ }
397
+ }
398
+ setGlobalProperties(properties) {
399
+ const flattenedProperties = flattenObject(properties);
400
+ this.globalProperties = { ...this.globalProperties, ...flattenedProperties };
401
+ }
402
+ setCloudConfiguration(properties) {
403
+ this.cloudConfiguration = properties;
404
+ this.setGlobalProperties({
405
+ cloud: {
406
+ publicApiKey: properties.publicApiKey,
407
+ baseUrl: properties.baseUrl
408
+ }
409
+ });
410
+ }
411
+ setSampleRate(sampleRate) {
412
+ let _sampleRate;
413
+ _sampleRate = sampleRate ?? 0.05;
414
+ if (process.env.COPILOTKIT_TELEMETRY_SAMPLE_RATE) {
415
+ _sampleRate = parseFloat(process.env.COPILOTKIT_TELEMETRY_SAMPLE_RATE);
416
+ }
417
+ if (_sampleRate < 0 || _sampleRate > 1) {
418
+ throw new Error("Sample rate must be between 0 and 1");
419
+ }
420
+ this.sampleRate = _sampleRate;
421
+ this.setGlobalProperties({
422
+ sampleRate: this.sampleRate,
423
+ sampleRateAdjustmentFactor: 1 - this.sampleRate
424
+ });
425
+ }
426
+ };
272
427
  // Annotate the CommonJS export names for ESM import in node:
273
428
  0 && (module.exports = {
274
429
  COPILOT_CLOUD_API_URL,
275
430
  COPILOT_CLOUD_CHAT_URL,
276
431
  COPILOT_CLOUD_PUBLIC_API_KEY_HEADER,
277
432
  COPILOT_CLOUD_VERSION,
433
+ TelemetryClient,
278
434
  actionParametersToJsonSchema,
279
435
  actionToChatCompletionFunction,
280
436
  annotatedFunctionToAction,