mermaid-js / mermaid / 3702613472

import { addDetector } from './detectType';

import { log as _log, setLogLevel as _setLogLevel } from '../logger';

import { getConfig as _getConfig } from '../config';

import { sanitizeText as _sanitizeText } from '../diagrams/common/common';

import { setupGraphViewbox as _setupGraphViewbox } from '../setupGraphViewbox';

import { addStylesForDiagram } from '../styles';

import { DiagramDefinition, DiagramDetector } from './types';

/*

  Packaging and exposing resources for external diagrams so that they can import

  diagramAPI and have access to select parts of mermaid common code required to

  create diagrams working like the internal diagrams.

*/

export const log = _log;

export const setLogLevel = _setLogLevel;

export const getConfig = _getConfig;

export const sanitizeText = (text: string) => _sanitizeText(text, getConfig());

export const setupGraphViewbox = _setupGraphViewbox;

const diagrams: Record<string, DiagramDefinition> = {};

export interface Detectors {

  [key: string]: DiagramDetector;

}

/**

 * Registers the given diagram with Mermaid.

 *

 * Can be used for third-party custom diagrams.

 *

 * @param id - A unique ID for the given diagram.

 * @param diagram - The diagram definition.

 * @param detector - Function that returns `true` if a given mermaid text is this diagram definition.

 */

export const registerDiagram = (

  id: string,

  diagram: DiagramDefinition,

  detector?: DiagramDetector

) => {

  diagrams[id] = diagram;

  if (detector) {

    addDetector(id, detector);

  }

  addStylesForDiagram(id, diagram.styles);

};

export const getDiagram = (name: string): DiagramDefinition => {

  if (name in diagrams) {

    return diagrams[name];

  }

  throw new Error(`Diagram ${name} not found.`);

};