@dxos/plugin-markdown 0.8.4-main.9735255 → 0.8.4-main.abd8ff62ef

package/src/components/MarkdownContainer.tsx

@@ -1,111 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { type Extension } from '@codemirror/state';
-import { Atom } from '@effect-atom/atom-react';
-import React, { forwardRef, useMemo } from 'react';
-
-import { Common } from '@dxos/app-framework';
-import { type SurfaceComponentProps, useAppGraph, useCapabilities } from '@dxos/app-framework/react';
-import { Obj } from '@dxos/echo';
-import { useActionRunner } from '@dxos/plugin-graph';
-import { useObject } from '@dxos/react-client/echo';
-import { type SelectionManager } from '@dxos/react-ui-attention';
-import { Layout } from '@dxos/react-ui-mosaic';
-import { Text } from '@dxos/schema';
-
-import { useLinkQuery } from '../hooks';
-import { Markdown, MarkdownCapabilities, type MarkdownPluginState } from '../types';
-
-import { MarkdownEditor, type MarkdownEditorContentProps, type MarkdownEditorRootProps } from './MarkdownEditor';
-
-export type MarkdownContainerProps = SurfaceComponentProps<
-  Markdown.Document | Text.Text,
-  {
-    id: string;
-    settings: Markdown.Settings;
-    selectionManager?: SelectionManager;
-  } & Pick<MarkdownEditorRootProps, 'viewMode' | 'onViewModeChange'> &
-    Pick<MarkdownEditorContentProps, 'editorStateStore'> &
-    Pick<MarkdownPluginState, 'extensionProviders'>
->;
-
-export const MarkdownContainer = forwardRef<HTMLDivElement, MarkdownContainerProps>(
-  ({ role, subject: object, id, settings, extensionProviders, ...props }, forwardedRef) => {
-    const db = Obj.isObject(object) ? Obj.getDatabase(object) : undefined;
-    const attendableId = Obj.instanceOf(Markdown.Document, object) ? Obj.getDXN(object).toString() : undefined;
-    const [docContent] = useObject(Obj.instanceOf(Markdown.Document, object) ? object.content : undefined, 'content');
-    const [textContent] = useObject(Obj.instanceOf(Text.Text, object) ? object : undefined, 'content');
-    const initialValue = docContent ?? textContent;
-
-    // Extensions from other plugins.
-    // TODO(burdon): Document MarkdownPluginState.extensionProviders
-    const otherExtensionProviders = useCapabilities(MarkdownCapabilities.Extensions);
-    const extensions = useMemo<Extension[]>(() => {
-      if (!Obj.instanceOf(Markdown.Document, object) && !Obj.instanceOf(Text.Text, 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 runAction = useActionRunner();
-    const customActions = useMemo(() => {
-      return Atom.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(Common.Capability.FileUploader);
-    const handleFileUpload = useMemo(() => {
-      if (!db || !upload) {
-        return undefined;
-      }
-
-      return async (file: File) => upload(db, file);
-    }, [db, upload]);
-
-    // Query for @ refs.
-    const handleLinkQuery = useLinkQuery(db);
-
-    return (
-      <Layout.Main toolbar={settings.toolbar} ref={forwardedRef}>
-        <MarkdownEditor.Root
-          id={attendableId ?? id}
-          object={object}
-          extensions={extensions}
-          settings={settings}
-          onAction={runAction}
-          onFileUpload={handleFileUpload}
-          onLinkQuery={handleLinkQuery}
-          {...props}
-        >
-          {settings.toolbar && (
-            <MarkdownEditor.Toolbar id={attendableId ?? id} role={role} customActions={customActions} />
-          )}
-          <MarkdownEditor.Content initialValue={initialValue} scrollPastEnd={role === 'article'} />
-          <MarkdownEditor.Blocks />
-        </MarkdownEditor.Root>
-      </Layout.Main>
-    );
-  },
-);
-
-export default MarkdownContainer;

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);
-};

package/src/types/MarkdownAction.ts

@@ -1,59 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import * as Schema from 'effect/Schema';
-
-import { Capability } from '@dxos/app-framework';
-import { Operation } from '@dxos/operation';
-import { SpaceSchema } from '@dxos/react-client/echo';
-import { Collection } from '@dxos/schema';
-import { EditorViewMode } from '@dxos/ui-editor/types';
-
-import { meta } from '../meta';
-
-import { Document } from './Markdown';
-
-const MARKDOWN_OPERATION = `${meta.id}/operation`;
-
-export namespace MarkdownOperation {
-  export const OnCreateSpace = Operation.make({
-    meta: { key: `${MARKDOWN_OPERATION}/on-create-space`, name: 'On Create Space' },
-    services: [Capability.Service],
-    schema: {
-      input: Schema.Struct({
-        space: SpaceSchema,
-        rootCollection: Collection.Collection,
-        isDefault: Schema.optional(Schema.Boolean),
-      }),
-      output: Schema.Void,
-    },
-  });
-
-  export const Create = Operation.make({
-    meta: { key: `${MARKDOWN_OPERATION}/create`, name: 'Create Markdown Document' },
-    services: [Capability.Service],
-    schema: {
-      input: Schema.Struct({
-        name: Schema.optional(Schema.String),
-        content: Schema.optional(Schema.String),
-      }),
-      output: Schema.Struct({
-        object: Document,
-      }),
-    },
-  });
-
-  // TODO(wittjosiah): This appears to be unused.
-  export const SetViewMode = Operation.make({
-    meta: { key: `${MARKDOWN_OPERATION}/set-view-mode`, name: 'Set View Mode' },
-    services: [Capability.Service],
-    schema: {
-      input: Schema.Struct({
-        id: Schema.String,
-        viewMode: EditorViewMode,
-      }),
-      output: Schema.Void,
-    },
-  });
-}