@dxos/plugin-markdown 0.8.4-main.3eb6e50203 → 0.8.4-main.3fbcb4aa9b

package/src/blueprints/functions/update.ts

@@ -1,79 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { next as A, type Doc } from '@automerge/automerge';
-import * as Effect from 'effect/Effect';
-import * as Schema from 'effect/Schema';
-
-import { Database, Type } from '@dxos/echo';
-import { DocAccessor, createDocAccessor } from '@dxos/echo-db';
-import { defineFunction } from '@dxos/functions';
-import { trim } from '@dxos/util';
-
-import { Markdown } from '../../types';
-
-const Edit = Schema.Struct({
-  oldString: Schema.String.annotations({
-    description: 'The text to find in the document.',
-  }),
-  newString: Schema.String.annotations({
-    description: 'The text to replace it with.',
-  }),
-  replaceAll: Schema.optional(Schema.Boolean).annotations({
-    description: 'If true, replaces all occurrences. Defaults to false (first occurrence only).',
-  }),
-});
-
-// TODO(wittjosiah): Reconcile with ThreadAction.AddProposal.
-// Based on opencode's MutilEdit tool: https://deepwiki.com/search/how-does-text-edit-tool-work_a159bc76-5401-424e-b29f-f087d1ea4f78
-export default defineFunction({
-  key: 'dxos.org/function/markdown/update',
-  name: 'Update',
-  description: trim`
-    Applies a set of edits to the markdown document.
-  `,
-  inputSchema: Schema.Struct({
-    doc: Type.Ref(Markdown.Document).annotations({
-      description: 'The ID of the markdown document.',
-    }),
-    edits: Schema.Array(Edit).annotations({
-      description: 'The edits to apply to the document. Each edit finds oldString and replaces it with newString.',
-    }),
-  }),
-  outputSchema: Schema.Struct({
-    newContent: Schema.String,
-  }),
-  handler: Effect.fn(function* ({ data: { doc, edits } }) {
-    const content = yield* doc.pipe(
-      Database.load,
-      Effect.map((_) => _.content),
-      Effect.flatMap(Database.load),
-    );
-    const accessor = createDocAccessor(content, ['content']);
-
-    for (const edit of edits) {
-      accessor.handle.change((doc: Doc<typeof content>) => {
-        const text = DocAccessor.getValue<string>(accessor);
-        if (edit.replaceAll) {
-          let idx = text.indexOf(edit.oldString);
-          while (idx !== -1) {
-            A.splice(doc, accessor.path as A.Prop[], idx, edit.oldString.length, edit.newString);
-            const updated = DocAccessor.getValue<string>(accessor);
-            idx = updated.indexOf(edit.oldString, idx + edit.newString.length);
-          }
-        } else {
-          const idx = text.indexOf(edit.oldString);
-          if (idx === -1) {
-            throw new Error(`Edit not found: ${JSON.stringify(edit.oldString)}`);
-          }
-          A.splice(doc, accessor.path as A.Prop[], idx, edit.oldString.length, edit.newString);
-        }
-      });
-    }
-
-    return {
-      newContent: DocAccessor.getValue<string>(accessor),
-    };
-  }),
-});

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,26 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import * as Effect from 'effect/Effect';
-
-import { Capability } from '@dxos/app-framework';
-import { AppCapabilities } from '@dxos/app-toolkit';
-
-import { MarkdownBlueprint } from '../../blueprints';
-
-export const functions = MarkdownBlueprint.functions;
-
-export type BlueprintCapabilities = [
-  Capability.Capability<typeof AppCapabilities.Functions>,
-  Capability.Capability<typeof AppCapabilities.BlueprintDefinition>,
-];
-
-const blueprintDefinition = Capability.makeModule<[], BlueprintCapabilities>(() =>
-  Effect.succeed([
-    Capability.contributes(AppCapabilities.Functions, functions),
-    Capability.contributes(AppCapabilities.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 { Capabilities, Capability } 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(Capabilities.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* Capabilities.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/react-surface/react-surface.tsx

@@ -1,102 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import * as Effect from 'effect/Effect';
-import React, { forwardRef, useCallback, useMemo } from 'react';
-
-import { Capabilities, Capability } from '@dxos/app-framework';
-import {
-  Surface,
-  useAtomCapability,
-  useAtomCapabilityState,
-  useCapability,
-  useSettingsState,
-} from '@dxos/app-framework/ui';
-import { AppCapabilities } from '@dxos/app-toolkit';
-import { type SurfaceComponentProps } from '@dxos/app-toolkit/ui';
-import { Obj } from '@dxos/echo';
-import { AttentionCapabilities } from '@dxos/plugin-attention';
-import { Text } from '@dxos/schema';
-import { type EditorViewMode } from '@dxos/ui-editor';
-
-import { MarkdownCard, MarkdownContainer, type MarkdownContainerProps, MarkdownSettings } from '../../components';
-import { meta } from '../../meta';
-import { Markdown, MarkdownCapabilities } from '../../types';
-
-export default Capability.makeModule(() =>
-  Effect.succeed(
-    Capability.contributes(Capabilities.ReactSurface, [
-      Surface.create({
-        id: `${meta.id}/surface/document`,
-        role: ['article', 'section', 'tabpanel'],
-        filter: (data): data is { subject: Markdown.Document; variant: undefined } =>
-          Obj.instanceOf(Markdown.Document, data.subject) && !data.variant,
-        component: ({ data, role, ref }) => {
-          return <Container id={Obj.getDXN(data.subject).toString()} subject={data.subject} role={role} ref={ref} />;
-        },
-      }),
-      Surface.create({
-        id: `${meta.id}/surface/text`,
-        role: ['article', 'section', 'tabpanel'],
-        filter: (data): data is { id: string; subject: Text.Text } =>
-          typeof data.id === 'string' && Obj.instanceOf(Text.Text, data.subject),
-        component: ({ data, role }) => {
-          return <Container id={data.id} subject={data.subject} role={role} />;
-        },
-      }),
-      Surface.create({
-        id: `${meta.id}/surface/plugin-settings`,
-        role: 'article',
-        filter: (data): data is { subject: AppCapabilities.Settings } =>
-          AppCapabilities.isSettings(data.subject) && data.subject.prefix === meta.id,
-        component: ({ data: { subject } }) => {
-          const { settings, updateSettings } = useSettingsState<Markdown.Settings>(subject.atom);
-          return <MarkdownSettings settings={settings} onSettingsChange={updateSettings} />;
-        },
-      }),
-      Surface.create({
-        id: `${meta.id}/surface/preview`,
-        role: 'card--content',
-        filter: (data): data is { subject: Markdown.Document | Text.Text } =>
-          Obj.instanceOf(Markdown.Document, data.subject) || Obj.instanceOf(Text.Text, data.subject),
-        component: ({ data }) => <MarkdownCard {...data} />,
-      }),
-    ]),
-  ),
-);
-
-/**
- * Common wrapper.
- */
-const Container = forwardRef<HTMLDivElement, SurfaceComponentProps<Markdown.Document | Text.Text, { id: string }>>(
-  ({ id, subject, role }, forwardedRef) => {
-    const selectionManager = useCapability(AttentionCapabilities.Selection);
-    const settings = useAtomCapability(MarkdownCapabilities.Settings);
-    const [state, setState] = useAtomCapabilityState(MarkdownCapabilities.State);
-    const editorState = useCapability(MarkdownCapabilities.EditorState);
-    const extensions = useCapability(MarkdownCapabilities.Extensions);
-    const extensionProviders = useMemo(() => extensions.flat(), [extensions]);
-
-    const viewMode: EditorViewMode = (id && state.viewMode[id]) || settings?.defaultViewMode || 'source';
-    const handleViewModeChange = useCallback<NonNullable<MarkdownContainerProps['onViewModeChange']>>(
-      (mode) => setState((current) => ({ ...current, viewMode: { ...current.viewMode, [id]: mode } })),
-      [id, setState],
-    );
-
-    return (
-      <MarkdownContainer
-        role={role}
-        subject={subject}
-        id={id}
-        settings={settings}
-        selectionManager={selectionManager}
-        extensionProviders={extensionProviders}
-        editorStateStore={editorState}
-        viewMode={viewMode}
-        onViewModeChange={handleViewModeChange}
-        ref={forwardedRef}
-      />
-    );
-  },
-);

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/cli/index.ts

@@ -1,5 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-export * from './plugin';

package/src/cli/plugin.ts

@@ -1,30 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import * as Effect from 'effect/Effect';
-
-import { Plugin } from '@dxos/app-framework';
-import { AppPlugin } from '@dxos/app-toolkit';
-import { type CreateObject } from '@dxos/plugin-space/types';
-import { Text } from '@dxos/schema';
-
-// NOTE: Must not import from index to avoid pulling in react dependencies.
-import { OperationResolver } from '../capabilities/operation-resolver';
-import { meta } from '../meta';
-import { Markdown } from '../types';
-
-export const MarkdownPlugin = Plugin.define(meta).pipe(
-  AppPlugin.addMetadataModule({
-    metadata: {
-      id: Markdown.Document.typename,
-      metadata: {
-        createObject: ((props) => Effect.sync(() => Markdown.make(props))) satisfies CreateObject,
-        addToCollectionOnCreate: true,
-      },
-    },
-  }),
-  AppPlugin.addOperationResolverModule({ activate: OperationResolver }),
-  AppPlugin.addSchemaModule({ schema: [Markdown.Document, Text.Text] }),
-  Plugin.make,
-);

package/src/components/MarkdownCard/MarkdownCard.tsx

@@ -1,64 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import React, { useMemo } from 'react';
-
-import { Obj } from '@dxos/echo';
-import { useTranslation } from '@dxos/react-ui';
-import { Card } from '@dxos/react-ui-mosaic';
-import { Text } from '@dxos/schema';
-
-import { meta } from '../../meta';
-import { Markdown } from '../../types';
-import { getContentSnippet, getFallbackName } from '../../util';
-import { MarkdownEditor } from '../MarkdownEditor';
-
-export type MarkdownCardProps = { subject: Markdown.Document | Text.Text };
-
-export const MarkdownCard = ({ subject }: MarkdownCardProps) => {
-  const { t } = useTranslation(meta.id);
-  const snippet = useMemo(() => getSnippet(subject), [subject]);
-  const info = getInfo(subject);
-
-  return (
-    <Card.Content>
-      {snippet && (
-        <Card.Row className='max-h-[300px] overflow-hidden'>
-          <MarkdownEditor.Root id={subject.id} viewMode='readonly'>
-            <MarkdownEditor.Content initialValue={snippet} slots={{}} classNames='!bg-transparent' />
-          </MarkdownEditor.Root>
-        </Card.Row>
-      )}
-      <Card.Row>
-        <Card.Text classNames='text-xs text-description'>
-          {info.words} {t('words label', { count: info.words })}
-        </Card.Text>
-      </Card.Row>
-    </Card.Content>
-  );
-};
-
-const getInfo = (subject: Markdown.Document | Text.Text) => {
-  const text = (Obj.instanceOf(Markdown.Document, subject) ? subject.content?.target?.content : subject.content) ?? '';
-  return { words: text.split(' ').length };
-};
-
-// TODO(burdon): Factor out.
-const getTitle = (subject: Markdown.Document | Text.Text, fallback: string) => {
-  if (Obj.instanceOf(Markdown.Document, subject)) {
-    const title = Obj.getLabel(subject);
-    return title ?? getFallbackName(subject.content?.target?.content ?? fallback);
-  } else if (Obj.instanceOf(Text.Text, subject)) {
-    return getFallbackName(subject.content);
-  }
-};
-
-// TODO(burdon): Factor out.
-const getSnippet = (subject: Markdown.Document | Text.Text, fallback?: string) => {
-  if (Obj.instanceOf(Markdown.Document, subject)) {
-    return Obj.getDescription(subject) || getContentSnippet(subject.content?.target?.content ?? fallback);
-  } else if (Obj.instanceOf(Text.Text, subject)) {
-    return getContentSnippet(subject.content ?? fallback);
-  }
-};

package/src/components/MarkdownCard/index.ts

@@ -1,9 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { MarkdownCard } from './MarkdownCard';
-
-export * from './MarkdownCard';
-
-export default MarkdownCard;

package/src/components/MarkdownContainer.tsx

@@ -1,113 +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 { useCapabilities } from '@dxos/app-framework/ui';
-import { AppCapabilities } from '@dxos/app-toolkit';
-import { type SurfaceComponentProps } from '@dxos/app-toolkit/ui';
-import { useAppGraph } from '@dxos/app-toolkit/ui';
-import { Obj } from '@dxos/echo';
-import { useActionRunner } from '@dxos/plugin-graph';
-import { useObject } from '@dxos/react-client/echo';
-import { Layout } from '@dxos/react-ui';
-import { type SelectionManager } from '@dxos/react-ui-attention';
-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(AppCapabilities.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;