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

package/src/components/MarkdownContainer.stories.tsx

@@ -1,137 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import { type Meta, type StoryObj } from '@storybook/react-vite';
-import React, { useMemo } from 'react';
-
-import {
-  type Capabilities,
-  IntentPlugin,
-  LayoutAction,
-  SettingsPlugin,
-  Surface,
-  createIntent,
-  useIntentDispatcher,
-} from '@dxos/app-framework';
-import { withPluginManager } from '@dxos/app-framework/testing';
-import { Obj, Query } from '@dxos/echo';
-import { AttentionPlugin } from '@dxos/plugin-attention';
-import { ClientPlugin } from '@dxos/plugin-client';
-import { GraphPlugin } from '@dxos/plugin-graph';
-import { PreviewPlugin } from '@dxos/plugin-preview';
-import { SpacePlugin } from '@dxos/plugin-space';
-import { StorybookLayoutPlugin } from '@dxos/plugin-storybook-layout';
-import { ThemePlugin } from '@dxos/plugin-theme';
-import { faker } from '@dxos/random';
-import { fullyQualifiedId, useQuery, useSpace } from '@dxos/react-client/echo';
-import { useAsyncEffect } from '@dxos/react-ui';
-import { withLayout, withTheme } from '@dxos/react-ui/testing';
-import { useAttentionAttributes } from '@dxos/react-ui-attention';
-import { defaultTx } from '@dxos/react-ui-theme';
-import { DataType } from '@dxos/schema';
-import { type ValueGenerator, createObjectFactory } from '@dxos/schema/testing';
-
-import { MarkdownPlugin } from '../MarkdownPlugin';
-import { translations } from '../translations';
-import { Markdown } from '../types';
-
-faker.seed(1);
-
-const generator: ValueGenerator = faker as any;
-
-const DefaultStory = () => {
-  const { dispatchPromise: dispatch } = useIntentDispatcher();
-  const space = useSpace();
-  const [doc] = useQuery(space, Query.type(Markdown.Document));
-  const data = useMemo(() => ({ subject: doc }), [doc]);
-  const id = doc && fullyQualifiedId(doc);
-  const attentionAttrs = useAttentionAttributes(id);
-
-  useAsyncEffect(async () => {
-    if (space) {
-      await dispatch(createIntent(LayoutAction.SwitchWorkspace, { part: 'workspace', subject: space.id }));
-    }
-  }, [space, dispatch]);
-
-  return (
-    <div className='contents' {...attentionAttrs}>
-      <Surface role='article' data={data} limit={1} />
-    </div>
-  );
-};
-
-const meta = {
-  title: 'plugins/plugin-markdown/MarkdownContainer',
-  render: DefaultStory,
-  decorators: [
-    withTheme,
-    withLayout({ container: 'column' }),
-    withPluginManager<{ title?: string; content?: string }>((context) => ({
-      plugins: [
-        ClientPlugin({
-          types: [Markdown.Document, DataType.Text, DataType.Person, DataType.Organization],
-          onClientInitialized: async ({ client }) => {
-            await client.halo.createIdentity();
-            await client.spaces.waitUntilReady();
-            await client.spaces.default.waitUntilReady();
-
-            const space = client.spaces.default;
-            const createObjects = createObjectFactory(space.db, generator);
-            await createObjects([{ type: DataType.Organization, count: 10 }]);
-
-            const queue = space.queues.create();
-            const kai = Obj.make(DataType.Person, { fullName: 'Kai' });
-            const dxos = Obj.make(DataType.Organization, { name: 'DXOS' });
-            await queue.append([kai, dxos]);
-
-            space.db.add(
-              Markdown.makeDocument({
-                name: context.args.title ?? 'Testing',
-                content: [
-                  `# ${context.args.title ?? 'Testing'}`,
-                  context.args.content ?? '',
-                  // TODO(burdon): Popovers not currently working.
-                  '## Here are some objects',
-                  `![Alice](${Obj.getDXN(kai)})`,
-                  `![DXOS](${Obj.getDXN(dxos)})`,
-                  '',
-                  'END',
-                  '',
-                ].join('\n\n'),
-              }),
-            );
-
-            await space.db.flush({ indexes: true });
-          },
-        }),
-        SpacePlugin({}),
-        GraphPlugin(),
-        IntentPlugin(),
-        SettingsPlugin(),
-        // UI
-        ThemePlugin({ tx: defaultTx }),
-        AttentionPlugin(),
-        MarkdownPlugin(),
-        PreviewPlugin(),
-        StorybookLayoutPlugin({}),
-      ],
-    })),
-  ],
-  parameters: {
-    layout: 'fullscreen',
-    controls: { disable: true },
-    translations,
-  },
-} satisfies Meta<typeof Capabilities>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const Default: Story = {
-  args: {
-    title: 'Testing',
-    content: ['This is a line with **some** formatting.'].join('\n\n'),
-  },
-};

package/src/components/MarkdownContainer.tsx

@@ -1,121 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { type Extension } from '@codemirror/state';
-import { Rx } from '@effect-rx/rx-react';
-import React, { useMemo } from 'react';
-
-import { Capabilities, useAppGraph, useCapabilities } from '@dxos/app-framework';
-import { Obj } from '@dxos/echo';
-import { fullyQualifiedId, getSpace } from '@dxos/react-client/echo';
-import { type SelectionManager } from '@dxos/react-ui-attention';
-import { StackItem } from '@dxos/react-ui-stack';
-import { DataType } from '@dxos/schema';
-
-import { MarkdownCapabilities } from '../capabilities';
-import { type DocumentType, useLinkQuery } from '../hooks';
-import { Markdown, type MarkdownPluginState } from '../types';
-
-import { MarkdownEditor, type MarkdownEditorContentProps, type MarkdownEditorRootProps } from './MarkdownEditor';
-
-export type MarkdownContainerProps = {
-  role?: string;
-  object: DocumentType;
-  settings: Markdown.Settings;
-  selectionManager?: SelectionManager;
-} & (Pick<MarkdownEditorRootProps, 'id' | 'viewMode' | 'onViewModeChange'> &
-  Pick<MarkdownEditorContentProps, 'editorStateStore'> &
-  Pick<MarkdownPluginState, 'extensionProviders'>);
-
-// TODO(burdon): Attention doesn't update in storybook.
-// TODO(burdon): Toolbar state (currently not working in labs: e.g., heading, list, table).
-//  Heading state is correct (see react-ui-editor headings.ts, but the toolbar isn't updated).
-// TODO(burdon): View mode (currently not working in labs).
-// TODO(burdon): Test update document name.
-// TODO(burdon): Test comment threads.
-// TODO(burdon): Test preview blocks.
-// TODO(burdon): Test file upload.
-
-export const MarkdownContainer = ({
-  id,
-  role,
-  object,
-  settings,
-  extensionProviders,
-  ...props
-}: MarkdownContainerProps) => {
-  const space = getSpace(object);
-  const isDocument = Obj.instanceOf(Markdown.Document, object);
-  const isText = Obj.instanceOf(DataType.Text, object);
-  const attendableId = isDocument ? fullyQualifiedId(object) : undefined;
-
-  // Extensions from other plugins.
-  // TODO(burdon): Document MarkdownPluginState.extensionProviders
-  const otherExtensionProviders = useCapabilities(MarkdownCapabilities.Extensions);
-  const extensions = useMemo<Extension[]>(() => {
-    if (!Obj.instanceOf(Markdown.Document, object)) {
-      return [];
-    }
-
-    return [...(otherExtensionProviders ?? []), ...(extensionProviders ?? [])]
-      .flat()
-      .reduce((acc: Extension[], provider) => {
-        const extension =
-          typeof provider === 'function' ? provider({ document: object as Markdown.Document }) : provider;
-        if (extension) {
-          acc.push(extension);
-        }
-
-        return acc;
-      }, []);
-  }, [extensionProviders, otherExtensionProviders, object]);
-
-  // Toolbar actions from app graph.
-  const { graph } = useAppGraph();
-  const customActions = useMemo(() => {
-    return Rx.make((get) => {
-      const actions = get(graph.actions(id));
-      const nodes = actions.filter((action) => action.properties.disposition === 'toolbar');
-      const edges = nodes.map((node) => ({ source: 'root', target: node.id }));
-      return { nodes, edges };
-    });
-  }, [graph]);
-
-  // File upload.
-  const [upload] = useCapabilities(Capabilities.FileUploader);
-  const handleFileUpload = useMemo(() => {
-    if (!space || !upload) {
-      return undefined;
-    }
-
-    return async (file: File) => upload(space, file);
-  }, [space, upload]);
-
-  // Query for @ refs.
-  const handleLinkQuery = useLinkQuery(space);
-
-  return (
-    <StackItem.Content toolbar={settings.toolbar}>
-      <MarkdownEditor.Root
-        id={attendableId ?? id}
-        object={object}
-        extensions={extensions}
-        onFileUpload={handleFileUpload}
-        onLinkQuery={handleLinkQuery}
-        {...props}
-      >
-        {settings.toolbar && (
-          <MarkdownEditor.Toolbar id={attendableId ?? id} role={role} customActions={customActions} />
-        )}
-        <MarkdownEditor.Content
-          initialValue={isDocument ? object.content?.target?.content : isText ? object.content : object.text}
-          scrollPastEnd={role === 'article'}
-        />
-        <MarkdownEditor.Blocks />
-      </MarkdownEditor.Root>
-    </StackItem.Content>
-  );
-};
-
-export default MarkdownContainer;

package/src/components/Suggestions.stories.tsx

@@ -1,219 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import { type Meta } from '@storybook/react-vite';
-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 { Capabilities, IntentPlugin, SettingsPlugin, useCapability, useIntentDispatcher } from '@dxos/app-framework';
-import { withPluginManager } from '@dxos/app-framework/testing';
-import { Obj, Ref, Type } from '@dxos/echo';
-import { invariant } from '@dxos/invariant';
-import { ClientPlugin } from '@dxos/plugin-client';
-import { GraphPlugin } from '@dxos/plugin-graph';
-import { PreviewPlugin } from '@dxos/plugin-preview';
-import { SpacePlugin } from '@dxos/plugin-space';
-import { StorybookLayoutPlugin } from '@dxos/plugin-storybook-layout';
-import { ThemePlugin } from '@dxos/plugin-theme';
-import { faker } from '@dxos/random';
-import { createDocAccessor, fullyQualifiedId, toCursorRange, useQueue, useSpace } from '@dxos/react-client/echo';
-import { IconButton, Toolbar } from '@dxos/react-ui';
-import { withTheme } from '@dxos/react-ui/testing';
-import { type EditorSelection, type Range, useTextEditor } from '@dxos/react-ui-editor';
-import { StackItem } from '@dxos/react-ui-stack';
-import { defaultTx } from '@dxos/react-ui-theme';
-import { DataType } from '@dxos/schema';
-import { render } from '@dxos/storybook-utils';
-
-import { MarkdownCapabilities } from '../capabilities';
-import { MarkdownPlugin } from '../MarkdownPlugin';
-import { meta } from '../meta';
-import { translations } from '../translations';
-import { Markdown } 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.Obj({
-    typename: 'dxos.org/type/Test',
-    version: '0.1.0',
-  }),
-);
-
-const TestChat: FC<{ doc: Markdown.Document; content: string }> = ({ doc, content }) => {
-  const { dispatchPromise: dispatch } = useIntentDispatcher();
-  const { parentRef } = useTextEditor({ initialValue: content });
-  const { editorState } = useCapability(MarkdownCapabilities.State);
-
-  const space = useSpace();
-  const queueDxn = useMemo(() => space && space.queues.create().dxn, [space]);
-  const queue = useQueue<DataType.Message>(queueDxn);
-
-  const handleInsert = async () => {
-    invariant(space);
-    invariant(queue);
-    await queue.append([
-      Obj.make(DataType.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(fullyQualifiedId(doc))?.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 Type.Expando,
-    //     object: Ref.fromDXN(new DXN(DXN.kind.QUEUE, [...queue.dxn.parts, message.id])),
-    //     at: cursor,
-    //     label: 'Proposal',
-    //   }),
-    // );
-  };
-
-  return (
-    <StackItem.Content toolbar>
-      <Toolbar.Root>
-        <IconButton icon='ph--plus--regular' disabled={!queue} label='Insert' onClick={handleInsert} />
-      </Toolbar.Root>
-      <div ref={parentRef} className='p-4' />
-    </StackItem.Content>
-  );
-};
-
-const DefaultStory = ({ document, chat }: { document: string; chat: string }) => {
-  const space = useSpace();
-  const [doc, setDoc] = useState<Markdown.Document>();
-  const settings = useCapability(Capabilities.SettingsStore).getStore<Markdown.Settings>(meta.id)!.value;
-  const { editorState } = useCapability(MarkdownCapabilities.State);
-
-  useEffect(() => {
-    if (!space) {
-      return undefined;
-    }
-
-    const doc = space.db.add(
-      Markdown.makeDocument({
-        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;
-  }
-
-  // TODO(burdon): Layout issue.
-  return (
-    <div className='grid grid-cols-2 bs-full overflow-hidden'>
-      <MarkdownContainer id={doc.id} object={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: [
-        ClientPlugin({
-          types: [Markdown.Document, TestItem],
-          onClientInitialized: async ({ client }) => {
-            await client.halo.createIdentity();
-          },
-        }),
-        SpacePlugin({}),
-        GraphPlugin(),
-        IntentPlugin(),
-        SettingsPlugin(),
-
-        // UI
-        ThemePlugin({ tx: defaultTx }),
-        MarkdownPlugin(),
-        PreviewPlugin(),
-        StorybookLayoutPlugin({}),
-      ],
-    }),
-  ],
-  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/events.ts

@@ -1,11 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Events } from '@dxos/app-framework';
-
-import { meta } from './meta';
-
-export namespace MarkdownEvents {
-  export const SetupExtensions = Events.createStateEvent(`${meta.id}/event/setup-extensions`);
-}

package/src/functions/diff.ts

@@ -1,37 +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 { createDocAccessor } from '@dxos/echo-db';
-import { DatabaseService, 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/diff',
-  name: 'Diff',
-  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* DatabaseService.resolve(ArtifactId.toDXN(id), Markdown.Document);
-    const content = yield* Effect.promise(() => object.content.load());
-    const accessor = createDocAccessor(content, ['content']);
-    applyDiffs(accessor, diffs);
-  }),
-});

package/src/functions/index.ts

@@ -1,6 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-export { default as diff } from './diff';
-export { default as open } from './open';

package/src/functions/open.ts

@@ -1,32 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import * as Effect from 'effect/Effect';
-import * as Schema from 'effect/Schema';
-
-import { ArtifactId } from '@dxos/assistant';
-import { DatabaseService, defineFunction } from '@dxos/functions';
-
-import { Markdown } from '../types';
-
-export default defineFunction({
-  key: 'dxos.org/function/markdown/open',
-  name: 'Open',
-  description: 'Opens and reads the contents of a new markdown document.',
-  inputSchema: Schema.Struct({
-    id: ArtifactId.annotations({
-      description: 'The ID of the markdown document.',
-    }),
-  }),
-  outputSchema: Schema.Struct({
-    content: Schema.String,
-  }),
-  handler: Effect.fn(function* ({ data: { id } }) {
-    const object = yield* DatabaseService.resolve(ArtifactId.toDXN(id), Markdown.Document);
-    const { content } = yield* Effect.promise(() => object.content.load());
-    return {
-      content,
-    };
-  }),
-});

package/src/hooks/useSelectCurrentThread.tsx

@@ -1,56 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { EditorView } from '@codemirror/view';
-import * as Schema from 'effect/Schema';
-import { useMemo } from 'react';
-
-import { LayoutAction, createResolver, useIntentResolver } from '@dxos/app-framework';
-import { invariant } from '@dxos/invariant';
-import { Cursor, setSelection } from '@dxos/react-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 scrollIntoViewResolver = useMemo(
-    () =>
-      createResolver({
-        intent: LayoutAction.UpdateLayout,
-        position: 'hoist',
-        filter: (data): data is { part: 'current'; subject: string; options: { cursor: string } } => {
-          if (!Schema.is(LayoutAction.ScrollIntoView.fields.input)(data)) {
-            return false;
-          }
-
-          return !!editorView && data.subject === documentId && !!data.options?.cursor;
-        },
-        resolve: ({ options: { cursor } }) => {
-          invariant(editorView, 'Editor view is not defined.');
-          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],
-  );
-
-  useIntentResolver(meta.id, scrollIntoViewResolver);
-};

package/src/types/MarkdownAction.ts

@@ -1,29 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import * as Schema from 'effect/Schema';
-
-import { EditorViewMode } from '@dxos/react-ui-editor/types';
-
-import { meta } from '../meta';
-
-import { Document } from './Markdown';
-
-export class Create extends Schema.TaggedClass<Create>()(`${meta.id}/action/create`, {
-  input: Schema.Struct({
-    name: Schema.optional(Schema.String),
-    content: Schema.optional(Schema.String),
-  }),
-  output: Schema.Struct({
-    object: Document,
-  }),
-}) {}
-
-export class SetViewMode extends Schema.TaggedClass<SetViewMode>()(`${meta.id}/action/set-view-mode`, {
-  input: Schema.Struct({
-    id: Schema.String,
-    viewMode: EditorViewMode,
-  }),
-  output: Schema.Void,
-}) {}