@copilotkit/shared 1.69.2 → 1.70.0

package/dist/index.umd.js

@@ -941,6 +941,16 @@ ${getSeeMoreMarkdown(troubleshootingLink)}`;
 		};
 	}
 
+//#endregion
+//#region src/utils/inspector-visibility.ts
+/**
+	* The Inspector is a development-only browser tool. Consumers may disable it,
+	* but an explicit `true` never overrides a production or server environment.
+	*/
+	function shouldEnableInspector({ enableInspector, isBrowser, isDevelopment }) {
+		return isBrowser && isDevelopment && enableInspector !== false;
+	}
+
 //#endregion
 //#region src/utils/types.ts
 	const RUNTIME_MODE_SSE = "sse";
@@ -1139,6 +1149,24 @@ ${getSeeMoreMarkdown(troubleshootingLink)}`;
 	var _process$env;
 	const TELEMETRY_SINK_URL = typeof process !== "undefined" && ((_process$env = process.env) === null || _process$env === void 0 ? void 0 : _process$env.COPILOTKIT_TELEMETRY_URL) || "https://telemetry.copilotkit.ai/ingest";
 	const FETCH_TIMEOUT_MS = 3e3;
+	const TELEMETRY_ID_PATTERN = /^[A-Za-z0-9_-]{1,128}$/;
+	/**
+	* Return the first telemetry identity accepted by the ingest service.
+	*
+	* Empty and whitespace-only values are unconfigured placeholders and must not
+	* suppress a later identity source. Leading and trailing HTTP spaces and tabs
+	* are removed before validation. The ingest service accepts 1 to 128 ASCII
+	* letters, digits, underscores, and hyphens.
+	*
+	* @internal
+	*/
+	function firstNonBlankTelemetryId(...candidates) {
+		for (const candidate of candidates) {
+			if (candidate === void 0) continue;
+			const normalized = candidate.replace(/^[\t ]+|[\t ]+$/g, "");
+			if (TELEMETRY_ID_PATTERN.test(normalized)) return normalized;
+		}
+	}
 	const STRIPPED_KEYS = new Set(["cloud.public_api_key", "cloud.publicApiKey"]);
 	function stripCloudKeys(obj) {
 		if (!obj) return {};
@@ -1151,12 +1179,15 @@ ${getSeeMoreMarkdown(troubleshootingLink)}`;
 		const parts = token.split(".");
 		if (parts.length !== 3) return null;
 		try {
-			let b64 = parts[1].replace(/-/g, "+").replace(/_/g, "/");
+			var _firstNonBlankTelemet;
+			const payload = parts[1];
+			if (!/^[A-Za-z0-9_-]+$/.test(payload) || payload.length % 4 === 1) return null;
+			let b64 = payload.replace(/-/g, "+").replace(/_/g, "/");
 			const padding = (4 - b64.length % 4) % 4;
 			b64 += "=".repeat(padding);
-			const json = typeof atob === "function" ? atob(b64) : Buffer.from(b64, "base64").toString("utf8");
+			const json = typeof Buffer !== "undefined" ? Buffer.from(b64, "base64").toString("utf8") : new TextDecoder().decode(Uint8Array.from(atob(b64), (character) => character.charCodeAt(0)));
 			const decoded = JSON.parse(json);
-			return typeof decoded.telemetry_id === "string" ? decoded.telemetry_id : null;
+			return (_firstNonBlankTelemet = firstNonBlankTelemetryId(typeof decoded.telemetry_id === "string" ? decoded.telemetry_id : void 0)) !== null && _firstNonBlankTelemet !== void 0 ? _firstNonBlankTelemet : null;
 		} catch (_unused) {
 			return null;
 		}
@@ -1168,7 +1199,7 @@ ${getSeeMoreMarkdown(troubleshootingLink)}`;
 	}
 	async function send(opts) {
 		try {
-			var _opts$packageVersion;
+			var _firstNonBlankTelemet2, _opts$packageVersion;
 			const body = JSON.stringify({
 				event: opts.event,
 				properties: stripCloudKeys(opts.properties),
@@ -1179,7 +1210,7 @@ ${getSeeMoreMarkdown(troubleshootingLink)}`;
 				},
 				ts: Math.floor(Date.now() / 1e3)
 			});
-			const telemetryId = parseTelemetryIdFromLicense(opts.licenseToken);
+			const telemetryId = (_firstNonBlankTelemet2 = firstNonBlankTelemetryId(opts.telemetryId)) !== null && _firstNonBlankTelemet2 !== void 0 ? _firstNonBlankTelemet2 : parseTelemetryIdFromLicense(opts.licenseToken);
 			const headers = {
 				"Content-Type": "application/json",
 				"User-Agent": opts.packageName ? `CopilotKit-Runtime/${(_opts$packageVersion = opts.packageVersion) !== null && _opts$packageVersion !== void 0 ? _opts$packageVersion : "unknown"} (${opts.packageName})` : "CopilotKit-Runtime"
@@ -1201,6 +1232,29 @@ ${getSeeMoreMarkdown(troubleshootingLink)}`;
 	}
 	const lambdaClient = { send };
 
+//#endregion
+//#region src/telemetry/sampling.ts
+/** Identifies which client emitted an event. */
+	const TELEMETRY_EMITTER_V1 = "v1-shared";
+	const TELEMETRY_EMITTER_V2 = "v2-runtime";
+	/**
+	* Compute the sampling block for one captured event.
+	*
+	* `telemetryId` is the caller's parsed license telemetry_id, or null when
+	* anonymous — it decides the branch, and is deliberately not returned:
+	* only the non-PII shape below travels on the event.
+	*/
+	function computeSamplingMeta({ telemetryId, sampleRate }) {
+		const identified = Boolean(telemetryId);
+		const effectiveSampleRate = identified ? 1 : sampleRate;
+		return {
+			sampleRate: effectiveSampleRate,
+			sampleRateAdjustmentFactor: 1 - effectiveSampleRate,
+			sampleWeight: 1 / effectiveSampleRate,
+			telemetry_identified: identified
+		};
+	}
+
 //#endregion
 //#region src/telemetry/telemetry-client.ts
 /**
@@ -1218,6 +1272,7 @@ ${getSeeMoreMarkdown(troubleshootingLink)}`;
 			this.cloudConfiguration = null;
 			this.licenseToken = null;
 			this.telemetryId = null;
+			this.licenseTelemetryId = null;
 			this.telemetryDisabled = false;
 			this.sampleRate = .05;
 			this.anonymousId = `anon_${(0, uuid.v4)()}`;
@@ -1236,19 +1291,29 @@ ${getSeeMoreMarkdown(troubleshootingLink)}`;
 			return Math.random() < this.sampleRate;
 		}
 		async capture(event, properties) {
-			var _this$licenseToken;
+			return this.captureWithIdentity(event, properties, {
+				telemetryId: this.telemetryId,
+				licenseToken: this.licenseToken,
+				licenseTelemetryId: this.licenseTelemetryId
+			});
+		}
+		async captureWithIdentity(event, properties, identity) {
+			var _identity$telemetryId, _identity$licenseToke;
 			if (this.telemetryDisabled) return;
-			if (!this.telemetryId && !this.shouldSendEvent()) return;
-			const effectiveSampleRate = this.telemetryId ? 1 : this.sampleRate;
-			const samplingMeta = {
-				sampleRate: effectiveSampleRate,
-				sampleRateAdjustmentFactor: 1 - effectiveSampleRate,
-				sampleWeight: 1 / effectiveSampleRate
+			if (!identity.licenseTelemetryId && !this.shouldSendEvent()) return;
+			const eventMeta = {
+				...computeSamplingMeta({
+					telemetryId: identity.licenseTelemetryId,
+					sampleRate: this.sampleRate
+				}),
+				telemetry_emitter: TELEMETRY_EMITTER_V1,
+				telemetry_event_id: (0, uuid.v4)()
 			};
 			const flattenedProperties = flattenObject(properties);
 			const propertiesWithGlobal = {
 				...this.globalProperties,
-				...samplingMeta,
+				...eventMeta,
+				telemetry_transport: "segment",
 				...flattenedProperties
 			};
 			const orderedPropertiesWithGlobal = Object.keys(propertiesWithGlobal).sort().reduce((obj, key) => {
@@ -1260,11 +1325,13 @@ ${getSeeMoreMarkdown(troubleshootingLink)}`;
 				properties: flattenedProperties,
 				globalProperties: {
 					...this.globalProperties,
-					...samplingMeta
+					...eventMeta,
+					telemetry_transport: "lambda"
 				},
 				packageName: this.packageName,
 				packageVersion: this.packageVersion,
-				licenseToken: (_this$licenseToken = this.licenseToken) !== null && _this$licenseToken !== void 0 ? _this$licenseToken : void 0
+				telemetryId: (_identity$telemetryId = identity.telemetryId) !== null && _identity$telemetryId !== void 0 ? _identity$telemetryId : void 0,
+				licenseToken: (_identity$licenseToke = identity.licenseToken) !== null && _identity$licenseToke !== void 0 ? _identity$licenseToke : void 0
 			});
 			if (this.segment) this.segment.track({
 				anonymousId: this.anonymousId,
@@ -1286,9 +1353,57 @@ ${getSeeMoreMarkdown(troubleshootingLink)}`;
 				baseUrl: properties.baseUrl
 			} });
 		}
+		/**
+		* Atomically configure standalone, legacy, or anonymous telemetry identity.
+		*
+		* A standalone id takes transport precedence over a supplied legacy license
+		* token, but only a license-derived id grants sampling authority. Neither
+		* value is added to event properties.
+		*
+		* @param identity - One standalone id, one legacy license token, or neither.
+		*/
+		setTelemetryIdentity(identity) {
+			const resolvedIdentity = this.resolveTelemetryIdentity(identity);
+			this.telemetryId = resolvedIdentity.telemetryId;
+			this.licenseToken = resolvedIdentity.licenseToken;
+			this.licenseTelemetryId = resolvedIdentity.licenseTelemetryId;
+		}
+		/**
+		* Configure legacy license-derived telemetry identity.
+		*
+		* @param licenseToken - License token whose telemetry claim identifies sends.
+		*/
 		setLicenseToken(licenseToken) {
-			this.licenseToken = licenseToken;
-			this.telemetryId = parseAndWarnTelemetryId(licenseToken);
+			this.setTelemetryIdentity({ licenseToken });
+		}
+		/**
+		* Create an immutable capture scope for one runtime.
+		*
+		* The scope shares this client's sinks, process-wide opt-out, global
+		* properties, and sampling settings, but snapshots transport identity and
+		* license-derived sampling authority. Constructing another runtime cannot
+		* rewrite an existing scope.
+		*
+		* @param identity - The runtime's construction-time telemetry identity.
+		* @returns A capture-only client bound to that identity.
+		*/
+		createScope(identity) {
+			const resolvedIdentity = this.resolveTelemetryIdentity(identity);
+			return { capture: (event, properties) => this.captureWithIdentity(event, properties, resolvedIdentity) };
+		}
+		resolveTelemetryIdentity(identity) {
+			var _identity$licenseToke2;
+			const telemetryId = firstNonBlankTelemetryId(identity.telemetryId);
+			if (telemetryId !== void 0) return {
+				telemetryId,
+				licenseToken: null,
+				licenseTelemetryId: null
+			};
+			return {
+				telemetryId: null,
+				licenseToken: (_identity$licenseToke2 = identity.licenseToken) !== null && _identity$licenseToke2 !== void 0 ? _identity$licenseToke2 : null,
+				licenseTelemetryId: identity.licenseToken ? parseAndWarnTelemetryId(identity.licenseToken) : null
+			};
 		}
 		setSampleRate(sampleRate) {
 			let _sampleRate;
@@ -1676,7 +1791,7 @@ ${getSeeMoreMarkdown(troubleshootingLink)}`;
 
 //#endregion
 //#region package.json
-	var version = "1.69.2";
+	var version = "1.70.0";
 
 //#endregion
 //#region src/a2ui-prompts.ts
@@ -1797,27 +1912,46 @@ Use the SAME surfaceId as the main surface. Match action names to button action
 //#endregion
 //#region src/index.ts
 	const COPILOTKIT_VERSION = version;
+	/** Read a record value without traversing its prototype chain. */
+	function getOwnRecordValue(record, key) {
+		return Object.prototype.hasOwnProperty.call(record, key) ? record[key] : void 0;
+	}
+	/** Legacy UI surfaces that remain available for every active entitlement. */
+	function isLegacyUiFeature(feature) {
+		return feature === "chat" || feature === "popup" || feature === "sidebar";
+	}
 	/**
-	* Client-safe license context factory, driven by the license status the
+	* Client-safe license context factory, driven by the license authority the
 	* runtime reports via /info.
 	*
-	* Features are enabled unless the runtime definitively reports the license
-	* as "expired" or "invalid". A null/"none"/"unknown" status fails open
-	* (unlicensed = unrestricted, with branding), and "expiring" keeps features
-	* on while the provider surfaces a warning banner. Per-feature data is not
-	* in /info yet, so checkFeature is uniform across features and getLimit has
-	* no limits to report. This is inlined here to avoid importing the full
-	* license-verifier bundle (which depends on Node's `crypto`) into browser
-	* bundles.
+	* A ready managed entitlement is authoritative in both directions. A ready
+	* active self-hosted entitlement is also authoritative, while an inactive
+	* self-hosted response preserves the legacy signed-license fallback. Active
+	* entitlements supply feature grants and limits; authoritative inactive
+	* entitlements deny every feature and limit. Older runtimes that report only a
+	* status retain the legacy behavior: features are enabled unless the status is
+	* "expired" or "invalid", and no limits are reported. This is inlined here to
+	* avoid importing the full license-verifier bundle (which depends on Node's
+	* `crypto`) into browser bundles.
 	*/
-	function createLicenseContextValue(status) {
-		const resolvedStatus = status !== null && status !== void 0 ? status : null;
+	function createLicenseContextValue(status, runtimeEntitlements) {
+		const readyEntitlement = (runtimeEntitlements === null || runtimeEntitlements === void 0 ? void 0 : runtimeEntitlements.status) === "ready" ? runtimeEntitlements.entitlement : null;
+		const hasUsableSelfHostedLegacyFallback = readyEntitlement && !readyEntitlement.active && readyEntitlement.source === "selfHostedDeploymentLicense" && (status === "valid" || status === "expiring");
+		const featureAuthority = readyEntitlement && !hasUsableSelfHostedLegacyFallback ? readyEntitlement : null;
+		const activeEntitlement = (featureAuthority === null || featureAuthority === void 0 ? void 0 : featureAuthority.active) ? featureAuthority : null;
+		const resolvedStatus = activeEntitlement ? "valid" : (readyEntitlement === null || readyEntitlement === void 0 ? void 0 : readyEntitlement.source) === "managedOrgSubscription" ? "none" : featureAuthority ? status !== null && status !== void 0 ? status : "none" : status !== null && status !== void 0 ? status : null;
 		const featuresEnabled = resolvedStatus !== "expired" && resolvedStatus !== "invalid";
 		return {
 			status: resolvedStatus,
 			license: null,
-			checkFeature: () => featuresEnabled,
-			getLimit: () => null
+			checkFeature: (feature) => {
+				var _getOwnRecordValue;
+				return featureAuthority ? activeEntitlement ? feature === "threads" && Object.prototype.hasOwnProperty.call(activeEntitlement.limits, "threads.max_count") ? true : (_getOwnRecordValue = getOwnRecordValue(activeEntitlement.features, feature)) !== null && _getOwnRecordValue !== void 0 ? _getOwnRecordValue : isLegacyUiFeature(feature) : false : featuresEnabled;
+			},
+			getLimit: (feature) => {
+				var _getOwnRecordValue2;
+				return activeEntitlement ? (_getOwnRecordValue2 = getOwnRecordValue(activeEntitlement.limits, feature)) !== null && _getOwnRecordValue2 !== void 0 ? _getOwnRecordValue2 : null : null;
+			}
 		};
 	}
 
@@ -1852,11 +1986,14 @@ exports.RUNTIME_MODE_INTELLIGENCE = RUNTIME_MODE_INTELLIGENCE;
 exports.RUNTIME_MODE_SSE = RUNTIME_MODE_SSE;
 exports.ResolvedCopilotKitError = ResolvedCopilotKitError;
 exports.Severity = Severity;
+exports.TELEMETRY_EMITTER_V1 = TELEMETRY_EMITTER_V1;
+exports.TELEMETRY_EMITTER_V2 = TELEMETRY_EMITTER_V2;
 exports.TelemetryClient = TelemetryClient;
 exports.TranscriptionErrorCode = TranscriptionErrorCode;
 exports.TranscriptionErrors = TranscriptionErrors;
 exports.UpgradeRequiredError = UpgradeRequiredError;
 exports.actionParametersToJsonSchema = actionParametersToJsonSchema;
+exports.computeSamplingMeta = computeSamplingMeta;
 exports.convertJsonSchemaToZodSchema = convertJsonSchemaToZodSchema;
 exports.copyToClipboard = copyToClipboard;
 exports.createLicenseContextValue = createLicenseContextValue;
@@ -1865,6 +2002,7 @@ exports.ensureStructuredError = ensureStructuredError;
 exports.exceedsMaxSize = exceedsMaxSize;
 exports.executeConditions = executeConditions;
 exports.finalizeRunEvents = finalizeRunEvents;
+exports.firstNonBlankTelemetryId = firstNonBlankTelemetryId;
 exports.formatFileSize = formatFileSize;
 exports.generateVideoThumbnail = generateVideoThumbnail;
 exports.getDocumentIcon = getDocumentIcon;
@@ -1896,6 +2034,7 @@ exports.readFileAsBase64 = readFileAsBase64;
 exports.resolveDebugConfig = resolveDebugConfig;
 exports.safeParseToolArgs = safeParseToolArgs;
 exports.schemaToJsonSchema = schemaToJsonSchema;
+exports.shouldEnableInspector = shouldEnableInspector;
 exports.styledConsole = styledConsole;
 exports.tryMap = tryMap;
 });