@copilotkit/shared 2.0.0-next.1 → 2.0.0-rc.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.
- package/LICENSE +21 -0
- package/README.md +93 -12
- package/dist/_virtual/_rolldown/runtime.cjs +29 -0
- package/dist/a2ui-envelope.cjs +154 -0
- package/dist/a2ui-envelope.cjs.map +1 -0
- package/dist/a2ui-envelope.d.cts +101 -0
- package/dist/a2ui-envelope.d.cts.map +1 -0
- package/dist/a2ui-envelope.d.mts +101 -0
- package/dist/a2ui-envelope.d.mts.map +1 -0
- package/dist/a2ui-envelope.mjs +151 -0
- package/dist/a2ui-envelope.mjs.map +1 -0
- package/dist/a2ui-prompts.cjs +259 -0
- package/dist/a2ui-prompts.cjs.map +1 -0
- package/dist/a2ui-prompts.d.cts +79 -0
- package/dist/a2ui-prompts.d.cts.map +1 -0
- package/dist/a2ui-prompts.d.mts +79 -0
- package/dist/a2ui-prompts.d.mts.map +1 -0
- package/dist/a2ui-prompts.mjs +251 -0
- package/dist/a2ui-prompts.mjs.map +1 -0
- package/dist/attachments/content.cjs +17 -0
- package/dist/attachments/content.cjs.map +1 -0
- package/dist/attachments/content.d.cts +9 -0
- package/dist/attachments/content.d.cts.map +1 -0
- package/dist/attachments/content.d.mts +9 -0
- package/dist/attachments/content.d.mts.map +1 -0
- package/dist/attachments/content.mjs +16 -0
- package/dist/attachments/content.mjs.map +1 -0
- package/dist/attachments/types.d.cts +64 -0
- package/dist/attachments/types.d.cts.map +1 -0
- package/dist/attachments/types.d.mts +64 -0
- package/dist/attachments/types.d.mts.map +1 -0
- package/dist/attachments/utils.cjs +137 -0
- package/dist/attachments/utils.cjs.map +1 -0
- package/dist/attachments/utils.d.cts +44 -0
- package/dist/attachments/utils.d.cts.map +1 -0
- package/dist/attachments/utils.d.mts +44 -0
- package/dist/attachments/utils.d.mts.map +1 -0
- package/dist/attachments/utils.mjs +129 -0
- package/dist/attachments/utils.mjs.map +1 -0
- package/dist/constants/index.cjs +25 -0
- package/dist/constants/index.cjs.map +1 -0
- package/dist/constants/index.d.cts +17 -0
- package/dist/constants/index.d.cts.map +1 -0
- package/dist/constants/index.d.mts +17 -0
- package/dist/constants/index.d.mts.map +1 -0
- package/dist/constants/index.mjs +17 -12
- package/dist/constants/index.mjs.map +1 -1
- package/dist/debug-event-envelope.d.cts +13 -0
- package/dist/debug-event-envelope.d.cts.map +1 -0
- package/dist/debug-event-envelope.d.mts +13 -0
- package/dist/debug-event-envelope.d.mts.map +1 -0
- package/dist/debug.cjs +38 -0
- package/dist/debug.cjs.map +1 -0
- package/dist/debug.d.cts +29 -0
- package/dist/debug.d.cts.map +1 -0
- package/dist/debug.d.mts +29 -0
- package/dist/debug.d.mts.map +1 -0
- package/dist/debug.mjs +37 -0
- package/dist/debug.mjs.map +1 -0
- package/dist/event-transforms/index.cjs +15 -0
- package/dist/event-transforms/index.d.cts +4 -0
- package/dist/event-transforms/index.d.mts +4 -0
- package/dist/event-transforms/index.mjs +5 -0
- package/dist/event-transforms/open-generative-ui-middleware.cjs +286 -0
- package/dist/event-transforms/open-generative-ui-middleware.cjs.map +1 -0
- package/dist/event-transforms/open-generative-ui-middleware.d.cts +60 -0
- package/dist/event-transforms/open-generative-ui-middleware.d.cts.map +1 -0
- package/dist/event-transforms/open-generative-ui-middleware.d.mts +60 -0
- package/dist/event-transforms/open-generative-ui-middleware.d.mts.map +1 -0
- package/dist/event-transforms/open-generative-ui-middleware.mjs +283 -0
- package/dist/event-transforms/open-generative-ui-middleware.mjs.map +1 -0
- package/dist/event-transforms/recorded-events.cjs +59 -0
- package/dist/event-transforms/recorded-events.cjs.map +1 -0
- package/dist/event-transforms/recorded-events.d.cts +23 -0
- package/dist/event-transforms/recorded-events.d.cts.map +1 -0
- package/dist/event-transforms/recorded-events.d.mts +23 -0
- package/dist/event-transforms/recorded-events.d.mts.map +1 -0
- package/dist/event-transforms/recorded-events.mjs +58 -0
- package/dist/event-transforms/recorded-events.mjs.map +1 -0
- package/dist/finalize-events.cjs +186 -0
- package/dist/finalize-events.cjs.map +1 -0
- package/dist/finalize-events.d.cts +40 -0
- package/dist/finalize-events.d.cts.map +1 -0
- package/dist/finalize-events.d.mts +40 -0
- package/dist/finalize-events.d.mts.map +1 -0
- package/dist/finalize-events.mjs +184 -0
- package/dist/finalize-events.mjs.map +1 -0
- package/dist/generative-ui/basic-functions.cjs +177 -0
- package/dist/generative-ui/basic-functions.cjs.map +1 -0
- package/dist/generative-ui/basic-functions.d.cts +108 -0
- package/dist/generative-ui/basic-functions.d.cts.map +1 -0
- package/dist/generative-ui/basic-functions.d.mts +108 -0
- package/dist/generative-ui/basic-functions.d.mts.map +1 -0
- package/dist/generative-ui/basic-functions.mjs +167 -0
- package/dist/generative-ui/basic-functions.mjs.map +1 -0
- package/dist/generative-ui/child-refs.cjs +161 -0
- package/dist/generative-ui/child-refs.cjs.map +1 -0
- package/dist/generative-ui/child-refs.d.cts +68 -0
- package/dist/generative-ui/child-refs.d.cts.map +1 -0
- package/dist/generative-ui/child-refs.d.mts +68 -0
- package/dist/generative-ui/child-refs.d.mts.map +1 -0
- package/dist/generative-ui/child-refs.mjs +152 -0
- package/dist/generative-ui/child-refs.mjs.map +1 -0
- package/dist/generative-ui/is-record.cjs +10 -0
- package/dist/generative-ui/is-record.cjs.map +1 -0
- package/dist/generative-ui/is-record.mjs +9 -0
- package/dist/generative-ui/is-record.mjs.map +1 -0
- package/dist/generative-ui/prompt.cjs +91 -0
- package/dist/generative-ui/prompt.cjs.map +1 -0
- package/dist/generative-ui/prompt.d.cts +13 -0
- package/dist/generative-ui/prompt.d.cts.map +1 -0
- package/dist/generative-ui/prompt.d.mts +13 -0
- package/dist/generative-ui/prompt.d.mts.map +1 -0
- package/dist/generative-ui/prompt.mjs +90 -0
- package/dist/generative-ui/prompt.mjs.map +1 -0
- package/dist/generative-ui/render-ui-args.cjs +160 -0
- package/dist/generative-ui/render-ui-args.cjs.map +1 -0
- package/dist/generative-ui/render-ui-args.d.cts +40 -0
- package/dist/generative-ui/render-ui-args.d.cts.map +1 -0
- package/dist/generative-ui/render-ui-args.d.mts +40 -0
- package/dist/generative-ui/render-ui-args.d.mts.map +1 -0
- package/dist/generative-ui/render-ui-args.mjs +159 -0
- package/dist/generative-ui/render-ui-args.mjs.map +1 -0
- package/dist/generative-ui/types.cjs +101 -0
- package/dist/generative-ui/types.cjs.map +1 -0
- package/dist/generative-ui/types.d.cts +270 -0
- package/dist/generative-ui/types.d.cts.map +1 -0
- package/dist/generative-ui/types.d.mts +270 -0
- package/dist/generative-ui/types.d.mts.map +1 -0
- package/dist/generative-ui/types.mjs +86 -0
- package/dist/generative-ui/types.mjs.map +1 -0
- package/dist/generative-ui/validate-operation.cjs +405 -0
- package/dist/generative-ui/validate-operation.cjs.map +1 -0
- package/dist/generative-ui/validate-operation.d.cts +86 -0
- package/dist/generative-ui/validate-operation.d.cts.map +1 -0
- package/dist/generative-ui/validate-operation.d.mts +86 -0
- package/dist/generative-ui/validate-operation.d.mts.map +1 -0
- package/dist/generative-ui/validate-operation.mjs +399 -0
- package/dist/generative-ui/validate-operation.mjs.map +1 -0
- package/dist/index.cjs +233 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +80 -0
- package/dist/index.d.cts.map +1 -0
- package/dist/index.d.mts +80 -0
- package/dist/index.d.mts.map +1 -0
- package/dist/index.mjs +78 -123
- package/dist/index.mjs.map +1 -1
- package/dist/index.umd.js +3979 -0
- package/dist/index.umd.js.map +1 -0
- package/dist/intelligence-routing-fields.cjs +35 -0
- package/dist/intelligence-routing-fields.cjs.map +1 -0
- package/dist/intelligence-routing-fields.d.cts +18 -0
- package/dist/intelligence-routing-fields.d.cts.map +1 -0
- package/dist/intelligence-routing-fields.d.mts +18 -0
- package/dist/intelligence-routing-fields.d.mts.map +1 -0
- package/dist/intelligence-routing-fields.mjs +34 -0
- package/dist/intelligence-routing-fields.mjs.map +1 -0
- package/dist/logger.cjs +7 -0
- package/dist/logger.cjs.map +1 -0
- package/dist/logger.d.cts +5 -0
- package/dist/logger.d.cts.map +1 -0
- package/dist/logger.d.mts +5 -0
- package/dist/logger.d.mts.map +1 -0
- package/dist/logger.mjs +6 -0
- package/dist/logger.mjs.map +1 -0
- package/dist/open-generative-ui-prompts.cjs +8 -0
- package/dist/open-generative-ui-prompts.cjs.map +1 -0
- package/dist/open-generative-ui-prompts.d.cts +6 -0
- package/dist/open-generative-ui-prompts.d.cts.map +1 -0
- package/dist/open-generative-ui-prompts.d.mts +6 -0
- package/dist/open-generative-ui-prompts.d.mts.map +1 -0
- package/dist/open-generative-ui-prompts.mjs +7 -0
- package/dist/open-generative-ui-prompts.mjs.map +1 -0
- package/dist/package.cjs +12 -0
- package/dist/package.cjs.map +1 -0
- package/dist/package.mjs +6 -0
- package/dist/package.mjs.map +1 -0
- package/dist/standard-schema.cjs +31 -0
- package/dist/standard-schema.cjs.map +1 -0
- package/dist/standard-schema.d.cts +33 -0
- package/dist/standard-schema.d.cts.map +1 -0
- package/dist/standard-schema.d.mts +33 -0
- package/dist/standard-schema.d.mts.map +1 -0
- package/dist/standard-schema.mjs +30 -0
- package/dist/standard-schema.mjs.map +1 -0
- package/dist/telemetry/events.d.cts +72 -0
- package/dist/telemetry/events.d.cts.map +1 -0
- package/dist/telemetry/events.d.mts +72 -0
- package/dist/telemetry/events.d.mts.map +1 -0
- package/dist/telemetry/index.cjs +18 -0
- package/dist/telemetry/index.d.cts +5 -0
- package/dist/telemetry/index.d.mts +5 -0
- package/dist/telemetry/index.mjs +6 -12
- package/dist/telemetry/lambda-client.cjs +91 -0
- package/dist/telemetry/lambda-client.cjs.map +1 -0
- package/dist/telemetry/lambda-client.d.cts +31 -0
- package/dist/telemetry/lambda-client.d.cts.map +1 -0
- package/dist/telemetry/lambda-client.d.mts +31 -0
- package/dist/telemetry/lambda-client.d.mts.map +1 -0
- package/dist/telemetry/lambda-client.mjs +87 -0
- package/dist/telemetry/lambda-client.mjs.map +1 -0
- package/dist/telemetry/model-host.cjs +104 -0
- package/dist/telemetry/model-host.cjs.map +1 -0
- package/dist/telemetry/model-host.d.cts +26 -0
- package/dist/telemetry/model-host.d.cts.map +1 -0
- package/dist/telemetry/model-host.d.mts +26 -0
- package/dist/telemetry/model-host.d.mts.map +1 -0
- package/dist/telemetry/model-host.mjs +102 -0
- package/dist/telemetry/model-host.mjs.map +1 -0
- package/dist/telemetry/sampling.cjs +50 -0
- package/dist/telemetry/sampling.cjs.map +1 -0
- package/dist/telemetry/sampling.d.cts +57 -0
- package/dist/telemetry/sampling.d.cts.map +1 -0
- package/dist/telemetry/sampling.d.mts +57 -0
- package/dist/telemetry/sampling.d.mts.map +1 -0
- package/dist/telemetry/sampling.mjs +44 -0
- package/dist/telemetry/sampling.mjs.map +1 -0
- package/dist/telemetry/telemetry-client.cjs +165 -0
- package/dist/telemetry/telemetry-client.cjs.map +1 -0
- package/dist/telemetry/telemetry-client.d.cts +87 -0
- package/dist/telemetry/telemetry-client.d.cts.map +1 -0
- package/dist/telemetry/telemetry-client.d.mts +87 -0
- package/dist/telemetry/telemetry-client.d.mts.map +1 -0
- package/dist/telemetry/telemetry-client.mjs +162 -9
- package/dist/telemetry/telemetry-client.mjs.map +1 -1
- package/dist/telemetry/telemetry-disabled.cjs +20 -0
- package/dist/telemetry/telemetry-disabled.cjs.map +1 -0
- package/dist/telemetry/telemetry-disabled.d.cts +16 -0
- package/dist/telemetry/telemetry-disabled.d.cts.map +1 -0
- package/dist/telemetry/telemetry-disabled.d.mts +16 -0
- package/dist/telemetry/telemetry-disabled.d.mts.map +1 -0
- package/dist/telemetry/telemetry-disabled.mjs +19 -0
- package/dist/telemetry/telemetry-disabled.mjs.map +1 -0
- package/dist/telemetry/utils.cjs +14 -0
- package/dist/telemetry/utils.cjs.map +1 -0
- package/dist/telemetry/utils.mjs +12 -8
- package/dist/telemetry/utils.mjs.map +1 -1
- package/dist/transcription-errors.cjs +84 -0
- package/dist/transcription-errors.cjs.map +1 -0
- package/dist/transcription-errors.d.cts +52 -0
- package/dist/transcription-errors.d.cts.map +1 -0
- package/dist/transcription-errors.d.mts +52 -0
- package/dist/transcription-errors.d.mts.map +1 -0
- package/dist/transcription-errors.mjs +82 -0
- package/dist/transcription-errors.mjs.map +1 -0
- package/dist/types/{action.d.ts → action.d.cts} +32 -32
- package/dist/types/action.d.cts.map +1 -0
- package/dist/types/action.d.mts +59 -0
- package/dist/types/action.d.mts.map +1 -0
- package/dist/types/copilot-cloud-config.d.cts +15 -0
- package/dist/types/copilot-cloud-config.d.cts.map +1 -0
- package/dist/types/copilot-cloud-config.d.mts +15 -0
- package/dist/types/copilot-cloud-config.d.mts.map +1 -0
- package/dist/types/error.d.cts +57 -0
- package/dist/types/error.d.cts.map +1 -0
- package/dist/types/error.d.mts +57 -0
- package/dist/types/error.d.mts.map +1 -0
- package/dist/types/message.d.cts +42 -0
- package/dist/types/message.d.cts.map +1 -0
- package/dist/types/message.d.mts +42 -0
- package/dist/types/message.d.mts.map +1 -0
- package/dist/types/openai-assistant.d.cts +55 -0
- package/dist/types/openai-assistant.d.cts.map +1 -0
- package/dist/types/openai-assistant.d.mts +55 -0
- package/dist/types/openai-assistant.d.mts.map +1 -0
- package/dist/types/utility.d.cts +6 -0
- package/dist/types/utility.d.cts.map +1 -0
- package/dist/types/utility.d.mts +6 -0
- package/dist/types/utility.d.mts.map +1 -0
- package/dist/utils/clipboard.cjs +28 -0
- package/dist/utils/clipboard.cjs.map +1 -0
- package/dist/utils/clipboard.d.cts +14 -0
- package/dist/utils/clipboard.d.cts.map +1 -0
- package/dist/utils/clipboard.d.mts +14 -0
- package/dist/utils/clipboard.d.mts.map +1 -0
- package/dist/utils/clipboard.mjs +27 -0
- package/dist/utils/clipboard.mjs.map +1 -0
- package/dist/utils/conditions.cjs +32 -0
- package/dist/utils/conditions.cjs.map +1 -0
- package/dist/utils/{conditions.d.ts → conditions.d.cts} +16 -11
- package/dist/utils/conditions.d.cts.map +1 -0
- package/dist/utils/conditions.d.mts +31 -0
- package/dist/utils/conditions.d.mts.map +1 -0
- package/dist/utils/conditions.mjs +30 -6
- package/dist/utils/conditions.mjs.map +1 -1
- package/dist/utils/console-styling.cjs +91 -0
- package/dist/utils/console-styling.cjs.map +1 -0
- package/dist/utils/console-styling.d.cts +65 -0
- package/dist/utils/console-styling.d.cts.map +1 -0
- package/dist/utils/console-styling.d.mts +65 -0
- package/dist/utils/console-styling.d.mts.map +1 -0
- package/dist/utils/console-styling.mjs +83 -15
- package/dist/utils/console-styling.mjs.map +1 -1
- package/dist/utils/dashboard-url.cjs +19 -0
- package/dist/utils/dashboard-url.cjs.map +1 -0
- package/dist/utils/dashboard-url.mjs +18 -0
- package/dist/utils/dashboard-url.mjs.map +1 -0
- package/dist/utils/errors.cjs +439 -0
- package/dist/utils/errors.cjs.map +1 -0
- package/dist/utils/{errors.d.ts → errors.d.cts} +188 -156
- package/dist/utils/errors.d.cts.map +1 -0
- package/dist/utils/errors.d.mts +312 -0
- package/dist/utils/errors.d.mts.map +1 -0
- package/dist/utils/errors.mjs +416 -63
- package/dist/utils/errors.mjs.map +1 -1
- package/dist/utils/index.cjs +105 -0
- package/dist/utils/index.cjs.map +1 -0
- package/dist/utils/index.d.cts +58 -0
- package/dist/utils/index.d.cts.map +1 -0
- package/dist/utils/index.d.mts +58 -0
- package/dist/utils/index.d.mts.map +1 -0
- package/dist/utils/index.mjs +97 -107
- package/dist/utils/index.mjs.map +1 -1
- package/dist/utils/inspector-learning.cjs +217 -0
- package/dist/utils/inspector-learning.cjs.map +1 -0
- package/dist/utils/inspector-learning.d.cts +104 -0
- package/dist/utils/inspector-learning.d.cts.map +1 -0
- package/dist/utils/inspector-learning.d.mts +104 -0
- package/dist/utils/inspector-learning.d.mts.map +1 -0
- package/dist/utils/inspector-learning.mjs +215 -0
- package/dist/utils/inspector-learning.mjs.map +1 -0
- package/dist/utils/inspector-metadata.cjs +146 -0
- package/dist/utils/inspector-metadata.cjs.map +1 -0
- package/dist/utils/inspector-metadata.d.cts +55 -0
- package/dist/utils/inspector-metadata.d.cts.map +1 -0
- package/dist/utils/inspector-metadata.d.mts +55 -0
- package/dist/utils/inspector-metadata.d.mts.map +1 -0
- package/dist/utils/inspector-metadata.mjs +146 -0
- package/dist/utils/inspector-metadata.mjs.map +1 -0
- package/dist/utils/inspector-visibility.cjs +13 -0
- package/dist/utils/inspector-visibility.cjs.map +1 -0
- package/dist/utils/inspector-visibility.d.cts +18 -0
- package/dist/utils/inspector-visibility.d.cts.map +1 -0
- package/dist/utils/inspector-visibility.d.mts +18 -0
- package/dist/utils/inspector-visibility.d.mts.map +1 -0
- package/dist/utils/inspector-visibility.mjs +12 -0
- package/dist/utils/inspector-visibility.mjs.map +1 -0
- package/dist/utils/json-schema.cjs +215 -0
- package/dist/utils/json-schema.cjs.map +1 -0
- package/dist/utils/{json-schema.d.ts → json-schema.d.cts} +20 -18
- package/dist/utils/json-schema.d.cts.map +1 -0
- package/dist/utils/json-schema.d.mts +36 -0
- package/dist/utils/json-schema.d.mts.map +1 -0
- package/dist/utils/json-schema.mjs +210 -12
- package/dist/utils/json-schema.mjs.map +1 -1
- package/dist/utils/random-id.cjs +38 -0
- package/dist/utils/random-id.cjs.map +1 -0
- package/dist/utils/{random-id.d.ts → random-id.d.cts} +3 -1
- package/dist/utils/random-id.d.cts.map +1 -0
- package/dist/utils/random-id.d.mts +8 -0
- package/dist/utils/random-id.d.mts.map +1 -0
- package/dist/utils/random-id.mjs +33 -12
- package/dist/utils/random-id.mjs.map +1 -1
- package/dist/utils/requests.cjs +58 -0
- package/dist/utils/requests.cjs.map +1 -0
- package/dist/utils/{requests.d.ts → requests.d.cts} +3 -1
- package/dist/utils/requests.d.cts.map +1 -0
- package/dist/utils/requests.d.mts +12 -0
- package/dist/utils/requests.d.mts.map +1 -0
- package/dist/utils/requests.mjs +56 -6
- package/dist/utils/requests.mjs.map +1 -1
- package/dist/utils/row-render-keys.cjs +206 -0
- package/dist/utils/row-render-keys.cjs.map +1 -0
- package/dist/utils/row-render-keys.d.cts +65 -0
- package/dist/utils/row-render-keys.d.cts.map +1 -0
- package/dist/utils/row-render-keys.d.mts +65 -0
- package/dist/utils/row-render-keys.d.mts.map +1 -0
- package/dist/utils/row-render-keys.mjs +201 -0
- package/dist/utils/row-render-keys.mjs.map +1 -0
- package/dist/utils/types.cjs +9 -0
- package/dist/utils/types.cjs.map +1 -0
- package/dist/utils/types.d.cts +122 -0
- package/dist/utils/types.d.cts.map +1 -0
- package/dist/utils/types.d.mts +122 -0
- package/dist/utils/types.d.mts.map +1 -0
- package/dist/utils/types.mjs +6 -1
- package/dist/utils/types.mjs.map +1 -1
- package/package.json +74 -40
- package/scripts/verify-cjs-exports.cjs +16 -0
- package/src/__tests__/a2ui-envelope.test.ts +434 -0
- package/src/__tests__/a2ui-prompts.test.ts +362 -0
- package/src/__tests__/debug.test.ts +116 -0
- package/src/__tests__/license-context.test.ts +253 -0
- package/src/__tests__/root-entry-browser-safety.test.ts +91 -0
- package/src/__tests__/standard-schema-types.test.ts +144 -0
- package/src/__tests__/standard-schema.test.ts +359 -0
- package/src/__tests__/zod-regression.test.ts +319 -0
- package/src/a2ui-envelope.ts +309 -0
- package/src/a2ui-prompts.ts +322 -0
- package/src/attachments/__tests__/utils.test.ts +214 -0
- package/src/attachments/content.test.ts +48 -0
- package/src/attachments/content.ts +16 -0
- package/src/attachments/index.ts +21 -0
- package/src/attachments/types.ts +77 -0
- package/src/attachments/utils.ts +169 -0
- package/src/constants/index.ts +14 -1
- package/src/debug-event-envelope.ts +9 -0
- package/src/debug.ts +55 -0
- package/src/event-transforms/index.ts +5 -0
- package/src/event-transforms/open-generative-ui-middleware.ts +392 -0
- package/src/event-transforms/recorded-events.test.ts +166 -0
- package/src/event-transforms/recorded-events.ts +74 -0
- package/src/finalize-events.test.ts +284 -0
- package/src/finalize-events.ts +260 -0
- package/src/generative-ui/__tests__/render-ui-args.test.ts +175 -0
- package/src/generative-ui/__tests__/validate-operation.test.ts +977 -0
- package/src/generative-ui/basic-functions.ts +282 -0
- package/src/generative-ui/child-refs.ts +210 -0
- package/src/generative-ui/index.ts +6 -0
- package/src/generative-ui/is-record.ts +4 -0
- package/src/generative-ui/prompt.ts +174 -0
- package/src/generative-ui/render-ui-args.ts +199 -0
- package/src/generative-ui/types.ts +314 -0
- package/src/generative-ui/validate-operation.ts +723 -0
- package/src/index.ts +190 -1
- package/src/intelligence-routing-fields.test.ts +51 -0
- package/src/intelligence-routing-fields.ts +40 -0
- package/src/logger.ts +1 -0
- package/src/open-generative-ui-prompts.ts +20 -0
- package/src/standard-schema.ts +82 -0
- package/src/telemetry/events.ts +37 -10
- package/src/telemetry/index.ts +8 -0
- package/src/telemetry/lambda-client.test.ts +446 -0
- package/src/telemetry/lambda-client.ts +194 -0
- package/src/telemetry/model-host.test.ts +145 -0
- package/src/telemetry/model-host.ts +156 -0
- package/src/telemetry/sampling.test.ts +65 -0
- package/src/telemetry/sampling.ts +103 -0
- package/src/telemetry/telemetry-blank-license-identity.test.ts +128 -0
- package/src/telemetry/telemetry-client.test.ts +798 -0
- package/src/telemetry/telemetry-client.ts +223 -37
- package/src/telemetry/telemetry-disabled.ts +22 -0
- package/src/telemetry/utils.ts +0 -24
- package/src/transcription-errors.ts +99 -0
- package/src/types/__tests__/message.test.ts +62 -0
- package/src/types/action.ts +9 -5
- package/src/types/error.ts +11 -2
- package/src/types/message.ts +33 -5
- package/src/types/openai-assistant.ts +6 -2
- package/src/utils/__tests__/clipboard.test.ts +87 -0
- package/src/utils/__tests__/conditions.test.ts +161 -0
- package/src/utils/__tests__/json-schema.test.ts +812 -0
- package/src/utils/__tests__/row-render-keys.test.ts +388 -0
- package/src/utils/clipboard.ts +23 -0
- package/src/utils/conditions.ts +27 -9
- package/src/utils/console-styling.ts +10 -8
- package/src/utils/dashboard-url.ts +17 -0
- package/src/utils/errors.ts +55 -22
- package/src/utils/index.ts +70 -1
- package/src/utils/inspector-learning.test.ts +423 -0
- package/src/utils/inspector-learning.ts +523 -0
- package/src/utils/inspector-metadata.test.ts +743 -0
- package/src/utils/inspector-metadata.ts +263 -0
- package/src/utils/inspector-visibility.test.ts +43 -0
- package/src/utils/inspector-visibility.ts +17 -0
- package/src/utils/json-schema.ts +156 -12
- package/src/utils/random-id.ts +5 -2
- package/src/utils/requests.ts +3 -1
- package/src/utils/row-render-keys.ts +263 -0
- package/src/utils/types.ts +128 -1
- package/src/utils.test.ts +137 -0
- package/tsconfig.json +10 -2
- package/tsdown.config.ts +49 -0
- package/vitest.config.mjs +11 -0
- package/CHANGELOG.md +0 -1817
- package/dist/chunk-2OJ5OJ2D.mjs +0 -1
- package/dist/chunk-2OJ5OJ2D.mjs.map +0 -1
- package/dist/chunk-64DYJ27R.mjs +0 -201
- package/dist/chunk-64DYJ27R.mjs.map +0 -1
- package/dist/chunk-6QGXWNS5.mjs +0 -34
- package/dist/chunk-6QGXWNS5.mjs.map +0 -1
- package/dist/chunk-6W2UEO2M.mjs +0 -94
- package/dist/chunk-6W2UEO2M.mjs.map +0 -1
- package/dist/chunk-7DJDTRNX.mjs +0 -426
- package/dist/chunk-7DJDTRNX.mjs.map +0 -1
- package/dist/chunk-A66772CV.mjs +0 -107
- package/dist/chunk-A66772CV.mjs.map +0 -1
- package/dist/chunk-BOKE4OKY.mjs +0 -41
- package/dist/chunk-BOKE4OKY.mjs.map +0 -1
- package/dist/chunk-FCCOSO5L.mjs +0 -1
- package/dist/chunk-FCCOSO5L.mjs.map +0 -1
- package/dist/chunk-GYZIHHE6.mjs +0 -13
- package/dist/chunk-GYZIHHE6.mjs.map +0 -1
- package/dist/chunk-IAFBVORQ.mjs +0 -1
- package/dist/chunk-IAFBVORQ.mjs.map +0 -1
- package/dist/chunk-JAAUCDUR.mjs +0 -38
- package/dist/chunk-JAAUCDUR.mjs.map +0 -1
- package/dist/chunk-MSUB6DGR.mjs +0 -1
- package/dist/chunk-MSUB6DGR.mjs.map +0 -1
- package/dist/chunk-N5EP5OD5.mjs +0 -1
- package/dist/chunk-N5EP5OD5.mjs.map +0 -1
- package/dist/chunk-NAFEBKSO.mjs +0 -1
- package/dist/chunk-NAFEBKSO.mjs.map +0 -1
- package/dist/chunk-P7STFMPO.mjs +0 -1
- package/dist/chunk-P7STFMPO.mjs.map +0 -1
- package/dist/chunk-PL5WNHFZ.mjs +0 -50
- package/dist/chunk-PL5WNHFZ.mjs.map +0 -1
- package/dist/chunk-UYARLQNA.mjs +0 -1
- package/dist/chunk-UYARLQNA.mjs.map +0 -1
- package/dist/chunk-XEMZTHQZ.mjs +0 -67
- package/dist/chunk-XEMZTHQZ.mjs.map +0 -1
- package/dist/chunk-XTHC46M2.mjs +0 -1
- package/dist/chunk-XTHC46M2.mjs.map +0 -1
- package/dist/constants/index.d.ts +0 -6
- package/dist/constants/index.js +0 -40
- package/dist/constants/index.js.map +0 -1
- package/dist/index.d.ts +0 -25
- package/dist/index.js +0 -1098
- package/dist/index.js.map +0 -1
- package/dist/telemetry/events.d.ts +0 -45
- package/dist/telemetry/events.js +0 -19
- package/dist/telemetry/events.js.map +0 -1
- package/dist/telemetry/events.mjs +0 -1
- package/dist/telemetry/events.mjs.map +0 -1
- package/dist/telemetry/index.d.ts +0 -3
- package/dist/telemetry/index.js +0 -188
- package/dist/telemetry/index.js.map +0 -1
- package/dist/telemetry/index.mjs.map +0 -1
- package/dist/telemetry/scarf-client.d.ts +0 -7
- package/dist/telemetry/scarf-client.js +0 -59
- package/dist/telemetry/scarf-client.js.map +0 -1
- package/dist/telemetry/scarf-client.mjs +0 -7
- package/dist/telemetry/scarf-client.mjs.map +0 -1
- package/dist/telemetry/security-check.d.ts +0 -2
- package/dist/telemetry/security-check.js +0 -2
- package/dist/telemetry/security-check.js.map +0 -1
- package/dist/telemetry/security-check.mjs +0 -1
- package/dist/telemetry/security-check.mjs.map +0 -1
- package/dist/telemetry/telemetry-client.d.ts +0 -40
- package/dist/telemetry/telemetry-client.js +0 -186
- package/dist/telemetry/telemetry-client.js.map +0 -1
- package/dist/telemetry/utils.d.ts +0 -8
- package/dist/telemetry/utils.js +0 -69
- package/dist/telemetry/utils.js.map +0 -1
- package/dist/types/action.js +0 -19
- package/dist/types/action.js.map +0 -1
- package/dist/types/action.mjs +0 -2
- package/dist/types/action.mjs.map +0 -1
- package/dist/types/copilot-cloud-config.d.ts +0 -13
- package/dist/types/copilot-cloud-config.js +0 -19
- package/dist/types/copilot-cloud-config.js.map +0 -1
- package/dist/types/copilot-cloud-config.mjs +0 -2
- package/dist/types/copilot-cloud-config.mjs.map +0 -1
- package/dist/types/error.d.ts +0 -55
- package/dist/types/error.js +0 -19
- package/dist/types/error.js.map +0 -1
- package/dist/types/error.mjs +0 -2
- package/dist/types/error.mjs.map +0 -1
- package/dist/types/index.d.ts +0 -7
- package/dist/types/index.js +0 -19
- package/dist/types/index.js.map +0 -1
- package/dist/types/index.mjs +0 -8
- package/dist/types/index.mjs.map +0 -1
- package/dist/types/message.d.ts +0 -26
- package/dist/types/message.js +0 -19
- package/dist/types/message.js.map +0 -1
- package/dist/types/message.mjs +0 -2
- package/dist/types/message.mjs.map +0 -1
- package/dist/types/openai-assistant.d.ts +0 -53
- package/dist/types/openai-assistant.js +0 -19
- package/dist/types/openai-assistant.js.map +0 -1
- package/dist/types/openai-assistant.mjs +0 -2
- package/dist/types/openai-assistant.mjs.map +0 -1
- package/dist/types/utility.d.ts +0 -6
- package/dist/types/utility.js +0 -19
- package/dist/types/utility.js.map +0 -1
- package/dist/types/utility.mjs +0 -2
- package/dist/types/utility.mjs.map +0 -1
- package/dist/utils/conditions.js +0 -74
- package/dist/utils/conditions.js.map +0 -1
- package/dist/utils/console-styling.d.ts +0 -84
- package/dist/utils/console-styling.js +0 -123
- package/dist/utils/console-styling.js.map +0 -1
- package/dist/utils/errors.js +0 -443
- package/dist/utils/errors.js.map +0 -1
- package/dist/utils/index.d.ts +0 -32
- package/dist/utils/index.js +0 -927
- package/dist/utils/index.js.map +0 -1
- package/dist/utils/json-schema.js +0 -228
- package/dist/utils/json-schema.js.map +0 -1
- package/dist/utils/random-id.js +0 -68
- package/dist/utils/random-id.js.map +0 -1
- package/dist/utils/requests.js +0 -91
- package/dist/utils/requests.js.map +0 -1
- package/dist/utils/types.d.ts +0 -20
- package/dist/utils/types.js +0 -19
- package/dist/utils/types.js.map +0 -1
- package/jest.config.js +0 -5
- package/src/telemetry/scarf-client.ts +0 -39
- package/src/telemetry/security-check.ts +0 -0
- package/src/utils/json-schema.test.ts +0 -383
- package/tsup.config.ts +0 -11
|
@@ -0,0 +1,446 @@
|
|
|
1
|
+
import { describe, test, expect, vi, beforeEach, afterEach } from "vitest";
|
|
2
|
+
import { parseTelemetryIdFromLicense, send } from "./lambda-client";
|
|
3
|
+
|
|
4
|
+
const EXPECTED_TELEMETRY_SINK_URL =
|
|
5
|
+
process.env.COPILOTKIT_TELEMETRY_URL ??
|
|
6
|
+
"https://telemetry.copilotkit.ai/ingest";
|
|
7
|
+
const TELEMETRY_ID_HEADER = "x-copilotkit-telemetry-id";
|
|
8
|
+
const LEGACY_IDENTITY_PAYLOAD = Buffer.from(
|
|
9
|
+
JSON.stringify({ telemetry_id: "legacy-telemetry-id" }),
|
|
10
|
+
).toString("base64url");
|
|
11
|
+
const INVALID_BASE64URL_PAYLOADS = [
|
|
12
|
+
{
|
|
13
|
+
label: "a dollar sign",
|
|
14
|
+
payload: `${LEGACY_IDENTITY_PAYLOAD}$`,
|
|
15
|
+
},
|
|
16
|
+
{
|
|
17
|
+
label: "a space",
|
|
18
|
+
payload: `${LEGACY_IDENTITY_PAYLOAD} `,
|
|
19
|
+
},
|
|
20
|
+
{
|
|
21
|
+
label: "a line break",
|
|
22
|
+
payload: `${LEGACY_IDENTITY_PAYLOAD}\n`,
|
|
23
|
+
},
|
|
24
|
+
{
|
|
25
|
+
label: "an impossible length",
|
|
26
|
+
payload: `${Buffer.from(JSON.stringify({ telemetry_id: "xx" })).toString(
|
|
27
|
+
"base64url",
|
|
28
|
+
)}A`,
|
|
29
|
+
},
|
|
30
|
+
] as const;
|
|
31
|
+
|
|
32
|
+
test("normalizes surrounding HTTP whitespace in a legacy license identity", () => {
|
|
33
|
+
const telemetryId = "\t legacy-telemetry-id \t";
|
|
34
|
+
const payload = Buffer.from(
|
|
35
|
+
JSON.stringify({ telemetry_id: telemetryId }),
|
|
36
|
+
).toString("base64url");
|
|
37
|
+
|
|
38
|
+
expect(parseTelemetryIdFromLicense(`header.${payload}.sig`)).toBe(
|
|
39
|
+
"legacy-telemetry-id",
|
|
40
|
+
);
|
|
41
|
+
});
|
|
42
|
+
|
|
43
|
+
test("rejects an ingest-invalid UTF-8 legacy identity in the browser fallback", () => {
|
|
44
|
+
const payload = Buffer.from(
|
|
45
|
+
JSON.stringify({ telemetry_id: "tenant-é" }),
|
|
46
|
+
).toString("base64url");
|
|
47
|
+
vi.stubGlobal("Buffer", undefined);
|
|
48
|
+
|
|
49
|
+
try {
|
|
50
|
+
expect(parseTelemetryIdFromLicense(`header.${payload}.sig`)).toBeNull();
|
|
51
|
+
} finally {
|
|
52
|
+
vi.unstubAllGlobals();
|
|
53
|
+
}
|
|
54
|
+
});
|
|
55
|
+
|
|
56
|
+
test.each(INVALID_BASE64URL_PAYLOADS)(
|
|
57
|
+
"rejects a legacy payload with $label in Node and the browser fallback",
|
|
58
|
+
({ payload }) => {
|
|
59
|
+
const token = `header.${payload}.sig`;
|
|
60
|
+
|
|
61
|
+
expect(parseTelemetryIdFromLicense(token)).toBeNull();
|
|
62
|
+
|
|
63
|
+
vi.stubGlobal("Buffer", undefined);
|
|
64
|
+
try {
|
|
65
|
+
expect(parseTelemetryIdFromLicense(token)).toBeNull();
|
|
66
|
+
} finally {
|
|
67
|
+
vi.unstubAllGlobals();
|
|
68
|
+
}
|
|
69
|
+
},
|
|
70
|
+
);
|
|
71
|
+
|
|
72
|
+
/**
|
|
73
|
+
* Captures the telemetry request without replacing fetch with an untyped mock.
|
|
74
|
+
*/
|
|
75
|
+
function setupCapturedRequest() {
|
|
76
|
+
let capturedRequest:
|
|
77
|
+
| {
|
|
78
|
+
bodyText: string;
|
|
79
|
+
headers: Record<string, string>;
|
|
80
|
+
rawTelemetryIdHeader: string | undefined;
|
|
81
|
+
url: string;
|
|
82
|
+
}
|
|
83
|
+
| undefined;
|
|
84
|
+
const fetchMock = vi
|
|
85
|
+
.spyOn(globalThis, "fetch")
|
|
86
|
+
.mockImplementation((input, init) => {
|
|
87
|
+
if (typeof init?.body !== "string") {
|
|
88
|
+
throw new Error("Expected telemetry request body to be a string");
|
|
89
|
+
}
|
|
90
|
+
if (
|
|
91
|
+
init.headers === undefined ||
|
|
92
|
+
init.headers instanceof Headers ||
|
|
93
|
+
Array.isArray(init.headers)
|
|
94
|
+
) {
|
|
95
|
+
throw new Error("Expected telemetry request headers to be a record");
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
capturedRequest = {
|
|
99
|
+
bodyText: init.body,
|
|
100
|
+
headers: Object.fromEntries(new Headers(init.headers).entries()),
|
|
101
|
+
rawTelemetryIdHeader:
|
|
102
|
+
init.headers["X-CopilotKit-Telemetry-Id"] ?? undefined,
|
|
103
|
+
url: String(input),
|
|
104
|
+
};
|
|
105
|
+
return Promise.resolve(new Response(null, { status: 202 }));
|
|
106
|
+
});
|
|
107
|
+
|
|
108
|
+
const readRequest = () => {
|
|
109
|
+
if (!capturedRequest) {
|
|
110
|
+
throw new Error("Expected telemetry send to reach fetch successfully");
|
|
111
|
+
}
|
|
112
|
+
return capturedRequest;
|
|
113
|
+
};
|
|
114
|
+
|
|
115
|
+
return {
|
|
116
|
+
readRequest,
|
|
117
|
+
teardown: () => fetchMock.mockRestore(),
|
|
118
|
+
};
|
|
119
|
+
}
|
|
120
|
+
|
|
121
|
+
test.each(["bad\nid", "bad\u0000id", "tenant-🚀"])(
|
|
122
|
+
"header-invalid legacy identity %j sends anonymously instead of dropping the event",
|
|
123
|
+
async (invalidTelemetryId) => {
|
|
124
|
+
const payload = Buffer.from(
|
|
125
|
+
JSON.stringify({ telemetry_id: invalidTelemetryId }),
|
|
126
|
+
).toString("base64url");
|
|
127
|
+
const { readRequest, teardown } = setupCapturedRequest();
|
|
128
|
+
|
|
129
|
+
try {
|
|
130
|
+
await send({
|
|
131
|
+
event: "oss.runtime.instance_created",
|
|
132
|
+
licenseToken: `header.${payload}.sig`,
|
|
133
|
+
});
|
|
134
|
+
|
|
135
|
+
expect(readRequest().rawTelemetryIdHeader).toBeUndefined();
|
|
136
|
+
} finally {
|
|
137
|
+
teardown();
|
|
138
|
+
}
|
|
139
|
+
},
|
|
140
|
+
);
|
|
141
|
+
|
|
142
|
+
test.each(INVALID_BASE64URL_PAYLOADS)(
|
|
143
|
+
"legacy payload with $label sends anonymously in Node and the browser fallback",
|
|
144
|
+
async ({ payload }) => {
|
|
145
|
+
const { readRequest, teardown } = setupCapturedRequest();
|
|
146
|
+
const sendMalformedToken = () =>
|
|
147
|
+
send({
|
|
148
|
+
event: "oss.runtime.instance_created",
|
|
149
|
+
licenseToken: `header.${payload}.sig`,
|
|
150
|
+
});
|
|
151
|
+
|
|
152
|
+
try {
|
|
153
|
+
await sendMalformedToken();
|
|
154
|
+
expect(readRequest().rawTelemetryIdHeader).toBeUndefined();
|
|
155
|
+
|
|
156
|
+
vi.stubGlobal("Buffer", undefined);
|
|
157
|
+
await sendMalformedToken();
|
|
158
|
+
expect(readRequest().rawTelemetryIdHeader).toBeUndefined();
|
|
159
|
+
} finally {
|
|
160
|
+
vi.unstubAllGlobals();
|
|
161
|
+
teardown();
|
|
162
|
+
}
|
|
163
|
+
},
|
|
164
|
+
);
|
|
165
|
+
|
|
166
|
+
describe("lambda-client send()", () => {
|
|
167
|
+
let fetchMock: ReturnType<typeof vi.fn>;
|
|
168
|
+
let originalFetch: typeof fetch;
|
|
169
|
+
|
|
170
|
+
beforeEach(() => {
|
|
171
|
+
originalFetch = global.fetch;
|
|
172
|
+
fetchMock = vi.fn().mockResolvedValue(new Response("", { status: 202 }));
|
|
173
|
+
global.fetch = fetchMock as unknown as typeof fetch;
|
|
174
|
+
});
|
|
175
|
+
|
|
176
|
+
afterEach(() => {
|
|
177
|
+
global.fetch = originalFetch;
|
|
178
|
+
});
|
|
179
|
+
|
|
180
|
+
function bodyOf(callIdx = 0): {
|
|
181
|
+
properties: Record<string, unknown>;
|
|
182
|
+
global_properties: Record<string, unknown>;
|
|
183
|
+
} {
|
|
184
|
+
const init = fetchMock.mock.calls[callIdx][1] as RequestInit;
|
|
185
|
+
return JSON.parse(init.body as string);
|
|
186
|
+
}
|
|
187
|
+
|
|
188
|
+
function headersOf(callIdx = 0): Record<string, string> {
|
|
189
|
+
const init = fetchMock.mock.calls[callIdx][1] as RequestInit;
|
|
190
|
+
return init.headers as Record<string, string>;
|
|
191
|
+
}
|
|
192
|
+
|
|
193
|
+
test("strips cloud.public_api_key from properties before sending", async () => {
|
|
194
|
+
await send({
|
|
195
|
+
event: "oss.runtime.copilot_request_created",
|
|
196
|
+
properties: {
|
|
197
|
+
requestType: "run",
|
|
198
|
+
"cloud.api_key_provided": true,
|
|
199
|
+
"cloud.public_api_key": "ck_live_abc.secret-blob",
|
|
200
|
+
},
|
|
201
|
+
});
|
|
202
|
+
|
|
203
|
+
const body = bodyOf();
|
|
204
|
+
expect(body.properties).not.toHaveProperty("cloud.public_api_key");
|
|
205
|
+
// Boolean indicator stays — it's not the key itself.
|
|
206
|
+
expect(body.properties).toMatchObject({
|
|
207
|
+
requestType: "run",
|
|
208
|
+
"cloud.api_key_provided": true,
|
|
209
|
+
});
|
|
210
|
+
});
|
|
211
|
+
|
|
212
|
+
test("strips cloud.publicApiKey from globalProperties (v1 camelCase variant)", async () => {
|
|
213
|
+
await send({
|
|
214
|
+
event: "oss.runtime.instance_created",
|
|
215
|
+
globalProperties: {
|
|
216
|
+
"cloud.publicApiKey": "ck_live_abc.secret-blob",
|
|
217
|
+
"cloud.baseUrl": "https://api.cloud.copilotkit.ai",
|
|
218
|
+
sampleRate: 0.05,
|
|
219
|
+
},
|
|
220
|
+
});
|
|
221
|
+
|
|
222
|
+
const body = bodyOf();
|
|
223
|
+
expect(body.global_properties).not.toHaveProperty("cloud.publicApiKey");
|
|
224
|
+
// baseUrl is unrelated to attribution and rides through.
|
|
225
|
+
expect(body.global_properties).toMatchObject({
|
|
226
|
+
"cloud.baseUrl": "https://api.cloud.copilotkit.ai",
|
|
227
|
+
sampleRate: 0.05,
|
|
228
|
+
});
|
|
229
|
+
});
|
|
230
|
+
|
|
231
|
+
test("emits X-CopilotKit-Telemetry-Id when license JWT carries telemetry_id", async () => {
|
|
232
|
+
const payload = Buffer.from('{"telemetry_id":"abc-123"}').toString(
|
|
233
|
+
"base64url",
|
|
234
|
+
);
|
|
235
|
+
const token = `header.${payload}.sig`;
|
|
236
|
+
|
|
237
|
+
await send({
|
|
238
|
+
event: "oss.runtime.instance_created",
|
|
239
|
+
licenseToken: token,
|
|
240
|
+
});
|
|
241
|
+
|
|
242
|
+
expect(headersOf()["X-CopilotKit-Telemetry-Id"]).toBe("abc-123");
|
|
243
|
+
});
|
|
244
|
+
|
|
245
|
+
test("falls through to anonymous when license JWT has no telemetry_id", async () => {
|
|
246
|
+
const payload = Buffer.from('{"license_id":"foo"}').toString("base64url");
|
|
247
|
+
const token = `header.${payload}.sig`;
|
|
248
|
+
|
|
249
|
+
await send({
|
|
250
|
+
event: "oss.runtime.instance_created",
|
|
251
|
+
licenseToken: token,
|
|
252
|
+
});
|
|
253
|
+
|
|
254
|
+
expect(headersOf()["X-CopilotKit-Telemetry-Id"]).toBeUndefined();
|
|
255
|
+
});
|
|
256
|
+
|
|
257
|
+
test("falls through to anonymous when license token isn't a JWT shape", async () => {
|
|
258
|
+
await send({
|
|
259
|
+
event: "oss.runtime.instance_created",
|
|
260
|
+
licenseToken: "not-a-jwt",
|
|
261
|
+
});
|
|
262
|
+
|
|
263
|
+
expect(headersOf()["X-CopilotKit-Telemetry-Id"]).toBeUndefined();
|
|
264
|
+
});
|
|
265
|
+
|
|
266
|
+
test("swallows fetch errors silently", async () => {
|
|
267
|
+
fetchMock.mockRejectedValueOnce(new Error("network down"));
|
|
268
|
+
|
|
269
|
+
await expect(
|
|
270
|
+
send({ event: "oss.runtime.instance_created" }),
|
|
271
|
+
).resolves.toBeUndefined();
|
|
272
|
+
});
|
|
273
|
+
});
|
|
274
|
+
|
|
275
|
+
const lambdaIdentityTransportCases = [
|
|
276
|
+
{
|
|
277
|
+
label: "standalone identity over a legacy license identity",
|
|
278
|
+
explicitTelemetryId: "explicit-telemetry-id",
|
|
279
|
+
licenseTelemetryId: "license-telemetry-id",
|
|
280
|
+
expectedTelemetryId: "explicit-telemetry-id",
|
|
281
|
+
},
|
|
282
|
+
{
|
|
283
|
+
label: "normalized standalone identity over a legacy license identity",
|
|
284
|
+
explicitTelemetryId: "\t explicit-telemetry-id \t",
|
|
285
|
+
licenseTelemetryId: "license-telemetry-id",
|
|
286
|
+
expectedTelemetryId: "explicit-telemetry-id",
|
|
287
|
+
},
|
|
288
|
+
{
|
|
289
|
+
label: "legacy license identity without a standalone identity",
|
|
290
|
+
explicitTelemetryId: undefined,
|
|
291
|
+
licenseTelemetryId: "license-telemetry-id",
|
|
292
|
+
expectedTelemetryId: "license-telemetry-id",
|
|
293
|
+
},
|
|
294
|
+
{
|
|
295
|
+
label: "legacy license identity with an empty standalone identity",
|
|
296
|
+
explicitTelemetryId: "",
|
|
297
|
+
licenseTelemetryId: "license-telemetry-id",
|
|
298
|
+
expectedTelemetryId: "license-telemetry-id",
|
|
299
|
+
},
|
|
300
|
+
{
|
|
301
|
+
label: "legacy license identity with a whitespace-only standalone identity",
|
|
302
|
+
explicitTelemetryId: " \t ",
|
|
303
|
+
licenseTelemetryId: "license-telemetry-id",
|
|
304
|
+
expectedTelemetryId: "license-telemetry-id",
|
|
305
|
+
},
|
|
306
|
+
{
|
|
307
|
+
label: "legacy license identity with a header-invalid standalone identity",
|
|
308
|
+
explicitTelemetryId: "bad\nid",
|
|
309
|
+
licenseTelemetryId: "license-telemetry-id",
|
|
310
|
+
expectedTelemetryId: "license-telemetry-id",
|
|
311
|
+
},
|
|
312
|
+
{
|
|
313
|
+
label: "legacy license identity with an ingest-invalid standalone identity",
|
|
314
|
+
explicitTelemetryId: "team.prod",
|
|
315
|
+
licenseTelemetryId: "license-telemetry-id",
|
|
316
|
+
expectedTelemetryId: "license-telemetry-id",
|
|
317
|
+
},
|
|
318
|
+
{
|
|
319
|
+
label: "legacy license identity with an overlong standalone identity",
|
|
320
|
+
explicitTelemetryId: "a".repeat(129),
|
|
321
|
+
licenseTelemetryId: "license-telemetry-id",
|
|
322
|
+
expectedTelemetryId: "license-telemetry-id",
|
|
323
|
+
},
|
|
324
|
+
] as const;
|
|
325
|
+
|
|
326
|
+
test.each(lambdaIdentityTransportCases)(
|
|
327
|
+
"sends $label only through the telemetry identity header",
|
|
328
|
+
async ({ explicitTelemetryId, licenseTelemetryId, expectedTelemetryId }) => {
|
|
329
|
+
const payload = Buffer.from(
|
|
330
|
+
JSON.stringify({ telemetry_id: licenseTelemetryId }),
|
|
331
|
+
).toString("base64url");
|
|
332
|
+
const licenseToken = `header.${payload}.sig`;
|
|
333
|
+
const { readRequest, teardown } = setupCapturedRequest();
|
|
334
|
+
|
|
335
|
+
try {
|
|
336
|
+
await send({
|
|
337
|
+
event: "oss.runtime.instance_created",
|
|
338
|
+
properties: { requestType: "run" },
|
|
339
|
+
globalProperties: { sampleRate: 0.25 },
|
|
340
|
+
packageName: "@copilotkit/runtime",
|
|
341
|
+
packageVersion: "1.2.3",
|
|
342
|
+
licenseToken,
|
|
343
|
+
telemetryId: explicitTelemetryId,
|
|
344
|
+
});
|
|
345
|
+
|
|
346
|
+
const { bodyText, headers, rawTelemetryIdHeader, url } = readRequest();
|
|
347
|
+
expect(url).toBe(EXPECTED_TELEMETRY_SINK_URL);
|
|
348
|
+
expect(rawTelemetryIdHeader).toBe(expectedTelemetryId);
|
|
349
|
+
expect(headers).toEqual({
|
|
350
|
+
"content-type": "application/json",
|
|
351
|
+
[TELEMETRY_ID_HEADER]: expectedTelemetryId,
|
|
352
|
+
"user-agent": "CopilotKit-Runtime/1.2.3 (@copilotkit/runtime)",
|
|
353
|
+
});
|
|
354
|
+
expect(JSON.parse(bodyText)).toEqual({
|
|
355
|
+
event: "oss.runtime.instance_created",
|
|
356
|
+
properties: { requestType: "run" },
|
|
357
|
+
global_properties: { sampleRate: 0.25 },
|
|
358
|
+
package: {
|
|
359
|
+
name: "@copilotkit/runtime",
|
|
360
|
+
version: "1.2.3",
|
|
361
|
+
},
|
|
362
|
+
ts: expect.any(Number),
|
|
363
|
+
});
|
|
364
|
+
|
|
365
|
+
const nonIdentityHeaders = Object.entries(headers).filter(
|
|
366
|
+
([name]) => name !== TELEMETRY_ID_HEADER,
|
|
367
|
+
);
|
|
368
|
+
const nonIdentityHeaderText = JSON.stringify(nonIdentityHeaders);
|
|
369
|
+
for (const identity of [explicitTelemetryId, licenseTelemetryId]) {
|
|
370
|
+
if (identity === undefined || identity.trim().length === 0) continue;
|
|
371
|
+
expect(url).not.toContain(identity);
|
|
372
|
+
expect(bodyText).not.toContain(identity);
|
|
373
|
+
expect(nonIdentityHeaderText).not.toContain(identity);
|
|
374
|
+
}
|
|
375
|
+
} finally {
|
|
376
|
+
teardown();
|
|
377
|
+
}
|
|
378
|
+
},
|
|
379
|
+
);
|
|
380
|
+
|
|
381
|
+
test.each(["", " \t "])(
|
|
382
|
+
"blank standalone identity %j without a legacy identity sends no identity header",
|
|
383
|
+
async (blankTelemetryId) => {
|
|
384
|
+
const { readRequest, teardown } = setupCapturedRequest();
|
|
385
|
+
|
|
386
|
+
try {
|
|
387
|
+
await send({
|
|
388
|
+
event: "oss.runtime.instance_created",
|
|
389
|
+
telemetryId: blankTelemetryId,
|
|
390
|
+
});
|
|
391
|
+
|
|
392
|
+
expect(readRequest().headers[TELEMETRY_ID_HEADER]).toBeUndefined();
|
|
393
|
+
} finally {
|
|
394
|
+
teardown();
|
|
395
|
+
}
|
|
396
|
+
},
|
|
397
|
+
);
|
|
398
|
+
|
|
399
|
+
test.each([
|
|
400
|
+
"bad\nid",
|
|
401
|
+
"bad\rid",
|
|
402
|
+
"bad\u0000id",
|
|
403
|
+
"bad\u0001id",
|
|
404
|
+
"bad\u007fid",
|
|
405
|
+
"tenant-🚀",
|
|
406
|
+
])(
|
|
407
|
+
"header-invalid standalone identity %j sends anonymously instead of dropping the event",
|
|
408
|
+
async (invalidTelemetryId) => {
|
|
409
|
+
const { readRequest, teardown } = setupCapturedRequest();
|
|
410
|
+
|
|
411
|
+
try {
|
|
412
|
+
await send({
|
|
413
|
+
event: "oss.runtime.instance_created",
|
|
414
|
+
telemetryId: invalidTelemetryId,
|
|
415
|
+
});
|
|
416
|
+
|
|
417
|
+
const { headers, rawTelemetryIdHeader } = readRequest();
|
|
418
|
+
expect(rawTelemetryIdHeader).toBeUndefined();
|
|
419
|
+
expect(headers[TELEMETRY_ID_HEADER]).toBeUndefined();
|
|
420
|
+
} finally {
|
|
421
|
+
teardown();
|
|
422
|
+
}
|
|
423
|
+
},
|
|
424
|
+
);
|
|
425
|
+
|
|
426
|
+
test("does not treat COPILOTKIT_TELEMETRY_ID as an identity alias", async () => {
|
|
427
|
+
const originalTelemetryId = process.env.COPILOTKIT_TELEMETRY_ID;
|
|
428
|
+
const envTelemetryId = "environment-telemetry-id";
|
|
429
|
+
process.env.COPILOTKIT_TELEMETRY_ID = envTelemetryId;
|
|
430
|
+
const { readRequest, teardown } = setupCapturedRequest();
|
|
431
|
+
|
|
432
|
+
try {
|
|
433
|
+
await send({ event: "oss.runtime.instance_created" });
|
|
434
|
+
|
|
435
|
+
const { bodyText, headers } = readRequest();
|
|
436
|
+
expect(headers[TELEMETRY_ID_HEADER]).toBeUndefined();
|
|
437
|
+
expect(bodyText).not.toContain(envTelemetryId);
|
|
438
|
+
} finally {
|
|
439
|
+
if (originalTelemetryId === undefined) {
|
|
440
|
+
delete process.env.COPILOTKIT_TELEMETRY_ID;
|
|
441
|
+
} else {
|
|
442
|
+
process.env.COPILOTKIT_TELEMETRY_ID = originalTelemetryId;
|
|
443
|
+
}
|
|
444
|
+
teardown();
|
|
445
|
+
}
|
|
446
|
+
});
|
|
@@ -0,0 +1,194 @@
|
|
|
1
|
+
// Telemetry sink client.
|
|
2
|
+
//
|
|
3
|
+
// Posts events to a CopilotKit-controlled telemetry-sink endpoint, which
|
|
4
|
+
// fans out to Scarf, Reo, and any future destinations. Replaces the direct
|
|
5
|
+
// per-vendor calls (formerly a Scarf-specific client) so that vendor changes
|
|
6
|
+
// don't require SDK releases and so that downstream services we don't want
|
|
7
|
+
// exposed to OSS readers (e.g. the email-enrichment service backing Reo) stay
|
|
8
|
+
// private.
|
|
9
|
+
//
|
|
10
|
+
// Two attribution modes:
|
|
11
|
+
// - Identified: a standalone telemetry id or a CopilotKit license token is
|
|
12
|
+
// configured. Standalone identity takes precedence. License tokens are
|
|
13
|
+
// JWTs (header.payload.sig) whose payload carries `telemetry_id`; the SDK
|
|
14
|
+
// base64url-decodes the payload — without verifying the Ed25519 signature,
|
|
15
|
+
// which is the license-verifier's job. The resolved identity is emitted
|
|
16
|
+
// only via `X-CopilotKit-Telemetry-Id`.
|
|
17
|
+
// - Anonymous: no license token, or a malformed/non-JWT one. No
|
|
18
|
+
// telemetry-id header; events still flow, attribution is best-effort
|
|
19
|
+
// from request-level signals (IP, UA).
|
|
20
|
+
//
|
|
21
|
+
// Note: CopilotCloud customer API keys (`ck_<env>_<id>.<secret>`) are
|
|
22
|
+
// unrelated to telemetry attribution. They flow into Segment / PostHog
|
|
23
|
+
// via the v1 shared TelemetryClient and never reach this code path.
|
|
24
|
+
//
|
|
25
|
+
// Best-effort: every error is swallowed. Telemetry must not break the
|
|
26
|
+
// host application.
|
|
27
|
+
|
|
28
|
+
const TELEMETRY_SINK_URL =
|
|
29
|
+
(typeof process !== "undefined" && process.env?.COPILOTKIT_TELEMETRY_URL) ||
|
|
30
|
+
"https://telemetry.copilotkit.ai/ingest";
|
|
31
|
+
|
|
32
|
+
const FETCH_TIMEOUT_MS = 3000;
|
|
33
|
+
const TELEMETRY_ID_PATTERN = /^[A-Za-z0-9_-]{1,128}$/;
|
|
34
|
+
|
|
35
|
+
export interface LambdaSendOptions {
|
|
36
|
+
event: string;
|
|
37
|
+
properties?: Record<string, unknown>;
|
|
38
|
+
globalProperties?: Record<string, unknown>;
|
|
39
|
+
packageName?: string;
|
|
40
|
+
packageVersion?: string;
|
|
41
|
+
/** Standalone analytics identity, resolved before any legacy license claim. */
|
|
42
|
+
telemetryId?: string;
|
|
43
|
+
// The CopilotKit license token (Ed25519-signed JWT), when one is
|
|
44
|
+
// configured on the runtime. The sender base64url-decodes the payload
|
|
45
|
+
// segment to extract `telemetry_id`; missing or malformed tokens
|
|
46
|
+
// produce an anonymous send.
|
|
47
|
+
licenseToken?: string;
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
/**
|
|
51
|
+
* Return the first telemetry identity accepted by the ingest service.
|
|
52
|
+
*
|
|
53
|
+
* Empty and whitespace-only values are unconfigured placeholders and must not
|
|
54
|
+
* suppress a later identity source. Leading and trailing HTTP spaces and tabs
|
|
55
|
+
* are removed before validation. The ingest service accepts 1 to 128 ASCII
|
|
56
|
+
* letters, digits, underscores, and hyphens.
|
|
57
|
+
*
|
|
58
|
+
* @internal
|
|
59
|
+
*/
|
|
60
|
+
export function firstNonBlankTelemetryId(
|
|
61
|
+
...candidates: ReadonlyArray<string | undefined>
|
|
62
|
+
): string | undefined {
|
|
63
|
+
for (const candidate of candidates) {
|
|
64
|
+
if (candidate === undefined) {
|
|
65
|
+
continue;
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
const normalized = candidate.replace(/^[\t ]+|[\t ]+$/g, "");
|
|
69
|
+
if (TELEMETRY_ID_PATTERN.test(normalized)) {
|
|
70
|
+
return normalized;
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
return undefined;
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
// These fields aren't used by the telemetry service, so we strip them
|
|
78
|
+
// at the wire boundary rather than rely on every caller to omit them.
|
|
79
|
+
// Both the snake_case and camelCase variants are listed because callers
|
|
80
|
+
// upstream use different conventions.
|
|
81
|
+
const STRIPPED_KEYS = new Set(["cloud.public_api_key", "cloud.publicApiKey"]);
|
|
82
|
+
|
|
83
|
+
function stripCloudKeys(
|
|
84
|
+
obj: Record<string, unknown> | undefined,
|
|
85
|
+
): Record<string, unknown> {
|
|
86
|
+
if (!obj) return {};
|
|
87
|
+
const out: Record<string, unknown> = {};
|
|
88
|
+
for (const [k, v] of Object.entries(obj)) {
|
|
89
|
+
if (!STRIPPED_KEYS.has(k)) out[k] = v;
|
|
90
|
+
}
|
|
91
|
+
return out;
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
// Pull telemetry_id out of a CopilotKit license token without verifying
|
|
95
|
+
// the signature. The token shape is a standard JWT
|
|
96
|
+
// (`<header>.<payload>.<sig>`) with base64url-encoded segments; the
|
|
97
|
+
// payload is UTF-8 JSON with a telemetry_id accepted by the ingest service.
|
|
98
|
+
//
|
|
99
|
+
// Verification (Ed25519, key rotation, expiry) is the license-verifier
|
|
100
|
+
// package's job. For telemetry attribution we only need the claimed id —
|
|
101
|
+
// the trust model is claim-only on the Lambda side anyway.
|
|
102
|
+
//
|
|
103
|
+
// Exported so TelemetryClient setters can detect unparseable tokens at
|
|
104
|
+
// configuration time and surface a single warning, instead of silently
|
|
105
|
+
// emitting anonymous events on every capture.
|
|
106
|
+
export function parseTelemetryIdFromLicense(token?: string): string | null {
|
|
107
|
+
if (!token) return null;
|
|
108
|
+
const parts = token.split(".");
|
|
109
|
+
if (parts.length !== 3) return null;
|
|
110
|
+
try {
|
|
111
|
+
const payload = parts[1];
|
|
112
|
+
if (!/^[A-Za-z0-9_-]+$/.test(payload) || payload.length % 4 === 1) {
|
|
113
|
+
return null;
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
let b64 = payload.replace(/-/g, "+").replace(/_/g, "/");
|
|
117
|
+
const padding = (4 - (b64.length % 4)) % 4;
|
|
118
|
+
b64 += "=".repeat(padding);
|
|
119
|
+
const json =
|
|
120
|
+
typeof Buffer !== "undefined"
|
|
121
|
+
? Buffer.from(b64, "base64").toString("utf8")
|
|
122
|
+
: new TextDecoder().decode(
|
|
123
|
+
Uint8Array.from(atob(b64), (character) => character.charCodeAt(0)),
|
|
124
|
+
);
|
|
125
|
+
const decoded = JSON.parse(json) as { telemetry_id?: unknown };
|
|
126
|
+
const telemetryId =
|
|
127
|
+
typeof decoded.telemetry_id === "string"
|
|
128
|
+
? decoded.telemetry_id
|
|
129
|
+
: undefined;
|
|
130
|
+
return firstNonBlankTelemetryId(telemetryId) ?? null;
|
|
131
|
+
} catch {
|
|
132
|
+
return null;
|
|
133
|
+
}
|
|
134
|
+
}
|
|
135
|
+
|
|
136
|
+
// Parse the telemetry_id from a license token AND emit the rollout smoke
|
|
137
|
+
// signal if the parse returned null. Returning the parsed id lets callers
|
|
138
|
+
// cache it in one step (avoiding a second parseTelemetryIdFromLicense
|
|
139
|
+
// pass) while keeping the warn text in lockstep between v1 (shared) and
|
|
140
|
+
// v2 (runtime) TelemetryClient.setLicenseToken.
|
|
141
|
+
export function parseAndWarnTelemetryId(licenseToken: string): string | null {
|
|
142
|
+
const telemetryId = parseTelemetryIdFromLicense(licenseToken);
|
|
143
|
+
if (!telemetryId) {
|
|
144
|
+
console.warn(
|
|
145
|
+
"[CopilotKit] License token did not yield a telemetry_id; telemetry events will be sent anonymously.",
|
|
146
|
+
);
|
|
147
|
+
}
|
|
148
|
+
return telemetryId;
|
|
149
|
+
}
|
|
150
|
+
|
|
151
|
+
export async function send(opts: LambdaSendOptions): Promise<void> {
|
|
152
|
+
try {
|
|
153
|
+
const body = JSON.stringify({
|
|
154
|
+
event: opts.event,
|
|
155
|
+
properties: stripCloudKeys(opts.properties),
|
|
156
|
+
global_properties: stripCloudKeys(opts.globalProperties),
|
|
157
|
+
package: {
|
|
158
|
+
name: opts.packageName,
|
|
159
|
+
version: opts.packageVersion,
|
|
160
|
+
},
|
|
161
|
+
ts: Math.floor(Date.now() / 1000),
|
|
162
|
+
});
|
|
163
|
+
|
|
164
|
+
const telemetryId =
|
|
165
|
+
firstNonBlankTelemetryId(opts.telemetryId) ??
|
|
166
|
+
parseTelemetryIdFromLicense(opts.licenseToken);
|
|
167
|
+
const headers: Record<string, string> = {
|
|
168
|
+
"Content-Type": "application/json",
|
|
169
|
+
"User-Agent": opts.packageName
|
|
170
|
+
? `CopilotKit-Runtime/${opts.packageVersion ?? "unknown"} (${opts.packageName})`
|
|
171
|
+
: "CopilotKit-Runtime",
|
|
172
|
+
};
|
|
173
|
+
if (telemetryId) {
|
|
174
|
+
headers["X-CopilotKit-Telemetry-Id"] = telemetryId;
|
|
175
|
+
}
|
|
176
|
+
|
|
177
|
+
const controller = new AbortController();
|
|
178
|
+
const timeoutId = setTimeout(() => controller.abort(), FETCH_TIMEOUT_MS);
|
|
179
|
+
try {
|
|
180
|
+
await fetch(TELEMETRY_SINK_URL, {
|
|
181
|
+
method: "POST",
|
|
182
|
+
headers,
|
|
183
|
+
body,
|
|
184
|
+
signal: controller.signal,
|
|
185
|
+
});
|
|
186
|
+
} finally {
|
|
187
|
+
clearTimeout(timeoutId);
|
|
188
|
+
}
|
|
189
|
+
} catch {
|
|
190
|
+
// Silent failure — telemetry must not break the application.
|
|
191
|
+
}
|
|
192
|
+
}
|
|
193
|
+
|
|
194
|
+
export const lambdaClient = { send };
|