@copilotkit/vue 2.0.0-rc.2 → 2.0.0-rc.20

package/src/v2/components/chat/use-copy-feedback.ts

@@ -0,0 +1,21 @@
+import { onBeforeUnmount, readonly, ref } from "vue";
+import { ɵCopyFeedback } from "@copilotkit/core";
+
+/**
+ * The "copied" check mark of a copy button, from core's `ɵCopyFeedback`:
+ * `copy(text)` writes to the clipboard and shows the check mark for two
+ * seconds; a second copy restarts the wait.
+ * @internal
+ */
+export function useCopyFeedback() {
+  const feedback = new ɵCopyFeedback();
+  const copied = ref(feedback.getSnapshot());
+  const unsubscribe = feedback.subscribe(() => {
+    copied.value = feedback.getSnapshot();
+  });
+  onBeforeUnmount(() => {
+    unsubscribe();
+    feedback.dispose();
+  });
+  return { copied: readonly(copied), copy: feedback.copy };
+}

package/src/v2/components/icons/__tests__/icons.test.ts

@@ -1,86 +1,90 @@
 import { describe, expect, it } from "vitest";
+import { h } from "vue";
 import { mount } from "@vue/test-utils";
-import {
-  IconArrowUp,
-  IconCheck,
-  IconCheckCircle,
-  IconChevronDown,
-  IconChevronLeft,
-  IconChevronRight,
-  IconCircle,
-  IconCopy,
-  IconEdit,
-  IconLoader2,
-  IconMessageCircle,
-  IconMic,
-  IconPlus,
-  IconRefreshCw,
-  IconSquare,
-  IconThumbsDown,
-  IconThumbsUp,
-  IconVolume2,
-  IconX,
-} from "../index";
+import { CopilotIcon, IconCircle, IconPlay, IconX } from "../index";
 
-describe("icons adapter", () => {
-  it("exports all expected icon aliases", () => {
-    const icons = [
-      IconMessageCircle,
-      IconX,
-      IconChevronDown,
-      IconPlus,
-      IconMic,
-      IconArrowUp,
-      IconCheck,
-      IconSquare,
-      IconLoader2,
-      IconCopy,
-      IconEdit,
-      IconChevronLeft,
-      IconChevronRight,
-      IconThumbsUp,
-      IconThumbsDown,
-      IconVolume2,
-      IconRefreshCw,
-      IconCheckCircle,
-      IconCircle,
-    ];
+describe("CopilotIcon", () => {
+  it("draws the named icon with Lucide's classes and default attributes", () => {
+    const svg = mount(CopilotIcon, { props: { name: "X" } }).find("svg");
 
-    for (const icon of icons) {
-      expect(icon).toBeDefined();
-    }
+    expect(svg.classes()).toEqual(["lucide", "lucide-x"]);
+    expect(svg.attributes()).toMatchObject({
+      xmlns: "http://www.w3.org/2000/svg",
+      width: "24",
+      height: "24",
+      viewBox: "0 0 24 24",
+      fill: "none",
+      stroke: "currentColor",
+      "stroke-width": "2",
+      "stroke-linecap": "round",
+      "stroke-linejoin": "round",
+    });
+    expect(svg.findAll("path").map((path) => path.attributes("d"))).toEqual([
+      "M18 6 6 18",
+      "m6 6 12 12",
+    ]);
   });
 
-  it("renders svg icons from aliases", () => {
-    const xWrapper = mount(IconX);
-    const loaderWrapper = mount(IconLoader2);
+  it("draws circle and polygon nodes", () => {
+    const circle = mount(IconCircle).find("svg").find("circle");
+    const polygon = mount(IconPlay).find("svg").find("polygon");
 
-    expect(xWrapper.find("svg").exists()).toBe(true);
-    expect(loaderWrapper.find("svg").exists()).toBe(true);
+    expect(circle.attributes()).toMatchObject({ cx: "12", cy: "12", r: "10" });
+    expect(polygon.attributes("points")).toBe("6 3 20 12 6 21 6 3");
   });
 
-  it("passes through classes, size, style, and accessibility attributes", () => {
-    const wrapper = mount(IconX, {
+  it("applies size, color and stroke-width", () => {
+    const svg = mount(IconX, {
+      props: { size: 18, color: "red", strokeWidth: 1.75 },
+    }).find("svg");
+
+    expect(svg.attributes()).toMatchObject({
+      width: "18",
+      height: "18",
+      stroke: "red",
+      "stroke-width": "1.75",
+    });
+  });
+
+  it("passes other attributes to the svg after the Lucide classes", () => {
+    const svg = mount(IconX, {
       attrs: {
         class: "icon-class",
-        width: "18",
-        height: "20",
-        "stroke-width": "1.5",
-        role: "img",
-        "aria-hidden": "true",
+        fill: "currentColor",
+        "data-testid": "close-icon",
         style: "color: rgb(255, 0, 0);",
       },
-    });
+    }).find("svg");
+
+    expect(svg.classes()).toEqual(["lucide", "lucide-x", "icon-class"]);
+    expect(svg.attributes("fill")).toBe("currentColor");
+    expect(svg.attributes("data-testid")).toBe("close-icon");
+    expect(svg.attributes("style")).toContain("color: rgb(255, 0, 0)");
+  });
 
-    const svg = wrapper.find("svg");
+  it("hides an unnamed icon from screen readers", () => {
+    const svg = mount(IconX).find("svg");
 
-    expect(svg.exists()).toBe(true);
-    expect(svg.classes()).toContain("icon-class");
-    expect(svg.attributes("width")).toBe("18");
-    expect(svg.attributes("height")).toBe("20");
-    expect(svg.attributes("stroke-width")).toBe("1.5");
-    expect(svg.attributes("role")).toBe("img");
     expect(svg.attributes("aria-hidden")).toBe("true");
-    expect(svg.attributes("style")).toContain("color");
+  });
+
+  it("keeps a named icon visible to screen readers", () => {
+    const labelled = mount(IconX, { attrs: { "aria-label": "Close" } }).find(
+      "svg",
+    );
+    const withRole = mount(IconX, { attrs: { role: "img" } }).find("svg");
+
+    expect(labelled.attributes("aria-hidden")).toBeUndefined();
+    expect(labelled.attributes("aria-label")).toBe("Close");
+    expect(withRole.attributes("aria-hidden")).toBeUndefined();
+  });
+
+  it("keeps an icon with slot content visible to screen readers", () => {
+    const svg = mount(IconX, {
+      slots: { default: () => h("title", "Close") },
+    }).find("svg");
+
+    expect(svg.attributes("aria-hidden")).toBeUndefined();
+    expect(svg.find("title").text()).toBe("Close");
   });
 });

package/src/v2/components/icons/index.ts

@@ -1,27 +1,109 @@
-export {
-  MessageCircle as IconMessageCircle,
-  X as IconX,
-  ChevronDown as IconChevronDown,
-  Plus as IconPlus,
-  Mic as IconMic,
-  ArrowUp as IconArrowUp,
-  Check as IconCheck,
-  Square as IconSquare,
-  Loader2 as IconLoader2,
-  Copy as IconCopy,
-  Download as IconDownload,
-  Edit as IconEdit,
-  ChevronLeft as IconChevronLeft,
-  ChevronRight as IconChevronRight,
-  ThumbsUp as IconThumbsUp,
-  ThumbsDown as IconThumbsDown,
-  Volume2 as IconVolume2,
-  RefreshCw as IconRefreshCw,
-  CheckCircle as IconCheckCircle,
-  Circle as IconCircle,
-  PanelLeftOpen as IconPanelLeftOpen,
-  Play as IconPlay,
-  Upload as IconUpload,
-  Wrench as IconWrench,
-  EyeOff as IconEyeOff,
-} from "lucide-vue-next";
+import { defineComponent, h } from "vue";
+import type { PropType } from "vue";
+import { ɵcopilotIcons, ɵcopilotIconSvgAttributes } from "@copilotkit/core";
+import type { CopilotIconName } from "@copilotkit/core";
+
+/** True when the attributes give the icon an accessible name or role. */
+function hasAccessibleAttribute(attributes: object) {
+  return Object.keys(attributes).some(
+    (key) => key.startsWith("aria-") || key === "role" || key === "title",
+  );
+}
+
+/** Props that change how an icon is drawn. Other attributes go on the `<svg>`. */
+const iconDrawProps = {
+  /** Width and height of the icon. Defaults to `24`. */
+  size: { type: [Number, String], default: 24 },
+  /** Line color. Defaults to `currentColor`. */
+  color: { type: String, default: "currentColor" },
+  /** Line width. Defaults to `2`. */
+  strokeWidth: { type: [Number, String], default: 2 },
+};
+
+/**
+ * Draws one of the chat icons as an inline `<svg>`.
+ *
+ * The `<svg>` has the classes `lucide lucide-<icon name>`, so CSS that selects
+ * them (for example `svg.lucide-arrow-up`) keeps working. The icon is hidden
+ * from screen readers unless you give it an `aria-*` attribute, a `role` or a
+ * `title`. Other attributes, such as `class` or `fill`, go on the `<svg>`.
+ *
+ * Props:
+ * - `name`: the chat icon, for example `"ArrowUp"` or `"X"`.
+ * - `size`: width and height. Defaults to `24`.
+ * - `stroke-width`: line width. Defaults to `2`.
+ * - `color`: line color. Defaults to `currentColor`.
+ *
+ * @example
+ * ```vue
+ * <CopilotIcon name="ArrowUp" class="cpk-chat-input-send-icon" />
+ * <CopilotIcon name="X" aria-label="Close" />
+ * ```
+ */
+export const CopilotIcon = defineComponent({
+  name: "CopilotIcon",
+  props: {
+    /** The chat icon to draw, for example `"ArrowUp"`. */
+    name: { type: String as PropType<CopilotIconName>, required: true },
+    ...iconDrawProps,
+  },
+  setup(props, { attrs, slots }) {
+    return () => {
+      const icon = ɵcopilotIcons[props.name];
+      const content = slots.default?.() ?? [];
+      const isDecorative =
+        content.length === 0 && !hasAccessibleAttribute(attrs);
+      return h(
+        "svg",
+        {
+          ...ɵcopilotIconSvgAttributes,
+          width: props.size,
+          height: props.size,
+          stroke: props.color,
+          "stroke-width": props.strokeWidth,
+          class: ["lucide", `lucide-${icon.name}`],
+          "aria-hidden": isDecorative ? "true" : undefined,
+        },
+        [...icon.nodes.map((node) => h(node.tag, node.attributes)), ...content],
+      );
+    };
+  },
+});
+
+/**
+ * Internal. Makes a component that draws one chat icon, such as `IconArrowUp`.
+ * It takes the same `size`, `color` and `stroke-width` props as `CopilotIcon`.
+ */
+function defineIcon(name: CopilotIconName) {
+  return defineComponent({
+    name: `Icon${name}`,
+    props: iconDrawProps,
+    setup(props, { slots }) {
+      return () => h(CopilotIcon, { name, ...props }, slots);
+    },
+  });
+}
+
+export const IconArrowUp = defineIcon("ArrowUp");
+export const IconCheck = defineIcon("Check");
+export const IconChevronDown = defineIcon("ChevronDown");
+export const IconChevronLeft = defineIcon("ChevronLeft");
+export const IconChevronRight = defineIcon("ChevronRight");
+export const IconCircle = defineIcon("Circle");
+export const IconCopy = defineIcon("Copy");
+export const IconEdit = defineIcon("Edit");
+export const IconEyeOff = defineIcon("EyeOff");
+export const IconLoader2 = defineIcon("Loader2");
+export const IconMessageCircle = defineIcon("MessageCircle");
+export const IconMic = defineIcon("Mic");
+export const IconPanelLeftOpen = defineIcon("PanelLeftOpen");
+export const IconPlay = defineIcon("Play");
+export const IconPlus = defineIcon("Plus");
+export const IconRefreshCw = defineIcon("RefreshCw");
+export const IconSquare = defineIcon("Square");
+export const IconThumbsDown = defineIcon("ThumbsDown");
+export const IconThumbsUp = defineIcon("ThumbsUp");
+export const IconUpload = defineIcon("Upload");
+export const IconVolume2 = defineIcon("Volume2");
+export const IconWrench = defineIcon("Wrench");
+export const IconX = defineIcon("X");

package/src/v2/hooks/__tests__/use-frontend-tool.e2e.test.ts

@@ -1,4 +1,12 @@
-import { computed, defineComponent, onMounted, ref, watch } from "vue";
+import {
+  computed,
+  defineComponent,
+  h,
+  nextTick,
+  onMounted,
+  ref,
+  watch,
+} from "vue";
 import type { PropType } from "vue";
 import { screen, fireEvent, waitFor, cleanup } from "@testing-library/vue";
 import { afterEach, describe, expect, it } from "vitest";
@@ -27,6 +35,11 @@ import {
   textChunkEvent,
   testId,
 } from "../../__tests__/utils/test-helpers";
+import { mountWithProvider } from "../../__tests__/utils/mount";
+import {
+  StateCapturingAgent,
+  toolCallMessage,
+} from "../../__tests__/utils/agents";
 
 afterEach(() => {
   cleanup();
@@ -912,6 +925,54 @@ describe("useFrontendTool E2E - Dynamic Registration", () => {
     });
   });
 
+  describe("Overriding a provider tool", () => {
+    it("brings the provider tool back after the overriding component unmounts", async () => {
+      const calls: string[] = [];
+      const lookupTool = (owner: string): VueFrontendTool => ({
+        name: "lookup",
+        parameters: z.object({}),
+        followUp: false,
+        handler: async () => {
+          calls.push(owner);
+          return owner;
+        },
+      });
+
+      const OverridingTool = defineComponent({
+        setup() {
+          useFrontendTool(lookupTool("component"));
+          return () => null;
+        },
+      });
+
+      const showOverride = ref(true);
+      const agent = new StateCapturingAgent(
+        [
+          { newMessages: [toolCallMessage("lookup")] },
+          { newMessages: [toolCallMessage("lookup")] },
+        ],
+        "test-agent",
+      );
+      const { getCore, wrapper } = mountWithProvider(
+        () => (showOverride.value ? h(OverridingTool) : h("div")),
+        {
+          frontendTools: [lookupTool("provider")],
+          agents__unsafe_dev_only: { "test-agent": agent },
+        },
+      );
+
+      await nextTick();
+      await getCore().runAgent({ agent });
+
+      showOverride.value = false;
+      await nextTick();
+      await getCore().runAgent({ agent });
+
+      expect(calls).toEqual(["component", "provider"]);
+      wrapper.unmount();
+    });
+  });
+
   describe("Integration with Chat UI", () => {
     it("should render tool output correctly in chat interface", async () => {
       const agent = new MockStepwiseAgent();

package/src/v2/hooks/__tests__/use-render-activity-message.test.ts

@@ -0,0 +1,105 @@
+import {
+  afterEach,
+  beforeEach,
+  describe,
+  expect,
+  expectTypeOf,
+  it,
+  vi,
+} from "vitest";
+import { defineComponent, h, toRaw } from "vue";
+import { z } from "zod";
+import type { ActivityMessage } from "@ag-ui/core";
+import { useRenderActivityMessage } from "../use-render-activity-message";
+import type {
+  VueActivityMessageRenderer,
+  VueActivityMessageRendererProps,
+} from "../../types";
+import { renderWithCopilotKit } from "../../__tests__/utils/mount";
+
+const ProgressRenderer = defineComponent({
+  props: { content: { type: Object, required: true } },
+  setup: () => () => null,
+});
+
+const progressSchema = z.object({
+  label: z.string(),
+  percent: z.number().default(0),
+});
+
+// A zod schema is a Standard Schema, so it fits the `content` field, and the
+// renderer's content type is the schema's output type.
+const progressRenderer = {
+  activityType: "progress",
+  content: progressSchema,
+  render: ProgressRenderer,
+} satisfies VueActivityMessageRenderer<z.output<typeof progressSchema>>;
+
+function activityMessage(content: Record<string, unknown>): ActivityMessage {
+  return {
+    id: "activity-1",
+    role: "activity",
+    activityType: "progress",
+    content,
+  };
+}
+
+function renderWithProgressRenderer() {
+  let helpers: ReturnType<typeof useRenderActivityMessage> | undefined;
+  const Probe = defineComponent({
+    setup() {
+      helpers = useRenderActivityMessage();
+      return () => null;
+    },
+  });
+
+  renderWithCopilotKit(() => h(Probe), {
+    providerProps: { renderActivityMessages: [progressRenderer] },
+  });
+
+  if (!helpers) throw new Error("useRenderActivityMessage did not run");
+  return helpers;
+}
+
+describe("useRenderActivityMessage", () => {
+  let consoleWarnSpy: ReturnType<typeof vi.spyOn>;
+
+  beforeEach(() => {
+    consoleWarnSpy = vi.spyOn(console, "warn").mockImplementation(() => {});
+  });
+
+  afterEach(() => {
+    consoleWarnSpy.mockRestore();
+  });
+
+  it("types a zod content schema's output as the render props content", () => {
+    type Props = VueActivityMessageRendererProps<
+      z.output<typeof progressSchema>
+    >;
+    expectTypeOf<Props["content"]>().toEqualTypeOf<{
+      label: string;
+      percent: number;
+    }>();
+  });
+
+  it("passes the zod schema's parsed output to the renderer", () => {
+    const { renderActivityMessage } = renderWithProgressRenderer();
+
+    const result = renderActivityMessage(activityMessage({ label: "Upload" }));
+
+    // The provider stores renderers in reactive state, so compare the raw value.
+    expect(toRaw(result?.renderer)).toBe(ProgressRenderer);
+    expect(result?.props.content).toEqual({ label: "Upload", percent: 0 });
+  });
+
+  it("returns null and warns when the content fails the schema", () => {
+    const { renderActivityMessage } = renderWithProgressRenderer();
+
+    const result = renderActivityMessage(activityMessage({ label: 42 }));
+
+    expect(result).toBeNull();
+    expect(consoleWarnSpy).toHaveBeenCalledWith(
+      "Failed to validate content for activity message 'progress'.",
+    );
+  });
+});

package/src/v2/hooks/__tests__/use-render-tool.test.ts

@@ -93,7 +93,7 @@ describe("useRenderTool", () => {
     expect(typeof renderer?.render).toBe("function");
   });
 
-  it("registers wildcard renderer and defaults parameters schema to z.any", () => {
+  it("registers wildcard renderer and defaults parameters to a schema that accepts any value", () => {
     const core = createMockCore();
     mockUseCopilotKit.mockReturnValue({ copilotkit: { value: core } });
 
@@ -118,11 +118,8 @@ describe("useRenderTool", () => {
     const renderer = core.renderToolCalls.find((item) => item.name === "*");
     expect(renderer).toBeDefined();
     expect(typeof renderer?.render).toBe("function");
-    const wildcardArgs = renderer?.args as
-      | { safeParse: (v: unknown) => { success: boolean } }
-      | undefined;
-    expect(wildcardArgs).toBeDefined();
-    expect(wildcardArgs!.safeParse({ arbitrary: true }).success).toBe(true);
+    const result = renderer?.args["~standard"].validate({ arbitrary: true });
+    expect(result).toEqual({ value: { arbitrary: true } });
   });
 
   it("accepts a Vue component renderer", () => {

package/src/v2/hooks/__tests__/zod-regression.test.ts

@@ -4,7 +4,7 @@
  *
  * Covers:
  * 1. useRenderTool with complex Zod schemas
- * 2. defineToolCallRenderer with Zod (named + wildcard default z.any())
+ * 2. defineToolCallRenderer with Zod (named + wildcard default schema)
  * 3. useComponent with Zod schemas
  * 4. The registered schema object is the original Zod instance (identity check)
  */
@@ -134,7 +134,7 @@ describe("useRenderTool Zod regression", () => {
     const schema = z.object({
       action: z.discriminatedUnion("type", [
         z.object({ type: z.literal("search"), query: z.string() }),
-        z.object({ type: z.literal("navigate"), url: z.string().url() }),
+        z.object({ type: z.literal("navigate"), url: z.url() }),
       ]),
     });
 
@@ -196,14 +196,15 @@ describe("useRenderTool Zod regression", () => {
 });
 
 describe("defineToolCallRenderer Zod regression", () => {
-  it("wildcard tool defaults to z.any() for args", () => {
+  it("wildcard tool defaults to a schema that accepts any value", () => {
     const renderer = defineToolCallRenderer({
       name: "*",
       render: () => "wildcard",
     });
 
     expect(renderer.name).toBe("*");
-    expect((renderer.args as any)["~standard"].vendor).toBe("zod");
+    const result = renderer.args["~standard"].validate({ city: "Paris" });
+    expect(result).toEqual({ value: { city: "Paris" } });
   });
 
   it("named tool with Zod args preserves schema identity", () => {

package/src/v2/hooks/use-attachments.ts

@@ -240,15 +240,19 @@ export function useAttachments(
     await processFiles(files);
   }
 
+  function onPaste(event: ClipboardEvent) {
+    void handlePaste(event);
+  }
+
   onMounted(() => {
     if (typeof document !== "undefined") {
-      document.addEventListener("paste", handlePaste);
+      document.addEventListener("paste", onPaste);
     }
   });
 
   onBeforeUnmount(() => {
     if (typeof document !== "undefined") {
-      document.removeEventListener("paste", handlePaste);
+      document.removeEventListener("paste", onPaste);
     }
   });
 

package/src/v2/hooks/use-frontend-tool.ts

@@ -12,6 +12,11 @@ const EMPTY_DEPS: WatchSource<unknown>[] = [];
  * The tool registration is reactive to provided dependencies and is cleaned up
  * automatically when the current scope is disposed.
  *
+ * A tool with the same name and `agentId` as a tool that is already
+ * registered (for example a provider `frontendTools` entry) takes its place
+ * while this scope is active. When the scope is disposed, the earlier tool is
+ * active again.
+ *
  * @example
  * ```ts
  * useFrontendTool({
@@ -42,13 +47,10 @@ export function useFrontendTool<T extends Record<string, unknown>>(
       const core = copilotkit.value;
       const name = tool.name;
 
-      if (core.getTool({ toolName: name, agentId: tool.agentId })) {
-        console.warn(
-          `Tool '${name}' already exists for agent '${tool.agentId || "global"}'. Overriding with latest registration.`,
-        );
-        core.removeTool(name, tool.agentId);
-      }
-      core.addTool(tool);
+      // Registrations stack in core: this one shadows an earlier tool with the
+      // same name and agentId (a provider tool, or another component's), and
+      // unregistering it brings that tool back.
+      const unregister = core.addTool(tool);
 
       // The render function is registered even when tool.parameters is
       // undefined — tools like HITL confirm dialogs have no parameters
@@ -62,9 +64,7 @@ export function useFrontendTool<T extends Record<string, unknown>>(
         } as VueToolCallRenderer<unknown>);
       }
 
-      onCleanup(() => {
-        core.removeTool(name, tool.agentId);
-      });
+      onCleanup(unregister);
     },
     { immediate: true },
   );