@copilotkit/react-core 0.8.0-alpha.5 → 0.8.0

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/components/copilot-provider.tsx","../src/context/copilot-context.tsx","../src/hooks/use-tree.ts","../src/hooks/use-copilot-chat.ts","../src/hooks/use-make-copilot-actionable.ts","../src/hooks/use-make-copilot-readable.ts"],"sourcesContent":["\"use client\";\nimport { FunctionCallHandler } from \"ai\";\nimport { ReactNode, useCallback, useState } from \"react\";\nimport { CopilotContext, CopilotApiConfig } from \"../context/copilot-context\";\nimport useTree from \"../hooks/use-tree\";\nimport { AnnotatedFunction } from \"../types/annotated-function\";\nimport { ChatCompletionCreateParams } from \"openai/resources/chat\";\n\nexport function CopilotProvider({\n  copilotApiConfig,\n  children,\n}: {\n  copilotApiConfig: CopilotApiConfig;\n  children: ReactNode;\n}): JSX.Element {\n  const [entryPoints, setEntryPoints] = useState<\n    Record<string, AnnotatedFunction<any[]>>\n  >({});\n\n  const { addElement, removeElement, printTree } = useTree();\n\n  const setEntryPoint = useCallback(\n    (id: string, entryPoint: AnnotatedFunction<any[]>) => {\n      setEntryPoints((prevPoints) => {\n        return {\n          ...prevPoints,\n          [id]: entryPoint,\n        };\n      });\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    (categories: string[] = [\"global\"]) => {\n      return printTree(categories);\n    },\n    [printTree]\n  );\n\n  const addContext = useCallback(\n    (context: string, parentId?: string, categories: string[] = [\"global\"]) => {\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    return entryPointsToChatCompletionFunctions(Object.values(entryPoints));\n  }, [entryPoints]);\n\n  const getFunctionCallHandler = useCallback(() => {\n    return entryPointsToFunctionCallHandler(Object.values(entryPoints));\n  }, [entryPoints]);\n\n  return (\n    <CopilotContext.Provider\n      value={{\n        entryPoints,\n        getChatCompletionFunctionDescriptions,\n        getFunctionCallHandler,\n        setEntryPoint,\n        removeEntryPoint,\n        getContextString,\n        addContext,\n        removeContext,\n\n        copilotApiConfig,\n      }}\n    >\n      {children}\n    </CopilotContext.Provider>\n  );\n}\n\nfunction entryPointsToFunctionCallHandler(\n  entryPoints: AnnotatedFunction<any[]>[]\n): FunctionCallHandler {\n  return async (chatMessages, functionCall) => {\n    let entrypointsByFunctionName: Record<\n      string,\n      AnnotatedFunction<any[]>\n    > = {};\n    for (let entryPoint of entryPoints) {\n      entrypointsByFunctionName[entryPoint.name] = entryPoint;\n    }\n\n    const entryPointFunction =\n      entrypointsByFunctionName[functionCall.name || \"\"];\n    if (entryPointFunction) {\n      let parsedFunctionCallArguments: Record<string, any>[] = [];\n      if (functionCall.arguments) {\n        parsedFunctionCallArguments = JSON.parse(functionCall.arguments);\n      }\n\n      const paramsInCorrectOrder: any[] = [];\n      for (let arg of entryPointFunction.argumentAnnotations) {\n        paramsInCorrectOrder.push(\n          parsedFunctionCallArguments[\n            arg.name as keyof typeof parsedFunctionCallArguments\n          ]\n        );\n      }\n\n      await entryPointFunction.implementation(...paramsInCorrectOrder);\n\n      // commented out becasue for now we don't want to return anything\n      // const result = await entryPointFunction.implementation(\n      //   ...parsedFunctionCallArguments\n      // );\n      // const functionResponse: ChatRequest = {\n      //   messages: [\n      //     ...chatMessages,\n      //     {\n      //       id: nanoid(),\n      //       name: functionCall.name,\n      //       role: 'function' as const,\n      //       content: JSON.stringify(result),\n      //     },\n      //   ],\n      // };\n\n      // return functionResponse;\n    }\n  };\n}\n\nfunction entryPointsToChatCompletionFunctions(\n  entryPoints: AnnotatedFunction<any[]>[]\n): ChatCompletionCreateParams.Function[] {\n  return entryPoints.map(annotatedFunctionToChatCompletionFunction);\n}\n\nfunction annotatedFunctionToChatCompletionFunction(\n  annotatedFunction: AnnotatedFunction<any[]>\n): ChatCompletionCreateParams.Function {\n  // Create the parameters object based on the argumentAnnotations\n  let parameters: { [key: string]: any } = {};\n  for (let arg of annotatedFunction.argumentAnnotations) {\n    // isolate the args we should forward inline\n    let { name, required, ...forwardedArgs } = arg;\n    parameters[arg.name] = forwardedArgs;\n  }\n\n  let requiredParameterNames: string[] = [];\n  for (let arg of annotatedFunction.argumentAnnotations) {\n    if (arg.required) {\n      requiredParameterNames.push(arg.name);\n    }\n  }\n\n  // Create the ChatCompletionFunctions object\n  let chatCompletionFunction: ChatCompletionCreateParams.Function = {\n    name: annotatedFunction.name,\n    description: annotatedFunction.description,\n    parameters: {\n      type: \"object\",\n      properties: parameters,\n      required: requiredParameterNames,\n    },\n  };\n\n  return chatCompletionFunction;\n}\n","\"use client\";\n\nimport { FunctionCallHandler } from \"ai\";\nimport React from \"react\";\nimport { TreeNodeId } from \"../hooks/use-tree\";\nimport { AnnotatedFunction } from \"../types/annotated-function\";\nimport { ChatCompletionCreateParams } from \"openai/resources/chat\";\n\nexport interface CopilotApiConfig {\n  chatApiEndpoint: string;\n}\n\nexport function copilotApiConfigExtrapolator(config: CopilotApiConfig) {\n  return {\n    get chatApiEndpoint(): string {\n      return `${config.chatApiEndpoint}`;\n    },\n  };\n}\n\nexport interface CopilotContextParams {\n  // function-calling\n  entryPoints: Record<string, AnnotatedFunction<any[]>>;\n  setEntryPoint: (id: string, entryPoint: AnnotatedFunction<any[]>) => void;\n  removeEntryPoint: (id: string) => void;\n  getChatCompletionFunctionDescriptions: () => ChatCompletionCreateParams.Function[];\n  getFunctionCallHandler: () => FunctionCallHandler;\n\n  // text context\n  getContextString: (categories?: string[]) => string;\n  addContext: (\n    context: string,\n    parentId?: string,\n    categories?: string[]\n  ) => TreeNodeId;\n  removeContext: (id: TreeNodeId) => void;\n\n  // api endpoints\n  copilotApiConfig: CopilotApiConfig;\n}\n\nconst emptyCopilotContext: CopilotContextParams = {\n  entryPoints: {},\n  setEntryPoint: () => {},\n  removeEntryPoint: () => {},\n  getChatCompletionFunctionDescriptions: () => returnAndThrowInDebug([]),\n  getFunctionCallHandler: () => returnAndThrowInDebug(async () => {}),\n\n  getContextString: () => returnAndThrowInDebug(\"\"),\n  addContext: () => \"\",\n  removeContext: () => {},\n\n  copilotApiConfig: new (class implements CopilotApiConfig {\n    get chatApiEndpoint(): string {\n      throw new Error(\n        \"Remember to wrap your app in a `<CopilotProvider> {...} </CopilotProvider>` !!!\"\n      );\n    }\n  })(),\n};\n\nexport const CopilotContext =\n  React.createContext<CopilotContextParams>(emptyCopilotContext);\n\nfunction returnAndThrowInDebug<T>(value: T): T {\n  throw new Error(\n    \"Remember to wrap your app in a `<CopilotProvider> {...} </CopilotProvider>` !!!\"\n  );\n  return value;\n}\n","import { nanoid } from \"nanoid\";\nimport { useCallback, useReducer } from \"react\";\n\nexport type TreeNodeId = string;\n\nexport interface TreeNode {\n  id: TreeNodeId;\n  value: string;\n  children: TreeNode[];\n  parentId?: TreeNodeId;\n  categories: Set<string>;\n}\n\nexport type Tree = TreeNode[];\n\nexport interface UseTreeReturn {\n  tree: Tree;\n  addElement: (\n    value: string,\n    categories: string[],\n    parentId?: TreeNodeId\n  ) => TreeNodeId;\n  printTree: (categories: string[]) => string;\n  removeElement: (id: TreeNodeId) => void;\n}\n\nconst findNode = (nodes: Tree, id: TreeNodeId): TreeNode | undefined => {\n  for (const node of nodes) {\n    if (node.id === id) {\n      return node;\n    }\n    const result = findNode(node.children, id);\n    if (result) {\n      return result;\n    }\n  }\n  return undefined;\n};\n\nconst removeNode = (nodes: Tree, id: TreeNodeId): Tree => {\n  return nodes.reduce((result: Tree, node) => {\n    if (node.id !== id) {\n      const newNode = { ...node, children: removeNode(node.children, id) };\n      result.push(newNode);\n    }\n    return result;\n  }, []);\n};\n\nconst addNode = (\n  nodes: Tree,\n  newNode: TreeNode,\n  parentId?: TreeNodeId\n): Tree => {\n  if (!parentId) {\n    return [...nodes, newNode];\n  }\n  return nodes.map((node) => {\n    if (node.id === parentId) {\n      return { ...node, children: [...node.children, newNode] };\n    } else if (node.children.length) {\n      return { ...node, children: addNode(node.children, newNode, parentId) };\n    }\n    return node;\n  });\n};\n\nconst treeIndentationRepresentation = (\n  index: number,\n  indentLevel: number\n): string => {\n  if (indentLevel === 0) {\n    return (index + 1).toString();\n  } else if (indentLevel === 1) {\n    return String.fromCharCode(65 + index); // 65 is the ASCII value for 'A'\n  } else if (indentLevel === 2) {\n    return String.fromCharCode(97 + index); // 97 is the ASCII value for 'a'\n  } else {\n    return \"-\";\n  }\n};\n\nconst printNode = (node: TreeNode, prefix = \"\", indentLevel = 0): string => {\n  const indent = \" \".repeat(3).repeat(indentLevel);\n\n  const prefixPlusIndentLength = prefix.length + indent.length;\n  const subsequentLinesPrefix = \" \".repeat(prefixPlusIndentLength);\n\n  const valueLines = node.value.split(\"\\n\");\n\n  const outputFirstLine = `${indent}${prefix}${valueLines[0]}`;\n  const outputSubsequentLines = valueLines\n    .slice(1)\n    .map((line) => `${subsequentLinesPrefix}${line}`)\n    .join(\"\\n\");\n\n  let output = `${outputFirstLine}\\n`;\n  if (outputSubsequentLines) {\n    output += `${outputSubsequentLines}\\n`;\n  }\n\n  const childPrePrefix = \" \".repeat(prefix.length);\n\n  node.children.forEach(\n    (child, index) =>\n      (output += printNode(\n        child,\n        `${childPrePrefix}${treeIndentationRepresentation(\n          index,\n          indentLevel + 1\n        )}. `,\n        indentLevel + 1\n      ))\n  );\n  return output;\n};\n\n// Action types\ntype Action =\n  | {\n      type: \"ADD_NODE\";\n      value: string;\n      parentId?: string;\n      id: string;\n      categories: string[];\n    }\n  | { type: \"REMOVE_NODE\"; id: string };\n\n// Reducer function\nfunction treeReducer(state: Tree, action: Action): Tree {\n  switch (action.type) {\n    case \"ADD_NODE\": {\n      const { value, parentId, id: newNodeId } = action;\n      const newNode: TreeNode = {\n        id: newNodeId,\n        value,\n        children: [],\n        categories: new Set(action.categories),\n      };\n\n      try {\n        return addNode(state, newNode, parentId);\n      } catch (error) {\n        console.error(`Error while adding node with id ${newNodeId}: ${error}`);\n        return state;\n      }\n    }\n    case \"REMOVE_NODE\":\n      return removeNode(state, action.id);\n    default:\n      return state;\n  }\n}\n\n// useTree hook\nconst useTree = (): UseTreeReturn => {\n  const [tree, dispatch] = useReducer(treeReducer, []);\n\n  const addElement = useCallback(\n    (value: string, categories: string[], parentId?: string): TreeNodeId => {\n      const newNodeId = nanoid(); // Generate new ID outside of dispatch\n      dispatch({\n        type: \"ADD_NODE\",\n        value,\n        parentId,\n        id: newNodeId,\n        categories: categories,\n      });\n      return newNodeId; // Return the new ID\n    },\n    []\n  );\n\n  const removeElement = useCallback((id: TreeNodeId): void => {\n    dispatch({ type: \"REMOVE_NODE\", id });\n  }, []);\n\n  const printTree = useCallback(\n    (categories: string[]): string => {\n      const categoriesSet = new Set(categories);\n\n      let output = \"\";\n      tree.forEach((node, index) => {\n        // if the node does not have any of the desired categories, continue to the next node\n        if (!setsHaveIntersection(categoriesSet, node.categories)) {\n          return;\n        }\n\n        // add a new line before each node except the first one\n        if (index !== 0) {\n          output += \"\\n\";\n        }\n\n        output += printNode(\n          node,\n          `${treeIndentationRepresentation(index, 0)}. `\n        );\n      });\n      return output;\n    },\n    [tree]\n  );\n\n  return { tree, addElement, printTree, removeElement };\n};\n\nexport default useTree;\n\nfunction setsHaveIntersection<T>(setA: Set<T>, setB: Set<T>): boolean {\n  const [smallerSet, largerSet] =\n    setA.size <= setB.size ? [setA, setB] : [setB, setA];\n\n  for (let item of smallerSet) {\n    if (largerSet.has(item)) {\n      return true;\n    }\n  }\n\n  return false;\n}\n","import { useMemo, useContext } from \"react\";\nimport {\n  CopilotContext,\n  CopilotContextParams,\n  copilotApiConfigExtrapolator,\n} from \"../context/copilot-context\";\nimport { useChat } from \"ai/react\";\nimport { ChatRequestOptions, CreateMessage, Message } from \"ai\";\nimport { UseChatOptions } from \"ai\";\n\nexport interface UseCopilotChatOptions extends UseChatOptions {\n  makeSystemMessage?: (contextString: string) => string;\n}\n\nexport interface UseCopilotChatReturn {\n  visibleMessages: Message[];\n  append: (\n    message: Message | CreateMessage,\n    chatRequestOptions?: ChatRequestOptions\n  ) => Promise<string | null | undefined>;\n  reload: (\n    chatRequestOptions?: ChatRequestOptions\n  ) => Promise<string | null | undefined>;\n  stop: () => void;\n  isLoading: boolean;\n  input: string;\n  setInput: React.Dispatch<React.SetStateAction<string>>;\n}\n\nexport function useCopilotChat({\n  makeSystemMessage,\n  ...options\n}: UseCopilotChatOptions): UseCopilotChatReturn {\n  const {\n    getContextString,\n    getChatCompletionFunctionDescriptions,\n    getFunctionCallHandler,\n    copilotApiConfig,\n  } = useContext(CopilotContext);\n\n  const systemMessage: Message = useMemo(() => {\n    const systemMessageMaker = makeSystemMessage || defaultSystemMessage;\n    const contextString = getContextString();\n\n    return {\n      id: \"system\",\n      content: systemMessageMaker(contextString),\n      role: \"system\",\n    };\n  }, [getContextString, makeSystemMessage]);\n\n  const initialMessagesWithContext = [systemMessage].concat(\n    options.initialMessages || []\n  );\n\n  const functionDescriptions = useMemo(() => {\n    return getChatCompletionFunctionDescriptions();\n  }, [getChatCompletionFunctionDescriptions]);\n\n  const { messages, append, reload, stop, isLoading, input, setInput } =\n    useChat({\n      api: copilotApiConfigExtrapolator(copilotApiConfig).chatApiEndpoint,\n      id: options.id,\n      initialMessages: initialMessagesWithContext,\n      experimental_onFunctionCall: getFunctionCallHandler(),\n      body: {\n        id: options.id,\n        functions: functionDescriptions,\n      },\n    });\n\n  const visibleMessages = messages.filter(\n    (message) => message.role === \"user\" || message.role === \"assistant\"\n  );\n\n  return {\n    visibleMessages,\n    append,\n    reload,\n    stop,\n    isLoading,\n    input,\n    setInput,\n  };\n}\n\nexport function defaultSystemMessage(contextString: 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 functions you can call to initiate actions on their behalf, or functions you can call to receive more information.\n\nPlease assist them as best you can.\n\nYou can ask them for clarifying questions if needed, but don't be annoying about it. If you can reasonably 'fill in the blanks' yourself, do so.\n\nIf you would like to call a function, call it without saying anything else.\n`;\n}\n","\"use client\";\n\nimport { useRef, useContext, useEffect, useMemo } from \"react\";\nimport { CopilotContext } from \"../context/copilot-context\";\nimport { AnnotatedFunction } from \"../types/annotated-function\";\nimport { nanoid } from \"nanoid\";\n\nexport function useMakeCopilotActionable<ActionInput extends any[]>(\n  annotatedFunction: AnnotatedFunction<ActionInput>,\n  dependencies: any[]\n) {\n  const idRef = useRef(nanoid()); // generate a unique id\n  const { setEntryPoint, removeEntryPoint } = useContext(CopilotContext);\n\n  const memoizedAnnotatedFunction: AnnotatedFunction<ActionInput> = useMemo(\n    () => ({\n      name: annotatedFunction.name,\n      description: annotatedFunction.description,\n      argumentAnnotations: annotatedFunction.argumentAnnotations,\n      implementation: annotatedFunction.implementation,\n    }),\n    dependencies\n  );\n\n  useEffect(() => {\n    setEntryPoint(\n      idRef.current,\n      memoizedAnnotatedFunction as AnnotatedFunction<any[]>\n    );\n\n    return () => {\n      removeEntryPoint(idRef.current);\n    };\n  }, [memoizedAnnotatedFunction, setEntryPoint, removeEntryPoint]);\n}\n","\"use client\";\n\nimport { useContext, useEffect, useRef } from \"react\";\nimport { CopilotContext } from \"../context/copilot-context\";\n\n/**\n * Adds the given information to the Copilot context to make it readable by Copilot.\n * @param information - The information to be added to the Copilot context.\n * @param parentId - The ID of the parent context, if any.\n * @param categories - An array of categories to control which context are visible where. Particularly useful with CopilotTextarea (see `useMakeAutosuggestionFunction`)\n * @returns The ID of the added context.\n */\nexport function useMakeCopilotReadable(\n  information: string,\n  parentId?: string,\n  categories?: string[]\n): string | undefined {\n  const { addContext, removeContext } = useContext(CopilotContext);\n  const idRef = useRef<string>();\n\n  useEffect(() => {\n    const id = addContext(information, parentId, categories);\n    idRef.current = id;\n\n    return () => {\n      removeContext(id);\n    };\n  }, [information, parentId, addContext, removeContext]);\n\n  return idRef.current;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEA,SAAoB,eAAAA,cAAa,gBAAgB;;;ACCjD,OAAO,WAAW;AAHlB;AAYO,SAAS,6BAA6B,QAA0B;AACrE,SAAO;AAAA,IACL,IAAI,kBAA0B;AAC5B,aAAO,GAAG,OAAO;AAAA,IACnB;AAAA,EACF;AACF;AAuBA,IAAM,sBAA4C;AAAA,EAChD,aAAa,CAAC;AAAA,EACd,eAAe,MAAM;AAAA,EAAC;AAAA,EACtB,kBAAkB,MAAM;AAAA,EAAC;AAAA,EACzB,uCAAuC,MAAM,sBAAsB,CAAC,CAAC;AAAA,EACrE,wBAAwB,MAAM,sBAAsB,MAAY;AAAA,EAAC,EAAC;AAAA,EAElE,kBAAkB,MAAM,sBAAsB,EAAE;AAAA,EAChD,YAAY,MAAM;AAAA,EAClB,eAAe,MAAM;AAAA,EAAC;AAAA,EAEtB,kBAAkB,IAAK,MAAkC;AAAA,IACvD,IAAI,kBAA0B;AAC5B,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,IACF;AAAA,EACF,EAAG;AACL;AAEO,IAAM,iBACX,MAAM,cAAoC,mBAAmB;AAE/D,SAAS,sBAAyB,OAAa;AAC7C,QAAM,IAAI;AAAA,IACR;AAAA,EACF;AACA,SAAO;AACT;;;ACrEA,SAAS,cAAc;AACvB,SAAS,aAAa,kBAAkB;AAsCxC,IAAM,aAAa,CAAC,OAAa,OAAyB;AACxD,SAAO,MAAM,OAAO,CAAC,QAAc,SAAS;AAC1C,QAAI,KAAK,OAAO,IAAI;AAClB,YAAM,UAAU,iCAAK,OAAL,EAAW,UAAU,WAAW,KAAK,UAAU,EAAE,EAAE;AACnE,aAAO,KAAK,OAAO;AAAA,IACrB;AACA,WAAO;AAAA,EACT,GAAG,CAAC,CAAC;AACP;AAEA,IAAM,UAAU,CACd,OACA,SACA,aACS;AACT,MAAI,CAAC,UAAU;AACb,WAAO,CAAC,GAAG,OAAO,OAAO;AAAA,EAC3B;AACA,SAAO,MAAM,IAAI,CAAC,SAAS;AACzB,QAAI,KAAK,OAAO,UAAU;AACxB,aAAO,iCAAK,OAAL,EAAW,UAAU,CAAC,GAAG,KAAK,UAAU,OAAO,EAAE;AAAA,IAC1D,WAAW,KAAK,SAAS,QAAQ;AAC/B,aAAO,iCAAK,OAAL,EAAW,UAAU,QAAQ,KAAK,UAAU,SAAS,QAAQ,EAAE;AAAA,IACxE;AACA,WAAO;AAAA,EACT,CAAC;AACH;AAEA,IAAM,gCAAgC,CACpC,OACA,gBACW;AACX,MAAI,gBAAgB,GAAG;AACrB,YAAQ,QAAQ,GAAG,SAAS;AAAA,EAC9B,WAAW,gBAAgB,GAAG;AAC5B,WAAO,OAAO,aAAa,KAAK,KAAK;AAAA,EACvC,WAAW,gBAAgB,GAAG;AAC5B,WAAO,OAAO,aAAa,KAAK,KAAK;AAAA,EACvC,OAAO;AACL,WAAO;AAAA,EACT;AACF;AAEA,IAAM,YAAY,CAAC,MAAgB,SAAS,IAAI,cAAc,MAAc;AAC1E,QAAM,SAAS,IAAI,OAAO,CAAC,EAAE,OAAO,WAAW;AAE/C,QAAM,yBAAyB,OAAO,SAAS,OAAO;AACtD,QAAM,wBAAwB,IAAI,OAAO,sBAAsB;AAE/D,QAAM,aAAa,KAAK,MAAM,MAAM,IAAI;AAExC,QAAM,kBAAkB,GAAG,SAAS,SAAS,WAAW;AACxD,QAAM,wBAAwB,WAC3B,MAAM,CAAC,EACP,IAAI,CAAC,SAAS,GAAG,wBAAwB,MAAM,EAC/C,KAAK,IAAI;AAEZ,MAAI,SAAS,GAAG;AAAA;AAChB,MAAI,uBAAuB;AACzB,cAAU,GAAG;AAAA;AAAA,EACf;AAEA,QAAM,iBAAiB,IAAI,OAAO,OAAO,MAAM;AAE/C,OAAK,SAAS;AAAA,IACZ,CAAC,OAAO,UACL,UAAU;AAAA,MACT;AAAA,MACA,GAAG,iBAAiB;AAAA,QAClB;AAAA,QACA,cAAc;AAAA,MAChB;AAAA,MACA,cAAc;AAAA,IAChB;AAAA,EACJ;AACA,SAAO;AACT;AAcA,SAAS,YAAY,OAAa,QAAsB;AACtD,UAAQ,OAAO,MAAM;AAAA,IACnB,KAAK,YAAY;AACf,YAAM,EAAE,OAAO,UAAU,IAAI,UAAU,IAAI;AAC3C,YAAM,UAAoB;AAAA,QACxB,IAAI;AAAA,QACJ;AAAA,QACA,UAAU,CAAC;AAAA,QACX,YAAY,IAAI,IAAI,OAAO,UAAU;AAAA,MACvC;AAEA,UAAI;AACF,eAAO,QAAQ,OAAO,SAAS,QAAQ;AAAA,MACzC,SAAS,OAAP;AACA,gBAAQ,MAAM,mCAAmC,cAAc,OAAO;AACtE,eAAO;AAAA,MACT;AAAA,IACF;AAAA,IACA,KAAK;AACH,aAAO,WAAW,OAAO,OAAO,EAAE;AAAA,IACpC;AACE,aAAO;AAAA,EACX;AACF;AAGA,IAAM,UAAU,MAAqB;AACnC,QAAM,CAAC,MAAM,QAAQ,IAAI,WAAW,aAAa,CAAC,CAAC;AAEnD,QAAM,aAAa;AAAA,IACjB,CAAC,OAAe,YAAsB,aAAkC;AACtE,YAAM,YAAY,OAAO;AACzB,eAAS;AAAA,QACP,MAAM;AAAA,QACN;AAAA,QACA;AAAA,QACA,IAAI;AAAA,QACJ;AAAA,MACF,CAAC;AACD,aAAO;AAAA,IACT;AAAA,IACA,CAAC;AAAA,EACH;AAEA,QAAM,gBAAgB,YAAY,CAAC,OAAyB;AAC1D,aAAS,EAAE,MAAM,eAAe,GAAG,CAAC;AAAA,EACtC,GAAG,CAAC,CAAC;AAEL,QAAM,YAAY;AAAA,IAChB,CAAC,eAAiC;AAChC,YAAM,gBAAgB,IAAI,IAAI,UAAU;AAExC,UAAI,SAAS;AACb,WAAK,QAAQ,CAAC,MAAM,UAAU;AAE5B,YAAI,CAAC,qBAAqB,eAAe,KAAK,UAAU,GAAG;AACzD;AAAA,QACF;AAGA,YAAI,UAAU,GAAG;AACf,oBAAU;AAAA,QACZ;AAEA,kBAAU;AAAA,UACR;AAAA,UACA,GAAG,8BAA8B,OAAO,CAAC;AAAA,QAC3C;AAAA,MACF,CAAC;AACD,aAAO;AAAA,IACT;AAAA,IACA,CAAC,IAAI;AAAA,EACP;AAEA,SAAO,EAAE,MAAM,YAAY,WAAW,cAAc;AACtD;AAEA,IAAO,mBAAQ;AAEf,SAAS,qBAAwB,MAAc,MAAuB;AACpE,QAAM,CAAC,YAAY,SAAS,IAC1B,KAAK,QAAQ,KAAK,OAAO,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,IAAI;AAErD,WAAS,QAAQ,YAAY;AAC3B,QAAI,UAAU,IAAI,IAAI,GAAG;AACvB,aAAO;AAAA,IACT;AAAA,EACF;AAEA,SAAO;AACT;;;AFpJI;AAvEJ;AAQO,SAAS,gBAAgB;AAAA,EAC9B;AAAA,EACA;AACF,GAGgB;AACd,QAAM,CAAC,aAAa,cAAc,IAAI,SAEpC,CAAC,CAAC;AAEJ,QAAM,EAAE,YAAY,eAAe,UAAU,IAAI,iBAAQ;AAEzD,QAAM,gBAAgBC;AAAA,IACpB,CAAC,IAAY,eAAyC;AACpD,qBAAe,CAAC,eAAe;AAC7B,eAAO,iCACF,aADE;AAAA,UAEL,CAAC,KAAK;AAAA,QACR;AAAA,MACF,CAAC;AAAA,IACH;AAAA,IACA,CAAC;AAAA,EACH;AAEA,QAAM,mBAAmBA,aAAY,CAAC,OAAe;AACnD,mBAAe,CAAC,eAAe;AAC7B,YAAM,YAAY,mBAAK;AACvB,aAAO,UAAU;AACjB,aAAO;AAAA,IACT,CAAC;AAAA,EACH,GAAG,CAAC,CAAC;AAEL,QAAM,mBAAmBA;AAAA,IACvB,CAAC,aAAuB,CAAC,QAAQ,MAAM;AACrC,aAAO,UAAU,UAAU;AAAA,IAC7B;AAAA,IACA,CAAC,SAAS;AAAA,EACZ;AAEA,QAAM,aAAaA;AAAA,IACjB,CAAC,SAAiB,UAAmB,aAAuB,CAAC,QAAQ,MAAM;AACzE,aAAO,WAAW,SAAS,YAAY,QAAQ;AAAA,IACjD;AAAA,IACA,CAAC,UAAU;AAAA,EACb;AAEA,QAAM,gBAAgBA;AAAA,IACpB,CAAC,OAAe;AACd,oBAAc,EAAE;AAAA,IAClB;AAAA,IACA,CAAC,aAAa;AAAA,EAChB;AAEA,QAAM,wCAAwCA,aAAY,MAAM;AAC9D,WAAO,qCAAqC,OAAO,OAAO,WAAW,CAAC;AAAA,EACxE,GAAG,CAAC,WAAW,CAAC;AAEhB,QAAM,yBAAyBA,aAAY,MAAM;AAC/C,WAAO,iCAAiC,OAAO,OAAO,WAAW,CAAC;AAAA,EACpE,GAAG,CAAC,WAAW,CAAC;AAEhB,SACE,oBAAC,eAAe,UAAf;AAAA,IACC,OAAO;AAAA,MACL;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MAEA;AAAA,IACF;AAAA,IAEC;AAAA,GACH;AAEJ;AAEA,SAAS,iCACP,aACqB;AACrB,SAAO,CAAO,cAAc,iBAAiB;AAC3C,QAAI,4BAGA,CAAC;AACL,aAAS,cAAc,aAAa;AAClC,gCAA0B,WAAW,QAAQ;AAAA,IAC/C;AAEA,UAAM,qBACJ,0BAA0B,aAAa,QAAQ;AACjD,QAAI,oBAAoB;AACtB,UAAI,8BAAqD,CAAC;AAC1D,UAAI,aAAa,WAAW;AAC1B,sCAA8B,KAAK,MAAM,aAAa,SAAS;AAAA,MACjE;AAEA,YAAM,uBAA8B,CAAC;AACrC,eAAS,OAAO,mBAAmB,qBAAqB;AACtD,6BAAqB;AAAA,UACnB,4BACE,IAAI;AAAA,QAER;AAAA,MACF;AAEA,YAAM,mBAAmB,eAAe,GAAG,oBAAoB;AAAA,IAmBjE;AAAA,EACF;AACF;AAEA,SAAS,qCACP,aACuC;AACvC,SAAO,YAAY,IAAI,yCAAyC;AAClE;AAEA,SAAS,0CACP,mBACqC;AAErC,MAAI,aAAqC,CAAC;AAC1C,WAAS,OAAO,kBAAkB,qBAAqB;AAErD,QAA2C,UAArC,QAAM,SA3JhB,IA2J+C,IAAlB,0BAAkB,IAAlB,CAAnB,QAAM;AACZ,eAAW,IAAI,QAAQ;AAAA,EACzB;AAEA,MAAI,yBAAmC,CAAC;AACxC,WAAS,OAAO,kBAAkB,qBAAqB;AACrD,QAAI,IAAI,UAAU;AAChB,6BAAuB,KAAK,IAAI,IAAI;AAAA,IACtC;AAAA,EACF;AAGA,MAAI,yBAA8D;AAAA,IAChE,MAAM,kBAAkB;AAAA,IACxB,aAAa,kBAAkB;AAAA,IAC/B,YAAY;AAAA,MACV,MAAM;AAAA,MACN,YAAY;AAAA,MACZ,UAAU;AAAA,IACZ;AAAA,EACF;AAEA,SAAO;AACT;;;AGlLA,SAAS,SAAS,kBAAkB;AAMpC,SAAS,eAAe;AAuBjB,SAAS,eAAe,IAGiB;AAHjB,eAC7B;AAAA;AAAA,EA9BF,IA6B+B,IAE1B,oBAF0B,IAE1B;AAAA,IADH;AAAA;AAGA,QAAM;AAAA,IACJ;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF,IAAI,WAAW,cAAc;AAE7B,QAAM,gBAAyB,QAAQ,MAAM;AAC3C,UAAM,qBAAqB,qBAAqB;AAChD,UAAM,gBAAgB,iBAAiB;AAEvC,WAAO;AAAA,MACL,IAAI;AAAA,MACJ,SAAS,mBAAmB,aAAa;AAAA,MACzC,MAAM;AAAA,IACR;AAAA,EACF,GAAG,CAAC,kBAAkB,iBAAiB,CAAC;AAExC,QAAM,6BAA6B,CAAC,aAAa,EAAE;AAAA,IACjD,QAAQ,mBAAmB,CAAC;AAAA,EAC9B;AAEA,QAAM,uBAAuB,QAAQ,MAAM;AACzC,WAAO,sCAAsC;AAAA,EAC/C,GAAG,CAAC,qCAAqC,CAAC;AAE1C,QAAM,EAAE,UAAU,QAAQ,QAAQ,MAAM,WAAW,OAAO,SAAS,IACjE,QAAQ;AAAA,IACN,KAAK,6BAA6B,gBAAgB,EAAE;AAAA,IACpD,IAAI,QAAQ;AAAA,IACZ,iBAAiB;AAAA,IACjB,6BAA6B,uBAAuB;AAAA,IACpD,MAAM;AAAA,MACJ,IAAI,QAAQ;AAAA,MACZ,WAAW;AAAA,IACb;AAAA,EACF,CAAC;AAEH,QAAM,kBAAkB,SAAS;AAAA,IAC/B,CAAC,YAAY,QAAQ,SAAS,UAAU,QAAQ,SAAS;AAAA,EAC3D;AAEA,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;AAEO,SAAS,qBAAqB,eAA+B;AAClE,SAAO;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQP;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAWF;;;ACxGA,SAAS,QAAQ,cAAAC,aAAY,WAAW,WAAAC,gBAAe;AAGvD,SAAS,UAAAC,eAAc;AALvB;AAOO,SAAS,yBACd,mBACA,cACA;AACA,QAAM,QAAQ,OAAOA,QAAO,CAAC;AAC7B,QAAM,EAAE,eAAe,iBAAiB,IAAIC,YAAW,cAAc;AAErE,QAAM,4BAA4DC;AAAA,IAChE,OAAO;AAAA,MACL,MAAM,kBAAkB;AAAA,MACxB,aAAa,kBAAkB;AAAA,MAC/B,qBAAqB,kBAAkB;AAAA,MACvC,gBAAgB,kBAAkB;AAAA,IACpC;AAAA,IACA;AAAA,EACF;AAEA,YAAU,MAAM;AACd;AAAA,MACE,MAAM;AAAA,MACN;AAAA,IACF;AAEA,WAAO,MAAM;AACX,uBAAiB,MAAM,OAAO;AAAA,IAChC;AAAA,EACF,GAAG,CAAC,2BAA2B,eAAe,gBAAgB,CAAC;AACjE;;;AChCA,SAAS,cAAAC,aAAY,aAAAC,YAAW,UAAAC,eAAc;AAF9C;AAYO,SAAS,uBACd,aACA,UACA,YACoB;AACpB,QAAM,EAAE,YAAY,cAAc,IAAIC,YAAW,cAAc;AAC/D,QAAM,QAAQC,QAAe;AAE7B,EAAAC,WAAU,MAAM;AACd,UAAM,KAAK,WAAW,aAAa,UAAU,UAAU;AACvD,UAAM,UAAU;AAEhB,WAAO,MAAM;AACX,oBAAc,EAAE;AAAA,IAClB;AAAA,EACF,GAAG,CAAC,aAAa,UAAU,YAAY,aAAa,CAAC;AAErD,SAAO,MAAM;AACf;","names":["useCallback","useCallback","useContext","useMemo","nanoid","useContext","useMemo","useContext","useEffect","useRef","useContext","useRef","useEffect"]}
+{"version":3,"sources":[],"names":[],"mappings":""}

package/dist/types/annotated-function.mjs

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

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

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

package/dist/types/document-pointer.d.ts

@@ -0,0 +1,9 @@
+interface DocumentPointer {
+    id: string;
+    name: string;
+    sourceApplication: string;
+    iconImageUri: string;
+    getContents: () => Promise<string>;
+}
+
+export { DocumentPointer };

package/dist/types/document-pointer.mjs

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

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

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

package/dist/types/index.d.ts

@@ -1 +1,2 @@
 export { AnnotatedFunction, AnnotatedFunctionArgument } from './annotated-function.js';
+export { DocumentPointer } from './document-pointer.js';

package/dist/types/index.mjs

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

package/dist/types/index.mjs.map

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

package/dist/utils/utils.mjs

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

package/dist/utils/utils.mjs.map

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

package/dist/utils/utils.test.mjs

@@ -4,4 +4,5 @@ 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"],"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":[]}
+{"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"]}

package/package.json

@@ -4,7 +4,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.8.0-alpha.5",
+  "version": "0.8.0",
   "sideEffects": false,
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -23,8 +23,8 @@
     "ts-jest": "^29.1.1",
     "tsup": "^6.5.0",
     "typescript": "^4.9.4",
-    "tsconfig": "0.4.0-alpha.3",
-    "eslint-config-custom": "0.2.0"
+    "eslint-config-custom": "0.2.0",
+    "tsconfig": "0.4.0"
   },
   "dependencies": {
     "ai": "^2.2.12",

package/src/components/copilot-provider.tsx

@@ -5,6 +5,8 @@ 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({
   copilotApiConfig,
@@ -18,6 +20,11 @@ export function CopilotProvider({
   >({});
 
   const { addElement, removeElement, printTree } = useTree();
+  const {
+    addElement: addDocument,
+    removeElement: removeDocument,
+    allElements: allDocuments,
+  } = useFlatCategoryStore<DocumentPointer>();
 
   const setEntryPoint = useCallback(
     (id: string, entryPoint: AnnotatedFunction<any[]>) => {
@@ -68,6 +75,27 @@ export function CopilotProvider({
     return entryPointsToFunctionCallHandler(Object.values(entryPoints));
   }, [entryPoints]);
 
+  const getDocumentsContext = useCallback(
+    (categories: string[] = ["global"]) => {
+      return allDocuments(categories);
+    },
+    [allDocuments]
+  );
+
+  const addDocumentContext = useCallback(
+    (documentPointer: DocumentPointer, categories: string[] = ["global"]) => {
+      return addDocument(documentPointer, categories);
+    },
+    [addDocument]
+  );
+
+  const removeDocumentContext = useCallback(
+    (documentId: string) => {
+      removeDocument(documentId);
+    },
+    [removeDocument]
+  );
+
   return (
     <CopilotContext.Provider
       value={{
@@ -79,7 +107,9 @@ export function CopilotProvider({
         getContextString,
         addContext,
         removeContext,
-
+        getDocumentsContext,
+        addDocumentContext,
+        removeDocumentContext,
         copilotApiConfig,
       }}
     >

package/src/context/copilot-context.tsx

@@ -5,6 +5,7 @@ import React from "react";
 import { TreeNodeId } from "../hooks/use-tree";
 import { AnnotatedFunction } from "../types/annotated-function";
 import { ChatCompletionCreateParams } from "openai/resources/chat";
+import { DocumentPointer } from "../types";
 
 export interface CopilotApiConfig {
   chatApiEndpoint: string;
@@ -35,6 +36,14 @@ export interface CopilotContextParams {
   ) => TreeNodeId;
   removeContext: (id: TreeNodeId) => void;
 
+  // document context
+  getDocumentsContext: (categories?: string[]) => DocumentPointer[];
+  addDocumentContext: (
+    documentPointer: DocumentPointer,
+    categories?: string[]
+  ) => TreeNodeId;
+  removeDocumentContext: (documentId: string) => void;
+
   // api endpoints
   copilotApiConfig: CopilotApiConfig;
 }
@@ -50,6 +59,10 @@ const emptyCopilotContext: CopilotContextParams = {
   addContext: () => "",
   removeContext: () => {},
 
+  getDocumentsContext: () => returnAndThrowInDebug([]),
+  addDocumentContext: () => returnAndThrowInDebug(""),
+  removeDocumentContext: () => {},
+
   copilotApiConfig: new (class implements CopilotApiConfig {
     get chatApiEndpoint(): string {
       throw new Error(

package/src/hooks/index.ts

@@ -4,3 +4,4 @@ export type { UseCopilotChatReturn } from "./use-copilot-chat";
 
 export { useMakeCopilotActionable } from "./use-make-copilot-actionable";
 export { useMakeCopilotReadable } from "./use-make-copilot-readable";
+export { useMakeCopilotDocumentReadable } from "./use-make-copilot-document-readable";

package/src/hooks/use-flat-category-store.ts

@@ -0,0 +1,114 @@
+import { nanoid } from "nanoid";
+import { useCallback, useReducer } from "react";
+
+export type FlatCategoryStoreId = string;
+
+export interface UseFlatCategoryStoreReturn<T> {
+  addElement: (value: T, categories: string[]) => FlatCategoryStoreId;
+  removeElement: (id: FlatCategoryStoreId) => void;
+  allElements: (categories: string[]) => T[];
+}
+
+interface FlatCategoryStoreElement<T> {
+  id: FlatCategoryStoreId;
+  value: T;
+  categories: Set<string>;
+}
+
+const useFlatCategoryStore = <T>(): UseFlatCategoryStoreReturn<T> => {
+  const [elements, dispatch] = useReducer<
+    React.Reducer<
+      Map<FlatCategoryStoreId, FlatCategoryStoreElement<T>>,
+      Action<T>
+    >
+  >(
+    flatCategoryStoreReducer,
+    new Map<FlatCategoryStoreId, FlatCategoryStoreElement<T>>()
+  );
+
+  const addElement = useCallback(
+    (value: T, categories: string[]): FlatCategoryStoreId => {
+      const newId = nanoid();
+      dispatch({
+        type: "ADD_ELEMENT",
+        value,
+        id: newId,
+        categories,
+      });
+      return newId;
+    },
+    []
+  );
+
+  const removeElement = useCallback((id: FlatCategoryStoreId): void => {
+    dispatch({ type: "REMOVE_ELEMENT", id });
+  }, []);
+
+  const allElements = useCallback(
+    (categories: string[]): T[] => {
+      const categoriesSet = new Set(categories);
+      const result: T[] = [];
+      elements.forEach((element) => {
+        if (setsHaveIntersection(categoriesSet, element.categories)) {
+          result.push(element.value);
+        }
+      });
+      return result;
+    },
+    [elements]
+  );
+
+  return { addElement, removeElement, allElements };
+};
+
+export default useFlatCategoryStore;
+
+// Action types
+type Action<T> =
+  | {
+      type: "ADD_ELEMENT";
+      value: T;
+      id: FlatCategoryStoreId;
+      categories: string[];
+    }
+  | { type: "REMOVE_ELEMENT"; id: FlatCategoryStoreId };
+
+// Reducer
+function flatCategoryStoreReducer<T>(
+  state: Map<FlatCategoryStoreId, FlatCategoryStoreElement<T>>,
+  action: Action<T>
+): Map<FlatCategoryStoreId, FlatCategoryStoreElement<T>> {
+  switch (action.type) {
+    case "ADD_ELEMENT": {
+      const { value, id, categories } = action;
+      const newElement: FlatCategoryStoreElement<T> = {
+        id,
+        value,
+        categories: new Set(categories),
+      };
+      const newState = new Map(state);
+      newState.set(id, newElement);
+      return newState;
+    }
+    case "REMOVE_ELEMENT": {
+      const newState = new Map(state);
+      newState.delete(action.id);
+      return newState;
+    }
+    default:
+      return state;
+  }
+}
+
+function setsHaveIntersection<T>(setA: Set<T>, setB: Set<T>): boolean {
+  const [smallerSet, largerSet] =
+    setA.size <= setB.size ? [setA, setB] : [setB, setA];
+
+  for (let item of smallerSet) {
+    if (largerSet.has(item)) {
+      return true;
+    }
+  }
+
+  return false;
+}

package/src/hooks/use-make-copilot-document-readable.ts

@@ -0,0 +1,32 @@
+"use client";
+
+import { useContext, useEffect, useRef } from "react";
+import { CopilotContext } from "../context/copilot-context";
+import { DocumentPointer } from "../types";
+
+/**
+ * Adds the given information to the Copilot context to make it readable by Copilot.
+ * @param information - The information to be added to the Copilot context.
+ * @param parentId - The ID of the parent context, if any.
+ * @param categories - An array of categories to control which context are visible where. Particularly useful with CopilotTextarea (see `useMakeAutosuggestionFunction`)
+ * @returns The ID of the added context.
+ */
+export function useMakeCopilotDocumentReadable(
+  document: DocumentPointer,
+  categories?: string[]
+): string | undefined {
+  const { addDocumentContext, removeDocumentContext } =
+    useContext(CopilotContext);
+  const idRef = useRef<string>();
+
+  useEffect(() => {
+    const id = addDocumentContext(document, categories);
+    idRef.current = id;
+
+    return () => {
+      removeDocumentContext(id);
+    };
+  }, [document, categories, addDocumentContext, removeDocumentContext]);
+
+  return idRef.current;
+}

package/src/types/document-pointer.ts

@@ -0,0 +1,7 @@
+export interface DocumentPointer {
+  id: string;
+  name: string;
+  sourceApplication: string;
+  iconImageUri: string;
+  getContents: () => Promise<string>;
+}

package/src/types/index.ts

@@ -1,2 +1,3 @@
 export type { AnnotatedFunctionArgument } from "./annotated-function";
 export type { AnnotatedFunction } from "./annotated-function";
+export type { DocumentPointer } from "./document-pointer";