@copilotkit/shared 0.37.0 → 0.38.0-beta.0

package/dist/types/index.d.ts

@@ -1,4 +1,4 @@
-export { AssistantMessage, FunctionCall, FunctionCallHandler, FunctionDefinition, JSONValue, Message, Role, ToolDefinition } from './openai-assistant.js';
+export { AssistantMessage, FunctionCallHandler, FunctionCallHandlerArguments, FunctionDefinition, JSONValue, ToolDefinition } from './openai-assistant.js';
 export { AnnotatedFunction, AnnotatedFunctionArgument, AnnotatedFunctionArrayArgument, AnnotatedFunctionSimpleArgument } from './annotated-function.js';
 export { Action, MappedParameterTypes, Parameter } from './action.js';
 export { CopilotCloudConfig } from './copilot-cloud-config.js';

package/dist/types/openai-assistant.d.ts

@@ -1,47 +1,3 @@
-type Role = "system" | "user" | "assistant" | "function";
-interface FunctionCall {
-    /**
-     * The arguments to call the function with, as generated by the model in JSON
-     * format. Note that the model does not always generate valid JSON, and may
-     * hallucinate parameters not defined by your function schema. Validate the
-     * arguments in your code before calling your function.
-     */
-    arguments?: string;
-    /**
-     * The name of the function to call.
-     */
-    name?: string;
-    /**
-     * Temporarily add scope to the function call.
-     */
-    scope?: "client" | "server";
-}
-/**
- * Shared types between the API and UI packages.
- */
-interface Message {
-    id: string;
-    createdAt?: Date;
-    content: string;
-    ui?: string | null | undefined;
-    role: Role;
-    /**
-     * If the message has a role of `function`, the `name` field is the name of the function.
-     * Otherwise, the name field should not be set.
-     */
-    name?: string;
-    /**
-     * If the assistant role makes a function call, the `function_call` field
-     * contains the function call name and arguments. Otherwise, the field should
-     * not be set.
-     */
-    function_call?: FunctionCall;
-    /**
-     * Partial function call contains the function call name and arguments as they are
-     * streamed from the model. This is used to display the function call in the UI.
-     */
-    partialFunctionCall?: FunctionCall;
-}
 interface FunctionDefinition {
     /**
      * The name of the function to be called. Must be a-z, A-Z, 0-9, or contain
@@ -68,7 +24,12 @@ interface ToolDefinition {
     type: "function";
     function: FunctionDefinition;
 }
-type FunctionCallHandler = (chatMessages: Message[], functionCall: FunctionCall) => Promise<any>;
+interface FunctionCallHandlerArguments {
+    messages: any[];
+    name: string;
+    args: any;
+}
+type FunctionCallHandler = (args: FunctionCallHandlerArguments) => Promise<any>;
 type AssistantMessage = {
     id: string;
     role: "assistant";
@@ -83,4 +44,4 @@ type JSONValue = null | string | number | boolean | {
     [x: string]: JSONValue;
 } | Array<JSONValue>;
 
-export { AssistantMessage, FunctionCall, FunctionCallHandler, FunctionDefinition, JSONValue, Message, Role, ToolDefinition };
+export { AssistantMessage, FunctionCallHandler, FunctionCallHandlerArguments, FunctionDefinition, JSONValue, ToolDefinition };

package/dist/types/openai-assistant.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/types/openai-assistant.ts"],"sourcesContent":["export type Role = \"system\" | \"user\" | \"assistant\" | \"function\";\n\nexport interface FunctionCall {\n  /**\n   * The arguments to call the function with, as generated by the model in JSON\n   * format. Note that the model does not always generate valid JSON, and may\n   * hallucinate parameters not defined by your function schema. Validate the\n   * arguments in your code before calling your function.\n   */\n  arguments?: string;\n\n  /**\n   * The name of the function to call.\n   */\n  name?: string;\n\n  /**\n   * Temporarily add scope to the function call.\n   */\n  scope?: \"client\" | \"server\";\n}\n\n/**\n * Shared types between the API and UI packages.\n */\nexport interface Message {\n  id: string;\n  createdAt?: Date;\n  content: string;\n  ui?: string | null | undefined;\n  role: Role;\n  /**\n   * If the message has a role of `function`, the `name` field is the name of the function.\n   * Otherwise, the name field should not be set.\n   */\n  name?: string;\n  /**\n   * If the assistant role makes a function call, the `function_call` field\n   * contains the function call name and arguments. Otherwise, the field should\n   * not be set.\n   */\n  function_call?: FunctionCall;\n\n  /**\n   * Partial function call contains the function call name and arguments as they are\n   * streamed from the model. This is used to display the function call in the UI.\n   */\n  partialFunctionCall?: FunctionCall;\n}\n\nexport interface FunctionDefinition {\n  /**\n   * The name of the function to be called. Must be a-z, A-Z, 0-9, or contain\n   * underscores and dashes, with a maximum length of 64.\n   */\n  name: string;\n  /**\n   * The parameters the functions accepts, described as a JSON Schema object. See the\n   * [guide](/docs/guides/gpt/function-calling) for examples, and the\n   * [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for\n   * documentation about the format.\n   *\n   * To describe a function that accepts no parameters, provide the value\n   * `{\"type\": \"object\", \"properties\": {}}`.\n   */\n  parameters: Record<string, unknown>;\n  /**\n   * A description of what the function does, used by the model to choose when and\n   * how to call the function.\n   */\n  description?: string;\n}\n\nexport interface ToolDefinition {\n  type: \"function\";\n  function: FunctionDefinition;\n}\n\nexport type FunctionCallHandler = (\n  chatMessages: Message[],\n  functionCall: FunctionCall,\n) => Promise<any>;\n\nexport type AssistantMessage = {\n  id: string;\n  role: \"assistant\";\n  content: Array<{\n    type: \"text\";\n    text: {\n      value: string;\n    };\n  }>;\n};\n\nexport type JSONValue =\n  | null\n  | string\n  | number\n  | boolean\n  | { [x: string]: JSONValue }\n  | Array<JSONValue>;\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
+{"version":3,"sources":["../../src/types/openai-assistant.ts"],"sourcesContent":["export interface FunctionDefinition {\n  /**\n   * The name of the function to be called. Must be a-z, A-Z, 0-9, or contain\n   * underscores and dashes, with a maximum length of 64.\n   */\n  name: string;\n  /**\n   * The parameters the functions accepts, described as a JSON Schema object. See the\n   * [guide](/docs/guides/gpt/function-calling) for examples, and the\n   * [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for\n   * documentation about the format.\n   *\n   * To describe a function that accepts no parameters, provide the value\n   * `{\"type\": \"object\", \"properties\": {}}`.\n   */\n  parameters: Record<string, unknown>;\n  /**\n   * A description of what the function does, used by the model to choose when and\n   * how to call the function.\n   */\n  description?: string;\n}\n\nexport interface ToolDefinition {\n  type: \"function\";\n  function: FunctionDefinition;\n}\n\nexport interface FunctionCallHandlerArguments {\n  messages: any[];\n  name: string;\n  args: any;\n}\n\nexport type FunctionCallHandler = (args: FunctionCallHandlerArguments) => Promise<any>;\n\nexport type AssistantMessage = {\n  id: string;\n  role: \"assistant\";\n  content: Array<{\n    type: \"text\";\n    text: {\n      value: string;\n    };\n  }>;\n};\n\nexport type JSONValue =\n  | null\n  | string\n  | number\n  | boolean\n  | { [x: string]: JSONValue }\n  | Array<JSONValue>;\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/utils/index.d.ts

@@ -1,8 +1,5 @@
-export { COMPLEX_HEADER, StreamPart, StreamPartType, StreamString, StreamStringPrefixes, decodeResult, encodeResult, formatStreamPart, isStreamStringEqualToType, parseStreamPart, streamPartsByCode, validCodes } from './utils.js';
-export { ChatCompletionChunk, ToolCallFunctionCall, ToolCallPayload, parseChatCompletion } from './parse-chat-completion.js';
-export { ChatCompletionContentEvent, ChatCompletionEvent, ChatCompletionFunctionEvent, ChatCompletionPartialEvent, ChatCompletionResultEvent, decodeChatCompletion } from './decode-chat-completion.js';
-export { decodeChatCompletionAsText } from './decode-chat-completion-as-text.js';
 export { actionToChatCompletionFunction, annotatedFunctionToAction, annotatedFunctionToChatCompletionFunction } from './annotated-function.js';
+export { JSONSchema, JSONSchemaArray, JSONSchemaBoolean, JSONSchemaNumber, JSONSchemaObject, JSONSchemaString, actionParametersToJsonSchema } from './json-schema.js';
 import '../types/openai-assistant.js';
 import '../types/annotated-function.js';
 import '../types/action.js';

package/dist/utils/index.js

@@ -20,365 +20,13 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/utils/index.ts
 var utils_exports = {};
 __export(utils_exports, {
-  COMPLEX_HEADER: () => COMPLEX_HEADER,
-  StreamStringPrefixes: () => StreamStringPrefixes,
+  actionParametersToJsonSchema: () => actionParametersToJsonSchema,
   actionToChatCompletionFunction: () => actionToChatCompletionFunction,
   annotatedFunctionToAction: () => annotatedFunctionToAction,
-  annotatedFunctionToChatCompletionFunction: () => annotatedFunctionToChatCompletionFunction,
-  decodeChatCompletion: () => decodeChatCompletion,
-  decodeChatCompletionAsText: () => decodeChatCompletionAsText,
-  decodeResult: () => decodeResult,
-  encodeResult: () => encodeResult,
-  formatStreamPart: () => formatStreamPart,
-  isStreamStringEqualToType: () => isStreamStringEqualToType,
-  parseChatCompletion: () => parseChatCompletion,
-  parseStreamPart: () => parseStreamPart,
-  streamPartsByCode: () => streamPartsByCode,
-  validCodes: () => validCodes
+  annotatedFunctionToChatCompletionFunction: () => annotatedFunctionToChatCompletionFunction
 });
 module.exports = __toCommonJS(utils_exports);
 
-// src/utils/utils.ts
-function encodeResult(result) {
-  if (result === void 0) {
-    return "";
-  } else if (typeof result === "string") {
-    return result;
-  } else {
-    return JSON.stringify(result);
-  }
-}
-function decodeResult(result) {
-  try {
-    return JSON.parse(result);
-  } catch (e) {
-    return result;
-  }
-}
-var textStreamPart = {
-  code: "0",
-  name: "text",
-  parse: (value) => {
-    if (typeof value !== "string") {
-      throw new Error('"text" parts expect a string value.');
-    }
-    return { type: "text", value };
-  }
-};
-var functionCallStreamPart = {
-  code: "1",
-  name: "function_call",
-  parse: (value) => {
-    if (value == null || typeof value !== "object" || !("function_call" in value) || typeof value.function_call !== "object" || value.function_call == null || !("name" in value.function_call) || !("arguments" in value.function_call) || typeof value.function_call.name !== "string" || typeof value.function_call.arguments !== "string") {
-      throw new Error('"function_call" parts expect an object with a "function_call" property.');
-    }
-    return {
-      type: "function_call",
-      value
-    };
-  }
-};
-var dataStreamPart = {
-  code: "2",
-  name: "data",
-  parse: (value) => {
-    if (!Array.isArray(value)) {
-      throw new Error('"data" parts expect an array value.');
-    }
-    return { type: "data", value };
-  }
-};
-var errorStreamPart = {
-  code: "3",
-  name: "error",
-  parse: (value) => {
-    if (typeof value !== "string") {
-      throw new Error('"error" parts expect a string value.');
-    }
-    return { type: "error", value };
-  }
-};
-var assistantMessage = {
-  code: "4",
-  name: "assistant_message",
-  parse: (value) => {
-    if (value == null || typeof value !== "object" || !("id" in value) || !("role" in value) || !("content" in value) || typeof value.id !== "string" || typeof value.role !== "string" || value.role !== "assistant" || !Array.isArray(value.content) || !value.content.every(
-      (item) => item != null && typeof item === "object" && "type" in item && item.type === "text" && "text" in item && item.text != null && typeof item.text === "object" && "value" in item.text && typeof item.text.value === "string"
-    )) {
-      throw new Error(
-        '"assistant_message" parts expect an object with an "id", "role", and "content" property.'
-      );
-    }
-    return {
-      type: "assistant_message",
-      value
-    };
-  }
-};
-var assistantControlData = {
-  code: "5",
-  name: "assistant_control_data",
-  parse: (value) => {
-    if (value == null || typeof value !== "object" || !("threadId" in value) || !("messageId" in value) || typeof value.threadId !== "string" || typeof value.messageId !== "string") {
-      throw new Error(
-        '"assistant_control_data" parts expect an object with a "threadId" and "messageId" property.'
-      );
-    }
-    return {
-      type: "assistant_control_data",
-      value: {
-        threadId: value.threadId,
-        messageId: value.messageId
-      }
-    };
-  }
-};
-var streamParts = [
-  textStreamPart,
-  functionCallStreamPart,
-  dataStreamPart,
-  errorStreamPart,
-  assistantMessage,
-  assistantControlData
-];
-var streamPartsByCode = {
-  [textStreamPart.code]: textStreamPart,
-  [functionCallStreamPart.code]: functionCallStreamPart,
-  [dataStreamPart.code]: dataStreamPart,
-  [errorStreamPart.code]: errorStreamPart,
-  [assistantMessage.code]: assistantMessage,
-  [assistantControlData.code]: assistantControlData
-};
-var StreamStringPrefixes = {
-  [textStreamPart.name]: textStreamPart.code,
-  [functionCallStreamPart.name]: functionCallStreamPart.code,
-  [dataStreamPart.name]: dataStreamPart.code,
-  [errorStreamPart.name]: errorStreamPart.code,
-  [assistantMessage.name]: assistantMessage.code,
-  [assistantControlData.name]: assistantControlData.code
-};
-var validCodes = streamParts.map((part) => part.code);
-var parseStreamPart = (line) => {
-  const firstSeparatorIndex = line.indexOf(":");
-  if (firstSeparatorIndex === -1) {
-    throw new Error("Failed to parse stream string. No separator found.");
-  }
-  const prefix = line.slice(0, firstSeparatorIndex);
-  if (!validCodes.includes(prefix)) {
-    throw new Error(`Failed to parse stream string. Invalid code ${prefix}.`);
-  }
-  const code = prefix;
-  const textValue = line.slice(firstSeparatorIndex + 1);
-  const jsonValue = JSON.parse(textValue);
-  return streamPartsByCode[code].parse(jsonValue);
-};
-function formatStreamPart(type, value) {
-  const streamPart = streamParts.find((part) => part.name === type);
-  if (!streamPart) {
-    throw new Error(`Invalid stream part type: ${type}`);
-  }
-  return `${streamPart.code}:${JSON.stringify(value)}
-`;
-}
-var isStreamStringEqualToType = (type, value) => value.startsWith(`${StreamStringPrefixes[type]}:`) && value.endsWith("\n");
-var COMPLEX_HEADER = "X-Experimental-Stream-Data";
-
-// src/utils/parse-chat-completion.ts
-function parseChatCompletion(stream) {
-  const reader = stream.getReader();
-  let buffer = new Uint8Array();
-  async function cleanup(controller) {
-    if (controller) {
-      try {
-        controller.close();
-      } catch (_) {
-      }
-    }
-    if (reader) {
-      try {
-        await reader.cancel();
-      } catch (_) {
-      }
-    }
-  }
-  return new ReadableStream({
-    async pull(controller) {
-      while (true) {
-        try {
-          const { done, value } = await reader.read();
-          if (done) {
-            await cleanup(controller);
-            return;
-          }
-          const newBuffer = new Uint8Array(buffer.length + value.length);
-          newBuffer.set(buffer);
-          newBuffer.set(value, buffer.length);
-          buffer = newBuffer;
-          const valueString = new TextDecoder("utf-8").decode(buffer);
-          const lines = valueString.split("\n").filter((line) => line.trim() !== "");
-          buffer = !valueString.endsWith("\n") ? new TextEncoder().encode(lines.pop() || "") : new Uint8Array();
-          for (const line of lines) {
-            const cleanedLine = line.replace(/^data: /, "");
-            if (cleanedLine === "[DONE]") {
-              await cleanup(controller);
-              return;
-            }
-            const json = JSON.parse(cleanedLine);
-            controller.enqueue(json);
-          }
-        } catch (error) {
-          controller.error(error);
-          await cleanup(controller);
-          return;
-        }
-      }
-    },
-    cancel() {
-      reader.cancel();
-    }
-  });
-}
-
-// src/utils/decode-chat-completion.ts
-function decodeChatCompletion(stream) {
-  const reader = stream.getReader();
-  let mode = null;
-  let functionCallName = "";
-  let functionCallArguments = "";
-  let functionCallScope = "client";
-  async function cleanup(controller) {
-    if (controller) {
-      try {
-        controller.close();
-      } catch (_) {
-      }
-    }
-    if (reader) {
-      try {
-        await reader.cancel();
-      } catch (_) {
-      }
-    }
-  }
-  return new ReadableStream({
-    async pull(controller) {
-      var _a, _b, _c, _d, _e, _f;
-      const flushFunctionCall = () => {
-        let args = null;
-        try {
-          args = JSON.parse(functionCallArguments);
-        } catch (error) {
-          cleanup(controller);
-          controller.error(error);
-          return false;
-        }
-        controller.enqueue({
-          type: "function",
-          name: functionCallName,
-          arguments: args,
-          scope: functionCallScope
-        });
-        mode = null;
-        functionCallName = "";
-        functionCallArguments = "";
-        return true;
-      };
-      while (true) {
-        try {
-          const { done, value } = await reader.read();
-          if (done) {
-            if ((mode == null ? void 0 : mode.type) === "function") {
-              flushFunctionCall();
-            }
-            await cleanup(controller);
-            return;
-          }
-          if ((mode == null ? void 0 : mode.type) === "function" && (!((_b = (_a = value.choices[0].delta.tool_calls) == null ? void 0 : _a[0]) == null ? void 0 : _b.function) || ((_d = (_c = value.choices[0].delta.tool_calls) == null ? void 0 : _c[0]) == null ? void 0 : _d.function.name))) {
-            if (!flushFunctionCall()) {
-              return;
-            }
-          }
-          const maybeFunctionCall = (_f = (_e = value.choices[0].delta.tool_calls) == null ? void 0 : _e[0]) == null ? void 0 : _f.function;
-          if (maybeFunctionCall) {
-            mode = { type: "function", function: maybeFunctionCall };
-          } else {
-            mode = { type: "message" };
-          }
-          if (mode.type === "message") {
-            if (value.choices[0].delta.role === "function") {
-              controller.enqueue({
-                type: "result",
-                content: value.choices[0].delta.content,
-                name: value.choices[0].delta.name
-              });
-            } else if (value.choices[0].delta.content) {
-              controller.enqueue({
-                type: "content",
-                content: value.choices[0].delta.content
-              });
-            }
-            continue;
-          } else if (mode.type === "function") {
-            const maybeFunctionCallName = mode.function.name;
-            if (maybeFunctionCallName) {
-              functionCallName = maybeFunctionCallName;
-            }
-            const maybeFunctionCallArguments = mode.function.arguments;
-            if (maybeFunctionCallArguments) {
-              functionCallArguments += maybeFunctionCallArguments;
-            }
-            const maybeFunctionCallScope = mode.function.scope;
-            if (maybeFunctionCallScope) {
-              functionCallScope = maybeFunctionCallScope;
-            }
-            controller.enqueue({
-              type: "partial",
-              name: functionCallName,
-              arguments: functionCallArguments
-            });
-            continue;
-          }
-        } catch (error) {
-          controller.error(error);
-          await cleanup(controller);
-          return;
-        }
-      }
-    },
-    cancel() {
-      reader.cancel();
-    }
-  });
-}
-
-// src/utils/decode-chat-completion-as-text.ts
-function decodeChatCompletionAsText(stream) {
-  const reader = stream.getReader();
-  return new ReadableStream({
-    async pull(controller) {
-      while (true) {
-        try {
-          const { done, value } = await reader.read();
-          if (done) {
-            controller.close();
-            return;
-          }
-          if (value.type === "content") {
-            controller.enqueue(value.content);
-            continue;
-          }
-        } catch (error) {
-          controller.error(error);
-          return;
-        }
-      }
-    },
-    cancel() {
-      reader.cancel();
-    }
-  });
-}
-
 // src/utils/annotated-function.ts
 function annotatedFunctionToChatCompletionFunction(annotatedFunction) {
   let parameters = {};
@@ -535,22 +183,87 @@ function annotatedFunctionToAction(annotatedFunction) {
     }
   };
 }
+
+// src/utils/json-schema.ts
+function actionParametersToJsonSchema(actionParameters) {
+  let parameters = {};
+  for (let parameter of actionParameters || []) {
+    parameters[parameter.name] = convertAttribute2(parameter);
+  }
+  let requiredParameterNames = [];
+  for (let arg of actionParameters || []) {
+    if (arg.required !== false) {
+      requiredParameterNames.push(arg.name);
+    }
+  }
+  return {
+    type: "object",
+    properties: parameters,
+    required: requiredParameterNames
+  };
+}
+function convertAttribute2(attribute) {
+  var _a, _b, _c;
+  switch (attribute.type) {
+    case "string":
+      return {
+        type: "string",
+        description: attribute.description,
+        ...attribute.enum && { enum: attribute.enum }
+      };
+    case "number":
+    case "boolean":
+      return {
+        type: attribute.type,
+        description: attribute.description
+      };
+    case "object":
+    case "object[]":
+      const properties = (_a = attribute.attributes) == null ? void 0 : _a.reduce(
+        (acc, attr) => {
+          acc[attr.name] = convertAttribute2(attr);
+          return acc;
+        },
+        {}
+      );
+      const required = (_b = attribute.attributes) == null ? void 0 : _b.filter((attr) => attr.required !== false).map((attr) => attr.name);
+      if (attribute.type === "object[]") {
+        return {
+          type: "array",
+          items: {
+            type: "object",
+            ...properties && { properties },
+            ...required && required.length > 0 && { required }
+          },
+          description: attribute.description
+        };
+      }
+      return {
+        type: "object",
+        description: attribute.description,
+        ...properties && { properties },
+        ...required && required.length > 0 && { required }
+      };
+    default:
+      if ((_c = attribute.type) == null ? void 0 : _c.endsWith("[]")) {
+        const itemType = attribute.type.slice(0, -2);
+        return {
+          type: "array",
+          items: { type: itemType },
+          description: attribute.description
+        };
+      }
+      return {
+        type: "string",
+        description: attribute.description
+      };
+  }
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  COMPLEX_HEADER,
-  StreamStringPrefixes,
+  actionParametersToJsonSchema,
   actionToChatCompletionFunction,
   annotatedFunctionToAction,
-  annotatedFunctionToChatCompletionFunction,
-  decodeChatCompletion,
-  decodeChatCompletionAsText,
-  decodeResult,
-  encodeResult,
-  formatStreamPart,
-  isStreamStringEqualToType,
-  parseChatCompletion,
-  parseStreamPart,
-  streamPartsByCode,
-  validCodes
+  annotatedFunctionToChatCompletionFunction
 });
 //# sourceMappingURL=index.js.map