Expose registerDiagram() for non-lazyLoadedDiagrams

[aloisklink]

📑 Summary

Exposes the registerDiagram() function publicly as mermaid.mermaidAPI.registerDiagram so that users can add their own diagrams at bundle-time.

This is instead of using the lazyLoadedDiagrams config setting.

Resolves #3701

📏 Design Decisions

In order to get this working, I updated @mermaid-js/mermaid-mindmap so that you can now get both the id and detector by running import("@mermaid-js/mermaid-mindmap").

Example usage

import {
  diagram as mindmap,
  detector as mindmapDetector,
  id as mindmapId,
} from '@mermaid-js/mermaid-mindmap';
import {
  diagram as exampleDiagram,
  detector as exampleDiagramDetector,
  id as exampleDiagramId,
} from '@mermaid-js/mermaid-example-diagram';
import mermaid from 'mermaid';

mermaid.mermaidAPI.registerDiagram(mindmapId, mindmap, mindmapDetector);
mermaid.mermaidAPI.registerDiagram(exampleDiagramId, exampleDiagram, exampleDiagramDetector);
await mermaid.initialize({ logLevel: 0 });
await mermaid.initThrowsErrors();

Also, to make life slightly easier, registerDiagram no longer takes a callback. Instead, it checks whether the diagram contains an injectUtils function, and if it does, it uses that as the callback instead.

📋 Tasks

Make sure you

• 📖 have read the contribution guidelines
• 💻 have added unit/e2e tests (if appropriate)
• 🔖 targeted develop branch
  • This PR also merges cleanly with the release_9.2.0_buggfixes branch, in case we want to back-port this to v9.2.0 as well.

[knsv]

Nice work!

[sidharthv96]

Incorporated in #3774

[Billiam]

@sidharthv96 It seems like the change to actually export registerDiagram (https://github.com/mermaid-js/mermaid/pull/3710/files#diff-8f9cbf877a7595ee65c9cb40cbfd22234c40531a90ecccf1bb33c6ae0432edf1R484-R491) didn't make it in.

The spec for registerDiagram (using external-diagrams-mindmap.html) was added, but the html file is still using the original registerExternalDiagrams method instead: https://github.com/mermaid-js/mermaid/blob/master/cypress/platform/external-diagrams-mindmap.html#L44

Possibly failed conflict resolution?

[sidharthv96]

@Billiam It was a deliberate choice not to export registerDiagram. registerExternalDiagrams was added to support the functionality.

[Billiam]

Thanks! Sorry I missed that discussion