Add zenuml

packages/mermaid-zenuml/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@mermaid-js/mermaid-zenuml",
+  "version": "0.0.1",
+  "description": "Zenuml integration for MermaidJS.",
+  "module": "dist/mermaid-zenuml.core.mjs",
+  "types": "dist/detector.d.ts",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/mermaid-zenuml.core.mjs",
+      "types": "./dist/detector.d.ts"
+    },
+    "./*": "./*"
+  },
+  "keywords": [
+    "diagram",
+    "markdown",
+    "zenuml",
+    "mermaid"
+  ],
+  "scripts": {
+    "prepublishOnly": "pnpm -w run build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/mermaid-js/mermaid"
+  },
+  "author": "Peng Xiao",
+  "license": "MIT",
+  "standard": {
+    "ignore": [
+      "dist/**/*.js"
+    ],
+    "globals": [
+      "page"
+    ]
+  },
+  "dependencies": {
+    "@zenuml/core": "^2.0.36"
+  },
+  "devDependencies": {
+    "mermaid": "workspace:*"
+  },
+  "files": [
+    "dist"
+  ]
+}

packages/mermaid-zenuml/src/detector.ts

@@ -0,0 +1,21 @@
+import type { ExternalDiagramDefinition } from 'mermaid';
+
+const id = 'zenuml';
+const regexp = /^\s*zenuml/;
+
+const detector = (txt: string) => {
+  return txt.match(regexp) !== null;
+};
+
+const loader = async () => {
+  const { diagram } = await import('./zenuml-definition.js');
+  return { id, diagram };
+};
+
+const plugin: ExternalDiagramDefinition = {
+  id,
+  detector,
+  loader,
+};
+
+export default plugin;

packages/mermaid-zenuml/src/mermaidUtils.ts

@@ -0,0 +1,58 @@
+import type { MermaidConfig } from 'mermaid';
+
+const warning = (s: string) => {
+  // Todo remove debug code
+  // eslint-disable-next-line no-console
+  console.error('Log function was called before initialization', s);
+};
+
+export type LogLevel = 'trace' | 'debug' | 'info' | 'warn' | 'error' | 'fatal';
+
+export const LEVELS: Record<LogLevel, number> = {
+  trace: 0,
+  debug: 1,
+  info: 2,
+  warn: 3,
+  error: 4,
+  fatal: 5,
+};
+
+export const log: Record<keyof typeof LEVELS, typeof console.log> = {
+  trace: warning,
+  debug: warning,
+  info: warning,
+  warn: warning,
+  error: warning,
+  fatal: warning,
+};
+
+export let setLogLevel: (level: keyof typeof LEVELS | number | string) => void;
+export let getConfig: () => MermaidConfig;
+export let sanitizeText: (str: string) => string;
+// eslint-disable @typescript-eslint/no-explicit-any
+export let setupGraphViewbox: (
+  graph: any,
+  svgElem: any,
+  padding: any,
+  useMaxWidth: boolean
+) => void;
+
+export const injectUtils = (
+  _log: Record<keyof typeof LEVELS, typeof console.log>,
+  _setLogLevel: any,
+  _getConfig: any,
+  _sanitizeText: any,
+  _setupGraphViewbox: any
+) => {
+  _log.info('Mermaid utils injected');
+  log.trace = _log.trace;
+  log.debug = _log.debug;
+  log.info = _log.info;
+  log.warn = _log.warn;
+  log.error = _log.error;
+  log.fatal = _log.fatal;
+  setLogLevel = _setLogLevel;
+  getConfig = _getConfig;
+  sanitizeText = _sanitizeText;
+  setupGraphViewbox = _setupGraphViewbox;
+};

packages/mermaid-zenuml/src/parser.ts

@@ -0,0 +1,10 @@
+// ZenUML manage parsing internally. It uses Antlr4 to parse the DSL.
+// The parser is defined in https://github.com/ZenUml/vue-sequence/blob/main/src/parser/index.js
+
+// This is a dummy parser that satisfies the mermaid API logic.
+export default {
+  parser: { yy: {} },
+  parse: () => {
+    // no op
+  },
+};

packages/mermaid-zenuml/src/zenuml-definition.ts

@@ -0,0 +1,17 @@
+import { injectUtils } from './mermaidUtils.js';
+import parser from './parser.js';
+import renderer from './zenumlRenderer.js';
+
+export const diagram = {
+  db: {
+    clear: () => {
+      // no-op
+    },
+  },
+  renderer,
+  parser,
+  styles: () => {
+    // no-op
+  },
+  injectUtils,
+};

packages/mermaid-zenuml/src/zenumlRenderer.ts

@@ -0,0 +1,68 @@
+import { getConfig, log } from './mermaidUtils.js';
+import ZenUml from '@zenuml/core';
+
+const regexp = /^\s*zenuml/;
+
+// Create a Zen UML container outside the svg first for rendering, otherwise the Zen UML diagram cannot be rendered properly
+function createTemporaryZenumlContainer(id: string) {
+  const container = document.createElement('div');
+  container.id = `container-${id}`;
+  container.style.display = 'flex';
+  container.innerHTML = `<div id="zenUMLApp-${id}"></div>`;
+  const app = container.querySelector(`#zenUMLApp-${id}`) as HTMLElement;
+  return { container, app };
+}
+
+// Create a foreignObject to wrap the Zen UML container in the svg
+function createForeignObject(id: string) {
+  const foreignObject = document.createElementNS('http://www.w3.org/2000/svg', 'foreignObject');
+  foreignObject.setAttribute('x', '0');
+  foreignObject.setAttribute('y', '0');
+  foreignObject.setAttribute('width', '100%');
+  foreignObject.setAttribute('height', '100%');
+  const { container, app } = createTemporaryZenumlContainer(id);
+  foreignObject.appendChild(container);
+  return { foreignObject, container, app };
+}
+
+/**
+ * Draws a Zen UML in the tag with id: id based on the graph definition in text.
+ *
+ * @param text - The text of the diagram
+ * @param id - The id of the diagram which will be used as a DOM element id¨
+ */
+export const draw = async function (text: string, id: string) {
+  log.info('draw with Zen UML renderer', ZenUml);
+
+  text = text.replace(regexp, '');
+  const { securityLevel } = getConfig();
+  // Handle root and Document for when rendering in sandbox mode
+  let sandboxElement: HTMLIFrameElement | null = null;
+  if (securityLevel === 'sandbox') {
+    sandboxElement = document.getElementById('i' + id) as HTMLIFrameElement;
+  }
+
+  const root = securityLevel === 'sandbox' ? sandboxElement?.contentWindow?.document : document;
+
+  const svgContainer = root?.querySelector(`svg#${id}`);
+
+  if (!root || !svgContainer) {
+    log.error('Cannot find root or svgContainer');
+    return;
+  }
+
+  const { foreignObject, container, app } = createForeignObject(id);
+  svgContainer.appendChild(foreignObject);
+
+  const zenuml = new ZenUml(app);
+  // default is a theme name. More themes to be added and will be configurable in the future
+  await zenuml.render(text, 'theme-mermaid');
+
+  const { width, height } = window.getComputedStyle(container);
+  log.debug('zenuml diagram size', width, height);
+  svgContainer.setAttribute('style', `width: ${width}; height: ${height};`);
+};
+
+export default {
+  draw,
+};

packages/mermaid-zenuml/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "rootDir": "./src",
+    "outDir": "./dist"
+  },
+  "include": ["./src/**/*.ts"],
+  "typeRoots": ["./src/types"]
+}