From 1d5378a4f29cc9b109ad742bf79c39002b66261f Mon Sep 17 00:00:00 2001
From: Aakansha Doshi <aakansha1216@gmail.com>
Date: Mon, 27 Nov 2023 13:19:31 +0530
Subject: [PATCH 1/7] fix: clean comments in text in getDiagramFromText API so
 flowchart works well

---
 demos/flowchart.html            | 6 +++++-
 packages/mermaid/src/Diagram.ts | 6 +++++-
 2 files changed, 10 insertions(+), 2 deletions(-)

diff --git a/demos/flowchart.html b/demos/flowchart.html
index d7032a663c..e6fdb6d2b7 100644
--- a/demos/flowchart.html
+++ b/demos/flowchart.html
@@ -1539,7 +1539,11 @@ <h3>flowchart</h3>
       class I bugged_node
     </pre>
     <hr />
-
+    <pre class="mermaid">
+      flowchart LR
+  %% this is a comment A -- text --> B{node}
+  A -- text --> B -- text2 --> C
+    </pre>
     <h1 id="link-clicked">Anchor for "link-clicked" test</h1>
 
     <script type="module">
diff --git a/packages/mermaid/src/Diagram.ts b/packages/mermaid/src/Diagram.ts
index 2b5ae89923..391df6ff9a 100644
--- a/packages/mermaid/src/Diagram.ts
+++ b/packages/mermaid/src/Diagram.ts
@@ -8,6 +8,8 @@ import { encodeEntities } from './utils.js';
 import type { DetailedError } from './utils.js';
 import type { DiagramDefinition, DiagramMetadata } from './diagram-api/types.js';
 
+import { cleanupComments } from './diagram-api/comments.js';
+
 export type ParseErrorFunction = (err: string | DetailedError | unknown, hash?: any) => void;
 
 /**
@@ -23,7 +25,7 @@ export class Diagram {
 
   private detectError?: UnknownDiagramError;
   constructor(public text: string, public metadata: Pick<DiagramMetadata, 'title'> = {}) {
-    this.text = encodeEntities(text);
+    this.text = encodeEntities(cleanupComments(text));
     this.text += '\n';
     const cnf = configApi.getConfig();
     try {
@@ -85,6 +87,8 @@ export const getDiagramFromText = async (
   metadata: Pick<DiagramMetadata, 'title'> = {}
 ): Promise<Diagram> => {
   const type = detectType(text, configApi.getConfig());
+  let title;
+
   try {
     // Trying to find the diagram
     getDiagram(type);

From 4a4d715270ee77062e3ba4aa7a13702f80997960 Mon Sep 17 00:00:00 2001
From: Aakansha Doshi <aakansha1216@gmail.com>
Date: Mon, 27 Nov 2023 13:25:13 +0530
Subject: [PATCH 2/7] remove unused variable

---
 packages/mermaid/src/Diagram.ts | 2 --
 1 file changed, 2 deletions(-)

diff --git a/packages/mermaid/src/Diagram.ts b/packages/mermaid/src/Diagram.ts
index 391df6ff9a..5f17d09927 100644
--- a/packages/mermaid/src/Diagram.ts
+++ b/packages/mermaid/src/Diagram.ts
@@ -87,8 +87,6 @@ export const getDiagramFromText = async (
   metadata: Pick<DiagramMetadata, 'title'> = {}
 ): Promise<Diagram> => {
   const type = detectType(text, configApi.getConfig());
-  let title;
-
   try {
     // Trying to find the diagram
     getDiagram(type);

From 7e119381e809eeebfb3b94d01e6acf9396f2ac2f Mon Sep 17 00:00:00 2001
From: Aakansha Doshi <aakansha1216@gmail.com>
Date: Mon, 27 Nov 2023 13:33:01 +0530
Subject: [PATCH 3/7] add test

---
 packages/mermaid/src/diagram.spec.ts | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/packages/mermaid/src/diagram.spec.ts b/packages/mermaid/src/diagram.spec.ts
index 4354f57bce..452ce9f07b 100644
--- a/packages/mermaid/src/diagram.spec.ts
+++ b/packages/mermaid/src/diagram.spec.ts
@@ -83,4 +83,14 @@ Expecting 'TXT', got 'NEWLINE'"
     expect(messages[0].message).toBe('I fl°°9829¶ß you!');
     expect(messages[1].message).toBe('I fl°°9829¶ß you fl°infin¶ß times more!');
   });
+
+  test('should clean up comments when present in diagram defination', async () => {
+    const diagram = await getDiagramFromText(
+      `flowchart LR
+    %% this is a comment A -- text --> B{node}
+    A -- text --> B -- text2 --> C`
+    );
+    expect(diagram).toBeInstanceOf(Diagram);
+    expect(diagram.type).toBe('flowchart-v2');
+  });
 });

From 4dbfa2f0d3952aae5b05626bde5ad514a89d2805 Mon Sep 17 00:00:00 2001
From: Aakansha Doshi <aakansha1216@gmail.com>
Date: Mon, 27 Nov 2023 16:11:25 +0530
Subject: [PATCH 4/7] review fixes

---
 demos/flowchart.html                 | 6 +-----
 packages/mermaid/src/diagram.spec.ts | 2 +-
 2 files changed, 2 insertions(+), 6 deletions(-)

diff --git a/demos/flowchart.html b/demos/flowchart.html
index e6fdb6d2b7..d7032a663c 100644
--- a/demos/flowchart.html
+++ b/demos/flowchart.html
@@ -1539,11 +1539,7 @@ <h3>flowchart</h3>
       class I bugged_node
     </pre>
     <hr />
-    <pre class="mermaid">
-      flowchart LR
-  %% this is a comment A -- text --> B{node}
-  A -- text --> B -- text2 --> C
-    </pre>
+
     <h1 id="link-clicked">Anchor for "link-clicked" test</h1>
 
     <script type="module">
diff --git a/packages/mermaid/src/diagram.spec.ts b/packages/mermaid/src/diagram.spec.ts
index 452ce9f07b..7a3daffbee 100644
--- a/packages/mermaid/src/diagram.spec.ts
+++ b/packages/mermaid/src/diagram.spec.ts
@@ -84,7 +84,7 @@ Expecting 'TXT', got 'NEWLINE'"
     expect(messages[1].message).toBe('I fl°°9829¶ß you fl°infin¶ß times more!');
   });
 
-  test('should clean up comments when present in diagram defination', async () => {
+  test('should clean up comments inside getDiagramFromText when present in diagram definition', async () => {
     const diagram = await getDiagramFromText(
       `flowchart LR
     %% this is a comment A -- text --> B{node}

From fe4485c55fc8167a43103985ffaf145aa8e4a08f Mon Sep 17 00:00:00 2001
From: Aakansha Doshi <aakansha1216@gmail.com>
Date: Tue, 28 Nov 2023 09:01:54 +0530
Subject: [PATCH 5/7] update mermaidAPI to cleanup the text before passing to
 getDiagramFromText

---
 packages/mermaid/src/Diagram.ts         |  4 +---
 packages/mermaid/src/diagram.spec.ts    | 10 ----------
 packages/mermaid/src/mermaidAPI.spec.ts | 13 +++++++++++++
 packages/mermaid/src/mermaidAPI.ts      |  9 +++++++--
 4 files changed, 21 insertions(+), 15 deletions(-)

diff --git a/packages/mermaid/src/Diagram.ts b/packages/mermaid/src/Diagram.ts
index 5f17d09927..2b5ae89923 100644
--- a/packages/mermaid/src/Diagram.ts
+++ b/packages/mermaid/src/Diagram.ts
@@ -8,8 +8,6 @@ import { encodeEntities } from './utils.js';
 import type { DetailedError } from './utils.js';
 import type { DiagramDefinition, DiagramMetadata } from './diagram-api/types.js';
 
-import { cleanupComments } from './diagram-api/comments.js';
-
 export type ParseErrorFunction = (err: string | DetailedError | unknown, hash?: any) => void;
 
 /**
@@ -25,7 +23,7 @@ export class Diagram {
 
   private detectError?: UnknownDiagramError;
   constructor(public text: string, public metadata: Pick<DiagramMetadata, 'title'> = {}) {
-    this.text = encodeEntities(cleanupComments(text));
+    this.text = encodeEntities(text);
     this.text += '\n';
     const cnf = configApi.getConfig();
     try {
diff --git a/packages/mermaid/src/diagram.spec.ts b/packages/mermaid/src/diagram.spec.ts
index 7a3daffbee..4354f57bce 100644
--- a/packages/mermaid/src/diagram.spec.ts
+++ b/packages/mermaid/src/diagram.spec.ts
@@ -83,14 +83,4 @@ Expecting 'TXT', got 'NEWLINE'"
     expect(messages[0].message).toBe('I fl°°9829¶ß you!');
     expect(messages[1].message).toBe('I fl°°9829¶ß you fl°infin¶ß times more!');
   });
-
-  test('should clean up comments inside getDiagramFromText when present in diagram definition', async () => {
-    const diagram = await getDiagramFromText(
-      `flowchart LR
-    %% this is a comment A -- text --> B{node}
-    A -- text --> B -- text2 --> C`
-    );
-    expect(diagram).toBeInstanceOf(Diagram);
-    expect(diagram.type).toBe('flowchart-v2');
-  });
 });
diff --git a/packages/mermaid/src/mermaidAPI.spec.ts b/packages/mermaid/src/mermaidAPI.spec.ts
index 32647ee625..7e8f46d06a 100644
--- a/packages/mermaid/src/mermaidAPI.spec.ts
+++ b/packages/mermaid/src/mermaidAPI.spec.ts
@@ -67,6 +67,7 @@ vi.mock('stylis', () => {
 });
 import { compile, serialize } from 'stylis';
 import { decodeEntities, encodeEntities } from './utils.js';
+import { Diagram } from './Diagram.js';
 
 /**
  * @see https://vitest.dev/guide/mocking.html Mock part of a module
@@ -744,4 +745,16 @@ describe('mermaidAPI', () => {
       });
     });
   });
+
+  describe('getDiagramFromText', () => {
+    it('should clean up comments when present in diagram definition', async () => {
+      const diagram = await mermaidAPI.getDiagramFromText(
+        `flowchart LR
+      %% this is a comment A -- text --> B{node}
+      A -- text --> B -- text2 --> C`
+      );
+      expect(diagram).toBeInstanceOf(Diagram);
+      expect(diagram.type).toBe('flowchart-v2');
+    });
+  });
 });
diff --git a/packages/mermaid/src/mermaidAPI.ts b/packages/mermaid/src/mermaidAPI.ts
index 09d0077803..65310d4fae 100644
--- a/packages/mermaid/src/mermaidAPI.ts
+++ b/packages/mermaid/src/mermaidAPI.ts
@@ -17,7 +17,7 @@ import { compile, serialize, stringify } from 'stylis';
 import { version } from '../package.json';
 import * as configApi from './config.js';
 import { addDiagrams } from './diagram-api/diagram-orchestration.js';
-import { Diagram, getDiagramFromText } from './Diagram.js';
+import { Diagram, getDiagramFromText as getDiagramFromTextInternal } from './Diagram.js';
 import errorRenderer from './diagrams/error/errorRenderer.js';
 import { attachFunctions } from './interactionDb.js';
 import { log, setLogLevel } from './logger.js';
@@ -28,7 +28,7 @@ import type { MermaidConfig } from './config.type.js';
 import { evaluate } from './diagrams/common/common.js';
 import isEmpty from 'lodash-es/isEmpty.js';
 import { setA11yDiagramInfo, addSVGa11yTitleDescription } from './accessibility.js';
-import type { DiagramStyleClassDef } from './diagram-api/types.js';
+import type { DiagramMetadata, DiagramStyleClassDef } from './diagram-api/types.js';
 import { preprocessDiagram } from './preprocess.js';
 import { decodeEntities } from './utils.js';
 
@@ -519,6 +519,11 @@ function initialize(options: MermaidConfig = {}) {
   addDiagrams();
 }
 
+const getDiagramFromText = (text: string, metadata: Pick<DiagramMetadata, 'title'> = {}) => {
+  const { code } = preprocessDiagram(text);
+  return getDiagramFromTextInternal(code, metadata);
+};
+
 /**
  * Add accessibility (a11y) information to the diagram.
  *

From 18bc2af570ea7857a752c8292e0acb5c086b75d7 Mon Sep 17 00:00:00 2001
From: ad1992 <ad1992@users.noreply.github.com>
Date: Tue, 28 Nov 2023 03:38:09 +0000
Subject: [PATCH 6/7] Update docs

---
 docs/config/setup/modules/mermaidAPI.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/config/setup/modules/mermaidAPI.md b/docs/config/setup/modules/mermaidAPI.md
index 6337807883..a1992c2254 100644
--- a/docs/config/setup/modules/mermaidAPI.md
+++ b/docs/config/setup/modules/mermaidAPI.md
@@ -96,7 +96,7 @@ mermaid.initialize(config);
 
 #### Defined in
 
-[mermaidAPI.ts:603](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L603)
+[mermaidAPI.ts:608](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L608)
 
 ## Functions
 

From 4ed7b2be0263333d46ec8bcedef065f3977fde4a Mon Sep 17 00:00:00 2001
From: Aakansha Doshi <aakansha1216@gmail.com>
Date: Tue, 28 Nov 2023 12:05:52 +0530
Subject: [PATCH 7/7] Add dummy commit to trigger GH checks

---
 packages/mermaid/src/mermaidAPI.spec.ts | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/packages/mermaid/src/mermaidAPI.spec.ts b/packages/mermaid/src/mermaidAPI.spec.ts
index 7e8f46d06a..b7ff578fbe 100644
--- a/packages/mermaid/src/mermaidAPI.spec.ts
+++ b/packages/mermaid/src/mermaidAPI.spec.ts
@@ -750,7 +750,7 @@ describe('mermaidAPI', () => {
     it('should clean up comments when present in diagram definition', async () => {
       const diagram = await mermaidAPI.getDiagramFromText(
         `flowchart LR
-      %% this is a comment A -- text --> B{node}
+      %% This is a comment A -- text --> B{node}
       A -- text --> B -- text2 --> C`
       );
       expect(diagram).toBeInstanceOf(Diagram);