@assistant-ui/core 0.3.4 → 0.3.6

package/src/index.ts

@@ -326,7 +326,10 @@ export type { ExternalStoreSharedOptions } from "./runtimes/external-store/exter
 export { pickExternalStoreSharedOptions } from "./runtimes/external-store/external-store-shared-options";
 
 // Message queue
-export type { ExternalThreadQueueAdapter } from "./runtime/queue/external-thread-queue-adapter";
+export type {
+  ExternalThreadQueueAdapter,
+  QueuePlacement,
+} from "./runtime/queue/external-thread-queue-adapter";
 export type { ExternalThreadBranchAdapter } from "./runtime/branch/external-thread-branch-adapter";
 export {
   createMessageQueue,
@@ -338,6 +341,7 @@ export {
 export type {
   RemoteThreadListAdapter,
   RemoteThreadListOptions,
+  RemoteThreadListProviderComponent,
   RemoteThreadInitializeResponse,
   RemoteThreadMetadata,
   RemoteThreadListResponse,

package/src/react/AssistantProvider.tsx

@@ -4,7 +4,11 @@ import {
   type FC,
   type PropsWithChildren,
 } from "react";
-import { useAui, AuiProvider, type AssistantClient } from "@assistant-ui/store";
+import {
+  AuiConfig,
+  AuiProvider,
+  type AssistantClient,
+} from "@assistant-ui/store";
 import type { AssistantRuntime } from "../runtime/api/assistant-runtime";
 import type { AssistantRuntimeCore } from "../runtime/interfaces/assistant-runtime-core";
 import { RuntimeAdapter } from "./RuntimeAdapter";
@@ -16,12 +20,17 @@ export const getRenderComponent = (runtime: AssistantRuntime) => {
 
 export type AssistantProviderBaseProps = PropsWithChildren<{
   runtime: AssistantRuntime;
-  aui?: AssistantClient | null;
+  aui?: AssistantClient | null | undefined;
+  config?: AuiConfig | undefined;
 }>;
 
 const AssistantProviderInner: FC<
-  PropsWithChildren<{ runtime: AssistantRuntime }>
-> = ({ runtime, children }) => {
+  PropsWithChildren<{
+    runtime: AssistantRuntime;
+    aui: AssistantClient | null;
+    config: AuiConfig | undefined;
+  }>
+> = ({ runtime, aui, config, children }) => {
   // The runtime has a stable identity but mutates in place: its options are
   // pushed in by an unconditional effect inside <RenderComponent />, so that
   // element must be re-created every commit for React to re-render it and
@@ -29,10 +38,10 @@ const AssistantProviderInner: FC<
   // stable RenderComponent type, which silences the effect and stops option
   // changes (e.g. unstable_enableMessageQueue) from reaching the runtime.
   "use no memo";
-  const aui = useAui({ threads: RuntimeAdapter(runtime) });
   const RenderComponent = getRenderComponent(runtime);
+  const merged = AuiConfig({ ...config, threads: RuntimeAdapter(runtime) });
   return (
-    <AuiProvider value={aui}>
+    <AuiProvider extends={aui} config={merged}>
       {RenderComponent && <RenderComponent />}
       {children}
     </AuiProvider>
@@ -40,16 +49,9 @@ const AssistantProviderInner: FC<
 };
 
 export const AssistantProviderBase: FC<AssistantProviderBaseProps> = memo(
-  ({ runtime, aui = null, children }) => {
-    const inner = (
-      <AssistantProviderInner runtime={runtime}>
-        {children}
-      </AssistantProviderInner>
-    );
-    return aui ? (
-      <AuiProvider value={aui}>{inner}</AuiProvider>
-    ) : (
-      <AuiProvider value={null}>{inner}</AuiProvider>
-    );
-  },
+  ({ runtime, aui = null, config, children }) => (
+    <AssistantProviderInner runtime={runtime} aui={aui} config={config}>
+      {children}
+    </AssistantProviderInner>
+  ),
 );

package/src/react/AssistantRuntimeProvider.test.tsx

@@ -5,7 +5,12 @@ import { useEffect } from "react";
 import { cleanup, render } from "@testing-library/react";
 import { afterEach, describe, expect, it } from "vitest";
 import { resource } from "@assistant-ui/tap";
-import { AuiProvider, useAui, type AssistantClient } from "@assistant-ui/store";
+import {
+  AuiConfig,
+  AuiProvider,
+  useAui,
+  type AssistantClient,
+} from "@assistant-ui/store";
 import type { ChatModelAdapter } from "../runtime/utils/chat-model-adapter";
 import { AssistantRuntimeProvider } from "./AssistantRuntimeProvider";
 import { useLocalRuntime } from "./runtimes/useLocalRuntime";
@@ -98,4 +103,53 @@ describe("AssistantRuntimeProvider aui composition", () => {
     expect(aui.parentScope.getState()).toEqual({ count: 0 });
     expect(log).toEqual(["parent tap effect", "consumer effect"]);
   });
+
+  it("provides config scopes alongside the runtime scope", () => {
+    let aui!: AnyClient;
+    const Consumer = () => {
+      aui = useAui();
+      return null;
+    };
+
+    const App = () => {
+      const runtime = useLocalRuntime(chatModel);
+      const config = AuiConfig({
+        extraScope: makeCounterClient()(),
+      } as unknown as AuiConfig.Input);
+      return (
+        <AssistantRuntimeProvider runtime={runtime} config={config}>
+          <Consumer />
+        </AssistantRuntimeProvider>
+      );
+    };
+
+    render(<App />);
+
+    expect(aui.threads).toBeDefined();
+    expect(aui.extraScope.getState()).toEqual({ count: 0 });
+  });
+
+  it("keeps the runtime's threads scope when config carries a threads key", () => {
+    let aui!: AnyClient;
+    const Consumer = () => {
+      aui = useAui();
+      return null;
+    };
+
+    const App = () => {
+      const runtime = useLocalRuntime(chatModel);
+      const config = AuiConfig({
+        threads: makeCounterClient()(),
+      } as unknown as AuiConfig.Input);
+      return (
+        <AssistantRuntimeProvider runtime={runtime} config={config}>
+          <Consumer />
+        </AssistantRuntimeProvider>
+      );
+    };
+
+    render(<App />);
+
+    expect(aui.threads.getState().main).toBeDefined();
+  });
 });

package/src/react/AssistantRuntimeProvider.tsx

@@ -1,5 +1,5 @@
 import { type ReactNode, memo } from "react";
-import type { AssistantClient } from "@assistant-ui/store";
+import type { AssistantClient, AuiConfig } from "@assistant-ui/store";
 import type { AssistantRuntime } from "../runtime/api/assistant-runtime";
 import { AssistantProviderBase } from "./AssistantProvider";
 
@@ -29,6 +29,7 @@ export const AssistantRuntimeProvider = memo(
   ({
     runtime,
     aui,
+    config,
     children,
   }: {
     /**
@@ -44,10 +45,19 @@ export const AssistantRuntimeProvider = memo(
      * @defaultValue null
      */
     aui?: AssistantClient | null;
+    /**
+     * Optional extra scopes provided alongside the runtime's `threads`
+     * scope; build with `AuiConfig`.
+     */
+    config?: AuiConfig;
     children: ReactNode;
   }) => {
     return (
-      <AssistantProviderBase runtime={runtime} aui={aui ?? null}>
+      <AssistantProviderBase
+        runtime={runtime}
+        aui={aui ?? null}
+        config={config}
+      >
         {children}
       </AssistantProviderBase>
     );

package/src/react/providers/AttachmentByIndexProvider.tsx

@@ -1,20 +1,24 @@
 import type { FC, PropsWithChildren } from "react";
-import { useAui, AuiProvider, Derived } from "@assistant-ui/store";
+import { useAui, AuiConfig, AuiProvider, Derived } from "@assistant-ui/store";
 
 export const MessageAttachmentByIndexProvider: FC<
   PropsWithChildren<{
     index: number;
   }>
 > = ({ index, children }) => {
-  const aui = useAui({
+  const aui = useAui();
+  const config = AuiConfig({
     attachment: Derived({
       source: "message",
       query: { type: "index", index },
       get: (aui) => aui.message.attachment({ index }),
     }),
   });
-
-  return <AuiProvider value={aui}>{children}</AuiProvider>;
+  return (
+    <AuiProvider extends={aui} config={config}>
+      {children}
+    </AuiProvider>
+  );
 };
 
 export const ComposerAttachmentByIndexProvider: FC<
@@ -22,13 +26,17 @@ export const ComposerAttachmentByIndexProvider: FC<
     index: number;
   }>
 > = ({ index, children }) => {
-  const aui = useAui({
+  const aui = useAui();
+  const config = AuiConfig({
     attachment: Derived({
       source: "composer",
       query: { type: "index", index },
       get: (aui) => aui.composer.attachment({ index }),
     }),
   });
-
-  return <AuiProvider value={aui}>{children}</AuiProvider>;
+  return (
+    <AuiProvider extends={aui} config={config}>
+      {children}
+    </AuiProvider>
+  );
 };

package/src/react/providers/ChainOfThoughtByIndicesProvider.tsx

@@ -1,5 +1,10 @@
 import type { FC, PropsWithChildren } from "react";
-import { useAui, useAuiState, AuiProvider } from "@assistant-ui/store";
+import {
+  useAui,
+  useAuiState,
+  AuiConfig,
+  AuiProvider,
+} from "@assistant-ui/store";
 import { ChainOfThoughtClient } from "../../store/clients/chain-of-thought-client";
 import type { ChainOfThoughtPart } from "../../store/scopes/chain-of-thought";
 
@@ -16,7 +21,7 @@ export const ChainOfThoughtByIndicesProvider: FC<
 
   const parentAui = useAui();
 
-  const aui = useAui({
+  const config = AuiConfig({
     chainOfThought: ChainOfThoughtClient({
       parts,
       getMessagePart: ({ index }) => {
@@ -29,6 +34,9 @@ export const ChainOfThoughtByIndicesProvider: FC<
       },
     }),
   });
-
-  return <AuiProvider value={aui}>{children}</AuiProvider>;
+  return (
+    <AuiProvider extends={parentAui} config={config}>
+      {children}
+    </AuiProvider>
+  );
 };

package/src/react/providers/ChainOfThoughtPartByIndexProvider.tsx

@@ -1,18 +1,22 @@
 import type { FC, PropsWithChildren } from "react";
-import { useAui, AuiProvider, Derived } from "@assistant-ui/store";
+import { useAui, AuiConfig, AuiProvider, Derived } from "@assistant-ui/store";
 
 export const ChainOfThoughtPartByIndexProvider: FC<
   PropsWithChildren<{
     index: number;
   }>
 > = ({ index, children }) => {
-  const aui = useAui({
+  const aui = useAui();
+  const config = AuiConfig({
     part: Derived({
       source: "chainOfThought",
       query: { type: "index", index },
       get: (aui) => aui.chainOfThought.part({ index }),
     }),
   });
-
-  return <AuiProvider value={aui}>{children}</AuiProvider>;
+  return (
+    <AuiProvider extends={aui} config={config}>
+      {children}
+    </AuiProvider>
+  );
 };

package/src/react/providers/MessageByIdProvider.tsx

@@ -1,12 +1,13 @@
 import type { FC, PropsWithChildren } from "react";
-import { useAui, AuiProvider, Derived } from "@assistant-ui/store";
+import { useAui, AuiConfig, AuiProvider, Derived } from "@assistant-ui/store";
 
 export const MessageByIdProvider: FC<
   PropsWithChildren<{
     id: string;
   }>
 > = ({ id, children }) => {
-  const aui = useAui({
+  const aui = useAui();
+  const config = AuiConfig({
     message: Derived({
       source: "thread",
       query: { type: "id", id },
@@ -18,6 +19,9 @@ export const MessageByIdProvider: FC<
       get: (aui) => aui.thread.message({ id }).composer(),
     }),
   });
-
-  return <AuiProvider value={aui}>{children}</AuiProvider>;
+  return (
+    <AuiProvider extends={aui} config={config}>
+      {children}
+    </AuiProvider>
+  );
 };

package/src/react/providers/MessageByIndexProvider.tsx

@@ -1,12 +1,13 @@
 import type { FC, PropsWithChildren } from "react";
-import { useAui, AuiProvider, Derived } from "@assistant-ui/store";
+import { useAui, AuiConfig, AuiProvider, Derived } from "@assistant-ui/store";
 
 export const MessageByIndexProvider: FC<
   PropsWithChildren<{
     index: number;
   }>
 > = ({ index, children }) => {
-  const aui = useAui({
+  const aui = useAui();
+  const config = AuiConfig({
     message: Derived({
       source: "thread",
       query: { type: "index", index },
@@ -18,6 +19,9 @@ export const MessageByIndexProvider: FC<
       get: (aui) => aui.thread.message({ index }).composer(),
     }),
   });
-
-  return <AuiProvider value={aui}>{children}</AuiProvider>;
+  return (
+    <AuiProvider extends={aui} config={config}>
+      {children}
+    </AuiProvider>
+  );
 };

package/src/react/providers/PartByIndexProvider.tsx

@@ -1,18 +1,22 @@
 import type { FC, PropsWithChildren } from "react";
-import { useAui, AuiProvider, Derived } from "@assistant-ui/store";
+import { useAui, AuiConfig, AuiProvider, Derived } from "@assistant-ui/store";
 
 export const PartByIndexProvider: FC<
   PropsWithChildren<{
     index: number;
   }>
 > = ({ index, children }) => {
-  const aui = useAui({
+  const aui = useAui();
+  const config = AuiConfig({
     part: Derived({
       source: "message",
       query: { type: "index", index },
       get: (aui) => aui.message.part({ index }),
     }),
   });
-
-  return <AuiProvider value={aui}>{children}</AuiProvider>;
+  return (
+    <AuiProvider extends={aui} config={config}>
+      {children}
+    </AuiProvider>
+  );
 };

package/src/react/providers/QueueItemByIndexProvider.tsx

@@ -1,5 +1,5 @@
 import type { FC, PropsWithChildren } from "react";
-import { AuiProvider, Derived, useAui } from "@assistant-ui/store";
+import { useAui, AuiConfig, AuiProvider, Derived } from "@assistant-ui/store";
 
 export type QueueItemByIndexProviderProps = PropsWithChildren<{
   index: number;
@@ -9,13 +9,17 @@ export const QueueItemByIndexProvider: FC<QueueItemByIndexProviderProps> = ({
   index,
   children,
 }) => {
-  const aui = useAui({
+  const aui = useAui();
+  const config = AuiConfig({
     queueItem: Derived({
       source: "composer",
-      query: { index },
+      query: { type: "index", index },
       get: (aui) => aui.composer.queueItem({ index }),
     }),
   });
-
-  return <AuiProvider value={aui}>{children}</AuiProvider>;
+  return (
+    <AuiProvider extends={aui} config={config}>
+      {children}
+    </AuiProvider>
+  );
 };

package/src/react/providers/ReadonlyThreadProvider.tsx

@@ -5,7 +5,7 @@ import {
   useMemo,
   useState,
 } from "react";
-import { useAui, AuiProvider, Derived } from "@assistant-ui/store";
+import { useAui, AuiConfig, AuiProvider, Derived } from "@assistant-ui/store";
 import type { ThreadMessage } from "../../types/message";
 import { ReadonlyThreadRuntimeCore } from "../../runtimes/readonly/ReadonlyThreadRuntimeCore";
 import {
@@ -72,7 +72,9 @@ export const ReadonlyThreadProvider: FC<ReadonlyThreadProvider.Props> = ({
     );
   }, [core]);
 
-  const aui = useAui({
+  const aui = useAui();
+
+  const config = AuiConfig({
     thread: ThreadClient({ runtime: threadRuntime }),
     composer: Derived({
       source: "thread",
@@ -80,6 +82,9 @@ export const ReadonlyThreadProvider: FC<ReadonlyThreadProvider.Props> = ({
       get: (aui) => aui.thread.composer(),
     }),
   });
-
-  return <AuiProvider value={aui}>{children}</AuiProvider>;
+  return (
+    <AuiProvider extends={aui} config={config}>
+      {children}
+    </AuiProvider>
+  );
 };

package/src/react/providers/SuggestionByIndexProvider.tsx

@@ -1,5 +1,5 @@
 import type { FC, PropsWithChildren } from "react";
-import { AuiProvider, Derived, useAui } from "@assistant-ui/store";
+import { useAui, AuiConfig, AuiProvider, Derived } from "@assistant-ui/store";
 
 export type SuggestionByIndexProviderProps = PropsWithChildren<{
   index: number;
@@ -9,13 +9,17 @@ export const SuggestionByIndexProvider: FC<SuggestionByIndexProviderProps> = ({
   index,
   children,
 }) => {
-  const aui = useAui({
+  const aui = useAui();
+  const config = AuiConfig({
     suggestion: Derived({
       source: "suggestions",
       query: { index },
       get: (aui) => aui.suggestions.suggestion({ index }),
     }),
   });
-
-  return <AuiProvider value={aui}>{children}</AuiProvider>;
+  return (
+    <AuiProvider extends={aui} config={config}>
+      {children}
+    </AuiProvider>
+  );
 };

package/src/react/providers/TextMessagePartProvider.tsx

@@ -1,5 +1,10 @@
 import { type FC, type PropsWithChildren, useMemo } from "react";
-import { useAui, AuiProvider, type ClientOutput } from "@assistant-ui/store";
+import {
+  useAui,
+  AuiConfig,
+  AuiProvider,
+  type ClientOutput,
+} from "@assistant-ui/store";
 import type { PartState } from "../../store/scopes/part";
 
 import { resource } from "@assistant-ui/tap";
@@ -42,9 +47,13 @@ export const TextMessagePartProvider: FC<
     isRunning?: boolean;
   }>
 > = ({ text, isRunning = false, children }) => {
-  const aui = useAui({
+  const aui = useAui();
+  const config = AuiConfig({
     part: TextMessagePartClient({ text, isRunning }),
   });
-
-  return <AuiProvider value={aui}>{children}</AuiProvider>;
+  return (
+    <AuiProvider extends={aui} config={config}>
+      {children}
+    </AuiProvider>
+  );
 };

package/src/react/providers/ThreadListItemByIndexProvider.tsx

@@ -1,5 +1,5 @@
 import type { FC, PropsWithChildren } from "react";
-import { useAui, AuiProvider, Derived } from "@assistant-ui/store";
+import { useAui, AuiConfig, AuiProvider, Derived } from "@assistant-ui/store";
 
 export const ThreadListItemByIndexProvider: FC<
   PropsWithChildren<{
@@ -7,13 +7,17 @@ export const ThreadListItemByIndexProvider: FC<
     archived: boolean;
   }>
 > = ({ index, archived, children }) => {
-  const aui = useAui({
+  const aui = useAui();
+  const config = AuiConfig({
     threadListItem: Derived({
       source: "threads",
       query: { type: "index", index, archived },
       get: (aui) => aui.threads.item({ index, archived }),
     }),
   });
-
-  return <AuiProvider value={aui}>{children}</AuiProvider>;
+  return (
+    <AuiProvider extends={aui} config={config}>
+      {children}
+    </AuiProvider>
+  );
 };

package/src/react/providers/ThreadListItemRuntimeProvider.tsx

@@ -1,5 +1,5 @@
 import type { FC, PropsWithChildren } from "react";
-import { useAui, AuiProvider } from "@assistant-ui/store";
+import { useAui, AuiConfig, AuiProvider } from "@assistant-ui/store";
 import type { ThreadListItemRuntime } from "../..";
 import { ThreadListItemClient } from "../../store/internal";
 
@@ -8,9 +8,13 @@ export const ThreadListItemRuntimeProvider: FC<
     runtime: ThreadListItemRuntime;
   }>
 > = ({ runtime, children }) => {
-  const aui = useAui({
+  const aui = useAui();
+  const config = AuiConfig({
     threadListItem: ThreadListItemClient({ runtime }),
   });
-
-  return <AuiProvider value={aui}>{children}</AuiProvider>;
+  return (
+    <AuiProvider extends={aui} config={config}>
+      {children}
+    </AuiProvider>
+  );
 };

package/src/react/runtimes/RemoteThreadListThreadListRuntimeCore.tsx

@@ -14,14 +14,29 @@ import {
   normalizeCursor,
   updateStatusReducer,
 } from "../../runtimes/remote-thread-list/remote-thread-state";
-import type { RemoteThreadListOptions } from "../../runtimes/remote-thread-list/types";
+import type {
+  RemoteThreadListOptions,
+  RemoteThreadListProviderComponent,
+} from "../../runtimes/remote-thread-list/types";
 import { RemoteThreadListHookInstanceManager } from "./RemoteThreadListHookInstanceManager";
-import { type FC, Fragment, useEffect, useId } from "react";
+import {
+  type ComponentType,
+  type FC,
+  Fragment,
+  type PropsWithChildren,
+  useEffect,
+  useId,
+} from "react";
 import { create } from "zustand";
 import { AssistantMessageStream } from "assistant-stream";
 import type { ModelContextProvider } from "../../model-context/types";
 import { RuntimeAdapterProvider } from "./RuntimeAdapterProvider";
 
+const asProviderComponent = (
+  provider: RemoteThreadListProviderComponent | undefined,
+): ComponentType<PropsWithChildren> =>
+  (provider ?? Fragment) as ComponentType<PropsWithChildren>;
+
 const threadNotFoundError = (threadIdOrRemoteId: string, action: string) =>
   new Error(`Thread "${threadIdOrRemoteId}" not found while ${action}.`);
 
@@ -189,7 +204,7 @@ export class RemoteThreadListThreadListRuntimeCore
       this._notifySubscribers(),
     );
     this.useProvider = create(() => ({
-      Provider: options.adapter.unstable_Provider ?? Fragment,
+      Provider: asProviderComponent(options.adapter.unstable_Provider),
     }));
     this.__internal_setOptions(options);
     this.switchToNewThread();
@@ -210,7 +225,7 @@ export class RemoteThreadListThreadListRuntimeCore
 
     this._options = options;
 
-    const Provider = options.adapter.unstable_Provider ?? Fragment;
+    const Provider = asProviderComponent(options.adapter.unstable_Provider);
     if (Provider !== this.useProvider.getState().Provider) {
       this.useProvider.setState({ Provider }, true);
     }
@@ -473,7 +488,10 @@ export class RemoteThreadListThreadListRuntimeCore
     if (this.mainThreadId !== undefined) {
       await task;
     } else {
-      task.then(() => this._notifySubscribers());
+      void task.then(
+        () => this._notifySubscribers(),
+        () => undefined,
+      );
     }
 
     if (generation !== this._switchGeneration) return;

package/src/react/runtimes/useLocalRuntime.ts

@@ -84,6 +84,8 @@ export const splitLocalRuntimeOptions = <T extends LocalRuntimeOptions>(
     adapters,
     unstable_humanToolNames,
     unstable_enableMessageQueue,
+    unstable_queueClearOnRewind,
+    unstable_queueClearOnCancel,
     ...rest
   } = options;
 
@@ -95,6 +97,8 @@ export const splitLocalRuntimeOptions = <T extends LocalRuntimeOptions>(
       adapters,
       unstable_humanToolNames,
       unstable_enableMessageQueue,
+      unstable_queueClearOnRewind,
+      unstable_queueClearOnCancel,
     },
     otherOptions: rest,
   };