ai 2.1.0 → 2.1.3

package/vue/dist/index.d.ts

@@ -1,4 +1,194 @@
-export { UseChatHelpers, useChat } from './use-chat.js';
-export { UseCompletionHelpers, useCompletion } from './use-completion.js';
-export { C as CreateMessage, M as Message, U as UseChatOptions } from './types-f862f74a.js';
-import 'vue';
+import { Ref } from 'vue';
+
+/**
+ * Shared types between the API and UI packages.
+ */
+type Message = {
+    id: string;
+    createdAt?: Date;
+    content: string;
+    role: 'system' | 'user' | 'assistant';
+};
+type CreateMessage = {
+    id?: string;
+    createdAt?: Date;
+    content: string;
+    role: 'system' | 'user' | 'assistant';
+};
+type UseChatOptions = {
+    /**
+     * The API endpoint that accepts a `{ messages: Message[] }` object and returns
+     * a stream of tokens of the AI chat response. Defaults to `/api/chat`.
+     */
+    api?: string;
+    /**
+     * An unique identifier for the chat. If not provided, a random one will be
+     * generated. When provided, the `useChat` hook with the same `id` will
+     * have shared states across components.
+     */
+    id?: string;
+    /**
+     * Initial messages of the chat. Useful to load an existing chat history.
+     */
+    initialMessages?: Message[];
+    /**
+     * Initial input of the chat.
+     */
+    initialInput?: string;
+    /**
+     * Callback function to be called when the API response is received.
+     */
+    onResponse?: (response: Response) => void;
+    /**
+     * Callback function to be called when the chat is finished streaming.
+     */
+    onFinish?: (message: Message) => void;
+    /**
+     * Callback function to be called when an error is encountered.
+     */
+    onError?: (error: Error) => void;
+    /**
+     * HTTP headers to be sent with the API request.
+     */
+    headers?: Record<string, string> | Headers;
+    /**
+     * Extra body object to be sent with the API request.
+     * @example
+     * Send a `sessionId` to the API along with the messages.
+     * ```js
+     * useChat({
+     *   body: {
+     *     sessionId: '123',
+     *   }
+     * })
+     * ```
+     */
+    body?: object;
+    /**
+     * Whether to send extra message fields such as `message.id` and `message.createdAt` to the API.
+     * Defaults to `false`. When set to `true`, the API endpoint might need to
+     * handle the extra fields before forwarding the request to the AI service.
+     */
+    sendExtraMessageFields?: boolean;
+};
+type UseCompletionOptions = {
+    /**
+     * The API endpoint that accepts a `{ prompt: string }` object and returns
+     * a stream of tokens of the AI completion response. Defaults to `/api/completion`.
+     */
+    api?: string;
+    /**
+     * An unique identifier for the chat. If not provided, a random one will be
+     * generated. When provided, the `useChat` hook with the same `id` will
+     * have shared states across components.
+     */
+    id?: string;
+    /**
+     * Initial prompt input of the completion.
+     */
+    initialInput?: string;
+    /**
+     * Initial completion result. Useful to load an existing history.
+     */
+    initialCompletion?: string;
+    /**
+     * Callback function to be called when the API response is received.
+     */
+    onResponse?: (response: Response) => void;
+    /**
+     * Callback function to be called when the completion is finished streaming.
+     */
+    onFinish?: (prompt: string, completion: string) => void;
+    /**
+     * Callback function to be called when an error is encountered.
+     */
+    onError?: (error: Error) => void;
+    /**
+     * HTTP headers to be sent with the API request.
+     */
+    headers?: Record<string, string> | Headers;
+    /**
+     * Extra body object to be sent with the API request.
+     * @example
+     * Send a `sessionId` to the API along with the prompt.
+     * ```js
+     * useChat({
+     *   body: {
+     *     sessionId: '123',
+     *   }
+     * })
+     * ```
+     */
+    body?: object;
+};
+
+type UseChatHelpers = {
+    /** Current messages in the chat */
+    messages: Ref<Message[]>;
+    /** The error object of the API request */
+    error: Ref<undefined | Error>;
+    /**
+     * Append a user message to the chat list. This triggers the API call to fetch
+     * the assistant's response.
+     */
+    append: (message: Message | CreateMessage) => Promise<string | null | undefined>;
+    /**
+     * Reload the last AI chat response for the given chat history. If the last
+     * message isn't from the assistant, it will request the API to generate a
+     * new response.
+     */
+    reload: () => Promise<string | null | undefined>;
+    /**
+     * Abort the current request immediately, keep the generated tokens if any.
+     */
+    stop: () => void;
+    /**
+     * Update the `messages` state locally. This is useful when you want to
+     * edit the messages on the client, and then trigger the `reload` method
+     * manually to regenerate the AI response.
+     */
+    setMessages: (messages: Message[]) => void;
+    /** The current value of the input */
+    input: Ref<string>;
+    /** Form submission handler to automattically reset input and append a user message  */
+    handleSubmit: (e: any) => void;
+    /** Whether the API request is in progress */
+    isLoading: Ref<boolean>;
+};
+declare function useChat({ api, id, initialMessages, initialInput, sendExtraMessageFields, onResponse, onFinish, onError, headers, body }?: UseChatOptions): UseChatHelpers;
+
+type UseCompletionHelpers = {
+    /** The current completion result */
+    completion: Ref<string>;
+    /** The error object of the API request */
+    error: Ref<undefined | Error>;
+    /**
+     * Send a new prompt to the API endpoint and update the completion state.
+     */
+    complete: (prompt: string) => Promise<string | null | undefined>;
+    /**
+     * Abort the current API request but keep the generated tokens.
+     */
+    stop: () => void;
+    /**
+     * Update the `completion` state locally.
+     */
+    setCompletion: (completion: string) => void;
+    /** The current value of the input */
+    input: Ref<string>;
+    /**
+     * Form submission handler to automatically reset input and append a user message
+     * @example
+     * ```jsx
+     * <form @submit="handleSubmit">
+     *  <input @change="handleInputChange" v-model="input" />
+     * </form>
+     * ```
+     */
+    handleSubmit: (e: any) => void;
+    /** Whether the API request is in progress */
+    isLoading: Ref<boolean>;
+};
+declare function useCompletion({ api, id, initialCompletion, initialInput, headers, body, onResponse, onFinish, onError }?: UseCompletionOptions): UseCompletionHelpers;
+
+export { CreateMessage, Message, UseChatHelpers, UseChatOptions, UseCompletionHelpers, useChat, useCompletion };

package/vue/dist/index.mjs

@@ -1,10 +1,348 @@
-import {
-  useChat
-} from "./chunk-OYI6GFBM.mjs";
-import {
-  useCompletion
-} from "./chunk-FT26CHLO.mjs";
-import "./chunk-WXH4YPZV.mjs";
+var __defProp = Object.defineProperty;
+var __getOwnPropSymbols = Object.getOwnPropertySymbols;
+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 __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());
+  });
+};
+
+// vue/use-chat.ts
+import swrv from "swrv";
+import { ref } from "vue";
+
+// shared/utils.ts
+import { customAlphabet } from "nanoid";
+var nanoid = customAlphabet(
+  "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz",
+  7
+);
+var decoder = new TextDecoder();
+function decodeAIStreamChunk(chunk) {
+  return decoder.decode(chunk);
+}
+
+// vue/use-chat.ts
+var uniqueId = 0;
+var useSWRV = swrv.default || swrv;
+var store = {};
+function useChat({
+  api = "/api/chat",
+  id,
+  initialMessages = [],
+  initialInput = "",
+  sendExtraMessageFields,
+  onResponse,
+  onFinish,
+  onError,
+  headers,
+  body
+} = {}) {
+  const chatId = id || `chat-${uniqueId++}`;
+  const key = `${api}|${chatId}`;
+  const { data, mutate: originalMutate } = useSWRV(
+    key,
+    () => store[key] || initialMessages
+  );
+  data.value || (data.value = initialMessages);
+  const mutate = (data2) => {
+    store[key] = data2;
+    return originalMutate();
+  };
+  const messages = data;
+  const error = ref(void 0);
+  const isLoading = ref(false);
+  let abortController = null;
+  function triggerRequest(messagesSnapshot) {
+    return __async(this, null, function* () {
+      try {
+        isLoading.value = true;
+        abortController = new AbortController();
+        const previousMessages = messages.value;
+        mutate(messagesSnapshot);
+        const res = yield fetch(api, {
+          method: "POST",
+          body: JSON.stringify(__spreadValues({
+            messages: sendExtraMessageFields ? messagesSnapshot : messagesSnapshot.map(({ role, content }) => ({
+              role,
+              content
+            }))
+          }, body)),
+          headers: headers || {},
+          signal: abortController.signal
+        }).catch((err) => {
+          mutate(previousMessages);
+          throw err;
+        });
+        if (onResponse) {
+          try {
+            yield onResponse(res);
+          } catch (err) {
+            throw err;
+          }
+        }
+        if (!res.ok) {
+          mutate(previousMessages);
+          throw new Error(
+            (yield res.text()) || "Failed to fetch the chat response."
+          );
+        }
+        if (!res.body) {
+          throw new Error("The response body is empty.");
+        }
+        let result = "";
+        const createdAt = /* @__PURE__ */ new Date();
+        const replyId = nanoid();
+        const reader = res.body.getReader();
+        while (true) {
+          const { done, value } = yield reader.read();
+          if (done) {
+            break;
+          }
+          result += decodeAIStreamChunk(value);
+          mutate([
+            ...messagesSnapshot,
+            {
+              id: replyId,
+              createdAt,
+              content: result,
+              role: "assistant"
+            }
+          ]);
+          if (abortController === null) {
+            reader.cancel();
+            break;
+          }
+        }
+        if (onFinish) {
+          onFinish({
+            id: replyId,
+            createdAt,
+            content: result,
+            role: "assistant"
+          });
+        }
+        abortController = null;
+        return result;
+      } catch (err) {
+        if (err.name === "AbortError") {
+          abortController = null;
+          return null;
+        }
+        if (onError && err instanceof Error) {
+          onError(err);
+        }
+        error.value = err;
+      } finally {
+        isLoading.value = false;
+      }
+    });
+  }
+  const append = (message) => __async(this, null, function* () {
+    if (!message.id) {
+      message.id = nanoid();
+    }
+    return triggerRequest(messages.value.concat(message));
+  });
+  const reload = () => __async(this, null, function* () {
+    const messagesSnapshot = messages.value;
+    if (messagesSnapshot.length === 0)
+      return null;
+    const lastMessage = messagesSnapshot[messagesSnapshot.length - 1];
+    if (lastMessage.role === "assistant") {
+      return triggerRequest(messagesSnapshot.slice(0, -1));
+    }
+    return triggerRequest(messagesSnapshot);
+  });
+  const stop = () => {
+    if (abortController) {
+      abortController.abort();
+      abortController = null;
+    }
+  };
+  const setMessages = (messages2) => {
+    mutate(messages2);
+  };
+  const input = ref(initialInput);
+  const handleSubmit = (e) => {
+    e.preventDefault();
+    const inputValue = input.value;
+    if (!inputValue)
+      return;
+    append({
+      content: inputValue,
+      role: "user"
+    });
+    input.value = "";
+  };
+  return {
+    messages,
+    append,
+    error,
+    reload,
+    stop,
+    setMessages,
+    input,
+    handleSubmit,
+    isLoading
+  };
+}
+
+// vue/use-completion.ts
+import swrv2 from "swrv";
+import { ref as ref2 } from "vue";
+var uniqueId2 = 0;
+var useSWRV2 = swrv2.default || swrv2;
+var store2 = {};
+function useCompletion({
+  api = "/api/completion",
+  id,
+  initialCompletion = "",
+  initialInput = "",
+  headers,
+  body,
+  onResponse,
+  onFinish,
+  onError
+} = {}) {
+  const completionId = id || `completion-${uniqueId2++}`;
+  const key = `${api}|${completionId}`;
+  const { data, mutate: originalMutate } = useSWRV2(
+    key,
+    () => store2[key] || initialCompletion
+  );
+  data.value || (data.value = initialCompletion);
+  const mutate = (data2) => {
+    store2[key] = data2;
+    return originalMutate();
+  };
+  const completion = data;
+  const error = ref2(void 0);
+  const isLoading = ref2(false);
+  let abortController = null;
+  function triggerRequest(prompt) {
+    return __async(this, null, function* () {
+      try {
+        isLoading.value = true;
+        abortController = new AbortController();
+        mutate("");
+        const res = yield fetch(api, {
+          method: "POST",
+          body: JSON.stringify(__spreadValues({
+            prompt
+          }, body)),
+          headers: headers || {},
+          signal: abortController.signal
+        }).catch((err) => {
+          throw err;
+        });
+        if (onResponse) {
+          try {
+            yield onResponse(res);
+          } catch (err) {
+            throw err;
+          }
+        }
+        if (!res.ok) {
+          throw new Error(
+            (yield res.text()) || "Failed to fetch the chat response."
+          );
+        }
+        if (!res.body) {
+          throw new Error("The response body is empty.");
+        }
+        let result = "";
+        const reader = res.body.getReader();
+        while (true) {
+          const { done, value } = yield reader.read();
+          if (done) {
+            break;
+          }
+          result += decodeAIStreamChunk(value);
+          mutate(result);
+          if (abortController === null) {
+            reader.cancel();
+            break;
+          }
+        }
+        if (onFinish) {
+          onFinish(prompt, result);
+        }
+        abortController = null;
+        return result;
+      } catch (err) {
+        if (err.name === "AbortError") {
+          abortController = null;
+          return null;
+        }
+        if (onError && error instanceof Error) {
+          onError(error);
+        }
+        error.value = err;
+      } finally {
+        isLoading.value = false;
+      }
+    });
+  }
+  const complete = (prompt) => __async(this, null, function* () {
+    return triggerRequest(prompt);
+  });
+  const stop = () => {
+    if (abortController) {
+      abortController.abort();
+      abortController = null;
+    }
+  };
+  const setCompletion = (completion2) => {
+    mutate(completion2);
+  };
+  const input = ref2(initialInput);
+  const handleSubmit = (e) => {
+    e.preventDefault();
+    const inputValue = input.value;
+    if (!inputValue)
+      return;
+    return complete(inputValue);
+  };
+  return {
+    completion,
+    complete,
+    error,
+    stop,
+    setCompletion,
+    input,
+    handleSubmit,
+    isLoading
+  };
+}
 export {
   useChat,
   useCompletion

package/dist/ai-stream.d.ts

@@ -1,18 +0,0 @@
-interface AIStreamCallbacks {
-    onStart?: () => Promise<void>;
-    onCompletion?: (completion: string) => Promise<void>;
-    onToken?: (token: string) => Promise<void>;
-}
-interface AIStreamParser {
-    (data: string): string | void;
-}
-declare function createEventStreamTransformer(customParser: AIStreamParser): TransformStream<Uint8Array, string>;
-/**
- * This stream forks input stream, allowing us to use the result as a
- * bytestream of the messages and pass the messages to our callback interface.
- */
-declare function createCallbacksTransformer(callbacks: AIStreamCallbacks | undefined): TransformStream<string, Uint8Array>;
-declare function trimStartOfStreamHelper(): (text: string) => string;
-declare function AIStream(res: Response, customParser: AIStreamParser, callbacks?: AIStreamCallbacks): ReadableStream;
-
-export { AIStream, AIStreamCallbacks, AIStreamParser, createCallbacksTransformer, createEventStreamTransformer, trimStartOfStreamHelper };

package/dist/ai-stream.js

@@ -1,132 +0,0 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-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 __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());
-  });
-};
-
-// streams/ai-stream.ts
-var ai_stream_exports = {};
-__export(ai_stream_exports, {
-  AIStream: () => AIStream,
-  createCallbacksTransformer: () => createCallbacksTransformer,
-  createEventStreamTransformer: () => createEventStreamTransformer,
-  trimStartOfStreamHelper: () => trimStartOfStreamHelper
-});
-module.exports = __toCommonJS(ai_stream_exports);
-var import_eventsource_parser = require("eventsource-parser");
-function createEventStreamTransformer(customParser) {
-  const decoder = new TextDecoder();
-  let parser;
-  return new TransformStream({
-    start(controller) {
-      return __async(this, null, function* () {
-        function onParse(event) {
-          if (event.type === "event") {
-            const data = event.data;
-            if (data === "[DONE]") {
-              controller.terminate();
-              return;
-            }
-            const message = customParser(data);
-            if (message)
-              controller.enqueue(message);
-          }
-        }
-        parser = (0, import_eventsource_parser.createParser)(onParse);
-      });
-    },
-    transform(chunk) {
-      parser.feed(decoder.decode(chunk));
-    }
-  });
-}
-function createCallbacksTransformer(callbacks) {
-  const encoder = new TextEncoder();
-  let fullResponse = "";
-  const { onStart, onToken, onCompletion } = callbacks || {};
-  return new TransformStream({
-    start() {
-      return __async(this, null, function* () {
-        if (onStart)
-          yield onStart();
-      });
-    },
-    transform(message, controller) {
-      return __async(this, null, function* () {
-        controller.enqueue(encoder.encode(message));
-        if (onToken)
-          yield onToken(message);
-        if (onCompletion)
-          fullResponse += message;
-      });
-    },
-    flush() {
-      return __async(this, null, function* () {
-        yield onCompletion == null ? void 0 : onCompletion(fullResponse);
-      });
-    }
-  });
-}
-function trimStartOfStreamHelper() {
-  let start = true;
-  return (text) => {
-    if (start)
-      text = text.trimStart();
-    if (text)
-      start = false;
-    return text;
-  };
-}
-function AIStream(res, customParser, callbacks) {
-  if (!res.ok) {
-    throw new Error(
-      `Failed to convert the response to stream. Received status code: ${res.status}.`
-    );
-  }
-  const stream = res.body || new ReadableStream({
-    start(controller) {
-      controller.close();
-    }
-  });
-  return stream.pipeThrough(createEventStreamTransformer(customParser)).pipeThrough(createCallbacksTransformer(callbacks));
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  AIStream,
-  createCallbacksTransformer,
-  createEventStreamTransformer,
-  trimStartOfStreamHelper
-});