@copilotkitnext/web-inspector 0.0.28 → 0.0.30

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@copilotkitnext/web-inspector",
-  "version": "0.0.28",
+  "version": "0.0.30",
   "description": "Lit-based web component for the CopilotKit web inspector",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -18,7 +18,8 @@
     "@ag-ui/client": "0.0.42",
     "lit": "^3.2.0",
     "lucide": "^0.525.0",
-    "@copilotkitnext/core": "0.0.28"
+    "marked": "^12.0.2",
+    "@copilotkitnext/core": "0.0.30"
   },
   "devDependencies": {
     "@tailwindcss/cli": "^4.1.11",
@@ -28,8 +29,9 @@
     "tailwindcss": "^4.0.8",
     "tsup": "^8.5.0",
     "typescript": "5.8.2",
-    "@copilotkitnext/eslint-config": "0.0.0",
-    "@copilotkitnext/typescript-config": "0.0.0"
+    "vitest": "^3.0.5",
+    "@copilotkitnext/typescript-config": "0.0.0",
+    "@copilotkitnext/eslint-config": "0.0.0"
   },
   "engines": {
     "node": ">=18"
@@ -41,6 +43,7 @@
     "dev:css": "npx @tailwindcss/cli -i ./src/styles/tailwind.css -o ./src/styles/generated.css --watch --minify",
     "lint": "eslint . --max-warnings 0",
     "check-types": "pnpm run build:css && tsc --noEmit",
-    "clean": "rm -rf dist src/styles/generated.css"
+    "clean": "rm -rf dist src/styles/generated.css",
+    "test": "pnpm run build:css && vitest run"
   }
 }

package/src/__tests__/web-inspector.spec.ts

@@ -0,0 +1,171 @@
+import { WebInspectorElement } from "../index";
+import {
+  CopilotKitCore,
+  CopilotKitCoreRuntimeConnectionStatus,
+  type CopilotKitCoreSubscriber,
+} from "@copilotkitnext/core";
+import type { AbstractAgent, AgentSubscriber } from "@ag-ui/client";
+import { describe, it, expect, vi, beforeEach } from "vitest";
+
+type MockAgentController = { emit: (key: keyof AgentSubscriber, payload: unknown) => void };
+
+type InspectorInternals = {
+  flattenedEvents: Array<{ type: string }>;
+  agentMessages: Map<string, Array<{ contentText?: string }>>;
+  agentStates: Map<string, unknown>;
+  cachedTools: Array<{ name: string }>;
+};
+
+type InspectorContextInternals = {
+  contextStore: Record<string, { description?: string; value: unknown }>;
+  copyContextValue: (value: unknown, id: string) => Promise<void>;
+  persistState: () => void;
+};
+
+type MockAgentExtras = Partial<{
+  messages: unknown;
+  state: unknown;
+  toolHandlers: Record<string, unknown>;
+  toolRenderers: Record<string, unknown>;
+}>;
+
+function createMockAgent(
+  agentId: string,
+  extras: MockAgentExtras = {},
+): { agent: AbstractAgent; controller: MockAgentController } {
+  const subscribers = new Set<AgentSubscriber>();
+
+  const agent = {
+    agentId,
+    ...extras,
+    subscribe(subscriber: AgentSubscriber) {
+      subscribers.add(subscriber);
+      return {
+        unsubscribe: () => subscribers.delete(subscriber),
+      };
+    },
+  };
+
+  const emit = (key: keyof AgentSubscriber, payload: unknown) => {
+    subscribers.forEach((subscriber) => {
+      const handler = subscriber[key];
+      if (handler) {
+        (handler as (arg: unknown) => void)(payload);
+      }
+    });
+  };
+
+  return { agent: agent as unknown as AbstractAgent, controller: { emit } };
+}
+
+type MockCore = {
+  agents: Record<string, AbstractAgent>;
+  context: Record<string, unknown>;
+  properties: Record<string, unknown>;
+  runtimeConnectionStatus: CopilotKitCoreRuntimeConnectionStatus;
+  subscribe: (subscriber: CopilotKitCoreSubscriber) => { unsubscribe: () => void };
+};
+
+function createMockCore(initialAgents: Record<string, AbstractAgent> = {}) {
+  const subscribers = new Set<CopilotKitCoreSubscriber>();
+  const core: MockCore = {
+    agents: initialAgents,
+    context: {},
+    properties: {},
+    runtimeConnectionStatus: CopilotKitCoreRuntimeConnectionStatus.Connected,
+    subscribe(subscriber: CopilotKitCoreSubscriber) {
+      subscribers.add(subscriber);
+      return { unsubscribe: () => subscribers.delete(subscriber) };
+    },
+  };
+
+  return {
+    core,
+    emitAgentsChanged(nextAgents = core.agents) {
+      core.agents = nextAgents;
+      subscribers.forEach((subscriber) =>
+        subscriber.onAgentsChanged?.({
+          copilotkit: core as unknown as CopilotKitCore,
+          agents: core.agents,
+        }),
+      );
+    },
+    emitContextChanged(nextContext: Record<string, unknown>) {
+      core.context = nextContext;
+      subscribers.forEach((subscriber) =>
+        subscriber.onContextChanged?.({
+          copilotkit: core as unknown as CopilotKitCore,
+          context: core.context as unknown as Readonly<Record<string, { value: string; description: string }>>,
+        }),
+      );
+    },
+  };
+}
+
+describe("WebInspectorElement", () => {
+  beforeEach(() => {
+    document.body.innerHTML = "";
+    localStorage.clear();
+    const mockClipboard = { writeText: vi.fn().mockResolvedValue(undefined) };
+    (navigator as unknown as { clipboard: typeof mockClipboard }).clipboard = mockClipboard;
+  });
+
+  it("records agent events and syncs state/messages/tools", async () => {
+    const { agent, controller } = createMockAgent("alpha", {
+      messages: [{ id: "m1", role: "user", content: "hi there" }],
+      state: { foo: "bar" },
+      toolHandlers: {
+        greet: { description: "hello", parameters: { type: "object" } },
+      },
+    });
+    const { core, emitAgentsChanged } = createMockCore({ alpha: agent });
+
+    const inspector = new WebInspectorElement();
+    document.body.appendChild(inspector);
+    inspector.core = core as unknown as WebInspectorElement["core"];
+
+    emitAgentsChanged();
+    await inspector.updateComplete;
+
+    controller.emit("onRunStartedEvent", { event: { id: "run-1" } });
+    controller.emit("onMessagesSnapshotEvent", { event: { id: "msg-1" } });
+    await inspector.updateComplete;
+
+    const inspectorHandle = inspector as unknown as InspectorInternals;
+
+    const flattened = inspectorHandle.flattenedEvents;
+    expect(flattened.some((evt) => evt.type === "RUN_STARTED")).toBe(true);
+    expect(flattened.some((evt) => evt.type === "MESSAGES_SNAPSHOT")).toBe(true);
+    expect(inspectorHandle.agentMessages.get("alpha")?.[0]?.contentText).toContain("hi there");
+    expect(inspectorHandle.agentStates.get("alpha")).toBeDefined();
+    expect(inspectorHandle.cachedTools.some((tool) => tool.name === "greet")).toBe(true);
+  });
+
+  it("normalizes context, persists state, and copies context values", async () => {
+    const { core, emitContextChanged } = createMockCore();
+    const inspector = new WebInspectorElement();
+    document.body.appendChild(inspector);
+    inspector.core = core as unknown as WebInspectorElement["core"];
+
+    emitContextChanged({
+      ctxA: { value: { nested: true } },
+      ctxB: { description: "Described", value: 5 },
+    });
+    await inspector.updateComplete;
+
+    const inspectorHandle = inspector as unknown as InspectorContextInternals;
+    const contextStore = inspectorHandle.contextStore;
+    const ctxA = contextStore.ctxA!;
+    const ctxB = contextStore.ctxB!;
+    expect(ctxA.value).toMatchObject({ nested: true });
+    expect(ctxB.description).toBe("Described");
+
+    await inspectorHandle.copyContextValue({ nested: true }, "ctxA");
+    const clipboard = (navigator as unknown as { clipboard: { writeText: ReturnType<typeof vi.fn> } }).clipboard
+      .writeText as ReturnType<typeof vi.fn>;
+    expect(clipboard).toHaveBeenCalledTimes(1);
+
+    inspectorHandle.persistState();
+    expect(localStorage.getItem("cpk:inspector:state")).toBeTruthy();
+  });
+});

package/src/assets/inspector-logo.svg

@@ -0,0 +1,40 @@
+<svg width="136" height="26" viewBox="0 0 136 26" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path d="M15.5253 11.0828H11.2602C11.2299 10.7299 11.1492 10.4097 11.0181 10.1224C10.8921 9.83503 10.7157 9.588 10.4888 9.38129C10.267 9.16958 9.99725 9.00818 9.67964 8.89733C9.36202 8.78136 9.00155 8.72338 8.59823 8.72338C7.89242 8.72338 7.29501 8.89477 6.80598 9.23756C6.322 9.58045 5.95397 10.072 5.70189 10.7122C5.45486 11.3524 5.33134 12.1213 5.33134 13.0187C5.33134 13.9665 5.45738 14.7606 5.70946 15.4008C5.96657 16.0361 6.33712 16.515 6.82111 16.8376C7.30509 17.1553 7.88739 17.314 8.56798 17.314C8.95618 17.314 9.30404 17.2662 9.61158 17.1704C9.91911 17.0695 10.1863 16.9259 10.4132 16.7393C10.64 16.5528 10.8241 16.3284 10.9653 16.0663C11.1114 15.7991 11.2097 15.4991 11.2602 15.1664L15.5253 15.1967C15.4748 15.852 15.2908 16.52 14.9732 17.2006C14.6556 17.8762 14.2044 18.5013 13.6195 19.076C13.0398 19.6457 12.3214 20.1046 11.4643 20.4524C10.6073 20.8003 9.61158 20.9742 8.47724 20.9742C7.05554 20.9742 5.78004 20.6692 4.65074 20.0592C3.52649 19.4491 2.63667 18.5517 1.98126 17.367C1.33091 16.1823 1.00574 14.7328 1.00574 13.0187C1.00574 11.2946 1.33848 9.84259 2.00396 8.66285C2.66944 7.47811 3.56682 6.58324 4.69611 5.97827C5.82541 5.36825 7.08578 5.06323 8.47724 5.06323C9.45528 5.06323 10.3552 5.19683 11.177 5.46403C11.9987 5.73123 12.7196 6.12194 13.3397 6.63618C13.9599 7.14537 14.4589 7.77302 14.8371 8.51922C15.2152 9.26533 15.4446 10.1198 15.5253 11.0828Z" fill="#010507"/>
+<path d="M23.0894 20.9742C21.829 20.9742 20.7501 20.7246 19.8527 20.2256C18.9553 19.7214 18.2672 19.0206 17.7883 18.1232C17.3093 17.2208 17.0698 16.1747 17.0698 14.9849C17.0698 13.7951 17.3093 12.7516 17.7883 11.8542C18.2672 10.9517 18.9553 10.2509 19.8527 9.75184C20.7501 9.24767 21.829 8.99564 23.0894 8.99564C24.3498 8.99564 25.4286 9.24767 26.326 9.75184C27.2234 10.2509 27.9115 10.9517 28.3905 11.8542C28.8695 12.7516 29.1089 13.7951 29.1089 14.9849C29.1089 16.1747 28.8695 17.2208 28.3905 18.1232C27.9115 19.0206 27.2234 19.7214 26.326 20.2256C25.4286 20.7246 24.3498 20.9742 23.0894 20.9742ZM23.1196 17.8888C23.4726 17.8888 23.7776 17.7703 24.0346 17.5334C24.2918 17.2965 24.4909 16.9587 24.6321 16.5201C24.7733 16.0814 24.8438 15.5597 24.8438 14.9547C24.8438 14.3446 24.7733 13.8228 24.6321 13.3893C24.4909 12.9506 24.2918 12.6128 24.0346 12.3759C23.7776 12.139 23.4726 12.0205 23.1196 12.0205C22.7466 12.0205 22.4265 12.139 22.1592 12.3759C21.8921 12.6128 21.6878 12.9506 21.5466 13.3893C21.4056 13.8228 21.3349 14.3446 21.3349 14.9547C21.3349 15.5597 21.4056 16.0814 21.5466 16.5201C21.6878 16.9587 21.8921 17.2965 22.1592 17.5334C22.4265 17.7703 22.7466 17.8888 23.1196 17.8888Z" fill="#010507"/>
+<path d="M30.8029 25.1184V9.14681H34.947V11.1735H35.0377C35.189 10.7803 35.4109 10.4199 35.7032 10.0922C35.9957 9.7594 36.3587 9.4947 36.7922 9.2981C37.2257 9.09639 37.7299 8.99564 38.3046 8.99564C39.0709 8.99564 39.7995 9.19979 40.4901 9.60811C41.1858 10.0165 41.7505 10.6593 42.1841 11.5365C42.6227 12.4138 42.842 13.5531 42.842 14.9547C42.842 16.2957 42.6328 17.4073 42.2143 18.2896C41.801 19.1719 41.2464 19.8298 40.5506 20.2633C39.8599 20.697 39.1011 20.9137 38.2744 20.9137C37.7299 20.9137 37.2434 20.8255 36.8149 20.649C36.3914 20.4675 36.0284 20.223 35.7259 19.9155C35.4285 19.6029 35.199 19.25 35.0377 18.8568H34.9772V25.1184H30.8029ZM34.8865 14.9547C34.8865 15.5193 34.9596 16.0083 35.1058 16.4218C35.257 16.8301 35.4688 17.1477 35.7411 17.3746C36.0183 17.5964 36.3486 17.7073 36.7317 17.7073C37.1149 17.7073 37.44 17.5989 37.7072 17.3821C37.9795 17.1603 38.1862 16.8452 38.3273 16.4369C38.4736 16.0234 38.5466 15.5294 38.5466 14.9547C38.5466 14.3799 38.4736 13.8884 38.3273 13.48C38.1862 13.0666 37.9795 12.7516 37.7072 12.5347C37.44 12.3129 37.1149 12.202 36.7317 12.202C36.3486 12.202 36.0183 12.3129 35.7411 12.5347C35.4688 12.7516 35.257 13.0666 35.1058 13.48C34.9596 13.8884 34.8865 14.3799 34.8865 14.9547Z" fill="#010507"/>
+<path d="M44.5908 20.7625V9.14678H48.7652V20.7625H44.5908ZM46.6779 7.93683C46.1133 7.93683 45.6294 7.75033 45.2261 7.37726C44.8227 7.00419 44.621 6.55549 44.621 6.03118C44.621 5.50686 44.8227 5.05816 45.2261 4.68509C45.6294 4.31202 46.1133 4.12549 46.6779 4.12549C47.2477 4.12549 47.7316 4.31202 48.1299 4.68509C48.5332 5.05816 48.7349 5.50686 48.7349 6.03118C48.7349 6.55549 48.5332 7.00419 48.1299 7.37726C47.7316 7.75033 47.2477 7.93683 46.6779 7.93683Z" fill="#010507"/>
+<path d="M55.0664 5.27496V20.7625H50.892V5.27496H55.0664Z" fill="#010507"/>
+<path d="M62.7893 20.9742C61.5289 20.9742 60.4501 20.7246 59.5527 20.2256C58.6553 19.7214 57.9671 19.0206 57.4881 18.1232C57.0093 17.2208 56.7698 16.1747 56.7698 14.9849C56.7698 13.7951 57.0093 12.7516 57.4881 11.8542C57.9671 10.9517 58.6553 10.2509 59.5527 9.75184C60.4501 9.24767 61.5289 8.99564 62.7893 8.99564C64.0497 8.99564 65.1286 9.24767 66.026 9.75184C66.9234 10.2509 67.6115 10.9517 68.0904 11.8542C68.5694 12.7516 68.8089 13.7951 68.8089 14.9849C68.8089 16.1747 68.5694 17.2208 68.0904 18.1232C67.6115 19.0206 66.9234 19.7214 66.026 20.2256C65.1286 20.7246 64.0497 20.9742 62.7893 20.9742ZM62.8195 17.8888C63.1724 17.8888 63.4775 17.7703 63.7346 17.5334C63.9917 17.2965 64.1908 16.9587 64.332 16.5201C64.4731 16.0814 64.5438 15.5597 64.5438 14.9547C64.5438 14.3446 64.4731 13.8228 64.332 13.3893C64.1908 12.9506 63.9917 12.6128 63.7346 12.3759C63.4775 12.139 63.1724 12.0205 62.8195 12.0205C62.4464 12.0205 62.1263 12.139 61.8592 12.3759C61.5919 12.6128 61.3878 12.9506 61.2466 13.3893C61.1054 13.8228 61.0349 14.3446 61.0349 14.9547C61.0349 15.5597 61.1054 16.0814 61.2466 16.5201C61.3878 16.9587 61.5919 17.2965 61.8592 17.5334C62.1263 17.7703 62.4464 17.8888 62.8195 17.8888Z" fill="#010507"/>
+<path d="M77.4298 9.1468V12.1717H69.7769V9.1468H77.4298ZM71.2591 6.36392H75.4334V17.0267C75.4334 17.188 75.4612 17.3241 75.5166 17.4351C75.572 17.5409 75.6578 17.6216 75.7738 17.677C75.8897 17.7274 76.0384 17.7527 76.2199 17.7527C76.3459 17.7527 76.4921 17.7375 76.6585 17.7073C76.8299 17.677 76.9559 17.6518 77.0366 17.6317L77.6416 20.5659C77.4551 20.6213 77.1879 20.6894 76.84 20.77C76.4972 20.8507 76.0888 20.9037 75.6149 20.9288C74.657 20.9792 73.8529 20.8809 73.2026 20.6339C72.5522 20.3818 72.0631 19.9861 71.7355 19.4466C71.4078 18.9072 71.249 18.2316 71.2591 17.42V6.36392Z" fill="#010507"/>
+<path d="M79.3223 20.7625V5.27496H83.5268V11.5365H83.7385L88.397 5.27496H93.2973L88.0642 12.1717L93.4183 20.7625H88.397L84.9183 14.9546L83.5268 16.7696V20.7625H79.3223Z" fill="#010507"/>
+<path d="M95.3334 20.7625V9.14678H99.5077V20.7625H95.3334ZM97.4206 7.93683C96.8559 7.93683 96.3719 7.75033 95.9686 7.37726C95.5653 7.00419 95.3637 6.55549 95.3637 6.03118C95.3637 5.50686 95.5653 5.05816 95.9686 4.68509C96.3719 4.31202 96.8559 4.12549 97.4206 4.12549C97.9902 4.12549 98.4743 4.31202 98.8725 4.68509C99.2758 5.05816 99.4775 5.50686 99.4775 6.03118C99.4775 6.55549 99.2758 7.00419 98.8725 7.37726C98.4743 7.75033 97.9902 7.93683 97.4206 7.93683Z" fill="#010507"/>
+<path d="M108.562 9.1468V12.1717H100.909V9.1468H108.562ZM102.391 6.36392H106.565V17.0267C106.565 17.188 106.593 17.3241 106.648 17.4351C106.704 17.5409 106.789 17.6216 106.905 17.677C107.021 17.7274 107.17 17.7527 107.352 17.7527C107.478 17.7527 107.623 17.7375 107.791 17.7073C107.962 17.677 108.087 17.6518 108.168 17.6317L108.774 20.5659C108.587 20.6213 108.319 20.6894 107.971 20.77C107.629 20.8507 107.22 20.9037 106.747 20.9288C105.789 20.9792 104.985 20.8809 104.334 20.6339C103.684 20.3818 103.195 19.9861 102.867 19.4466C102.54 18.9072 102.381 18.2316 102.391 17.42V6.36392Z" fill="#010507"/>
+<path d="M119.539 8.67678C121.648 5.91866 123.398 3.19128 124.071 0.988777C124.089 0.928849 124.159 0.90339 124.212 0.937987C126.553 2.48864 130.818 3.50932 134.591 3.53328C134.656 3.53369 134.7 3.59769 134.677 3.65822C133.423 6.84039 131.891 12.5423 131.831 19.0536C131.831 19.1503 131.695 19.185 131.647 19.1009C129.5 15.3438 122.623 10.0644 119.574 8.81838C119.518 8.79519 119.502 8.7255 119.539 8.67678Z" fill="url(#paint0_linear_8010_10612)"/>
+<path d="M126.653 6.98969C123.357 8.03321 120.345 8.61334 119.626 8.74516C119.58 8.75356 119.571 8.81686 119.614 8.83473C122.687 10.1121 129.53 15.3761 131.657 19.118C131.661 19.1262 131.671 19.1292 131.68 19.1255C131.688 19.1214 131.693 19.1108 131.69 19.1016L126.653 6.98969Z" fill="url(#paint1_linear_8010_10612)"/>
+<path d="M124.221 0.931179C127.043 2.4702 130.303 3.16142 134.629 3.52564C134.656 3.52796 134.665 3.56437 134.641 3.57702C134.088 3.86136 130.918 5.47409 128.565 6.33784C127.934 6.56926 127.3 6.78394 126.676 6.982C126.662 6.98633 126.647 6.97951 126.641 6.96631L124.156 0.989469C124.139 0.949222 124.183 0.910305 124.221 0.931179Z" fill="url(#paint2_linear_8010_10612)"/>
+<path d="M124.171 1.02203L131.742 19.082" stroke="#513C9F" stroke-width="0.183881" stroke-linecap="round"/>
+<path d="M119.628 8.74279C119.628 8.74279 123.809 7.99233 127.739 6.63677C131.668 5.28124 134.594 3.6214 134.594 3.6214" stroke="#513C9F" stroke-width="0.183881" stroke-linecap="round"/>
+<path d="M125.209 3.30383L122.405 12.6358M122.405 12.6358H129.07M122.405 12.6358L111.874 25.0383" stroke="#ABABAB" stroke-width="0.321797" stroke-linecap="round"/>
+<path d="M119.181 22.485L117.94 22.6596C118.584 24.3618 119.904 25.1053 121.479 25.1053C125.341 25.1053 124.163 20.7382 126.4 20.7382C128.023 20.7382 127.364 24.2778 130.857 24.2778C132.989 24.2778 133.201 22.1301 132.837 21.2061C132.835 21.2005 132.833 21.1953 132.83 21.1902L132.259 20.3154C132.222 20.2572 132.131 20.2791 132.125 20.3483L132.018 21.4087C132.011 21.4824 132.013 21.5559 132.021 21.6295C132.109 22.3621 132.165 24.14 130.857 24.14C129.477 24.14 129.145 20.6462 126.4 20.6462C123.181 20.6462 123.594 24.9675 121.618 24.9675C120.313 24.9675 119.319 23.4964 119.181 22.485Z" fill="url(#paint3_linear_8010_10612)"/>
+<defs>
+<linearGradient id="paint0_linear_8010_10612" x1="129.301" y1="2.33848" x2="125.623" y2="12.452" gradientUnits="userSpaceOnUse">
+<stop stop-color="#6430AB"/>
+<stop offset="1" stop-color="#AA89D8"/>
+</linearGradient>
+<linearGradient id="paint1_linear_8010_10612" x1="126.451" y1="8.03874" x2="121.717" y2="17.1869" gradientUnits="userSpaceOnUse">
+<stop stop-color="#005DBB"/>
+<stop offset="1" stop-color="#3D92E8"/>
+</linearGradient>
+<linearGradient id="paint2_linear_8010_10612" x1="128.565" y1="2.33842" x2="127.139" y2="6.79755" gradientUnits="userSpaceOnUse">
+<stop stop-color="#1B70C4"/>
+<stop offset="1" stop-color="#54A4F2"/>
+</linearGradient>
+<linearGradient id="paint3_linear_8010_10612" x1="117.94" y1="22.7838" x2="132.981" y2="22.7838" gradientUnits="userSpaceOnUse">
+<stop stop-color="#4497EA"/>
+<stop offset="0.254755" stop-color="#1463B2"/>
+<stop offset="0.498725" stop-color="#0A437D"/>
+<stop offset="0.666667" stop-color="#2476C8"/>
+<stop offset="0.972542" stop-color="#0C549A"/>
+</linearGradient>
+</defs>
+</svg>