@copilotkit/runtime 1.9.3-next.2 → 1.9.3-next.4

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 (31) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/README.md +55 -100
  3. package/dist/{chunk-CCQGWSPS.mjs → chunk-L5XBPLH4.mjs} +2 -2
  4. package/dist/{chunk-2RQ4BX75.mjs → chunk-M52XCCYL.mjs} +2 -2
  5. package/dist/{chunk-7WSOM546.mjs → chunk-TOTCMKGV.mjs} +2 -2
  6. package/dist/{chunk-4ES2QKLP.mjs → chunk-UNXHBYJH.mjs} +2 -2
  7. package/dist/{chunk-4ES2QKLP.mjs.map → chunk-UNXHBYJH.mjs.map} +1 -1
  8. package/dist/{chunk-DH323WEF.mjs → chunk-VM2GXVSW.mjs} +2 -2
  9. package/dist/index.js +1 -1
  10. package/dist/index.js.map +1 -1
  11. package/dist/index.mjs +5 -5
  12. package/dist/lib/index.js +1 -1
  13. package/dist/lib/index.js.map +1 -1
  14. package/dist/lib/index.mjs +5 -5
  15. package/dist/lib/integrations/index.js +1 -1
  16. package/dist/lib/integrations/index.js.map +1 -1
  17. package/dist/lib/integrations/index.mjs +4 -4
  18. package/dist/lib/integrations/nest/index.js +1 -1
  19. package/dist/lib/integrations/nest/index.js.map +1 -1
  20. package/dist/lib/integrations/nest/index.mjs +2 -2
  21. package/dist/lib/integrations/node-express/index.js +1 -1
  22. package/dist/lib/integrations/node-express/index.js.map +1 -1
  23. package/dist/lib/integrations/node-express/index.mjs +2 -2
  24. package/dist/lib/integrations/node-http/index.js +1 -1
  25. package/dist/lib/integrations/node-http/index.js.map +1 -1
  26. package/dist/lib/integrations/node-http/index.mjs +1 -1
  27. package/package.json +2 -2
  28. /package/dist/{chunk-CCQGWSPS.mjs.map → chunk-L5XBPLH4.mjs.map} +0 -0
  29. /package/dist/{chunk-2RQ4BX75.mjs.map → chunk-M52XCCYL.mjs.map} +0 -0
  30. /package/dist/{chunk-7WSOM546.mjs.map → chunk-TOTCMKGV.mjs.map} +0 -0
  31. /package/dist/{chunk-DH323WEF.mjs.map → chunk-VM2GXVSW.mjs.map} +0 -0
package/CHANGELOG.md CHANGED
@@ -1,5 +1,19 @@
1
1
  # @copilotkit/runtime
2
2
 
3
+ ## 1.9.3-next.4
4
+
5
+ ### Patch Changes
6
+
7
+ - @copilotkit/shared@1.9.3-next.4
8
+
9
+ ## 1.9.3-next.3
10
+
11
+ ### Patch Changes
12
+
13
+ - 1bda332: - chore(telemetry): integrate Scarf for usage analytics
14
+ - Updated dependencies [1bda332]
15
+ - @copilotkit/shared@1.9.3-next.3
16
+
3
17
  ## 1.9.3-next.2
4
18
 
5
19
  ### Patch Changes
package/README.md CHANGED
@@ -1,121 +1,76 @@
1
- <div align="center">
2
- <a href="https://copilotkit.ai" target="_blank">
3
- <img src="https://github.com/copilotkit/copilotkit/raw/main/assets/banner.png" alt="CopilotKit Logo">
4
- </a>
5
-
6
- <br/>
7
-
8
- <strong>
9
- CopilotKit is the open-source framework for integrating powerful AI Copilots into any application. Easily implement custom AI Chatbots, AI Agents, AI Textareas, and more.
10
- </strong>
11
- </div>
1
+ # CopilotKit - Runtime
12
2
 
13
- <br/>
3
+ <img src="https://github.com/user-attachments/assets/0a6b64d9-e193-4940-a3f6-60334ac34084" alt="banner" style="border-radius: 12px; border: 2px solid #d6d4fa;" />
14
4
 
15
- <div align="center">
5
+ <br>
6
+ <div align="center" style="display:flex;justify-content:center;gap:16px;height:20px;margin: 0;">
16
7
  <a href="https://www.npmjs.com/package/@copilotkit/react-core" target="_blank">
17
- <img src="https://img.shields.io/npm/v/%40copilotkit%2Freact-core?logo=npm&logoColor=%23FFFFFF&label=Version&color=%236963ff" alt="NPM">
8
+ <img src="https://img.shields.io/npm/v/%40copilotkit%2Fruntime?logo=npm&logoColor=%23FFFFFF&label=Version&color=%236963ff" alt="NPM">
9
+ </a>
10
+ <a href="https://github.com/copilotkit/copilotkit/blob/main/LICENSE" target="_blank">
11
+ <img src="https://img.shields.io/github/license/copilotkit/copilotkit?color=%236963ff&label=License" alt="MIT">
18
12
  </a>
19
- <img src="https://img.shields.io/github/license/copilotkit/copilotkit?color=%236963ff&label=License" alt="MIT">
20
13
  <a href="https://discord.gg/6dffbvGU3D" target="_blank">
21
14
  <img src="https://img.shields.io/discord/1122926057641742418?logo=discord&logoColor=%23FFFFFF&label=Discord&color=%236963ff" alt="Discord">
22
15
  </a>
23
16
  </div>
24
17
  <br/>
25
-
26
18
  <div align="center">
27
- <a href="https://discord.gg/6dffbvGU3D?ref=github_readme" target="_blank">
28
- <img src="https://github.com/copilotkit/copilotkit/raw/main/assets/btn_discord.png" alt="CopilotKit Discord" height="40px">
29
- </a>
30
- <a href="https://docs.copilotkit.ai?ref=github_readme" target="_blank">
31
- <img src="https://github.com/copilotkit/copilotkit/raw/main/assets/btn_docs.png" alt="CopilotKit GitHub" height="40px">
32
- </a>
33
- <a href="https://cloud.copilotkit.ai?ref=github_readme" target="_blank">
34
- <img src="https://github.com/copilotkit/copilotkit/raw/main/assets/btn_cloud.png" alt="CopilotKit GitHub" height="40px">
19
+ <a href="https://www.producthunt.com/posts/copilotkit" target="_blank">
20
+ <img src="https://api.producthunt.com/widgets/embed-image/v1/top-post-badge.svg?post_id=428778&theme=light&period=daily">
35
21
  </a>
36
22
  </div>
37
23
 
38
- <br />
24
+ ## ✨ Why CopilotKit?
39
25
 
40
- <div align="center">
41
- <img src="https://github.com/CopilotKit/CopilotKit/raw/main/assets/animated-banner.gif" alt="CopilotKit Screenshot" style="border-radius: 15px;" />
42
- </div>
26
+ - Minutes to integrate - Get started quickly with our CLI
27
+ - Framework agnostic - Works with React, Next.js, AGUI and more
28
+ - Production-ready UI - Use customizable components or build with headless UI
29
+ - Built-in security - Prompt injection protection
30
+ - Open source - Full transparency and community-driven
31
+
32
+ <img src="https://github.com/user-attachments/assets/6cb425f8-ffcb-49d2-9bbb-87cab5995b78" alt="class-support-ecosystem" style="border-radius: 12px; border: 2px solid #d6d4fa;">
33
+
34
+ ## 🧑‍💻 Real life use cases
43
35
 
44
- # Documentation
36
+ <span>Deploy deeply-integrated AI assistants & agents that work alongside your users inside your applications.</span>
37
+
38
+ <img src="https://github.com/user-attachments/assets/3b810240-e9f8-43ae-acec-31a58095e223" alt="headless-ui" style="border-radius: 12px; border: 2px solid #d6d4fa;">
39
+
40
+
41
+ ## 🏆 Featured Examples
42
+
43
+ <p align="center">
44
+ <a href="https://www.copilotkit.ai/examples/form-filling-copilot">
45
+ <img src="https://github.com/user-attachments/assets/874da84a-67ff-47fa-a6b4-cbc3c65eb704" width="300" style="border-radius: 16px;" />
46
+ </a>
47
+ <a href="https://www.copilotkit.ai/examples/state-machine-copilot">
48
+ <img src="https://github.com/user-attachments/assets/0b5e45b3-2704-4678-82dc-2f3e1c58e2dd" width="300" style="border-radius: 16px;" />
49
+ </a>
50
+ <a href="https://www.copilotkit.ai/examples/chat-with-your-data">
51
+ <img src="https://github.com/user-attachments/assets/0fed66be-a4c2-4093-8eab-75c0b27a62f6" width="300" style="border-radius: 16px;" />
52
+ </a>
53
+ </p>
54
+
55
+ ## Documentation
45
56
 
46
57
  To get started with CopilotKit, please check out the [documentation](https://docs.copilotkit.ai).
47
58
 
48
- ## LangFuse Logging Integration
49
-
50
- CopilotKit now supports LangFuse logging integration to help you monitor, analyze, and debug your LLM requests and responses.
51
-
52
- ### Setup
53
-
54
- To enable LangFuse logging, you can configure it when initializing the CopilotRuntime:
55
-
56
- ```typescript
57
- import { CopilotRuntime, OpenAIAdapter } from "@copilotkit/runtime";
58
- import { LangfuseClient } from "langfuse";
59
-
60
- // Initialize your LangFuse client
61
- const langfuse = new LangfuseClient({
62
- publicKey: process.env.LANGFUSE_PUBLIC_KEY!,
63
- secretKey: process.env.LANGFUSE_SECRET_KEY!,
64
- baseUrl: process.env.LANGFUSE_BASE_URL,
65
- });
66
-
67
- // Create a CopilotRuntime with LangFuse logging enabled
68
- const runtime = new CopilotRuntime({
69
- adapter: new OpenAIAdapter({ apiKey: process.env.OPENAI_API_KEY }),
70
- logging: {
71
- enabled: true,
72
- progressive: true, // Set to false for buffered logging
73
- logger: {
74
- logRequest: (data) => langfuse.trace({ name: "LLM Request", input: data }),
75
- logResponse: (data) => langfuse.trace({ name: "LLM Response", output: data }),
76
- logError: (errorData) => langfuse.trace({ name: "LLM Error", metadata: errorData }),
77
- },
78
- },
79
- });
80
- ```
81
59
 
82
- ### Configuration Options
83
-
84
- The logging configuration accepts the following options:
85
-
86
- - `enabled` (boolean): Enable or disable logging (default: false)
87
- - `progressive` (boolean): When true, logs each chunk as it's streamed. When false, logs the complete response (default: true)
88
- - `logger` (object): Contains callback functions for logging:
89
- - `logRequest`: Called when an LLM request is made
90
- - `logResponse`: Called when an LLM response is received
91
- - `logError`: Called when an error occurs during an LLM request
92
-
93
- ### Custom Logging Integrations
94
-
95
- You can integrate with any logging service by implementing the logger interface:
96
-
97
- ```typescript
98
- const runtime = new CopilotRuntime({
99
- adapter: new OpenAIAdapter({ apiKey: "YOUR_API_KEY" }),
100
- logging: {
101
- enabled: true,
102
- progressive: false,
103
- logger: {
104
- logRequest: (data) => {
105
- // Implement your custom logging logic
106
- console.log("LLM Request:", JSON.stringify(data));
107
- },
108
- logResponse: (data) => {
109
- // Implement your custom logging logic
110
- console.log("LLM Response:", JSON.stringify(data));
111
- },
112
- logError: (error) => {
113
- // Implement your custom error logging
114
- console.error("LLM Error:", error);
115
- },
116
- },
117
- },
118
- });
60
+ ## Analytics & Privacy
61
+
62
+ CopilotKit uses [Scarf](https://scarf.sh) for anonymous usage analytics to help improve the product. Scarf handles all privacy compliance and does not store raw IP addresses. This helps us understand how CopilotKit is being used and prioritize improvements.
63
+
64
+ ### Opting Out
65
+
66
+ To disable analytics, set the environment variable:
67
+
68
+ ```bash
69
+ export COPILOTKIT_TELEMETRY_DISABLED=true
119
70
  ```
120
71
 
121
- This allows you to send your logs to any system or service that you prefer.
72
+ Or use the `DO_NOT_TRACK` standard:
73
+
74
+ ```bash
75
+ export DO_NOT_TRACK=1
76
+ ```
@@ -2,7 +2,7 @@ import {
2
2
  copilotRuntimeNodeHttpEndpoint,
3
3
  getRuntimeInstanceTelemetryInfo,
4
4
  telemetry_client_default
5
- } from "./chunk-4ES2QKLP.mjs";
5
+ } from "./chunk-UNXHBYJH.mjs";
6
6
  import {
7
7
  __name
8
8
  } from "./chunk-FHD4JECV.mjs";
@@ -22,4 +22,4 @@ __name(copilotRuntimeNestEndpoint, "copilotRuntimeNestEndpoint");
22
22
  export {
23
23
  copilotRuntimeNestEndpoint
24
24
  };
25
- //# sourceMappingURL=chunk-CCQGWSPS.mjs.map
25
+ //# sourceMappingURL=chunk-L5XBPLH4.mjs.map
@@ -2,7 +2,7 @@ import {
2
2
  getCommonConfig,
3
3
  getRuntimeInstanceTelemetryInfo,
4
4
  telemetry_client_default
5
- } from "./chunk-4ES2QKLP.mjs";
5
+ } from "./chunk-UNXHBYJH.mjs";
6
6
  import {
7
7
  __name
8
8
  } from "./chunk-FHD4JECV.mjs";
@@ -77,4 +77,4 @@ export {
77
77
  config,
78
78
  copilotRuntimeNextJSPagesRouterEndpoint
79
79
  };
80
- //# sourceMappingURL=chunk-2RQ4BX75.mjs.map
80
+ //# sourceMappingURL=chunk-M52XCCYL.mjs.map
@@ -1,6 +1,6 @@
1
1
  import {
2
2
  LangGraphEventTypes
3
- } from "./chunk-4ES2QKLP.mjs";
3
+ } from "./chunk-UNXHBYJH.mjs";
4
4
  import {
5
5
  __name
6
6
  } from "./chunk-FHD4JECV.mjs";
@@ -156,4 +156,4 @@ export {
156
156
  CustomEventNames,
157
157
  LangGraphAgent
158
158
  };
159
- //# sourceMappingURL=chunk-7WSOM546.mjs.map
159
+ //# sourceMappingURL=chunk-TOTCMKGV.mjs.map
@@ -40,7 +40,7 @@ var require_package = __commonJS({
40
40
  publishConfig: {
41
41
  access: "public"
42
42
  },
43
- version: "1.9.3-next.2",
43
+ version: "1.9.3-next.4",
44
44
  sideEffects: false,
45
45
  main: "./dist/index.js",
46
46
  module: "./dist/index.mjs",
@@ -5918,4 +5918,4 @@ export {
5918
5918
  getCommonConfig,
5919
5919
  copilotRuntimeNodeHttpEndpoint
5920
5920
  };
5921
- //# sourceMappingURL=chunk-4ES2QKLP.mjs.map
5921
+ //# sourceMappingURL=chunk-UNXHBYJH.mjs.map