@mermaid-js/mermaid-cli 10.1.0 → 10.2.4

package/dist-types/src/index.d.ts

@@ -13,7 +13,7 @@ export type ParseMDDOptions = {
     /**
      * - Mermaid config.
      */
-    mermaidConfig?: any;
+    mermaidConfig?: import("mermaid").MermaidConfig | undefined;
     /**
      * - Optional CSS text.
      */

package/dist-types/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.js"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SA4Xc,MAAM;;;;SACN,MAAM;;;;;;AAqBpB;;;;;;;;;;;;;;GAcG;AACH,2BAZW,GAAG,MAAM,IAAI,IAAI,GAAG,UAAU,EAAE,GAAG,MAAM,GAAG,SAAS,UAIrD,GAAG,MAAM,IAAI,IAAI,GAAG,UAAU,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,EAAE;;;;;8BAwGlE;AAzSD;;;;;;;;;GASG;AACH,uCAPW,OAAO,WAAW,EAAE,OAAO,cAC3B,MAAM,gBACN,KAAK,GAAG,KAAK,GAAG,KAAK,8FAEnB,QAAQ;IAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAC,CAAC,CAwJ9E;AAzLD;;;;;;;GAOG;AAEH;;;;;;;;;;;GAWG;AACH,kCAPW,OAAO,WAAW,EAAE,OAAO,cAC3B,MAAM,gBACN,KAAK,GAAG,KAAK,GAAG,KAAK,sCAGnB,QAAQ,MAAM,CAAC,CAK3B;AAhHD,qCAsFC;AA9KD;;;;;GAKG;AACH,+BAHW,MAAM,GACJ,KAAK,CAKjB;sBAnBqB,WAAW"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.js"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SA6Vc,MAAM;;;;SACN,MAAM;;;;;;AAqBpB;;;;;;;;;;;;;;GAcG;AACH,2BAZW,GAAG,MAAM,IAAI,IAAI,GAAG,UAAU,EAAE,GAAG,MAAM,GAAG,SAAS,UAIrD,GAAG,MAAM,IAAI,IAAI,GAAG,UAAU,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,EAAE;;;;;8BAwGlE;AArQD;;;;;;;;;GASG;AACH,uCAPW,OAAO,WAAW,EAAE,OAAO,cAC3B,MAAM,gBACN,KAAK,GAAG,KAAK,GAAG,KAAK,8FAEnB,QAAQ;IAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAC,CAAC,CAoH9E;AArJD;;;;;;;GAOG;AAEH;;;;;;;;;;;GAWG;AACH,kCAPW,OAAO,WAAW,EAAE,OAAO,cAC3B,MAAM,gBACN,KAAK,GAAG,KAAK,GAAG,KAAK,sCAGnB,QAAQ,MAAM,CAAC,CAK3B;AAzHD,qCA+FC;AAnLD;;;;;GAKG;AACH,+BAHW,MAAM,GACJ,KAAK,CAKjB;sBAnBqB,WAAW"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mermaid-js/mermaid-cli",
-  "version": "10.1.0",
+  "version": "10.2.4",
   "description": "Command-line interface for mermaid",
   "license": "MIT",
   "repository": "git@github.com:mermaid-js/mermaid-cli.git",
@@ -28,8 +28,7 @@
   },
   "devDependencies": {
     "@fortawesome/fontawesome-free": "^5.6.0",
-    "@mermaid-js/mermaid-mindmap": "^9.2.2",
-    "@tsconfig/node14": "^1.0.3",
+    "@tsconfig/node14": "^14.1.0",
     "jest": "^29.0.1",
     "mermaid": "^10.0.0",
     "standard": "^17.0.0",

package/src/index.js

@@ -52,36 +52,32 @@ const checkConfigFile = file => {
  * If `undefined`, reads from `stdin` instead.
  * @returns {Promise<string>} The contents of `inputFile` parsed as `utf8`.
  */
-const getInputData = async inputFile => new Promise((resolve, reject) => {
+async function getInputData (inputFile) {
   // if an input file has been specified using '-i', it takes precedence over
   // piping from stdin
   if (typeof inputFile !== 'undefined') {
-    return fs.readFile(inputFile, 'utf-8', (err, data) => {
-      if (err) {
-        return reject(err)
-      }
-
-      return resolve(data)
-    })
+    return await fs.promises.readFile(inputFile, 'utf-8')
   }
 
-  let data = ''
-  process.stdin.on('readable', function () {
-    const chunk = process.stdin.read()
+  return await new Promise((resolve, reject) => {
+    let data = ''
+    process.stdin.on('readable', function () {
+      const chunk = process.stdin.read()
 
-    if (chunk !== null) {
-      data += chunk
-    }
-  })
+      if (chunk !== null) {
+        data += chunk
+      }
+    })
 
-  process.stdin.on('error', function (err) {
-    reject(err)
-  })
+    process.stdin.on('error', function (err) {
+      reject(err)
+    })
 
-  process.stdin.on('end', function () {
-    resolve(data)
+    process.stdin.on('end', function () {
+      resolve(data)
+    })
   })
-})
+}
 
 /**
  * Commander parser that converts a string to an integer.
@@ -161,10 +157,19 @@ async function cli () {
     checkConfigFile(configFile)
     mermaidConfig = Object.assign(mermaidConfig, JSON.parse(fs.readFileSync(configFile, 'utf-8')))
   }
-  let puppeteerConfig = {}
+  // @ts-expect-error Setting headless to `1` is not officially supported
+  let puppeteerConfig = /** @type {import('puppeteer').PuppeteerLaunchOptions} */ ({
+    /*
+     * `headless: 1` is not officially supported, but setting this to any
+     * non-`true` truthy value doesn't change any behavior, but it hides the
+     * Puppeteer old Headless deprecation warning,
+     * see https://github.com/argos-ci/jest-puppeteer/issues/553#issuecomment-1561826456
+     */
+    headless: 1
+  })
   if (puppeteerConfigFile) {
     checkConfigFile(puppeteerConfigFile)
-    puppeteerConfig = JSON.parse(fs.readFileSync(puppeteerConfigFile, 'utf-8'))
+    puppeteerConfig = Object.assign(puppeteerConfig, JSON.parse(fs.readFileSync(puppeteerConfigFile, 'utf-8')))
   }
 
   // check cssFile
@@ -239,54 +244,18 @@ async function renderMermaid (browser, definition, outputFormat, { viewport, bac
       body.style.background = backgroundColor
     }, backgroundColor)
     const metadata = await page.$eval('#container', async (container, definition, mermaidConfig, myCSS, backgroundColor) => {
-      /**
-       * Checks to see if the given object is one of Mermaid's DetailedErrors.
-       *
-       * @param {unknown} error - The error to check
-       * @returns {error is import("mermaid").DetailedError} Returns `true` is the `error`
-       * is a `Mermaid.DetailedError`.
-       * @see https://github.com/mermaid-js/mermaid/blob/v10.0.1/packages/mermaid/src/utils.ts#L927-L930
-       */
-      function isDetailedError (error) {
-        return typeof error === 'object' && error !== null && 'str' in error
-      }
-
-      container.textContent = definition
-
       /**
        * @typedef {Object} GlobalThisWithMermaid
        * We've already imported these modules in our `index.html` file, so that they
        * get correctly bundled.
        * @property {import("mermaid")["default"]} mermaid Already imported mermaid instance
-       * @property {import("@mermaid-js/mermaid-mindmap")} mermaidMindmap Already imported mermaid-mindmap plugin
        */
-      const { mermaid, mermaidMindmap } = /** @type {GlobalThisWithMermaid & typeof globalThis} */ (globalThis)
+      const { mermaid } = /** @type {GlobalThisWithMermaid & typeof globalThis} */ (globalThis)
 
-      await mermaid.registerExternalDiagrams([mermaidMindmap])
-
-      mermaid.initialize(mermaidConfig)
+      mermaid.initialize({ startOnLoad: false, ...mermaidConfig })
       // should throw an error if mmd diagram is invalid
-      try {
-        await mermaid.run({
-          nodes: [
-            /**
-             * @type {HTMLElement} We know this is a `HTMLElement`, since we
-             * control the input HTML file
-             */ (container)
-          ],
-          suppressErrors: false
-        })
-      } catch (error) {
-        if (error instanceof Error) {
-          // mermaid-js doesn't currently throws JS Errors, but let's leave this
-          // here in case it does in the future
-          throw error
-        } else if (isDetailedError(error)) {
-          throw new Error(error.message)
-        } else {
-          throw new Error(`Unknown mermaid render error: ${error}`)
-        }
-      }
+      const { svg: svgText } = await mermaid.render('my-svg', definition, container)
+      container.innerHTML = svgText
 
       const svg = container.getElementsByTagName?.('svg')?.[0]
       if (svg?.style) {
@@ -452,7 +421,7 @@ async function run (input, output, { puppeteerConfig = {}, quiet = false, output
     if (input && /\.(md|markdown)$/.test(input)) {
       const imagePromises = []
       for (const mermaidCodeblockMatch of definition.matchAll(mermaidChartsInMarkdownRegexGlobal)) {
-        const mermaidDefinition = mermaidCodeblockMatch[1]
+        const mermaidDefinition = mermaidCodeblockMatch[2]
 
         /** Output can be either a template image file, or a `.md` output file.
          *   If it is a template image file, use that to created numbered diagrams