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

package/src/v2/components/chat/types.ts

@@ -6,24 +6,73 @@ import type {
   ToolMessage,
   UserMessage,
 } from "@ag-ui/core";
+import type { VNode } from "vue";
 import type { CopilotKitCoreErrorCode, ToolCallStatus } from "@copilotkit/core";
 import type { Suggestion } from "@copilotkit/core";
 import type {
   Attachment,
   AttachmentsConfig,
   AttachmentModality,
+  InputContentSource,
 } from "@copilotkit/shared";
-import type { CopilotChatLabels } from "../../providers/types";
+import type {
+  CopilotChatLabels,
+  CopilotChatToolCallDisplay,
+  ToolCallEntry,
+} from "@copilotkit/core";
 import type { InterruptEvent } from "../../types";
 import type { AutoScrollMode } from "./normalize-auto-scroll";
 
 export type CopilotChatInputMode = "input" | "transcribe" | "processing";
 export type { Attachment, AttachmentsConfig, AttachmentModality };
 export type { AutoScrollMode };
+export type { CopilotChatToolCallDisplay, ToolCallEntry };
+
+/** How a `CopilotChatToolCallGroup` draws its calls. */
+export type CopilotChatToolCallGroupAppearance = "card" | "line" | "stack";
+
+/** Props of the `#tool-calls-group` slot, which replaces a group of calls. */
+export interface CopilotChatToolCallsGroupSlotProps {
+  /** The calls in the group, in order. */
+  calls: ToolCallEntry[];
+  /** The appearance the view's `toolCallDisplay` asks for. */
+  appearance: CopilotChatToolCallGroupAppearance;
+  /** The agent is running and nothing follows the group, so more calls may join it. */
+  isActive: boolean;
+  /**
+   * Draws one call through the registered renderers and tool-call slots.
+   * Render the VNode with `<component :is="renderCall(call)" />`.
+   */
+  renderCall: (call: ToolCallEntry) => VNode;
+}
+
+/**
+ * Props of `CopilotChatWorkSummary` and of the `#work-summary` slot, which
+ * replaces the "Working… / Worked for 9s" line of the `"turn"` display.
+ */
+export interface CopilotChatWorkSummarySlotProps {
+  /** The agent is still working on this reply. */
+  isWorking: boolean;
+  /** Whether the work (narration and tool calls) is showing. */
+  isOpen: boolean;
+  /** The tool calls the reply made. */
+  calls: ToolCallEntry[];
+  /**
+   * How long the agent has worked on the reply, in ms, summed over its runs
+   * so time spent waiting between them doesn't count. Only known for replies
+   * this client watched start; without it the summary shows the tool count.
+   */
+  elapsedMs?: number;
+  /** When the current run started (epoch ms), while the agent is working. */
+  workingSince?: number;
+  /** Opens or closes the reply's work. */
+  onClick: () => void;
+}
 
 export interface CopilotChatAttachmentRendererProps {
   type: AttachmentModality;
-  source: Attachment["source"];
+  /** Any AG-UI content source, as in React; a `file` handle shows no preview. */
+  source: InputContentSource;
   filename?: string;
   className?: string;
 }
@@ -94,6 +143,20 @@ export interface CopilotChatViewProps {
   onDragLeave?: (event: DragEvent) => void;
   onDrop?: (event: DragEvent) => void;
   onFinishTranscribeWithAudio?: (audioBlob: Blob) => void | Promise<void>;
+  /**
+   * How tool calls show. Defaults to `"grouped"`: calls made in a row share
+   * one card that opens to a row per call. `"line"` and `"stacked"` group
+   * them too; `"separate"` gives every call its own card. Calls drawn by a
+   * renderer that does not set `group: true`, or by a tool-call slot, always
+   * show on their own.
+   */
+  toolCallDisplay?: CopilotChatToolCallDisplay;
+  /**
+   * Whether reply thumbs record ratings for Automatic Learning once a
+   * Trajectory has started. Defaults to `true`; set `false` to keep the
+   * thumbs to your own `thumbs-up` / `thumbs-down` handlers and slots.
+   */
+  messageFeedback?: boolean;
 }
 
 export interface CopilotChatProps extends Omit<
@@ -319,13 +382,56 @@ export interface CopilotChatAssistantMessageCopyButtonSlotProps {
   label: string;
 }
 
+/**
+ * Attributes and listeners that let a thumb record a Learning rating and open
+ * its comment popover. Bind them on the thumb's `<button>` with `v-bind`;
+ * they are empty while the chat records no ratings.
+ */
+export type CopilotChatAssistantMessageThumbProps = Record<string, unknown>;
+
 export interface CopilotChatAssistantMessageThumbsUpButtonSlotProps {
-  onThumbsUp: () => void;
+  /**
+   * Rates the reply. Pass the click event, so the comment points at the
+   * clicked thumb and a keyboard click moves focus into it.
+   */
+  onThumbsUp: (event?: MouseEvent) => void;
   label: string;
+  /** This rating is the chosen one (Learning only). */
+  pressed: boolean;
+  thumbProps: CopilotChatAssistantMessageThumbProps;
 }
 
 export interface CopilotChatAssistantMessageThumbsDownButtonSlotProps {
-  onThumbsDown: () => void;
+  /** See {@link CopilotChatAssistantMessageThumbsUpButtonSlotProps.onThumbsUp}. */
+  onThumbsDown: (event?: MouseEvent) => void;
+  label: string;
+  /** This rating is the chosen one (Learning only). */
+  pressed: boolean;
+  thumbProps: CopilotChatAssistantMessageThumbProps;
+}
+
+/** Props of the `feedback-comment` slot: the comment field of a rating. */
+export interface CopilotChatAssistantMessageFeedbackCommentSlotProps {
+  value: string;
+  /** The comment already saved. */
+  savedComment: string;
+  /** Bind as `:ref` on the text field, so a keyboard rating can focus it. */
+  inputRef: (element: unknown) => void;
+  onChange: (value: string) => void;
+  /** Saves the comment, closes the popover and returns focus to the thumb. */
+  onSubmit: () => void;
+  onEditingChange: (editing: boolean) => void;
+  /**
+   * Focus left the form for `next`, or for no focusable element when null.
+   * Not called when the window loses focus.
+   */
+  onLeave: (next: Element | null) => void;
+}
+
+/** Props of the `inspector-button` slot. */
+export interface CopilotChatAssistantMessageInspectorButtonSlotProps {
+  /** Opens this message in the Inspector. */
+  onInspect: () => void;
   label: string;
 }
 
@@ -498,6 +604,8 @@ export interface CopilotSidebarViewToggleButtonSlotProps {
 export interface CopilotSidebarViewProps extends CopilotChatViewProps {
   width?: number | string;
   defaultOpen?: boolean;
+  /** The edge the sidebar docks to. Defaults to `"right"`. */
+  position?: "left" | "right";
 }
 
 export type CopilotPopupViewHeaderSlotProps = CopilotSidebarViewHeaderSlotProps;
@@ -533,4 +641,6 @@ export interface CopilotPopupProps extends CopilotChatProps {
 export interface CopilotSidebarProps extends CopilotChatProps {
   width?: number | string;
   defaultOpen?: boolean;
+  /** The edge the sidebar docks to. Defaults to `"right"`. */
+  position?: CopilotSidebarViewProps["position"];
 }

package/src/v2/components/chat/use-chat-labels.ts

@@ -0,0 +1,16 @@
+import { computed } from "vue";
+import { CopilotChatDefaultLabels } from "@copilotkit/core";
+import type { CopilotChatLabels } from "@copilotkit/core";
+import { useCopilotChatConfiguration } from "../../providers/useCopilotChatConfiguration";
+
+/**
+ * The chat labels in effect: the surrounding chat configuration's, or the
+ * default English labels outside a chat.
+ * @internal
+ */
+export function useChatLabels() {
+  const config = useCopilotChatConfiguration();
+  return computed<Readonly<CopilotChatLabels>>(
+    () => config.value?.labels ?? CopilotChatDefaultLabels,
+  );
+}

package/src/v2/components/chat/use-lightbox.ts

@@ -0,0 +1,64 @@
+import { nextTick, ref } from "vue";
+import { useCopilotId } from "../ui/use-id";
+
+type DocWithVT = Document & {
+  startViewTransition?: (cb: () => void | Promise<void>) => {
+    finished: Promise<void>;
+  };
+};
+
+/**
+ * Opens and closes a lightbox, using the View Transition API to morph the
+ * thumbnail into the full-screen content, as React's `useLightbox`.
+ *
+ * `view-transition-name` must be on exactly one element at a time: on the
+ * thumbnail in the old state, and on the lightbox content (bind `vtName` to
+ * it) in the new one. The transition callback waits for Vue to render the
+ * change, so the API can snapshot old and new correctly.
+ * @internal
+ */
+export function useLightbox() {
+  const thumbnailRef = ref<HTMLElement | null>(null);
+  const open = ref(false);
+  // A custom ident: Vue's ids can hold characters CSS does not allow there.
+  const vtName = useCopilotId("cpk-lightbox").replace(/[^\w-]/g, "-");
+
+  const openLightbox = () => {
+    const thumb = thumbnailRef.value;
+    const doc =
+      typeof document === "undefined" ? undefined : (document as DocWithVT);
+
+    if (doc?.startViewTransition && thumb) {
+      thumb.style.viewTransitionName = vtName;
+      doc.startViewTransition(async () => {
+        thumb.style.viewTransitionName = "";
+        open.value = true;
+        await nextTick();
+      });
+    } else {
+      open.value = true;
+    }
+  };
+
+  const closeLightbox = () => {
+    const thumb = thumbnailRef.value;
+    const doc =
+      typeof document === "undefined" ? undefined : (document as DocWithVT);
+
+    if (doc?.startViewTransition && thumb) {
+      const transition = doc.startViewTransition(async () => {
+        open.value = false;
+        await nextTick();
+        thumb.style.viewTransitionName = vtName;
+      });
+      const clear = () => {
+        thumb.style.viewTransitionName = "";
+      };
+      transition.finished.then(clear, clear);
+    } else {
+      open.value = false;
+    }
+  };
+
+  return { thumbnailRef, vtName, open, openLightbox, closeLightbox };
+}

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,23 +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,
-} 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");