@dxos/plugin-markdown 0.8.4-main.7ace549 → 0.8.4-main.9735255

package/src/capabilities/artifact-definition.ts

@@ -1,112 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-// ISSUE(burdon): defineArtifact
-// @ts-nocheck
-
-import * as Function from 'effect/Function';
-import * as Schema from 'effect/Schema';
-
-import { ToolResult, createTool } from '@dxos/ai';
-import { Capabilities, chain, contributes, createIntent } from '@dxos/app-framework';
-import { ArtifactId, createArtifactElement } from '@dxos/assistant';
-import { defineArtifact } from '@dxos/blueprints';
-import { Obj } from '@dxos/echo';
-import { assertArgument, invariant } from '@dxos/invariant';
-import { SpaceAction } from '@dxos/plugin-space/types';
-import { Filter } from '@dxos/react-client/echo';
-
-import { meta } from '../meta';
-import { Markdown, MarkdownAction } from '../types';
-
-export default () => {
-  const definition = defineArtifact({
-    id: `artifact:${meta.id}`, // TODO(burdon): meta.id/artifact?
-    name: meta.name,
-    instructions: `
-      The markdown plugin allows you to work with text documents in the current space.
-      Use these tools to interact with documents, including listing available documents and retrieving their content.
-      Documents are stored in Markdown format.
-    `,
-    schema: Markdown.Document,
-    tools: [
-      createTool(meta.id, {
-        name: 'create',
-        description: 'Create a new markdown document',
-        caption: 'Creating document...',
-        schema: Schema.Struct({
-          name: Schema.optional(Schema.String).annotations({
-            description: 'Optional name for the document.',
-          }),
-          content: Schema.String.annotations({
-            description: 'The content of the document.',
-          }),
-        }),
-        execute: async ({ name, content }, { extensions }) => {
-          invariant(extensions?.space, 'No space');
-          invariant(extensions?.dispatch, 'No intent dispatcher');
-
-          const intent = Function.pipe(
-            createIntent(MarkdownAction.Create, {
-              spaceId: extensions.space.id,
-              name,
-              content,
-            }),
-            chain(SpaceAction.AddObject, { target: extensions.space }),
-          );
-
-          const { data, error } = await extensions.dispatch(intent);
-          if (!data || error) {
-            return ToolResult.Error(error?.message ?? 'Failed to create document');
-          }
-
-          return ToolResult.Success(createArtifactElement(data.id));
-        },
-      }),
-      createTool(meta.id, {
-        name: 'list',
-        description: 'List all markdown documents in the current space.',
-        caption: 'Listing markdown documents...',
-        schema: Schema.Struct({}),
-        execute: async (_input, { extensions }) => {
-          invariant(extensions?.space, 'No space');
-          const space = extensions.space;
-          const { objects: documents } = await space.db.query(Filter.type(Markdown.Document)).run();
-          const documentInfo = documents.map((doc) => {
-            invariant(Obj.instanceOf(Markdown.Document, doc));
-            return {
-              id: Obj.getDXN(doc).toString(),
-              name: doc.name || doc.fallbackName || 'Unnamed Document',
-              // TODO(ZaymonFC): Include updatedAt?
-            };
-          });
-
-          return ToolResult.Success(documentInfo);
-        },
-      }),
-      createTool(meta.id, {
-        name: 'inspect',
-        description: 'Read the content of a markdown document.',
-        caption: 'Inspecting markdown document...',
-        schema: Schema.Struct({
-          id: ArtifactId,
-        }),
-        execute: async ({ id }, { extensions }) => {
-          invariant(extensions?.space, 'No space');
-          const document = await extensions.space.db.query(Filter.ids(ArtifactId.toDXN(id).toString())).first();
-          assertArgument(Obj.instanceOf(Markdown.Document, document), 'document', 'Invalid type');
-
-          const { content } = await document.content?.load();
-          return ToolResult.Success({
-            id: Obj.getDXN(document).toString(),
-            name: document.name || document.fallbackName || 'Unnamed Document',
-            content,
-          });
-        },
-      }),
-    ],
-  });
-
-  return contributes(Capabilities.ArtifactDefinition, definition);
-};

package/src/capabilities/blueprint-definition.ts

@@ -1,43 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Capabilities, contributes } from '@dxos/app-framework';
-import { Blueprint, Template } from '@dxos/blueprints';
-import { type FunctionDefinition } from '@dxos/functions';
-import { trim } from '@dxos/util';
-
-import { MarkdownFunction } from '../functions';
-
-const functions: FunctionDefinition[] = [MarkdownFunction.create, MarkdownFunction.open, MarkdownFunction.update];
-
-export const MARKDOWN_BLUEPRINT_KEY = 'dxos.org/blueprint/markdown';
-
-export const MarkdownBlueprint: Blueprint.Blueprint = Blueprint.make({
-  key: MARKDOWN_BLUEPRINT_KEY,
-  name: 'Markdown',
-  tools: Blueprint.toolDefinitions({ functions }),
-  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."
-      ${'```'}
-    `,
-  }),
-});
-
-export default () => [
-  contributes(Capabilities.Functions, functions),
-  contributes(Capabilities.BlueprintDefinition, MarkdownBlueprint),
-];

package/src/capabilities/capabilities.ts

@@ -1,22 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { defineCapability } from '@dxos/app-framework';
-import { type EditorStateStore, type EditorViewMode } from '@dxos/react-ui-editor';
-
-import { meta } from '../meta';
-import { type MarkdownExtensionProvider, type MarkdownPluginState } from '../types';
-
-export namespace MarkdownCapabilities {
-  export const State = defineCapability<{
-    state: MarkdownPluginState;
-    editorState: EditorStateStore;
-    getViewMode: (id: string) => EditorViewMode;
-    // TODO(burdon): Event object.
-    setViewMode: (id: string, viewMode: EditorViewMode) => void;
-  }>(`${meta.id}/capability/state`);
-
-  // TODO(burdon): Move to ./types (external API)?
-  export const Extensions = defineCapability<MarkdownExtensionProvider[]>(`${meta.id}/capability/extensions`);
-}

package/src/capabilities/intent-resolver.ts

@@ -1,58 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { next as A } from '@automerge/automerge';
-import * as Option from 'effect/Option';
-import type * as Schema from 'effect/Schema';
-
-import {
-  Capabilities,
-  CollaborationActions,
-  type PluginContext,
-  contributes,
-  createResolver,
-} from '@dxos/app-framework';
-import { Obj } from '@dxos/echo';
-import { createDocAccessor, getRangeFromCursor } from '@dxos/echo-db';
-
-import { Markdown, MarkdownAction } from '../types';
-
-import { MarkdownCapabilities } from './capabilities';
-
-export default (context: PluginContext) =>
-  contributes(Capabilities.IntentResolver, [
-    createResolver({
-      intent: MarkdownAction.Create,
-      resolve: ({ name, content }) => {
-        return { data: { object: Markdown.make({ name, content }) } };
-      },
-    }),
-    createResolver({
-      intent: MarkdownAction.SetViewMode,
-      resolve: ({ id, viewMode }) => {
-        const { state } = context.getCapability(MarkdownCapabilities.State);
-        state.viewMode[id] = viewMode;
-      },
-    }),
-    createResolver({
-      intent: CollaborationActions.AcceptProposal,
-      filter: (
-        data,
-      ): data is Omit<Schema.Schema.Type<typeof CollaborationActions.AcceptProposal.fields.input>, 'subject'> & {
-        subject: Markdown.Document;
-      } => Obj.instanceOf(Markdown.Document, data.subject),
-      resolve: async ({ subject, anchor, proposal }) => {
-        const text = await subject.content.load();
-        const accessor = createDocAccessor(text, ['content']);
-        const { start, end } = Option.fromNullable(anchor).pipe(
-          Option.flatMap((at) => Option.fromNullable(getRangeFromCursor(accessor, at))),
-          // Fallback to the end of the document.
-          Option.getOrElse(() => ({ start: text.content.length - 1, end: text.content.length - 1 })),
-        );
-        accessor.handle.change((doc) => {
-          A.splice(doc, accessor.path.slice(), start, end - start, proposal.text);
-        });
-      },
-    }),
-  ]);

package/src/capabilities/react-surface.tsx

@@ -1,93 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import React, { useCallback } from 'react';
-
-import { Capabilities, contributes, createSurface } from '@dxos/app-framework';
-import { SurfaceCardRole, useCapability } from '@dxos/app-framework/react';
-import { Obj } from '@dxos/echo';
-import { SettingsStore } from '@dxos/local-storage';
-import { AttentionCapabilities } from '@dxos/plugin-attention';
-import { Text } from '@dxos/schema';
-
-import { MarkdownCard, MarkdownContainer, type MarkdownContainerProps, MarkdownSettings } from '../components';
-import { meta } from '../meta';
-import { Markdown } from '../types';
-import { isEditorModel } from '../util';
-
-import { MarkdownCapabilities } from './capabilities';
-
-export default () =>
-  contributes(Capabilities.ReactSurface, [
-    createSurface({
-      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 }) => {
-        return <Container id={Obj.getDXN(data.subject).toString()} subject={data.subject} role={role} />;
-      },
-    }),
-    createSurface({
-      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} />;
-      },
-    }),
-    // TODO(burdon): Remove this variant and conform to Text.
-    createSurface({
-      id: `${meta.id}/surface/editor`,
-      role: ['article', 'section'],
-      filter: (data): data is { subject: { id: string; text: string } } => isEditorModel(data.subject),
-      component: ({ data, role }) => {
-        return <Container id={data.subject.id} subject={data.subject} role={role} />;
-      },
-    }),
-    createSurface({
-      id: `${meta.id}/surface/plugin-settings`,
-      role: 'article',
-      filter: (data): data is { subject: SettingsStore<Markdown.Settings> } =>
-        data.subject instanceof SettingsStore && data.subject.prefix === meta.id,
-      component: ({ data: { subject } }) => <MarkdownSettings settings={subject.value} />,
-    }),
-    createSurface({
-      id: `${meta.id}/surface/preview`,
-      role: SurfaceCardRole.literals as any,
-      filter: (data): data is { subject: Markdown.Document | Text.Text } =>
-        Obj.instanceOf(Markdown.Document, data.subject) || Obj.instanceOf(Text.Text, data.subject),
-      component: ({ data, role }) => <MarkdownCard {...data} role={role as SurfaceCardRole} />,
-    }),
-  ]);
-
-/**
- * Common wrapper.
- */
-const Container = ({ id, subject, role }: { id: string; subject: MarkdownContainerProps['object']; role: string }) => {
-  const selectionManager = useCapability(AttentionCapabilities.Selection);
-  const settingsStore = useCapability(Capabilities.SettingsStore);
-  const settings = settingsStore.getStore<Markdown.Settings>(meta.id)!.value;
-  const { state, editorState, getViewMode, setViewMode } = useCapability(MarkdownCapabilities.State);
-  const viewMode = getViewMode(id);
-  const handleViewModeChange = useCallback<NonNullable<MarkdownContainerProps['onViewModeChange']>>(
-    (mode) => setViewMode(id, mode),
-    [id, setViewMode],
-  );
-
-  return (
-    <MarkdownContainer
-      id={id}
-      object={subject}
-      role={role}
-      settings={settings}
-      selectionManager={selectionManager}
-      extensionProviders={state.extensionProviders}
-      editorStateStore={editorState}
-      viewMode={viewMode}
-      onViewModeChange={handleViewModeChange}
-    />
-  );
-};

package/src/capabilities/settings.ts

@@ -1,25 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Capabilities, contributes } from '@dxos/app-framework';
-import { live } from '@dxos/live-object';
-
-import { meta } from '../meta';
-import { Markdown } from '../types';
-
-export default () => {
-  const settings = live<Markdown.Settings>({
-    defaultViewMode: 'preview',
-    toolbar: true,
-    numberedHeadings: true,
-    folding: true,
-    experimental: false,
-  });
-
-  return contributes(Capabilities.Settings, {
-    prefix: meta.id,
-    schema: Markdown.Settings,
-    value: settings,
-  });
-};

package/src/capabilities/state.ts

@@ -1,31 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Capabilities, type PluginContext, contributes } from '@dxos/app-framework';
-import { LocalStorageStore } from '@dxos/local-storage';
-import { type EditorViewMode, createEditorStateStore } from '@dxos/react-ui-editor';
-
-import { meta } from '../meta';
-import { type Markdown, type MarkdownPluginState } from '../types';
-
-import { MarkdownCapabilities } from './capabilities';
-
-export default (context: PluginContext) => {
-  const state = new LocalStorageStore<MarkdownPluginState>(meta.id, { extensionProviders: [], viewMode: {} });
-  state.prop({ key: 'viewMode', type: LocalStorageStore.json<{ [key: string]: EditorViewMode }>() });
-
-  // TODO(wittjosiah): Fold into state.
-  const editorState = createEditorStateStore(`${meta.id}/editor`);
-
-  const getViewMode = (id: string) => {
-    const defaultViewMode = context.getCapability(Capabilities.SettingsStore).getStore<Markdown.Settings>(meta.id)!
-      .value.defaultViewMode;
-    return (id && state.values.viewMode[id]) || defaultViewMode;
-  };
-
-  const setViewMode = (id: string, viewMode: EditorViewMode) => (state.values.viewMode[id] = viewMode);
-
-  // Return object with methods.
-  return contributes(MarkdownCapabilities.State, { state: state.values, editorState, getViewMode, setViewMode });
-};

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