mrmd-js 2.0.1 → 2.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Maxime Rivest
+
+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:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+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.

package/dist/index.cjs

@@ -6387,6 +6387,143 @@ function createCssExecutor() {
   return new CssExecutor();
 }
 
+/**
+ * Mermaid Executor
+ *
+ * Executes Mermaid diagram cells by rendering them to SVG.
+ * Loads mermaid from CDN on first use and returns HTML displayData.
+ *
+ * @module execute/mermaid
+ */
+
+
+/**
+ * @typedef {import('../session/context/interface.js').ExecutionContext} ExecutionContext
+ * @typedef {import('../types/execution.js').ExecuteOptions} ExecuteOptions
+ * @typedef {import('../types/execution.js').ExecutionResult} ExecutionResult
+ * @typedef {import('../types/execution.js').DisplayData} DisplayData
+ */
+
+/** CDN URL for mermaid */
+const MERMAID_CDN = 'https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.min.js';
+
+/** Counter for unique diagram IDs */
+let diagramCounter = 0;
+
+/**
+ * Load mermaid from CDN if not already loaded
+ * @returns {Promise<void>}
+ */
+async function ensureMermaidLoaded() {
+  // Check if already loaded
+  if (typeof window !== 'undefined' && window.mermaid) {
+    return;
+  }
+
+  // Load from CDN
+  return new Promise((resolve, reject) => {
+    const script = document.createElement('script');
+    script.src = MERMAID_CDN;
+    script.onload = () => {
+      // Initialize mermaid with safe defaults
+      window.mermaid.initialize({
+        startOnLoad: false,
+        theme: 'default',
+        securityLevel: 'loose', // Allow clicks/links in diagrams
+        fontFamily: '-apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, sans-serif',
+      });
+      resolve();
+    };
+    script.onerror = () => reject(new Error('Failed to load mermaid from CDN'));
+    document.head.appendChild(script);
+  });
+}
+
+/**
+ * Mermaid executor - renders Mermaid diagrams to SVG
+ */
+class MermaidExecutor extends BaseExecutor {
+  /** @type {readonly string[]} */
+  languages = ['mermaid'];
+
+  /**
+   * Execute Mermaid diagram cell
+   * @param {string} code - Mermaid diagram definition
+   * @param {ExecutionContext} context - Execution context
+   * @param {ExecuteOptions} [options] - Execution options
+   * @returns {Promise<ExecutionResult>}
+   */
+  async execute(code, context, options = {}) {
+    const startTime = performance.now();
+
+    try {
+      // Ensure mermaid is loaded
+      await ensureMermaidLoaded();
+
+      // Generate unique ID for this diagram
+      const diagramId = `mermaid-diagram-${++diagramCounter}`;
+
+      // Render the diagram
+      const { svg } = await window.mermaid.render(diagramId, code.trim());
+
+      const duration = performance.now() - startTime;
+
+      // Build display data with the rendered SVG
+      /** @type {DisplayData[]} */
+      const displayData = [
+        {
+          data: {
+            'text/html': svg,
+            'text/plain': `[Mermaid diagram rendered]`,
+          },
+          metadata: {
+            mermaid: true,
+            diagramId,
+          },
+        },
+      ];
+
+      return {
+        success: true,
+        stdout: '',
+        stderr: '',
+        result: undefined,
+        displayData,
+        assets: [],
+        executionCount: 0,
+        duration,
+      };
+    } catch (error) {
+      const duration = performance.now() - startTime;
+      const errorMessage = error instanceof Error ? error.message : String(error);
+
+      // Return error as stderr with helpful message
+      return {
+        success: false,
+        stdout: '',
+        stderr: `Mermaid rendering error: ${errorMessage}`,
+        result: undefined,
+        error: {
+          type: 'MermaidError',
+          message: errorMessage,
+        },
+        displayData: [],
+        assets: [],
+        executionCount: 0,
+        duration,
+      };
+    }
+  }
+}
+
+/**
+ * Create a Mermaid executor
+ * @returns {MermaidExecutor}
+ */
+function createMermaidExecutor() {
+  return new MermaidExecutor();
+}
+
 /**
  * Execute Module
  *
@@ -6405,6 +6542,7 @@ function createDefaultExecutorRegistry() {
   registry.register(new JavaScriptExecutor());
   registry.register(new HtmlExecutor());
   registry.register(new CssExecutor());
+  registry.register(new MermaidExecutor());
   return registry;
 }
 
@@ -7731,6 +7869,7 @@ exports.HtmlRenderer = HtmlRenderer;
 exports.IframeContext = IframeContext;
 exports.JavaScriptExecutor = JavaScriptExecutor;
 exports.MainContext = MainContext;
+exports.MermaidExecutor = MermaidExecutor;
 exports.MrpRuntime = MrpRuntime;
 exports.RUNTIME_NAME = RUNTIME_NAME;
 exports.RUNTIME_VERSION = RUNTIME_VERSION;
@@ -7750,6 +7889,7 @@ exports.createHtmlRenderer = createHtmlRenderer;
 exports.createIframeContext = createIframeContext;
 exports.createJavaScriptExecutor = createJavaScriptExecutor;
 exports.createMainContext = createMainContext;
+exports.createMermaidExecutor = createMermaidExecutor;
 exports.createRuntime = createRuntime;
 exports.createSession = createSession;
 exports.createSessionManager = createSessionManager;