@copilotkit/vue 2.0.0-rc.1 → 2.0.0-rc.11

package/src/v2/components/ui/floating.ts

@@ -0,0 +1,321 @@
+import { onBeforeUnmount, ref, watch } from "vue";
+import type { CSSProperties, Ref } from "vue";
+
+/**
+ * Positions floating UI (tooltips, popovers, menus) next to an element, the
+ * way React's Radix primitives do: fixed to the viewport, flipped to the other
+ * side when it does not fit, and shifted along its side to stay on screen.
+ * Floating content sits in a wrapper that carries the position, so the
+ * content's own enter and exit animations can use `transform`.
+ * @internal
+ */
+
+export type FloatingSide = "top" | "right" | "bottom" | "left";
+export type FloatingAlign = "start" | "center" | "end";
+
+export interface FloatingOptions {
+  side?: FloatingSide;
+  align?: FloatingAlign;
+  /** Distance from the reference element, in px. */
+  sideOffset?: number;
+  /** Shift along the side, in px, for `start` and `end`. */
+  alignOffset?: number;
+  /** Space kept between the content and the viewport edge, in px. */
+  collisionPadding?: number;
+  /** Size of an arrow drawn on the content, in px (added to the offset). */
+  arrowSize?: number;
+}
+
+export interface FloatingPlacement {
+  x: number;
+  y: number;
+  side: FloatingSide;
+  align: FloatingAlign;
+  /** Room left between the reference element and the viewport edge. */
+  availableWidth: number;
+  availableHeight: number;
+  /** The reference element's center on the content, for its arrow. */
+  arrowX?: number;
+  arrowY?: number;
+  transformOrigin: string;
+}
+
+const OPPOSITE: Record<FloatingSide, FloatingSide> = {
+  top: "bottom",
+  bottom: "top",
+  left: "right",
+  right: "left",
+};
+
+const clamp = (value: number, min: number, max: number) =>
+  Math.min(Math.max(value, min), Math.max(min, max));
+
+/** Where content of `size` goes next to `reference` in a `viewport`. */
+export function computeFloatingPlacement(
+  reference: Pick<
+    DOMRect,
+    "top" | "left" | "right" | "bottom" | "width" | "height"
+  >,
+  size: { width: number; height: number },
+  viewport: { width: number; height: number },
+  options: FloatingOptions = {},
+): FloatingPlacement {
+  const {
+    side: preferredSide = "bottom",
+    align = "center",
+    sideOffset = 0,
+    alignOffset = 0,
+    collisionPadding = 0,
+    arrowSize = 0,
+  } = options;
+  const offset = sideOffset + arrowSize;
+
+  const space = (side: FloatingSide) =>
+    ({
+      top: reference.top,
+      bottom: viewport.height - reference.bottom,
+      left: reference.left,
+      right: viewport.width - reference.right,
+    })[side] -
+    offset -
+    collisionPadding;
+  const needed = (side: FloatingSide) =>
+    side === "top" || side === "bottom" ? size.height : size.width;
+
+  let side = preferredSide;
+  const opposite = OPPOSITE[preferredSide];
+  if (
+    space(side) < needed(side) &&
+    space(opposite) >= needed(opposite) &&
+    space(opposite) > space(side)
+  ) {
+    side = opposite;
+  }
+
+  const vertical = side === "top" || side === "bottom";
+  let x: number;
+  let y: number;
+  if (vertical) {
+    y =
+      side === "top"
+        ? reference.top - size.height - offset
+        : reference.bottom + offset;
+    x =
+      align === "start"
+        ? reference.left + alignOffset
+        : align === "end"
+          ? reference.right - size.width - alignOffset
+          : reference.left + reference.width / 2 - size.width / 2;
+    x = clamp(
+      x,
+      collisionPadding,
+      viewport.width - size.width - collisionPadding,
+    );
+  } else {
+    x =
+      side === "left"
+        ? reference.left - size.width - offset
+        : reference.right + offset;
+    y =
+      align === "start"
+        ? reference.top + alignOffset
+        : align === "end"
+          ? reference.bottom - size.height - alignOffset
+          : reference.top + reference.height / 2 - size.height / 2;
+    y = clamp(
+      y,
+      collisionPadding,
+      viewport.height - size.height - collisionPadding,
+    );
+  }
+
+  const arrowX = vertical
+    ? clamp(reference.left + reference.width / 2 - x, 0, size.width)
+    : undefined;
+  const arrowY = vertical
+    ? undefined
+    : clamp(reference.top + reference.height / 2 - y, 0, size.height);
+  const transformOrigin = vertical
+    ? `${arrowX}px ${side === "top" ? `${size.height + arrowSize}px` : `${-arrowSize}px`}`
+    : `${side === "left" ? `${size.width + arrowSize}px` : `${-arrowSize}px`} ${arrowY}px`;
+
+  return {
+    x,
+    y,
+    side,
+    align,
+    availableWidth: vertical
+      ? viewport.width - 2 * collisionPadding
+      : Math.max(0, space(side)),
+    availableHeight: vertical
+      ? Math.max(0, space(side))
+      : viewport.height - 2 * collisionPadding,
+    arrowX,
+    arrowY,
+    transformOrigin,
+  };
+}
+
+/** Whether `element` is scrolled or clipped fully out of view. */
+export function isElementClippedAway(element: Element): boolean {
+  const rect = element.getBoundingClientRect();
+  const view = element.ownerDocument.defaultView;
+  if (!view) return false;
+  let top = 0;
+  let left = 0;
+  let bottom = view.innerHeight;
+  let right = view.innerWidth;
+  for (
+    let parent = element.parentElement;
+    parent;
+    parent = parent.parentElement
+  ) {
+    const { overflowX, overflowY } = view.getComputedStyle(parent);
+    if (overflowX === "visible" && overflowY === "visible") continue;
+    const clip = parent.getBoundingClientRect();
+    top = Math.max(top, clip.top);
+    left = Math.max(left, clip.left);
+    bottom = Math.min(bottom, clip.bottom);
+    right = Math.min(right, clip.right);
+  }
+  // Strict, so an element that only touches the edge still counts as shown.
+  return (
+    rect.bottom < top ||
+    rect.top > bottom ||
+    rect.right < left ||
+    rect.left > right
+  );
+}
+
+/**
+ * Keeps `floating` placed next to `reference` while `open`: on scroll,
+ * resize, and size changes of either element.
+ */
+export function useFloating(
+  reference: Ref<HTMLElement | null | undefined>,
+  floating: Ref<HTMLElement | null | undefined>,
+  open: Ref<boolean>,
+  options: () => FloatingOptions & { hideWhenDetached?: boolean },
+) {
+  const placement = ref<FloatingPlacement | null>(null);
+  const referenceHidden = ref(false);
+  let cleanup: (() => void) | undefined;
+
+  const update = () => {
+    const referenceElement = reference.value;
+    const floatingElement = floating.value;
+    if (!referenceElement || !floatingElement) return;
+    const view = floatingElement.ownerDocument.defaultView;
+    if (!view) return;
+    const opts = options();
+    placement.value = computeFloatingPlacement(
+      referenceElement.getBoundingClientRect(),
+      {
+        width: floatingElement.offsetWidth,
+        height: floatingElement.offsetHeight,
+      },
+      { width: view.innerWidth, height: view.innerHeight },
+      opts,
+    );
+    referenceHidden.value =
+      !!opts.hideWhenDetached &&
+      (!referenceElement.isConnected || isElementClippedAway(referenceElement));
+  };
+
+  const stop = () => {
+    cleanup?.();
+    cleanup = undefined;
+  };
+
+  watch(
+    [open, reference, floating],
+    ([isOpen, referenceElement, floatingElement]) => {
+      stop();
+      if (!isOpen || !referenceElement || !floatingElement) {
+        if (!isOpen) placement.value = null;
+        return;
+      }
+      update();
+      const view = floatingElement.ownerDocument.defaultView;
+      if (!view) return;
+      let frame = 0;
+      const schedule = () => {
+        if (frame) return;
+        frame = view.requestAnimationFrame(() => {
+          frame = 0;
+          update();
+        });
+      };
+      view.addEventListener("scroll", schedule, {
+        capture: true,
+        passive: true,
+      });
+      view.addEventListener("resize", schedule);
+      const observer =
+        typeof ResizeObserver === "undefined"
+          ? undefined
+          : new ResizeObserver(schedule);
+      observer?.observe(referenceElement);
+      observer?.observe(floatingElement);
+      cleanup = () => {
+        if (frame) view.cancelAnimationFrame(frame);
+        view.removeEventListener("scroll", schedule, { capture: true });
+        view.removeEventListener("resize", schedule);
+        observer?.disconnect();
+      };
+    },
+    { flush: "post", immediate: true },
+  );
+
+  onBeforeUnmount(stop);
+
+  /** Style for the wrapper around the floating content. */
+  const wrapperStyle = (zIndex?: string | number): CSSProperties => {
+    const current = placement.value;
+    return {
+      position: "fixed",
+      left: "0px",
+      top: "0px",
+      minWidth: "max-content",
+      zIndex: zIndex ?? 50,
+      // Off screen until measured, as Radix does.
+      transform: current
+        ? `translate(${Math.round(current.x)}px, ${Math.round(current.y)}px)`
+        : "translate(0, -200%)",
+      visibility: referenceHidden.value ? "hidden" : undefined,
+      pointerEvents: referenceHidden.value ? "none" : undefined,
+    };
+  };
+
+  return { placement, referenceHidden, update, wrapperStyle };
+}
+
+/**
+ * Style for an arrow wrapper on floating content, as Radix places it: on the
+ * edge facing the reference element, centered on it.
+ */
+export function arrowWrapperStyle(
+  placement: FloatingPlacement | null,
+): CSSProperties {
+  if (!placement) return { position: "absolute", visibility: "hidden" };
+  const { side, arrowX, arrowY } = placement;
+  return {
+    position: "absolute",
+    left: arrowX !== undefined ? `${arrowX}px` : undefined,
+    top: arrowY !== undefined ? `${arrowY}px` : undefined,
+    [OPPOSITE[side]]: "0px",
+    transformOrigin: {
+      top: "",
+      right: "0 0",
+      bottom: "center 0",
+      left: "100% 0",
+    }[side],
+    transform: {
+      top: "translateY(100%)",
+      right: "translateY(50%) rotate(90deg) translateX(-50%)",
+      bottom: "rotate(180deg)",
+      left: "translateY(50%) rotate(-90deg) translateX(50%)",
+    }[side],
+    marginLeft: arrowX !== undefined ? "-5px" : undefined,
+  };
+}

package/src/v2/components/ui/presence.ts

@@ -0,0 +1,54 @@
+import { nextTick, onBeforeUnmount, ref, watch } from "vue";
+import type { Ref } from "vue";
+
+/**
+ * Keeps closing content mounted until its exit animation ends, like Radix's
+ * Presence: the content gets `data-state="closed"`, and its CSS animation
+ * (for example `cpk-tooltip-exit`) plays before it unmounts.
+ * @internal
+ */
+export function usePresence(
+  open: Ref<boolean>,
+  element: Ref<HTMLElement | null | undefined>,
+) {
+  const present = ref(open.value);
+  let finish: (() => void) | undefined;
+
+  const stopWaiting = () => {
+    finish?.();
+    finish = undefined;
+  };
+
+  watch(open, async (isOpen) => {
+    stopWaiting();
+    if (isOpen) {
+      present.value = true;
+      return;
+    }
+    // Let `data-state="closed"` reach the DOM, so its animation starts.
+    await nextTick();
+    if (open.value) return;
+    const node = element.value;
+    const view = node?.ownerDocument.defaultView;
+    const animationName = node && view?.getComputedStyle(node).animationName;
+    if (!node || !view || !animationName || animationName === "none") {
+      present.value = false;
+      return;
+    }
+    const done = () => {
+      stopWaiting();
+      if (!open.value) present.value = false;
+    };
+    // A fallback, in case the animation is cancelled without an end event.
+    const timer = view.setTimeout(done, 400);
+    node.addEventListener("animationend", done, { once: true });
+    finish = () => {
+      view.clearTimeout(timer);
+      node.removeEventListener("animationend", done);
+    };
+  });
+
+  onBeforeUnmount(stopWaiting);
+
+  return present;
+}

package/src/v2/components/ui/use-id.ts

@@ -0,0 +1,16 @@
+import * as vue from "vue";
+
+let counter = 0;
+
+/**
+ * A unique id for ARIA references. Uses Vue's SSR-safe `useId()` on Vue 3.5+;
+ * the peer range starts at 3.3, which has none, so older Vue gets a counter.
+ * Read through the namespace, so a Vue without the export does not fail to
+ * import this module.
+ * @internal
+ */
+export function useCopilotId(prefix = "cpk"): string {
+  const vueUseId = (vue as { useId?: () => string }).useId;
+  const id = vueUseId?.();
+  return id ? `${prefix}-${id}` : `${prefix}-${++counter}`;
+}

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", () => {