feat: JSON format representation of diagram is returned in render fun…

[dhananjaydeshmukhperforce]

📑 Summary

Intention of this PR is to export json format representation of mermaid diagram.

This PR supports JSON format representation for following types of diagrams

1. Class Diagram
2. ER Diagram
3. Flowchart Diagram
4. Sequence Diagram
5. State Diagram

Resolves

https://github.com/orgs/mermaid-js/discussions/6094

[changeset-bot]

⚠️ No Changeset found

Latest commit: a0c4d34

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[netlify]

✅ Deploy Preview for mermaid-js ready!

Name	Link
🔨 Latest commit	a0c4d34
🔍 Latest deploy log	https://app.netlify.com/sites/mermaid-js/deploys/67480cee49a48400087d5331
😎 Deploy Preview	https://deploy-preview-6095--mermaid-js.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[pkg-pr-new]

Open in Stackblitz

npm i https://pkg.pr.new/mermaid-js/mermaid@6095

npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/mermaid-zenuml@6095

npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/parser@6095

npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/layout-elk@6095

commit: a0c4d34

[codecov]

Codecov Report

Attention: Patch coverage is 0% with 50 lines in your changes missing coverage. Please review.

Project coverage is 4.48%. Comparing base (df636c6) to head (a0c4d34).

Files with missing lines	Patch %	Lines
packages/mermaid/src/Diagram.ts	0.00%	11 Missing ⚠️
.../mermaid/src/diagrams/sequence/sequenceRenderer.ts	0.00%	9 Missing ⚠️
packages/mermaid/src/rendering-util/render.ts	0.00%	9 Missing ⚠️
...rc/rendering-util/layout-algorithms/dagre/index.js	0.00%	7 Missing ⚠️
packages/mermaid/src/diagrams/er/erRenderer.js	0.00%	5 Missing ⚠️
...ges/mermaid/src/diagrams/class/classRenderer-v2.ts	0.00%	4 Missing ⚠️
packages/mermaid/src/mermaidAPI.ts	0.00%	2 Missing ⚠️
...aid/src/diagrams/class/classRenderer-v3-unified.ts	0.00%	1 Missing ⚠️
.../src/diagrams/flowchart/flowRenderer-v3-unified.ts	0.00%	1 Missing ⚠️
...aid/src/diagrams/state/stateRenderer-v3-unified.ts	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           develop   #6095      +/-   ##
==========================================
- Coverage     4.48%   4.48%   -0.01%     
==========================================
  Files          383     383              
  Lines        54038   54078      +40     
  Branches       596     596              
==========================================
  Hits          2425    2425              
- Misses       51613   51653      +40     

Flag	Coverage Δ
unit	4.48% <0.00%> (-0.01%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
...aid/src/diagrams/class/classRenderer-v3-unified.ts	0.00% <0.00%> (ø)
.../src/diagrams/flowchart/flowRenderer-v3-unified.ts	0.00% <0.00%> (ø)
...aid/src/diagrams/state/stateRenderer-v3-unified.ts	0.00% <0.00%> (ø)
packages/mermaid/src/mermaidAPI.ts	0.00% <0.00%> (ø)
...ges/mermaid/src/diagrams/class/classRenderer-v2.ts	0.00% <0.00%> (ø)
packages/mermaid/src/diagrams/er/erRenderer.js	0.00% <0.00%> (ø)
...rc/rendering-util/layout-algorithms/dagre/index.js	0.00% <0.00%> (ø)
.../mermaid/src/diagrams/sequence/sequenceRenderer.ts	0.00% <0.00%> (ø)
packages/mermaid/src/rendering-util/render.ts	0.00% <0.00%> (ø)
packages/mermaid/src/Diagram.ts	0.00% <0.00%> (ø)

[perseveringman]

@knsv @sidharthv96 @Yokozuna59 This pr is able to solve the problem of not being able to get the data structure of the layout information, but has not been able to get the merge, this problem has been bothering me for a long time, and I have been using the fork way of data conversion, is the team currently considering solving this problem, or is it because there is already a program being implemented? I would like to get a response to this question, thank you very much!

[sidharthv96]

@perseveringman there is already a different approach for unifying rendering data that's being implemented. This approach adds a new dependency, and does extra processing while rendering, without any benefit for the majority of the end users.

I would suggest you to continue using the fork, until the new approach is implemented for all these diagrams.

If you could share your usecase, we could see if we can tweak data4Layout to support that as well.