@copilotkit/react-core 0.25.0 → 0.36.0-mme-pre.1

package/dist/utils/index.js

@@ -0,0 +1,267 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getOwnPropSymbols = Object.getOwnPropertySymbols;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __propIsEnum = Object.prototype.propertyIsEnumerable;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __spreadValues = (a, b) => {
+  for (var prop in b || (b = {}))
+    if (__hasOwnProp.call(b, prop))
+      __defNormalProp(a, prop, b[prop]);
+  if (__getOwnPropSymbols)
+    for (var prop of __getOwnPropSymbols(b)) {
+      if (__propIsEnum.call(b, prop))
+        __defNormalProp(a, prop, b[prop]);
+    }
+  return a;
+};
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+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/utils/index.ts
+var utils_exports = {};
+__export(utils_exports, {
+  extract: () => extract,
+  fetchAndDecodeChatCompletion: () => fetchAndDecodeChatCompletion,
+  fetchAndDecodeChatCompletionAsText: () => fetchAndDecodeChatCompletionAsText,
+  fetchChatCompletion: () => fetchChatCompletion
+});
+module.exports = __toCommonJS(utils_exports);
+
+// src/utils/fetch-chat-completion.ts
+var import_shared = require("@copilotkit/shared");
+function fetchChatCompletion(_0) {
+  return __async(this, arguments, function* ({
+    copilotConfig,
+    model,
+    messages,
+    tools,
+    temperature,
+    headers,
+    body,
+    signal,
+    toolChoice
+  }) {
+    temperature || (temperature = 0.5);
+    tools || (tools = []);
+    const cleanedMessages = messages.map((message) => {
+      const { content, role, name, function_call } = message;
+      return { content, role, name, function_call };
+    });
+    toolChoice || (toolChoice = "auto");
+    const response = yield fetch(copilotConfig.chatApiEndpoint, {
+      method: "POST",
+      headers: __spreadValues(__spreadValues({
+        "Content-Type": "application/json"
+      }, copilotConfig.headers), headers ? __spreadValues({}, headers) : {}),
+      body: JSON.stringify(__spreadValues(__spreadValues(__spreadValues(__spreadValues(__spreadValues(__spreadValues(__spreadValues(__spreadValues({
+        model,
+        messages: cleanedMessages,
+        stream: true
+      }, tools.length ? { tools } : {}), temperature ? { temperature } : {}), tools.length != 0 ? { tool_choice: toolChoice } : {}), copilotConfig.body), copilotConfig.backendOnlyProps), excludeBackendOnlyProps(copilotConfig)), body ? __spreadValues({}, body) : {}), copilotConfig.cloud ? { cloud: copilotConfig.cloud } : {})),
+      signal
+    });
+    return response;
+  });
+}
+function excludeBackendOnlyProps(copilotConfig) {
+  var _a;
+  const backendOnlyProps = (_a = copilotConfig.backendOnlyProps) != null ? _a : {};
+  if (Object.keys(backendOnlyProps).length > 0) {
+    return {
+      [import_shared.EXCLUDE_FROM_FORWARD_PROPS_KEYS]: Object.keys(backendOnlyProps)
+    };
+  } else {
+    return {};
+  }
+}
+function fetchAndDecodeChatCompletion(params) {
+  return __async(this, null, function* () {
+    const response = yield fetchChatCompletion(params);
+    if (!response.ok || !response.body) {
+      response.events = null;
+    } else {
+      const events = yield (0, import_shared.decodeChatCompletion)((0, import_shared.parseChatCompletion)(response.body));
+      response.events = events;
+    }
+    return response;
+  });
+}
+function fetchAndDecodeChatCompletionAsText(params) {
+  return __async(this, null, function* () {
+    const response = yield fetchChatCompletion(params);
+    if (!response.ok || !response.body) {
+      response.events = null;
+    } else {
+      const events = yield (0, import_shared.decodeChatCompletionAsText)(
+        (0, import_shared.decodeChatCompletion)((0, import_shared.parseChatCompletion)(response.body))
+      );
+      response.events = events;
+    }
+    return response;
+  });
+}
+
+// src/utils/extract.ts
+var import_shared3 = require("@copilotkit/shared");
+
+// src/components/copilot-provider/copilotkit.tsx
+var import_react = require("react");
+var import_shared2 = require("@copilotkit/shared");
+var import_jsx_runtime = require("react/jsx-runtime");
+var defaultCopilotContextCategories = ["global"];
+
+// src/utils/extract.ts
+var import_untruncate_json = __toESM(require("untruncate-json"));
+function extract(_0) {
+  return __async(this, arguments, function* ({
+    context,
+    instructions,
+    parameters,
+    include,
+    data,
+    abortSignal,
+    stream
+  }) {
+    var _a, _b;
+    const { messages } = context;
+    const action = {
+      name: "extract",
+      parameters,
+      handler: (args) => {
+      }
+    };
+    const includeReadable = (_a = include == null ? void 0 : include.readable) != null ? _a : false;
+    const includeMessages = (_b = include == null ? void 0 : include.messages) != null ? _b : false;
+    let contextString = "";
+    if (data) {
+      contextString = (typeof data === "string" ? data : JSON.stringify(data)) + "\n\n";
+    }
+    if (includeReadable) {
+      contextString += context.getContextString([], defaultCopilotContextCategories);
+    }
+    const systemMessage = {
+      id: "system",
+      content: makeSystemMessage(contextString, instructions),
+      role: "system"
+    };
+    const headers = __spreadValues(__spreadValues({}, context.copilotApiConfig.headers || {}), context.copilotApiConfig.publicApiKey ? { [import_shared3.COPILOT_CLOUD_PUBLIC_API_KEY_HEADER]: context.copilotApiConfig.publicApiKey } : {});
+    const response = yield fetchAndDecodeChatCompletion({
+      copilotConfig: context.copilotApiConfig,
+      messages: includeMessages ? [systemMessage, ...messages] : [systemMessage],
+      tools: context.getChatCompletionFunctionDescriptions({ extract: action }),
+      headers,
+      body: context.copilotApiConfig.body,
+      toolChoice: { type: "function", function: { name: "extract" } },
+      signal: abortSignal
+    });
+    if (!response.events) {
+      throw new Error("extract() failed: Could not fetch chat completion");
+    }
+    const reader = response.events.getReader();
+    let isInitial = true;
+    while (true) {
+      const { done, value } = yield reader.read();
+      if (done) {
+        break;
+      }
+      if (value.type === "partial") {
+        try {
+          let partialArguments = JSON.parse((0, import_untruncate_json.default)(value.arguments));
+          stream == null ? void 0 : stream({
+            status: isInitial ? "initial" : "inProgress",
+            args: partialArguments
+          });
+          isInitial = false;
+        } catch (e) {
+        }
+      }
+      if (value.type === "function") {
+        stream == null ? void 0 : stream({
+          status: "complete",
+          args: value.arguments
+        });
+        return value.arguments;
+      }
+    }
+    throw new Error("extract() failed: No function call occurred");
+  });
+}
+function makeSystemMessage(contextString, instructions) {
+  return `
+Please act as an efficient, competent, conscientious, and industrious professional assistant.
+
+Help the user achieve their goals, and you do so in a way that is as efficient as possible, without unnecessary fluff, but also without sacrificing professionalism.
+Always be polite and respectful, and prefer brevity over verbosity.
+
+The user has provided you with the following context:
+\`\`\`
+${contextString}
+\`\`\`
+
+They have also provided you with a function you MUST call to initiate actions on their behalf.
+
+Please assist them as best you can.
+
+This is not a conversation, so please do not ask questions. Just call the function without saying anything else.
+
+The user has given you the following task to complete:
+
+\`\`\`
+${instructions}
+\`\`\`
+
+Any additional messages provided are for providing context only and should not be used to ask questions or engage in conversation.
+`;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  extract,
+  fetchAndDecodeChatCompletion,
+  fetchAndDecodeChatCompletionAsText,
+  fetchChatCompletion
+});
+//# sourceMappingURL=index.js.map

package/dist/utils/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/utils/index.ts","../../src/utils/fetch-chat-completion.ts","../../src/utils/extract.ts","../../src/components/copilot-provider/copilotkit.tsx"],"sourcesContent":["export {\n  type FetchChatCompletionParams,\n  fetchChatCompletion,\n  fetchAndDecodeChatCompletion,\n  fetchAndDecodeChatCompletionAsText,\n} from \"./fetch-chat-completion\";\n\nexport { extract } from \"./extract\";\n","import {\n  Message,\n  ToolDefinition,\n  ChatCompletionEvent,\n  decodeChatCompletion,\n  parseChatCompletion,\n  decodeChatCompletionAsText,\n  EXCLUDE_FROM_FORWARD_PROPS_KEYS,\n} from \"@copilotkit/shared\";\nimport { CopilotApiConfig } from \"../context\";\n\nexport interface FetchChatCompletionParams {\n  copilotConfig: CopilotApiConfig;\n  model?: string;\n  messages: Message[];\n  tools?: ToolDefinition[];\n  temperature?: number;\n  maxTokens?: number;\n  headers?: Record<string, string> | Headers;\n  body?: object;\n  signal?: AbortSignal;\n  toolChoice?: string | { type: \"function\"; function: { name: string } };\n}\n\nexport async function fetchChatCompletion({\n  copilotConfig,\n  model,\n  messages,\n  tools,\n  temperature,\n  headers,\n  body,\n  signal,\n  toolChoice,\n}: FetchChatCompletionParams): Promise<Response> {\n  temperature ||= 0.5;\n  tools ||= [];\n\n  // clean up any extra properties from messages\n  const cleanedMessages = messages.map((message) => {\n    const { content, role, name, function_call } = message;\n    return { content, role, name, function_call };\n  });\n\n  toolChoice ||= \"auto\";\n\n  const response = await fetch(copilotConfig.chatApiEndpoint, {\n    method: \"POST\",\n    headers: {\n      \"Content-Type\": \"application/json\",\n      ...copilotConfig.headers,\n      ...(headers ? { ...headers } : {}),\n    },\n    body: JSON.stringify({\n      model,\n      messages: cleanedMessages,\n      stream: true,\n      ...(tools.length ? { tools } : {}),\n      ...(temperature ? { temperature } : {}),\n      ...(tools.length != 0 ? { tool_choice: toolChoice } : {}),\n      ...copilotConfig.body,\n      ...copilotConfig.backendOnlyProps,\n      ...excludeBackendOnlyProps(copilotConfig),\n      ...(body ? { ...body } : {}),\n      ...(copilotConfig.cloud ? { cloud: copilotConfig.cloud } : {}),\n    }),\n    signal,\n  });\n\n  return response;\n}\n\nfunction excludeBackendOnlyProps(copilotConfig: any) {\n  const backendOnlyProps = copilotConfig.backendOnlyProps ?? {};\n  if (Object.keys(backendOnlyProps).length > 0) {\n    return {\n      [EXCLUDE_FROM_FORWARD_PROPS_KEYS]: Object.keys(backendOnlyProps),\n    };\n  } else {\n    return {};\n  }\n}\n\nexport interface DecodedChatCompletionResponse extends Response {\n  events: ReadableStream<ChatCompletionEvent> | null;\n}\n\nexport async function fetchAndDecodeChatCompletion(\n  params: FetchChatCompletionParams,\n): Promise<DecodedChatCompletionResponse> {\n  const response = await fetchChatCompletion(params);\n  if (!response.ok || !response.body) {\n    (response as any).events = null;\n  } else {\n    const events = await decodeChatCompletion(parseChatCompletion(response.body));\n    (response as any).events = events;\n  }\n  return response as any;\n}\n\nexport interface DecodedChatCompletionResponseAsText extends Response {\n  events: ReadableStream<string> | null;\n}\n\nexport async function fetchAndDecodeChatCompletionAsText(\n  params: FetchChatCompletionParams,\n): Promise<DecodedChatCompletionResponseAsText> {\n  const response = await fetchChatCompletion(params);\n  if (!response.ok || !response.body) {\n    (response as any).events = null;\n  } else {\n    const events = await decodeChatCompletionAsText(\n      decodeChatCompletion(parseChatCompletion(response.body)),\n    );\n    (response as any).events = events;\n  }\n\n  return response as any;\n}\n","import {\n  Action,\n  COPILOT_CLOUD_PUBLIC_API_KEY_HEADER,\n  MappedParameterTypes,\n  Message,\n  Parameter,\n} from \"@copilotkit/shared\";\nimport { CopilotContextParams } from \"../context\";\nimport { defaultCopilotContextCategories } from \"../components\";\nimport { fetchAndDecodeChatCompletion } from \"./fetch-chat-completion\";\nimport untruncateJson from \"untruncate-json\";\n\ninterface InitialState<T extends Parameter[] | [] = []> {\n  status: \"initial\";\n  args: Partial<MappedParameterTypes<T>>;\n}\n\ninterface InProgressState<T extends Parameter[] | [] = []> {\n  status: \"inProgress\";\n  args: Partial<MappedParameterTypes<T>>;\n}\n\ninterface CompleteState<T extends Parameter[] | [] = []> {\n  status: \"complete\";\n  args: MappedParameterTypes<T>;\n}\n\ntype StreamHandlerArgs<T extends Parameter[] | [] = []> =\n  | InitialState<T>\n  | InProgressState<T>\n  | CompleteState<T>;\n\ninterface ExtractOptions<T extends Parameter[]> {\n  context: CopilotContextParams;\n  instructions: string;\n  parameters: T;\n  include?: IncludeOptions;\n  data?: any;\n  abortSignal?: AbortSignal;\n  stream?: (args: StreamHandlerArgs<T>) => void;\n}\n\ninterface IncludeOptions {\n  readable?: boolean;\n  messages?: boolean;\n}\n\nexport async function extract<const T extends Parameter[]>({\n  context,\n  instructions,\n  parameters,\n  include,\n  data,\n  abortSignal,\n  stream,\n}: ExtractOptions<T>): Promise<MappedParameterTypes<T>> {\n  const { messages } = context;\n\n  const action: Action<any> = {\n    name: \"extract\",\n    parameters,\n    handler: (args: any) => {},\n  };\n\n  const includeReadable = include?.readable ?? false;\n  const includeMessages = include?.messages ?? false;\n\n  let contextString = \"\";\n\n  if (data) {\n    contextString = (typeof data === \"string\" ? data : JSON.stringify(data)) + \"\\n\\n\";\n  }\n\n  if (includeReadable) {\n    contextString += context.getContextString([], defaultCopilotContextCategories);\n  }\n\n  const systemMessage: Message = {\n    id: \"system\",\n    content: makeSystemMessage(contextString, instructions),\n    role: \"system\",\n  };\n\n  const headers = {\n    ...(context.copilotApiConfig.headers || {}),\n    ...(context.copilotApiConfig.publicApiKey\n      ? { [COPILOT_CLOUD_PUBLIC_API_KEY_HEADER]: context.copilotApiConfig.publicApiKey }\n      : {}),\n  };\n\n  const response = await fetchAndDecodeChatCompletion({\n    copilotConfig: context.copilotApiConfig,\n    messages: includeMessages ? [systemMessage, ...messages] : [systemMessage],\n    tools: context.getChatCompletionFunctionDescriptions({ extract: action }),\n    headers,\n    body: context.copilotApiConfig.body,\n    toolChoice: { type: \"function\", function: { name: \"extract\" } },\n    signal: abortSignal,\n  });\n\n  if (!response.events) {\n    throw new Error(\"extract() failed: Could not fetch chat completion\");\n  }\n\n  const reader = response.events.getReader();\n  let isInitial = true;\n\n  while (true) {\n    const { done, value } = await reader.read();\n\n    if (done) {\n      break;\n    }\n\n    if (value.type === \"partial\") {\n      try {\n        let partialArguments = JSON.parse(untruncateJson(value.arguments));\n        stream?.({\n          status: isInitial ? \"initial\" : \"inProgress\",\n          args: partialArguments as Partial<MappedParameterTypes<T>>,\n        });\n        isInitial = false;\n      } catch (e) {}\n    }\n\n    if (value.type === \"function\") {\n      stream?.({\n        status: \"complete\",\n        args: value.arguments as MappedParameterTypes<T>,\n      });\n      return value.arguments as MappedParameterTypes<T>;\n    }\n  }\n\n  throw new Error(\"extract() failed: No function call occurred\");\n}\n\nfunction makeSystemMessage(contextString: string, instructions: string): string {\n  return `\nPlease act as an efficient, competent, conscientious, and industrious professional assistant.\n\nHelp the user achieve their goals, and you do so in a way that is as efficient as possible, without unnecessary fluff, but also without sacrificing professionalism.\nAlways be polite and respectful, and prefer brevity over verbosity.\n\nThe user has provided you with the following context:\n\\`\\`\\`\n${contextString}\n\\`\\`\\`\n\nThey have also provided you with a function you MUST call to initiate actions on their behalf.\n\nPlease assist them as best you can.\n\nThis is not a conversation, so please do not ask questions. Just call the function without saying anything else.\n\nThe user has given you the following task to complete:\n\n\\`\\`\\`\n${instructions}\n\\`\\`\\`\n\nAny additional messages provided are for providing context only and should not be used to ask questions or engage in conversation.\n`;\n}\n","/**\n * Provides the Copilot context to its children.\n * \n * <img\n *   referrerPolicy=\"no-referrer-when-downgrade\"\n *   src=\"https://static.scarf.sh/a.png?x-pxid=a9b290bb-38f9-4518-ac3b-8f54fdbf43be\"\n * />\n * \n * This component provides the Copilot context to its children.\n * It can be configured either with a chat API endpoint or a `CopilotApiConfig`.\n * \n * <Note>\n *   The backend can use OpenAI, or you can bring your own LLM. For examples of the\n *   backend api implementation, see `examples/next-openai` or the [runtime\n *   docs](https://docs.copilotkit.ai/getting-started/quickstart-runtime).\n * </Note>\n * \n * <RequestExample>\n *   ```jsx CopilotKit Example\n *   import { CopilotKit } from \"@copilotkit/react-core\";\n * \n *   <CopilotKit \n *     runtimeUrl=\"https://your.copilotkit.api\">\n *     <YourApp/>\n *   </CopilotKit>\n *   ```\n * </RequestExample>\n * \n * ## Example usage\n * \n * ```jsx\n * <CopilotKit publicApiKey=\"the api key or self host (see below)\">\n *   <App />\n * </CopilotKit>\n```\n */\nimport { Ref, useCallback, useRef, useState } from \"react\";\nimport {\n  CopilotContext,\n  CopilotApiConfig,\n  InChatRenderFunction,\n} from \"../../context/copilot-context\";\nimport useTree from \"../../hooks/use-tree\";\nimport { CopilotChatSuggestionConfiguration, DocumentPointer } from \"../../types\";\n\nimport {\n  COPILOT_CLOUD_CHAT_URL,\n  CopilotCloudConfig,\n  FunctionCallHandler,\n  Message,\n  actionToChatCompletionFunction,\n} from \"@copilotkit/shared\";\n\nimport { FrontendAction } from \"../../types/frontend-action\";\nimport useFlatCategoryStore from \"../../hooks/use-flat-category-store\";\nimport { CopilotKitProps } from \"./copilotkit-props\";\nimport { ToolDefinition } from \"@copilotkit/shared\";\n\nexport function CopilotKit({ children, ...props }: CopilotKitProps) {\n  // Compute all the functions and properties that we need to pass\n  // to the CopilotContext.\n\n  if (!props.runtimeUrl && !props.url && !props.publicApiKey) {\n    throw new Error(\"Please provide either a url or a publicApiKey to the CopilotKit component.\");\n  }\n\n  const chatApiEndpoint = props.runtimeUrl || props.url || COPILOT_CLOUD_CHAT_URL;\n\n  const [entryPoints, setEntryPoints] = useState<Record<string, FrontendAction<any>>>({});\n  const chatComponentsCache = useRef<Record<string, InChatRenderFunction | string>>({});\n  const { addElement, removeElement, printTree } = useTree();\n  const [messages, setMessages] = useState<Message[]>([]);\n\n  const {\n    addElement: addDocument,\n    removeElement: removeDocument,\n    allElements: allDocuments,\n  } = useFlatCategoryStore<DocumentPointer>();\n\n  const setEntryPoint = useCallback((id: string, entryPoint: FrontendAction<any>) => {\n    setEntryPoints((prevPoints) => {\n      return {\n        ...prevPoints,\n        [id]: entryPoint,\n      };\n    });\n  }, []);\n\n  const removeEntryPoint = useCallback((id: string) => {\n    setEntryPoints((prevPoints) => {\n      const newPoints = { ...prevPoints };\n      delete newPoints[id];\n      return newPoints;\n    });\n  }, []);\n\n  const getContextString = useCallback(\n    (documents: DocumentPointer[], categories: string[]) => {\n      const documentsString = documents\n        .map((document) => {\n          return `${document.name} (${document.sourceApplication}):\\n${document.getContents()}`;\n        })\n        .join(\"\\n\\n\");\n\n      const nonDocumentStrings = printTree(categories);\n\n      return `${documentsString}\\n\\n${nonDocumentStrings}`;\n    },\n    [printTree],\n  );\n\n  const addContext = useCallback(\n    (\n      context: string,\n      parentId?: string,\n      categories: string[] = defaultCopilotContextCategories,\n    ) => {\n      return addElement(context, categories, parentId);\n    },\n    [addElement],\n  );\n\n  const removeContext = useCallback(\n    (id: string) => {\n      removeElement(id);\n    },\n    [removeElement],\n  );\n\n  const getChatCompletionFunctionDescriptions = useCallback(\n    (customEntryPoints?: Record<string, FrontendAction<any>>) => {\n      return entryPointsToChatCompletionFunctions(Object.values(customEntryPoints || entryPoints));\n    },\n    [entryPoints],\n  );\n\n  const getFunctionCallHandler = useCallback(\n    (customEntryPoints?: Record<string, FrontendAction<any>>) => {\n      return entryPointsToFunctionCallHandler(Object.values(customEntryPoints || entryPoints));\n    },\n    [entryPoints],\n  );\n\n  const getDocumentsContext = useCallback(\n    (categories: string[]) => {\n      return allDocuments(categories);\n    },\n    [allDocuments],\n  );\n\n  const addDocumentContext = useCallback(\n    (documentPointer: DocumentPointer, categories: string[] = defaultCopilotContextCategories) => {\n      return addDocument(documentPointer, categories);\n    },\n    [addDocument],\n  );\n\n  const removeDocumentContext = useCallback(\n    (documentId: string) => {\n      removeDocument(documentId);\n    },\n    [removeDocument],\n  );\n\n  if (!props.publicApiKey) {\n    if (props.cloudRestrictToTopic) {\n      throw new Error(\n        \"To use the cloudRestrictToTopic feature, please sign up at https://copilotkit.ai and provide a publicApiKey.\",\n      );\n    }\n  }\n\n  let cloud: CopilotCloudConfig | undefined = undefined;\n  if (props.publicApiKey) {\n    cloud = {\n      guardrails: {\n        input: {\n          restrictToTopic: {\n            enabled: props.cloudRestrictToTopic ? true : false,\n            validTopics: props.cloudRestrictToTopic?.validTopics || [],\n            invalidTopics: props.cloudRestrictToTopic?.invalidTopics || [],\n          },\n        },\n      },\n    };\n  }\n\n  // get the appropriate CopilotApiConfig from the props\n  const copilotApiConfig: CopilotApiConfig = {\n    publicApiKey: props.publicApiKey,\n    ...(cloud ? { cloud } : {}),\n    chatApiEndpoint: chatApiEndpoint,\n    chatApiEndpointV2: `${props.url}/v2`,\n    headers: props.headers || {},\n    body: {\n      ...props.body,\n      ...props.backendOnlyProps,\n    },\n    transcribeAudioUrl: props.transcribeAudioUrl,\n    textToSpeechUrl: props.textToSpeechUrl,\n  };\n\n  const [chatSuggestionConfiguration, setChatSuggestionConfiguration] = useState<{\n    [key: string]: CopilotChatSuggestionConfiguration;\n  }>({});\n\n  const addChatSuggestionConfiguration = (\n    id: string,\n    suggestion: CopilotChatSuggestionConfiguration,\n  ) => {\n    setChatSuggestionConfiguration((prev) => ({ ...prev, [id]: suggestion }));\n  };\n\n  const removeChatSuggestionConfiguration = (id: string) => {\n    setChatSuggestionConfiguration((prev) => {\n      const { [id]: _, ...rest } = prev;\n      return rest;\n    });\n  };\n\n  return (\n    <CopilotContext.Provider\n      value={{\n        entryPoints,\n        chatComponentsCache,\n        getChatCompletionFunctionDescriptions,\n        getFunctionCallHandler,\n        setEntryPoint,\n        removeEntryPoint,\n        getContextString,\n        addContext,\n        removeContext,\n        getDocumentsContext,\n        addDocumentContext,\n        removeDocumentContext,\n        copilotApiConfig: copilotApiConfig,\n        messages,\n        setMessages,\n        chatSuggestionConfiguration,\n        addChatSuggestionConfiguration,\n        removeChatSuggestionConfiguration,\n      }}\n    >\n      {children}\n    </CopilotContext.Provider>\n  );\n}\n\nexport const defaultCopilotContextCategories = [\"global\"];\n\nfunction entryPointsToChatCompletionFunctions(actions: FrontendAction<any>[]): ToolDefinition[] {\n  return actions.map(actionToChatCompletionFunction);\n}\n\nfunction entryPointsToFunctionCallHandler(actions: FrontendAction<any>[]): FunctionCallHandler {\n  return async (chatMessages, functionCall) => {\n    let actionsByFunctionName: Record<string, FrontendAction<any>> = {};\n    for (let action of actions) {\n      actionsByFunctionName[action.name] = action;\n    }\n\n    const action = actionsByFunctionName[functionCall.name || \"\"];\n    if (action) {\n      let functionCallArguments: Record<string, any>[] = [];\n      if (functionCall.arguments) {\n        functionCallArguments = JSON.parse(functionCall.arguments);\n      }\n      return await action.handler(functionCallArguments);\n    }\n  };\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,oBAQO;AAgBP,SAAsB,oBAAoB,IAUO;AAAA,6CAVP;AAAA,IACxC;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF,GAAiD;AAC/C,kCAAgB;AAChB,sBAAU,CAAC;AAGX,UAAM,kBAAkB,SAAS,IAAI,CAAC,YAAY;AAChD,YAAM,EAAE,SAAS,MAAM,MAAM,cAAc,IAAI;AAC/C,aAAO,EAAE,SAAS,MAAM,MAAM,cAAc;AAAA,IAC9C,CAAC;AAED,gCAAe;AAEf,UAAM,WAAW,MAAM,MAAM,cAAc,iBAAiB;AAAA,MAC1D,QAAQ;AAAA,MACR,SAAS;AAAA,QACP,gBAAgB;AAAA,SACb,cAAc,UACb,UAAU,mBAAK,WAAY,CAAC;AAAA,MAElC,MAAM,KAAK,UAAU;AAAA,QACnB;AAAA,QACA,UAAU;AAAA,QACV,QAAQ;AAAA,SACJ,MAAM,SAAS,EAAE,MAAM,IAAI,CAAC,IAC5B,cAAc,EAAE,YAAY,IAAI,CAAC,IACjC,MAAM,UAAU,IAAI,EAAE,aAAa,WAAW,IAAI,CAAC,IACpD,cAAc,OACd,cAAc,mBACd,wBAAwB,aAAa,IACpC,OAAO,mBAAK,QAAS,CAAC,IACtB,cAAc,QAAQ,EAAE,OAAO,cAAc,MAAM,IAAI,CAAC,EAC7D;AAAA,MACD;AAAA,IACF,CAAC;AAED,WAAO;AAAA,EACT;AAAA;AAEA,SAAS,wBAAwB,eAAoB;AAxErD;AAyEE,QAAM,oBAAmB,mBAAc,qBAAd,YAAkC,CAAC;AAC5D,MAAI,OAAO,KAAK,gBAAgB,EAAE,SAAS,GAAG;AAC5C,WAAO;AAAA,MACL,CAAC,6CAA+B,GAAG,OAAO,KAAK,gBAAgB;AAAA,IACjE;AAAA,EACF,OAAO;AACL,WAAO,CAAC;AAAA,EACV;AACF;AAMA,SAAsB,6BACpB,QACwC;AAAA;AACxC,UAAM,WAAW,MAAM,oBAAoB,MAAM;AACjD,QAAI,CAAC,SAAS,MAAM,CAAC,SAAS,MAAM;AAClC,MAAC,SAAiB,SAAS;AAAA,IAC7B,OAAO;AACL,YAAM,SAAS,UAAM,wCAAqB,mCAAoB,SAAS,IAAI,CAAC;AAC5E,MAAC,SAAiB,SAAS;AAAA,IAC7B;AACA,WAAO;AAAA,EACT;AAAA;AAMA,SAAsB,mCACpB,QAC8C;AAAA;AAC9C,UAAM,WAAW,MAAM,oBAAoB,MAAM;AACjD,QAAI,CAAC,SAAS,MAAM,CAAC,SAAS,MAAM;AAClC,MAAC,SAAiB,SAAS;AAAA,IAC7B,OAAO;AACL,YAAM,SAAS,UAAM;AAAA,YACnB,wCAAqB,mCAAoB,SAAS,IAAI,CAAC;AAAA,MACzD;AACA,MAAC,SAAiB,SAAS;AAAA,IAC7B;AAEA,WAAO;AAAA,EACT;AAAA;;;ACtHA,IAAAA,iBAMO;;;AC8BP,mBAAmD;AASnD,IAAAC,iBAMO;AA0KH;AA2BG,IAAM,kCAAkC,CAAC,QAAQ;;;AD9OxD,6BAA2B;AAqC3B,SAAsB,QAAqC,IAQH;AAAA,6CARG;AAAA,IACzD;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF,GAAwD;AAvDxD;AAwDE,UAAM,EAAE,SAAS,IAAI;AAErB,UAAM,SAAsB;AAAA,MAC1B,MAAM;AAAA,MACN;AAAA,MACA,SAAS,CAAC,SAAc;AAAA,MAAC;AAAA,IAC3B;AAEA,UAAM,mBAAkB,wCAAS,aAAT,YAAqB;AAC7C,UAAM,mBAAkB,wCAAS,aAAT,YAAqB;AAE7C,QAAI,gBAAgB;AAEpB,QAAI,MAAM;AACR,uBAAiB,OAAO,SAAS,WAAW,OAAO,KAAK,UAAU,IAAI,KAAK;AAAA,IAC7E;AAEA,QAAI,iBAAiB;AACnB,uBAAiB,QAAQ,iBAAiB,CAAC,GAAG,+BAA+B;AAAA,IAC/E;AAEA,UAAM,gBAAyB;AAAA,MAC7B,IAAI;AAAA,MACJ,SAAS,kBAAkB,eAAe,YAAY;AAAA,MACtD,MAAM;AAAA,IACR;AAEA,UAAM,UAAU,kCACV,QAAQ,iBAAiB,WAAW,CAAC,IACrC,QAAQ,iBAAiB,eACzB,EAAE,CAAC,kDAAmC,GAAG,QAAQ,iBAAiB,aAAa,IAC/E,CAAC;AAGP,UAAM,WAAW,MAAM,6BAA6B;AAAA,MAClD,eAAe,QAAQ;AAAA,MACvB,UAAU,kBAAkB,CAAC,eAAe,GAAG,QAAQ,IAAI,CAAC,aAAa;AAAA,MACzE,OAAO,QAAQ,sCAAsC,EAAE,SAAS,OAAO,CAAC;AAAA,MACxE;AAAA,MACA,MAAM,QAAQ,iBAAiB;AAAA,MAC/B,YAAY,EAAE,MAAM,YAAY,UAAU,EAAE,MAAM,UAAU,EAAE;AAAA,MAC9D,QAAQ;AAAA,IACV,CAAC;AAED,QAAI,CAAC,SAAS,QAAQ;AACpB,YAAM,IAAI,MAAM,mDAAmD;AAAA,IACrE;AAEA,UAAM,SAAS,SAAS,OAAO,UAAU;AACzC,QAAI,YAAY;AAEhB,WAAO,MAAM;AACX,YAAM,EAAE,MAAM,MAAM,IAAI,MAAM,OAAO,KAAK;AAE1C,UAAI,MAAM;AACR;AAAA,MACF;AAEA,UAAI,MAAM,SAAS,WAAW;AAC5B,YAAI;AACF,cAAI,mBAAmB,KAAK,UAAM,uBAAAC,SAAe,MAAM,SAAS,CAAC;AACjE,2CAAS;AAAA,YACP,QAAQ,YAAY,YAAY;AAAA,YAChC,MAAM;AAAA,UACR;AACA,sBAAY;AAAA,QACd,SAAS,GAAP;AAAA,QAAW;AAAA,MACf;AAEA,UAAI,MAAM,SAAS,YAAY;AAC7B,yCAAS;AAAA,UACP,QAAQ;AAAA,UACR,MAAM,MAAM;AAAA,QACd;AACA,eAAO,MAAM;AAAA,MACf;AAAA,IACF;AAEA,UAAM,IAAI,MAAM,6CAA6C;AAAA,EAC/D;AAAA;AAEA,SAAS,kBAAkB,eAAuB,cAA8B;AAC9E,SAAO;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQP;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA;AAAA;AAAA;AAAA;AAAA;AAKF;","names":["import_shared","import_shared","untruncateJson"]}

package/dist/utils/index.mjs

@@ -0,0 +1,23 @@
+import "../chunk-CYDWEPFL.mjs";
+import {
+  extract
+} from "../chunk-BTJD4QON.mjs";
+import "../chunk-JD7BAH7U.mjs";
+import "../chunk-SPCZTZCY.mjs";
+import "../chunk-JWANHQCM.mjs";
+import "../chunk-YULKJPY3.mjs";
+import "../chunk-YWITCRBI.mjs";
+import {
+  fetchAndDecodeChatCompletion,
+  fetchAndDecodeChatCompletionAsText,
+  fetchChatCompletion
+} from "../chunk-7YTDTTX5.mjs";
+import "../chunk-TW5FS2QT.mjs";
+import "../chunk-SKC7AJIV.mjs";
+export {
+  extract,
+  fetchAndDecodeChatCompletion,
+  fetchAndDecodeChatCompletionAsText,
+  fetchChatCompletion
+};
+//# sourceMappingURL=index.mjs.map

package/dist/utils/index.mjs.map

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

package/package.json

@@ -4,7 +4,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.25.0",
+  "version": "0.36.0-mme-pre.1",
   "sideEffects": false,
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -29,13 +29,13 @@
     "ts-jest": "^29.1.1",
     "tsup": "^6.7.0",
     "typescript": "^5.2.3",
-    "eslint-config-custom": "0.10.0",
-    "tsconfig": "0.14.0"
+    "eslint-config-custom": "0.11.0-mme-pre.1",
+    "tsconfig": "0.15.0-mme-pre.1"
   },
   "dependencies": {
     "nanoid": "^4.0.2",
     "untruncate-json": "^0.0.1",
-    "@copilotkit/shared": "0.9.0"
+    "@copilotkit/shared": "0.36.0-mme-pre.1"
   },
   "scripts": {
     "build": "tsup --clean",

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

@@ -6,12 +6,12 @@ import { ReactNode } from "react";
 
 export interface CopilotKitProps {
   /**
-   * The public API key for Copilot Cloud.
+   * Your Copilot Cloud API key.
    */
   publicApiKey?: string;
 
   /**
-   * Cloud feature: Restrict to a specific topic.
+   * Cloud feature: Restrict input to a specific topic.
    */
   cloudRestrictToTopic?: {
     validTopics?: string[];
@@ -23,16 +23,26 @@ export interface CopilotKitProps {
    */
   runtimeUrl?: string;
 
+  /**
+   * The endpoint for the Copilot transcribe audio service.
+   */
+  transcribeAudioUrl?: string;
+
+  /**
+   * The endpoint for the Copilot text to speech service.
+   */
+  textToSpeechUrl?: string;
+
   /**
    * @deprecated use runtimeUrl instead
    */
   url?: string;
 
   /**
-   * additional headers to be sent with the request
-   * @default {}
-   * @example
-   * ```
+   * Additional headers to be sent with the request.
+   *
+   * For example:
+   * ```js
    * {
    *   'Authorization': 'Bearer your_token_here'
    * }
@@ -42,9 +52,8 @@ export interface CopilotKitProps {
 
   /**
    * Additional body params to be sent with the request
-   * @default {}
-   * @example
-   * ```
+   * For example:
+   * ```js
    * {
    *   'message': 'Hello, world!'
    * }
@@ -59,9 +68,8 @@ export interface CopilotKitProps {
 
   /**
    * Backend only props that will be combined to body params to be sent with the request
-   * @default {}
-   * @example
-   * ```
+   * For example:
+   * ```js
    * {
    *   'user_id': 'users_id',
    * }

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

@@ -1,3 +1,39 @@
+/**
+ * Provides the Copilot context to its children.
+ * 
+ * <img
+ *   referrerPolicy="no-referrer-when-downgrade"
+ *   src="https://static.scarf.sh/a.png?x-pxid=a9b290bb-38f9-4518-ac3b-8f54fdbf43be"
+ * />
+ * 
+ * This component provides the Copilot context to its children.
+ * It can be configured either with a chat API endpoint or a `CopilotApiConfig`.
+ * 
+ * <Note>
+ *   The backend can use OpenAI, or you can bring your own LLM. For examples of the
+ *   backend api implementation, see `examples/next-openai` or the [runtime
+ *   docs](https://docs.copilotkit.ai/getting-started/quickstart-runtime).
+ * </Note>
+ * 
+ * <RequestExample>
+ *   ```jsx CopilotKit Example
+ *   import { CopilotKit } from "@copilotkit/react-core";
+ * 
+ *   <CopilotKit 
+ *     runtimeUrl="https://your.copilotkit.api">
+ *     <YourApp/>
+ *   </CopilotKit>
+ *   ```
+ * </RequestExample>
+ * 
+ * ## Example usage
+ * 
+ * ```jsx
+ * <CopilotKit publicApiKey="the api key or self host (see below)">
+ *   <App />
+ * </CopilotKit>
+```
+ */
 import { Ref, useCallback, useRef, useState } from "react";
 import {
   CopilotContext,
@@ -5,7 +41,8 @@ import {
   InChatRenderFunction,
 } from "../../context/copilot-context";
 import useTree from "../../hooks/use-tree";
-import { DocumentPointer } from "../../types";
+import { CopilotChatSuggestionConfiguration, DocumentPointer } from "../../types";
+
 import {
   COPILOT_CLOUD_CHAT_URL,
   CopilotCloudConfig,
@@ -13,31 +50,12 @@ import {
   Message,
   actionToChatCompletionFunction,
 } from "@copilotkit/shared";
+
 import { FrontendAction } from "../../types/frontend-action";
 import useFlatCategoryStore from "../../hooks/use-flat-category-store";
 import { CopilotKitProps } from "./copilotkit-props";
 import { ToolDefinition } from "@copilotkit/shared";
 
-/**
- * The CopilotKit component.
- * This component provides the Copilot context to its children.
- * It can be configured either with a chat API endpoint or a CopilotApiConfig.
- *
- * NOTE: The backend can use OpenAI, or you can bring your own LLM.
- * For examples of the backend api implementation, see `examples/next-openai` usage (under `src/api/copilotkit`),
- * or read the documentation at https://docs.copilotkit.ai
- * In particular, Getting-Started > Quickstart-Runtime: https://docs.copilotkit.ai/getting-started/quickstart-runtime
- *
- * Example usage:
- * ```
- * <CopilotKit url="https://your.copilotkit.api">
- *    <App />
- * </CopilotKit>
- * ```
- *
- * @param props - The props for the component.
- * @returns The CopilotKit component.
- */
 export function CopilotKit({ children, ...props }: CopilotKitProps) {
   // Compute all the functions and properties that we need to pass
   // to the CopilotContext.
@@ -178,6 +196,26 @@ export function CopilotKit({ children, ...props }: CopilotKitProps) {
       ...props.body,
       ...props.backendOnlyProps,
     },
+    transcribeAudioUrl: props.transcribeAudioUrl,
+    textToSpeechUrl: props.textToSpeechUrl,
+  };
+
+  const [chatSuggestionConfiguration, setChatSuggestionConfiguration] = useState<{
+    [key: string]: CopilotChatSuggestionConfiguration;
+  }>({});
+
+  const addChatSuggestionConfiguration = (
+    id: string,
+    suggestion: CopilotChatSuggestionConfiguration,
+  ) => {
+    setChatSuggestionConfiguration((prev) => ({ ...prev, [id]: suggestion }));
+  };
+
+  const removeChatSuggestionConfiguration = (id: string) => {
+    setChatSuggestionConfiguration((prev) => {
+      const { [id]: _, ...rest } = prev;
+      return rest;
+    });
   };
 
   return (
@@ -198,6 +236,9 @@ export function CopilotKit({ children, ...props }: CopilotKitProps) {
         copilotApiConfig: copilotApiConfig,
         messages,
         setMessages,
+        chatSuggestionConfiguration,
+        addChatSuggestionConfiguration,
+        removeChatSuggestionConfiguration,
       }}
     >
       {children}

package/src/context/copilot-context.tsx

@@ -5,9 +5,10 @@ import {
   ToolDefinition,
 } from "@copilotkit/shared";
 import { ActionRenderProps, FrontendAction } from "../types/frontend-action";
-import React, { Ref } from "react";
+import React from "react";
 import { TreeNodeId } from "../hooks/use-tree";
 import { DocumentPointer } from "../types";
+import { CopilotChatSuggestionConfiguration } from "../types/chat-suggestion-configuration";
 
 /**
  * Interface for the configuration of the Copilot API.
@@ -28,6 +29,16 @@ export interface CopilotApiConfig {
    */
   chatApiEndpoint: string;
 
+  /**
+   * The endpoint for the Copilot transcribe audio service.
+   */
+  transcribeAudioUrl?: string;
+
+  /**
+   * The endpoint for the Copilot text to speech service.
+   */
+  textToSpeechUrl?: string;
+
   /**
    * The endpoint for the chat API v2.
    */
@@ -98,6 +109,14 @@ export interface CopilotContextParams {
   removeDocumentContext: (documentId: string) => void;
   getDocumentsContext: (categories: string[]) => DocumentPointer[];
 
+  // suggestions configuration
+  chatSuggestionConfiguration: { [key: string]: CopilotChatSuggestionConfiguration };
+  addChatSuggestionConfiguration: (
+    id: string,
+    suggestion: CopilotChatSuggestionConfiguration,
+  ) => void;
+  removeChatSuggestionConfiguration: (id: string) => void;
+
   // api endpoints
   copilotApiConfig: CopilotApiConfig;
 }
@@ -134,6 +153,10 @@ const emptyCopilotContext: CopilotContextParams = {
       return {};
     }
   })(),
+
+  chatSuggestionConfiguration: {},
+  addChatSuggestionConfiguration: () => {},
+  removeChatSuggestionConfiguration: () => {},
 };
 
 export const CopilotContext = React.createContext<CopilotContextParams>(emptyCopilotContext);

package/src/hooks/use-chat.ts

@@ -1,4 +1,5 @@
-import { useRef, useState } from "react";
+import { useRef, useState, useContext, useEffect } from "react";
+import { CopilotContext } from "../context/copilot-context";
 import {
   Message,
   ToolDefinition,
@@ -123,7 +124,6 @@ export function useChat(options: UseChatOptionsWithCopilotConfig): UseChatHelper
     abortControllerRef.current = abortController;
 
     setMessages([...messages, ...newMessages]);
-
     // add threadId and runId to the body if it exists
     const copilotConfigBody = options.copilotConfig.body || {};
     if (threadIdRef.current) {