@copilotkit/react-core 0.14.0 → 0.15.0-alpha.1

package/dist/openai-assistants/utils/process-message-stream.mjs

@@ -0,0 +1,47 @@
+var __async = (__this, __arguments, generator) => {
+  return new Promise((resolve, reject) => {
+    var fulfilled = (value) => {
+      try {
+        step(generator.next(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var rejected = (value) => {
+      try {
+        step(generator.throw(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
+    step((generator = generator.apply(__this, __arguments)).next());
+  });
+};
+
+// src/openai-assistants/utils/process-message-stream.ts
+function processMessageStream(reader, processMessage) {
+  return __async(this, null, function* () {
+    const decoder = new TextDecoder();
+    let buffer = "";
+    while (true) {
+      const { done, value } = yield reader.read();
+      if (done) {
+        if (buffer.length > 0) {
+          processMessage(buffer);
+        }
+        break;
+      }
+      buffer += decoder.decode(value, { stream: true });
+      let endIndex;
+      while ((endIndex = buffer.indexOf("\n")) !== -1) {
+        processMessage(buffer.substring(0, endIndex).trim());
+        buffer = buffer.substring(endIndex + 1);
+      }
+    }
+  });
+}
+export {
+  processMessageStream
+};
+//# sourceMappingURL=process-message-stream.mjs.map

package/dist/openai-assistants/utils/process-message-stream.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/openai-assistants/utils/process-message-stream.ts"],"sourcesContent":["export async function processMessageStream(\n  reader: ReadableStreamDefaultReader<Uint8Array>,\n  processMessage: (message: string) => void | Promise<void>,\n) {\n  const decoder = new TextDecoder();\n  let buffer = \"\";\n  while (true) {\n    const { done, value } = await reader.read();\n\n    if (done) {\n      if (buffer.length > 0) {\n        processMessage(buffer);\n      }\n      break;\n    }\n\n    buffer += decoder.decode(value, { stream: true });\n\n    let endIndex: number;\n    while ((endIndex = buffer.indexOf(\"\\n\")) !== -1) {\n      processMessage(buffer.substring(0, endIndex).trim());\n      buffer = buffer.substring(endIndex + 1); // Remove the processed instruction + delimiter\n    }\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,SAAsB,qBACpB,QACA,gBACA;AAAA;AACA,UAAM,UAAU,IAAI,YAAY;AAChC,QAAI,SAAS;AACb,WAAO,MAAM;AACX,YAAM,EAAE,MAAM,MAAM,IAAI,MAAM,OAAO,KAAK;AAE1C,UAAI,MAAM;AACR,YAAI,OAAO,SAAS,GAAG;AACrB,yBAAe,MAAM;AAAA,QACvB;AACA;AAAA,MACF;AAEA,gBAAU,QAAQ,OAAO,OAAO,EAAE,QAAQ,KAAK,CAAC;AAEhD,UAAI;AACJ,cAAQ,WAAW,OAAO,QAAQ,IAAI,OAAO,IAAI;AAC/C,uBAAe,OAAO,UAAU,GAAG,QAAQ,EAAE,KAAK,CAAC;AACnD,iBAAS,OAAO,UAAU,WAAW,CAAC;AAAA,MACxC;AAAA,IACF;AAAA,EACF;AAAA;","names":[]}

package/dist/types/annotated-function.mjs

@@ -1,3 +1 @@
-
-//# sourceMappingURL=out.js.map
 //# sourceMappingURL=annotated-function.mjs.map

package/dist/types/annotated-function.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"names":[],"mappings":""}
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/types/document-pointer.mjs

@@ -1,3 +1 @@
-
-//# sourceMappingURL=out.js.map
 //# sourceMappingURL=document-pointer.mjs.map

package/dist/types/document-pointer.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"names":[],"mappings":""}
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/types/index.mjs

@@ -1,3 +1 @@
-import '../chunk-EFZPSZWO.mjs';
-//# sourceMappingURL=out.js.map
 //# sourceMappingURL=index.mjs.map

package/dist/types/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"names":[],"mappings":""}
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/utils/utils.d.ts

@@ -1 +1,2 @@
 
+export { }

package/dist/utils/utils.mjs

@@ -1,3 +1 @@
-
-//# sourceMappingURL=out.js.map
 //# sourceMappingURL=utils.mjs.map

package/dist/utils/utils.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"names":[],"mappings":""}
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/utils/utils.test.d.ts

@@ -1 +1,2 @@
 
+export { }

package/dist/utils/utils.test.mjs

@@ -4,5 +4,4 @@ describe("emptyTest", () => {
     expect(true).toBeTruthy();
   });
 });
-//# sourceMappingURL=out.js.map
 //# sourceMappingURL=utils.test.mjs.map

package/dist/utils/utils.test.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/utils/utils.test.ts"],"names":[],"mappings":";AAEA,SAAS,aAAa,MAAM;AAC1B,KAAG,oBAAoB,MAAM;AAC3B,WAAO,IAAI,EAAE,WAAW;AAAA,EAC1B,CAAC;AACH,CAAC","sourcesContent":["import * as utils from \"./utils\";\n\ndescribe(\"emptyTest\", () => {\n  it(\"should be truthy\", () => {\n    expect(true).toBeTruthy();\n  });\n});\n"]}
+{"version":3,"sources":["../../src/utils/utils.test.ts"],"sourcesContent":["import * as utils from \"./utils\";\n\ndescribe(\"emptyTest\", () => {\n  it(\"should be truthy\", () => {\n    expect(true).toBeTruthy();\n  });\n});\n"],"mappings":";AAEA,SAAS,aAAa,MAAM;AAC1B,KAAG,oBAAoB,MAAM;AAC3B,WAAO,IAAI,EAAE,WAAW;AAAA,EAC1B,CAAC;AACH,CAAC;","names":[]}

package/package.json

@@ -4,7 +4,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.14.0",
+  "version": "0.15.0-alpha.1",
   "sideEffects": false,
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -21,15 +21,16 @@
     "jest": "^29.6.4",
     "react": "^18.2.0",
     "ts-jest": "^29.1.1",
-    "tsup": "^6.5.0",
-    "typescript": "^4.9.4",
-    "eslint-config-custom": "0.2.0",
-    "tsconfig": "0.5.0"
+    "tsup": "^6.7.0",
+    "typescript": "^5.1.3",
+    "tsconfig": "0.6.0-alpha.1",
+    "eslint-config-custom": "0.2.0"
   },
   "dependencies": {
-    "ai": "^2.2.12",
+    "ai": "^2.2.23",
     "nanoid": "^4.0.2",
-    "openai": "^4.6.0"
+    "openai": "^4.6.0",
+    "@copilotkit/shared": "0.1.0-alpha.1"
   },
   "scripts": {
     "build": "tsup --treeshake",

package/src/components/copilot-provider/copilot-provider-props.tsx

@@ -0,0 +1,50 @@
+"use client";
+import { ReactNode } from "react";
+import { CopilotApiConfig } from "../../context/copilot-context";
+
+/**
+ * Props for the CopilotProvider when using a chat API endpoint.
+ */
+
+export interface CopilotProviderApiEndpointProps {
+  /**
+   * The endpoint for the chat API.
+   */
+  chatApiEndpoint: string;
+
+  /**
+   * The endpoint for the chat API v2.
+   * If not provided, defaults to chatApiEndpoint + "/v2".
+   * This is used for the chat API v2.
+   * If you are not using the chat API v2, you can ignore this.
+   * @default chatApiEndpoint + "/v2"
+   * @optional
+   */
+  chatApiEndpointV2?: string;
+
+  /**
+   * The children to be rendered within the CopilotProvider.
+   */
+  children: ReactNode;
+}
+/**
+ * Props for the CopilotProvider when using a CopilotApiConfig.
+ */
+
+export interface CopilotProviderApiConfigProps {
+  /**
+   * The configuration for the Copilot API.
+   */
+  chatApiConfig: CopilotApiConfig;
+
+  /**
+   * The children to be rendered within the CopilotProvider.
+   */
+  children: ReactNode;
+}
+/**
+ * Props for the CopilotProvider component.
+ * Can be either CopilotProviderApiEndpointProps or CopilotProviderApiConfigProps.
+ */
+
+export type CopilotProviderProps = CopilotProviderApiEndpointProps | CopilotProviderApiConfigProps;

package/src/components/{copilot-provider.tsx → copilot-provider/copilot-provider.tsx}

@@ -1,24 +1,52 @@
 "use client";
+
 import { FunctionCallHandler } from "ai";
-import { ReactNode, useCallback, useState } from "react";
-import { CopilotContext, CopilotApiConfig } from "../context/copilot-context";
-import useTree from "../hooks/use-tree";
-import { AnnotatedFunction } from "../types/annotated-function";
+import { useCallback, useState } from "react";
+import { CopilotContext, CopilotApiConfig } from "../../context/copilot-context";
+import useTree from "../../hooks/use-tree";
+import { AnnotatedFunction } from "../../types/annotated-function";
 import { ChatCompletionCreateParams } from "openai/resources/chat";
-import { DocumentPointer } from "../types";
-import useFlatCategoryStore from "../hooks/use-flat-category-store";
-
-export function CopilotProvider({
-  chatApiEndpoint,
-  headers,
-  body,
-  children,
-}: {
-  chatApiEndpoint: string;
-  headers?: Record<string, string>;
-  body?: Record<string, any>;
-  children: ReactNode;
-}): JSX.Element {
+import { DocumentPointer } from "../../types";
+import useFlatCategoryStore from "../../hooks/use-flat-category-store";
+import { StandardCopilotApiConfig } from "./standard-cpilot-api-config";
+import { CopilotProviderProps } from "./copilot-provider-props";
+
+/**
+ * The CopilotProvider component.
+ * This component provides the Copilot context to its children.
+ * It can be configured either with a chat API endpoint or a CopilotApiConfig.
+ *
+ * Example usage:
+ * ```
+ * <CopilotProvider chatApiEndpoint="https://api.copilot.chat">
+ *    <App />
+ * </CopilotProvider>
+ * ```
+ *
+ * or
+ *
+ * ```
+ * const copilotApiConfig = new StandardCopilotApiConfig(
+ *  "https://api.copilot.chat",
+ *  "https://api.copilot.chat/v2",
+ *  {},
+ *  {}
+ *  );
+ *
+ * // ...
+ *
+ * <CopilotProvider chatApiConfig={copilotApiConfig}>
+ *    <App />
+ * </CopilotProvider>
+ * ```
+ *
+ * @param props - The props for the component.
+ * @returns The CopilotProvider component.
+ */
+export function CopilotProvider({ children, ...props }: CopilotProviderProps): JSX.Element {
+  // Compute all the functions and properties that we need to pass
+  // to the CopilotContext.
+
   const [entryPoints, setEntryPoints] = useState<Record<string, AnnotatedFunction<any[]>>>({});
 
   const { addElement, removeElement, printTree } = useTree();
@@ -107,6 +135,19 @@ export function CopilotProvider({
     [removeDocument],
   );
 
+  // get the appropriate CopilotApiConfig from the props
+  let copilotApiConfig: CopilotApiConfig;
+  if ("chatApiEndpoint" in props) {
+    copilotApiConfig = new StandardCopilotApiConfig(
+      props.chatApiEndpoint,
+      props.chatApiEndpointV2 || `${props.chatApiEndpoint}/v2`,
+      {},
+      {},
+    );
+  } else {
+    copilotApiConfig = props.chatApiConfig;
+  }
+
   return (
     <CopilotContext.Provider
       value={{
@@ -121,11 +162,7 @@ export function CopilotProvider({
         getDocumentsContext,
         addDocumentContext,
         removeDocumentContext,
-        copilotApiConfig: {
-          chatApiEndpoint,
-          headers: headers || {},
-          body: body || {},
-        },
+        copilotApiConfig: copilotApiConfig,
       }}
     >
       {children}

package/src/components/copilot-provider/index.ts

@@ -0,0 +1,7 @@
+export { CopilotProvider, defaultCopilotContextCategories } from "./copilot-provider";
+
+export type {
+  CopilotProviderApiEndpointProps,
+  CopilotProviderApiConfigProps,
+  CopilotProviderProps,
+} from "./copilot-provider-props";

package/src/components/copilot-provider/standard-cpilot-api-config.tsx

@@ -0,0 +1,28 @@
+import { CopilotApiConfig } from "../../context/copilot-context";
+
+/**
+ * A standard implementation of the CopilotApiConfig interface.
+ *
+ * Pass in the base URL of the chat API, the headers to be sent with each request, and the body to be sent with each request.
+ * The rest of the CopilotApiConfig interface is implemented by default.
+ *
+ */
+
+export class StandardCopilotApiConfig implements CopilotApiConfig {
+  chatApiEndpoint: string;
+  chatApiEndpointV2: string;
+  headers: Record<string, string>;
+  body: Record<string, any>;
+
+  constructor(
+    chatApiEndpoint: string,
+    chatApiEndpointV2: string,
+    headers: Record<string, string>,
+    body: Record<string, any>,
+  ) {
+    this.chatApiEndpoint = chatApiEndpoint;
+    this.chatApiEndpointV2 = chatApiEndpointV2;
+    this.headers = headers;
+    this.body = body;
+  }
+}

package/src/components/index.ts

@@ -1 +1 @@
-export { CopilotProvider, defaultCopilotContextCategories } from "./copilot-provider";
+export * from "./copilot-provider";

package/src/context/copilot-context.tsx

@@ -16,6 +16,11 @@ export interface CopilotApiConfig {
    */
   chatApiEndpoint: string;
 
+  /**
+   * The endpoint for the chat API v2.
+   */
+  chatApiEndpointV2: string;
+
   /**
    * additional headers to be sent with the request
    * @default {}
@@ -46,6 +51,9 @@ export function copilotApiConfigExtrapolator(config: CopilotApiConfig) {
     get chatApiEndpoint(): string {
       return `${config.chatApiEndpoint}`;
     },
+    get chatApiEndpointV2(): string {
+      return `${config.chatApiEndpointV2}`;
+    },
   };
 }
 
@@ -93,6 +101,11 @@ const emptyCopilotContext: CopilotContextParams = {
         "Remember to wrap your app in a `<CopilotProvider> {...} </CopilotProvider>` !!!",
       );
     }
+    get chatApiEndpointV2(): string {
+      throw new Error(
+        "Remember to wrap your app in a `<CopilotProvider> {...} </CopilotProvider>` !!!",
+      );
+    }
     get headers(): Record<string, string> {
       return {};
     }

package/src/hooks/use-copilot-chat.ts

@@ -63,7 +63,7 @@ export function useCopilotChat({
     headers: { ...copilotApiConfig.headers, ...options.headers },
     body: {
       id: options.id,
-      functions: functionDescriptions,
+      functions: functionDescriptions.length > 0 ? functionDescriptions : undefined,
       ...copilotApiConfig.body,
       ...options.body,
     },

package/src/index.tsx

@@ -2,3 +2,4 @@ export * from "./components";
 export * from "./context";
 export * from "./hooks";
 export * from "./types";
+export * from "./openai-assistants";

package/src/openai-assistants/hooks/index.ts

@@ -0,0 +1,9 @@
+// export type { AssistantStatus } from "./use-assistants";
+// export { experimental_useAssistant } from "./use-assistants";
+export type {
+  AssistantStatus,
+  RequestForwardingOptions,
+  UseCopilotChatOptionsV2,
+  UseCopilotChatV2Result,
+} from "./use-copilot-chat-v2";
+export { useCopilotChatV2 } from "./use-copilot-chat-v2";

package/src/openai-assistants/hooks/use-assistants.ts

@@ -0,0 +1,114 @@
+"use client";
+
+import { useState } from "react";
+import { processMessageStream } from "../utils";
+import { Message, parseStreamPart } from "@copilotkit/shared";
+
+export type AssistantStatus = "in_progress" | "awaiting_message";
+
+export interface UseAssistantResult {
+  messages: Message[];
+  input: string;
+  handleInputChange: (e: any) => void;
+  submitMessage: (e: any) => Promise<void>;
+  status: AssistantStatus;
+  error: unknown;
+}
+
+export function experimental_useAssistant({
+  api,
+  threadId: threadIdParam,
+}: {
+  api: string;
+  threadId?: string | undefined;
+}): UseAssistantResult {
+  const [messages, setMessages] = useState<Message[]>([]);
+  const [input, setInput] = useState("");
+  const [threadId, setThreadId] = useState<string | undefined>(undefined);
+  const [status, setStatus] = useState<AssistantStatus>("awaiting_message");
+  const [error, setError] = useState<unknown | undefined>(undefined);
+
+  const handleInputChange = (e: any) => {
+    setInput(e.target.value);
+  };
+
+  const submitMessage = async (e: any) => {
+    e.preventDefault();
+
+    if (input === "") {
+      return;
+    }
+
+    setStatus("in_progress");
+
+    setMessages((messages) => [...messages, { id: "", role: "user", content: input }]);
+
+    setInput("");
+
+    const result = await fetch(api, {
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      body: JSON.stringify({
+        // always use user-provided threadId when available:
+        threadId: threadIdParam ?? threadId ?? null,
+        message: input,
+      }),
+    });
+
+    if (result.body == null) {
+      throw new Error("The response body is empty.");
+    }
+
+    await processMessageStream(result.body.getReader(), (message: string) => {
+      try {
+        const { type, value } = parseStreamPart(message);
+
+        switch (type) {
+          case "assistant_message": {
+            // append message:
+            setMessages((messages) => [
+              ...messages,
+              {
+                id: value.id,
+                role: value.role,
+                content: value.content[0].text.value,
+              },
+            ]);
+            break;
+          }
+
+          case "assistant_control_data": {
+            setThreadId(value.threadId);
+
+            // set id of last message:
+            setMessages((messages) => {
+              const lastMessage = messages[messages.length - 1];
+              lastMessage.id = value.messageId;
+              return [...messages.slice(0, messages.length - 1), lastMessage];
+            });
+
+            break;
+          }
+
+          case "error": {
+            setError(value);
+            break;
+          }
+        }
+      } catch (error) {
+        setError(error);
+      }
+    });
+
+    setStatus("awaiting_message");
+  };
+
+  return {
+    messages,
+    input,
+    handleInputChange,
+    submitMessage,
+    status,
+    error,
+  };
+}