marcel/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-10-12 18:49:37 +02:00
Code Issues Packages Projects Releases Wiki Activity

fix: Change return type from parse

Browse Source
This commit is contained in:
Sidharth Vinod
2024-09-10 14:18:34 +05:30
parent 638be1992d
commit 5ab955b6b3
1 changed files with 12 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
packages/mermaid/src/mermaid.ts
View File

@@ -2,18 +2,18 @@
* Web page integration module for the mermaid framework. It uses the mermaidAPI for mermaid * Web page integration module for the mermaid framework. It uses the mermaidAPI for mermaid
* functionality and to render the diagrams to svg code! * functionality and to render the diagrams to svg code!
*/ */
import { registerIconPacks } from './rendering-util/icons.js';
import { dedent } from 'ts-dedent'; import { dedent } from 'ts-dedent';
import type { MermaidConfig } from './config.type.js'; import type { MermaidConfig } from './config.type.js';
import { detectType, registerLazyLoadedDiagrams } from './diagram-api/detectType.js'; import { detectType, registerLazyLoadedDiagrams } from './diagram-api/detectType.js';
import { addDiagrams } from './diagram-api/diagram-orchestration.js'; import { addDiagrams } from './diagram-api/diagram-orchestration.js';
import { loadRegisteredDiagrams } from './diagram-api/loadDiagram.js'; import { loadRegisteredDiagrams } from './diagram-api/loadDiagram.js';
import type { ExternalDiagramDefinition, SVG, SVGGroup } from './diagram-api/types.js'; import type { ExternalDiagramDefinition, SVG, SVGGroup } from './diagram-api/types.js';
import type { Diagram, ParseErrorFunction } from './Diagram.js'; import type { ParseErrorFunction } from './Diagram.js';
import type { UnknownDiagramError } from './errors.js'; import type { UnknownDiagramError } from './errors.js';
import type { InternalHelpers } from './internals.js'; import type { InternalHelpers } from './internals.js';
import { log } from './logger.js'; import { log } from './logger.js';
import { mermaidAPI } from './mermaidAPI.js'; import { mermaidAPI } from './mermaidAPI.js';
import { registerIconPacks } from './rendering-util/icons.js';
import type { LayoutLoaderDefinition, RenderOptions } from './rendering-util/render.js'; import type { LayoutLoaderDefinition, RenderOptions } from './rendering-util/render.js';
import { registerLayoutLoaders } from './rendering-util/render.js'; import { registerLayoutLoaders } from './rendering-util/render.js';
import type { LayoutData } from './rendering-util/types.js'; import type { LayoutData } from './rendering-util/types.js';
@@ -321,7 +321,9 @@ const executeQueue = async () => {
executionQueueRunning = false; executionQueueRunning = false;
}; };
interface ConfigTuple { interface ParseResultWithConfigs extends Omit<ParseResult, 'config'> {
/** Config the user has defined in the text as frontmatter or directives */
userConfig: MermaidConfig;
defaultConfig: MermaidConfig; defaultConfig: MermaidConfig;
config: MermaidConfig; config: MermaidConfig;
} }
@@ -347,7 +349,7 @@ interface ConfigTuple {
const parse = async ( const parse = async (
text: string, text: string,
parseOptions?: ParseOptions parseOptions?: ParseOptions
): Promise<boolean | void | (Diagram & ConfigTuple)> => { ): Promise<boolean | void | ParseResultWithConfigs> => {
return new Promise((resolve, reject) => { return new Promise((resolve, reject) => {
// This promise will resolve when the render call is done. // This promise will resolve when the render call is done.
// It will be queued first and will be executed when it is first in line // It will be queued first and will be executed when it is first in line
@@ -355,9 +357,12 @@ const parse = async (
new Promise((res, rej) => { new Promise((res, rej) => {
mermaidAPI.parse(text, parseOptions).then( mermaidAPI.parse(text, parseOptions).then(
(r) => { (r) => {
const result = r as Diagram & ConfigTuple; const result = {
result.defaultConfig = mermaidAPI.defaultConfig; diagram: r.diagram,
result.config = mermaidAPI.getConfig(); userConfig: r.config,
defaultConfig: mermaidAPI.defaultConfig,
config: mermaidAPI.getConfig(),
} satisfies ParseResultWithConfigs;
// This resolves for the promise for the queue handling // This resolves for the promise for the queue handling
res(result); res(result);
// This fulfills the promise sent to the value back to the original caller // This fulfills the promise sent to the value back to the original caller