@assistant-ui/core 0.1.7 → 0.1.9

package/src/tests/mention-formatter.test.ts

@@ -0,0 +1,112 @@
+import { describe, it, expect } from "vitest";
+import { unstable_defaultDirectiveFormatter } from "../adapters/mention";
+
+describe("unstable_defaultDirectiveFormatter", () => {
+  describe("serialize", () => {
+    it("serializes with id === label (no name attr)", () => {
+      expect(
+        unstable_defaultDirectiveFormatter.serialize({
+          id: "weather",
+          type: "tool",
+          label: "weather",
+        }),
+      ).toBe(":tool[weather]");
+    });
+
+    it("serializes with id !== label (includes name attr)", () => {
+      expect(
+        unstable_defaultDirectiveFormatter.serialize({
+          id: "get_weather",
+          type: "tool",
+          label: "Weather",
+        }),
+      ).toBe(":tool[Weather]{name=get_weather}");
+    });
+  });
+
+  describe("parse", () => {
+    it("parses plain text", () => {
+      expect(unstable_defaultDirectiveFormatter.parse("hello world")).toEqual([
+        { kind: "text", text: "hello world" },
+      ]);
+    });
+
+    it("parses a single directive without name attr", () => {
+      expect(
+        unstable_defaultDirectiveFormatter.parse("use :tool[weather] please"),
+      ).toEqual([
+        { kind: "text", text: "use " },
+        { kind: "mention", type: "tool", label: "weather", id: "weather" },
+        { kind: "text", text: " please" },
+      ]);
+    });
+
+    it("parses a directive with name attr", () => {
+      expect(
+        unstable_defaultDirectiveFormatter.parse(
+          ":tool[Weather]{name=get_weather}",
+        ),
+      ).toEqual([
+        {
+          kind: "mention",
+          type: "tool",
+          label: "Weather",
+          id: "get_weather",
+        },
+      ]);
+    });
+
+    it("parses multiple directives in text", () => {
+      const result = unstable_defaultDirectiveFormatter.parse(
+        ":tool[a] and :tool[b]{name=bb}",
+      );
+      expect(result).toHaveLength(3);
+      expect(result[0]).toEqual({
+        kind: "mention",
+        type: "tool",
+        label: "a",
+        id: "a",
+      });
+      expect(result[1]).toEqual({ kind: "text", text: " and " });
+      expect(result[2]).toEqual({
+        kind: "mention",
+        type: "tool",
+        label: "b",
+        id: "bb",
+      });
+    });
+
+    it("parses hyphenated types", () => {
+      expect(
+        unstable_defaultDirectiveFormatter.parse(
+          ":data-source[My DB]{name=db_1}",
+        ),
+      ).toEqual([
+        {
+          kind: "mention",
+          type: "data-source",
+          label: "My DB",
+          id: "db_1",
+        },
+      ]);
+    });
+
+    it("roundtrips serialize → parse", () => {
+      const item = {
+        id: "get_weather",
+        type: "tool",
+        label: "Weather",
+      };
+      const serialized = unstable_defaultDirectiveFormatter.serialize(item);
+      const parsed = unstable_defaultDirectiveFormatter.parse(serialized);
+      expect(parsed).toEqual([
+        {
+          kind: "mention",
+          type: "tool",
+          label: "Weather",
+          id: "get_weather",
+        },
+      ]);
+    });
+  });
+});

package/src/types/index.ts

@@ -0,0 +1,47 @@
+export type {
+  // Message parts
+  TextMessagePart,
+  ReasoningMessagePart,
+  SourceMessagePart,
+  ImageMessagePart,
+  FileMessagePart,
+  DataMessagePart,
+  Unstable_AudioMessagePart,
+  ToolCallMessagePart,
+  ThreadUserMessagePart,
+  ThreadAssistantMessagePart,
+  // Message status
+  MessagePartStatus,
+  ToolCallMessagePartStatus,
+  MessageStatus,
+  // Thread messages
+  MessageTiming,
+  ThreadStep,
+  ThreadSystemMessage,
+  ThreadUserMessage,
+  ThreadAssistantMessage,
+  ThreadMessage,
+  MessageRole,
+  // Config
+  RunConfig,
+  AppendMessage,
+} from "./message";
+
+export type {
+  Attachment,
+  PendingAttachment,
+  CompleteAttachment,
+  AttachmentStatus,
+  CreateAttachment,
+} from "./attachment";
+
+export type { Unsubscribe } from "./unsubscribe";
+
+export type { QuoteInfo } from "./quote";
+
+export type {
+  Unstable_MentionItem,
+  Unstable_MentionCategory,
+  Unstable_DirectiveSegment,
+  Unstable_DirectiveFormatter,
+} from "./mention";

package/src/types/mention.ts

@@ -0,0 +1,50 @@
+import type { ReadonlyJSONObject } from "assistant-stream/utils";
+
+// =============================================================================
+// Mention Item (user-facing definition for items that can be @-mentioned)
+// =============================================================================
+
+export type Unstable_MentionItem = {
+  readonly id: string;
+  readonly type: string;
+  readonly label: string;
+  readonly icon?: string | undefined;
+  readonly description?: string | undefined;
+  readonly metadata?: ReadonlyJSONObject | undefined;
+};
+
+// =============================================================================
+// Mention Category (for hierarchical navigation)
+// =============================================================================
+
+export type Unstable_MentionCategory = {
+  readonly id: string;
+  readonly label: string;
+  readonly icon?: string | undefined;
+};
+
+// =============================================================================
+// Directive Segment (parsed representation of mention directives in text)
+// =============================================================================
+
+/** Parsed segment from directive text */
+export type Unstable_DirectiveSegment =
+  | { readonly kind: "text"; readonly text: string }
+  | {
+      readonly kind: "mention";
+      readonly type: string;
+      readonly label: string;
+      readonly id: string;
+    };
+
+// =============================================================================
+// Directive Formatter (configurable serialization/parsing for mentions)
+// =============================================================================
+
+/** Configurable formatter for mention directive serialization/parsing */
+export type Unstable_DirectiveFormatter = {
+  /** Serialize a mention item to directive text */
+  serialize(item: Unstable_MentionItem): string;
+  /** Parse text into alternating text and mention segments */
+  parse(text: string): readonly Unstable_DirectiveSegment[];
+};