@dxos/plugin-markdown 0.8.4-main.dedc0f3 → 0.8.4-main.dfabb4ec29

package/src/operations/update.test.ts

@@ -0,0 +1,214 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { describe, expect, it } from '@effect/vitest';
+import * as Effect from 'effect/Effect';
+
+import { MemoizedAiService } from '@dxos/ai/testing';
+import { SpaceProperties } from '@dxos/client-protocol';
+import { Blueprint, Operation } from '@dxos/compute';
+import { Database, Feed, Obj, Query, Ref } from '@dxos/echo';
+import { Collection } from '@dxos/echo';
+import { TestHelpers } from '@dxos/effect/testing';
+import { AgentService } from '@dxos/functions-runtime';
+import { AssistantTestLayer } from '@dxos/functions-runtime/testing';
+import { invariant } from '@dxos/invariant';
+import { ObjectId } from '@dxos/keys';
+import { Markdown } from '@dxos/plugin-markdown';
+import { HasSubject } from '@dxos/types';
+import { trim } from '@dxos/util';
+
+import { WithProperties } from '#testing';
+
+import MarkdownBlueprint from '../blueprints/markdown-blueprint';
+import { MarkdownOperation } from '../types';
+import { MarkdownOperationHandlerSet } from './index';
+
+ObjectId.dangerouslyDisableRandomness();
+
+const TestLayer = AssistantTestLayer({
+  aiServicePreset: 'edge-remote',
+  operationHandlers: MarkdownOperationHandlerSet,
+  types: [
+    SpaceProperties,
+    Collection.Collection,
+    Blueprint.Blueprint,
+    Markdown.Document,
+    HasSubject.HasSubject,
+    Feed.Feed,
+  ],
+  blueprints: [MarkdownBlueprint.make()],
+  tracing: 'pretty',
+});
+
+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.add(doc);
+
+        yield* Operation.invoke(MarkdownOperation.Update, {
+          doc: Ref.make(doc),
+          edits: [{ oldString: 'Founders', newString: '# Founders' }],
+        });
+
+        const updatedDoc = yield* Database.resolve(Obj.getDXN(doc), Markdown.Document);
+        expect(updatedDoc.name).toBe(doc.name);
+        const text = yield* Database.load(updatedDoc.content);
+        expect(text.content).toBe('# Founders and portfolio of BlueYard.');
+      },
+      WithProperties,
+      Effect.provide(TestLayer),
+      TestHelpers.provideTestContext,
+    ),
+  );
+
+  it.effect(
+    'create and update a markdown document',
+    Effect.fnUntraced(
+      function* (_) {
+        const agent = yield* AgentService.createSession({
+          blueprints: [MarkdownBlueprint.make()],
+        });
+
+        yield* agent.submitPrompt('Create a document with a cookie recipe.');
+        yield* agent.waitForCompletion();
+        {
+          const docs = yield* Database.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.load(doc.content).pipe(Effect.map((_) => _.content)),
+          });
+        }
+
+        yield* agent.submitPrompt('Add a section with a holiday-themed variation.');
+        yield* agent.waitForCompletion();
+        {
+          const docs = yield* Database.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.load(doc.content).pipe(Effect.map((_) => _.content)),
+          });
+        }
+      },
+      WithProperties,
+      Effect.provide(TestLayer),
+      TestHelpers.provideTestContext,
+    ),
+    MemoizedAiService.isGenerationEnabled() ? 240_000 : 30_000,
+  );
+
+  it.effect(
+    'update existing document',
+    Effect.fnUntraced(
+      function* (_) {
+        const document = yield* Database.add(
+          Markdown.make({
+            name: 'Cookie Recipe',
+            content: trim`
+                Ingredients: 
+                  - 2 cups of ???
+                  - 1 cup of sugar
+                  - 1 cup of butter
+                  - 1 cup of eggs
+          `,
+          }),
+        );
+        const agent = yield* AgentService.createSession({
+          blueprints: [MarkdownBlueprint.make()],
+          context: [Ref.make(document)],
+        });
+
+        yield* agent.submitPrompt('Add the missing ingredient (its flour).');
+        yield* agent.waitForCompletion();
+
+        {
+          const docs = yield* Database.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));
+          const content = yield* Database.load(doc.content).pipe(Effect.map((_) => _.content));
+          console.log({
+            name: doc.name,
+            content: yield* Database.load(doc.content).pipe(Effect.map((_) => _.content)),
+          });
+          expect(content.toLowerCase()).toContain('flour');
+        }
+      },
+      WithProperties,
+      Effect.provide(TestLayer),
+      TestHelpers.provideTestContext,
+    ),
+    MemoizedAiService.isGenerationEnabled() ? 240_000 : 30_000,
+  );
+
+  it.effect(
+    'add lines to document one by one',
+    Effect.fnUntraced(
+      function* (_) {
+        const document = yield* Database.add(
+          Markdown.make({
+            name: 'Shopping list',
+            content: trim`
+              # Shopping list
+            `,
+          }),
+        );
+        const agent = yield* AgentService.createSession({
+          blueprints: [MarkdownBlueprint.make()],
+          context: [Ref.make(document)],
+        });
+
+        yield* agent.submitPrompt('Add milk to the shopping list.');
+        yield* agent.waitForCompletion();
+        yield* agent.submitPrompt('Add bread to the shopping list.');
+        yield* agent.waitForCompletion();
+        yield* agent.submitPrompt('Add eggs to the shopping list.');
+        yield* agent.waitForCompletion();
+
+        {
+          const docs = yield* Database.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));
+          const content = yield* Database.load(doc.content).pipe(Effect.map((_) => _.content));
+          console.log({
+            name: doc.name,
+            content: yield* Database.load(doc.content).pipe(Effect.map((_) => _.content)),
+          });
+          expect(content.toLowerCase()).toContain('milk');
+          expect(content.toLowerCase()).toContain('bread');
+          expect(content.toLowerCase()).toContain('eggs');
+        }
+      },
+      WithProperties,
+      Effect.provide(TestLayer),
+      TestHelpers.provideTestContext,
+    ),
+    MemoizedAiService.isGenerationEnabled() ? 240_000 : 30_000,
+  );
+});

package/src/plugin.ts

@@ -0,0 +1,11 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { Plugin } from '@dxos/app-framework';
+
+import { meta } from './meta';
+
+export const MarkdownPlugin = Plugin.lazy(meta, () => import('#plugin'));
+
+export { MarkdownOperationHandlerSet } from './operations';

package/src/testing.ts

@@ -0,0 +1,27 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Toolkit from '@effect/ai/Toolkit';
+import * as Effect from 'effect/Effect';
+
+import { SpaceProperties } from '@dxos/client-protocol';
+import { Obj, Ref } from '@dxos/echo';
+import { Database } from '@dxos/echo';
+import { Collection } from '@dxos/echo';
+
+// TODO(wittjosiah): Factor out.
+export const WithProperties = <A, E, R>(effect: Effect.Effect<A, E, R>): Effect.Effect<A, E, R | Database.Service> =>
+  Effect.zipRight(
+    Effect.gen(function* () {
+      // TODO(wittjosiah): Remove cast.
+      yield* Database.add(
+        Obj.make(SpaceProperties, {
+          [Collection.Collection.typename]: Ref.make(Collection.make()),
+        }) as any,
+      );
+    }),
+    effect,
+  );
+
+export const testToolkit = Toolkit.empty as Toolkit.Toolkit<any>;

package/src/translations.ts

@@ -3,47 +3,41 @@
 //
 
 import { type Resource } from '@dxos/react-ui';
+import { translations as editorTranslations } from '@dxos/react-ui-editor/translations';
 
-import { meta } from './meta';
-import { Markdown } from './types';
+import { meta } from '#meta';
+import { Markdown } from '#types';
 
 export const translations = [
   {
     'en-US': {
       [Markdown.Document.typename]: {
-        'typename label': 'Document',
-        'typename label_zero': 'Documents',
-        'typename label_one': 'Document',
-        'typename label_other': 'Documents',
-        'object name placeholder': 'New document',
-        'rename object label': 'Rename document',
-        'delete object label': 'Delete document',
+        'typename.label': 'Document',
+        'typename.label_zero': 'Documents',
+        'typename.label_one': 'Document',
+        'typename.label_other': 'Documents',
+        'object-name.placeholder': 'New document',
+        'add-object.label': 'Add document',
+        'rename-object.label': 'Rename document',
+        'delete-object.label': 'Delete document',
+        'object-deleted.label': 'Document deleted',
       },
       [meta.id]: {
-        'plugin name': 'Editor',
-        'settings title': 'Editor settings',
-        'choose markdown from space dialog title': 'Choose one or more documents to add',
-        // TODO(burdon): Style-guide for user-facing text (e.g., hints, questions, capitalization, etc.)
-        'empty choose markdown from space message': 'None available; try creating a new one instead?',
-        'chooser done label': 'Add selected',
-        'editor placeholder': '',
-        'editor input mode label': 'Editor input mode',
-        'select editor input mode placeholder': 'Select editor input mode…',
-        'settings editor input mode default label': 'Default',
-        'settings editor input mode vim label': 'Vim',
-        'settings editor input mode vscode label': 'VS Code',
-        'settings toolbar label': 'Show toolbar',
-        'settings numbered headings label': 'Numbered headings',
-        'settings folding label': 'Folding',
-        'settings experimental label': 'Enable experimental features',
-        'settings debug label': 'Enable debugging features',
-        'settings debug placeholder': 'Typewriter script...',
-        'toggle view mode label': 'Toggle read-only',
-        'default view mode label': 'Default view mode',
-        'upload image label': 'Upload image',
-        'fallback title': 'Untitled',
-        'navigate to document label': 'Open document',
+        'plugin.name': 'Editor',
+        'choose-markdown-from-space-dialog.title': 'Choose one or more documents to add',
+        'empty-choose-markdown-from-space.message': 'None available; try creating a new one instead?',
+        'chooser-done.label': 'Add selected',
+        'editor.placeholder': 'Enter text…',
+        'toggle-view-mode.label': 'Toggle read-only',
+        'upload-image.label': 'Upload image',
+        'fallback.title': 'Untitled',
+        'navigate-to-document.label': 'Open document',
+        'words.label': 'words',
+        'words.label_zero': 'words',
+        'words.label_one': 'word',
+        'words.label_other': 'words',
       },
     },
   },
+  ...editorTranslations,
 ] as const satisfies Resource[];

package/src/types/Markdown.ts

@@ -2,27 +2,41 @@
 // Copyright 2024 DXOS.org
 //
 
-import { Schema } from 'effect';
+import * as Schema from 'effect/Schema';
 
-import { Obj, Ref, Type } from '@dxos/echo';
-import { LabelAnnotation } from '@dxos/echo-schema';
-import { EditorInputMode, EditorViewMode } from '@dxos/react-ui-editor/types';
-import { DataType, ItemAnnotation } from '@dxos/schema';
+import { BlueprintsAnnotation, GraphPropsAnnotation } from '@dxos/app-toolkit';
+import { Annotation, Obj, Ref, Type } from '@dxos/echo';
+import { DescriptionAnnotation, FormInputAnnotation, LabelAnnotation } from '@dxos/echo/internal';
+import { Text } from '@dxos/schema';
+
+export const BLUEPRINT_KEY = 'org.dxos.blueprint.markdown';
+
+// Re-export Settings as merged const/type (not as namespace).
+import * as SettingsModule from './Settings';
+export const Settings = SettingsModule.Settings;
+export type Settings = SettingsModule.Settings;
 
 /**
  * Document Item type.
  */
 export const Document = Schema.Struct({
   name: Schema.optional(Schema.String),
-  fallbackName: Schema.optional(Schema.String),
-  content: Type.Ref(DataType.Text),
+  description: Schema.optional(Schema.String),
+  fallbackName: Schema.String.pipe(FormInputAnnotation.set(false), Schema.optional),
+  content: Ref.Ref(Text.Text).pipe(FormInputAnnotation.set(false)),
 }).pipe(
-  Type.Obj({
-    typename: 'dxos.org/type/Document',
+  Type.object({
+    typename: 'org.dxos.type.document',
     version: '0.1.0',
   }),
   LabelAnnotation.set(['name', 'fallbackName']),
-  ItemAnnotation.set(true),
+  DescriptionAnnotation.set('description'),
+  Annotation.IconAnnotation.set({
+    icon: 'ph--text-aa--regular',
+    hue: 'indigo',
+  }),
+  BlueprintsAnnotation.set([BLUEPRINT_KEY]),
+  GraphPropsAnnotation.set({ managesAutofocus: true }),
 );
 
 export type Document = Schema.Schema.Type<typeof Document>;
@@ -30,27 +44,12 @@ export type Document = Schema.Schema.Type<typeof Document>;
 /**
  * Document factory.
  */
-export const makeDocument = ({
+export const make = ({
   content = '',
   ...props
-}: Partial<{ name: string; fallbackName: string; content: string }> = {}) =>
-  Obj.make(Document, { ...props, content: Ref.make(DataType.makeText(content)) });
-
-/**
- * Plugin settings.
- */
-export const Settings = Schema.mutable(
-  Schema.Struct({
-    defaultViewMode: EditorViewMode,
-    editorInputMode: Schema.optional(EditorInputMode),
-    experimental: Schema.optional(Schema.Boolean),
-    debug: Schema.optional(Schema.Boolean),
-    toolbar: Schema.optional(Schema.Boolean),
-    typewriter: Schema.optional(Schema.String),
-    // TODO(burdon): Per document settings.
-    numberedHeadings: Schema.optional(Schema.Boolean),
-    folding: Schema.optional(Schema.Boolean),
-  }),
-);
-
-export interface Settings extends Schema.Schema.Type<typeof Settings> {}
+}: Partial<{ name: string; fallbackName: string; content: string }> = {}) => {
+  const doc = Obj.make(Document, { ...props, content: Ref.make(Text.make({ content })) });
+  // TODO(dmaretskyi): We need a better way to set parents when creating hierarchies.
+  Obj.setParent(doc.content.target!, doc);
+  return doc;
+};

package/src/types/MarkdownCapabilities.ts

@@ -0,0 +1,51 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+// @import-as-namespace
+
+import { type EditorView } from '@codemirror/view';
+import { type Atom } from '@effect-atom/atom-react';
+import * as Schema from 'effect/Schema';
+
+import { Capability } from '@dxos/app-framework';
+import { type EditorStateStore } from '@dxos/ui-editor';
+import { type EditorViewMode } from '@dxos/ui-editor/types';
+
+import { meta } from '#meta';
+
+import type * as Markdown from './Markdown';
+import { type MarkdownExtensionProvider } from './types';
+
+/** Schema for persisted markdown state. */
+export const StateSchema = Schema.mutable(
+  Schema.Struct({
+    viewMode: Schema.Record({ key: Schema.String, value: Schema.String }),
+  }),
+);
+
+export type MarkdownState = {
+  viewMode: Record<string, EditorViewMode>;
+};
+
+export type EditorViewEntry = { view: EditorView; documentId: string };
+
+export type EditorViewRegistry = {
+  register: (attendableId: string, view: EditorView, documentId: string) => void;
+  unregister: (attendableId: string) => void;
+  get: (attendableId: string) => EditorViewEntry | undefined;
+};
+
+export const Settings = Capability.make<Atom.Writable<Markdown.Settings>>(`${meta.id}.capability.settings`);
+
+/** Persisted state atom for view mode per document. */
+export const State = Capability.make<Atom.Writable<MarkdownState>>(`${meta.id}.capability.state`);
+
+/** Editor state store for cursor positions, scroll state, etc. */
+export const EditorState = Capability.make<EditorStateStore>(`${meta.id}.capability.editor-state`);
+
+/** Registry of active EditorView instances keyed by attendable ID. */
+export const EditorViews = Capability.make<EditorViewRegistry>(`${meta.id}.capability.editor-views`);
+
+// TODO(burdon): Move to ./types (external API)?
+export const Extensions = Capability.make<MarkdownExtensionProvider[]>(`${meta.id}.capability.extensions`);

package/src/types/MarkdownEvents.ts

@@ -0,0 +1,14 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+// @import-as-namespace
+
+import { type ActivationEvent } from '@dxos/app-framework';
+import { AppActivationEvents } from '@dxos/app-toolkit';
+
+import { meta } from '#meta';
+
+export const SetupExtensions: ActivationEvent.ActivationEvent = AppActivationEvents.createStateEvent(
+  `${meta.id}.event.setup-extensions`,
+);

package/src/types/MarkdownOperation.ts

@@ -0,0 +1,122 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+// @import-as-namespace
+
+import * as Schema from 'effect/Schema';
+
+import { Capability } from '@dxos/app-framework';
+import { Operation } from '@dxos/compute';
+import { Database, Ref } from '@dxos/echo';
+import { EditorViewMode } from '@dxos/ui-editor/types';
+import { trim } from '@dxos/util';
+
+import { meta } from '#meta';
+
+import * as Markdown from './Markdown';
+
+const MARKDOWN_OPERATION = `${meta.id}.operation`;
+
+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).',
+  }),
+});
+
+export const Create = Operation.make({
+  meta: {
+    key: 'org.dxos.function.markdown.create',
+    name: 'Create',
+    description: 'Creates a new markdown document and adds it to the space.',
+  },
+  input: Schema.Struct({
+    name: Schema.String,
+    content: Schema.String,
+  }),
+  output: Schema.Struct({
+    id: Schema.String.annotations({
+      description: 'The DXN of the created document.',
+    }),
+  }),
+  services: [Database.Service],
+});
+
+export const CreateMarkdown = Operation.make({
+  meta: { key: `${MARKDOWN_OPERATION}.create`, name: 'Create Markdown Document' },
+  services: [Capability.Service],
+  input: Schema.Struct({
+    name: Schema.optional(Schema.String),
+    content: Schema.optional(Schema.String),
+  }),
+  output: Schema.Struct({
+    object: Markdown.Document,
+  }),
+});
+
+export const Open = Operation.make({
+  meta: {
+    key: 'org.dxos.function.markdown.open',
+    name: 'Open',
+    description: 'Opens and reads the contents of a new markdown document.',
+  },
+  input: Schema.Struct({
+    doc: Ref.Ref(Markdown.Document).annotations({
+      description: 'The ID of the markdown document.',
+    }),
+  }),
+  output: Schema.Struct({
+    content: Schema.String,
+  }),
+  services: [Database.Service],
+});
+
+export const ScrollToAnchor = Operation.make({
+  meta: { key: `${MARKDOWN_OPERATION}.scroll-to-anchor`, name: 'Scroll To Anchor' },
+  services: [Capability.Service],
+  input: Schema.Struct({
+    subject: Schema.String.annotations({ description: 'Attendable ID of the markdown editor.' }),
+    cursor: Schema.String.annotations({ description: 'Cursor position to scroll to.' }),
+    ref: Schema.optional(Schema.String.annotations({ description: 'Reference ID (e.g. thread ID).' })),
+  }),
+  output: Schema.Void,
+});
+
+// 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],
+  input: Schema.Struct({
+    id: Schema.String,
+    viewMode: EditorViewMode,
+  }),
+  output: Schema.Void,
+});
+
+export const Update = Operation.make({
+  meta: {
+    key: 'org.dxos.function.markdown.update',
+    name: 'Update',
+    description: trim`
+      Applies a set of edits to the markdown document.
+    `,
+  },
+  input: Schema.Struct({
+    doc: Ref.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.',
+    }),
+  }),
+  output: Schema.Struct({
+    newContent: Schema.String,
+  }),
+  services: [Database.Service],
+});

package/src/types/Settings.ts

@@ -0,0 +1,65 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+// @import-as-namespace
+
+import * as Schema from 'effect/Schema';
+
+import { EditorInputMode, EditorViewMode } from '@dxos/ui-editor/types';
+
+/**
+ * Plugin settings.
+ */
+export const Settings = Schema.mutable(
+  Schema.Struct({
+    defaultViewMode: EditorViewMode.annotations({
+      title: 'Default view mode',
+      description: 'Set whether documents open in editing or read-only mode.',
+    }),
+    editorInputMode: Schema.optional(
+      EditorInputMode.annotations({
+        title: 'Editor input mode',
+        description: 'Choose keyboard bindings for the editor.',
+      }),
+    ),
+    toolbar: Schema.optional(
+      Schema.Boolean.annotations({
+        title: 'Show toolbar',
+        description: 'Display a formatting toolbar above the editor.',
+      }),
+    ),
+    numberedHeadings: Schema.optional(
+      Schema.Boolean.annotations({
+        title: 'Numbered headings',
+        description: 'Automatically number heading levels in the document.',
+      }),
+    ),
+    folding: Schema.optional(
+      Schema.Boolean.annotations({
+        title: 'Folding',
+        description: 'Allow collapsing and expanding sections by heading.',
+      }),
+    ),
+    experimental: Schema.optional(
+      Schema.Boolean.annotations({
+        title: 'Enable experimental features',
+        description: 'Turn on features that are still in development.',
+      }),
+    ),
+    debug: Schema.optional(
+      Schema.Boolean.annotations({
+        title: 'Enable debugging features',
+        description: 'Show developer tools and diagnostics for the editor.',
+      }),
+    ),
+    snippets: Schema.optional(
+      Schema.String.annotations({
+        title: 'Snippets',
+        description: 'Input snippets to replay for testing purposes.',
+      }),
+    ),
+  }),
+);
+
+export interface Settings extends Schema.Schema.Type<typeof Settings> {}

package/src/types/index.ts

@@ -2,6 +2,10 @@
 // Copyright 2024 DXOS.org
 //
 
-export * as MarkdownAction from './MarkdownAction';
-export * as Markdown from './Markdown';
 export * from './types';
+
+export * as Markdown from './Markdown';
+export * as MarkdownCapabilities from './MarkdownCapabilities';
+export * as MarkdownEvents from './MarkdownEvents';
+export * as MarkdownOperation from './MarkdownOperation';
+export * as Settings from './Settings';