@jupyterlab/mermaid 4.1.0-alpha.1

package/README.md

@@ -0,0 +1,3 @@
+# @jupyterlab/mermaid
+
+A JupyterLab provider rendering Mermaid text-based diagrams.

package/lib/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @packageDocumentation
+ * @module mermaid
+ */
+export * from './manager';
+export * from './markdown';
+export * from './mime';
+export * from './tokens';

package/lib/index.js

@@ -0,0 +1,11 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+/**
+ * @packageDocumentation
+ * @module mermaid
+ */
+export * from './manager';
+export * from './markdown';
+export * from './mime';
+export * from './tokens';
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,2DAA2D;AAC3D;;;GAGG;AAEH,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC"}

package/lib/manager.d.ts

@@ -0,0 +1,65 @@
+import type MermaidType from 'mermaid';
+import { LruCache } from '@jupyterlab/coreutils';
+import { IThemeManager } from '@jupyterlab/apputils';
+import { IMermaidManager } from './tokens';
+/**
+ * A mermaid diagram manager with cache.
+ */
+export declare class MermaidManager implements IMermaidManager {
+    protected _diagrams: LruCache<string, HTMLElement>;
+    protected _themes: IThemeManager | null;
+    constructor(options?: MermaidManager.IOptions);
+    /**
+     * Handle (re)-initializing mermaid based on external values.
+     */
+    initialize(): void;
+    /**
+     * Get the underlying, potentially un-initialized mermaid module.
+     */
+    getMermaid(): Promise<typeof MermaidType>;
+    /**
+     * Get the version of the currently-loaded mermaid module
+     */
+    getMermaidVersion(): string | null;
+    /**
+     * Get a pre-cached mermaid figure.
+     *
+     * This primarily exists for the needs of `marked`, which supports async node
+     * visitors, but not async rendering.
+     */
+    getCachedFigure(text: string): HTMLElement | null;
+    /**
+     * Attempt a raw rendering of mermaid to an SVG string, extracting some metadata.
+     */
+    renderSvg(text: string): Promise<IMermaidManager.IRenderInfo>;
+    /**
+     * Provide and cache a fully-rendered element, checking the cache first.
+     */
+    renderFigure(text: string): Promise<HTMLElement>;
+    /**
+     * Provide a code block with the mermaid source.
+     */
+    makeMermaidCode(text: string): HTMLElement;
+    /**
+     * Get the parser message element from a failed parse.
+     *
+     * This doesn't do much of anything if the text is successfully parsed.
+     */
+    makeMermaidError(text: string): Promise<HTMLElement>;
+    /**
+     * Extract extra attributes to add to a generated figure.
+     */
+    makeMermaidFigure(info: IMermaidManager.IRenderInfo): HTMLElement;
+}
+/**
+ * A namespace for implementation-specific details of this mermaid manager.
+ */
+export declare namespace MermaidManager {
+    /**
+     * Initialization options for the mermaid manager.
+     */
+    interface IOptions {
+        maxCacheSize?: number | null;
+        themes?: IThemeManager | null;
+    }
+}

package/lib/manager.js

@@ -0,0 +1,258 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+import { PromiseDelegate } from '@lumino/coreutils';
+import { LruCache } from '@jupyterlab/coreutils';
+import { DETAILS_CLASS, MERMAID_CLASS, MERMAID_CODE_CLASS, MERMAID_DARK_THEME, MERMAID_DEFAULT_THEME, SUMMARY_CLASS, WARNING_CLASS } from './tokens';
+/**
+ * A mermaid diagram manager with cache.
+ */
+export class MermaidManager {
+    constructor(options = {}) {
+        this._diagrams = new LruCache({ maxSize: options.maxCacheSize || null });
+        // handle reacting to themes
+        if (options.themes) {
+            Private.initThemes(options.themes || null);
+            options.themes.themeChanged.connect(this.initialize, this);
+        }
+    }
+    /**
+     * Handle (re)-initializing mermaid based on external values.
+     */
+    initialize() {
+        this._diagrams.clear();
+        Private.initMermaid();
+    }
+    /**
+     * Get the underlying, potentially un-initialized mermaid module.
+     */
+    async getMermaid() {
+        return await Private.ensureMermaid();
+    }
+    /**
+     * Get the version of the currently-loaded mermaid module
+     */
+    getMermaidVersion() {
+        return Private.version();
+    }
+    /**
+     * Get a pre-cached mermaid figure.
+     *
+     * This primarily exists for the needs of `marked`, which supports async node
+     * visitors, but not async rendering.
+     */
+    getCachedFigure(text) {
+        return this._diagrams.get(text);
+    }
+    /**
+     * Attempt a raw rendering of mermaid to an SVG string, extracting some metadata.
+     */
+    async renderSvg(text) {
+        const _mermaid = await this.getMermaid();
+        const id = `jp-mermaid-${Private.nextMermaidId()}`;
+        // create temporary element into which to render
+        const el = document.createElement('div');
+        document.body.appendChild(el);
+        try {
+            const { svg } = await _mermaid.render(id, text, el);
+            const parser = new DOMParser();
+            const doc = parser.parseFromString(svg, 'image/svg+xml');
+            const info = { text, svg };
+            const svgEl = doc.querySelector('svg');
+            const { maxWidth } = (svgEl === null || svgEl === void 0 ? void 0 : svgEl.style) || {};
+            info.width = maxWidth ? parseFloat(maxWidth) : null;
+            const firstTitle = doc.querySelector('title');
+            const firstDesc = doc.querySelector('desc');
+            if (firstTitle) {
+                info.accessibleTitle = firstTitle.textContent;
+            }
+            if (firstDesc) {
+                info.accessibleDescription = firstDesc.textContent;
+            }
+            return info;
+        }
+        finally {
+            el.remove();
+        }
+    }
+    /**
+     * Provide and cache a fully-rendered element, checking the cache first.
+     */
+    async renderFigure(text) {
+        // bail if already cached
+        let output = this._diagrams.get(text);
+        if (output != null) {
+            return output;
+        }
+        let className = MERMAID_CLASS;
+        let result = null;
+        // the element that will be returned
+        output = document.createElement('div');
+        output.className = className;
+        try {
+            const response = await this.renderSvg(text);
+            result = this.makeMermaidFigure(response);
+        }
+        catch (err) {
+            output.classList.add(WARNING_CLASS);
+            result = await this.makeMermaidError(text);
+        }
+        let version = this.getMermaidVersion();
+        if (version) {
+            result.dataset.jpMermaidVersion = version;
+        }
+        output.appendChild(result);
+        // update the cache for use when rendering synchronously
+        this._diagrams.set(text, output);
+        return output;
+    }
+    /**
+     * Provide a code block with the mermaid source.
+     */
+    makeMermaidCode(text) {
+        // append the source
+        const pre = document.createElement('pre');
+        const code = document.createElement('code');
+        code.innerText = text;
+        pre.appendChild(code);
+        code.className = MERMAID_CODE_CLASS;
+        code.textContent = text;
+        return pre;
+    }
+    /**
+     * Get the parser message element from a failed parse.
+     *
+     * This doesn't do much of anything if the text is successfully parsed.
+     */
+    async makeMermaidError(text) {
+        const _mermaid = await this.getMermaid();
+        let errorMessage = '';
+        try {
+            await _mermaid.parse(text);
+        }
+        catch (err) {
+            errorMessage = `${err}`;
+        }
+        const result = document.createElement('details');
+        result.className = DETAILS_CLASS;
+        const summary = document.createElement('summary');
+        summary.className = SUMMARY_CLASS;
+        summary.appendChild(this.makeMermaidCode(text));
+        result.appendChild(summary);
+        const warning = document.createElement('pre');
+        warning.innerText = errorMessage;
+        result.appendChild(warning);
+        return result;
+    }
+    /**
+     * Extract extra attributes to add to a generated figure.
+     */
+    makeMermaidFigure(info) {
+        const figure = document.createElement('figure');
+        const img = document.createElement('img');
+        figure.appendChild(img);
+        img.setAttribute('src', `data:image/svg+xml,${encodeURIComponent(info.svg)}`);
+        // add dimension information
+        if (info.width) {
+            img.width = info.width;
+        }
+        // add accessible alt title
+        if (info.accessibleTitle) {
+            img.setAttribute('alt', info.accessibleTitle);
+        }
+        figure.appendChild(this.makeMermaidCode(info.text));
+        // add accessible caption, with fallback to raw mermaid source
+        if (info.accessibleDescription) {
+            const caption = document.createElement('figcaption');
+            caption.className = 'sr-only';
+            caption.textContent = info.accessibleDescription;
+            figure.appendChild(caption);
+        }
+        return figure;
+    }
+}
+/**
+ * A namespace for global, private mermaid data.
+ */
+var Private;
+(function (Private) {
+    let _themes = null;
+    let _mermaid = null;
+    let _loading = null;
+    let _nextMermaidId = 0;
+    let _version = null;
+    /**
+     * Cache a reference to the theme manager.
+     */
+    function initThemes(themes) {
+        _themes = themes;
+    }
+    Private.initThemes = initThemes;
+    /**
+     * Get the version of mermaid used for rendering.
+     */
+    function version() {
+        return _version;
+    }
+    Private.version = version;
+    /**
+     * (Re-)initialize mermaid with lab-specific theme information
+     */
+    function initMermaid() {
+        if (!_mermaid) {
+            return false;
+        }
+        let theme = MERMAID_DEFAULT_THEME;
+        if (_themes) {
+            const jpTheme = _themes.theme;
+            theme =
+                jpTheme && _themes.isLight(jpTheme)
+                    ? MERMAID_DEFAULT_THEME
+                    : MERMAID_DARK_THEME;
+        }
+        const fontFamily = window
+            .getComputedStyle(document.body)
+            .getPropertyValue('--jp-ui-font-family');
+        _mermaid.mermaidAPI.globalReset();
+        _mermaid.mermaidAPI.initialize({
+            theme,
+            fontFamily,
+            maxTextSize: 100000,
+            startOnLoad: false
+        });
+        return true;
+    }
+    Private.initMermaid = initMermaid;
+    /**
+     * Determine whether mermaid has been loaded yet.
+     */
+    function getMermaid() {
+        return _mermaid;
+    }
+    Private.getMermaid = getMermaid;
+    /**
+     * Provide a globally-unique, but unstable, ID for disambiguation.
+     */
+    function nextMermaidId() {
+        return _nextMermaidId++;
+    }
+    Private.nextMermaidId = nextMermaidId;
+    /**
+     * Ensure mermaid has been lazily loaded once, initialized, and cached.
+     */
+    async function ensureMermaid() {
+        if (_mermaid != null) {
+            return _mermaid;
+        }
+        if (_loading) {
+            return _loading.promise;
+        }
+        _loading = new PromiseDelegate();
+        _version = (await import('mermaid/package.json')).version;
+        _mermaid = (await import('mermaid')).default;
+        initMermaid();
+        _loading.resolve(_mermaid);
+        return _mermaid;
+    }
+    Private.ensureMermaid = ensureMermaid;
+})(Private || (Private = {}));
+//# sourceMappingURL=manager.js.map

package/lib/manager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"manager.js","sourceRoot":"","sources":["../src/manager.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,2DAA2D;AAI3D,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAIjD,OAAO,EACL,aAAa,EAEb,aAAa,EACb,kBAAkB,EAClB,kBAAkB,EAClB,qBAAqB,EACrB,aAAa,EACb,aAAa,EACd,MAAM,UAAU,CAAC;AAElB;;GAEG;AACH,MAAM,OAAO,cAAc;IAIzB,YAAY,UAAmC,EAAE;QAC/C,IAAI,CAAC,SAAS,GAAG,IAAI,QAAQ,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,YAAY,IAAI,IAAI,EAAE,CAAC,CAAC;QAEzE,4BAA4B;QAC5B,IAAI,OAAO,CAAC,MAAM,EAAE;YAClB,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,IAAI,IAAI,CAAC,CAAC;YAC3C,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;SAC5D;IACH,CAAC;IAED;;OAEG;IACH,UAAU;QACR,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;QACvB,OAAO,CAAC,WAAW,EAAE,CAAC;IACxB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,UAAU;QACd,OAAO,MAAM,OAAO,CAAC,aAAa,EAAE,CAAC;IACvC,CAAC;IAED;;OAEG;IACH,iBAAiB;QACf,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;IAED;;;;;OAKG;IACH,eAAe,CAAC,IAAY;QAC1B,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,IAAY;QAC1B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;QAEzC,MAAM,EAAE,GAAG,cAAc,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC;QAEnD,gDAAgD;QAChD,MAAM,EAAE,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QACzC,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QAC9B,IAAI;YACF,MAAM,EAAE,GAAG,EAAE,GAAG,MAAM,QAAQ,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;YACpD,MAAM,MAAM,GAAG,IAAI,SAAS,EAAE,CAAC;YAC/B,MAAM,GAAG,GAAG,MAAM,CAAC,eAAe,CAAC,GAAG,EAAE,eAAe,CAAC,CAAC;YAEzD,MAAM,IAAI,GAAgC,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC;YACxD,MAAM,KAAK,GAAG,GAAG,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;YACvC,MAAM,EAAE,QAAQ,EAAE,GAAG,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,KAAK,KAAI,EAAE,CAAC;YACxC,IAAI,CAAC,KAAK,GAAG,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;YACpD,MAAM,UAAU,GAAG,GAAG,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;YAC9C,MAAM,SAAS,GAAG,GAAG,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;YAC5C,IAAI,UAAU,EAAE;gBACd,IAAI,CAAC,eAAe,GAAG,UAAU,CAAC,WAAW,CAAC;aAC/C;YACD,IAAI,SAAS,EAAE;gBACb,IAAI,CAAC,qBAAqB,GAAG,SAAS,CAAC,WAAW,CAAC;aACpD;YACD,OAAO,IAAI,CAAC;SACb;gBAAS;YACR,EAAE,CAAC,MAAM,EAAE,CAAC;SACb;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,YAAY,CAAC,IAAY;QAC7B,yBAAyB;QACzB,IAAI,MAAM,GAAuB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAE1D,IAAI,MAAM,IAAI,IAAI,EAAE;YAClB,OAAO,MAAM,CAAC;SACf;QAED,IAAI,SAAS,GAAG,aAAa,CAAC;QAE9B,IAAI,MAAM,GAAuB,IAAI,CAAC;QAEtC,oCAAoC;QACpC,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QACvC,MAAM,CAAC,SAAS,GAAG,SAAS,CAAC;QAE7B,IAAI;YACF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YAC5C,MAAM,GAAG,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;SAC3C;QAAC,OAAO,GAAG,EAAE;YACZ,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;YACpC,MAAM,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;SAC5C;QAED,IAAI,OAAO,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAEvC,IAAI,OAAO,EAAE;YACX,MAAM,CAAC,OAAO,CAAC,gBAAgB,GAAG,OAAO,CAAC;SAC3C;QAED,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QAE3B,wDAAwD;QACxD,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAEjC,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,eAAe,CAAC,IAAY;QAC1B,oBAAoB;QACpB,MAAM,GAAG,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAC1C,MAAM,IAAI,GAAG,QAAQ,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QAC5C,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QACtB,IAAI,CAAC,SAAS,GAAG,kBAAkB,CAAC;QACpC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QACxB,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,gBAAgB,CAAC,IAAY;QACjC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;QACzC,IAAI,YAAY,GAAG,EAAE,CAAC;QACtB,IAAI;YACF,MAAM,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;SAC5B;QAAC,OAAO,GAAG,EAAE;YACZ,YAAY,GAAG,GAAG,GAAG,EAAE,CAAC;SACzB;QAED,MAAM,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;QACjD,MAAM,CAAC,SAAS,GAAG,aAAa,CAAC;QACjC,MAAM,OAAO,GAAG,QAAQ,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;QAClD,OAAO,CAAC,SAAS,GAAG,aAAa,CAAC;QAClC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC;QAChD,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QAE5B,MAAM,OAAO,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAC9C,OAAO,CAAC,SAAS,GAAG,YAAY,CAAC;QACjC,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QAC5B,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,iBAAiB,CAAC,IAAiC;QACjD,MAAM,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QAChD,MAAM,GAAG,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAE1C,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QACxB,GAAG,CAAC,YAAY,CACd,KAAK,EACL,sBAAsB,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CACrD,CAAC;QAEF,4BAA4B;QAC5B,IAAI,IAAI,CAAC,KAAK,EAAE;YACd,GAAG,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;SACxB;QAED,2BAA2B;QAC3B,IAAI,IAAI,CAAC,eAAe,EAAE;YACxB,GAAG,CAAC,YAAY,CAAC,KAAK,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;SAC/C;QAED,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAEpD,8DAA8D;QAC9D,IAAI,IAAI,CAAC,qBAAqB,EAAE;YAC9B,MAAM,OAAO,GAAG,QAAQ,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;YACrD,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC;YAC9B,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC,qBAAqB,CAAC;YACjD,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;SAC7B;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AAeD;;GAEG;AACH,IAAU,OAAO,CAoFhB;AApFD,WAAU,OAAO;IACf,IAAI,OAAO,GAAyB,IAAI,CAAC;IACzC,IAAI,QAAQ,GAA8B,IAAI,CAAC;IAC/C,IAAI,QAAQ,GAA+C,IAAI,CAAC;IAChE,IAAI,cAAc,GAAG,CAAC,CAAC;IACvB,IAAI,QAAQ,GAAkB,IAAI,CAAC;IAEnC;;OAEG;IACH,SAAgB,UAAU,CAAC,MAA4B;QACrD,OAAO,GAAG,MAAM,CAAC;IACnB,CAAC;IAFe,kBAAU,aAEzB,CAAA;IAED;;OAEG;IACH,SAAgB,OAAO;QACrB,OAAO,QAAQ,CAAC;IAClB,CAAC;IAFe,eAAO,UAEtB,CAAA;IAED;;OAEG;IACH,SAAgB,WAAW;QACzB,IAAI,CAAC,QAAQ,EAAE;YACb,OAAO,KAAK,CAAC;SACd;QAED,IAAI,KAAK,GAAG,qBAAqB,CAAC;QAElC,IAAI,OAAO,EAAE;YACX,MAAM,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC;YAC9B,KAAK;gBACH,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC;oBACjC,CAAC,CAAC,qBAAqB;oBACvB,CAAC,CAAC,kBAAkB,CAAC;SAC1B;QAED,MAAM,UAAU,GAAG,MAAM;aACtB,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC;aAC/B,gBAAgB,CAAC,qBAAqB,CAAC,CAAC;QAE3C,QAAQ,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC;QAClC,QAAQ,CAAC,UAAU,CAAC,UAAU,CAAC;YAC7B,KAAK;YACL,UAAU;YACV,WAAW,EAAE,MAAM;YACnB,WAAW,EAAE,KAAK;SACnB,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IA3Be,mBAAW,cA2B1B,CAAA;IAED;;OAEG;IACH,SAAgB,UAAU;QACxB,OAAO,QAAQ,CAAC;IAClB,CAAC;IAFe,kBAAU,aAEzB,CAAA;IAED;;OAEG;IACH,SAAgB,aAAa;QAC3B,OAAO,cAAc,EAAE,CAAC;IAC1B,CAAC;IAFe,qBAAa,gBAE5B,CAAA;IAED;;OAEG;IACI,KAAK,UAAU,aAAa;QACjC,IAAI,QAAQ,IAAI,IAAI,EAAE;YACpB,OAAO,QAAQ,CAAC;SACjB;QACD,IAAI,QAAQ,EAAE;YACZ,OAAO,QAAQ,CAAC,OAAO,CAAC;SACzB;QACD,QAAQ,GAAG,IAAI,eAAe,EAAE,CAAC;QACjC,QAAQ,GAAG,CAAC,MAAM,MAAM,CAAC,sBAAsB,CAAC,CAAC,CAAC,OAAO,CAAC;QAC1D,QAAQ,GAAG,CAAC,MAAM,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC;QAC7C,WAAW,EAAE,CAAC;QACd,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC3B,OAAO,QAAQ,CAAC;IAClB,CAAC;IAbqB,qBAAa,gBAalC,CAAA;AACH,CAAC,EApFS,OAAO,KAAP,OAAO,QAoFhB"}

package/lib/markdown.d.ts

@@ -0,0 +1,29 @@
+import { IMermaidManager, IMermaidMarkdown } from './tokens';
+/**
+ * An implementation of mermaid fenced code blocks in markdown.
+ */
+export declare class MermaidMarkdown implements IMermaidMarkdown {
+    protected _mermaid: IMermaidManager;
+    readonly languages: string[];
+    readonly rank = 100;
+    constructor(options: MermaidMarkdown.IOptions);
+    /**
+     * Pre-parse and cache the rendered text.
+     */
+    walk(text: string): Promise<void>;
+    /**
+     * Render the diagram.
+     */
+    render(text: string): string | null;
+}
+/**
+ * A namespace for mermaid markdown
+ */
+export declare namespace MermaidMarkdown {
+    /**
+     * Initialization options for mermaid markdown
+     */
+    interface IOptions {
+        mermaid: IMermaidManager;
+    }
+}

package/lib/markdown.js

@@ -0,0 +1,30 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+/**
+ * An implementation of mermaid fenced code blocks in markdown.
+ */
+export class MermaidMarkdown {
+    constructor(options) {
+        this.languages = ['mermaid'];
+        this.rank = 100;
+        this._mermaid = options.mermaid;
+    }
+    /**
+     * Pre-parse and cache the rendered text.
+     */
+    async walk(text) {
+        await this._mermaid.renderFigure(text);
+    }
+    /**
+     * Render the diagram.
+     */
+    render(text) {
+        // handle pre-cached mermaid figures
+        let cachedFigure = this._mermaid.getCachedFigure(text);
+        if (cachedFigure) {
+            return cachedFigure.outerHTML;
+        }
+        return null;
+    }
+}
+//# sourceMappingURL=markdown.js.map

package/lib/markdown.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdown.js","sourceRoot":"","sources":["../src/markdown.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,2DAA2D;AAI3D;;GAEG;AACH,MAAM,OAAO,eAAe;IAK1B,YAAY,OAAiC;QAHpC,cAAS,GAAG,CAAC,SAAS,CAAC,CAAC;QACxB,SAAI,GAAG,GAAG,CAAC;QAGlB,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI,CAAC,IAAY;QACrB,MAAM,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IACzC,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,IAAY;QACjB,oCAAoC;QACpC,IAAI,YAAY,GAAuB,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QAC3E,IAAI,YAAY,EAAE;YAChB,OAAO,YAAY,CAAC,SAAS,CAAC;SAC/B;QACD,OAAO,IAAI,CAAC;IACd,CAAC;CACF"}

package/lib/mime.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @packageDocumentation
+ * @module mermaid-extension
+ */
+import { IMermaidManager } from './tokens';
+import { IRenderMime } from '@jupyterlab/rendermime-interfaces';
+import { PromiseDelegate } from '@lumino/coreutils';
+import { Widget } from '@lumino/widgets';
+/**
+ * A widget for rendering mermaid text-based diagrams, for usage with rendermime.
+ */
+export declare class RenderedMermaid extends Widget implements IRenderMime.IRenderer {
+    protected static _manager: IMermaidManager | null;
+    protected static _managerReady: PromiseDelegate<IMermaidManager>;
+    protected _lastRendered: string | null;
+    /**
+     * Create a new widget for rendering Vega/Vega-Lite.
+     */
+    constructor(options: IRenderMime.IRendererOptions);
+    static set manager(manager: IMermaidManager);
+    /**
+     * Render mermaid text-based diagrams into this widget's node.
+     */
+    renderModel(model: IRenderMime.IMimeModel): Promise<void>;
+    private _mimeType;
+}
+/**
+ * A mime renderer factory for mermaid text-based diagrams.
+ */
+export declare const rendererFactory: IRenderMime.IRendererFactory;

package/lib/mime.js

@@ -0,0 +1,98 @@
+/* -----------------------------------------------------------------------------
+| Copyright (c) Jupyter Development Team.
+| Distributed under the terms of the Modified BSD License.
+|----------------------------------------------------------------------------*/
+/**
+ * @packageDocumentation
+ * @module mermaid-extension
+ */
+import { MERMAID_CLASS, MERMAID_MIME_TYPE, WARNING_CLASS } from './tokens';
+import { PromiseDelegate } from '@lumino/coreutils';
+import { Widget } from '@lumino/widgets';
+const SVG_MIME = 'image/svg+xml';
+/**
+ * A widget for rendering mermaid text-based diagrams, for usage with rendermime.
+ */
+class RenderedMermaid extends Widget {
+    /**
+     * Create a new widget for rendering Vega/Vega-Lite.
+     */
+    constructor(options) {
+        super();
+        this._lastRendered = null;
+        this._mimeType = options.mimeType;
+        this.addClass(MERMAID_CLASS);
+    }
+    static set manager(manager) {
+        if (RenderedMermaid._manager) {
+            console.warn('Mermaid manager may only be set once, and is already set.');
+            return;
+        }
+        RenderedMermaid._manager = manager;
+        RenderedMermaid._managerReady.resolve(manager);
+    }
+    /**
+     * Render mermaid text-based diagrams into this widget's node.
+     */
+    async renderModel(model) {
+        const manager = await RenderedMermaid._managerReady.promise;
+        const text = model.data[this._mimeType];
+        if (text == null || text === this._lastRendered) {
+            return;
+        }
+        this._lastRendered = text;
+        // get a div containing a figure or parser message
+        const figure = await manager.renderFigure(text);
+        if (figure.classList.contains(WARNING_CLASS)) {
+            this.node.classList.add(WARNING_CLASS);
+        }
+        else {
+            this.node.classList.remove(WARNING_CLASS);
+        }
+        if (!figure.firstChild) {
+            return;
+        }
+        if (this.node.innerHTML !== figure.innerHTML) {
+            this.node.innerHTML = figure.innerHTML;
+        }
+        // capture the version of mermaid used
+        const version = manager.getMermaidVersion();
+        const mermaidMetadata = {
+            ...(model.metadata[MERMAID_MIME_TYPE] || {}),
+            version
+        };
+        const metadata = {
+            ...model.metadata,
+            [MERMAID_MIME_TYPE]: mermaidMetadata
+        };
+        // if available, set the fully-rendered SVG
+        const img = figure.querySelector('img');
+        if (img) {
+            const svg = decodeURIComponent(img.src.split(',')[1]);
+            const oldSvg = model.data[SVG_MIME];
+            if (svg !== oldSvg) {
+                model.setData({
+                    data: { ...model.data, [SVG_MIME]: svg },
+                    metadata
+                });
+            }
+        }
+        else {
+            const dataWithoutSvg = { ...model.data };
+            delete dataWithoutSvg[SVG_MIME];
+            model.setData({ data: dataWithoutSvg, metadata });
+        }
+    }
+}
+RenderedMermaid._manager = null;
+RenderedMermaid._managerReady = new PromiseDelegate();
+export { RenderedMermaid };
+/**
+ * A mime renderer factory for mermaid text-based diagrams.
+ */
+export const rendererFactory = {
+    safe: true,
+    mimeTypes: [MERMAID_MIME_TYPE],
+    createRenderer: options => new RenderedMermaid(options)
+};
+//# sourceMappingURL=mime.js.map

package/lib/mime.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mime.js","sourceRoot":"","sources":["../src/mime.ts"],"names":[],"mappings":"AAAA;;;+EAG+E;AAC/E;;;GAGG;AAEH,OAAO,EAEL,aAAa,EACb,iBAAiB,EACjB,aAAa,EACd,MAAM,UAAU,CAAC;AAElB,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAEzC,MAAM,QAAQ,GAAG,eAAe,CAAC;AAEjC;;GAEG;AACH,MAAa,eAAgB,SAAQ,MAAM;IAKzC;;OAEG;IACH,YAAY,OAAqC;QAC/C,KAAK,EAAE,CAAC;QANA,kBAAa,GAAkB,IAAI,CAAC;QAO5C,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,QAAQ,CAAC;QAClC,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;IAC/B,CAAC;IAED,MAAM,KAAK,OAAO,CAAC,OAAwB;QACzC,IAAI,eAAe,CAAC,QAAQ,EAAE;YAC5B,OAAO,CAAC,IAAI,CAAC,2DAA2D,CAAC,CAAC;YAC1E,OAAO;SACR;QACD,eAAe,CAAC,QAAQ,GAAG,OAAO,CAAC;QACnC,eAAe,CAAC,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACjD,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,WAAW,CAAC,KAA6B;QAC7C,MAAM,OAAO,GAAG,MAAM,eAAe,CAAC,aAAa,CAAC,OAAO,CAAC;QAE5D,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAuB,CAAC;QAC9D,IAAI,IAAI,IAAI,IAAI,IAAI,IAAI,KAAK,IAAI,CAAC,aAAa,EAAE;YAC/C,OAAO;SACR;QAED,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;QAE1B,kDAAkD;QAClD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAEhD,IAAI,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE;YAC5C,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;SACxC;aAAM;YACL,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;SAC3C;QAED,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE;YACtB,OAAO;SACR;QAED,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,KAAK,MAAM,CAAC,SAAS,EAAE;YAC5C,IAAI,CAAC,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC;SACxC;QAED,sCAAsC;QACtC,MAAM,OAAO,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;QAC5C,MAAM,eAAe,GAAG;YACtB,GAAG,CAAE,KAAK,CAAC,QAAQ,CAAC,iBAAiB,CAAyB,IAAI,EAAE,CAAC;YACrE,OAAO;SACR,CAAC;QACF,MAAM,QAAQ,GAAG;YACf,GAAG,KAAK,CAAC,QAAQ;YACjB,CAAC,iBAAiB,CAAC,EAAE,eAAe;SACrC,CAAC;QAEF,2CAA2C;QAC3C,MAAM,GAAG,GAAG,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAExC,IAAI,GAAG,EAAE;YACP,MAAM,GAAG,GAAG,kBAAkB,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACtD,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACpC,IAAI,GAAG,KAAK,MAAM,EAAE;gBAClB,KAAK,CAAC,OAAO,CAAC;oBACZ,IAAI,EAAE,EAAE,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE;oBACxC,QAAQ;iBACT,CAAC,CAAC;aACJ;SACF;aAAM;YACL,MAAM,cAAc,GAAG,EAAE,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;YACzC,OAAO,cAAc,CAAC,QAAQ,CAAC,CAAC;YAChC,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,cAAc,EAAE,QAAQ,EAAE,CAAC,CAAC;SACnD;IACH,CAAC;;AAhFgB,wBAAQ,GAA2B,IAAI,AAA/B,CAAgC;AACxC,6BAAa,GAAG,IAAI,eAAe,EAAmB,AAAzC,CAA0C;SAF7D,eAAe;AAsF5B;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAAiC;IAC3D,IAAI,EAAE,IAAI;IACV,SAAS,EAAE,CAAC,iBAAiB,CAAC;IAC9B,cAAc,EAAE,OAAO,CAAC,EAAE,CAAC,IAAI,eAAe,CAAC,OAAO,CAAC;CACxD,CAAC"}

package/lib/tokens.d.ts

@@ -0,0 +1,88 @@
+import { Token } from '@lumino/coreutils';
+import type MermaidType from 'mermaid';
+export declare const MERMAID_MIME_TYPE = "text/vnd.mermaid";
+export declare const MERMAID_FILE_EXTENSIONS: string[];
+export declare const MERMAID_DEFAULT_THEME = "default";
+export declare const MERMAID_DARK_THEME = "dark";
+export declare const MERMAID_CLASS = "jp-RenderedMermaid";
+export declare const MERMAID_CODE_CLASS = "mermaid";
+export declare const WARNING_CLASS = "jp-mod-warning";
+export declare const DETAILS_CLASS = "jp-RenderedMermaid-Details";
+export declare const SUMMARY_CLASS = "jp-RenderedMermaid-Summary";
+/**
+ * The exported token for a mermaid manager
+ */
+export declare const IMermaidManager: Token<IMermaidManager>;
+/**
+ * A namespace for public mermaid interfaces.
+ */
+export interface IMermaidManager {
+    /**
+     * Get the (potentially uninitialized) mermaid module.
+     */
+    getMermaid(): Promise<typeof MermaidType>;
+    /**
+     * Get the version of the currently-loaded mermaid module
+     */
+    getMermaidVersion(): string | null;
+    /**
+     * Render mermaid source to an SVG string with extraced metadata.
+     */
+    renderSvg(text: string): Promise<IMermaidManager.IRenderInfo>;
+    /**
+     * Render and cache mermaid source as a figure of an image, or a unsuccessful parser message.
+     */
+    renderFigure(text: string): Promise<HTMLElement>;
+    /**
+     * Get the pre-cached element for a mermaid string, if available.
+     */
+    getCachedFigure(text: string): HTMLElement | null;
+}
+/**
+ * A namespace for the mermaid manager.
+ */
+export declare namespace IMermaidManager {
+    /**
+     * The results of a successful rendering of a mermaid text-based diagram.
+     */
+    interface IRenderInfo {
+        /** the original source of the diagram. */
+        text: string;
+        /** The raw rendered SVG. */
+        svg: string;
+        /** The extracted accessible description, if found. */
+        accessibleDescription?: string | null;
+        /** The extracted accessible title, if found. */
+        accessibleTitle?: string | null;
+        /** The extracted width of the digaram, if found. */
+        width?: number | null;
+    }
+}
+/**
+ * The exported token for a mermaid manager
+ */
+export declare const IMermaidMarkdown: Token<IMermaidMarkdown>;
+/**
+ * A handler for mermaid fenced code blocks in markdown
+ *
+ * This duplicates the (currently) private `IFencedBlockRenderer` in
+ * `@jupyterlab/markedparser-extension`.
+ */
+export interface IMermaidMarkdown {
+    /**
+     * The languages this block accepts.
+     */
+    languages: string[];
+    /**
+     * The order in which the block would be processed
+     */
+    rank: number;
+    /**
+     * Handle up-front loading/parsing mermaid
+     */
+    walk: (text: string) => Promise<void>;
+    /**
+     * Provide pre-rendered diagram content
+     */
+    render: (text: string) => string | null;
+}

package/lib/tokens.js

@@ -0,0 +1,24 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+import { Token } from '@lumino/coreutils';
+// documented upstream constants
+export const MERMAID_MIME_TYPE = 'text/vnd.mermaid';
+export const MERMAID_FILE_EXTENSIONS = ['.mmd', '.mermaid'];
+// mermaid themes
+export const MERMAID_DEFAULT_THEME = 'default';
+export const MERMAID_DARK_THEME = 'dark';
+// DOM
+export const MERMAID_CLASS = 'jp-RenderedMermaid';
+export const MERMAID_CODE_CLASS = 'mermaid';
+export const WARNING_CLASS = 'jp-mod-warning';
+export const DETAILS_CLASS = 'jp-RenderedMermaid-Details';
+export const SUMMARY_CLASS = 'jp-RenderedMermaid-Summary';
+/**
+ * The exported token for a mermaid manager
+ */
+export const IMermaidManager = new Token('@jupyterlab/mermaid:IMermaidManager', `a manager for rendering mermaid text-based diagrams`);
+/**
+ * The exported token for a mermaid manager
+ */
+export const IMermaidMarkdown = new Token('@jupyterlab/mermaid:IMermaidMarkdown', `a manager for rendering mermaid text-based diagrams in markdown fenced code blocks`);
+//# sourceMappingURL=tokens.js.map