@copilotkit/react-core 1.55.0-next.9 → 1.55.0

package/src/v2/components/chat/__tests__/copilot-chat-throttle.test.tsx

@@ -0,0 +1,138 @@
+import React from "react";
+import { render } from "@testing-library/react";
+import { describe, it, expect, vi, beforeEach, afterEach } from "vitest";
+import { CopilotChat } from "../CopilotChat";
+import { useAgent } from "../../../hooks/use-agent";
+import { useCopilotKit } from "../../../providers/CopilotKitProvider";
+import { useCopilotChatConfiguration } from "../../../providers/CopilotChatConfigurationProvider";
+import { MockStepwiseAgent } from "../../../__tests__/utils/test-helpers";
+import { CopilotKitCoreRuntimeConnectionStatus } from "@copilotkit/core";
+
+// Mock useAgent to inspect the props it receives
+vi.mock("../../../hooks/use-agent", () => ({
+  useAgent: vi.fn(() => ({
+    agent: new MockStepwiseAgent(),
+  })),
+}));
+
+vi.mock("../../../providers/CopilotKitProvider", () => ({
+  useCopilotKit: vi.fn(),
+  useLicenseContext: vi.fn(() => ({
+    checkFeature: () => true,
+  })),
+}));
+
+vi.mock(
+  "../../../providers/CopilotChatConfigurationProvider",
+  async (importOriginal) => {
+    const actual =
+      await importOriginal<
+        typeof import("../../../providers/CopilotChatConfigurationProvider")
+      >();
+    return {
+      ...actual,
+      useCopilotChatConfiguration: vi.fn(() => undefined),
+      CopilotChatConfigurationProvider: ({
+        children,
+      }: {
+        children: React.ReactNode;
+      }) => <>{children}</>,
+    };
+  },
+);
+
+// Mock suggestions hook
+vi.mock("../../../hooks/use-suggestions", () => ({
+  useSuggestions: vi.fn(() => ({ suggestions: [] })),
+}));
+
+// Mock attachments hook
+vi.mock("../../../hooks/use-attachments", () => ({
+  useAttachments: vi.fn(() => ({
+    attachments: [],
+    enabled: false,
+    dragOver: false,
+    fileInputRef: { current: null },
+    containerRef: { current: null },
+    handleFileUpload: vi.fn(),
+    handleDragOver: vi.fn(),
+    handleDragLeave: vi.fn(),
+    handleDrop: vi.fn(),
+    removeAttachment: vi.fn(),
+    consumeAttachments: vi.fn(() => []),
+  })),
+}));
+
+const mockUseAgent = useAgent as ReturnType<typeof vi.fn>;
+const mockUseCopilotKit = useCopilotKit as ReturnType<typeof vi.fn>;
+
+/** Factory for the mock return value of useCopilotKit in CopilotChat tests */
+function createMockChatContext(agent: MockStepwiseAgent) {
+  return {
+    copilotkit: {
+      getAgent: () => agent,
+      runtimeUrl: "http://localhost:3000/api/copilot",
+      runtimeConnectionStatus: CopilotKitCoreRuntimeConnectionStatus.Connected,
+      runtimeTransport: "rest",
+      headers: {},
+      agents: { [String(agent.agentId)]: agent },
+      connectAgent: vi.fn().mockResolvedValue(undefined),
+      subscribe: vi.fn(() => ({ unsubscribe: vi.fn() })),
+      audioFileTranscriptionEnabled: false,
+    },
+    executingToolCallIds: new Set(),
+  };
+}
+
+describe("CopilotChat throttleMs prop", () => {
+  let mockAgent: MockStepwiseAgent;
+
+  beforeEach(() => {
+    mockAgent = new MockStepwiseAgent();
+    mockAgent.agentId = "default";
+
+    mockUseAgent.mockReturnValue({ agent: mockAgent });
+    mockUseCopilotKit.mockReturnValue(createMockChatContext(mockAgent));
+  });
+
+  afterEach(() => {
+    vi.restoreAllMocks();
+  });
+
+  it("passes throttleMs prop to useAgent", () => {
+    render(<CopilotChat throttleMs={500} />);
+
+    expect(mockUseAgent).toHaveBeenCalledWith(
+      expect.objectContaining({
+        throttleMs: 500,
+      }),
+    );
+  });
+
+  it("passes undefined throttleMs when prop is not set", () => {
+    render(<CopilotChat />);
+
+    expect(mockUseAgent).toHaveBeenCalledWith(
+      expect.objectContaining({
+        throttleMs: undefined,
+      }),
+    );
+  });
+});
+
+describe("throttleMs type inheritance", () => {
+  it("CopilotSidebarProps includes throttleMs via CopilotChatProps", () => {
+    // Type-level assertion — if this compiles, the type includes throttleMs.
+    const sidebarProps: import("../CopilotSidebar").CopilotSidebarProps = {
+      throttleMs: 1000,
+    };
+    expect(sidebarProps.throttleMs).toBe(1000);
+  });
+
+  it("CopilotPopupProps includes throttleMs via CopilotChatProps", () => {
+    const popupProps: import("../CopilotPopup").CopilotPopupProps = {
+      throttleMs: 2000,
+    };
+    expect(popupProps.throttleMs).toBe(2000);
+  });
+});

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

@@ -77,3 +77,12 @@ export {
 export { CopilotSidebar, type CopilotSidebarProps } from "./CopilotSidebar";
 
 export { CopilotPopup, type CopilotPopupProps } from "./CopilotPopup";
+
+export { CopilotChatAttachmentQueue } from "./CopilotChatAttachmentQueue";
+export { CopilotChatAttachmentRenderer } from "./CopilotChatAttachmentRenderer";
+
+export type {
+  Attachment,
+  AttachmentsConfig,
+  AttachmentModality,
+} from "@copilotkit/shared";

package/src/v2/components/chat/scroll-element-context.ts

@@ -0,0 +1,13 @@
+import React from "react";
+
+/**
+ * Provides the scroll container element to child components that need it for
+ * virtualization. Set by CopilotChatView.ScrollView; consumed by
+ * CopilotChatMessageView to feed useVirtualizer's getScrollElement.
+ *
+ * Carries the element itself (not a ref) so that context consumers re-render
+ * reactively when the scroll container is first mounted.
+ */
+export const ScrollElementContext = React.createContext<HTMLElement | null>(
+  null,
+);