@dxos/plugin-markdown 0.8.4-main.406dc2a → 0.8.4-main.422d1c7879

package/src/components/Toolbar.stories.tsx

@@ -1,118 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { type Meta, type StoryObj } from '@storybook/react-vite';
-import React, { useCallback, useState } from 'react';
-
-import { createObject } from '@dxos/echo-db';
-import { invariant } from '@dxos/invariant';
-import { PublicKey } from '@dxos/keys';
-import { faker } from '@dxos/random';
-import { createDocAccessor } from '@dxos/react-client/echo';
-import { useThemeContext } from '@dxos/react-ui';
-import { withTheme } from '@dxos/react-ui/testing';
-import {
-  type Comment,
-  EditorToolbar,
-  type EditorViewMode,
-  comments,
-  createBasicExtensions,
-  createDataExtensions,
-  createMarkdownExtensions,
-  createThemeExtensions,
-  decorateMarkdown,
-  editorSlots,
-  formattingKeymap,
-  translations,
-  useComments,
-  useEditorToolbarState,
-  useFormattingState,
-  useTextEditor,
-} from '@dxos/react-ui-editor';
-import { DataType } from '@dxos/schema';
-
-faker.seed(101);
-
-type StoryProps = {
-  content?: string;
-};
-
-const DefaultStory = ({ content = '' }: StoryProps) => {
-  const { themeMode } = useThemeContext();
-  const [text] = useState(createObject(DataType.makeText(content)));
-  const toolbarState = useEditorToolbarState({ viewMode: 'preview' });
-  const formattingObserver = useFormattingState(toolbarState);
-  const { parentRef, view } = useTextEditor(() => {
-    return {
-      id: text.id,
-      initialValue: text.content,
-      extensions: [
-        formattingObserver,
-        createBasicExtensions({ readOnly: toolbarState.viewMode === 'readonly' }),
-        createMarkdownExtensions(),
-        createThemeExtensions({ themeMode, syntaxHighlighting: true, slots: editorSlots }),
-        createDataExtensions({ id: text.id, text: createDocAccessor(text, ['content']) }),
-        comments({
-          onCreate: ({ cursor }) => {
-            const id = PublicKey.random().toHex();
-            setComments((comments) => [...comments, { id, cursor }]);
-            return id;
-          },
-        }),
-        formattingKeymap(),
-        ...(toolbarState.viewMode !== 'source' ? [decorateMarkdown()] : []),
-      ],
-    };
-  }, [text, formattingObserver, toolbarState.viewMode, themeMode]);
-
-  const handleViewModeChange = (viewMode: EditorViewMode) => {
-    toolbarState.viewMode = viewMode;
-  };
-
-  const getView = useCallback(() => {
-    invariant(view);
-    return view;
-  }, [view]);
-
-  const [_comments, setComments] = useState<Comment[]>([]);
-  useComments(view, text.id, _comments);
-
-  return (
-    <div role='none' className='flex flex-col'>
-      <EditorToolbar state={toolbarState ?? {}} getView={getView} viewMode={handleViewModeChange} />
-      <div className='flex grow overflow-hidden' ref={parentRef} />
-    </div>
-  );
-};
-
-const content = [
-  '# Demo',
-  '',
-  'The editor supports **Markdown** styles.',
-  '',
-  faker.lorem.paragraph({ min: 5, max: 8 }),
-  '',
-  '',
-].join('\n');
-
-const meta = {
-  title: 'plugins/plugin-markdown/Toolbar',
-  component: EditorToolbar as any,
-  render: DefaultStory,
-  decorators: [withTheme],
-  parameters: {
-    layout: 'fullscreen',
-    translations,
-  },
-} satisfies Meta<typeof DefaultStory>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const Default: Story = {
-  args: {
-    content,
-  },
-};

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/extensions.tsx

@@ -1,300 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import { type ViewUpdate } from '@codemirror/view';
-import React, { type AnchorHTMLAttributes, type ReactNode, useMemo } from 'react';
-import { createRoot } from 'react-dom/client';
-
-import {
-  LayoutAction,
-  type PromiseIntentDispatcher,
-  createIntent,
-  useCapabilities,
-  useIntentDispatcher,
-} from '@dxos/app-framework';
-import { debounceAndThrottle } from '@dxos/async';
-import { invariant } from '@dxos/invariant';
-import { createDocAccessor, fullyQualifiedId, getSpace } from '@dxos/react-client/echo';
-import { useIdentity } from '@dxos/react-client/halo';
-import { Icon, ThemeProvider } from '@dxos/react-ui';
-import { type SelectionManager } from '@dxos/react-ui-attention';
-import {
-  Cursor,
-  type EditorStateStore,
-  EditorView,
-  type EditorViewMode,
-  type Extension,
-  InputModeExtensions,
-  type PreviewOptions,
-  type RenderCallback,
-  createDataExtensions,
-  decorateMarkdown,
-  documentId,
-  folding,
-  formattingKeymap,
-  linkTooltip,
-  listener,
-  preview,
-  selectionState,
-  typewriter,
-} from '@dxos/react-ui-editor';
-import { defaultTx } from '@dxos/react-ui-theme';
-import { type DataType } from '@dxos/schema';
-import { isTruthy } from '@dxos/util';
-
-import { MarkdownCapabilities } from './capabilities';
-import { type Markdown } from './types';
-import { setFallbackName } from './util';
-
-type ExtensionsOptions = {
-  document?: Markdown.Document;
-  id?: string;
-  text?: DataType.Text;
-  dispatch?: PromiseIntentDispatcher;
-  settings: Markdown.Settings;
-  selectionManager?: SelectionManager;
-  viewMode?: EditorViewMode;
-  editorStateStore?: EditorStateStore;
-  previewOptions?: PreviewOptions;
-};
-
-// TODO(burdon): Merge with createBaseExtensions below.
-export const useExtensions = ({
-  document,
-  id,
-  text,
-  settings,
-  selectionManager,
-  viewMode,
-  editorStateStore,
-  previewOptions,
-}: ExtensionsOptions): Extension[] => {
-  const { dispatchPromise: dispatch } = useIntentDispatcher();
-  const identity = useIdentity();
-  const space = getSpace(document) ?? getSpace(text);
-
-  // TODO(wittjosiah): Autocomplete is not working and this query is causing performance issues.
-  // TODO(burdon): Unsubscribe.
-  // const query = space?.db.query(Filter.type(DocumentType));
-  // query?.subscribe();
-  const baseExtensions = useMemo(
-    () =>
-      createBaseExtensions({
-        document,
-        id,
-        text,
-        settings,
-        selectionManager,
-        viewMode,
-        previewOptions,
-        dispatch,
-        // query,
-      }),
-    [
-      document,
-      id,
-      text,
-      viewMode,
-      dispatch,
-      previewOptions,
-      settings,
-      settings.editorInputMode,
-      settings.folding,
-      settings.numberedHeadings,
-      settings.debug,
-      settings.typewriter,
-      selectionManager,
-    ],
-  );
-
-  const extensionProviders = useCapabilities(MarkdownCapabilities.Extensions);
-
-  //
-  // External extensions from other plugins.
-  //
-  const pluginExtensions = useMemo<Extension[]>(() => {
-    if (!document) {
-      return [];
-    }
-
-    return extensionProviders.flat().reduce((acc: Extension[], provider) => {
-      const extension = typeof provider === 'function' ? provider({ document }) : provider;
-      if (extension) {
-        acc.push(extension);
-      }
-
-      return acc;
-    }, []);
-  }, [extensionProviders, document]);
-
-  //
-  // Basic plugins.
-  //
-  return useMemo<Extension[]>(
-    () =>
-      [
-        // NOTE: Data extensions must be first so that automerge is updated before other extensions compute their state.
-        document &&
-          createDataExtensions({
-            id: document.id,
-            text: document.content.target && createDocAccessor(document.content.target, ['content']),
-            space,
-            identity,
-          }),
-        text &&
-          id &&
-          createDataExtensions({
-            id,
-            text: createDocAccessor(text, ['content']),
-            space,
-            identity,
-          }),
-        selectionState(editorStateStore),
-        document &&
-          listener({
-            onChange: (text) => setFallbackName(document, text),
-          }),
-        baseExtensions,
-        pluginExtensions,
-      ].filter(isTruthy),
-    [baseExtensions, pluginExtensions, document, document?.content?.target, text, id, space, identity],
-  );
-};
-
-/**
- * Create extension instances for editor.
- */
-const createBaseExtensions = ({
-  document,
-  id,
-  dispatch,
-  settings,
-  selectionManager,
-  viewMode,
-  previewOptions,
-}: ExtensionsOptions): Extension[] => {
-  const extensions: Extension[] = [
-    selectionManager && selectionChange(selectionManager),
-    settings.editorInputMode && InputModeExtensions[settings.editorInputMode],
-    settings.folding && folding(),
-  ].filter(isTruthy);
-
-  //
-  // Markdown
-  //
-  if (viewMode !== 'source') {
-    extensions.push(
-      ...[
-        formattingKeymap(),
-        decorateMarkdown({
-          selectionChangeDelay: 100,
-          numberedHeadings: settings.numberedHeadings ? { from: 2 } : undefined,
-          // TODO(wittjosiah): For internal links, consider ignoring the link text and rendering the label of the object being linked to.
-          renderLinkButton:
-            dispatch && (document || id)
-              ? createLinkRenderer((id: string) => {
-                  void dispatch(
-                    createIntent(LayoutAction.Open, {
-                      part: 'main',
-                      subject: [id],
-                      options: {
-                        pivotId: document ? fullyQualifiedId(document) : id,
-                      },
-                    }),
-                  );
-                })
-              : undefined,
-        }),
-        linkTooltip(renderLinkTooltip),
-        preview(previewOptions),
-      ],
-    );
-  }
-
-  if (settings.debug) {
-    const items = settings.typewriter?.split(/[,\n]/) ?? '';
-    if (items) {
-      extensions.push(typewriter({ items }));
-    }
-  }
-
-  return extensions;
-};
-
-export const selectionChange = (selectionManager: SelectionManager) => {
-  return EditorView.updateListener.of(
-    debounceAndThrottle((update: ViewUpdate) => {
-      if (update.selectionSet) {
-        const id = update.state.facet(documentId);
-        const cursorConverter = update.state.facet(Cursor.converter);
-        const selection = update.state.selection;
-        const ranges = selection.ranges
-          .map((range) => ({
-            from: cursorConverter.toCursor(range.from),
-            to: cursorConverter.toCursor(range.to),
-          }))
-          .filter(({ from, to }) => to > from);
-        selectionManager.updateMultiRange(id, ranges);
-      }
-    }, 100),
-  );
-};
-
-// TODO(burdon): Factor out styles.
-const style = {
-  hover: 'rounded-sm text-primary-500 hover:text-primary-600 dark:text-primary-500 hover:dark:text-primary-400',
-  icon: 'inline-block leading-none mis-1 cursor-pointer',
-};
-
-const createLinkRenderer =
-  (onSelectObject: (id: string) => void): RenderCallback<{ url: string }> =>
-  (el, { url }) => {
-    // TODO(burdon): Formalize/document internal link format.
-    const isInternal =
-      url.startsWith('/') ||
-      // TODO(wittjosiah): This should probably be parsed out on paste?
-      url.startsWith(window.location.origin);
-
-    const options: AnchorHTMLAttributes<any> = isInternal
-      ? {
-          onClick: () => {
-            const qualifiedId = url.split('/').at(-1);
-            invariant(qualifiedId, 'Invalid link format.');
-            onSelectObject(qualifiedId);
-          },
-        }
-      : {
-          href: url,
-          rel: 'noreferrer',
-          target: '_blank',
-        };
-
-    renderRoot(
-      el,
-      <a {...options} className={style.hover}>
-        <Icon
-          icon={isInternal ? 'ph--arrow-square-down--bold' : 'ph--arrow-square-out--bold'}
-          size={4}
-          classNames={style.icon}
-        />
-      </a>,
-    );
-  };
-
-const renderLinkTooltip: RenderCallback<{ url: string }> = (el, { url }) => {
-  const web = new URL(url);
-  renderRoot(
-    el,
-    <a href={url} rel='noreferrer' target='_blank' className={style.hover}>
-      {web.origin}
-      <Icon icon='ph--arrow-square-out--bold' size={4} classNames={style.icon} />
-    </a>,
-  );
-};
-
-// TODO(burdon): Remove react rendering; use DOM directly.
-export const renderRoot = <T extends Element>(root: T, node: ReactNode): T => {
-  createRoot(root).render(<ThemeProvider tx={defaultTx}>{node}</ThemeProvider>);
-  return root;
-};

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,
-}) {}