@dxos/plugin-mermaid 0.8.4-main.fd6878d → 0.9.0

package/LICENSE

@@ -1,8 +1,105 @@
-MIT License 
-Copyright (c) 2022 DXOS
+# Functional Source License, Version 1.1, ALv2 Future License
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+## Abbreviation
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+FSL-1.1-Apache-2.0
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+## Notice
+
+Copyright 2026 DXOS
+
+## Terms and Conditions
+
+### Licensor ("We")
+
+The party offering the Software under these Terms and Conditions.
+
+### The Software
+
+The "Software" is each version of the software that we make available under
+these Terms and Conditions, as indicated by our inclusion of these Terms and
+Conditions with the Software.
+
+### License Grant
+
+Subject to your compliance with this License Grant and the Patents,
+Redistribution and Trademark clauses below, we hereby grant you the right to
+use, copy, modify, create derivative works, publicly perform, publicly display
+and redistribute the Software for any Permitted Purpose identified below.
+
+### Permitted Purpose
+
+A Permitted Purpose is any purpose other than a Competing Use. A Competing Use
+means making the Software available to others in a commercial product or
+service that:
+
+1. substitutes for the Software;
+
+2. substitutes for any other product or service we offer using the Software
+   that exists as of the date we make the Software available; or
+
+3. offers the same or substantially similar functionality as the Software.
+
+Permitted Purposes specifically include using the Software:
+
+1. for your internal use and access;
+
+2. for non-commercial education;
+
+3. for non-commercial research; and
+
+4. in connection with professional services that you provide to a licensee
+   using the Software in accordance with these Terms and Conditions.
+
+### Patents
+
+To the extent your use for a Permitted Purpose would necessarily infringe our
+patents, the license grant above includes a license under our patents. If you
+make a claim against any party that the Software infringes or contributes to
+the infringement of any patent, then your patent license to the Software ends
+immediately.
+
+### Redistribution
+
+The Terms and Conditions apply to all copies, modifications and derivatives of
+the Software.
+
+If you redistribute any copies, modifications or derivatives of the Software,
+you must include a copy of or a link to these Terms and Conditions and not
+remove any copyright notices provided in or with the Software.
+
+### Disclaimer
+
+THE SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTIES OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING WITHOUT LIMITATION WARRANTIES OF FITNESS FOR A PARTICULAR
+PURPOSE, MERCHANTABILITY, TITLE OR NON-INFRINGEMENT.
+
+IN NO EVENT WILL WE HAVE ANY LIABILITY TO YOU ARISING OUT OF OR RELATED TO THE
+SOFTWARE, INCLUDING INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES,
+EVEN IF WE HAVE BEEN INFORMED OF THEIR POSSIBILITY IN ADVANCE.
+
+### Trademarks
+
+Except for displaying the License Details and identifying us as the origin of
+the Software, you have no right under these Terms and Conditions to use our
+trademarks, trade names, service marks or product names.
+
+## Grant of Future License
+
+We hereby irrevocably grant you an additional license to use the Software under
+the Apache License, Version 2.0 that is effective on the second anniversary of
+the date we make the Software available. On or after that date, you may use the
+Software under the Apache License, Version 2.0, in which case the following
+will apply:
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use
+this file except in compliance with the License.
+
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed
+under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+CONDITIONS OF ANY KIND, either express or implied. See the License for the
+specific language governing permissions and limitations under the License.

package/PLUGIN.mdl

@@ -0,0 +1,260 @@
+---
+id: org.dxos.plugin.mermaid
+name: MermaidPlugin
+version: 0.1.0
+---
+
+A CodeMirror extension plugin for DXOS Composer that renders Mermaid diagram
+definitions as live SVG previews inside the markdown editor.
+
+## Extensions
+
+The following extension dialects are used in this document.
+Each extension is defined in the Appendix or resolved via its URI.
+
+| Term        | URI                           |
+|-------------|-------------------------------|
+| `type`      | `org.dxos.mdl.type@1.0`      |
+| `feat`      | `org.dxos.mdl.feat@1.0`      |
+| `test`      | `org.dxos.mdl.test@1.0`      |
+| `component` | `org.dxos.mdl.component@1.0` |
+| `op`        | `org.dxos.mdl.op@1.0`        |
+
+## Types
+
+```mdl
+type DiagramKind
+  literals: flowchart | sequenceDiagram | classDiagram | stateDiagram | erDiagram | gantt | pie | gitGraph | mindmap | timeline
+```
+
+```mdl
+type DiagramTheme
+  literals: default | neutral | dark | forest | base
+```
+
+```mdl
+type RenderResult
+  fields:
+    svg: string          # rendered SVG markup
+    id: string           # unique widget id used by the Mermaid API
+```
+
+```mdl
+type RenderError
+  fields:
+    message: string      # human-readable parse or render error text
+    source: string       # the Mermaid source that caused the error
+```
+
+## Components
+
+```mdl
+component MermaidWidget
+  desc: |
+    An inline CodeMirror widget that replaces a ```mermaid fenced code block
+    with its rendered SVG diagram. The source code block is hidden while the
+    cursor is outside it; moving the cursor inside restores the raw text for
+    editing.
+  props:
+    id: string             # unique widget id (mermaid-<offset>)
+    source: string         # raw Mermaid diagram source
+    label?: string         # first token of source used as a diagram-type badge
+    darkMode: boolean      # mirrors the editor dark-theme facet
+  state:
+    svg?: string           # last successfully rendered SVG
+    error?: string         # last render error message; shown in place of diagram
+  layout: |
+    ┌────────────────────────────────┐
+    │  [rendered SVG diagram]        │
+    │                       [label] │
+    └────────────────────────────────┘
+    (on error)
+    ┌────────────────────────────────┐
+    │  error text                    │
+    └────────────────────────────────┘
+```
+
+## Operations
+
+```mdl
+op renderDiagram
+  desc: Parses a Mermaid source string and renders it to SVG via the Mermaid JS API.
+  input:
+    id: string             # unique element id required by the Mermaid render API
+    source: string         # raw Mermaid diagram definition
+    darkMode?: boolean     # sets darkMode / theme on the Mermaid config
+  output: RenderResult
+  errors:
+    ParseError: source does not conform to Mermaid syntax
+    RenderError: SVG generation failed after successful parse
+```
+
+## Features
+
+```mdl
+feat F-1: Diagram Rendering
+
+  req F-1.1:
+    when: a fenced code block with language tag `mermaid` is present in the document
+    then: the block is replaced by a rendered SVG diagram widget
+
+  req F-1.2:
+    when: the cursor moves inside the fenced code block
+    then: raw source text is revealed for editing and the widget is hidden
+
+  req F-1.3:
+    when: the cursor moves outside the fenced code block
+    then: the widget is restored and the raw text is hidden
+
+  req F-1.4:
+    when: the editor is in read-only mode
+    then: widgets are always shown regardless of cursor position
+```
+
+```mdl
+feat F-2: Error Handling
+
+  req F-2.1:
+    when: Mermaid fails to parse the source
+    then: an inline error message is shown in place of the diagram
+
+  req F-2.2:
+    when: a previously failing source is corrected
+    then: the widget re-renders and displays the valid diagram
+```
+
+```mdl
+feat F-3: Theme Integration
+
+  req F-3.1:
+    when: the editor's dark-theme facet is true
+    then: the Mermaid diagram is initialized with darkMode enabled
+
+  req F-3.2: The rendered widget uses the editor's group-surface background token.
+```
+
+```mdl
+feat F-4: Markdown Editor Integration
+
+  req F-4.1:
+    when: the MermaidPlugin is loaded
+    then: it registers the mermaid CodeMirror extension via MarkdownCapabilities.ExtensionProvider
+
+  req F-4.2: The plugin activates on MarkdownEvents.SetupExtensions.
+```
+
+## Acceptance
+
+```mdl
+test T-1: Valid flowchart renders
+  given: a document containing a ```mermaid fenced block with a valid flowchart definition
+  then:
+    - the raw code block lines are hidden
+    - an SVG widget is injected immediately after the block
+    - no error text is visible
+```
+
+```mdl
+test T-2: Cursor-in/out toggle
+  given: a rendered Mermaid widget is visible
+  when: the cursor moves inside the fenced code block
+  then:
+    - the cm-mermaid-hidden class is removed from the block lines
+    - the widget is no longer rendered in the viewport
+
+  when: the cursor moves back outside the block
+  then:
+    - block lines are hidden again
+    - widget is rendered again
+```
+
+```mdl
+test T-3: Invalid syntax shows error
+  given: a document containing a ```mermaid block with invalid syntax
+  then:
+    - no SVG is rendered
+    - an inline error message is shown with class cm-mermaid-error
+```
+
+```mdl
+test T-4: Read-only always shows widget
+  given: the editor is in read-only mode
+  when: any cursor position
+  then: widgets are rendered and raw source lines remain hidden
+```
+
+```mdl
+test T-5: Plugin activates on markdown event
+  given: MermaidPlugin and ProcessManagerPlugin are loaded
+  when: MarkdownEvents.SetupExtensions fires
+  then: the markdown module is in the active module list
+```
+
+---
+
+## Appendix: Extension Definitions
+
+Extension block types used in this document are defined below using
+the core `ext` primitive — the only construct the base language provides.
+
+```mdl
+ext type
+  uri: org.dxos.mdl.type@1.0
+  desc: A named data structure with typed fields and optional literals.
+  fields:
+    desc?: Prose
+    fields?: FieldMap        # name[?]: TypeExpr  (# inline comment)
+    literals?: UnionList     # a | b | c
+    extends?: TypeRef[]
+```
+
+```mdl
+ext feat
+  uri: org.dxos.mdl.feat@1.0
+  desc: A named feature grouping one or more requirements.
+  fields:
+    desc?: Prose
+    req: RequirementList
+  nesting: self
+```
+
+```mdl
+ext test
+  uri: org.dxos.mdl.test@1.0
+  desc: An acceptance scenario expressed as given / when / then steps.
+  fields:
+    given?: Step | Step[]
+    when?: Step | Step[]
+    then: Step | Step[]
+    tags?: TagList
+```
+
+```mdl
+ext component
+  uri: org.dxos.mdl.component@1.0
+  desc: A UI component with props, internal state, slots, actions, and events.
+  fields:
+    desc?: Prose
+    props?: FieldMap
+    state?: FieldMap
+    slots?: FieldMap
+    actions?: ActionMap
+    emits?: EventMap
+    layout?: CodeBlock
+```
+
+```mdl
+ext op
+  uri: org.dxos.mdl.op@1.0
+  desc: |
+    A named operation with typed inputs, outputs, and declared errors.
+    Pure ops have no effects or requires. Effectful ops declare both.
+  fields:
+    desc?: Prose
+    input?: FieldMap
+    output?: TypeExpr
+    errors?: ErrorMap
+    effects?: EffectList
+    requires?: ServiceList
+    note?: Prose
+```

package/README.md

@@ -12,4 +12,4 @@ Plugin mermaid.
 
 Your ideas, issues, and code are most welcome. Please take a look at our [community code of conduct](https://github.com/dxos/dxos/blob/main/CODE_OF_CONDUCT.md), the [issue guide](https://github.com/dxos/dxos/blob/main/CONTRIBUTING.md#submitting-issues), and the [PR contribution guide](https://github.com/dxos/dxos/blob/main/CONTRIBUTING.md#submitting-prs).
 
-License: [MIT](./LICENSE) Copyright 2023 © DXOS
+License: [FSL-1.1-Apache-2.0](./LICENSE) Copyright 2023 © DXOS

package/dist/lib/neutral/MermaidPlugin.mjs

@@ -0,0 +1,29 @@
+// src/MermaidPlugin.tsx
+import { Plugin } from "@dxos/app-framework";
+import { AppPlugin } from "@dxos/app-toolkit";
+import { MarkdownEvents } from "@dxos/plugin-markdown";
+import { MarkdownExtension } from "#capabilities";
+import { meta } from "#meta";
+
+// raw-loader:/__w/dxos/dxos/packages/plugins/plugin-mermaid/PLUGIN.mdl?raw
+var PLUGIN_default = "---\nid: org.dxos.plugin.mermaid\nname: MermaidPlugin\nversion: 0.1.0\n---\n\nA CodeMirror extension plugin for DXOS Composer that renders Mermaid diagram\ndefinitions as live SVG previews inside the markdown editor.\n\n## Extensions\n\nThe following extension dialects are used in this document.\nEach extension is defined in the Appendix or resolved via its URI.\n\n| Term        | URI                           |\n|-------------|-------------------------------|\n| `type`      | `org.dxos.mdl.type@1.0`      |\n| `feat`      | `org.dxos.mdl.feat@1.0`      |\n| `test`      | `org.dxos.mdl.test@1.0`      |\n| `component` | `org.dxos.mdl.component@1.0` |\n| `op`        | `org.dxos.mdl.op@1.0`        |\n\n## Types\n\n```mdl\ntype DiagramKind\n  literals: flowchart | sequenceDiagram | classDiagram | stateDiagram | erDiagram | gantt | pie | gitGraph | mindmap | timeline\n```\n\n```mdl\ntype DiagramTheme\n  literals: default | neutral | dark | forest | base\n```\n\n```mdl\ntype RenderResult\n  fields:\n    svg: string          # rendered SVG markup\n    id: string           # unique widget id used by the Mermaid API\n```\n\n```mdl\ntype RenderError\n  fields:\n    message: string      # human-readable parse or render error text\n    source: string       # the Mermaid source that caused the error\n```\n\n## Components\n\n```mdl\ncomponent MermaidWidget\n  desc: |\n    An inline CodeMirror widget that replaces a ```mermaid fenced code block\n    with its rendered SVG diagram. The source code block is hidden while the\n    cursor is outside it; moving the cursor inside restores the raw text for\n    editing.\n  props:\n    id: string             # unique widget id (mermaid-<offset>)\n    source: string         # raw Mermaid diagram source\n    label?: string         # first token of source used as a diagram-type badge\n    darkMode: boolean      # mirrors the editor dark-theme facet\n  state:\n    svg?: string           # last successfully rendered SVG\n    error?: string         # last render error message; shown in place of diagram\n  layout: |\n    \u250C\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510\n    \u2502  [rendered SVG diagram]        \u2502\n    \u2502                       [label] \u2502\n    \u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518\n    (on error)\n    \u250C\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510\n    \u2502  error text                    \u2502\n    \u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518\n```\n\n## Operations\n\n```mdl\nop renderDiagram\n  desc: Parses a Mermaid source string and renders it to SVG via the Mermaid JS API.\n  input:\n    id: string             # unique element id required by the Mermaid render API\n    source: string         # raw Mermaid diagram definition\n    darkMode?: boolean     # sets darkMode / theme on the Mermaid config\n  output: RenderResult\n  errors:\n    ParseError: source does not conform to Mermaid syntax\n    RenderError: SVG generation failed after successful parse\n```\n\n## Features\n\n```mdl\nfeat F-1: Diagram Rendering\n\n  req F-1.1:\n    when: a fenced code block with language tag `mermaid` is present in the document\n    then: the block is replaced by a rendered SVG diagram widget\n\n  req F-1.2:\n    when: the cursor moves inside the fenced code block\n    then: raw source text is revealed for editing and the widget is hidden\n\n  req F-1.3:\n    when: the cursor moves outside the fenced code block\n    then: the widget is restored and the raw text is hidden\n\n  req F-1.4:\n    when: the editor is in read-only mode\n    then: widgets are always shown regardless of cursor position\n```\n\n```mdl\nfeat F-2: Error Handling\n\n  req F-2.1:\n    when: Mermaid fails to parse the source\n    then: an inline error message is shown in place of the diagram\n\n  req F-2.2:\n    when: a previously failing source is corrected\n    then: the widget re-renders and displays the valid diagram\n```\n\n```mdl\nfeat F-3: Theme Integration\n\n  req F-3.1:\n    when: the editor's dark-theme facet is true\n    then: the Mermaid diagram is initialized with darkMode enabled\n\n  req F-3.2: The rendered widget uses the editor's group-surface background token.\n```\n\n```mdl\nfeat F-4: Markdown Editor Integration\n\n  req F-4.1:\n    when: the MermaidPlugin is loaded\n    then: it registers the mermaid CodeMirror extension via MarkdownCapabilities.ExtensionProvider\n\n  req F-4.2: The plugin activates on MarkdownEvents.SetupExtensions.\n```\n\n## Acceptance\n\n```mdl\ntest T-1: Valid flowchart renders\n  given: a document containing a ```mermaid fenced block with a valid flowchart definition\n  then:\n    - the raw code block lines are hidden\n    - an SVG widget is injected immediately after the block\n    - no error text is visible\n```\n\n```mdl\ntest T-2: Cursor-in/out toggle\n  given: a rendered Mermaid widget is visible\n  when: the cursor moves inside the fenced code block\n  then:\n    - the cm-mermaid-hidden class is removed from the block lines\n    - the widget is no longer rendered in the viewport\n\n  when: the cursor moves back outside the block\n  then:\n    - block lines are hidden again\n    - widget is rendered again\n```\n\n```mdl\ntest T-3: Invalid syntax shows error\n  given: a document containing a ```mermaid block with invalid syntax\n  then:\n    - no SVG is rendered\n    - an inline error message is shown with class cm-mermaid-error\n```\n\n```mdl\ntest T-4: Read-only always shows widget\n  given: the editor is in read-only mode\n  when: any cursor position\n  then: widgets are rendered and raw source lines remain hidden\n```\n\n```mdl\ntest T-5: Plugin activates on markdown event\n  given: MermaidPlugin and ProcessManagerPlugin are loaded\n  when: MarkdownEvents.SetupExtensions fires\n  then: the markdown module is in the active module list\n```\n\n---\n\n## Appendix: Extension Definitions\n\nExtension block types used in this document are defined below using\nthe core `ext` primitive \u2014 the only construct the base language provides.\n\n```mdl\next type\n  uri: org.dxos.mdl.type@1.0\n  desc: A named data structure with typed fields and optional literals.\n  fields:\n    desc?: Prose\n    fields?: FieldMap        # name[?]: TypeExpr  (# inline comment)\n    literals?: UnionList     # a | b | c\n    extends?: TypeRef[]\n```\n\n```mdl\next feat\n  uri: org.dxos.mdl.feat@1.0\n  desc: A named feature grouping one or more requirements.\n  fields:\n    desc?: Prose\n    req: RequirementList\n  nesting: self\n```\n\n```mdl\next test\n  uri: org.dxos.mdl.test@1.0\n  desc: An acceptance scenario expressed as given / when / then steps.\n  fields:\n    given?: Step | Step[]\n    when?: Step | Step[]\n    then: Step | Step[]\n    tags?: TagList\n```\n\n```mdl\next component\n  uri: org.dxos.mdl.component@1.0\n  desc: A UI component with props, internal state, slots, actions, and events.\n  fields:\n    desc?: Prose\n    props?: FieldMap\n    state?: FieldMap\n    slots?: FieldMap\n    actions?: ActionMap\n    emits?: EventMap\n    layout?: CodeBlock\n```\n\n```mdl\next op\n  uri: org.dxos.mdl.op@1.0\n  desc: |\n    A named operation with typed inputs, outputs, and declared errors.\n    Pure ops have no effects or requires. Effectful ops declare both.\n  fields:\n    desc?: Prose\n    input?: FieldMap\n    output?: TypeExpr\n    errors?: ErrorMap\n    effects?: EffectList\n    requires?: ServiceList\n    note?: Prose\n```\n";
+
+// src/MermaidPlugin.tsx
+var MermaidPlugin = Plugin.define(meta).pipe(Plugin.addModule({
+  id: "markdown",
+  activatesOn: MarkdownEvents.SetupExtensions,
+  activate: MarkdownExtension
+}), AppPlugin.addPluginAssetModule({
+  asset: {
+    pluginId: meta.id,
+    path: "PLUGIN.mdl",
+    content: PLUGIN_default,
+    mimeType: "application/x-mdl"
+  }
+}), Plugin.make);
+var MermaidPlugin_default = MermaidPlugin;
+export {
+  MermaidPlugin,
+  MermaidPlugin_default as default
+};
+//# sourceMappingURL=MermaidPlugin.mjs.map

package/dist/lib/neutral/MermaidPlugin.mjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/MermaidPlugin.tsx", "raw-loader:/__w/dxos/dxos/packages/plugins/plugin-mermaid/PLUGIN.mdl?raw"],
+  "sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport { Plugin } from '@dxos/app-framework';\nimport { AppPlugin } from '@dxos/app-toolkit';\nimport { MarkdownEvents } from '@dxos/plugin-markdown';\n\nimport { MarkdownExtension } from '#capabilities';\nimport { meta } from '#meta';\n\n// eslint-disable-next-line import/no-relative-packages\nimport pluginSpec from '../PLUGIN.mdl?raw';\n\nexport const MermaidPlugin = Plugin.define(meta).pipe(\n  Plugin.addModule({\n    id: 'markdown',\n    activatesOn: MarkdownEvents.SetupExtensions,\n    activate: MarkdownExtension,\n  }),\n  AppPlugin.addPluginAssetModule({\n    asset: { pluginId: meta.id, path: 'PLUGIN.mdl', content: pluginSpec, mimeType: 'application/x-mdl' },\n  }),\n  Plugin.make,\n);\n\nexport default MermaidPlugin;\n", "---\nid: org.dxos.plugin.mermaid\nname: MermaidPlugin\nversion: 0.1.0\n---\n\nA CodeMirror extension plugin for DXOS Composer that renders Mermaid diagram\ndefinitions as live SVG previews inside the markdown editor.\n\n## Extensions\n\nThe following extension dialects are used in this document.\nEach extension is defined in the Appendix or resolved via its URI.\n\n| Term        | URI                           |\n|-------------|-------------------------------|\n| `type`      | `org.dxos.mdl.type@1.0`      |\n| `feat`      | `org.dxos.mdl.feat@1.0`      |\n| `test`      | `org.dxos.mdl.test@1.0`      |\n| `component` | `org.dxos.mdl.component@1.0` |\n| `op`        | `org.dxos.mdl.op@1.0`        |\n\n## Types\n\n```mdl\ntype DiagramKind\n  literals: flowchart | sequenceDiagram | classDiagram | stateDiagram | erDiagram | gantt | pie | gitGraph | mindmap | timeline\n```\n\n```mdl\ntype DiagramTheme\n  literals: default | neutral | dark | forest | base\n```\n\n```mdl\ntype RenderResult\n  fields:\n    svg: string          # rendered SVG markup\n    id: string           # unique widget id used by the Mermaid API\n```\n\n```mdl\ntype RenderError\n  fields:\n    message: string      # human-readable parse or render error text\n    source: string       # the Mermaid source that caused the error\n```\n\n## Components\n\n```mdl\ncomponent MermaidWidget\n  desc: |\n    An inline CodeMirror widget that replaces a ```mermaid fenced code block\n    with its rendered SVG diagram. The source code block is hidden while the\n    cursor is outside it; moving the cursor inside restores the raw text for\n    editing.\n  props:\n    id: string             # unique widget id (mermaid-<offset>)\n    source: string         # raw Mermaid diagram source\n    label?: string         # first token of source used as a diagram-type badge\n    darkMode: boolean      # mirrors the editor dark-theme facet\n  state:\n    svg?: string           # last successfully rendered SVG\n    error?: string         # last render error message; shown in place of diagram\n  layout: |\n    \u250C\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510\n    \u2502  [rendered SVG diagram]        \u2502\n    \u2502                       [label] \u2502\n    \u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518\n    (on error)\n    \u250C\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510\n    \u2502  error text                    \u2502\n    \u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518\n```\n\n## Operations\n\n```mdl\nop renderDiagram\n  desc: Parses a Mermaid source string and renders it to SVG via the Mermaid JS API.\n  input:\n    id: string             # unique element id required by the Mermaid render API\n    source: string         # raw Mermaid diagram definition\n    darkMode?: boolean     # sets darkMode / theme on the Mermaid config\n  output: RenderResult\n  errors:\n    ParseError: source does not conform to Mermaid syntax\n    RenderError: SVG generation failed after successful parse\n```\n\n## Features\n\n```mdl\nfeat F-1: Diagram Rendering\n\n  req F-1.1:\n    when: a fenced code block with language tag `mermaid` is present in the document\n    then: the block is replaced by a rendered SVG diagram widget\n\n  req F-1.2:\n    when: the cursor moves inside the fenced code block\n    then: raw source text is revealed for editing and the widget is hidden\n\n  req F-1.3:\n    when: the cursor moves outside the fenced code block\n    then: the widget is restored and the raw text is hidden\n\n  req F-1.4:\n    when: the editor is in read-only mode\n    then: widgets are always shown regardless of cursor position\n```\n\n```mdl\nfeat F-2: Error Handling\n\n  req F-2.1:\n    when: Mermaid fails to parse the source\n    then: an inline error message is shown in place of the diagram\n\n  req F-2.2:\n    when: a previously failing source is corrected\n    then: the widget re-renders and displays the valid diagram\n```\n\n```mdl\nfeat F-3: Theme Integration\n\n  req F-3.1:\n    when: the editor's dark-theme facet is true\n    then: the Mermaid diagram is initialized with darkMode enabled\n\n  req F-3.2: The rendered widget uses the editor's group-surface background token.\n```\n\n```mdl\nfeat F-4: Markdown Editor Integration\n\n  req F-4.1:\n    when: the MermaidPlugin is loaded\n    then: it registers the mermaid CodeMirror extension via MarkdownCapabilities.ExtensionProvider\n\n  req F-4.2: The plugin activates on MarkdownEvents.SetupExtensions.\n```\n\n## Acceptance\n\n```mdl\ntest T-1: Valid flowchart renders\n  given: a document containing a ```mermaid fenced block with a valid flowchart definition\n  then:\n    - the raw code block lines are hidden\n    - an SVG widget is injected immediately after the block\n    - no error text is visible\n```\n\n```mdl\ntest T-2: Cursor-in/out toggle\n  given: a rendered Mermaid widget is visible\n  when: the cursor moves inside the fenced code block\n  then:\n    - the cm-mermaid-hidden class is removed from the block lines\n    - the widget is no longer rendered in the viewport\n\n  when: the cursor moves back outside the block\n  then:\n    - block lines are hidden again\n    - widget is rendered again\n```\n\n```mdl\ntest T-3: Invalid syntax shows error\n  given: a document containing a ```mermaid block with invalid syntax\n  then:\n    - no SVG is rendered\n    - an inline error message is shown with class cm-mermaid-error\n```\n\n```mdl\ntest T-4: Read-only always shows widget\n  given: the editor is in read-only mode\n  when: any cursor position\n  then: widgets are rendered and raw source lines remain hidden\n```\n\n```mdl\ntest T-5: Plugin activates on markdown event\n  given: MermaidPlugin and ProcessManagerPlugin are loaded\n  when: MarkdownEvents.SetupExtensions fires\n  then: the markdown module is in the active module list\n```\n\n---\n\n## Appendix: Extension Definitions\n\nExtension block types used in this document are defined below using\nthe core `ext` primitive \u2014 the only construct the base language provides.\n\n```mdl\next type\n  uri: org.dxos.mdl.type@1.0\n  desc: A named data structure with typed fields and optional literals.\n  fields:\n    desc?: Prose\n    fields?: FieldMap        # name[?]: TypeExpr  (# inline comment)\n    literals?: UnionList     # a | b | c\n    extends?: TypeRef[]\n```\n\n```mdl\next feat\n  uri: org.dxos.mdl.feat@1.0\n  desc: A named feature grouping one or more requirements.\n  fields:\n    desc?: Prose\n    req: RequirementList\n  nesting: self\n```\n\n```mdl\next test\n  uri: org.dxos.mdl.test@1.0\n  desc: An acceptance scenario expressed as given / when / then steps.\n  fields:\n    given?: Step | Step[]\n    when?: Step | Step[]\n    then: Step | Step[]\n    tags?: TagList\n```\n\n```mdl\next component\n  uri: org.dxos.mdl.component@1.0\n  desc: A UI component with props, internal state, slots, actions, and events.\n  fields:\n    desc?: Prose\n    props?: FieldMap\n    state?: FieldMap\n    slots?: FieldMap\n    actions?: ActionMap\n    emits?: EventMap\n    layout?: CodeBlock\n```\n\n```mdl\next op\n  uri: org.dxos.mdl.op@1.0\n  desc: |\n    A named operation with typed inputs, outputs, and declared errors.\n    Pure ops have no effects or requires. Effectful ops declare both.\n  fields:\n    desc?: Prose\n    input?: FieldMap\n    output?: TypeExpr\n    errors?: ErrorMap\n    effects?: EffectList\n    requires?: ServiceList\n    note?: Prose\n```\n"],
+  "mappings": ";AAIA,SAASA,cAAc;AACvB,SAASC,iBAAiB;AAC1B,SAASC,sBAAsB;AAE/B,SAASC,yBAAyB;AAClC,SAASC,YAAY;;;ACTrB;;;ADcO,IAAMC,gBAAgBC,OAAOC,OAAOC,IAAAA,EAAMC,KAC/CH,OAAOI,UAAU;EACfC,IAAI;EACJC,aAAaC,eAAeC;EAC5BC,UAAUC;AACZ,CAAA,GACAC,UAAUC,qBAAqB;EAC7BC,OAAO;IAAEC,UAAUZ,KAAKG;IAAIU,MAAM;IAAcC,SAASC;IAAYC,UAAU;EAAoB;AACrG,CAAA,GACAlB,OAAOmB,IAAI;AAGb,IAAA,wBAAepB;",
+  "names": ["Plugin", "AppPlugin", "MarkdownEvents", "MarkdownExtension", "meta", "MermaidPlugin", "Plugin", "define", "meta", "pipe", "addModule", "id", "activatesOn", "MarkdownEvents", "SetupExtensions", "activate", "MarkdownExtension", "AppPlugin", "addPluginAssetModule", "asset", "pluginId", "path", "content", "pluginSpec", "mimeType", "make"]
+}

package/dist/lib/neutral/capabilities/index.mjs

@@ -0,0 +1,7 @@
+// src/capabilities/index.ts
+import { Capability } from "@dxos/app-framework";
+var MarkdownExtension = Capability.lazy("MarkdownExtension", () => import("../markdown-extension-7YWEUNWO.mjs"));
+export {
+  MarkdownExtension
+};
+//# sourceMappingURL=index.mjs.map

package/dist/lib/neutral/capabilities/index.mjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../../src/capabilities/index.ts"],
+  "sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport { Capability } from '@dxos/app-framework';\n\nexport const MarkdownExtension = Capability.lazy('MarkdownExtension', () => import('./markdown-extension'));\n"],
+  "mappings": ";AAIA,SAASA,kBAAkB;AAEpB,IAAMC,oBAAoBD,WAAWE,KAAK,qBAAqB,MAAM,OAAO,oCAAA,CAAA;",
+  "names": ["Capability", "MarkdownExtension", "lazy"]
+}

package/dist/lib/neutral/chunk-WD2YFG2L.mjs

@@ -0,0 +1,36 @@
+// src/meta.ts
+import { Plugin } from "@dxos/app-framework";
+import { DXN } from "@dxos/keys";
+import { trim } from "@dxos/util";
+var meta = Plugin.makeMeta({
+  key: DXN.make("org.dxos.plugin.mermaid"),
+  name: "Mermaid",
+  author: "DXOS",
+  description: trim`
+    Generate diagrams from simple text-based definitions using Mermaid syntax.
+    Create flowcharts, sequence diagrams, class diagrams, state diagrams, entity-relationship
+    diagrams, Gantt charts, pie charts, Git graphs, mindmaps, and timelines — all from
+    plain-text source embedded directly in your documents.
+
+    The plugin integrates with the markdown editor as a CodeMirror extension.
+    Any fenced code block tagged with the \`mermaid\` language identifier is automatically
+    detected and replaced with a live SVG preview rendered by the Mermaid JS library.
+    The raw source is revealed for editing whenever the cursor moves inside the block,
+    then the rendered diagram is restored when the cursor moves away, providing a seamless
+    live-preview experience without leaving the editor.
+
+    Diagram rendering adapts to the editor's current color scheme: dark-mode documents
+    use Mermaid's dark theme while light-mode documents use the neutral theme.
+    Parse and render errors are shown inline in place of the diagram so that
+    invalid syntax is immediately visible without disrupting the rest of the document.
+  `,
+  icon: "ph--anchor-simple--regular",
+  iconHue: "cyan",
+  source: "https://github.com/dxos/dxos/tree/main/packages/plugins/plugin-mermaid",
+  spec: "PLUGIN.mdl"
+});
+
+export {
+  meta
+};
+//# sourceMappingURL=chunk-WD2YFG2L.mjs.map

package/dist/lib/neutral/chunk-WD2YFG2L.mjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/meta.ts"],
+  "sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport { Plugin } from '@dxos/app-framework';\nimport { DXN } from '@dxos/keys';\nimport { trim } from '@dxos/util';\n\nexport const meta = Plugin.makeMeta({\n  key: DXN.make('org.dxos.plugin.mermaid'),\n  name: 'Mermaid',\n  author: 'DXOS',\n  description: trim`\n    Generate diagrams from simple text-based definitions using Mermaid syntax.\n    Create flowcharts, sequence diagrams, class diagrams, state diagrams, entity-relationship\n    diagrams, Gantt charts, pie charts, Git graphs, mindmaps, and timelines — all from\n    plain-text source embedded directly in your documents.\n\n    The plugin integrates with the markdown editor as a CodeMirror extension.\n    Any fenced code block tagged with the \\`mermaid\\` language identifier is automatically\n    detected and replaced with a live SVG preview rendered by the Mermaid JS library.\n    The raw source is revealed for editing whenever the cursor moves inside the block,\n    then the rendered diagram is restored when the cursor moves away, providing a seamless\n    live-preview experience without leaving the editor.\n\n    Diagram rendering adapts to the editor's current color scheme: dark-mode documents\n    use Mermaid's dark theme while light-mode documents use the neutral theme.\n    Parse and render errors are shown inline in place of the diagram so that\n    invalid syntax is immediately visible without disrupting the rest of the document.\n  `,\n  icon: 'ph--anchor-simple--regular',\n  iconHue: 'cyan',\n  source: 'https://github.com/dxos/dxos/tree/main/packages/plugins/plugin-mermaid',\n  spec: 'PLUGIN.mdl',\n});\n"],
+  "mappings": ";AAIA,SAASA,cAAc;AACvB,SAASC,WAAW;AACpB,SAASC,YAAY;AAEd,IAAMC,OAAOH,OAAOI,SAAS;EAClCC,KAAKJ,IAAIK,KAAK,yBAAA;EACdC,MAAM;EACNC,QAAQ;EACRC,aAAaP;;;;;;;;;;;;;;;;;;EAkBbQ,MAAM;EACNC,SAAS;EACTC,QAAQ;EACRC,MAAM;AACR,CAAA;",
+  "names": ["Plugin", "DXN", "trim", "meta", "makeMeta", "key", "make", "name", "author", "description", "icon", "iconHue", "source", "spec"]
+}

package/dist/lib/neutral/index.mjs

@@ -0,0 +1,7 @@
+import {
+  meta
+} from "./chunk-WD2YFG2L.mjs";
+export {
+  meta
+};
+//# sourceMappingURL=index.mjs.map

package/dist/lib/neutral/index.mjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": [],
+  "sourcesContent": [],
+  "mappings": "",
+  "names": []
+}