@assistant-ui/core 0.3.6 → 0.3.8

package/src/react/client/Tools.ts

@@ -5,11 +5,11 @@ import {
   withKey,
   type ResourceElement,
 } from "@assistant-ui/tap";
+import type { ClientOutput } from "@assistant-ui/store";
 import {
-  useAssistantClientRef,
-  type ClientOutput,
   attachTransformScopes,
-} from "@assistant-ui/store";
+  useAssistantClientRef,
+} from "@assistant-ui/store/client";
 import type { McpAppResourceOutput, ToolsState } from "../types/scopes/tools";
 import type { Tool } from "assistant-stream";
 import {
@@ -18,7 +18,7 @@ import {
   type Toolkit,
 } from "../model-context/toolbox";
 import type { ToolCallMessagePartComponent } from "../types/MessagePartComponentTypes";
-import { ModelContext } from "../../store";
+import { ModelContext } from "../../store/clients/model-context-client";
 
 export type { McpAppResourceOutput };
 

package/src/react/index.ts

@@ -228,6 +228,7 @@ export {
 } from "./runtimes/useStreamingTiming";
 export {
   createRuntimeExtras,
+  unstable_createRuntimeExtrasFromBrand,
   type RuntimeExtras,
 } from "./runtimes/createRuntimeExtras";
 export { RemoteThreadListHookInstanceManager } from "./runtimes/RemoteThreadListHookInstanceManager";

package/src/react/runtimes/cloud/auiV0.ts

@@ -32,6 +32,7 @@ type AuiV0MessagePart =
   | {
       readonly type: "reasoning";
       readonly text: string;
+      readonly unstable_summary?: string;
     }
   | {
       readonly type: "source";
@@ -226,7 +227,13 @@ export function auiV0Encode(message: ThreadMessage): AuiV0Message {
           return { type: "text", text: part.text };
 
         case "reasoning":
-          return { type: "reasoning", text: part.text };
+          return {
+            type: "reasoning",
+            text: part.text,
+            ...(part.unstable_summary !== undefined
+              ? { unstable_summary: part.unstable_summary }
+              : undefined),
+          };
 
         case "source":
           if (part.sourceType === "url") {

package/src/react/runtimes/createRuntimeExtras.test.ts

@@ -1,6 +1,10 @@
 import { describe, it, expect } from "vitest";
 import type { AssistantClient } from "@assistant-ui/store";
-import { createRuntimeExtras } from "./createRuntimeExtras";
+import {
+  createRuntimeExtras,
+  unstable_createRuntimeExtrasFromBrand,
+} from "./createRuntimeExtras";
+import { createRuntimeExtrasBrand } from "../../runtime/utils/runtime-extras-brand";
 
 type Extras = { value: number; greet: () => string };
 
@@ -55,4 +59,13 @@ describe("createRuntimeExtras", () => {
 
     expect(() => channel.get(clientWith(undefined))).toThrow("useTestRuntime");
   });
+
+  it("reads extras provided through a standalone brand instance", () => {
+    const brand = createRuntimeExtrasBrand<Extras>("useTestRuntime");
+    const channel = unstable_createRuntimeExtrasFromBrand(brand);
+    const branded = brand.provide({ value: 7, greet: () => "hi" });
+
+    expect(channel.is(branded)).toBe(true);
+    expect(channel.get(clientWith(branded)).value).toBe(7);
+  });
 });

package/src/react/runtimes/createRuntimeExtras.ts

@@ -2,6 +2,10 @@
 
 import { useAuiState } from "@assistant-ui/store";
 import type { AssistantClient } from "@assistant-ui/store";
+import {
+  createRuntimeExtrasBrand,
+  type RuntimeExtrasBrand,
+} from "../../runtime/utils/runtime-extras-brand";
 
 /** @deprecated Internal API for external-store adapter authors. Not part of the public API; may change or be removed without notice. */
 export type RuntimeExtras<T extends object> = {
@@ -17,33 +21,10 @@ export type RuntimeExtras<T extends object> = {
 };
 
 /** @deprecated Internal API for external-store adapter authors. Not part of the public API; may change or be removed without notice. */
-export const createRuntimeExtras = <T extends object>(
-  runtimeName: string,
+export const unstable_createRuntimeExtrasFromBrand = <T extends object>(
+  brand: RuntimeExtrasBrand<T>,
 ): RuntimeExtras<T> => {
-  const brand = Symbol(`${runtimeName} extras`);
-
-  const is = (extras: unknown): extras is T =>
-    typeof extras === "object" && extras !== null && brand in extras;
-
-  const assert = (extras: unknown): T => {
-    if (!is(extras))
-      throw new Error(
-        `The current thread is not backed by the ${runtimeName} runtime.`,
-      );
-    return extras;
-  };
-
-  const provide = (value: T): T => {
-    Object.defineProperty(value, brand, {
-      value: true,
-      enumerable: false,
-      configurable: true,
-    });
-    return value;
-  };
-
-  const tryGet = (extras: unknown): T | undefined =>
-    is(extras) ? extras : undefined;
+  const { provide, is, tryGet, assert } = brand;
 
   const get = (client: AssistantClient): T =>
     assert(client.thread.getState().extras);
@@ -66,3 +47,11 @@ export const createRuntimeExtras = <T extends object>(
 
   return { provide, is, tryGet, get, use: use as RuntimeExtras<T>["use"] };
 };
+
+/** @deprecated Internal API for external-store adapter authors. Not part of the public API; may change or be removed without notice. */
+export const createRuntimeExtras = <T extends object>(
+  runtimeName: string,
+): RuntimeExtras<T> =>
+  unstable_createRuntimeExtrasFromBrand(
+    createRuntimeExtrasBrand<T>(runtimeName),
+  );

package/src/runtime/base/default-edit-composer-runtime-core.ts

@@ -1,7 +1,7 @@
 import type { AppendMessage, ThreadMessage } from "../../types/message";
 import type { CompleteAttachment } from "../../types/attachment";
 import { getThreadMessageText } from "../../utils/text";
-import { attachmentsEqual, liftNonTextParts } from "../../adapters/attachment";
+import { liftNonTextParts } from "../../adapters/attachment";
 import type { AttachmentAdapter } from "../../adapters/attachment";
 import type { DictationAdapter } from "../../adapters/speech";
 import type { SendOptions } from "../interfaces/composer-runtime-core";
@@ -26,8 +26,6 @@ export class DefaultEditComposerRuntimeCore extends BaseComposerRuntimeCore {
     return this.runtime.adapters?.dictation;
   }
 
-  private _previousText;
-  private _previousAttachments: readonly CompleteAttachment[];
   private _nonTextPassthrough: readonly ThreadMessage["content"][number][];
   private _parentId: string | null;
   private _sourceId: string | null;
@@ -58,24 +56,24 @@ export class DefaultEditComposerRuntimeCore extends BaseComposerRuntimeCore {
     this.endEditCallback = endEditCallback;
     this._parentId = parentId;
     this._sourceId = message.id;
-    this._previousText = getThreadMessageText(message);
-    this.setText(this._previousText);
+    this.setText(getThreadMessageText(message));
 
     this.setRole(message.role);
 
+    let attachments: readonly CompleteAttachment[];
     if (message.role === "user") {
-      this._previousAttachments = [
+      attachments = [
         ...(message.attachments ?? []),
         ...liftNonTextParts(message.content),
       ];
       this._nonTextPassthrough = [];
     } else {
-      this._previousAttachments = message.attachments ?? [];
+      attachments = message.attachments ?? [];
       this._nonTextPassthrough = message.content.filter(
         (p) => p.type !== "text",
       );
     }
-    this.setAttachments(this._previousAttachments);
+    this.setAttachments(attachments);
 
     this.setRunConfig({ ...runtime.composer.runConfig });
   }
@@ -92,49 +90,33 @@ export class DefaultEditComposerRuntimeCore extends BaseComposerRuntimeCore {
     message: Omit<AppendMessage, "parentId" | "sourceId">,
     options?: SendOptions,
   ) {
-    let appendTask: void | Promise<void> = undefined;
-    const text = getThreadMessageText(message as AppendMessage);
-    const attachmentsChanged = !attachmentsEqual(
-      message.attachments ?? [],
-      this._previousAttachments,
+    const content =
+      this._nonTextPassthrough.length > 0
+        ? ([
+            ...message.content,
+            ...this._nonTextPassthrough,
+          ] as AppendMessage["content"])
+        : message.content;
+    // Gate live state against the new branch's prefix (messages up to the
+    // parent): an unchanged interactable re-stamps the prior baseline, an
+    // interactable edited since the original message stamps its newest state.
+    const messages = this.runtime.messages;
+    const parentIndex =
+      this._parentId === null
+        ? -1
+        : messages.findIndex((m) => m.id === this._parentId);
+    const composerMetadata = gateInteractableComposerMetadata(
+      this.runtime.getModelContext().unstable_composerMetadata,
+      messages.slice(0, parentIndex + 1),
     );
-
-    if (
-      text !== this._previousText ||
-      attachmentsChanged ||
-      options?.startRun
-    ) {
-      const content =
-        this._nonTextPassthrough.length > 0
-          ? ([
-              ...message.content,
-              ...this._nonTextPassthrough,
-            ] as AppendMessage["content"])
-          : message.content;
-      // Gate live state against the new branch's prefix (messages up to the
-      // parent): an unchanged interactable re-stamps the prior baseline, an
-      // interactable edited since the original message stamps its newest state.
-      const messages = this.runtime.messages;
-      const parentIndex =
-        this._parentId === null
-          ? -1
-          : messages.findIndex((m) => m.id === this._parentId);
-      const composerMetadata = gateInteractableComposerMetadata(
-        this.runtime.getModelContext().unstable_composerMetadata,
-        messages.slice(0, parentIndex + 1),
-      );
-      const enriched = this.enrichWithComposerMetadata(
-        message,
-        composerMetadata,
-      );
-      appendTask = this.runtime.append({
-        ...enriched,
-        content,
-        parentId: this._parentId,
-        sourceId: this._sourceId,
-        startRun: options?.startRun,
-      });
-    }
+    const enriched = this.enrichWithComposerMetadata(message, composerMetadata);
+    const appendTask = this.runtime.append({
+      ...enriched,
+      content,
+      parentId: this._parentId,
+      sourceId: this._sourceId,
+      startRun: options?.startRun,
+    });
 
     this.handleCancel();
     return appendTask;

package/src/runtime/utils/runtime-extras-brand.ts

@@ -0,0 +1,47 @@
+/** @deprecated Internal API for external-store adapter authors. Not part of the public API; may change or be removed without notice. */
+export type RuntimeExtrasBrand<T extends object> = {
+  provide: (value: T) => T;
+  is: (extras: unknown) => extras is T;
+  tryGet: (extras: unknown) => T | undefined;
+  assert: (extras: unknown) => T;
+};
+
+/**
+ * Creates the framework-neutral half of a runtime extras channel: the brand
+ * symbol with its provide/read primitives. A runtime factory provides extras
+ * through the brand on any framework; the React entry wraps the same brand
+ * with a `use()` hook. The symbol is per-instance, so the adapter package
+ * creates the brand once and every binding imports that instance.
+ *
+ * @deprecated Internal API for external-store adapter authors. Not part of the public API; may change or be removed without notice.
+ */
+export const createRuntimeExtrasBrand = <T extends object>(
+  runtimeName: string,
+): RuntimeExtrasBrand<T> => {
+  const brand = Symbol(`${runtimeName} extras`);
+
+  const is = (extras: unknown): extras is T =>
+    typeof extras === "object" && extras !== null && brand in extras;
+
+  const assert = (extras: unknown): T => {
+    if (!is(extras))
+      throw new Error(
+        `The current thread is not backed by the ${runtimeName} runtime.`,
+      );
+    return extras;
+  };
+
+  const provide = (value: T): T => {
+    Object.defineProperty(value, brand, {
+      value: true,
+      enumerable: false,
+      configurable: true,
+    });
+    return value;
+  };
+
+  const tryGet = (extras: unknown): T | undefined =>
+    is(extras) ? extras : undefined;
+
+  return { provide, is, tryGet, assert };
+};

package/src/runtime/utils/thread-message-like.ts

@@ -160,10 +160,14 @@ export const fromThreadMessageLike = (
             const type = part.type;
             switch (type) {
               case "text":
-              case "reasoning":
                 if (!part.text?.trim()) return null;
                 return part;
 
+              case "reasoning":
+                if (!part.text?.trim() && !part.unstable_summary?.trim())
+                  return null;
+                return part;
+
               case "file":
               case "source":
                 return part;

package/src/store/clients/runtime-adapter.ts

@@ -1,8 +1,5 @@
-import {
-  Derived,
-  type ScopesConfig,
-  type AssistantClient,
-} from "@assistant-ui/store";
+import type { AssistantClient, ScopesConfig } from "@assistant-ui/store";
+import { Derived } from "@assistant-ui/store/client";
 import { ModelContext } from "./model-context-client";
 import { Suggestions } from "./suggestions";
 

package/src/store/clients/suggestions.ts

@@ -1,7 +1,7 @@
 import { useState } from "react";
 import { resource, withKey } from "@assistant-ui/tap";
 import type { ClientOutput } from "@assistant-ui/store";
-import { useClientLookup } from "@assistant-ui/store";
+import { useClientLookup } from "@assistant-ui/store/client";
 import type { SuggestionsState } from "../scopes/suggestions";
 import type { SuggestionState } from "../scopes/suggestion";
 

package/src/store/clients/thread-message-client.ts

@@ -7,7 +7,7 @@ import type { Attachment } from "../../types/attachment";
 import { useMemo, useState } from "react";
 import { useResource, resource, withKey } from "@assistant-ui/tap";
 import type { ClientOutput } from "@assistant-ui/store";
-import { useClientLookup } from "@assistant-ui/store";
+import { useClientLookup } from "@assistant-ui/store/client";
 import type { MessageState } from "../scopes/message";
 import type { PartState } from "../scopes/part";
 import { NoOpComposerClient } from "./no-op-composer-client";

package/src/store/index.ts

@@ -1,4 +1,5 @@
 /// <reference path="./scope-registration.ts" />
+/// <reference path="../react/types/store-augmentation.ts" />
 
 // scopes
 export type {
@@ -77,6 +78,36 @@ export type {
   ChainOfThoughtPart,
 } from "./scopes/chain-of-thought";
 
+// runtime wiring
+export { RuntimeAdapter } from "../react/RuntimeAdapter";
+export {
+  useExternalMessageConverter,
+  convertExternalMessages,
+  type JoinStrategy,
+} from "../react/runtimes/external-message-converter";
+export {
+  useStreamingTiming,
+  type StreamingTimingAccessors,
+  type StreamingTimingOptions,
+  type StreamingTimingState,
+} from "../react/runtimes/useStreamingTiming";
+export {
+  createRuntimeExtrasBrand,
+  type RuntimeExtrasBrand,
+} from "../runtime/utils/runtime-extras-brand";
+export { defineToolkit } from "../react/model-context/define-toolkit";
+export {
+  defineMcpToolkit,
+  type McpToolkitDefinition,
+  type McpToolkitEntry,
+  type McpToolkitToolConfig,
+} from "../react/model-context/define-mcp-toolkit";
+export type {
+  Toolkit,
+  ToolkitDefinition,
+  ToolkitDefinitionEntry,
+} from "../react/model-context/toolbox";
+
 // clients
 export { NoOpComposerClient } from "./clients/no-op-composer-client";
 export { Suggestions, type SuggestionConfig } from "./clients/suggestions";

package/src/store/runtime-clients/composer-runtime-client.ts

@@ -1,11 +1,8 @@
 import type { Unsubscribe } from "../../types/unsubscribe";
 import { useMemo, useEffect } from "react";
 import { useResource, resource, withKey } from "@assistant-ui/tap";
-import {
-  type ClientOutput,
-  useAssistantEmit,
-  useClientLookup,
-} from "@assistant-ui/store";
+import type { ClientOutput } from "@assistant-ui/store";
+import { useAssistantEmit, useClientLookup } from "@assistant-ui/store/client";
 import type {
   ComposerRuntime,
   EditComposerRuntime,

package/src/store/runtime-clients/lookup-domains.test.ts

@@ -0,0 +1,109 @@
+import { describe, expect, it } from "vitest";
+import { AuiConfig, createAssistantClient } from "@assistant-ui/store/client";
+import { RuntimeAdapter, Suggestions } from "../index";
+import { ExternalStoreRuntimeCore } from "../../runtimes/internal";
+import { AssistantRuntimeImpl } from "../../runtime/internal";
+import type { ExternalStoreAdapter } from "../../runtimes/external-store/external-store-adapter";
+
+type DemoMessage = { id: string; role: "user" | "assistant"; text: string };
+
+const createClient = () => {
+  const adapter: ExternalStoreAdapter<DemoMessage> = {
+    messages: [
+      { id: "u1", role: "user", text: "hi" },
+      { id: "a1", role: "assistant", text: "hello" },
+    ],
+    convertMessage: (message) => ({
+      id: message.id,
+      role: message.role,
+      content: [{ type: "text", text: message.text }],
+    }),
+    onNew: async () => {},
+    adapters: {
+      threadList: {
+        threadId: "t1",
+        threads: [{ status: "regular", id: "t1", title: "one" }],
+        archivedThreads: [{ status: "archived", id: "t2", title: "two" }],
+      },
+    },
+  };
+  const runtime = new AssistantRuntimeImpl(
+    new ExternalStoreRuntimeCore(adapter),
+  );
+  return createAssistantClient(
+    AuiConfig({
+      threads: RuntimeAdapter(runtime),
+      suggestions: Suggestions([
+        { title: "a", label: "a", prompt: "a" },
+        { title: "b", label: "b", prompt: "b" },
+      ]),
+    }),
+  );
+};
+
+/**
+ * Pins each by-index lookup's valid domain to the state array that backs it.
+ * Consumers (the vue by-index providers) guard with `index < array.length`
+ * against these arrays; a lookup changing its backing array must fail here.
+ */
+describe("by-index lookup domains", () => {
+  it("thread.message is indexed by thread.getState().messages", () => {
+    const handle = createClient();
+    const aui = handle.getClient();
+    const length = aui.thread.getState().messages.length;
+    expect(length).toBe(2);
+    expect(aui.thread.message({ index: length - 1 }).getState().id).toBe("a1");
+    expect(() => aui.thread.message({ index: length }).getState()).toThrow(
+      /out of bounds/,
+    );
+    handle.destroy();
+  });
+
+  it("message.part is indexed by message.getState().parts", () => {
+    const handle = createClient();
+    const aui = handle.getClient();
+    const message = aui.thread.message({ index: 1 });
+    const length = message.getState().parts.length;
+    expect(length).toBe(1);
+    expect(message.part({ index: length - 1 }).getState().type).toBe("text");
+    expect(() => message.part({ index: length }).getState()).toThrow(
+      /out of bounds/,
+    );
+    handle.destroy();
+  });
+
+  it("suggestions.suggestion is indexed by suggestions.getState().suggestions", () => {
+    const handle = createClient();
+    const aui = handle.getClient();
+    const length = aui.suggestions.getState().suggestions.length;
+    expect(length).toBe(2);
+    expect(
+      aui.suggestions.suggestion({ index: length - 1 }).getState().title,
+    ).toBe("b");
+    expect(() =>
+      aui.suggestions.suggestion({ index: length }).getState(),
+    ).toThrow(/out of bounds/);
+    handle.destroy();
+  });
+
+  it("threads.item is indexed by threadIds and archivedThreadIds", () => {
+    const handle = createClient();
+    const aui = handle.getClient();
+    const state = aui.threads.getState();
+    expect(state.threadIds).toHaveLength(1);
+    expect(state.archivedThreadIds).toHaveLength(1);
+    expect(aui.threads.item({ index: 0, archived: false }).getState().id).toBe(
+      "t1",
+    );
+    expect(aui.threads.item({ index: 0, archived: true }).getState().id).toBe(
+      "t2",
+    );
+    expect(() =>
+      aui.threads.item({ index: 1, archived: false }).getState(),
+    ).toThrow(/not found|out of bounds/);
+    expect(() =>
+      aui.threads.item({ index: 1, archived: true }).getState(),
+    ).toThrow(/not found|out of bounds/);
+    handle.destroy();
+  });
+});

package/src/store/runtime-clients/message-runtime-client.ts

@@ -1,10 +1,7 @@
 import { useMemo, useState } from "react";
 import { useResource, withKey, resource } from "@assistant-ui/tap";
-import {
-  type ClientOutput,
-  useClientLookup,
-  useClientResource,
-} from "@assistant-ui/store";
+import type { ClientOutput } from "@assistant-ui/store";
+import { useClientLookup, useClientResource } from "@assistant-ui/store/client";
 import type { MessageRuntime } from "../../runtime/api/message-runtime";
 import { useSubscribable } from "./useSubscribable";
 import { liveRef } from "./liveRef";

package/src/store/runtime-clients/thread-list-item-runtime-client.ts

@@ -1,7 +1,8 @@
 import type { Unsubscribe } from "../../types/unsubscribe";
 import { useEffect, useMemo } from "react";
 import { resource } from "@assistant-ui/tap";
-import { type ClientOutput, useAssistantEmit } from "@assistant-ui/store";
+import type { ClientOutput } from "@assistant-ui/store";
+import { useAssistantEmit } from "@assistant-ui/store/client";
 import type {
   ThreadListItemEventType,
   ThreadListItemRuntime,

package/src/store/runtime-clients/thread-list-runtime-client.ts

@@ -1,10 +1,7 @@
 import { useMemo } from "react";
 import { useResource, withKey, resource } from "@assistant-ui/tap";
-import {
-  type ClientOutput,
-  useClientLookup,
-  useClientResource,
-} from "@assistant-ui/store";
+import type { ClientOutput } from "@assistant-ui/store";
+import { useClientLookup, useClientResource } from "@assistant-ui/store/client";
 import type { ThreadListRuntime } from "../../runtime/api/thread-list-runtime";
 import type { AssistantRuntime } from "../../runtime/api/assistant-runtime";
 import { useSubscribable } from "./useSubscribable";

package/src/store/runtime-clients/thread-runtime-client.ts

@@ -4,12 +4,12 @@ import type { ThreadRuntime } from "../../runtime/api/thread-runtime";
 import { useMemo, useEffect, type RefObject } from "react";
 import { useResource, resource, withKey } from "@assistant-ui/tap";
 import { liveRef } from "./liveRef";
+import type { ClientOutput } from "@assistant-ui/store";
 import {
-  type ClientOutput,
   useAssistantEmit,
   useClientLookup,
   useClientResource,
-} from "@assistant-ui/store";
+} from "@assistant-ui/store/client";
 import { ComposerClient } from "./composer-runtime-client";
 import { MessageClient } from "./message-runtime-client";
 import { useSubscribable } from "./useSubscribable";