Making timeline diagram lazy-loaded internal, removing separate package

.vite/build.ts

@@ -41,11 +41,11 @@ const packageOptions = {
     packageName: 'mermaid-mindmap',
     file: 'detector.ts',
   },
-  'mermaid-timeline': {
-    name: 'mermaid-timeline',
-    packageName: 'mermaid-timeline',
-    file: 'detector.ts',
-  },
+  // 'mermaid-timeline': {
+  //   name: 'mermaid-timeline',
+  //   packageName: 'mermaid-timeline',
+  //   file: 'detector.ts',
+  // },
   // 'mermaid-timeline-detector': {
   //   name: 'mermaid-timeline-detector',
   //   packageName: 'mermaid-timeline',
@@ -138,7 +138,7 @@ export const getBuildConfig = ({ minify, core, watch, entryName }: BuildOptions)
         'packages/mermaid-mindmap/src/**',
         'packages/mermaid/src/**',
         // 'packages/mermaid-example-diagram/src/**',
-        'packages/mermaid-timeline/src/**',
+        // 'packages/mermaid-timeline/src/**',
       ],
     };
   }
@@ -166,7 +166,7 @@ if (watch) {
   if (!mermaidOnly) {
     build(getBuildConfig({ minify: false, watch, entryName: 'mermaid-mindmap' }));
     // build(getBuildConfig({ minify: false, watch, entryName: 'mermaid-example-diagram' }));
-    build(getBuildConfig({ minify: false, watch, entryName: 'mermaid-timeline' }));
+    //build(getBuildConfig({ minify: false, watch, entryName: 'mermaid-timeline' }));
     //build(getBuildConfig({ minify: false, watch, entryName: 'mermaid-timeline-detector' }));
   }
 } else if (visualize) {

.vite/server.ts

@@ -24,7 +24,7 @@ async function createServer() {
   app.use(express.static('./packages/mermaid/dist'));
   app.use(express.static('./packages/mermaid-example-diagram/dist'));
   app.use(express.static('./packages/mermaid-mindmap/dist'));
-  app.use(express.static('./packages/mermaid-timeline/dist'));
+  //app.use(express.static('./packages/mermaid-timeline/dist'));
   app.use(vite.middlewares);
   app.use(express.static('demos'));
   app.use(express.static('cypress/platform'));

cypress/platform/ashish2.html

@@ -74,18 +74,18 @@
     <pre id="diagram" class="mermaid">
  timeline
         title MermaidChart 2023 Timeline
-        section 2023 Q1 &lt;br&gt; Release Personal Tier
+        section 2023 Q1 <br> Release Personal Tier
           Buttet 1 : sub-point 1a : sub-point 1b
                : sub-point 1c
           Bullet 2 : sub-point 2a : sub-point 2b
         section 2023 Q2 <br> Release XYZ Tier
-          Buttet 3 : sub-point <br/> 3a : sub-point 3b
+          Buttet 3 : sub-point <br> 3a : sub-point 3b
                : sub-point 3c
           Bullet 4 : sub-point 4a : sub-point 4b
 
     </pre>
 
-    <pre id="diagram" class="mermaid2">
+    <pre id="diagram" class="mermaid">
  timeline
         title England's History Timeline
         section Stone Age
@@ -173,13 +173,11 @@ mindmap
           gc7((grand<br/>grand<br/>child 8))
         </pre>
     <pre id="diagram" class="mermaid2">
-      gantt
-        title Style today marker (vertical line should be 5px wide and half-transparent blue)
-        dateFormat YYYY-MM-DD
-        axisFormat %d
-        todayMarker stroke-width:5px,stroke:#00f,opacity:0.5
-        section Section1
-        Today: 1, -1h
+      flowchart-elk TB
+      a --> b
+      a --> c
+      b --> d
+      c --> d
     </pre>
 
     <!-- <div id="cy"></div> -->
@@ -189,9 +187,9 @@ mindmap
     <script type="module">
       //import mindmap from '../../packages/mermaid-mindmap/src/detector';
       // import example from '../../packages/mermaid-example-diagram/src/detector';
-      import timeline from '../../packages/mermaid-timeline/src/detector';
+      // import timeline from '../../packages/mermaid-timeline/src/detector';
       import mermaid from '../../packages/mermaid/src/mermaid';
-      await mermaid.registerExternalDiagrams([timeline]);
+      // await mermaid.registerExternalDiagrams([]);
       mermaid.parseError = function (err, hash) {
         // console.error('Mermaid error: ', err);
       };
@@ -201,13 +199,14 @@ mindmap
         logLevel: 0,
         flowchart: {
           useMaxWidth: false,
-          htmlLabels: false,
+          htmlLabels: true,
         },
         gantt: {
           useMaxWidth: false,
         },
         timeline: {
           disableMulticolor: false,
+          htmlLabels: false,
         },
         useMaxWidth: true,
         lazyLoadedDiagrams: [

cypress/platform/knsv2.html

@@ -54,7 +54,7 @@
     </style>
   </head>
   <body>
-    <pre id="diagram" class="mermaid">
+    <pre id="diagram" class="mermaid2">
 %%{init: {"flowchart": {"defaultRenderer": "elk"}} }%%
 graph TB
       a --> b
@@ -62,14 +62,14 @@ graph TB
       b --> d
       c --> d
     </pre>
-    <pre id="diagram" class="mermaid">
+    <pre id="diagram" class="mermaid2">
 flowchart-elk TB
       a --> b
       a --> c
       b --> d
       c --> d
     </pre>
-    <pre id="diagram" class="mermaid">
+    <pre id="diagram" class="mermaid2">
 %%{init: {"flowchart": {"defaultRenderer": "elk"}} }%%
 flowchart TB
   %% I could not figure out how to use double quotes in labels in Mermaid
@@ -125,7 +125,7 @@ flowchart TB
 </pre
     >
     <br />
-    <pre id="diagram" class="mermaid">
+    <pre id="diagram" class="mermaid2">
 flowchart TB
   %% I could not figure out how to use double quotes in labels in Mermaid
   subgraph ibm[IBM Espresso CPU]
@@ -227,14 +227,24 @@ sequenceDiagram
     Customer->>+Merchant: Receives goods or services
         </pre
     >
-    <pre id="diagram" class="mermaid2">
-      gantt
-        title Style today marker (vertical line should be 5px wide and half-transparent blue)
-        dateFormat YYYY-MM-DD
-        axisFormat %d
-        todayMarker stroke-width:5px,stroke:#00f,opacity:0.5
-        section Section1
-        Today: 1, -1h
+    <pre id="diagram" class="mermaid">
+mindmap
+  root((mindmap))
+    Origins
+      Long history
+      ::icon(fa fa-book)
+      Popularisation
+        British popular psychology author Tony Buzan
+    Research
+      On effectiveness<br/>and features
+      On Automatic creation
+        Uses
+            Creative techniques
+            Strategic planning
+            Argument mapping
+    Tools
+      Pen and paper
+      Mermaid
     </pre>
 
     <!-- <div id="cy"></div> -->
@@ -252,7 +262,7 @@ sequenceDiagram
         // console.error('Mermaid error: ', err);
       };
       mermaid.initialize({
-        // theme: 'forest',
+        theme: 'dark',
         startOnLoad: true,
         logLevel: 0,
         flowchart: {

docs/syntax/timeline.md

@@ -457,16 +457,4 @@ Let's put them to use, and see how our sample diagram looks in different themes:
           2010 : Pinterest
 ```
 
-## Integrating with your library/website.
-
-Timeline uses the experimental lazy loading & async rendering features which could change in the future.
-
-```html
-<script type="module">
-  import mermaid from 'https://cdn.jsdelivr.net/npm/mermaid@9/dist/mermaid.esm.min.mjs';
-  import timeline from 'https://cdn.jsdelivr.net/npm/@mermaid-js/mermaid-timeline@9/dist/mermaid-timeline.esm.min.mjs';
-  await mermaid.registerExternalDiagrams([timeline]);
-</script>
-```
-
 You can also refer the implementation in the live editor [here](https://github.com/mermaid-js/mermaid-live-editor/blob/fcf53c98c25604c90a218104268c339be53035a6/src/lib/util/mermaid.ts) to see how the async loading is done.

packages/mermaid-mindmap/src/mindmap.spec.js

@@ -347,4 +347,40 @@ root
     expect(child.children.length).toEqual(2);
     expect(child.children[1].nodeId).toEqual('b');
   });
+  it('MMP-23 Rows with only spaces should not interfere', function () {
+    let str = 'mindmap\nroot\n A\n \n\n B';
+    mindmap.parse(str);
+    const mm = mindmap.yy.getMindmap();
+    expect(mm.nodeId).toEqual('root');
+    expect(mm.children.length).toEqual(2);
+
+    const child = mm.children[0];
+    expect(child.nodeId).toEqual('A');
+    const child2 = mm.children[1];
+    expect(child2.nodeId).toEqual('B');
+  });
+  it('MMP-24 Handle rows above the mindmap declarations', function () {
+    let str = '\n \nmindmap\nroot\n A\n \n\n B';
+    mindmap.parse(str);
+    const mm = mindmap.yy.getMindmap();
+    expect(mm.nodeId).toEqual('root');
+    expect(mm.children.length).toEqual(2);
+
+    const child = mm.children[0];
+    expect(child.nodeId).toEqual('A');
+    const child2 = mm.children[1];
+    expect(child2.nodeId).toEqual('B');
+  });
+  it('MMP-25 Handle rows above the mindmap declarations, no space', function () {
+    let str = '\n\n\nmindmap\nroot\n A\n \n\n B';
+    mindmap.parse(str);
+    const mm = mindmap.yy.getMindmap();
+    expect(mm.nodeId).toEqual('root');
+    expect(mm.children.length).toEqual(2);
+
+    const child = mm.children[0];
+    expect(child.nodeId).toEqual('A');
+    const child2 = mm.children[1];
+    expect(child2.nodeId).toEqual('B');
+  });
 });

packages/mermaid-mindmap/src/parser/mindmap.jison

@@ -25,6 +25,7 @@
 <CLASS>\n				   { this.popState();}
 // [\s]*"::icon("   { this.begin('ICON'); }
 "::icon("   { yy.getLogger().trace('Begin icon');this.begin('ICON'); }
+[\s]+[\n]     {yy.getLogger().trace('SPACELINE');return 'SPACELINE'                 /* skip all whitespace */    ;}
 [\n]+               return 'NL';
 <ICON>[^\)]+			 { return 'ICON'; }
 <ICON>\)				   {yy.getLogger().trace('end icon');this.popState();}
@@ -64,14 +65,25 @@
 
 start
 // %{	: info document 'EOF' { return yy; } }
+	: mindMap
+  |	spaceLines mindMap
+  ;
+
+spaceLines
+  : SPACELINE
+  | spaceLines SPACELINE
+  | spaceLines NL
+  ;
+
+mindMap
   : MINDMAP document  { return yy; }
   | MINDMAP NL document  { return yy; }
-  |	SPACELIST MINDMAP document  { return yy; }
   ;
 
 stop
   : NL {yy.getLogger().trace('Stop NL ');}
   | EOF {yy.getLogger().trace('Stop EOF ');}
+  | SPACELINE
   | stop NL {yy.getLogger().trace('Stop NL2 ');}
   | stop EOF {yy.getLogger().trace('Stop EOF2 ');}
   ;
@@ -81,9 +93,10 @@ document
 	;
 
 statement
-	: SPACELIST node       { yy.getLogger().trace('Node: ',$2.id);yy.addNode($1.length, $2.id, $2.descr, $2.type);  }
+	: SPACELIST node       { yy.getLogger().info('Node: ',$2.id);yy.addNode($1.length, $2.id, $2.descr, $2.type);  }
 	| SPACELIST ICON       { yy.getLogger().trace('Icon: ',$2);yy.decorateNode({icon: $2}); }
 	| SPACELIST CLASS      { yy.decorateNode({class: $2}); }
+  | SPACELINE { yy.getLogger().trace('SPACELIST');}
 	| node					       { yy.getLogger().trace('Node: ',$1.id);yy.addNode(0, $1.id, $1.descr, $1.type);  }
 	| ICON                 { yy.decorateNode({icon: $1}); }
 	| CLASS                { yy.decorateNode({class: $1}); }

packages/mermaid-mindmap/src/svgDraw.js

@@ -203,14 +203,12 @@ const roundedRectBkg = function (elem, node) {
  * @returns {number} The height nodes dom element
  */
 export const drawNode = function (elem, node, fullSection, conf) {
-  const section = (fullSection % MAX_SECTIONS) - 1;
+  const section = fullSection % (MAX_SECTIONS - 1);
   const nodeElem = elem.append('g');
   node.section = section;
   nodeElem.attr(
     'class',
-    (node.class ? node.class + ' ' : '') +
-      'mindmap-node ' +
-      (section < 0 ? 'section-root' : 'section-' + section)
+    (node.class ? node.class + ' ' : '') + 'mindmap-node ' + ('section-' + section)
   );
   const bkgElem = nodeElem.append('g');
 
@@ -305,7 +303,7 @@ export const drawNode = function (elem, node, fullSection, conf) {
 };
 
 export const drawEdge = function drawEdge(edgesElem, mindmap, parent, depth, fullSection) {
-  const section = (fullSection % MAX_SECTIONS) - 1;
+  const section = fullSection % (MAX_SECTIONS - 1);
   const sx = parent.x + parent.width / 2;
   const sy = parent.y + parent.height / 2;
   const ex = mindmap.x + mindmap.width / 2;

packages/mermaid-timeline/package.json

@@ -1,58 +0,0 @@
-{
-  "name": "@mermaid-js/mermaid-timeline",
-  "version": "9.4.0",
-  "description": "Timeline diagram module for Mermaid.js.",
-  "module": "dist/mermaid-timeline.core.mjs",
-  "types": "dist/detector.d.ts",
-  "type": "module",
-  "exports": {
-    ".": {
-      "import": "./dist/mermaid-timeline.core.mjs",
-      "types": "./dist/detector.d.ts"
-    },
-    "./*": "./*"
-  },
-  "keywords": [
-    "diagram",
-    "markdown",
-    "timeline",
-    "mermaid"
-  ],
-  "scripts": {
-    "prepublishOnly": "pnpm -w run build"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/mermaid-js/mermaid"
-  },
-  "author": "Ashish Jain",
-  "license": "MIT",
-  "standard": {
-    "ignore": [
-      "**/parser/*.js",
-      "dist/**/*.js",
-      "cypress/**/*.js"
-    ],
-    "globals": [
-      "page"
-    ]
-  },
-  "dependencies": {
-    "d3": "^7.0.0",
-    "khroma": "^2.0.0"
-  },
-  "devDependencies": {
-    "concurrently": "^7.4.0",
-    "rimraf": "^3.0.2"
-  },
-  "resolutions": {
-    "d3": "^7.0.0"
-  },
-  "files": [
-    "dist"
-  ],
-  "sideEffects": [
-    "**/*.css",
-    "**/*.scss"
-  ]
-}

packages/mermaid-timeline/src/types/index.d.ts

@@ -1,7 +0,0 @@
-export {};
-
-declare global {
-  interface Window {
-    mermaid: any; // 👈️ turn off type checking
-  }
-}

packages/mermaid-timeline/tsconfig.json

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

packages/mermaid/src/diagram-api/diagram-orchestration.ts

@@ -1,5 +1,4 @@
 import { registerDiagram } from './diagramAPI';
-
 // @ts-ignore: TODO Fix ts errors
 import gitGraphParser from '../diagrams/git/parser/gitGraph';
 import { gitGraphDetector } from '../diagrams/git/gitGraphDetector';
@@ -97,6 +96,7 @@ import errorStyles from '../diagrams/error/styles';
 import flowchartElk from '../diagrams/flowchart/elk/detector';
 import { registerLazyLoadedDiagrams } from './detectType';
 
+import timelineDetector from '../diagrams/timeline/detector';
 let hasLoadedDiagrams = false;
 export const addDiagrams = () => {
   if (hasLoadedDiagrams) {
@@ -105,7 +105,7 @@ export const addDiagrams = () => {
   // This is added here to avoid race-conditions.
   // We could optimize the loading logic somehow.
   hasLoadedDiagrams = true;
-  registerLazyLoadedDiagrams(flowchartElk);
+  registerLazyLoadedDiagrams(flowchartElk, timelineDetector);
 
   registerDiagram(
     'error',

packages/mermaid/src/diagrams/timeline/detector.ts

@@ -1,4 +1,4 @@
-import type { ExternalDiagramDefinition } from 'mermaid';
+import type { ExternalDiagramDefinition } from '../../diagram-api/types';
 
 const id = 'timeline';
 

packages/mermaid/src/diagrams/timeline/timeline.spec.js

@@ -1,8 +1,8 @@
 import { parser as timeline } from './parser/timeline';
 import * as timelineDB from './timelineDb';
 import { injectUtils } from './mermaidUtils';
-import * as _commonDb from '../../mermaid/src/commonDb';
-import { parseDirective as _parseDirective } from '../../mermaid/src/directiveUtils';
+import * as _commonDb from '../../commonDb';
+import { parseDirective as _parseDirective } from '../../directiveUtils';
 
 import {
   log,
@@ -10,7 +10,7 @@ import {
   getConfig,
   sanitizeText,
   setupGraphViewBox,
-} from '../../mermaid/src/diagram-api/diagramAPI';
+} from '../../diagram-api/diagramAPI';
 
 injectUtils(
   log,

packages/mermaid/src/docs/.vitepress/theme/mermaid.ts

@@ -1,6 +1,6 @@
 import mermaid, { type MermaidConfig } from 'mermaid';
 import mindmap from '@mermaid-js/mermaid-mindmap';
-import timeline from '@mermaid-js/mermaid-timeline';
+// import timeline from '@mermaid-js/mermaid-timeline';
 
 const init = (async () => {
   try {

packages/mermaid/src/docs/syntax/timeline.md

@@ -10,7 +10,8 @@
 timeline
     title History of Social Media Platform
     2002 : LinkedIn
-    2004 : Facebook : Google
+    2004 : Facebook
+         : Google
     2005 : Youtube
     2006 : Twitter
 ```
@@ -290,16 +291,4 @@ Let's put them to use, and see how our sample diagram looks in different themes:
           2010 : Pinterest
 ```
 
-## Integrating with your library/website.
-
-Timeline uses the experimental lazy loading & async rendering features which could change in the future.
-
-```html
-<script type="module">
-  import mermaid from '<CDN_URL>/mermaid@<MERMAID_VERSION>/dist/mermaid.esm.min.mjs';
-  import timeline from '<CDN_URL>/@mermaid-js/mermaid-timeline@<MERMAID_VERSION>/dist/mermaid-timeline.esm.min.mjs';
-  await mermaid.registerExternalDiagrams([timeline]);
-</script>
-```
-
 You can also refer the implementation in the live editor [here](https://github.com/mermaid-js/mermaid-live-editor/blob/fcf53c98c25604c90a218104268c339be53035a6/src/lib/util/mermaid.ts) to see how the async loading is done.

packages/mermaid/src/docs/vite.config.ts

@@ -36,10 +36,10 @@ export default defineConfig({
         __dirname,
         '../../../mermaid-mindmap/dist/mermaid-mindmap.esm.min.mjs'
       ), // Use this one to build
-      '@mermaid-js/mermaid-timeline': path.join(
-        __dirname,
-        '../../../mermaid-timeline/dist/mermaid-timeline.esm.min.mjs'
-      ),
+      // '@mermaid-js/mermaid-timeline': path.join(
+      //   __dirname,
+      //   '../../../mermaid-timeline/dist/mermaid-timeline.esm.min.mjs'
+      // ),
     },
   },
   server: {

packages/mermaid/src/mermaid.ts

@@ -336,9 +336,9 @@ const registerExternalDiagrams = async (
   } else {
     await loadExternalDiagrams(...diagrams);
   }
-  externalDiagramsRegistered = true;
 };
 
+externalDiagramsRegistered = true;
 /**
  * ##contentLoaded Callback function that is called when page is loaded. This functions fetches
  * configuration for mermaid rendering and calls init for rendering the mermaid diagrams on the