@ai-sdk/react 4.0.0-beta.9 → 4.0.0-beta.91

package/dist/index.d.mts

@@ -1,178 +0,0 @@
-import { UIMessage, AbstractChat, ChatInit, CompletionRequestOptions, UseCompletionOptions, DeepPartial } from 'ai';
-export { CreateUIMessage, UIMessage, UseCompletionOptions } from 'ai';
-import { FlexibleSchema, FetchFunction, Resolvable, InferSchema } from '@ai-sdk/provider-utils';
-
-declare class Chat<UI_MESSAGE extends UIMessage> extends AbstractChat<UI_MESSAGE> {
-    #private;
-    constructor({ messages, ...init }: ChatInit<UI_MESSAGE>);
-    '~registerMessagesCallback': (onChange: () => void, throttleWaitMs?: number) => (() => void);
-    '~registerStatusCallback': (onChange: () => void) => (() => void);
-    '~registerErrorCallback': (onChange: () => void) => (() => void);
-}
-
-type UseChatHelpers<UI_MESSAGE extends UIMessage> = {
-    /**
-     * The id of the chat.
-     */
-    readonly id: string;
-    /**
-     * 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: UI_MESSAGE[] | ((messages: UI_MESSAGE[]) => UI_MESSAGE[])) => void;
-    error: Error | undefined;
-} & Pick<AbstractChat<UI_MESSAGE>, 'sendMessage' | 'regenerate' | 'stop' | 'resumeStream' | 'addToolResult' | 'addToolOutput' | 'addToolApprovalResponse' | 'status' | 'messages' | 'clearError'>;
-type UseChatOptions<UI_MESSAGE extends UIMessage> = ({
-    chat: Chat<UI_MESSAGE>;
-} | ChatInit<UI_MESSAGE>) & {
-    /**
-     * Custom throttle wait in ms for the chat messages and data updates.
-     * Default is undefined, which disables throttling.
-     */
-    experimental_throttle?: number;
-    /**
-     * Whether to resume an ongoing chat generation stream.
-     */
-    resume?: boolean;
-};
-declare function useChat<UI_MESSAGE extends UIMessage = UIMessage>({ experimental_throttle: throttleWaitMs, resume, ...options }?: UseChatOptions<UI_MESSAGE>): UseChatHelpers<UI_MESSAGE>;
-
-type UseCompletionHelpers = {
-    /** The current completion result */
-    completion: string;
-    /**
-     * Send a new prompt to the API endpoint and update the completion state.
-     */
-    complete: (prompt: string, options?: CompletionRequestOptions) => 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: (event: React.ChangeEvent<HTMLInputElement> | React.ChangeEvent<HTMLTextAreaElement>) => void;
-    /**
-     * Form submission handler to automatically reset input and append a user message
-     * @example
-     * ```jsx
-     * <form onSubmit={handleSubmit}>
-     *  <input onChange={handleInputChange} value={input} />
-     * </form>
-     * ```
-     */
-    handleSubmit: (event?: {
-        preventDefault?: () => void;
-    }) => void;
-    /** Whether the API request is in progress */
-    isLoading: boolean;
-};
-declare function useCompletion({ api, id, initialCompletion, initialInput, credentials, headers, body, streamProtocol, fetch, onFinish, onError, experimental_throttle: throttleWaitMs, }?: UseCompletionOptions & {
-    /**
-     * Custom throttle wait in ms for the completion and data updates.
-     * Default is undefined, which disables throttling.
-     */
-    experimental_throttle?: number;
-}): UseCompletionHelpers;
-
-type Experimental_UseObjectOptions<SCHEMA extends FlexibleSchema, RESULT> = {
-    /**
-     * The API endpoint. It should stream JSON that matches the schema as chunked text.
-     */
-    api: string;
-    /**
-     * A schema that defines the shape of the complete object.
-     */
-    schema: SCHEMA;
-    /**
-     * An unique identifier. If not provided, a random one will be
-     * generated. When provided, the `useObject` hook with the same `id` will
-     * have shared states across components.
-     */
-    id?: string;
-    /**
-     * An optional value for the initial object.
-     */
-    initialValue?: DeepPartial<RESULT>;
-    /**
-     * Custom fetch implementation. You can use it as a middleware to intercept requests,
-     * or to provide a custom fetch implementation for e.g. testing.
-     */
-    fetch?: FetchFunction;
-    /**
-     * Callback that is called when the stream has finished.
-     */
-    onFinish?: (event: {
-        /**
-         * The generated object (typed according to the schema).
-         * Can be undefined if the final object does not match the schema.
-         */
-        object: RESULT | undefined;
-        /**
-         * Optional error object. This is e.g. a TypeValidationError when the final object does not match the schema.
-         */
-        error: Error | undefined;
-    }) => Promise<void> | void;
-    /**
-     * Callback function to be called when an error is encountered.
-     */
-    onError?: (error: Error) => void;
-    /**
-     * Additional HTTP headers to be included in the request.
-     * Can be a static object, a function that returns headers, or an async function
-     * for dynamic auth tokens.
-     */
-    headers?: Resolvable<Record<string, string> | Headers>;
-    /**
-     * The credentials mode to be used for the fetch request.
-     * Possible values are: 'omit', 'same-origin', 'include'.
-     * Defaults to 'same-origin'.
-     */
-    credentials?: RequestCredentials;
-};
-type Experimental_UseObjectHelpers<RESULT, INPUT> = {
-    /**
-     * Calls the API with the provided input as JSON body.
-     */
-    submit: (input: INPUT) => void;
-    /**
-     * The current value for the generated object. Updated as the API streams JSON chunks.
-     */
-    object: DeepPartial<RESULT> | undefined;
-    /**
-     * The error object of the API request if any.
-     */
-    error: Error | undefined;
-    /**
-     * Flag that indicates whether an API request is in progress.
-     */
-    isLoading: boolean;
-    /**
-     * Abort the current request immediately, keep the current partial object if any.
-     */
-    stop: () => void;
-    /**
-     * Clear the object state.
-     */
-    clear: () => void;
-};
-declare function useObject<SCHEMA extends FlexibleSchema, RESULT = InferSchema<SCHEMA>, INPUT = any>({ api, id, schema, // required, in the future we will use it for validation
-initialValue, fetch, onError, onFinish, headers, credentials, }: Experimental_UseObjectOptions<SCHEMA, RESULT>): Experimental_UseObjectHelpers<RESULT, INPUT>;
-declare const experimental_useObject: typeof useObject;
-
-export { Chat, Experimental_UseObjectHelpers, Experimental_UseObjectOptions, UseChatHelpers, UseChatOptions, UseCompletionHelpers, experimental_useObject, useChat, useCompletion };

package/dist/index.mjs

@@ -1,506 +0,0 @@
-var __accessCheck = (obj, member, msg) => {
-  if (!member.has(obj))
-    throw TypeError("Cannot " + msg);
-};
-var __privateGet = (obj, member, getter) => {
-  __accessCheck(obj, member, "read from private field");
-  return getter ? getter.call(obj) : member.get(obj);
-};
-var __privateAdd = (obj, member, value) => {
-  if (member.has(obj))
-    throw TypeError("Cannot add the same private member more than once");
-  member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
-};
-var __privateSet = (obj, member, value, setter) => {
-  __accessCheck(obj, member, "write to private field");
-  setter ? setter.call(obj, value) : member.set(obj, value);
-  return value;
-};
-
-// src/use-chat.ts
-import { useCallback, useEffect, useRef, useSyncExternalStore } from "react";
-
-// src/chat.react.ts
-import { AbstractChat } from "ai";
-
-// src/throttle.ts
-import throttleFunction from "throttleit";
-function throttle(fn, waitMs) {
-  return waitMs != null ? throttleFunction(fn, waitMs) : fn;
-}
-
-// src/chat.react.ts
-var _messages, _status, _error, _messagesCallbacks, _statusCallbacks, _errorCallbacks, _callMessagesCallbacks, _callStatusCallbacks, _callErrorCallbacks;
-var ReactChatState = class {
-  constructor(initialMessages = []) {
-    __privateAdd(this, _messages, void 0);
-    __privateAdd(this, _status, "ready");
-    __privateAdd(this, _error, void 0);
-    __privateAdd(this, _messagesCallbacks, /* @__PURE__ */ new Set());
-    __privateAdd(this, _statusCallbacks, /* @__PURE__ */ new Set());
-    __privateAdd(this, _errorCallbacks, /* @__PURE__ */ new Set());
-    this.pushMessage = (message) => {
-      __privateSet(this, _messages, __privateGet(this, _messages).concat(message));
-      __privateGet(this, _callMessagesCallbacks).call(this);
-    };
-    this.popMessage = () => {
-      __privateSet(this, _messages, __privateGet(this, _messages).slice(0, -1));
-      __privateGet(this, _callMessagesCallbacks).call(this);
-    };
-    this.replaceMessage = (index, message) => {
-      __privateSet(this, _messages, [
-        ...__privateGet(this, _messages).slice(0, index),
-        // We deep clone the message here to ensure the new React Compiler (currently in RC) detects deeply nested parts/metadata changes:
-        this.snapshot(message),
-        ...__privateGet(this, _messages).slice(index + 1)
-      ]);
-      __privateGet(this, _callMessagesCallbacks).call(this);
-    };
-    this.snapshot = (value) => structuredClone(value);
-    this["~registerMessagesCallback"] = (onChange, throttleWaitMs) => {
-      const callback = throttleWaitMs ? throttle(onChange, throttleWaitMs) : onChange;
-      __privateGet(this, _messagesCallbacks).add(callback);
-      return () => {
-        __privateGet(this, _messagesCallbacks).delete(callback);
-      };
-    };
-    this["~registerStatusCallback"] = (onChange) => {
-      __privateGet(this, _statusCallbacks).add(onChange);
-      return () => {
-        __privateGet(this, _statusCallbacks).delete(onChange);
-      };
-    };
-    this["~registerErrorCallback"] = (onChange) => {
-      __privateGet(this, _errorCallbacks).add(onChange);
-      return () => {
-        __privateGet(this, _errorCallbacks).delete(onChange);
-      };
-    };
-    __privateAdd(this, _callMessagesCallbacks, () => {
-      __privateGet(this, _messagesCallbacks).forEach((callback) => callback());
-    });
-    __privateAdd(this, _callStatusCallbacks, () => {
-      __privateGet(this, _statusCallbacks).forEach((callback) => callback());
-    });
-    __privateAdd(this, _callErrorCallbacks, () => {
-      __privateGet(this, _errorCallbacks).forEach((callback) => callback());
-    });
-    __privateSet(this, _messages, initialMessages);
-  }
-  get status() {
-    return __privateGet(this, _status);
-  }
-  set status(newStatus) {
-    __privateSet(this, _status, newStatus);
-    __privateGet(this, _callStatusCallbacks).call(this);
-  }
-  get error() {
-    return __privateGet(this, _error);
-  }
-  set error(newError) {
-    __privateSet(this, _error, newError);
-    __privateGet(this, _callErrorCallbacks).call(this);
-  }
-  get messages() {
-    return __privateGet(this, _messages);
-  }
-  set messages(newMessages) {
-    __privateSet(this, _messages, [...newMessages]);
-    __privateGet(this, _callMessagesCallbacks).call(this);
-  }
-};
-_messages = new WeakMap();
-_status = new WeakMap();
-_error = new WeakMap();
-_messagesCallbacks = new WeakMap();
-_statusCallbacks = new WeakMap();
-_errorCallbacks = new WeakMap();
-_callMessagesCallbacks = new WeakMap();
-_callStatusCallbacks = new WeakMap();
-_callErrorCallbacks = new WeakMap();
-var _state;
-var Chat = class extends AbstractChat {
-  constructor({ messages, ...init }) {
-    const state = new ReactChatState(messages);
-    super({ ...init, state });
-    __privateAdd(this, _state, void 0);
-    this["~registerMessagesCallback"] = (onChange, throttleWaitMs) => __privateGet(this, _state)["~registerMessagesCallback"](onChange, throttleWaitMs);
-    this["~registerStatusCallback"] = (onChange) => __privateGet(this, _state)["~registerStatusCallback"](onChange);
-    this["~registerErrorCallback"] = (onChange) => __privateGet(this, _state)["~registerErrorCallback"](onChange);
-    __privateSet(this, _state, state);
-  }
-};
-_state = new WeakMap();
-
-// src/use-chat.ts
-function useChat({
-  experimental_throttle: throttleWaitMs,
-  resume = false,
-  ...options
-} = {}) {
-  const callbacksRef = useRef(
-    !("chat" in options) ? {
-      onToolCall: options.onToolCall,
-      onData: options.onData,
-      onFinish: options.onFinish,
-      onError: options.onError,
-      sendAutomaticallyWhen: options.sendAutomaticallyWhen
-    } : {}
-  );
-  if (!("chat" in options)) {
-    callbacksRef.current = {
-      onToolCall: options.onToolCall,
-      onData: options.onData,
-      onFinish: options.onFinish,
-      onError: options.onError,
-      sendAutomaticallyWhen: options.sendAutomaticallyWhen
-    };
-  }
-  const optionsWithCallbacks = {
-    ...options,
-    onToolCall: (arg) => {
-      var _a, _b;
-      return (_b = (_a = callbacksRef.current).onToolCall) == null ? void 0 : _b.call(_a, arg);
-    },
-    onData: (arg) => {
-      var _a, _b;
-      return (_b = (_a = callbacksRef.current).onData) == null ? void 0 : _b.call(_a, arg);
-    },
-    onFinish: (arg) => {
-      var _a, _b;
-      return (_b = (_a = callbacksRef.current).onFinish) == null ? void 0 : _b.call(_a, arg);
-    },
-    onError: (arg) => {
-      var _a, _b;
-      return (_b = (_a = callbacksRef.current).onError) == null ? void 0 : _b.call(_a, arg);
-    },
-    sendAutomaticallyWhen: (arg) => {
-      var _a, _b, _c;
-      return (_c = (_b = (_a = callbacksRef.current).sendAutomaticallyWhen) == null ? void 0 : _b.call(_a, arg)) != null ? _c : false;
-    }
-  };
-  const chatRef = useRef(
-    "chat" in options ? options.chat : new Chat(optionsWithCallbacks)
-  );
-  const shouldRecreateChat = "chat" in options && options.chat !== chatRef.current || "id" in options && chatRef.current.id !== options.id;
-  if (shouldRecreateChat) {
-    chatRef.current = "chat" in options ? options.chat : new Chat(optionsWithCallbacks);
-  }
-  const subscribeToMessages = useCallback(
-    (update) => chatRef.current["~registerMessagesCallback"](update, throttleWaitMs),
-    // `chatRef.current.id` is required to trigger re-subscription when the chat ID changes
-    // eslint-disable-next-line react-hooks/exhaustive-deps
-    [throttleWaitMs, chatRef.current.id]
-  );
-  const messages = useSyncExternalStore(
-    subscribeToMessages,
-    () => chatRef.current.messages,
-    () => chatRef.current.messages
-  );
-  const status = useSyncExternalStore(
-    chatRef.current["~registerStatusCallback"],
-    () => chatRef.current.status,
-    () => chatRef.current.status
-  );
-  const error = useSyncExternalStore(
-    chatRef.current["~registerErrorCallback"],
-    () => chatRef.current.error,
-    () => chatRef.current.error
-  );
-  const setMessages = useCallback(
-    (messagesParam) => {
-      if (typeof messagesParam === "function") {
-        messagesParam = messagesParam(chatRef.current.messages);
-      }
-      chatRef.current.messages = messagesParam;
-    },
-    [chatRef]
-  );
-  useEffect(() => {
-    if (resume) {
-      chatRef.current.resumeStream();
-    }
-  }, [resume, chatRef]);
-  return {
-    id: chatRef.current.id,
-    messages,
-    setMessages,
-    sendMessage: chatRef.current.sendMessage,
-    regenerate: chatRef.current.regenerate,
-    clearError: chatRef.current.clearError,
-    stop: chatRef.current.stop,
-    error,
-    resumeStream: chatRef.current.resumeStream,
-    status,
-    /**
-     * @deprecated Use `addToolOutput` instead.
-     */
-    addToolResult: chatRef.current.addToolOutput,
-    addToolOutput: chatRef.current.addToolOutput,
-    addToolApprovalResponse: chatRef.current.addToolApprovalResponse
-  };
-}
-
-// src/use-completion.ts
-import {
-  callCompletionApi
-} from "ai";
-import { useCallback as useCallback2, useEffect as useEffect2, useId, useRef as useRef2, useState } from "react";
-import useSWR from "swr";
-function useCompletion({
-  api = "/api/completion",
-  id,
-  initialCompletion = "",
-  initialInput = "",
-  credentials,
-  headers,
-  body,
-  streamProtocol = "data",
-  fetch: fetch2,
-  onFinish,
-  onError,
-  experimental_throttle: throttleWaitMs
-} = {}) {
-  const hookId = useId();
-  const completionId = id || hookId;
-  const { data, mutate } = useSWR([api, completionId], null, {
-    fallbackData: initialCompletion
-  });
-  const { data: isLoading = false, mutate: mutateLoading } = useSWR(
-    [completionId, "loading"],
-    null
-  );
-  const [error, setError] = useState(void 0);
-  const completion = data;
-  const [abortController, setAbortController] = useState(null);
-  const extraMetadataRef = useRef2({
-    credentials,
-    headers,
-    body
-  });
-  useEffect2(() => {
-    extraMetadataRef.current = {
-      credentials,
-      headers,
-      body
-    };
-  }, [credentials, headers, body]);
-  const triggerRequest = useCallback2(
-    async (prompt, options) => callCompletionApi({
-      api,
-      prompt,
-      credentials: extraMetadataRef.current.credentials,
-      headers: { ...extraMetadataRef.current.headers, ...options == null ? void 0 : options.headers },
-      body: {
-        ...extraMetadataRef.current.body,
-        ...options == null ? void 0 : options.body
-      },
-      streamProtocol,
-      fetch: fetch2,
-      // throttle streamed ui updates:
-      setCompletion: throttle(
-        (completion2) => mutate(completion2, false),
-        throttleWaitMs
-      ),
-      setLoading: mutateLoading,
-      setError,
-      setAbortController,
-      onFinish,
-      onError
-    }),
-    [
-      mutate,
-      mutateLoading,
-      api,
-      extraMetadataRef,
-      setAbortController,
-      onFinish,
-      onError,
-      setError,
-      streamProtocol,
-      fetch2,
-      throttleWaitMs
-    ]
-  );
-  const stop = useCallback2(() => {
-    if (abortController) {
-      abortController.abort();
-      setAbortController(null);
-    }
-  }, [abortController]);
-  const setCompletion = useCallback2(
-    (completion2) => {
-      mutate(completion2, false);
-    },
-    [mutate]
-  );
-  const complete = useCallback2(
-    async (prompt, options) => {
-      return triggerRequest(prompt, options);
-    },
-    [triggerRequest]
-  );
-  const [input, setInput] = useState(initialInput);
-  const handleSubmit = useCallback2(
-    (event) => {
-      var _a;
-      (_a = event == null ? void 0 : event.preventDefault) == null ? void 0 : _a.call(event);
-      return input ? complete(input) : void 0;
-    },
-    [input, complete]
-  );
-  const handleInputChange = useCallback2(
-    (e) => {
-      setInput(e.target.value);
-    },
-    [setInput]
-  );
-  return {
-    completion,
-    complete,
-    error,
-    setCompletion,
-    stop,
-    input,
-    setInput,
-    handleInputChange,
-    handleSubmit,
-    isLoading
-  };
-}
-
-// src/use-object.ts
-import {
-  isAbortError,
-  resolve,
-  normalizeHeaders,
-  safeValidateTypes
-} from "@ai-sdk/provider-utils";
-import { asSchema, isDeepEqualData, parsePartialJson } from "ai";
-import { useCallback as useCallback3, useId as useId2, useRef as useRef3, useState as useState2 } from "react";
-import useSWR2 from "swr";
-var getOriginalFetch = () => fetch;
-function useObject({
-  api,
-  id,
-  schema,
-  // required, in the future we will use it for validation
-  initialValue,
-  fetch: fetch2,
-  onError,
-  onFinish,
-  headers,
-  credentials
-}) {
-  const hookId = useId2();
-  const completionId = id != null ? id : hookId;
-  const { data, mutate } = useSWR2(
-    [api, completionId],
-    null,
-    { fallbackData: initialValue }
-  );
-  const [error, setError] = useState2(void 0);
-  const [isLoading, setIsLoading] = useState2(false);
-  const abortControllerRef = useRef3(null);
-  const stop = useCallback3(() => {
-    var _a;
-    try {
-      (_a = abortControllerRef.current) == null ? void 0 : _a.abort();
-    } catch (ignored) {
-    } finally {
-      setIsLoading(false);
-      abortControllerRef.current = null;
-    }
-  }, []);
-  const submit = async (input) => {
-    var _a;
-    try {
-      clearObject();
-      setIsLoading(true);
-      const abortController = new AbortController();
-      abortControllerRef.current = abortController;
-      const resolvedHeaders = await resolve(headers);
-      const actualFetch = fetch2 != null ? fetch2 : getOriginalFetch();
-      const response = await actualFetch(api, {
-        method: "POST",
-        headers: {
-          "Content-Type": "application/json",
-          ...normalizeHeaders(resolvedHeaders)
-        },
-        credentials,
-        signal: abortController.signal,
-        body: JSON.stringify(input)
-      });
-      if (!response.ok) {
-        throw new Error(
-          (_a = await response.text()) != null ? _a : "Failed to fetch the response."
-        );
-      }
-      if (response.body == null) {
-        throw new Error("The response body is empty.");
-      }
-      let accumulatedText = "";
-      let latestObject = void 0;
-      await response.body.pipeThrough(new TextDecoderStream()).pipeTo(
-        new WritableStream({
-          async write(chunk) {
-            accumulatedText += chunk;
-            const { value } = await parsePartialJson(accumulatedText);
-            const currentObject = value;
-            if (!isDeepEqualData(latestObject, currentObject)) {
-              latestObject = currentObject;
-              mutate(currentObject);
-            }
-          },
-          async close() {
-            setIsLoading(false);
-            abortControllerRef.current = null;
-            if (onFinish != null) {
-              const validationResult = await safeValidateTypes({
-                value: latestObject,
-                schema: asSchema(schema)
-              });
-              onFinish(
-                validationResult.success ? { object: validationResult.value, error: void 0 } : { object: void 0, error: validationResult.error }
-              );
-            }
-          }
-        })
-      );
-    } catch (error2) {
-      if (isAbortError(error2)) {
-        return;
-      }
-      if (onError && error2 instanceof Error) {
-        onError(error2);
-      }
-      setIsLoading(false);
-      setError(error2 instanceof Error ? error2 : new Error(String(error2)));
-    }
-  };
-  const clear = () => {
-    stop();
-    clearObject();
-  };
-  const clearObject = () => {
-    setError(void 0);
-    setIsLoading(false);
-    mutate(void 0);
-  };
-  return {
-    submit,
-    object: data,
-    error,
-    isLoading,
-    stop,
-    clear
-  };
-}
-var experimental_useObject = useObject;
-export {
-  Chat,
-  experimental_useObject,
-  useChat,
-  useCompletion
-};
-//# sourceMappingURL=index.mjs.map