@dxos/plugin-assistant 0.8.3 → 0.8.4-main.1c7ec43d41

package/src/components/ChatPrompt/ChatReferences.tsx

@@ -0,0 +1,57 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Option from 'effect/Option';
+import React from 'react';
+
+import { type AiContextBinder } from '@dxos/assistant';
+import { Annotation, type Database, Obj } from '@dxos/echo';
+import { Icon, IconButton, type Label, type ThemedClassName, toLocalizedString, useTranslation } from '@dxos/react-ui';
+import { getStyles, mx } from '@dxos/ui-theme';
+
+import { useContextObjects } from '#hooks';
+import { meta } from '#meta';
+
+export type ChatReferencesProps = ThemedClassName<{
+  context: AiContextBinder;
+  db: Database.Database;
+}>;
+
+export const ChatReferences = ({ classNames, context, db }: ChatReferencesProps) => {
+  const { t } = useTranslation(meta.id);
+  const { objects, onUpdateObject } = useContextObjects({ db, context });
+
+  return (
+    <ul className={mx('flex', classNames)}>
+      {objects.map((obj) => {
+        const dxn = Obj.getDXN(obj);
+        const typename = Obj.getTypename(obj);
+        const label: Label = Obj.getLabel(obj) ?? (typename ? ['object-name.placeholder', { ns: typename }] : obj.id);
+        const { icon, hue } = Option.fromNullable(Obj.getSchema(obj)).pipe(
+          Option.flatMap(Annotation.IconAnnotation.get),
+          Option.getOrElse(() => ({ icon: DEFAULT_OBJECT_ICON, hue: undefined as string | undefined })),
+        );
+        const styles = hue ? getStyles(hue) : undefined;
+        return (
+          <li key={dxn.toString()} className='dx-tag py-0 ps-2 flex items-center gap-1' data-hue='neutral'>
+            <Icon icon={icon} size={4} classNames={styles?.surfaceText} />
+            {toLocalizedString(label, t)}
+            <IconButton
+              icon='ph--x--bold'
+              iconOnly
+              variant='ghost'
+              label={t('remove-object.label')}
+              classNames='p-0 hover:bg-transparent'
+              size={3}
+              onClick={() => onUpdateObject?.(dxn, false)}
+            />
+          </li>
+        );
+      })}
+    </ul>
+  );
+};
+
+// TODO(dmaretskyi): Extract those somewhere else.
+const DEFAULT_OBJECT_ICON = 'ph--cube--regular';

package/src/components/ChatPrompt/ChatStatus.tsx

@@ -0,0 +1,123 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+import React, { useEffect, useMemo, useState } from 'react';
+
+import { type ThemedClassName } from '@dxos/react-ui';
+import { ChatStatus as NaturalChatStatus, formatElapsed } from '@dxos/react-ui-chat';
+import { Matrix } from '@dxos/react-ui-sfx';
+import { type ContentBlock } from '@dxos/types';
+import { Unit } from '@dxos/util';
+
+import { type ChatRequestTiming, useChatContext } from '../Chat/context';
+
+const CHAT_STREAM_STATUS_NAME = 'Chat.StreamStatus';
+const TICK_MS = 1_000;
+
+export type ChatStreamStatusProps = ThemedClassName<{
+  icon?: boolean;
+}>;
+
+/**
+ * Live status pill rendered at the bottom of the chat thread.
+ *
+ * The block-widget host re-mounts this component each time wire's drip queue toggles
+ * (`wireDrainingEffect`) — so all visible state is derived from chat-context values that
+ * survive the unmount: the latest `stats` block on the chat context's `messages` for token counts,
+ * and `requestTiming` (start/end wall-clock timestamps) for the elapsed value.
+ *
+ * Shows:
+ * - elapsed seconds since the most recent request started (frozen at end-of-request)
+ * - last completed turn's output token count (from the most recent `stats` content block)
+ * - cumulative session total tokens across all `stats` content blocks
+ */
+export const ChatStatus = ({ classNames, icon }: ChatStreamStatusProps) => {
+  // Read `messages` from the chat context (combines `useQuery(queue)` + the processor's
+  // pending atom) rather than `processor.messages` directly — the latter only contains
+  // blocks streamed via the ephemeral `PartialBlock` channel, while finalized blocks
+  // (including the per-turn `stats` block we read for token counts) are submitted to the
+  // feed via `_submitMessage` and only show up through `useQuery`.
+  const { messages, requestTiming } = useChatContext(CHAT_STREAM_STATUS_NAME);
+
+  const { lastOutputTokens, sessionTotalTokens } = useMemo(() => {
+    let last: number | undefined;
+    let total = 0;
+    for (const message of messages) {
+      for (const block of message.blocks) {
+        if (isStats(block) && block.usage) {
+          last = block.usage.outputTokens;
+          total += block.usage.totalTokens ?? 0;
+        }
+      }
+    }
+    return { lastOutputTokens: last, sessionTotalTokens: total };
+  }, [messages]);
+
+  const isRunning = requestTiming != null && requestTiming.endedAt == null;
+  const show = requestTiming || lastOutputTokens || sessionTotalTokens > 0;
+  if (!show) {
+    return null;
+  }
+
+  return (
+    <NaturalChatStatus.Root defaultRunning={false} classNames={['py-2 gap-2 text-sm', classNames]}>
+      {icon && (
+        <NaturalChatStatus.Icon>
+          <Matrix
+            classNames='w-5 h-5'
+            dotClassNames='bg-primary-500'
+            dim={4}
+            dotSize={3}
+            count={10}
+            interval={500}
+            active={isRunning}
+          />
+        </NaturalChatStatus.Icon>
+      )}
+      {show && (
+        <div role='none' className='flex items-center'>
+          {requestTiming && (
+            <NaturalChatStatus.Text>
+              <Elapsed timing={requestTiming} />
+            </NaturalChatStatus.Text>
+          )}
+          {lastOutputTokens != null && (
+            <>
+              {requestTiming && <NaturalChatStatus.Separator />}
+              <NaturalChatStatus.Text>↓ {Unit.Thousand(lastOutputTokens).toString()}</NaturalChatStatus.Text>
+            </>
+          )}
+          {sessionTotalTokens > 0 && (
+            <>
+              {(requestTiming || lastOutputTokens != null) && <NaturalChatStatus.Separator />}
+              <NaturalChatStatus.Text>Σ {Unit.Thousand(sessionTotalTokens).toString()}</NaturalChatStatus.Text>
+            </>
+          )}
+        </div>
+      )}
+    </NaturalChatStatus.Root>
+  );
+};
+
+/**
+ * Wall-clock-derived elapsed display. Tick interval forces a re-render every second while
+ * the request is active so the displayed value advances; once `endedAt` is set, the value
+ * is frozen and the interval is no longer scheduled.
+ */
+const Elapsed = ({ timing }: { timing: ChatRequestTiming }) => {
+  const isRunning = timing.endedAt == null;
+  const [now, setNow] = useState(Date.now());
+  useEffect(() => {
+    if (!isRunning) {
+      return;
+    }
+
+    const id = setInterval(() => setNow(Date.now()), TICK_MS);
+    return () => clearInterval(id);
+  }, [isRunning]);
+
+  return <>{formatElapsed((timing.endedAt ?? now) - timing.startedAt)}</>;
+};
+
+const isStats = (block: ContentBlock.Any): block is ContentBlock.Stats => block._tag === 'stats';

package/src/components/ChatPrompt/ChatStatusIndicator.tsx

@@ -0,0 +1,42 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import React, { useEffect, useState } from 'react';
+
+import { type ThemedClassName, Tooltip, useTimeout } from '@dxos/react-ui';
+import { Spinner, type SpinnerProps } from '@dxos/react-ui-sfx';
+import { mx } from '@dxos/ui-theme';
+
+const period = 3_000;
+
+export type ChatStatusIndicatorProps = ThemedClassName<
+  {
+    preset?: string;
+    processing?: boolean;
+    error?: Error;
+  } & Pick<SpinnerProps, 'size' | 'onClick'>
+>;
+
+export const ChatStatusIndicator = ({ classNames, preset, processing, error, ...props }: ChatStatusIndicatorProps) => {
+  const [init, setInit] = useState(false);
+  useEffect(() => setInit(false), [preset]);
+  useTimeout(
+    async () => {
+      setInit(true);
+    },
+    period / 2,
+    [preset],
+  );
+
+  return (
+    <div role='none' className={mx('relative flex', classNames)}>
+      <Spinner duration={period} state={!init ? 'flash' : error ? 'error' : processing ? 'spin' : 'pulse'} {...props} />
+      {error && (
+        <Tooltip.Trigger asChild content={error.message}>
+          <div className='absolute inset-0' />
+        </Tooltip.Trigger>
+      )}
+    </div>
+  );
+};

package/src/components/ChatPrompt/index.ts

@@ -0,0 +1,12 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+export * from './ChatActions';
+export * from './ChatMcpErrors';
+export * from './ChatOptions';
+export * from './ChatPresets';
+export * from './ChatPrompt';
+export * from './ChatReferences';
+export * from './ChatStatusIndicator';
+export * from './ChatStatus';

package/src/components/ChatThread/Anchor.stories.tsx

@@ -0,0 +1,95 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+import * as Effect from 'effect/Effect';
+import React from 'react';
+
+import { withPluginManager } from '@dxos/app-framework/testing';
+import { Database, Filter, Obj } from '@dxos/echo';
+import { DxAnchor } from '@dxos/lit-ui/react';
+import { ClientPlugin } from '@dxos/plugin-client';
+import { initializeIdentity } from '@dxos/plugin-client/testing';
+import { PreviewPlugin } from '@dxos/plugin-preview';
+import { StorybookPlugin, corePlugins } from '@dxos/plugin-testing';
+import { useQuery, useSpaces } from '@dxos/react-client/echo';
+import { Loading, withLayout } from '@dxos/react-ui/testing';
+import { Organization } from '@dxos/types';
+
+/**
+ * Production-style click → popover demo.
+ *
+ * Wires up the same chain Composer uses:
+ * - `<DxAnchor dxn=…>label</DxAnchor>` fires `DxAnchorActivate` on click.
+ * - `PreviewPlugin`'s `preview-popover` capability listens for the event, resolves the DXN
+ *   to a real ECHO object via `space.db.makeRef(dxn).load()`, then invokes
+ *   `LayoutOperation.UpdatePopover`.
+ * - `StorybookPlugin` provides both the `LayoutOperation.UpdatePopover` handler (mutating
+ *   the layout-state atom) and the `<Layout>` shell that renders the popover via
+ *   `<Surface.Surface type={AppSurface.Card} data={popoverContent}>`.
+ * - `PreviewPlugin` also registers Card-role surfaces (Organization, Person, Task, …); the
+ *   Surface system picks the matching one based on the resolved object's type.
+ *
+ * Click the anchor — the matching Card surface (from plugin-preview) renders inside the
+ * popover, anchored to the trigger.
+ */
+const DefaultStory = () => {
+  const [space] = useSpaces();
+  const [organization] = useQuery(space?.db, Filter.type(Organization.Organization));
+  if (!organization) {
+    return <Loading />;
+  }
+
+  const dxn = Obj.getDXN(organization).toString();
+  return (
+    <div role='none' className='flex flex-col gap-2 p-4'>
+      <p>
+        Click{' '}
+        <DxAnchor className='dx-tag--anchor' dxn={dxn}>
+          {organization.name}
+        </DxAnchor>{' '}
+        to open the popover.
+      </p>
+    </div>
+  );
+};
+
+const meta = {
+  title: 'plugins/plugin-assistant/components/ChatThread/Anchor',
+  render: DefaultStory,
+  decorators: [
+    withLayout({ layout: 'centered' }),
+    withPluginManager({
+      plugins: [
+        ...corePlugins(),
+        StorybookPlugin({}),
+        PreviewPlugin(),
+        ClientPlugin({
+          types: [Organization.Organization],
+          onClientInitialized: Effect.fnUntraced(function* ({ client }) {
+            const { personalSpace } = yield* initializeIdentity(client);
+            yield* Effect.gen(function* () {
+              yield* Database.add(
+                Obj.make(Organization.Organization, {
+                  name: 'DXOS',
+                  website: 'https://dxos.org',
+                  description: 'A decentralized network for collaborative applications.',
+                }),
+              );
+            }).pipe(Effect.provide(Database.layer(personalSpace.db)));
+          }),
+        }),
+      ],
+    }),
+  ],
+  parameters: {
+    layout: 'centered',
+  },
+} satisfies Meta<typeof DefaultStory>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {};

package/src/components/ChatThread/ChatThread.stories.tsx

@@ -0,0 +1,143 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+import * as Effect from 'effect/Effect';
+import * as Fiber from 'effect/Fiber';
+import * as Layer from 'effect/Layer';
+import React, { useEffect, useMemo, useState } from 'react';
+
+import { withPluginManager } from '@dxos/app-framework/testing';
+import { Database } from '@dxos/echo';
+import { runAndForwardErrors } from '@dxos/effect';
+import { ContextQueueService } from '@dxos/functions';
+import { ClientPlugin } from '@dxos/plugin-client';
+import { initializeIdentity } from '@dxos/plugin-client/testing';
+import { PreviewPlugin } from '@dxos/plugin-preview';
+import { StorybookPlugin, corePlugins } from '@dxos/plugin-testing';
+import { random } from '@dxos/random';
+import { type Queue, useSpaces } from '@dxos/react-client/echo';
+import { EditorPreviewProvider } from '@dxos/react-ui-editor';
+import { Loading, withLayout, withTheme } from '@dxos/react-ui/testing';
+import { Message, Organization, Person } from '@dxos/types';
+
+import { createMessageGenerator } from '#testing';
+import { translations } from '#translations';
+
+import { ChatThread, type ChatThreadProps } from './ChatThread';
+
+random.seed(1);
+
+type MessageGenerator = Effect.Effect<void, never, Database.Service | ContextQueueService>;
+
+type DefaultStoryProps = { generator?: MessageGenerator[]; delay?: number; wait?: boolean } & ChatThreadProps;
+
+const DefaultStory = ({ generator = [], delay = 0, wait, ...props }: DefaultStoryProps) => {
+  const [space] = useSpaces();
+  const queue = useMemo<Queue<Message.Message> | undefined>(() => space?.queues.create(), [space]);
+  const messages = useQueueMessages(queue);
+  const [done, setDone] = useState(false);
+
+  // Generate messages.
+  useEffect(() => {
+    if (!space || !queue) {
+      return;
+    }
+
+    const fiber = Effect.runFork(
+      Effect.gen(function* () {
+        for (const step of generator) {
+          yield* step;
+          if (delay) {
+            yield* Effect.sleep(delay);
+          }
+        }
+
+        setDone(true);
+      }).pipe(Effect.provide(Layer.mergeAll(Database.layer(space.db), ContextQueueService.layer(queue)))),
+    );
+
+    return () => {
+      void runAndForwardErrors(Fiber.interrupt(fiber));
+    };
+  }, [space, queue, generator, delay]);
+
+  if (wait && !done) {
+    return <Loading data={{ wait, done }} />;
+  }
+
+  return (
+    <EditorPreviewProvider onLookup={async ({ dxn, label }) => ({ label, text: dxn })}>
+      <ChatThread {...props} messages={messages} />
+    </EditorPreviewProvider>
+  );
+};
+
+const useQueueMessages = (queue?: Queue<Message.Message>) => {
+  const [messages, setMessages] = useState<Message.Message[]>([]);
+
+  useEffect(() => {
+    if (!queue) {
+      setMessages([]);
+      return;
+    }
+
+    const update = () => setMessages([...queue.objects]);
+    update();
+    return queue.subscribe(update);
+  }, [queue]);
+
+  return messages;
+};
+
+const meta = {
+  title: 'plugins/plugin-assistant/components/ChatThread',
+  component: ChatThread,
+  render: DefaultStory,
+  decorators: [
+    withTheme(),
+    withLayout({ layout: 'column' }),
+    withPluginManager({
+      plugins: [
+        ...corePlugins(),
+        StorybookPlugin({}),
+        PreviewPlugin(),
+        ClientPlugin({
+          types: [Organization.Organization, Person.Person],
+          onClientInitialized: ({ client }) =>
+            Effect.gen(function* () {
+              yield* initializeIdentity(client);
+            }),
+        }),
+      ],
+    }),
+  ],
+  parameters: {
+    layout: 'fullscreen',
+    translations,
+  },
+} satisfies Meta<DefaultStoryProps>;
+
+export default meta;
+
+type Story = StoryObj<DefaultStoryProps>;
+
+export const Default: Story = {
+  args: {
+    generator: createMessageGenerator(),
+    wait: true,
+  },
+};
+
+export const Delayed: Story = {
+  args: {
+    generator: createMessageGenerator(),
+    delay: 500,
+    options: {
+      autoScroll: true,
+      typewriter: true,
+      cursor: true,
+    },
+  },
+};

package/src/components/ChatThread/ChatThread.tsx

@@ -0,0 +1,113 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import React, { forwardRef, useCallback, useEffect, useMemo, useState } from 'react';
+
+import { PublicKey } from '@dxos/keys';
+import { type Identity } from '@dxos/react-client/halo';
+import { type ThemedClassName, setRef } from '@dxos/react-ui';
+import { MarkdownStream, type MarkdownStreamController, type MarkdownStreamProps } from '@dxos/react-ui-markdown';
+import { type Message } from '@dxos/types';
+import { keyToFallback } from '@dxos/util';
+
+import { type Assistant } from '../../types';
+import { type ChatEvent } from '../Chat';
+import { componentRegistry, createBlockRenderer } from './registry';
+import { MessageSyncer } from './sync';
+
+const defaultOptions: MarkdownStreamProps['options'] = {
+  autoScroll: true,
+  cursor: false,
+  fader: false,
+  typewriter: true,
+};
+
+export type ChatThreadProps = ThemedClassName<
+  {
+    identity?: Identity;
+    messages?: Message.Message[];
+    error?: Error;
+    viewType?: Assistant.ChatView;
+    onEvent?: (event: ChatEvent) => void;
+  } & Pick<MarkdownStreamProps, 'options' | 'debug' | 'extensions' | 'footer'>
+>;
+
+export const ChatThread = forwardRef<MarkdownStreamController | null, ChatThreadProps>(
+  (
+    {
+      classNames,
+      identity,
+      messages = [],
+      error,
+      options = defaultOptions,
+      footer,
+      debug = false,
+      extensions,
+      viewType,
+      onEvent,
+    },
+    forwardedRef,
+  ) => {
+    const [controller, setController] = useState<MarkdownStreamController | null>(null);
+    const handleMarkdownStreamRef = useCallback(
+      (instance: MarkdownStreamController | null) => {
+        setController(instance);
+        setRef(forwardedRef, instance);
+      },
+      [forwardedRef],
+    );
+
+    const userHue = useMemo(
+      () => identity?.profile?.data?.hue || keyToFallback(identity?.identityKey ?? PublicKey.random()).hue,
+      [identity],
+    );
+
+    // Show error.
+    useEffect(() => {
+      controller?.scrollToBottom();
+    }, [controller, error]);
+
+    // Update document.
+    const renderer = useMemo(() => createBlockRenderer(viewType), [viewType]);
+    const syncer = useMemo(() => controller && new MessageSyncer(controller, renderer), [controller, renderer]);
+    useEffect(() => {
+      if (!syncer) {
+        return;
+      }
+
+      if (syncer.update(messages)) {
+        controller?.scrollToBottom('instant');
+      }
+    }, [controller, syncer, messages]);
+
+    // Event adapter.
+    const handleEvent = useCallback<NonNullable<MarkdownStreamProps['onEvent']>>(
+      ({ type, value }) => {
+        switch (type) {
+          case 'submit': {
+            value && onEvent?.({ type, text: value });
+            break;
+          }
+        }
+      },
+      [onEvent],
+    );
+
+    return (
+      <div role='none' data-hue={userHue} className='contents'>
+        <MarkdownStream
+          key={viewType}
+          classNames={classNames}
+          registry={componentRegistry}
+          options={options}
+          debug={debug}
+          extensions={extensions}
+          footer={footer}
+          onEvent={handleEvent}
+          ref={handleMarkdownStreamRef}
+        />
+      </div>
+    );
+  },
+);

package/src/components/ChatThread/DEBUG.md

@@ -0,0 +1,41 @@
+# Dataflow from AI to Codemirror
+
+AiSession (packages/core/assistant/src/conversation/session.ts)
+│
+│ emits ephemeral Trace events containing
+│ PartialBlock { messageId, role, block: ContentBlock.Any }
+│ via AgentService.Session.subscribeEphemeral(): Stream<Trace.Message>
+▼
+AiChatProcessor (packages/plugins/plugin-assistant/src/processor/processor.ts)
+│
+│ Stream.runForEach → if Trace.isOfType(PartialBlock) →
+│ #handleEphemeralMessage(event.data)
+│ → upserts Message.Message into #streaming atom
+│ → finalizes into #messages atom on complete block
+▼
+Chat.tsx (packages/plugins/plugin-assistant/src/components/Chat/Chat.tsx)
+│
+│ reads processor.messages + processor.streaming atoms,
+│ passes flat Message[] down to ChatThread
+▼
+ChatThread.tsx (packages/plugins/plugin-assistant/src/components/ChatThread/ChatThread.tsx)
+│
+│ MessageSyncer (sync.ts) compares current messages
+│ to last rendered set:
+│ - new finalized chunk → controller.append(delta)
+│ - changed earlier message → controller.setContent(full)
+│ blockToMarkdown serializes ContentBlocks → markdown,
+│ embedding tool calls as XML widget tags
+│ (e.g. <tool-call name="...">...</tool-call>)
+▼
+MarkdownStreamController.append / setContent
+▼
+MarkdownStream (packages/ui/react-ui-markdown/src/MarkdownStream/MarkdownStream.tsx)
+│
+│ CodeMirror editor with:
+│ - extendedMarkdown (parseMixed → xmlLanguage on HTMLBlock/Paragraph)
+│ - xmlTags (registry → React/native widget portals)
+│ - wire extension (buffers appended text, drips at typewriter rate,
+│ treats XML atomic ranges as indivisible units)
+▼
+Rendered DOM (markdown + portaled widgets for tool calls / reasoning / etc.)

package/src/components/ChatThread/Link.tsx

@@ -0,0 +1,26 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import React, { useMemo } from 'react';
+
+import { type Space } from '@dxos/client/echo';
+import { Entity } from '@dxos/echo';
+import { type DXN } from '@dxos/keys';
+import { DxAnchor } from '@dxos/lit-ui/react';
+
+export type ObjectLinkProps = {
+  space: Space;
+  dxn: DXN;
+};
+
+export const ObjectLink = ({ space, dxn }: ObjectLinkProps) => {
+  const ref = useMemo(() => space.db.makeRef(dxn), [space, dxn.toString()]);
+
+  const title = (ref.target && Entity.getLabel(ref.target)) ?? ref.target?.id ?? ref.dxn.toString();
+  return (
+    <DxAnchor rootclassname='dx-tag--anchor' dxn={dxn.toString()}>
+      {title}
+    </DxAnchor>
+  );
+};