@dxos/plugin-markdown 0.8.4-main.bc674ce → 0.8.4-main.bcb3aa67d6

package/src/blueprints/functions/update.test.ts

@@ -1,149 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { describe, expect, it } from '@effect/vitest';
-import * as Effect from 'effect/Effect';
-import * as Layer from 'effect/Layer';
-
-import { AiService, ConsolePrinter } from '@dxos/ai';
-import { MemoizedAiService, TestAiService } from '@dxos/ai/testing';
-import {
-  AiConversation,
-  type ContextBinding,
-  GenerationObserver,
-  makeToolExecutionServiceFromFunctions,
-  makeToolResolverFromFunctions,
-} from '@dxos/assistant';
-import { Blueprint } from '@dxos/blueprints';
-import { SpaceProperties } from '@dxos/client-protocol';
-import { Obj, Query, Ref } from '@dxos/echo';
-import { Database } from '@dxos/echo';
-import { acquireReleaseResource } from '@dxos/effect';
-import { TestHelpers } from '@dxos/effect/testing';
-import { CredentialsService, FunctionInvocationService, QueueService, TracingService } from '@dxos/functions';
-import { FunctionInvocationServiceLayerTest, TestDatabaseLayer } from '@dxos/functions-runtime/testing';
-import { invariant } from '@dxos/invariant';
-import { ObjectId } from '@dxos/keys';
-import { Markdown } from '@dxos/plugin-markdown/types';
-import { Collection } from '@dxos/schema';
-import { HasSubject, type Message } from '@dxos/types';
-
-import { WithProperties, testToolkit } from '../../testing';
-import * as MarkdownBlueprint from '../markdown-blueprint';
-
-import update from './update';
-
-ObjectId.dangerouslyDisableRandomness();
-
-const TestLayer = Layer.mergeAll(
-  AiService.model('@anthropic/claude-opus-4-0'),
-  makeToolResolverFromFunctions(MarkdownBlueprint.functions, testToolkit),
-  makeToolExecutionServiceFromFunctions(testToolkit, testToolkit.toLayer({}) as any),
-).pipe(
-  Layer.provideMerge(
-    FunctionInvocationServiceLayerTest({
-      functions: MarkdownBlueprint.functions,
-    }),
-  ),
-  Layer.provideMerge(
-    Layer.mergeAll(
-      TestAiService(),
-      TestDatabaseLayer({
-        spaceKey: 'fixed',
-        indexing: { vector: true },
-        types: [SpaceProperties, Collection.Collection, Blueprint.Blueprint, Markdown.Document, HasSubject.HasSubject],
-      }),
-      CredentialsService.configuredLayer([]),
-      TracingService.layerNoop,
-    ),
-  ),
-);
-
-describe('update', () => {
-  it.effect(
-    'call a function to update a markdown document',
-    Effect.fnUntraced(
-      function* (_) {
-        const doc = Markdown.make({
-          name: 'BlueYard',
-          content: 'Founders and portfolio of BlueYard.',
-        });
-        yield* Database.Service.add(doc);
-
-        yield* FunctionInvocationService.invokeFunction(update, {
-          id: doc.id,
-          diffs: ['- Founders', '+ # Founders'],
-        });
-
-        const updatedDoc = yield* Database.Service.resolve(Obj.getDXN(doc), Markdown.Document);
-        expect(updatedDoc.name).toBe(doc.name);
-        const text = yield* Database.Service.load(updatedDoc.content);
-        expect(text.content).toBe('# Founders and portfolio of BlueYard.');
-      },
-      WithProperties,
-      Effect.provide(TestLayer),
-      TestHelpers.provideTestContext,
-    ),
-  );
-
-  it.scoped(
-    'create and update a markdown document',
-    Effect.fnUntraced(
-      function* (_) {
-        const queue = yield* QueueService.createQueue<Message.Message | ContextBinding>();
-        const conversation = yield* acquireReleaseResource(() => new AiConversation({ queue }));
-
-        yield* Database.Service.flush({ indexes: true });
-        const markdownBlueprint = yield* Database.Service.add(Obj.clone(MarkdownBlueprint.make()));
-        yield* Effect.promise(() =>
-          conversation.context.bind({
-            blueprints: [Ref.make(markdownBlueprint)],
-          }),
-        );
-
-        const observer = GenerationObserver.fromPrinter(new ConsolePrinter());
-
-        yield* conversation.createRequest({
-          observer,
-          prompt: `Create a document with a cookie recipe.`,
-        });
-        {
-          const docs = yield* Database.Service.runQuery(Query.type(Markdown.Document));
-          if (docs.length !== 1) {
-            throw new Error(`Expected 1 document; got ${docs.length}: ${docs.map((_) => _.name)}`);
-          }
-
-          const doc = docs[0];
-          invariant(Obj.instanceOf(Markdown.Document, doc));
-          console.log({
-            name: doc.name,
-            content: yield* Database.Service.load(doc.content).pipe(Effect.map((_) => _.content)),
-          });
-        }
-
-        yield* conversation.createRequest({
-          observer,
-          prompt: 'Add a section with a holiday-themed variation.',
-        });
-        {
-          const docs = yield* Database.Service.runQuery(Query.type(Markdown.Document));
-          if (docs.length !== 1) {
-            throw new Error(`Expected 1 document; got ${docs.length}: ${docs.map((_) => _.name)}`);
-          }
-
-          const doc = docs[0];
-          invariant(Obj.instanceOf(Markdown.Document, doc));
-          console.log({
-            name: doc.name,
-            content: yield* Database.Service.load(doc.content).pipe(Effect.map((_) => _.content)),
-          });
-        }
-      },
-      WithProperties,
-      Effect.provide(TestLayer),
-      TestHelpers.provideTestContext,
-    ),
-    MemoizedAiService.isGenerationEnabled() ? 240_000 : 30_000,
-  );
-});

package/src/blueprints/functions/update.ts

@@ -1,38 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import * as Effect from 'effect/Effect';
-import * as Schema from 'effect/Schema';
-
-import { ArtifactId, applyDiffs } from '@dxos/assistant';
-import { Database } from '@dxos/echo';
-import { createDocAccessor } from '@dxos/echo-db';
-import { defineFunction } from '@dxos/functions';
-import { trim } from '@dxos/util';
-
-import { Markdown } from '../../types';
-
-// TODO(wittjosiah): Reconcile with ThreadAction.AddProposal.
-export default defineFunction({
-  key: 'dxos.org/function/markdown/update',
-  name: 'Update',
-  description: trim`
-    Applies a set of diffs to the markdown document.
-  `,
-  inputSchema: Schema.Struct({
-    id: ArtifactId.annotations({
-      description: 'The ID of the markdown document.',
-    }),
-    diffs: Schema.Array(Schema.String).annotations({
-      description: 'The diffs to apply to the document.',
-    }),
-  }),
-  outputSchema: Schema.Void,
-  handler: Effect.fn(function* ({ data: { id, diffs } }) {
-    const object = yield* Database.Service.resolve(ArtifactId.toDXN(id), Markdown.Document);
-    const content = yield* Effect.promise(() => object.content.load());
-    const accessor = createDocAccessor(content, ['content']);
-    applyDiffs(accessor, diffs);
-  }),
-});

package/src/capabilities/anchor-sort/index.ts

@@ -1,7 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Capability } from '@dxos/app-framework';
-
-export const AnchorSort = Capability.lazy('AnchorSort', () => import('./anchor-sort'));

package/src/capabilities/app-graph-serializer/index.ts

@@ -1,7 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Capability } from '@dxos/app-framework';
-
-export const AppGraphSerializer = Capability.lazy('AppGraphSerializer', () => import('./app-graph-serializer'));

package/src/capabilities/artifact-definition/index.ts

@@ -1,7 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Capability } from '@dxos/app-framework';
-
-export const ArtifactDefinition = Capability.lazy('ArtifactDefinition', () => import('./artifact-definition'));

package/src/capabilities/blueprint-definition/blueprint-definition.ts

@@ -1,25 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import * as Effect from 'effect/Effect';
-
-import { Capability, Common } from '@dxos/app-framework';
-
-import { MarkdownBlueprint } from '../../blueprints';
-
-export const functions = MarkdownBlueprint.functions;
-
-export type BlueprintCapabilities = [
-  Capability.Capability<typeof Common.Capability.Functions>,
-  Capability.Capability<typeof Common.Capability.BlueprintDefinition>,
-];
-
-const blueprintDefinition = Capability.makeModule<[], BlueprintCapabilities>(() =>
-  Effect.succeed([
-    Capability.contributes(Common.Capability.Functions, functions),
-    Capability.contributes(Common.Capability.BlueprintDefinition, MarkdownBlueprint.make()),
-  ]),
-);
-
-export default blueprintDefinition;

package/src/capabilities/blueprint-definition/index.ts

@@ -1,7 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Capability } from '@dxos/app-framework';
-
-export const BlueprintDefinition = Capability.lazy('BlueprintDefinition', () => import('./blueprint-definition'));

package/src/capabilities/operation-resolver/index.ts

@@ -1,7 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Capability } from '@dxos/app-framework';
-
-export const OperationResolver = Capability.lazy('OperationResolver', () => import('./operation-resolver'));

package/src/capabilities/operation-resolver/operation-resolver.ts

@@ -1,45 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import * as Effect from 'effect/Effect';
-
-import { Capability, Common } from '@dxos/app-framework';
-import { Obj, Ref, Type } from '@dxos/echo';
-import { OperationResolver } from '@dxos/operation';
-import { Collection } from '@dxos/schema';
-
-import { Markdown, MarkdownCapabilities, MarkdownOperation } from '../../types';
-
-export default Capability.makeModule(
-  Effect.fnUntraced(function* () {
-    return Capability.contributes(Common.Capability.OperationResolver, [
-      OperationResolver.make({
-        operation: MarkdownOperation.OnCreateSpace,
-        handler: Effect.fnUntraced(function* ({ rootCollection }) {
-          const collection = Collection.makeManaged({ key: Type.getTypename(Markdown.Document) });
-          Obj.change(rootCollection, (c) => {
-            c.objects.push(Ref.make(collection));
-          });
-        }),
-      }),
-      OperationResolver.make({
-        operation: MarkdownOperation.Create,
-        handler: ({ name, content }) =>
-          Effect.succeed({
-            object: Markdown.make({ name, content }),
-          }),
-      }),
-      // TODO(wittjosiah): This appears to be unused.
-      OperationResolver.make({
-        operation: MarkdownOperation.SetViewMode,
-        handler: Effect.fnUntraced(function* ({ id, viewMode }) {
-          yield* Common.Capability.updateAtomValue(MarkdownCapabilities.State, (current) => ({
-            ...current,
-            viewMode: { ...current.viewMode, [id]: viewMode },
-          }));
-        }),
-      }),
-    ]);
-  }),
-);

package/src/capabilities/react-surface/index.ts

@@ -1,7 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Capability } from '@dxos/app-framework';
-
-export const ReactSurface = Capability.lazy('ReactSurface', () => import('./react-surface'));

package/src/capabilities/settings/index.ts

@@ -1,7 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Capability } from '@dxos/app-framework';
-
-export const MarkdownSettings = Capability.lazy('MarkdownSettings', () => import('./settings'));

package/src/capabilities/state/index.ts

@@ -1,7 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Capability } from '@dxos/app-framework';
-
-export const MarkdownState = Capability.lazy('MarkdownState', () => import('./state'));

package/src/capabilities/state/state.ts

@@ -1,31 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import * as Effect from 'effect/Effect';
-
-import { Capability } from '@dxos/app-framework';
-import { createKvsStore } from '@dxos/effect';
-import { createEditorStateStore } from '@dxos/ui-editor';
-
-import { meta } from '../../meta';
-import { MarkdownCapabilities, MarkdownStateSchema } from '../../types';
-
-export default Capability.makeModule(
-  Effect.fnUntraced(function* () {
-    // Persisted state using KVS store.
-    const stateAtom = createKvsStore({
-      key: `${meta.id}/state`,
-      schema: MarkdownStateSchema,
-      defaultValue: () => ({ viewMode: {} }),
-    });
-
-    // TODO(wittjosiah): Fold into state.
-    const editorState = createEditorStateStore(`${meta.id}/editor`);
-
-    return [
-      Capability.contributes(MarkdownCapabilities.State, stateAtom),
-      Capability.contributes(MarkdownCapabilities.EditorState, editorState),
-    ];
-  }),
-);

package/src/components/Suggestions.stories.tsx

@@ -1,215 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import { type Meta } from '@storybook/react-vite';
-import * as Effect from 'effect/Effect';
-import * as Function from 'effect/Function';
-import * as Match from 'effect/Match';
-import * as Option from 'effect/Option';
-import * as Schema from 'effect/Schema';
-import React, { type FC, useEffect, useMemo, useState } from 'react';
-
-import { useAtomCapability, useCapability } from '@dxos/app-framework/react';
-import { withPluginManager } from '@dxos/app-framework/testing';
-import { Obj, Ref, Type } from '@dxos/echo';
-import { createDocAccessor, toCursorRange } from '@dxos/echo-db';
-import { invariant } from '@dxos/invariant';
-import { ClientPlugin } from '@dxos/plugin-client';
-import { PreviewPlugin } from '@dxos/plugin-preview';
-import { StorybookPlugin, corePlugins } from '@dxos/plugin-testing';
-import { faker } from '@dxos/random';
-import { useQueue, useSpace } from '@dxos/react-client/echo';
-import { IconButton, Toolbar } from '@dxos/react-ui';
-import { withTheme } from '@dxos/react-ui/testing';
-import { useTextEditor } from '@dxos/react-ui-editor';
-import { Layout } from '@dxos/react-ui-mosaic';
-import { render } from '@dxos/storybook-utils';
-import { Message } from '@dxos/types';
-import { type EditorSelection, type Range } from '@dxos/ui-editor';
-
-import { MarkdownPlugin } from '../MarkdownPlugin';
-import { translations } from '../translations';
-import { Markdown, MarkdownCapabilities } from '../types';
-
-import { MarkdownContainer } from './MarkdownContainer';
-
-faker.seed(1);
-
-const TestItem = Schema.Struct({
-  title: Schema.String.annotations({
-    title: 'Title',
-    description: 'Product title',
-  }),
-  description: Schema.String.annotations({
-    title: 'Description',
-    description: 'Product description',
-  }),
-}).pipe(
-  Type.object({
-    typename: 'dxos.org/type/Test',
-    version: '0.1.0',
-  }),
-);
-
-const TestChat: FC<{ doc: Markdown.Document; content: string }> = ({ doc, content }) => {
-  const { parentRef } = useTextEditor({ initialValue: content });
-  const editorState = useCapability(MarkdownCapabilities.EditorState);
-
-  const space = useSpace();
-  const queueDxn = useMemo(() => space && space.queues.create().dxn, [space]);
-  const queue = useQueue<Message.Message>(queueDxn);
-
-  const handleInsert = async () => {
-    invariant(space);
-    invariant(queue);
-    await queue.append([
-      Obj.make(Message.Message, {
-        created: new Date().toISOString(),
-        sender: { role: 'assistant' },
-        blocks: [{ _tag: 'text', text: 'Hello' }],
-      }),
-    ]);
-    const message = queue.objects.at(-1);
-    invariant(message);
-
-    const text = await doc.content.load();
-    const accessor = createDocAccessor(text, ['content']);
-    const cursor = Function.pipe(
-      editorState.getState(Obj.getDXN(doc).toString())?.selection,
-      Option.fromNullable,
-      Option.map(selectionToRange),
-      Option.map((range) => toCursorRange(accessor, range.from, range.to)),
-      Option.getOrUndefined,
-    );
-
-    // {
-    //   const ref = refFromDXN(new DXN(DXN.kind.QUEUE, [...queue.dxn.parts, message.id]));
-    //   const message = deref(ref);
-    // }
-
-    // void dispatch(
-    //   createIntent(CollaborationActions.InsertContent, {
-    //     target: doc as any as TestSchema.Expando,
-    //     object: Ref.fromDXN(new DXN(DXN.kind.QUEUE, [...queue.dxn.parts, message.id])),
-    //     at: cursor,
-    //     label: 'Proposal',
-    //   }),
-    // );
-  };
-
-  return (
-    <Layout.Main toolbar>
-      <Toolbar.Root>
-        <IconButton icon='ph--plus--regular' disabled={!queue} label='Insert' onClick={handleInsert} />
-      </Toolbar.Root>
-      <div ref={parentRef} className='p-4' />
-    </Layout.Main>
-  );
-};
-
-const DefaultStory = ({ document, chat }: { document: string; chat: string }) => {
-  const space = useSpace();
-  const [doc, setDoc] = useState<Markdown.Document>();
-  const settings = useAtomCapability(MarkdownCapabilities.Settings);
-  const editorState = useCapability(MarkdownCapabilities.EditorState);
-
-  useEffect(() => {
-    if (!space) {
-      return undefined;
-    }
-
-    const doc = space.db.add(
-      Markdown.make({
-        name: 'Test',
-        content: document.replaceAll(/\[(\w+)\]/g, (_, label) => {
-          const obj = space.db.add(
-            Obj.make(TestItem, {
-              title: label,
-              description: faker.lorem.paragraph(),
-            }),
-          );
-          const dxn = Ref.make(obj).dxn.toString();
-          return `[${label}](${dxn})`;
-        }),
-      }),
-    );
-
-    setDoc(doc);
-  }, [space]);
-
-  if (!space || !doc) {
-    return null;
-  }
-
-  return (
-    <div className='grid grid-cols-2 bs-full overflow-hidden'>
-      <MarkdownContainer id={doc.id} subject={doc} settings={settings} editorStateStore={editorState} />
-      <TestChat doc={doc} content={chat} />
-    </div>
-  );
-};
-
-const storybook: Meta<typeof DefaultStory> = {
-  title: 'plugins/plugin-markdown/Suggestions',
-  render: render(DefaultStory),
-  decorators: [
-    withTheme,
-    withPluginManager({
-      plugins: [
-        ...corePlugins(),
-        StorybookPlugin({}),
-        ClientPlugin({
-          types: [Markdown.Document, TestItem],
-          onClientInitialized: ({ client }) =>
-            Effect.gen(function* () {
-              yield* Effect.promise(() => client.halo.createIdentity());
-            }),
-        }),
-
-        MarkdownPlugin(),
-        PreviewPlugin(),
-      ],
-    }),
-  ],
-  parameters: {
-    layout: 'fullscreen',
-    controls: {
-      disable: true,
-    },
-    translations,
-  },
-};
-
-export default storybook;
-
-type Story = Meta<typeof DefaultStory>;
-
-export const Default: Story = {
-  args: {
-    chat: 'Hello\n',
-    document: [
-      '# Test',
-      '',
-      faker.lorem.paragraph(1),
-      '',
-      'This is a [DXOS] story that tests [ECHO] references inside the Markdown plugin.',
-      '',
-      faker.lorem.paragraph(3),
-      '',
-    ].join('\n'),
-  },
-};
-
-// TODO(wittjosiah): Factor out.
-const selectionToRange = Match.type<EditorSelection>().pipe(
-  Match.when(
-    ({ head, anchor }) => (head ? head > anchor : false),
-    ({ head, anchor }) => ({ from: anchor, to: head! }) as Range,
-  ),
-  Match.when(
-    ({ head, anchor }) => (head ? head < anchor : false),
-    ({ head, anchor }) => ({ from: head!, to: anchor }) as Range,
-  ),
-  Match.orElse(({ anchor }) => ({ from: anchor, to: anchor }) as Range),
-);

package/src/hooks/useSelectCurrentThread.tsx

@@ -1,61 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { EditorView } from '@codemirror/view';
-import * as Effect from 'effect/Effect';
-import { useMemo } from 'react';
-
-import { Common } from '@dxos/app-framework';
-import { useOperationResolver } from '@dxos/app-framework/react';
-import { invariant } from '@dxos/invariant';
-import { OperationResolver } from '@dxos/operation';
-import { Cursor, setSelection } from '@dxos/ui-editor';
-
-import { meta } from '../meta';
-
-/**
- * Handle scrolling and selection of the current thread in a markdown editor.
- */
-export const useSelectCurrentThread = (editorView: EditorView | null, documentId: string) => {
-  const scrollIntoViewHandler = useMemo(
-    () =>
-      OperationResolver.make({
-        operation: Common.LayoutOperation.ScrollIntoView,
-        position: 'hoist',
-        filter: (input) => !!editorView && input.subject === documentId && !!input.cursor,
-        handler: (input) =>
-          Effect.sync(() => {
-            invariant(editorView, 'Editor view is not defined.');
-            const cursor = input.cursor;
-            if (!cursor) {
-              return;
-            }
-            const range = Cursor.getRangeFromCursor(editorView.state, cursor);
-            if (range) {
-              const selection =
-                editorView.state.selection.main.from !== range.from ? { anchor: range.from } : undefined;
-              const effects = [
-                // NOTE: This does not use the DOM scrollIntoView function.
-                EditorView.scrollIntoView(range.from, {
-                  y: 'start',
-                  yMargin: 96,
-                }),
-              ];
-              if (selection) {
-                // Update the editor selection to get bi-directional highlighting.
-                effects.push(setSelection.of({ current: documentId }));
-              }
-
-              editorView.dispatch({
-                effects,
-                selection: selection ? { anchor: range.from } : undefined,
-              });
-            }
-          }),
-      }),
-    [documentId, editorView],
-  );
-
-  useOperationResolver(meta.id, scrollIntoViewHandler);
-};