@dxos/plugin-markdown 0.8.4-main.f9ba587 → 0.8.4-main.fcc0d83b33

package/package.json

@@ -1,98 +1,155 @@
 {
   "name": "@dxos/plugin-markdown",
-  "version": "0.8.4-main.f9ba587",
+  "version": "0.8.4-main.fcc0d83b33",
   "description": "DXOS Surface plugin for interacting with Markdown",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dxos/dxos"
+  },
   "license": "MIT",
   "author": "DXOS.org",
   "sideEffects": true,
   "type": "module",
+  "imports": {
+    "#blueprints": "./src/blueprints/index.ts",
+    "#capabilities": {
+      "source": "./src/capabilities/index.ts",
+      "types": "./src/capabilities/index.ts",
+      "browser": "./src/capabilities/index.ts",
+      "node": "./src/capabilities/node.ts"
+    },
+    "#components": "./src/components/index.ts",
+    "#containers": "./src/containers/index.ts",
+    "#hooks": "./src/hooks/index.ts",
+    "#meta": "./src/meta.ts",
+    "#operations": "./src/operations/index.ts",
+    "#testing": "./src/testing.ts",
+    "#translations": "./src/translations.ts",
+    "#types": "./src/types/index.ts"
+  },
   "exports": {
     ".": {
+      "source": "./src/index.ts",
       "types": "./dist/types/src/index.d.ts",
       "browser": "./dist/lib/browser/index.mjs",
       "node": "./dist/lib/node-esm/index.mjs"
     },
+    "./blueprints": {
+      "source": "./src/blueprints/index.ts",
+      "types": "./dist/types/src/blueprints/index.d.ts",
+      "browser": "./dist/lib/browser/blueprints/index.mjs",
+      "node": "./dist/lib/node-esm/blueprints/index.mjs"
+    },
+    "./cli": {
+      "source": "./src/cli/index.ts",
+      "types": "./dist/types/src/cli/index.d.ts",
+      "browser": "./dist/lib/browser/cli/index.mjs",
+      "node": "./dist/lib/node-esm/cli/index.mjs"
+    },
+    "./operations": {
+      "source": "./src/operations/index.ts",
+      "types": "./dist/types/src/operations/index.d.ts",
+      "browser": "./dist/lib/browser/operations/index.mjs",
+      "node": "./dist/lib/node-esm/operations/index.mjs"
+    },
+    "./testing": {
+      "source": "./src/testing.ts",
+      "types": "./dist/types/src/testing.d.ts",
+      "browser": "./dist/lib/browser/testing.mjs",
+      "node": "./dist/lib/node-esm/testing.mjs"
+    },
+    "./translations": {
+      "source": "./src/translations.ts",
+      "types": "./dist/types/src/translations.d.ts",
+      "browser": "./dist/lib/browser/translations.mjs",
+      "node": "./dist/lib/node-esm/translations.mjs"
+    },
     "./types": {
+      "source": "./src/types/index.ts",
       "types": "./dist/types/src/types/index.d.ts",
       "browser": "./dist/lib/browser/types/index.mjs",
       "node": "./dist/lib/node-esm/types/index.mjs"
     }
   },
   "types": "dist/types/src/index.d.ts",
-  "typesVersions": {
-    "*": {
-      "types": [
-        "dist/types/src/types/index.d.ts"
-      ]
-    }
-  },
   "files": [
     "dist",
     "src"
   ],
   "dependencies": {
-    "@automerge/automerge": "3.0.0",
-    "@codemirror/search": "^6.5.6",
-    "@codemirror/view": "^6.34.1",
-    "@preact-signals/safe-react": "^0.9.0",
-    "@preact/signals-core": "^1.9.0",
+    "@automerge/automerge": "3.2.3",
+    "@codemirror/search": "^6.5.11",
+    "@codemirror/state": "^6.5.2",
+    "@codemirror/view": "^6.38.4",
+    "@effect-atom/atom": "^0.5.1",
+    "@effect-atom/atom-react": "^0.5.0",
+    "@effect/ai": "0.33.2",
+    "@effect/experimental": "0.58.0",
+    "@radix-ui/react-context": "1.1.1",
     "react-dropzone": "^14.2.3",
-    "@dxos/ai": "0.8.4-main.f9ba587",
-    "@dxos/app-framework": "0.8.4-main.f9ba587",
-    "@dxos/artifact": "0.8.4-main.f9ba587",
-    "@dxos/assistant": "0.8.4-main.f9ba587",
-    "@dxos/async": "0.8.4-main.f9ba587",
-    "@dxos/echo-schema": "0.8.4-main.f9ba587",
-    "@dxos/echo": "0.8.4-main.f9ba587",
-    "@dxos/invariant": "0.8.4-main.f9ba587",
-    "@dxos/keys": "0.8.4-main.f9ba587",
-    "@dxos/lit-ui": "0.8.4-main.f9ba587",
-    "@dxos/live-object": "0.8.4-main.f9ba587",
-    "@dxos/local-storage": "0.8.4-main.f9ba587",
-    "@dxos/plugin-attention": "0.8.4-main.f9ba587",
-    "@dxos/log": "0.8.4-main.f9ba587",
-    "@dxos/plugin-client": "0.8.4-main.f9ba587",
-    "@dxos/plugin-deck": "0.8.4-main.f9ba587",
-    "@dxos/plugin-graph": "0.8.4-main.f9ba587",
-    "@dxos/plugin-preview": "0.8.4-main.f9ba587",
-    "@dxos/plugin-space": "0.8.4-main.f9ba587",
-    "@dxos/plugin-theme": "0.8.4-main.f9ba587",
-    "@dxos/react-client": "0.8.4-main.f9ba587",
-    "@dxos/react-hooks": "0.8.4-main.f9ba587",
-    "@dxos/react-ui-attention": "0.8.4-main.f9ba587",
-    "@dxos/react-ui-editor": "0.8.4-main.f9ba587",
-    "@dxos/react-ui-form": "0.8.4-main.f9ba587",
-    "@dxos/react-ui-stack": "0.8.4-main.f9ba587",
-    "@dxos/schema": "0.8.4-main.f9ba587",
-    "@dxos/util": "0.8.4-main.f9ba587"
+    "@dxos/ai": "0.8.4-main.fcc0d83b33",
+    "@dxos/app-toolkit": "0.8.4-main.fcc0d83b33",
+    "@dxos/assistant": "0.8.4-main.fcc0d83b33",
+    "@dxos/app-framework": "0.8.4-main.fcc0d83b33",
+    "@dxos/compute": "0.8.4-main.fcc0d83b33",
+    "@dxos/async": "0.8.4-main.fcc0d83b33",
+    "@dxos/client-protocol": "0.8.4-main.fcc0d83b33",
+    "@dxos/echo-db": "0.8.4-main.fcc0d83b33",
+    "@dxos/effect": "0.8.4-main.fcc0d83b33",
+    "@dxos/functions-runtime": "0.8.4-main.fcc0d83b33",
+    "@dxos/echo": "0.8.4-main.fcc0d83b33",
+    "@dxos/invariant": "0.8.4-main.fcc0d83b33",
+    "@dxos/lit-ui": "0.8.4-main.fcc0d83b33",
+    "@dxos/keys": "0.8.4-main.fcc0d83b33",
+    "@dxos/log": "0.8.4-main.fcc0d83b33",
+    "@dxos/plugin-attention": "0.8.4-main.fcc0d83b33",
+    "@dxos/plugin-deck": "0.8.4-main.fcc0d83b33",
+    "@dxos/plugin-client": "0.8.4-main.fcc0d83b33",
+    "@dxos/plugin-graph": "0.8.4-main.fcc0d83b33",
+    "@dxos/plugin-preview": "0.8.4-main.fcc0d83b33",
+    "@dxos/plugin-space": "0.8.4-main.fcc0d83b33",
+    "@dxos/react-client": "0.8.4-main.fcc0d83b33",
+    "@dxos/react-hooks": "0.8.4-main.fcc0d83b33",
+    "@dxos/plugin-theme": "0.8.4-main.fcc0d83b33",
+    "@dxos/react-ui-attention": "0.8.4-main.fcc0d83b33",
+    "@dxos/react-ui-menu": "0.8.4-main.fcc0d83b33",
+    "@dxos/react-ui-editor": "0.8.4-main.fcc0d83b33",
+    "@dxos/react-ui-form": "0.8.4-main.fcc0d83b33",
+    "@dxos/react-ui-mosaic": "0.8.4-main.fcc0d83b33",
+    "@dxos/types": "0.8.4-main.fcc0d83b33",
+    "@dxos/react-ui-stack": "0.8.4-main.fcc0d83b33",
+    "@dxos/schema": "0.8.4-main.fcc0d83b33",
+    "@dxos/ui": "0.8.4-main.fcc0d83b33",
+    "@dxos/util": "0.8.4-main.fcc0d83b33",
+    "@dxos/ui-editor": "0.8.4-main.fcc0d83b33"
   },
   "devDependencies": {
-    "@effect-rx/rx-react": "0.38.0",
-    "@effect/platform": "0.88.0",
-    "@types/react": "~18.2.0",
-    "@types/react-dom": "~18.2.0",
-    "effect": "3.16.13",
-    "react": "~18.2.0",
-    "react-dom": "~18.2.0",
-    "vite": "5.4.7",
-    "@dxos/debug": "0.8.4-main.f9ba587",
-    "@dxos/plugin-storybook-layout": "0.8.4-main.f9ba587",
-    "@dxos/plugin-theme": "0.8.4-main.f9ba587",
-    "@dxos/random": "0.8.4-main.f9ba587",
-    "@dxos/react-ui": "0.8.4-main.f9ba587",
-    "@dxos/react-ui-theme": "0.8.4-main.f9ba587",
-    "@dxos/storybook-utils": "0.8.4-main.f9ba587"
+    "@effect-atom/atom-react": "^0.5.0",
+    "@effect/platform": "0.94.4",
+    "@types/react": "~19.2.7",
+    "@types/react-dom": "~19.2.3",
+    "effect": "3.20.0",
+    "react": "~19.2.3",
+    "react-dom": "~19.2.3",
+    "vite": "^8.0.10",
+    "@dxos/debug": "0.8.4-main.fcc0d83b33",
+    "@dxos/plugin-testing": "0.8.4-main.fcc0d83b33",
+    "@dxos/storybook-utils": "0.8.4-main.fcc0d83b33",
+    "@dxos/react-ui": "0.8.4-main.fcc0d83b33",
+    "@dxos/ui-theme": "0.8.4-main.fcc0d83b33",
+    "@dxos/random": "0.8.4-main.fcc0d83b33",
+    "@dxos/plugin-theme": "0.8.4-main.fcc0d83b33"
   },
   "peerDependencies": {
-    "@effect-rx/rx-react": "^0.34.1",
-    "@effect/platform": "^0.80.12",
-    "effect": "^3.13.3",
-    "react": "~18.2.0",
-    "react-dom": "~18.2.0",
-    "@dxos/react-ui": "0.8.4-main.f9ba587",
-    "@dxos/react-ui-theme": "0.8.4-main.f9ba587"
+    "@effect-atom/atom-react": "^0.5.0",
+    "@effect/platform": "0.94.4",
+    "effect": "3.20.0",
+    "react": "~19.2.3",
+    "react-dom": "~19.2.3",
+    "@dxos/react-ui": "0.8.4-main.fcc0d83b33",
+    "@dxos/ui-theme": "0.8.4-main.fcc0d83b33"
   },
   "publishConfig": {
     "access": "public"

package/src/MarkdownPlugin.tsx

@@ -2,120 +2,103 @@
 // Copyright 2025 DXOS.org
 //
 
-import { Capabilities, contributes, createIntent, defineModule, definePlugin, Events } from '@dxos/app-framework';
-import { type Obj, Ref } from '@dxos/echo';
-import { ClientCapabilities, ClientEvents } from '@dxos/plugin-client';
-import { SpaceCapabilities } from '@dxos/plugin-space';
-import { defineObjectForm } from '@dxos/plugin-space/types';
-import { createDocAccessor, getTextInRange } from '@dxos/react-client/echo';
-import { translations as editorTranslations } from '@dxos/react-ui-editor';
-import { DataType } from '@dxos/schema';
+import * as Effect from 'effect/Effect';
+import * as Option from 'effect/Option';
 
+import { Plugin } from '@dxos/app-framework';
+import { AppActivationEvents, AppPlugin } from '@dxos/app-toolkit';
+import { Operation } from '@dxos/compute';
+import { Annotation, type Obj, Ref } from '@dxos/echo';
+import { createDocAccessor, getTextInRange } from '@dxos/echo-db';
+import { SpaceOperation } from '@dxos/plugin-space/operations';
+import { type CreateObject } from '@dxos/plugin-space/types';
+import { translations as editorTranslations } from '@dxos/react-ui-editor/translations';
+import { Text } from '@dxos/schema';
+
+import { MarkdownBlueprint } from '#blueprints';
 import {
   AnchorSort,
   AppGraphSerializer,
-  ArtifactDefinition,
-  IntentResolver,
-  MarkdownState,
+  BlueprintDefinition,
   MarkdownSettings,
+  MarkdownState,
+  OperationHandler,
   ReactSurface,
-} from './capabilities';
-import { MarkdownEvents } from './events';
-import { meta } from './meta';
-import { translations } from './translations';
-import { DocumentType, MarkdownAction } from './types';
+} from '#capabilities';
+import { meta } from '#meta';
+import { MarkdownOperation } from '#operations';
+import { translations } from '#translations';
+import { Markdown, MarkdownEvents } from '#types';
+
 import { serializer } from './util';
 
-export const MarkdownPlugin = () =>
-  definePlugin(meta, [
-    defineModule({
-      id: `${meta.id}/module/translations`,
-      activatesOn: Events.SetupTranslations,
-      activate: () => contributes(Capabilities.Translations, [...translations, ...editorTranslations]),
-    }),
-    defineModule({
-      id: `${meta.id}/module/settings`,
-      activatesOn: Events.SetupSettings,
-      activate: MarkdownSettings,
-    }),
-    defineModule({
-      id: `${meta.id}/module/state`,
-      // TODO(wittjosiah): Does not integrate with settings store.
-      //   Should this be a different event?
-      //   Should settings store be renamed to be more generic?
-      activatesOn: Events.SetupSettings,
-      activate: MarkdownState,
-    }),
-    defineModule({
-      id: `${meta.id}/module/metadata`,
-      activatesOn: Events.SetupMetadata,
-      activate: () =>
-        contributes(Capabilities.Metadata, {
-          id: DocumentType.typename,
-          metadata: {
-            label: (object: DocumentType) => object.name || object.fallbackName,
-            icon: 'ph--text-aa--regular',
-            graphProps: {
-              managesAutofocus: true,
-            },
-            // TODO(wittjosiah): Move out of metadata.
-            loadReferences: async (doc: DocumentType) => await Ref.Array.loadAll<Obj.Any>([doc.content]),
-            serializer,
-            // TODO(wittjosiah): Consider how to do generic comments without these.
-            comments: 'anchored',
-            selectionMode: 'multi-range',
-            getAnchorLabel: (doc: DocumentType, anchor: string): string | undefined => {
-              if (doc.content) {
-                const [start, end] = anchor.split(':');
-                return getTextInRange(createDocAccessor(doc.content.target!, ['content']), start, end);
-              }
-            },
-          },
-        }),
-    }),
-    defineModule({
-      id: `${meta.id}/module/object-form`,
-      activatesOn: ClientEvents.SetupSchema,
-      activate: () =>
-        contributes(
-          SpaceCapabilities.ObjectForm,
-          defineObjectForm({
-            objectSchema: DocumentType,
-            getIntent: (_, { space }) => createIntent(MarkdownAction.Create, { spaceId: space.id }),
-          }),
-        ),
-    }),
-    defineModule({
-      id: `${meta.id}/module/schema`,
-      activatesOn: ClientEvents.SetupSchema,
-      activate: () => contributes(ClientCapabilities.Schema, [DataType.Text]),
-    }),
-    defineModule({
-      id: `${meta.id}/module/react-surface`,
-      activatesOn: Events.SetupReactSurface,
-      // TODO(wittjosiah): Should occur before the editor is loaded when surfaces activation is more granular.
-      activatesBefore: [MarkdownEvents.SetupExtensions],
-      activate: ReactSurface,
-    }),
-    defineModule({
-      id: `${meta.id}/module/intent-resolver`,
-      activatesOn: Events.SetupIntentResolver,
-      activate: IntentResolver,
-    }),
-    defineModule({
-      id: `${meta.id}/module/app-graph-serializer`,
-      activatesOn: Events.AppGraphReady,
-      activate: AppGraphSerializer,
-    }),
-    defineModule({
-      id: `${meta.id}/module/anchor-sort`,
-      // TODO(wittjosiah): More relevant event?
-      activatesOn: Events.AppGraphReady,
-      activate: AnchorSort,
-    }),
-    defineModule({
-      id: `${meta.id}/module/artifact-definition`,
-      activatesOn: Events.SetupArtifactDefinition,
-      activate: ArtifactDefinition,
-    }),
-  ]);
+export const MarkdownPlugin = Plugin.define(meta).pipe(
+  AppPlugin.addBlueprintDefinitionModule({ activate: BlueprintDefinition }),
+  AppPlugin.addMetadataModule({
+    metadata: {
+      id: Markdown.Document.typename,
+      metadata: {
+        // TODO(dmaretskyi): Remove label, icon and iconHue and query them of schema.
+        label: (object: Markdown.Document) => object.name || object.fallbackName,
+        icon: Annotation.IconAnnotation.get(Markdown.Document).pipe(Option.getOrThrow).icon,
+        iconHue: Annotation.IconAnnotation.get(Markdown.Document).pipe(Option.getOrThrow).hue ?? 'white',
+        blueprints: [MarkdownBlueprint.key],
+        graphProps: {
+          managesAutofocus: true,
+        },
+        // TODO(wittjosiah): Move out of metadata.
+        loadReferences: async (doc: Markdown.Document) => await Ref.Array.loadAll<Obj.Unknown>([doc.content]),
+        serializer,
+        // TODO(wittjosiah): Consider how to do generic comments without these.
+        comments: 'anchored',
+        selectionMode: 'multi-range',
+        getAnchorLabel: (doc: Markdown.Document, anchor: string): string | undefined => {
+          if (doc.content) {
+            const [start, end] = anchor.split(':');
+            return getTextInRange(createDocAccessor(doc.content.target!, ['content']), start, end);
+          }
+        },
+        createObject: ((props, options) =>
+          Effect.gen(function* () {
+            const object = Markdown.make(props);
+            return yield* Operation.invoke(SpaceOperation.AddObject, {
+              object,
+              target: options.target,
+              hidden: true,
+              targetNodeId: options.targetNodeId,
+            });
+          })) satisfies CreateObject,
+        scrollToAnchor: MarkdownOperation.ScrollToAnchor,
+      },
+    },
+  }),
+  AppPlugin.addOperationHandlerModule({ activate: OperationHandler }),
+  AppPlugin.addSchemaModule({ schema: [Markdown.Document, Text.Text] }),
+  AppPlugin.addSurfaceModule({
+    activate: ReactSurface,
+    firesBeforeActivation: [MarkdownEvents.SetupExtensions],
+  }),
+  AppPlugin.addTranslationsModule({ translations: [...translations, ...editorTranslations] }),
+  Plugin.addModule({
+    activatesOn: AppActivationEvents.SetupSettings,
+    activate: MarkdownSettings,
+  }),
+  Plugin.addModule({
+    id: 'state',
+    // TODO(wittjosiah): Does not integrate with settings store.
+    //   Should this be a different event?
+    //   Should settings store be renamed to be more generic?
+    activatesOn: AppActivationEvents.SetupSettings,
+    activate: MarkdownState,
+  }),
+  Plugin.addModule({
+    activatesOn: AppActivationEvents.AppGraphReady,
+    activate: AppGraphSerializer,
+  }),
+  Plugin.addModule({
+    // TODO(wittjosiah): More relevant event?
+    activatesOn: AppActivationEvents.AppGraphReady,
+    activate: AnchorSort,
+  }),
+  Plugin.make,
+);

package/src/blueprints/index.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+export { default as MarkdownBlueprint } from './markdown-blueprint';

package/src/blueprints/markdown-blueprint.ts

@@ -0,0 +1,43 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Blueprint, Template } from '@dxos/compute';
+import { trim } from '@dxos/util';
+
+import { Create, Open, Update } from '../operations/definitions';
+
+const BLUEPRINT_KEY = 'org.dxos.blueprint.markdown';
+
+const make = () =>
+  Blueprint.make({
+    key: BLUEPRINT_KEY,
+    name: 'Markdown',
+    description: 'Work with markdown documents. Preferred over raw database operations.',
+    tools: Blueprint.toolDefinitions({ operations: [Create, Open, Update] }),
+    instructions: Template.make({
+      // TODO(wittjosiah): Move example to function input schema annotation.
+      source: trim`
+        {{! Markdown }}
+
+        You can create, read and update markdown documents.
+        When asked to edit or update documents return updates as a set of compact diff string pairs.
+        For each diff, respond with the smallest possible matching span.
+
+        Example:
+        ${'```'}diff
+        - "There is a tyop in this sentence."
+        + "There is a typo in this sentence."
+        - "This id good."
+        + "This sentence is really good."
+        ${'```'}
+      `,
+    }),
+  });
+
+const blueprint: Blueprint.Definition = {
+  key: BLUEPRINT_KEY,
+  make,
+};
+
+export default blueprint;

package/src/capabilities/anchor-sort.ts

@@ -2,29 +2,36 @@
 // Copyright 2025 DXOS.org
 //
 
-import { Capabilities, contributes } from '@dxos/app-framework';
-import { Type } from '@dxos/echo';
-import { createDocAccessor, getRangeFromCursor, getTarget } from '@dxos/react-client/echo';
+import * as Effect from 'effect/Effect';
 
-import { DocumentType } from '../types';
+import { Capability } from '@dxos/app-framework';
+import { AppCapabilities } from '@dxos/app-toolkit';
+import { Relation } from '@dxos/echo';
+import { createDocAccessor, getRangeFromCursor } from '@dxos/echo-db';
+import { type AnchoredTo } from '@dxos/types';
 
-export default () =>
-  contributes(Capabilities.AnchorSort, {
-    key: Type.getTypename(DocumentType)!,
-    sort: (anchorA, anchorB) => {
-      const doc = getTarget(anchorA) as DocumentType;
-      const accessor = doc.content.target ? createDocAccessor(doc.content.target, ['content']) : undefined;
-      if (doc !== getTarget(anchorB) || !accessor) {
-        return 0;
-      }
+import { Markdown } from '#types';
 
-      const getStartPosition = (cursor: string | undefined) => {
-        const range = cursor ? getRangeFromCursor(accessor, cursor) : undefined;
-        return range?.start ?? Number.MAX_SAFE_INTEGER;
-      };
+export default Capability.makeModule(() =>
+  Effect.succeed(
+    Capability.contributes(AppCapabilities.AnchorSort, {
+      key: Markdown.Document.typename,
+      sort: (anchorA: AnchoredTo.AnchoredTo, anchorB: AnchoredTo.AnchoredTo) => {
+        const doc = Relation.getTarget(anchorA) as Markdown.Document;
+        const accessor = doc.content.target ? createDocAccessor(doc.content.target, ['content']) : undefined;
+        if (doc !== Relation.getTarget(anchorB) || !accessor) {
+          return 0;
+        }
 
-      const posA = getStartPosition(anchorA.anchor);
-      const posB = getStartPosition(anchorB.anchor);
-      return posA - posB;
-    },
-  });
+        const getStartPosition = (cursor: string | undefined) => {
+          const range = cursor ? getRangeFromCursor(accessor, cursor) : undefined;
+          return range?.start ?? Number.MAX_SAFE_INTEGER;
+        };
+
+        const posA = getStartPosition(anchorA.anchor);
+        const posB = getStartPosition(anchorB.anchor);
+        return posA - posB;
+      },
+    }),
+  ),
+);