@dxos/plugin-markdown 0.8.4-main.c4373fc → 0.8.4-main.d9fc60f731

package/src/types/Settings.ts

@@ -0,0 +1,85 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+// @import-as-namespace
+
+import * as Schema from 'effect/Schema';
+
+import { EditorInputMode, EditorViewMode } from '@dxos/ui-editor/types';
+
+/**
+ * Determines how new comment threads on markdown documents are wired up to
+ * the comment-thread AI agent (plugin-thread). The agent's identity (name,
+ * DID) is resolved at runtime via the AgentIdentity capability — this
+ * setting only controls whether and when the agent fires.
+ *
+ * - `off`: comments are plain user-only threads (no agent).
+ * - `auto`: every user message in a thread triggers an agent response.
+ * - `mention`: agent only responds when the message contains `@{agentName}`.
+ */
+export const CommentAgentMode = Schema.Union(Schema.Literal('off'), Schema.Literal('auto'), Schema.Literal('mention'));
+export type CommentAgentMode = Schema.Schema.Type<typeof CommentAgentMode>;
+
+/**
+ * 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.',
+    }),
+    commentAgentMode: Schema.optional(
+      CommentAgentMode.annotations({
+        title: 'Comment agent mode',
+        description:
+          "How new comment threads on markdown documents are processed: 'off' (no AI), 'auto' (AI responds to every user message), or 'mention' (AI responds only on @mention).",
+      }),
+    ),
+    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';

package/src/types/types.ts

@@ -2,8 +2,9 @@
 // Copyright 2023 DXOS.org
 //
 
-import { type Extension } from '@dxos/react-ui-editor';
-import { type EditorViewMode } from '@dxos/react-ui-editor/types';
+import { type Extension } from '@codemirror/state';
+
+import { type EditorViewMode } from '@dxos/ui-editor/types';
 
 import { type Document } from './Markdown';
 
@@ -11,7 +12,10 @@ import { type Document } from './Markdown';
 // TODO(wittjosiah): MarkdownExtensionProvider is a part of the MarkdownCapabilities api which should be in ./types.
 
 // TODO(burdon): Async?
-export type MarkdownExtensionProvider = (props: { document?: Document }) => Extension | undefined;
+export type MarkdownExtensionProvider = (props: {
+  document?: Document;
+  viewMode?: EditorViewMode;
+}) => Extension | undefined;
 
 export type MarkdownPluginState = {
   // Codemirror extensions provided by other plugins.

package/src/util.test.ts

@@ -0,0 +1,44 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { describe, expect, it } from 'vitest';
+
+import { trim } from '@dxos/util';
+
+import { getFallbackName } from './util';
+
+describe('markdown utils', () => {
+  it('getFallbackName', () => {
+    const tests = [
+      {
+        content: '',
+        expected: '',
+      },
+      {
+        content: trim`
+          ![img](https://dxos.network/dxos-logotype-blue.png)
+
+          # Welcome to Composer by DXOS
+
+          ## What is Composer?
+        `,
+        expected: 'Welcome to Composer by DXOS',
+      },
+      {
+        content: trim`
+          ![img](https://dxos.network/dxos-logotype-blue.png)
+
+          ---
+
+          This document is about the decetralized platform DXOS.
+        `,
+        expected: 'This document is about the…',
+      },
+    ];
+
+    tests.forEach(({ content, expected }) => {
+      expect(getFallbackName(content)).toBe(expected);
+    });
+  });
+});

package/src/util.tsx

@@ -4,9 +4,9 @@
 
 import { debounce } from '@dxos/async';
 import { Obj } from '@dxos/echo';
-import { type TypedObjectSerializer } from '@dxos/plugin-space/types';
+import { type TypedObjectSerializer } from '@dxos/plugin-space';
 
-import { Markdown } from './types';
+import { Markdown } from '#types';
 
 /**
  * Checks if an object conforms to the interface needed to render an editor.
@@ -32,18 +32,93 @@ export const isMarkdownProperties = (data: unknown): data is MarkdownProperties
 
 const nonTitleChars = /[^\w ]/g;
 
-export const getFallbackName = (content: string) => {
-  return content.substring(0, 31).split('\n')[0].replaceAll(nonTitleChars, '').trim();
+// Lines matching these patterns are skipped.
+const skipPatterns = [
+  /^!\[/, // Image.
+  /^---\s*$/, // Horizontal rule.
+  /^```/, // Code block fence.
+  /^\s*$/, // Empty or whitespace-only.
+];
+
+// Patterns to extract title text (first capture group is used).
+const titlePatterns = [
+  /^#{1,6}\s+(.+)/, // Heading.
+];
+
+/**
+ * Extracts a fallback name by scanning lines for the first heading or text fragment.
+ */
+export const getFallbackName = (content = ''): string => {
+  const len = content.length;
+
+  let i = 0;
+  while (i < len) {
+    // Find end of line.
+    let lineEnd = i;
+    while (lineEnd < len && content[lineEnd] !== '\n') {
+      lineEnd++;
+    }
+
+    const line = content.slice(i, lineEnd).trim();
+    i = lineEnd + 1;
+
+    // Skip lines matching skip patterns.
+    if (skipPatterns.some((pattern) => pattern.test(line))) {
+      continue;
+    }
+
+    // Check for title patterns.
+    for (const pattern of titlePatterns) {
+      const match = pattern.exec(line);
+      if (match) {
+        const text = match[1].replaceAll(nonTitleChars, '').trim();
+        if (text.length > 0) {
+          return text;
+        }
+      }
+    }
+
+    // Use line as plain text fallback.
+    const maxLen = 32;
+    const text = line.replaceAll(nonTitleChars, '').trim();
+    if (text.length > 0) {
+      if (text.length > maxLen) {
+        const words = text.split(/\s+/);
+        let result = '';
+        for (const word of words) {
+          const next = result.length === 0 ? word : result + ' ' + word;
+          if (next.length > maxLen) {
+            break;
+          }
+          result = next;
+        }
+
+        return result + '…';
+      }
+
+      return text;
+    }
+  }
+
+  return '';
 };
 
-export const getAbstract = (content: string) => {
-  return content.substring(0, 128).split('\n')[0].replaceAll(nonTitleChars, '').trim();
+// TODO(burdon): Option to strip Markdown.
+export const getContentSnippet = (content = '', maxLines = 3) => {
+  const abstract = content
+    .split('\n')
+    .filter((line) => !line.startsWith('!'))
+    .filter((line) => line.trim() !== '');
+
+  return abstract.slice(0, maxLines).join('\n') ?? '';
 };
 
-export const setFallbackName = debounce((doc: Markdown.Document, content: string) => {
+export const setFallbackName = debounce((doc: Markdown.Document, content = '') => {
   const name = getFallbackName(content);
   if (doc.fallbackName !== name) {
-    doc.fallbackName = name;
+    Obj.update(doc, (doc) => {
+      doc.fallbackName = name;
+    });
   }
 }, 200);
 
@@ -55,6 +130,6 @@ export const serializer: TypedObjectSerializer<Markdown.Document> = {
 
   deserialize: async ({ content: serialized }) => {
     const { name, fallbackName, content } = JSON.parse(serialized);
-    return Markdown.makeDocument({ name, fallbackName, content });
+    return Markdown.make({ name, fallbackName, content });
   },
 };

package/dist/lib/browser/MarkdownCard-ZHTH6EVA.mjs

@@ -1,80 +0,0 @@
-import {
-  getAbstract,
-  getFallbackName
-} from "./chunk-XYQDM6PM.mjs";
-import {
-  Markdown_exports
-} from "./chunk-PMBWHKDI.mjs";
-import {
-  meta
-} from "./chunk-ODB2PTBP.mjs";
-
-// src/components/MarkdownCard/MarkdownCard.tsx
-import { useSignals as _useSignals } from "@preact-signals/safe-react/tracking";
-import * as Function from "effect/Function";
-import React, { useCallback } from "react";
-import { LayoutAction, chain, createIntent, useIntentDispatcher } from "@dxos/app-framework";
-import { Obj } from "@dxos/echo";
-import { fullyQualifiedId } from "@dxos/react-client/echo";
-import { Button, Icon, useTranslation } from "@dxos/react-ui";
-import { Card } from "@dxos/react-ui-stack";
-import { DataType } from "@dxos/schema";
-var getTitle = (subject, fallback) => {
-  if (Obj.instanceOf(Markdown_exports.Document, subject)) {
-    return subject.name ?? subject.fallbackName ?? getFallbackName(subject.content?.target?.content ?? fallback);
-  } else if (Obj.instanceOf(DataType.Text, subject)) {
-    return getFallbackName(subject.content);
-  }
-};
-var getSnippet = (subject, fallback) => {
-  if (Obj.instanceOf(Markdown_exports.Document, subject)) {
-    return getAbstract(subject.content?.target?.content ?? fallback);
-  } else if (Obj.instanceOf(DataType.Text, subject)) {
-    return getAbstract(subject.content);
-  }
-};
-var MarkdownCard = ({ subject, role }) => {
-  var _effect = _useSignals();
-  try {
-    const { dispatchPromise: dispatch } = useIntentDispatcher();
-    const { t } = useTranslation(meta.id);
-    const snippet = getSnippet(subject, t("fallback abstract"));
-    const handleNavigate = useCallback(() => dispatch(Function.pipe(createIntent(LayoutAction.UpdatePopover, {
-      part: "popover",
-      subject: null,
-      options: {
-        state: false,
-        anchorId: ""
-      }
-    }), chain(LayoutAction.Open, {
-      part: "main",
-      subject: [
-        fullyQualifiedId(subject)
-      ]
-    }))), [
-      dispatch,
-      subject
-    ]);
-    return /* @__PURE__ */ React.createElement(Card.SurfaceRoot, {
-      role
-    }, /* @__PURE__ */ React.createElement(Card.Heading, null, getTitle(subject, t("fallback title"))), snippet && /* @__PURE__ */ React.createElement(Card.Text, {
-      classNames: "line-clamp-3 break-words col-span-2"
-    }, snippet), role === "card--popover" && /* @__PURE__ */ React.createElement(Card.Chrome, null, /* @__PURE__ */ React.createElement(Button, {
-      onClick: handleNavigate
-    }, /* @__PURE__ */ React.createElement("span", {
-      className: "grow"
-    }, t("navigate to document label")), /* @__PURE__ */ React.createElement(Icon, {
-      icon: "ph--arrow-right--regular"
-    }))));
-  } finally {
-    _effect.f();
-  }
-};
-
-// src/components/MarkdownCard/index.ts
-var MarkdownCard_default = MarkdownCard;
-export {
-  MarkdownCard,
-  MarkdownCard_default as default
-};
-//# sourceMappingURL=MarkdownCard-ZHTH6EVA.mjs.map

package/dist/lib/browser/MarkdownCard-ZHTH6EVA.mjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/components/MarkdownCard/MarkdownCard.tsx", "../../../src/components/MarkdownCard/index.ts"],
-  "sourcesContent": ["//\n// Copyright 2025 DXOS.org\n//\n\nimport * as Function from 'effect/Function';\nimport React, { useCallback } from 'react';\n\nimport { LayoutAction, chain, createIntent, useIntentDispatcher } from '@dxos/app-framework';\nimport { Obj } from '@dxos/echo';\nimport { type PreviewProps } from '@dxos/plugin-preview';\nimport { fullyQualifiedId } from '@dxos/react-client/echo';\nimport { Button, Icon, useTranslation } from '@dxos/react-ui';\nimport { Card } from '@dxos/react-ui-stack';\nimport { DataType } from '@dxos/schema';\n\nimport { meta } from '../../meta';\nimport { Markdown } from '../../types';\nimport { getAbstract, getFallbackName } from '../../util';\n\n// TODO(burdon): Factor out.\nconst getTitle = (subject: Markdown.Document | DataType.Text, fallback: string) => {\n  if (Obj.instanceOf(Markdown.Document, subject)) {\n    return subject.name ?? subject.fallbackName ?? getFallbackName(subject.content?.target?.content ?? fallback);\n  } else if (Obj.instanceOf(DataType.Text, subject)) {\n    return getFallbackName(subject.content);\n  }\n};\n\n// TODO(burdon): Factor out.\nconst getSnippet = (subject: Markdown.Document | DataType.Text, fallback: string) => {\n  if (Obj.instanceOf(Markdown.Document, subject)) {\n    return getAbstract(subject.content?.target?.content ?? fallback);\n  } else if (Obj.instanceOf(DataType.Text, subject)) {\n    return getAbstract(subject.content);\n  }\n};\n\nexport type MarkdownCardProps = PreviewProps<Markdown.Document | DataType.Text>;\n\nexport const MarkdownCard = ({ subject, role }: MarkdownCardProps) => {\n  const { dispatchPromise: dispatch } = useIntentDispatcher();\n  const { t } = useTranslation(meta.id);\n  const snippet = getSnippet(subject, t('fallback abstract'));\n\n  // TODO(wittjosiah): Factor out so this component isn't dependent on the app framework.\n  const handleNavigate = useCallback(\n    () =>\n      dispatch(\n        Function.pipe(\n          createIntent(LayoutAction.UpdatePopover, {\n            part: 'popover',\n            subject: null,\n            options: { state: false, anchorId: '' },\n          }),\n          chain(LayoutAction.Open, { part: 'main', subject: [fullyQualifiedId(subject)] }),\n        ),\n      ),\n    [dispatch, subject],\n  );\n\n  return (\n    <Card.SurfaceRoot role={role}>\n      <Card.Heading>{getTitle(subject, t('fallback title'))}</Card.Heading>\n      {snippet && <Card.Text classNames='line-clamp-3 break-words col-span-2'>{snippet}</Card.Text>}\n      {role === 'card--popover' && (\n        <Card.Chrome>\n          <Button onClick={handleNavigate}>\n            <span className='grow'>{t('navigate to document label')}</span>\n            <Icon icon='ph--arrow-right--regular' />\n          </Button>\n        </Card.Chrome>\n      )}\n    </Card.SurfaceRoot>\n  );\n};\n", "//\n// Copyright 2025 DXOS.org\n//\n\nimport { MarkdownCard } from './MarkdownCard';\n\nexport * from './MarkdownCard';\n\nexport default MarkdownCard;\n"],
-  "mappings": ";;;;;;;;;;;;;AAIA,YAAYA,cAAc;AAC1B,OAAOC,SAASC,mBAAmB;AAEnC,SAASC,cAAcC,OAAOC,cAAcC,2BAA2B;AACvE,SAASC,WAAW;AAEpB,SAASC,wBAAwB;AACjC,SAASC,QAAQC,MAAMC,sBAAsB;AAC7C,SAASC,YAAY;AACrB,SAASC,gBAAgB;AAOzB,IAAMC,WAAW,CAACC,SAA4CC,aAAAA;AAC5D,MAAIC,IAAIC,WAAWC,iBAASC,UAAUL,OAAAA,GAAU;AAC9C,WAAOA,QAAQM,QAAQN,QAAQO,gBAAgBC,gBAAgBR,QAAQS,SAASC,QAAQD,WAAWR,QAAAA;EACrG,WAAWC,IAAIC,WAAWQ,SAASC,MAAMZ,OAAAA,GAAU;AACjD,WAAOQ,gBAAgBR,QAAQS,OAAO;EACxC;AACF;AAGA,IAAMI,aAAa,CAACb,SAA4CC,aAAAA;AAC9D,MAAIC,IAAIC,WAAWC,iBAASC,UAAUL,OAAAA,GAAU;AAC9C,WAAOc,YAAYd,QAAQS,SAASC,QAAQD,WAAWR,QAAAA;EACzD,WAAWC,IAAIC,WAAWQ,SAASC,MAAMZ,OAAAA,GAAU;AACjD,WAAOc,YAAYd,QAAQS,OAAO;EACpC;AACF;AAIO,IAAMM,eAAe,CAAC,EAAEf,SAASgB,KAAI,MAAqB;;;AAC/D,UAAM,EAAEC,iBAAiBC,SAAQ,IAAKC,oBAAAA;AACtC,UAAM,EAAEC,EAAC,IAAKC,eAAeC,KAAKC,EAAE;AACpC,UAAMC,UAAUX,WAAWb,SAASoB,EAAE,mBAAA,CAAA;AAGtC,UAAMK,iBAAiBC,YACrB,MACER,SACWS,cACPC,aAAaC,aAAaC,eAAe;MACvCC,MAAM;MACN/B,SAAS;MACTgC,SAAS;QAAEC,OAAO;QAAOC,UAAU;MAAG;IACxC,CAAA,GACAC,MAAMN,aAAaO,MAAM;MAAEL,MAAM;MAAQ/B,SAAS;QAACqC,iBAAiBrC,OAAAA;;IAAU,CAAA,CAAA,CAAA,GAGpF;MAACkB;MAAUlB;KAAQ;AAGrB,WACE,sBAAA,cAACsC,KAAKC,aAAW;MAACvB;OAChB,sBAAA,cAACsB,KAAKE,SAAO,MAAEzC,SAASC,SAASoB,EAAE,gBAAA,CAAA,CAAA,GAClCI,WAAW,sBAAA,cAACc,KAAK1B,MAAI;MAAC6B,YAAW;OAAuCjB,OAAAA,GACxER,SAAS,mBACR,sBAAA,cAACsB,KAAKI,QAAM,MACV,sBAAA,cAACC,QAAAA;MAAOC,SAASnB;OACf,sBAAA,cAACoB,QAAAA;MAAKC,WAAU;OAAQ1B,EAAE,4BAAA,CAAA,GAC1B,sBAAA,cAAC2B,MAAAA;MAAKC,MAAK;;;;;AAMvB;;;AClEA,IAAA,uBAAeC;",
-  "names": ["Function", "React", "useCallback", "LayoutAction", "chain", "createIntent", "useIntentDispatcher", "Obj", "fullyQualifiedId", "Button", "Icon", "useTranslation", "Card", "DataType", "getTitle", "subject", "fallback", "Obj", "instanceOf", "Markdown", "Document", "name", "fallbackName", "getFallbackName", "content", "target", "DataType", "Text", "getSnippet", "getAbstract", "MarkdownCard", "role", "dispatchPromise", "dispatch", "useIntentDispatcher", "t", "useTranslation", "meta", "id", "snippet", "handleNavigate", "useCallback", "pipe", "createIntent", "LayoutAction", "UpdatePopover", "part", "options", "state", "anchorId", "chain", "Open", "fullyQualifiedId", "Card", "SurfaceRoot", "Heading", "classNames", "Chrome", "Button", "onClick", "span", "className", "Icon", "icon", "MarkdownCard"]
-}