@copilotkit/vue 2.0.0-rc.3 → 2.0.0-rc.31

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

@@ -1,127 +1,62 @@
-import type { Message, ToolCall, ToolMessage } from "@ag-ui/core";
-import { contentToText } from "@ag-ui/core";
-import { DEFAULT_AGENT_ID } from "@copilotkit/shared";
-import { ToolCallStatus } from "@copilotkit/core";
-import { partialJSONParse } from "@copilotkit/shared";
+import type { Message, ToolCall } from "@ag-ui/core";
+import {
+  ɵbuildToolCallRenderProps,
+  ɵfindToolMessage,
+  ɵresolveToolCallAgentId,
+  ɵresolveToolCallRenderer,
+} from "@copilotkit/core";
 import type { CopilotChatToolCallRenderSlotProps } from "./types";
 import type {
   VueToolCallRenderer,
   VueToolCallRendererRenderProps,
 } from "../../types";
 
-export function findToolMessage(
-  messages: Message[],
-  toolCallId: string,
-): ToolMessage | undefined {
-  return messages.find(
-    (message) =>
-      message.role === "tool" &&
-      (message as ToolMessage).toolCallId === toolCallId,
-  ) as ToolMessage | undefined;
-}
-
 export function getToolCallSlotName(toolName: string): `tool-call-${string}` {
   return `tool-call-${toolName}`;
 }
 
-export function getCoreRenderConfig(
-  toolCall: ToolCall,
-  renderToolCalls: readonly VueToolCallRenderer<unknown>[],
-  agentId: string,
-): VueToolCallRenderer<unknown> | undefined {
-  const exactMatches = renderToolCalls.filter(
-    (renderConfig) => renderConfig.name === toolCall.function.name,
-  );
-
-  return (
-    exactMatches.find((renderConfig) => renderConfig.agentId === agentId) ??
-    exactMatches.find((renderConfig) => !renderConfig.agentId) ??
-    exactMatches[0] ??
-    renderToolCalls.find((renderConfig) => renderConfig.name === "*")
-  );
-}
-
+/** Props for a `tool-call` / `tool-call-<name>` slot. */
 export function getToolCallRenderProps(
   toolCall: ToolCall,
   messages: Message[],
   executingToolCallIds: ReadonlySet<string>,
 ): CopilotChatToolCallRenderSlotProps {
-  const toolMessage = findToolMessage(messages, toolCall.id);
-  const parsedArgs = partialJSONParse(toolCall.function.arguments);
-
-  if (toolMessage) {
-    return {
-      name: toolCall.function.name,
-      args: parsedArgs,
-      status: ToolCallStatus.Complete,
-      result: contentToText(toolMessage.content),
-      toolCall,
-      toolMessage,
-    };
-  }
-
-  const isExecuting = executingToolCallIds.has(toolCall.id);
-  return {
-    name: toolCall.function.name,
-    args: parsedArgs,
-    status: isExecuting ? ToolCallStatus.Executing : ToolCallStatus.InProgress,
-    result: undefined,
+  const toolMessage = ɵfindToolMessage(messages, toolCall.id);
+  const { name, args, status, result } = ɵbuildToolCallRenderProps(
     toolCall,
-    toolMessage: undefined,
-  };
+    toolMessage,
+    { isExecuting: executingToolCallIds.has(toolCall.id) },
+  );
+  return { name, args, status, result, toolCall, toolMessage };
 }
 
+/** Props for a registered renderer's `render`. */
 export function getCoreRenderProps(
   toolCall: ToolCall,
   messages: Message[],
   executingToolCallIds: ReadonlySet<string>,
 ): VueToolCallRendererRenderProps<unknown> {
-  const toolMessage = findToolMessage(messages, toolCall.id);
-  const parsedArgs = partialJSONParse(toolCall.function.arguments);
-
-  if (toolMessage) {
-    return {
-      name: toolCall.function.name,
-      toolCallId: toolCall.id,
-      args: parsedArgs,
-      status: ToolCallStatus.Complete,
-      result: contentToText(toolMessage.content),
-    };
-  }
-
-  const isExecuting = executingToolCallIds.has(toolCall.id);
-  if (isExecuting) {
-    return {
-      name: toolCall.function.name,
-      toolCallId: toolCall.id,
-      args: parsedArgs,
-      status: ToolCallStatus.Executing,
-      result: undefined,
-    };
-  }
-
-  return {
-    name: toolCall.function.name,
-    toolCallId: toolCall.id,
-    args: parsedArgs && typeof parsedArgs === "object" ? parsedArgs : {},
-    status: ToolCallStatus.InProgress,
-    result: undefined,
-  };
+  return ɵbuildToolCallRenderProps(
+    toolCall,
+    ɵfindToolMessage(messages, toolCall.id),
+    { isExecuting: executingToolCallIds.has(toolCall.id) },
+  );
 }
 
 export function getToolCallMemoDeps(
   toolCall: ToolCall,
   messages: Message[],
   executingToolCallIds: ReadonlySet<string>,
-  renderToolCalls: readonly VueToolCallRenderer<unknown>[],
-  agentId: string = DEFAULT_AGENT_ID,
+  renderToolCalls: readonly VueToolCallRenderer[],
+  agentId: string = ɵresolveToolCallAgentId(undefined, undefined),
 ): unknown[] {
   return [
     toolCall.id,
     toolCall.function.name,
     toolCall.function.arguments,
-    findToolMessage(messages, toolCall.id)?.content,
+    ɵfindToolMessage(messages, toolCall.id)?.content,
     executingToolCallIds.has(toolCall.id),
-    getCoreRenderConfig(toolCall, renderToolCalls, agentId)?.render,
+    ɵresolveToolCallRenderer(renderToolCalls, toolCall.function.name, agentId)
+      ?.render,
   ];
 }

package/src/v2/components/chat/forwarded-slots.ts

@@ -0,0 +1,17 @@
+import type { Slots } from "vue";
+
+/**
+ * Returns the names of the slots that a wrapper passes on to the component it
+ * wraps: every slot in `slots` except the ones in `ownSlots`, which the
+ * wrapper renders itself.
+ *
+ * CopilotChat passes every slot except `chat-view` to CopilotChatView.
+ * CopilotSidebar, CopilotPopup, and their view components use this rule at
+ * each layer, so a slot that works on CopilotChat also works on them.
+ */
+export function forwardedSlotNames(
+  slots: Slots,
+  ownSlots: readonly string[] = [],
+): string[] {
+  return Object.keys(slots).filter((name) => !ownSlots.includes(name));
+}

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

@@ -1,5 +1,4 @@
 export * from "./types";
-export { default as BasicMarkdown } from "./BasicMarkdown.vue";
 export { default as StreamingMarkdownDefault } from "./StreamingMarkdownDefault.vue";
 export { default as CopilotChatAssistantMessage } from "./CopilotChatAssistantMessage.vue";
 export { default as CopilotChatAudioRecorder } from "./CopilotChatAudioRecorder.vue";

package/src/v2/components/chat/inspector-shortcuts.ts

@@ -1,34 +1,28 @@
+import { ɵinspectorShortcuts } from "@copilotkit/core";
 import { onBeforeUnmount, readonly, ref } from "vue";
 import type { Ref } from "vue";
 
-// Page-lifetime preference, shared by every message and chat. Deliberately
-// avoid sessionStorage: it survives reloads, while this preference must not.
-let shortcutsHidden = false;
-const listeners = new Set<() => void>();
-
 /**
  * Whether the user hid the Inspector buttons in the message toolbars ("Hide
- * this icon"), until the page reloads.
+ * this icon"), until the page reloads. Core's `ɵinspectorShortcuts` holds
+ * the page-lifetime preference.
  * @internal
  */
 export function useInspectorShortcutsHidden(): Readonly<Ref<boolean>> {
-  const hidden = ref(shortcutsHidden);
-  const listener = () => {
-    hidden.value = shortcutsHidden;
-  };
-  listeners.add(listener);
-  onBeforeUnmount(() => listeners.delete(listener));
+  const hidden = ref(ɵinspectorShortcuts.hidden);
+  const unsubscribe = ɵinspectorShortcuts.subscribe(() => {
+    hidden.value = ɵinspectorShortcuts.hidden;
+  });
+  onBeforeUnmount(unsubscribe);
   return readonly(hidden);
 }
 
 /** Hides the Inspector buttons of every message until the page reloads. */
 export function hideInspectorShortcuts(): void {
-  shortcutsHidden = true;
-  listeners.forEach((listener) => listener());
+  ɵinspectorShortcuts.hide();
 }
 
 /** @internal Shows the buttons again, so each test starts fresh. */
 export function ɵresetInspectorShortcuts(): void {
-  shortcutsHidden = false;
-  listeners.forEach((listener) => listener());
+  ɵinspectorShortcuts.reset();
 }

package/src/v2/components/chat/message-feedback.ts

@@ -1,23 +1,30 @@
 import type { AssistantMessage } from "@ag-ui/core";
 import type { CopilotKitCore } from "@copilotkit/core";
-import { computed, inject, onBeforeUnmount, ref, shallowRef, watch } from "vue";
-import type { ComputedRef, InjectionKey, Ref } from "vue";
 import {
-  getMessageFeedback,
-  setMessageFeedback,
-  subscribeToMessageFeedback,
-} from "../../lib/message-feedback";
+  ɵFeedbackCommentController,
+  ɵgetMessageFeedbackControls,
+  ɵisLearningFeedbackEnabled,
+  ɵsubscribeToLearningFeedbackEnabled,
+  ɵsubscribeToMessageFeedback,
+} from "@copilotkit/core";
+import type {
+  ɵMessageFeedbackControls,
+  ɵMessageFeedbackScope,
+} from "@copilotkit/core";
+import { computed, inject, onBeforeUnmount, ref, shallowRef, watch } from "vue";
 import type {
-  MessageFeedback,
-  MessageFeedbackRating,
-} from "../../lib/message-feedback";
+  ComputedRef,
+  InjectionKey,
+  Ref,
+  ShallowRef,
+  WritableComputedRef,
+} from "vue";
 
 /** The chat whose assistant messages collect feedback for Learning. */
-export interface MessageFeedbackScope {
-  readonly copilotkit: CopilotKitCore;
-  readonly agentId: string;
-  readonly threadId: string;
-}
+export type MessageFeedbackScope = ɵMessageFeedbackScope;
+
+/** Current feedback for one assistant message, and how to change it. */
+export type MessageFeedbackControls = ɵMessageFeedbackControls;
 
 /**
  * Provided by the message view while Learning is on for this chat. Assistant
@@ -29,68 +36,27 @@ export const MessageFeedbackScopeKey: InjectionKey<
   Ref<MessageFeedbackScope | null>
 > = Symbol("CopilotMessageFeedbackScope");
 
-// Cores that captured since Learning was configured, for chats that mount
-// while capture reconnects or is stopped. A Core leaves when its config goes.
-const capturedCores = new WeakSet<CopilotKitCore>();
-
-const rememberCapture = (copilotkit: CopilotKitCore) => {
-  if (capturedCores.has(copilotkit)) return;
-  capturedCores.add(copilotkit);
-  const unsubscribe = copilotkit.ɵsubscribeToLearningConfigured(() => {
-    if (copilotkit.ɵlearningConfigured) return;
-    capturedCores.delete(copilotkit);
-    unsubscribe();
-  });
-};
-
 /**
- * Whether the thumbs record feedback for Learning. True once a Trajectory of
- * this Core has started and as long as Learning stays configured, also while
- * capture reconnects or is stopped, so the buttons do not flicker. Ratings
- * given meanwhile still show but, like any Trajectory event, are not sent.
+ * Whether the thumbs record feedback for Learning. See core's
+ * `ɵisLearningFeedbackEnabled` for the rules.
  * @internal
  */
 export function useLearningFeedbackEnabled(
   copilotkit: Ref<CopilotKitCore>,
 ): ComputedRef<boolean> {
-  const configured = ref(false);
-  const capturing = ref(false);
-
+  const enabled = ref(false);
   watch(
     copilotkit,
     (core, _previous, onCleanup) => {
       const read = () => {
-        configured.value = core.ɵlearningConfigured;
-        capturing.value = core.trajectoryId !== null;
-        if (capturing.value) rememberCapture(core);
+        enabled.value = ɵisLearningFeedbackEnabled(core);
       };
       read();
-      const unsubscribeConfigured = core.ɵsubscribeToLearningConfigured(read);
-      const subscription = core.subscribe({ onTrajectoryChanged: read });
-      onCleanup(() => {
-        unsubscribeConfigured();
-        subscription.unsubscribe();
-      });
+      onCleanup(ɵsubscribeToLearningFeedbackEnabled(core, read));
     },
     { immediate: true },
   );
-
-  return computed(
-    () =>
-      configured.value &&
-      (capturing.value || capturedCores.has(copilotkit.value)),
-  );
-}
-
-/** Current feedback for one assistant message, and how to change it. */
-export interface MessageFeedbackControls {
-  readonly feedback: MessageFeedback | undefined;
-  /** Gives `rating`; a different rating than before starts without a comment. */
-  readonly rate: (rating: MessageFeedbackRating) => void;
-  /** Removes the rating and its comment. */
-  readonly clear: () => void;
-  /** Sets the current rating's comment; an empty one removes it. */
-  readonly comment: (comment: string) => void;
+  return computed(() => enabled.value);
 }
 
 /** Feedback controls for `message`, or `null` when this chat collects none. */
@@ -106,7 +72,7 @@ export function useMessageFeedback(
     (current, _previous, onCleanup) => {
       if (!current) return;
       onCleanup(
-        subscribeToMessageFeedback(current.agentId, current.threadId, () => {
+        ɵsubscribeToMessageFeedback(current.agentId, current.threadId, () => {
           version.value++;
         }),
       );
@@ -118,174 +84,105 @@ export function useMessageFeedback(
     const current = scope.value;
     if (!current) return null;
     void version.value;
-    const target = message.value;
-    const feedback = getMessageFeedback(
-      current.agentId,
-      current.threadId,
-      target.id,
-    );
-    const save = (next: MessageFeedback | null) =>
-      setMessageFeedback({ ...current, message: target, feedback: next });
-    return {
-      feedback,
-      rate: (rating) => {
-        if (feedback?.rating !== rating) save({ rating });
-      },
-      clear: () => {
-        if (feedback) save(null);
-      },
-      comment: (comment) => {
-        if (feedback) save({ rating: feedback.rating, comment });
-      },
-    };
+    return ɵgetMessageFeedbackControls(current, message.value);
   });
 }
 
-/**
- * How long the pointer may be away from the rating and its comment before the
- * comment closes: enough to cross the gap between them, short enough that
- * passing over a rating does not leave it open.
- */
-export const FEEDBACK_COMMENT_CLOSE_DELAY_MS = 150;
-
 /** The comment popover of one rated message: when it shows and what it holds. */
 export interface FeedbackComment {
-  readonly open: Ref<boolean>;
+  readonly open: ComputedRef<boolean>;
   /** The comment being edited. */
-  readonly draft: Ref<string>;
+  readonly draft: WritableComputedRef<string>;
   /** Grows each time the field should take focus: after a keyboard rating. */
-  readonly focusRequest: Ref<number>;
+  readonly focusRequest: ComputedRef<number>;
   /** Whether a focus request waits; reading it answers the request. */
   readonly takeFocusRequest: () => boolean;
   /** The comment field, for moving focus into it. */
-  readonly input: Ref<HTMLInputElement | null>;
+  readonly input: ShallowRef<HTMLInputElement | null>;
   /** Opens with `comment` in the field. */
-  readonly show: (options: { comment: string; focus: boolean }) => void;
+  readonly show: ɵFeedbackCommentController["show"];
   /** The pointer or focus reached the rating or the popover. */
-  readonly enter: (via?: "pointer" | "focus") => void;
+  readonly enter: ɵFeedbackCommentController["enter"];
   /**
    * It left them: close soon, unless the user is editing the comment or, when
    * focus left, the pointer is still on the rating or the popover.
    */
-  readonly leave: (via?: "pointer" | "focus") => void;
+  readonly leave: ɵFeedbackCommentController["leave"];
   /** Tracks whether focus is in the comment form. */
   readonly setEditing: (editing: boolean) => void;
   /** Closes, saving a changed comment unless `save` is false. */
-  readonly close: (options?: { save?: boolean }) => void;
+  readonly close: ɵFeedbackCommentController["close"];
   /** Moves focus back to the thumb without opening the comment again. */
   readonly returnFocus: (target: HTMLElement | null) => void;
+  /** The chosen thumb the popover points at. */
+  readonly anchor: ComputedRef<HTMLElement | null>;
+  /** A thumb click; returns whether the app's handler should run. */
+  readonly rate: ɵFeedbackCommentController["rate"];
+  /** The attributes and handlers of one thumb. */
+  readonly thumb: ɵFeedbackCommentController["thumb"];
+  /** Points at the chosen thumb when the click gave no element. */
+  readonly findAnchor: ɵFeedbackCommentController["findAnchor"];
+  /** Closes a comment whose rating changed or whose toolbar hid. */
+  readonly sync: ɵFeedbackCommentController["sync"];
+  /** Moves focus into the field when a keyboard rating asked for it. */
+  readonly focusField: ɵFeedbackCommentController["focusField"];
+  /** Saves, closes, and returns focus to the thumb. */
+  readonly submit: ɵFeedbackCommentController["submit"];
+  /** Escape in the popover; returns whether to stop the event. */
+  readonly popoverEscape: ɵFeedbackCommentController["popoverEscape"];
+  /** Tab out of the popover, back into the page's order. */
+  readonly popoverKeyDown: ɵFeedbackCommentController["popoverKeyDown"];
+  /** Focus left the comment form. */
+  readonly popoverFocusLeave: ɵFeedbackCommentController["popoverFocusLeave"];
 }
 
 /**
- * Drives the comment popover of a rated message, as React's
- * `useFeedbackComment` does.
- *
- * It opens when a rating is given and whenever the pointer or keyboard focus
- * reaches the chosen thumb, with the saved comment in the field. It closes by
- * itself shortly after the pointer leaves the thumb and the popover, unless
- * focus is in the field: then it stays until focus moves away, Enter, or
- * Escape. Closing saves a changed comment; Escape, a click on a thumb, and
- * removing the rating discard it.
+ * Drives the comment popover of a rated message with core's
+ * `ɵFeedbackCommentController`, which holds the open and close rules.
  * @internal
  */
 export function useFeedbackComment(
   controls: Ref<MessageFeedbackControls | null>,
 ): FeedbackComment {
-  const open = ref(false);
-  const draft = ref("");
-  const focusRequest = ref(0);
   const input = shallowRef<HTMLInputElement | null>(null);
-  let timer: ReturnType<typeof setTimeout> | undefined;
-  let editing = false;
-  let focusWaiting = false;
-  // Whether the pointer is on the chosen thumb or the popover. Browsers that
-  // do not focus a clicked button move focus to nothing while it stays there.
-  let pointerOver = false;
-  // Set while focus moves back to the thumb, whose focus would open it again.
-  let returning = false;
-
-  const takeFocusRequest = () => {
-    const waiting = focusWaiting;
-    focusWaiting = false;
-    return waiting;
-  };
-
-  const cancelClose = () => {
-    if (timer === undefined) return;
-    clearTimeout(timer);
-    timer = undefined;
-  };
-
-  const savedComment = () => controls.value?.feedback?.comment ?? "";
-
-  const close = ({ save = true }: { save?: boolean } = {}) => {
-    cancelClose();
-    focusWaiting = false;
-    pointerOver = false;
-    if (!open.value) return;
-    const current = controls.value;
-    if (save && current?.feedback && draft.value.trim() !== savedComment())
-      current.comment(draft.value);
-    editing = false;
-    open.value = false;
-  };
-
-  const show = ({ comment, focus }: { comment: string; focus: boolean }) => {
-    cancelClose();
-    draft.value = comment;
-    if (focus) {
-      focusWaiting = true;
-      focusRequest.value++;
-    }
-    open.value = true;
-  };
-
+  const controller = new ɵFeedbackCommentController({
+    getControls: () => controls.value,
+    getInput: () => input.value,
+  });
+  const state = shallowRef(controller.getSnapshot());
+  const unsubscribe = controller.subscribe(() => {
+    state.value = controller.getSnapshot();
+  });
   // A message that unmounts (scrolled out of a virtual list) keeps its edit.
   onBeforeUnmount(() => {
-    cancelClose();
-    const current = controls.value;
-    if (
-      open.value &&
-      current?.feedback &&
-      draft.value.trim() !== savedComment()
-    )
-      current.comment(draft.value);
+    controller.dispose();
+    unsubscribe();
   });
 
   return {
-    open,
-    draft,
-    focusRequest,
-    takeFocusRequest,
+    open: computed(() => state.value.open),
+    draft: computed({
+      get: () => state.value.draft,
+      set: controller.setDraft,
+    }),
+    focusRequest: computed(() => state.value.focusRequest),
+    takeFocusRequest: controller.takeFocusRequest,
     input,
-    show,
-    enter: (via = "focus") => {
-      cancelClose();
-      if (via === "pointer") pointerOver = true;
-      if (returning) return;
-      if (!open.value && controls.value?.feedback)
-        show({ comment: savedComment(), focus: false });
-    },
-    leave: (via = "focus") => {
-      if (via === "pointer") pointerOver = false;
-      else if (pointerOver) return;
-      cancelClose();
-      timer = setTimeout(() => {
-        timer = undefined;
-        if (!editing) close();
-      }, FEEDBACK_COMMENT_CLOSE_DELAY_MS);
-    },
-    setEditing: (value) => {
-      editing = value;
-    },
-    close,
-    returnFocus: (target) => {
-      returning = true;
-      try {
-        target?.focus();
-      } finally {
-        returning = false;
-      }
-    },
+    show: controller.show,
+    enter: controller.enter,
+    leave: controller.leave,
+    setEditing: controller.setEditing,
+    close: controller.close,
+    returnFocus: controller.returnFocus,
+    anchor: computed(() => state.value.anchor),
+    rate: controller.rate,
+    thumb: controller.thumb,
+    findAnchor: controller.findAnchor,
+    sync: controller.sync,
+    focusField: controller.focusField,
+    submit: controller.submit,
+    popoverEscape: controller.popoverEscape,
+    popoverKeyDown: controller.popoverKeyDown,
+    popoverFocusLeave: controller.popoverFocusLeave,
   };
 }

package/src/v2/components/chat/tool-call-display-context.ts

@@ -1,34 +1,16 @@
 import type { ComputedRef, InjectionKey } from "vue";
 import type {
-  CopilotChatToolCallDisplay,
-  ToolCallLayout,
-} from "./tool-call-layout";
+  ɵToolCallDisplayContextValue,
+  ɵToolCallRowStatus,
+} from "@copilotkit/core";
 
 /**
  * Provided by the message view so each message's tool calls follow the view's
  * `toolCallDisplay` without every layer passing it along.
  * @internal
  */
-export interface ToolCallDisplayContextValue {
-  display: CopilotChatToolCallDisplay;
-  isRunning: boolean;
-  /** Each assistant message's tool calls, laid out across the whole list. */
-  layouts: ReadonlyMap<string, ToolCallLayout>;
-  /**
-   * `"turn"` display: for each message in a reply's working phase, whether
-   * that work is showing. Messages not in here are the reply itself.
-   */
-  workOpen: ReadonlyMap<string, boolean>;
-  /**
-   * Like `workOpen`, for the messages' text: text that ends the reply stays
-   * out of it even when its message also calls a tool.
-   */
-  workTextOpen: ReadonlyMap<string, boolean>;
-}
-
-/** @internal */
 export const ToolCallDisplayContextKey: InjectionKey<
-  ComputedRef<ToolCallDisplayContextValue>
+  ComputedRef<ɵToolCallDisplayContextValue>
 > = Symbol("CopilotChatToolCallDisplay");
 
 /**
@@ -39,6 +21,8 @@ export const ToolCallDisplayContextKey: InjectionKey<
 export interface ToolCallGroupContextValue {
   appearance: "card" | "line" | "stack";
   failedIds: ReadonlySet<string>;
+  /** Each call's row status, by call id. */
+  statusById: ReadonlyMap<string, ɵToolCallRowStatus>;
   /** The agent may still finish the group's calls; see `isActive`. */
   active: boolean;
 }