ai 1.1.0 → 2.0.0

package/react/dist/types-f862f74a.d.ts

@@ -0,0 +1,123 @@
+/**
+ * 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;
+};
+
+export { CreateMessage as C, Message as M, UseChatOptions as U, UseCompletionOptions as a };

package/react/dist/use-chat.d.ts

@@ -0,0 +1,42 @@
+import { M as Message, C as CreateMessage, U as UseChatOptions } from './types-f862f74a.js';
+
+type UseChatHelpers = {
+    /** Current messages in the chat */
+    messages: Message[];
+    /** The error object of the API request */
+    error: 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: string;
+    /** setState-powered method to update the input value */
+    setInput: React.Dispatch<React.SetStateAction<string>>;
+    /** An input/textarea-ready onChange handler to control the value of the input */
+    handleInputChange: (e: any) => void;
+    /** Form submission handler to automattically reset input and append a user message  */
+    handleSubmit: (e: React.FormEvent<HTMLFormElement>) => void;
+    /** Whether the API request is in progress */
+    isLoading: boolean;
+};
+declare function useChat({ api, id, initialMessages, initialInput, sendExtraMessageFields, onResponse, onFinish, onError, headers, body }?: UseChatOptions): UseChatHelpers;
+
+export { CreateMessage, Message, UseChatHelpers, UseChatOptions, useChat };

package/react/dist/use-chat.js

@@ -0,0 +1,276 @@
+'use client'
+"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());
+  });
+};
+
+// react/use-chat.ts
+var use_chat_exports = {};
+__export(use_chat_exports, {
+  useChat: () => useChat
+});
+module.exports = __toCommonJS(use_chat_exports);
+var import_react = require("react");
+var import_mutation = __toESM(require("swr/mutation"));
+var import_swr = __toESM(require("swr"));
+
+// shared/utils.ts
+var import_nanoid = require("nanoid");
+var nanoid = (0, import_nanoid.customAlphabet)(
+  "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz",
+  7
+);
+var decoder = new TextDecoder();
+function decodeAIStreamChunk(chunk) {
+  return decoder.decode(chunk);
+}
+
+// react/use-chat.ts
+function useChat({
+  api = "/api/chat",
+  id,
+  initialMessages = [],
+  initialInput = "",
+  sendExtraMessageFields,
+  onResponse,
+  onFinish,
+  onError,
+  headers,
+  body
+} = {}) {
+  const hookId = (0, import_react.useId)();
+  const chatId = id || hookId;
+  const { data, mutate } = (0, import_swr.default)([api, chatId], null, {
+    fallbackData: initialMessages
+  });
+  const messages = data;
+  const messagesRef = (0, import_react.useRef)(messages);
+  (0, import_react.useEffect)(() => {
+    messagesRef.current = messages;
+  }, [messages]);
+  const abortControllerRef = (0, import_react.useRef)(null);
+  const extraMetadataRef = (0, import_react.useRef)({
+    headers,
+    body
+  });
+  (0, import_react.useEffect)(() => {
+    extraMetadataRef.current = {
+      headers,
+      body
+    };
+  }, [headers, body]);
+  const { error, trigger, isMutating } = (0, import_mutation.default)(
+    [api, chatId],
+    (_0, _1) => __async(this, [_0, _1], function* (_, { arg: messagesSnapshot }) {
+      try {
+        const abortController = new AbortController();
+        abortControllerRef.current = abortController;
+        const previousMessages = messagesRef.current;
+        mutate(messagesSnapshot, false);
+        const res = yield fetch(api, {
+          method: "POST",
+          body: JSON.stringify(__spreadValues({
+            messages: sendExtraMessageFields ? messagesSnapshot : messagesSnapshot.map(({ role, content }) => ({
+              role,
+              content
+            }))
+          }, extraMetadataRef.current.body)),
+          headers: extraMetadataRef.current.headers || {},
+          signal: abortController.signal
+        }).catch((err) => {
+          mutate(previousMessages, false);
+          throw err;
+        });
+        if (onResponse) {
+          try {
+            yield onResponse(res);
+          } catch (err) {
+            throw err;
+          }
+        }
+        if (!res.ok) {
+          mutate(previousMessages, false);
+          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"
+              }
+            ],
+            false
+          );
+          if (abortControllerRef.current === null) {
+            reader.cancel();
+            break;
+          }
+        }
+        if (onFinish) {
+          onFinish({
+            id: replyId,
+            createdAt,
+            content: result,
+            role: "assistant"
+          });
+        }
+        abortControllerRef.current = null;
+        return result;
+      } catch (err) {
+        if (err.name === "AbortError") {
+          abortControllerRef.current = null;
+          return null;
+        }
+        if (onError && err instanceof Error) {
+          onError(err);
+        }
+        throw err;
+      }
+    }),
+    {
+      populateCache: false,
+      revalidate: false
+    }
+  );
+  const append = (0, import_react.useCallback)(
+    (message) => __async(this, null, function* () {
+      if (!message.id) {
+        message.id = nanoid();
+      }
+      return trigger(messagesRef.current.concat(message));
+    }),
+    [trigger]
+  );
+  const reload = (0, import_react.useCallback)(() => __async(this, null, function* () {
+    if (messagesRef.current.length === 0)
+      return null;
+    const lastMessage = messagesRef.current[messagesRef.current.length - 1];
+    if (lastMessage.role === "assistant") {
+      return trigger(messagesRef.current.slice(0, -1));
+    }
+    return trigger(messagesRef.current);
+  }), [trigger]);
+  const stop = (0, import_react.useCallback)(() => {
+    if (abortControllerRef.current) {
+      abortControllerRef.current.abort();
+      abortControllerRef.current = null;
+    }
+  }, []);
+  const setMessages = (0, import_react.useCallback)(
+    (messages2) => {
+      mutate(messages2, false);
+      messagesRef.current = messages2;
+    },
+    [mutate]
+  );
+  const [input, setInput] = (0, import_react.useState)(initialInput);
+  const handleSubmit = (0, import_react.useCallback)(
+    (e) => {
+      e.preventDefault();
+      if (!input)
+        return;
+      append({
+        content: input,
+        role: "user"
+      });
+      setInput("");
+    },
+    [input, append]
+  );
+  const handleInputChange = (e) => {
+    setInput(e.target.value);
+  };
+  return {
+    messages,
+    error,
+    append,
+    reload,
+    stop,
+    setMessages,
+    input,
+    setInput,
+    handleInputChange,
+    handleSubmit,
+    isLoading: isMutating
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  useChat
+});

package/react/dist/use-chat.mjs

@@ -0,0 +1,8 @@
+'use client'
+import {
+  useChat
+} from "./chunk-5PP6W52J.mjs";
+import "./chunk-6EH3SWMP.mjs";
+export {
+  useChat
+};

package/react/dist/use-completion.d.ts

@@ -0,0 +1,47 @@
+import { a as UseCompletionOptions } from './types-f862f74a.js';
+
+type UseCompletionHelpers = {
+    /** The current completion result */
+    completion: string;
+    /**
+     * Send a new prompt to the API endpoint and update the completion state.
+     */
+    complete: (prompt: string) => Promise<string | null | undefined>;
+    /** The error object of the API request */
+    error: undefined | Error;
+    /**
+     * 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: string;
+    /** setState-powered method to update the input value */
+    setInput: React.Dispatch<React.SetStateAction<string>>;
+    /**
+     * An input/textarea-ready onChange handler to control the value of the input
+     * @example
+     * ```jsx
+     * <input onChange={handleInputChange} value={input} />
+     * ```
+     */
+    handleInputChange: (e: any) => void;
+    /**
+     * Form submission handler to automattically reset input and append a user message
+     * @example
+     * ```jsx
+     * <form onSubmit={handleSubmit}>
+     *  <input onChange={handleInputChange} value={input} />
+     * </form>
+     * ```
+     */
+    handleSubmit: (e: React.FormEvent<HTMLFormElement>) => void;
+    /** Whether the API request is in progress */
+    isLoading: boolean;
+};
+declare function useCompletion({ api, id, initialCompletion, initialInput, headers, body, onResponse, onFinish, onError }?: UseCompletionOptions): UseCompletionHelpers;
+
+export { UseCompletionHelpers, useCompletion };