@alpic-ai/insights 0.0.0-dev.g11e8d71 → 0.0.0-dev.g1226b39

package/dist/index.d.mts

@@ -36,6 +36,53 @@ type McpMiddlewareFn = (request: {
  */
 declare function intentMiddleware(options?: IntentMiddlewareOptions): McpMiddlewareFn;
 //#endregion
+//#region src/analytics-middleware.d.ts
+interface CaptureOptions {
+  message?: string;
+  /** Duration of the operation the event describes, in milliseconds. */
+  duration?: number;
+  isError?: boolean;
+  error?: string;
+  /** Freeform event detail. Not indexed — filtering on a property key is a query-time scan. */
+  properties?: Record<string, unknown>;
+}
+interface Analytics {
+  /** Records a custom event on the current session's timeline, interleaved with tool calls. */
+  capture(name: string, options?: CaptureOptions): void;
+  /**
+   * Replaces the current request user's trait snapshot (e.g. email, name, plan). The target user
+   * is resolved by Alpic from the request auth context — no id or sessionId is passed.
+   */
+  identify(traits: Record<string, string>): void;
+}
+/**
+ * Shape of the handler `extra` once `analyticsMiddleware()` (or `track(server)`) is installed.
+ * Cast the handler's `extra` to this to access `analytics` with types.
+ */
+interface AnalyticsExtra {
+  analytics: Analytics;
+}
+interface AnalyticsEvent extends CaptureOptions {
+  name: string;
+  timestamp: number;
+}
+interface AnalyticsBatch {
+  events: AnalyticsEvent[];
+  traits?: Record<string, string>;
+}
+interface AnalyticsMiddlewareOptions {
+  /** Receives each request's analytics locally, whether or not the server is hosted by Alpic. */
+  handler?: (batch: AnalyticsBatch) => Promise<void> | void;
+}
+/**
+ * Lets MCP server builders record custom analytics events and user traits from inside tool
+ * handlers, via `extra.analytics.capture(...)` / `extra.analytics.identify(...)`. Calls are
+ * buffered during the request. On Alpic, private environment-provided `_meta` keys carry them to
+ * the proxy for ingestion. Locally, pass a handler to receive them without exposing analytics in
+ * the MCP response.
+ */
+declare function analyticsMiddleware(options?: AnalyticsMiddlewareOptions): McpMiddlewareFn;
+//#endregion
 //#region src/feedback-middleware.d.ts
 interface FeedbackData {
   content: string;
@@ -77,4 +124,13 @@ declare const captureFeedback: (server: McpServer | Server, options?: FeedbackMi
  */
 declare const captureIntents: (server: McpServer | Server, options?: IntentMiddlewareOptions) => void;
 //#endregion
-export { type FeedbackData, type FeedbackMiddlewareOptions, type IntentMiddlewareOptions, type McpMiddlewareFn, type PromptData, captureFeedback, captureIntents, feedbackMiddleware, intentMiddleware };
+//#region src/track.d.ts
+/**
+ * Enables custom analytics events on a vanilla `@modelcontextprotocol/sdk` server. Accepts the
+ * high-level `McpServer` or the low-level `Server` and patches the `tools/call` request handlers
+ * so tool handlers can call `extra.analytics.capture(...)` / `extra.analytics.identify(...)`.
+ * Pass a handler in `options` to receive analytics when running outside Alpic.
+ */
+declare const track: (server: McpServer | Server, options?: AnalyticsMiddlewareOptions) => void;
+//#endregion
+export { type Analytics, type AnalyticsBatch, type AnalyticsEvent, type AnalyticsExtra, type AnalyticsMiddlewareOptions, type CaptureOptions, type FeedbackData, type FeedbackMiddlewareOptions, type IntentMiddlewareOptions, type McpMiddlewareFn, type PromptData, analyticsMiddleware, captureFeedback, captureIntents, feedbackMiddleware, intentMiddleware, track };

package/dist/index.mjs

@@ -1,4 +1,92 @@
 import { CallToolRequestSchema, CallToolResultSchema, ListToolsResultSchema } from "@modelcontextprotocol/sdk/types.js";
+//#region src/analytics-middleware.ts
+const MAX_EVENTS_PER_REQUEST = 50;
+function warnInDev(message) {
+	if (process.env.NODE_ENV !== "production") console.warn(`[insights] ${message}`);
+}
+function createAnalyticsBuffer() {
+	const events = [];
+	let traits;
+	let settled = false;
+	return {
+		analytics: {
+			capture(name, options) {
+				if (settled) {
+					warnInDev(`analytics.capture("${name}") was called after the request settled; the event was dropped. Capture events before the tool handler returns.`);
+					return;
+				}
+				if (events.length >= MAX_EVENTS_PER_REQUEST) {
+					warnInDev(`analytics.capture("${name}") exceeded the ${MAX_EVENTS_PER_REQUEST} events per request limit; the event was dropped.`);
+					return;
+				}
+				events.push({
+					...options,
+					name,
+					timestamp: Date.now()
+				});
+			},
+			identify(newTraits) {
+				if (settled) {
+					warnInDev("analytics.identify() was called after the request settled; the traits were dropped. Identify before the tool handler returns.");
+					return;
+				}
+				traits = { ...newTraits };
+			}
+		},
+		settle: () => {
+			settled = true;
+		},
+		get events() {
+			return events;
+		},
+		get traits() {
+			return traits;
+		}
+	};
+}
+/**
+* Lets MCP server builders record custom analytics events and user traits from inside tool
+* handlers, via `extra.analytics.capture(...)` / `extra.analytics.identify(...)`. Calls are
+* buffered during the request. On Alpic, private environment-provided `_meta` keys carry them to
+* the proxy for ingestion. Locally, pass a handler to receive them without exposing analytics in
+* the MCP response.
+*/
+function analyticsMiddleware(options) {
+	return async (request, extra, next) => {
+		if (request.method !== "tools/call" || extra === null || typeof extra !== "object") return next();
+		const buffer = createAnalyticsBuffer();
+		extra.analytics = buffer.analytics;
+		let rawResult;
+		try {
+			rawResult = await next();
+		} finally {
+			buffer.settle();
+		}
+		if (buffer.events.length === 0 && buffer.traits === void 0) return rawResult;
+		const batch = {
+			events: [...buffer.events],
+			...buffer.traits === void 0 ? {} : { traits: { ...buffer.traits } }
+		};
+		if (options?.handler) try {
+			await options.handler(batch);
+		} catch (error) {
+			console.error("Error calling analytics handler", error);
+		}
+		const eventsMetaKey = process.env.ALPIC_EVENTS_META_KEY || void 0;
+		const identifyMetaKey = process.env.ALPIC_IDENTIFY_META_KEY || void 0;
+		if (eventsMetaKey === void 0 && identifyMetaKey === void 0) return rawResult;
+		if (!CallToolResultSchema.safeParse(rawResult).success) return rawResult;
+		const result = rawResult;
+		const meta = { ...result._meta };
+		if (eventsMetaKey !== void 0 && buffer.events.length > 0) meta[eventsMetaKey] = buffer.events;
+		if (identifyMetaKey !== void 0 && buffer.traits !== void 0) meta[identifyMetaKey] = buffer.traits;
+		return {
+			...result,
+			_meta: meta
+		};
+	};
+}
+//#endregion
 //#region src/feedback-middleware.ts
 const FEEDBACK_TOOL_NAME = "send_feedback";
 const FEEDBACK_TOOL_DESCRIPTION = "Send feedback about this MCP server to its operators. Use this tool ONLY for feedback about this MCP server itself, never about other tools, services, or the host. You MAY call this tool when you detect a genuine issue with this server (e.g. a tool that failed unexpectedly, an unhelpful response, a missing capability). You MAY also call it when the user explicitly asks to send feedback. Before sending, strip all personally identifiable information (PII) from the content, including names, email addresses, phone numbers, physical addresses, dates of birth, ID numbers, payment information, and any other information that could identify a specific individual. Replace stripped values with generic placeholders (e.g. \"[name]\", \"[email]\").";
@@ -271,4 +359,19 @@ const captureIntents = (server, options) => {
 	});
 };
 //#endregion
-export { captureFeedback, captureIntents, feedbackMiddleware, intentMiddleware };
+//#region src/track.ts
+/**
+* Enables custom analytics events on a vanilla `@modelcontextprotocol/sdk` server. Accepts the
+* high-level `McpServer` or the low-level `Server` and patches the `tools/call` request handlers
+* so tool handlers can call `extra.analytics.capture(...)` / `extra.analytics.identify(...)`.
+* Pass a handler in `options` to receive analytics when running outside Alpic.
+*/
+const track = (server, options) => {
+	installCaptureMiddleware(server, {
+		middleware: analyticsMiddleware(options),
+		installedMarker: "__alpicTrackInstalled",
+		disabledWarning: "Analytics capture disabled."
+	});
+};
+//#endregion
+export { analyticsMiddleware, captureFeedback, captureIntents, feedbackMiddleware, intentMiddleware, track };

package/dist/react/index.d.mts

@@ -0,0 +1,67 @@
+import { ReactNode } from "react";
+//#region src/react/analytics-transport.d.ts
+interface AnalyticsEvent {
+  name: string;
+  timestamp: number;
+  message?: string;
+  properties?: Record<string, unknown>;
+  duration?: number;
+  isError?: boolean;
+  error?: string;
+}
+//#endregion
+//#region src/react/analytics-client.d.ts
+interface CaptureOptions {
+  message?: string;
+  properties?: Record<string, unknown>;
+  /** Duration of the operation the event describes, in milliseconds. */
+  duration?: number;
+  isError?: boolean;
+  error?: string;
+}
+/** Inspect, transform, or drop (return `null`) each event before it is buffered for delivery. */
+type BeforeSend = (event: AnalyticsEvent) => AnalyticsEvent | null;
+//#endregion
+//#region src/react/alpic-analytics.d.ts
+interface Analytics {
+  /** Queue a custom widget event for delivery to Alpic Analytics. */
+  capture: (name: string, options?: CaptureOptions) => void;
+}
+/** Toggles for the SDK's built-in event capture. Lifecycle and errors are on by default; interactions are opt-in. */
+interface AutoCaptureOptions {
+  lifecycle?: boolean;
+  errors?: boolean;
+  interactions?: boolean;
+}
+interface AlpicAnalyticsProps {
+  children?: ReactNode;
+  /** Inspect, transform, or drop each event before delivery. Runs synchronously in `capture`. */
+  beforeSend?: BeforeSend;
+  autoCapture?: AutoCaptureOptions;
+}
+/**
+ * Provides Alpic Analytics to descendant components and configures itself from the widget host.
+ * Wrap the widget once, then call `useAnalytics()` from components that capture events.
+ * Events captured before configuration is available are buffered automatically.
+ */
+declare function AlpicAnalytics({ children, beforeSend, autoCapture }: AlpicAnalyticsProps): import("react").JSX.Element;
+/** Returns the analytics client from the nearest `AlpicAnalytics` provider. */
+declare function useAnalytics(): Analytics;
+//#endregion
+//#region src/react/auto-capture.d.ts
+/**
+ * Reserved auto-capture event names. The `$` prefix marks events emitted by the SDK itself
+ * (lifecycle, errors, interactions) so the analytics UI can distinguish them from custom
+ * `capture()` calls. Keep in sync with the server-side reserved namespace.
+ */
+declare const AUTO_EVENT: {
+  readonly loaded: "$loaded";
+  readonly visible: "$visible";
+  readonly hidden: "$hidden";
+  readonly closed: "$closed";
+  readonly error: "$error";
+};
+/** Public DOM contract for declarative interaction capture: the attribute value is the event name. */
+declare const INTERACTION_ATTRIBUTE = "data-alpic-event";
+//#endregion
+export { AUTO_EVENT, AlpicAnalytics, type AlpicAnalyticsProps, type Analytics, type AutoCaptureOptions, type BeforeSend, type CaptureOptions, INTERACTION_ATTRIBUTE, useAnalytics };

package/dist/react/index.mjs

@@ -0,0 +1,285 @@
+import { createContext, useContext, useEffect, useRef, useState } from "react";
+import { jsx } from "react/jsx-runtime";
+//#region src/react/analytics-transport.ts
+function postAnalyticsBatch(ingestUrl, events) {
+	return fetch(ingestUrl, {
+		method: "POST",
+		keepalive: true,
+		headers: { "Content-Type": "application/json" },
+		body: JSON.stringify({ events })
+	}).then(() => void 0, () => void 0);
+}
+const FLUSH_DELAY_MS = 2e3;
+var AnalyticsClient = class {
+	events = [];
+	beforeSend;
+	stamp = null;
+	flushTimer = null;
+	warnedBufferFull = false;
+	constructor(options) {
+		this.beforeSend = options?.beforeSend;
+	}
+	configure(stamp) {
+		if (this.stamp !== null && !isSameStamp(this.stamp, stamp)) this.flush();
+		this.stamp = stamp;
+		if (this.events.length > 0) this.scheduleFlush();
+	}
+	capture = (name, options) => {
+		if (this.events.length >= 100) {
+			if (!this.warnedBufferFull) {
+				console.warn("[@alpic-ai/insights] analytics buffer is full, dropping events");
+				this.warnedBufferFull = true;
+			}
+			return;
+		}
+		const event = {
+			name,
+			timestamp: Date.now()
+		};
+		if (options?.message !== void 0) event.message = options.message;
+		if (options?.properties !== void 0) event.properties = options.properties;
+		if (options?.duration !== void 0) event.duration = options.duration;
+		if (options?.isError !== void 0) event.isError = options.isError;
+		if (options?.error !== void 0) event.error = options.error;
+		const outgoing = this.beforeSend ? this.beforeSend(event) : event;
+		if (outgoing === null) return;
+		this.events.push(outgoing);
+		if (this.events.length >= 50) {
+			this.flush();
+			return;
+		}
+		this.scheduleFlush();
+	};
+	flush = () => {
+		if (this.flushTimer !== null) {
+			clearTimeout(this.flushTimer);
+			this.flushTimer = null;
+		}
+		if (this.stamp === null) return;
+		while (this.events.length > 0) {
+			const batch = this.events.splice(0, 50);
+			postAnalyticsBatch(this.stamp.ingestUrl, batch);
+		}
+		this.warnedBufferFull = false;
+	};
+	scheduleFlush() {
+		if (this.stamp === null || this.flushTimer !== null) return;
+		this.flushTimer = setTimeout(this.flush, FLUSH_DELAY_MS);
+	}
+};
+function isSameStamp(left, right) {
+	return left.distinctId === right.distinctId && left.sessionId === right.sessionId && left.ingestUrl === right.ingestUrl;
+}
+//#endregion
+//#region src/react/auto-capture.ts
+/**
+* Reserved auto-capture event names. The `$` prefix marks events emitted by the SDK itself
+* (lifecycle, errors, interactions) so the analytics UI can distinguish them from custom
+* `capture()` calls. Keep in sync with the server-side reserved namespace.
+*/
+const AUTO_EVENT = {
+	loaded: "$loaded",
+	visible: "$visible",
+	hidden: "$hidden",
+	closed: "$closed",
+	error: "$error"
+};
+/** Public DOM contract for declarative interaction capture: the attribute value is the event name. */
+const INTERACTION_ATTRIBUTE = "data-alpic-event";
+const INTERACTION_DATASET_KEY = "alpicEvent";
+const INTERACTION_DATASET_PREFIX = "alpic";
+/**
+* Resolves the nearest `[data-alpic-event]` ancestor of a click target into an event: the
+* attribute value is the name, and every other `data-alpic-*` attribute becomes a property.
+*/
+function resolveInteractionEvent(target) {
+	if (!(target instanceof Element)) return null;
+	const element = target.closest(`[${INTERACTION_ATTRIBUTE}]`);
+	if (element === null) return null;
+	const name = element.dataset[INTERACTION_DATASET_KEY];
+	if (name === void 0 || name === "") return null;
+	const properties = {};
+	for (const [key, value] of Object.entries(element.dataset)) {
+		if (key === INTERACTION_DATASET_KEY || !key.startsWith(INTERACTION_DATASET_PREFIX) || value === void 0) continue;
+		const unprefixed = key.slice(5);
+		const propertyKey = unprefixed.charAt(0).toLowerCase() + unprefixed.slice(1);
+		properties[propertyKey] = value;
+	}
+	return Object.keys(properties).length > 0 ? {
+		name,
+		properties
+	} : { name };
+}
+/** Captures uncaught errors and unhandled rejections as `$error`, mapped onto the ingest error columns. */
+function installErrorCapture(client) {
+	const onError = (event) => {
+		client.capture(AUTO_EVENT.error, {
+			isError: true,
+			error: event.message,
+			properties: {
+				stack: event.error instanceof Error ? event.error.stack : void 0,
+				source: event.filename
+			}
+		});
+	};
+	const onRejection = (event) => {
+		const reason = event.reason;
+		client.capture(AUTO_EVENT.error, {
+			isError: true,
+			error: reason instanceof Error ? reason.message : String(reason),
+			properties: {
+				stack: reason instanceof Error ? reason.stack : void 0,
+				source: "unhandledrejection"
+			}
+		});
+	};
+	window.addEventListener("error", onError);
+	window.addEventListener("unhandledrejection", onRejection);
+	return () => {
+		window.removeEventListener("error", onError);
+		window.removeEventListener("unhandledrejection", onRejection);
+	};
+}
+/** Captures clicks on `[data-alpic-event]` elements via a single delegated `document` listener. */
+function installInteractionCapture(client) {
+	const onClick = (event) => {
+		const resolved = resolveInteractionEvent(event.target);
+		if (resolved === null) return;
+		client.capture(resolved.name, resolved.properties ? { properties: resolved.properties } : void 0);
+	};
+	document.addEventListener("click", onClick);
+	return () => {
+		document.removeEventListener("click", onClick);
+	};
+}
+//#endregion
+//#region src/react/stamp.ts
+const ANALYTICS_META_KEY = "alpic/analytics";
+function parseAnalyticsStamp(metadata) {
+	if (metadata === null || typeof metadata !== "object") return null;
+	const candidate = metadata[ANALYTICS_META_KEY];
+	if (candidate === null || candidate === void 0 || typeof candidate !== "object") return null;
+	const { distinctId, sessionId, ingestUrl } = candidate;
+	if (typeof distinctId !== "string" || typeof sessionId !== "string" || typeof ingestUrl !== "string") return null;
+	return {
+		distinctId,
+		sessionId,
+		ingestUrl
+	};
+}
+//#endregion
+//#region src/react/stamp-source.ts
+const TOOL_RESULT_METHOD = "ui/notifications/tool-result";
+const SET_GLOBALS_EVENT_TYPE = "openai:set_globals";
+const subscribers = /* @__PURE__ */ new Set();
+let latestProtocolStamp = null;
+let isObservingRuntime = false;
+function subscribeToAnalyticsStamp(onStamp) {
+	observeRuntime();
+	subscribers.add(onStamp);
+	if (latestProtocolStamp !== null) onStamp(latestProtocolStamp);
+	else emitOpenAiStamp(onStamp);
+	return () => {
+		subscribers.delete(onStamp);
+	};
+}
+function observeRuntime() {
+	if (isObservingRuntime || typeof window === "undefined") return;
+	window.addEventListener("message", handleToolResultMessage);
+	window.addEventListener(SET_GLOBALS_EVENT_TYPE, handleOpenAiGlobals, { passive: true });
+	isObservingRuntime = true;
+}
+function handleToolResultMessage(event) {
+	if (event.source !== window.parent || event.data === null || typeof event.data !== "object") return;
+	const message = event.data;
+	if (message.jsonrpc !== "2.0" || message.method !== TOOL_RESULT_METHOD) return;
+	const params = message.params;
+	if (params === null || typeof params !== "object") return;
+	const stamp = parseAnalyticsStamp(params._meta);
+	if (stamp === null) return;
+	latestProtocolStamp = stamp;
+	for (const subscriber of subscribers) subscriber(stamp);
+}
+function handleOpenAiGlobals() {
+	if (latestProtocolStamp !== null) return;
+	const globals = window;
+	if (globals.openai === void 0) return;
+	const stamp = parseAnalyticsStamp(globals.openai.toolResponseMetadata);
+	if (stamp === null) return;
+	for (const subscriber of subscribers) subscriber(stamp);
+}
+function emitOpenAiStamp(onStamp) {
+	if (typeof window === "undefined") return;
+	const stamp = parseAnalyticsStamp(window.openai?.toolResponseMetadata);
+	if (stamp !== null) onStamp(stamp);
+}
+observeRuntime();
+//#endregion
+//#region src/react/alpic-analytics.tsx
+const AnalyticsContext = createContext(null);
+/**
+* Provides Alpic Analytics to descendant components and configures itself from the widget host.
+* Wrap the widget once, then call `useAnalytics()` from components that capture events.
+* Events captured before configuration is available are buffered automatically.
+*/
+function AlpicAnalytics({ children, beforeSend, autoCapture }) {
+	const beforeSendRef = useRef(beforeSend);
+	beforeSendRef.current = beforeSend;
+	const [client] = useState(() => new AnalyticsClient({ beforeSend: (event) => {
+		const transform = beforeSendRef.current;
+		return transform ? transform(event) : event;
+	} }));
+	const lifecycle = autoCapture?.lifecycle ?? true;
+	const errors = autoCapture?.errors ?? true;
+	const interactions = autoCapture?.interactions ?? false;
+	useEffect(() => {
+		return subscribeToAnalyticsStamp((stamp) => {
+			client.configure(stamp);
+		});
+	}, [client]);
+	useEffect(() => {
+		if (lifecycle) client.capture(AUTO_EVENT.loaded);
+		let closed = false;
+		const onVisibilityChange = () => {
+			if (document.visibilityState === "hidden") {
+				if (lifecycle && !closed) client.capture(AUTO_EVENT.hidden);
+				client.flush();
+			} else {
+				closed = false;
+				if (lifecycle) client.capture(AUTO_EVENT.visible);
+			}
+		};
+		const onPageHide = () => {
+			if (lifecycle) client.capture(AUTO_EVENT.closed);
+			closed = true;
+			client.flush();
+		};
+		document.addEventListener("visibilitychange", onVisibilityChange);
+		window.addEventListener("pagehide", onPageHide);
+		return () => {
+			document.removeEventListener("visibilitychange", onVisibilityChange);
+			window.removeEventListener("pagehide", onPageHide);
+			client.flush();
+		};
+	}, [client, lifecycle]);
+	useEffect(() => {
+		if (!errors) return;
+		return installErrorCapture(client);
+	}, [client, errors]);
+	useEffect(() => {
+		if (!interactions) return;
+		return installInteractionCapture(client);
+	}, [client, interactions]);
+	return /* @__PURE__ */ jsx(AnalyticsContext.Provider, {
+		value: client,
+		children
+	});
+}
+/** Returns the analytics client from the nearest `AlpicAnalytics` provider. */
+function useAnalytics() {
+	const analytics = useContext(AnalyticsContext);
+	if (analytics === null) throw new Error("useAnalytics must be used within an <AlpicAnalytics> provider");
+	return analytics;
+}
+//#endregion
+export { AUTO_EVENT, AlpicAnalytics, INTERACTION_ATTRIBUTE, useAnalytics };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alpic-ai/insights",
-  "version": "0.0.0-dev.g11e8d71",
+  "version": "0.0.0-dev.g1226b39",
   "description": "User insights middlewares for Alpic-hosted MCP servers",
   "type": "module",
   "main": "./dist/index.mjs",
@@ -9,6 +9,10 @@
     ".": {
       "types": "./dist/index.d.mts",
       "default": "./dist/index.mjs"
+    },
+    "./react": {
+      "types": "./dist/react/index.d.mts",
+      "default": "./dist/react/index.mjs"
     }
   },
   "files": [
@@ -18,20 +22,30 @@
   "license": "ISC",
   "peerDependencies": {
     "@modelcontextprotocol/sdk": ">=1.29.0 <2",
+    "react": ">=18.0.0",
     "skybridge": "^0.36.3 || ^1.0.0"
   },
   "peerDependenciesMeta": {
+    "react": {
+      "optional": true
+    },
     "skybridge": {
       "optional": true
     }
   },
   "devDependencies": {
     "@modelcontextprotocol/sdk": "^1.29.0",
+    "@testing-library/dom": "^10.4.1",
+    "@testing-library/react": "^16.3.2",
     "@total-typescript/tsconfig": "^1.0.4",
     "@types/node": "^25.9.5",
+    "@types/react": "19.2.17",
+    "jsdom": "^29.1.1",
+    "react": "^19.2.7",
+    "react-dom": "^19.2.7",
     "shx": "^0.4.0",
     "skybridge": "^1.2.7",
-    "tsdown": "^0.22.5",
+    "tsdown": "^0.22.9",
     "typescript": "^6.0.3",
     "vitest": "^4.1.10",
     "zod": "^4.4.3"