/** * This is the api to be used when optionally handling the integration with the web page, instead of using the default integration provided by mermaid.js. * * The core of this api is the [**render**](https://github.com/knsv/mermaid/blob/master/docs/mermaidAPI.md#render) function which, given a graph * definition as text, renders the graph/diagram and returns an svg element for the graph. * * It is is then up to the user of the API to make use of the svg, either insert it somewhere in the page or do something completely different. * * In addition to the render function, a number of behavioral configuration options are available. * * @name mermaidAPI */ import { select } from 'd3'; import scope from 'scope-css'; import pkg from '../package.json'; import { setConfig, getConfig, setSiteConfig, getSiteConfig } from './config'; import { logger, setLogLevel } from './logger'; import utils, { assignWithDepth } from './utils'; import flowRenderer from './diagrams/flowchart/flowRenderer'; import flowRendererV2 from './diagrams/flowchart/flowRenderer-v2'; import flowParser from './diagrams/flowchart/parser/flow'; import flowDb from './diagrams/flowchart/flowDb'; import sequenceRenderer from './diagrams/sequence/sequenceRenderer'; import sequenceParser from './diagrams/sequence/parser/sequenceDiagram'; import sequenceDb from './diagrams/sequence/sequenceDb'; import ganttRenderer from './diagrams/gantt/ganttRenderer'; import ganttParser from './diagrams/gantt/parser/gantt'; import ganttDb from './diagrams/gantt/ganttDb'; import classRenderer from './diagrams/class/classRenderer'; import classParser from './diagrams/class/parser/classDiagram'; import classDb from './diagrams/class/classDb'; import stateRenderer from './diagrams/state/stateRenderer'; import stateRendererV2 from './diagrams/state/stateRenderer-v2'; import stateParser from './diagrams/state/parser/stateDiagram'; import stateDb from './diagrams/state/stateDb'; import gitGraphRenderer from './diagrams/git/gitGraphRenderer'; import gitGraphParser from './diagrams/git/parser/gitGraph'; import gitGraphAst from './diagrams/git/gitGraphAst'; import infoRenderer from './diagrams/info/infoRenderer'; import errorRenderer from './errorRenderer'; import infoParser from './diagrams/info/parser/info'; import infoDb from './diagrams/info/infoDb'; import pieRenderer from './diagrams/pie/pieRenderer'; import pieParser from './diagrams/pie/parser/pie'; import pieDb from './diagrams/pie/pieDb'; import erDb from './diagrams/er/erDb'; import erParser from './diagrams/er/parser/erDiagram'; import erRenderer from './diagrams/er/erRenderer'; import journeyParser from './diagrams/user-journey/parser/journey'; import journeyDb from './diagrams/user-journey/journeyDb'; import journeyRenderer from './diagrams/user-journey/journeyRenderer'; import configApi from './config'; const themes = {}; for (const themeName of ['default', 'forest', 'dark', 'neutral']) { themes[themeName] = require(`./themes/${themeName}/index.scss`); } function parse(text) { const graphInit = utils.detectInit(text); if (graphInit) { reinitialize(graphInit); logger.debug('reinit ', graphInit); } const graphType = utils.detectType(text); let parser; logger.debug('Type ' + graphType); switch (graphType) { case 'git': parser = gitGraphParser; parser.parser.yy = gitGraphAst; break; case 'flowchart': flowDb.clear(); parser = flowParser; parser.parser.yy = flowDb; break; case 'flowchart-v2': flowDb.clear(); parser = flowParser; parser.parser.yy = flowDb; break; case 'sequence': parser = sequenceParser; parser.parser.yy = sequenceDb; break; case 'gantt': parser = ganttParser; parser.parser.yy = ganttDb; break; case 'class': parser = classParser; parser.parser.yy = classDb; break; case 'state': parser = stateParser; parser.parser.yy = stateDb; break; case 'stateDiagram': parser = stateParser; parser.parser.yy = stateDb; break; case 'info': logger.debug('info info info'); parser = infoParser; parser.parser.yy = infoDb; break; case 'pie': logger.debug('pie'); parser = pieParser; parser.parser.yy = pieDb; break; case 'er': logger.debug('er'); parser = erParser; parser.parser.yy = erDb; break; case 'journey': logger.debug('Journey'); parser = journeyParser; parser.parser.yy = journeyDb; break; } parser.parser.yy.graphType = graphType; parser.parser.yy.parseError = (str, hash) => { const error = { str, hash }; throw error; }; parser.parse(text); return parser; } export const encodeEntities = function(text) { let txt = text; txt = txt.replace(/style.*:\S*#.*;/g, function(s) { const innerTxt = s.substring(0, s.length - 1); return innerTxt; }); txt = txt.replace(/classDef.*:\S*#.*;/g, function(s) { const innerTxt = s.substring(0, s.length - 1); return innerTxt; }); txt = txt.replace(/#\w+;/g, function(s) { const innerTxt = s.substring(1, s.length - 1); const isInt = /^\+?\d+$/.test(innerTxt); if (isInt) { return 'fl°°' + innerTxt + '¶ß'; } else { return 'fl°' + innerTxt + '¶ß'; } }); return txt; }; export const decodeEntities = function(text) { let txt = text; txt = txt.replace(/fl°°/g, function() { return ''; }); txt = txt.replace(/fl°/g, function() { return '&'; }); txt = txt.replace(/¶ß/g, function() { return ';'; }); return txt; }; /** * Function that renders an svg with a graph from a chart definition. Usage example below. * * ```js * mermaidAPI.initialize({ * startOnLoad:true * }); * $(function(){ * const graphDefinition = 'graph TB\na-->b'; * const cb = function(svgGraph){ * console.log(svgGraph); * }; * mermaidAPI.render('id1',graphDefinition,cb); * }); *``` * @param id the id of the element to be rendered * @param _txt the graph definition * @param cb callback which is called after rendering is finished with the svg code as inparam. * @param container selector to element in which a div with the graph temporarily will be inserted. In one is * provided a hidden div will be inserted in the body of the page instead. The element will be removed when rendering is * completed. */ const render = function(id, _txt, cb, container) { const cnf = getConfig(); // Check the maximum allowed text size let txt = _txt; if (_txt.length > cnf.maxTextSize) { txt = 'graph TB;a[Maximum text size in diagram exceeded];style a fill:#faa'; } const graphInit = utils.detectInit(txt); if (graphInit) { reinitialize(graphInit); assignWithDepth(cnf, getConfig()); } if (typeof container !== 'undefined') { container.innerHTML = ''; select(container) .append('div') .attr('id', 'd' + id) .attr('style', 'font-family: ' + cnf.fontFamily) .append('svg') .attr('id', id) .attr('width', '100%') .attr('xmlns', 'http://www.w3.org/2000/svg') .append('g'); } else { const existingSvg = document.getElementById(id); if (existingSvg) { existingSvg.remove(); } const element = document.querySelector('#' + 'd' + id); if (element) { element.remove(); } select('body') .append('div') .attr('id', 'd' + id) .append('svg') .attr('id', id) .attr('width', '100%') .attr('xmlns', 'http://www.w3.org/2000/svg') .append('g'); } window.txt = txt; txt = encodeEntities(txt); const element = select('#d' + id).node(); const graphType = utils.detectType(txt); // insert inline style into svg const svg = element.firstChild; const firstChild = svg.firstChild; // pre-defined theme let style = themes[cnf.theme]; if (style === undefined) { style = ''; } // user provided theme CSS if (cnf.themeCSS !== undefined) { style += `\n${cnf.themeCSS}`; } // user provided theme CSS if (cnf.fontFamily !== undefined) { style += `\n:root { --mermaid-font-family: ${cnf.fontFamily}}`; } // user provided theme CSS if (cnf.altFontFamily !== undefined) { style += `\n:root { --mermaid-alt-font-family: ${cnf.altFontFamily}}`; } // classDef if (graphType === 'flowchart' || graphType === 'flowchart-v2') { const classes = flowRenderer.getClasses(txt); for (const className in classes) { style += `\n.${className} > * { ${classes[className].styles.join( ' !important; ' )} !important; }`; if (classes[className].textStyles) { style += `\n.${className} tspan { ${classes[className].textStyles.join( ' !important; ' )} !important; }`; } } } const style1 = document.createElement('style'); style1.innerHTML = scope(style, `#${id}`); svg.insertBefore(style1, firstChild); const style2 = document.createElement('style'); const cs = window.getComputedStyle(svg); style2.innerHTML = `#${id} { color: ${cs.color}; font: ${cs.font}; }`; svg.insertBefore(style2, firstChild); try { switch (graphType) { case 'git': cnf.flowchart.arrowMarkerAbsolute = cnf.arrowMarkerAbsolute; gitGraphRenderer.setConf(cnf.git); gitGraphRenderer.draw(txt, id, false); break; case 'flowchart': cnf.flowchart.arrowMarkerAbsolute = cnf.arrowMarkerAbsolute; flowRenderer.setConf(cnf.flowchart); flowRenderer.draw(txt, id, false); break; case 'flowchart-v2': cnf.flowchart.arrowMarkerAbsolute = cnf.arrowMarkerAbsolute; flowRendererV2.setConf(cnf.flowchart); flowRendererV2.draw(txt, id, false); break; case 'sequence': cnf.sequence.arrowMarkerAbsolute = cnf.arrowMarkerAbsolute; if (cnf.sequenceDiagram) { // backwards compatibility sequenceRenderer.setConf(Object.assign(cnf.sequence, cnf.sequenceDiagram)); console.error( '`mermaid config.sequenceDiagram` has been renamed to `config.sequence`. Please update your mermaid config.' ); } else { sequenceRenderer.setConf(cnf.sequence); } sequenceRenderer.draw(txt, id); break; case 'gantt': cnf.gantt.arrowMarkerAbsolute = cnf.arrowMarkerAbsolute; ganttRenderer.setConf(cnf.gantt); ganttRenderer.draw(txt, id); break; case 'class': cnf.class.arrowMarkerAbsolute = cnf.arrowMarkerAbsolute; classRenderer.setConf(cnf.class); classRenderer.draw(txt, id); break; case 'state': cnf.class.arrowMarkerAbsolute = cnf.arrowMarkerAbsolute; stateRenderer.setConf(cnf.state); stateRenderer.draw(txt, id); break; case 'stateDiagram': cnf.class.arrowMarkerAbsolute = cnf.arrowMarkerAbsolute; stateRendererV2.setConf(cnf.state); stateRendererV2.draw(txt, id); break; case 'info': cnf.class.arrowMarkerAbsolute = cnf.arrowMarkerAbsolute; infoRenderer.setConf(cnf.class); infoRenderer.draw(txt, id, pkg.version); break; case 'pie': cnf.class.arrowMarkerAbsolute = cnf.arrowMarkerAbsolute; pieRenderer.setConf(cnf.class); pieRenderer.draw(txt, id, pkg.version); break; case 'er': erRenderer.setConf(cnf.er); erRenderer.draw(txt, id, pkg.version); break; case 'journey': journeyRenderer.setConf(cnf.journey); journeyRenderer.draw(txt, id, pkg.version); break; } } catch (e) { // errorRenderer.setConf(cnf.class); errorRenderer.draw(id, pkg.version); throw e; } select(`[id="${id}"]`) .selectAll('foreignobject > *') .attr('xmlns', 'http://www.w3.org/1999/xhtml'); // if (cnf.arrowMarkerAbsolute) { // url = // window.location.protocol + // '//' + // window.location.host + // window.location.pathname + // window.location.search; // url = url.replace(/\(/g, '\\('); // url = url.replace(/\)/g, '\\)'); // } // Fix for when the base tag is used let svgCode = select('#d' + id).node().innerHTML; logger.debug('cnf.arrowMarkerAbsolute', cnf.arrowMarkerAbsolute); if (!cnf.arrowMarkerAbsolute || cnf.arrowMarkerAbsolute === 'false') { svgCode = svgCode.replace(/marker-end="url\(.*?#/g, 'marker-end="url(#', 'g'); } svgCode = decodeEntities(svgCode); if (typeof cb !== 'undefined') { switch (graphType) { case 'flowchart': case 'flowchart-v2': cb(svgCode, flowDb.bindFunctions); break; case 'gantt': cb(svgCode, ganttDb.bindFunctions); break; case 'class': cb(svgCode, classDb.bindFunctions); break; default: cb(svgCode); } } else { logger.debug('CB = undefined!'); } const node = select('#d' + id).node(); if (node !== null && typeof node.remove === 'function') { select('#d' + id) .node() .remove(); } return svgCode; }; let currentDirective = {}; const parseDirective = function(statement, context, type) { try { if (statement !== undefined) { statement = statement.trim(); switch (context) { case 'open_directive': currentDirective = {}; break; case 'type_directive': currentDirective.type = statement.toLowerCase(); break; case 'arg_directive': currentDirective.args = JSON.parse(statement); break; case 'close_directive': handleDirective(currentDirective, type); currentDirective = null; break; } } } catch (error) { logger.error( `Error while rendering sequenceDiagram directive: ${statement} jison context: ${context}` ); logger.error(error.message); } }; const handleDirective = function(directive, type) { logger.debug(`Directive type=${directive.type} with args:`, directive.args); switch (directive.type) { case 'init': case 'initialize': { ['config'].forEach(prop => { if (typeof directive.args[prop] !== 'undefined') { if (type === 'flowchart-v2') { type = 'flowchart'; } directive.args[type] = directive.args[prop]; delete directive.args[prop]; } }); reinitialize(directive.args); break; } case 'wrap': case 'nowrap': directive.args = { config: { wrap: directive.type === 'wrap' } }; ['config'].forEach(prop => { if (typeof directive.args[prop] !== 'undefined') { if (type === 'flowchart-v2') { type = 'flowchart'; } directive.args[type] = directive.args[prop]; delete directive.args[prop]; } }); reinitialize(directive.args); break; default: logger.warn( `Unhandled directive: source: '%%{${directive.type}: ${JSON.stringify( directive.args ? directive.args : {} )}}%%`, directive ); break; } }; function updateRendererConfigs(conf) { gitGraphRenderer.setConf(conf.git); flowRenderer.setConf(conf.flowchart); flowRendererV2.setConf(conf.flowchart); if (typeof conf['sequenceDiagram'] !== 'undefined') { sequenceRenderer.setConf(assignWithDepth(conf.sequence, conf['sequenceDiagram'])); } sequenceRenderer.setConf(conf.sequence); ganttRenderer.setConf(conf.gantt); classRenderer.setConf(conf.class); stateRenderer.setConf(conf.state); stateRendererV2.setConf(conf.state); infoRenderer.setConf(conf.class); pieRenderer.setConf(conf.class); erRenderer.setConf(conf.er); journeyRenderer.setConf(conf.journey); errorRenderer.setConf(conf.class); } function reinitialize(options) { console.log(`mermaidAPI.reinitialize: v${pkg.version}`, options); // Set default options const config = typeof options === 'object' ? setConfig(options) : getSiteConfig(); updateRendererConfigs(config); setLogLevel(config.logLevel); logger.debug('mermaidAPI.reinitialize: ', config); } function initialize(options) { // console.log(`mermaidAPI.initialize: v${pkg.version}`); // Set default options const config = typeof options === 'object' ? setSiteConfig(options) : getSiteConfig(); updateRendererConfigs(config); setLogLevel(config.logLevel); logger.debug('mermaidAPI.initialize: ', config); } // function getConfig () { // console.warn('get config') // return config // } const mermaidAPI = Object.freeze({ render, parse, parseDirective, initialize, reinitialize, getConfig, getSiteConfig, reset: () => { // console.warn('reset'); configApi.reset(); const siteConfig = getSiteConfig(); updateRendererConfigs(siteConfig); }, globalReset: () => { configApi.reset(configApi.defaultConfig); updateRendererConfigs(getConfig()); }, defaultConfig: configApi.defaultConfig }); setLogLevel(getConfig().logLevel); configApi.reset(getConfig()); export default mermaidAPI; /** * ## mermaidAPI configuration defaults *
* * <script> * var config = { * theme:'default', * logLevel:'fatal', * securityLevel:'strict', * startOnLoad:true, * arrowMarkerAbsolute:false, * * flowchart:{ * htmlLabels:true, * curve:'linear', * }, * sequence:{ * diagramMarginX:50, * diagramMarginY:10, * actorMargin:50, * width:150, * height:65, * boxMargin:10, * boxTextMargin:5, * noteMargin:10, * messageMargin:35, * messageAlign:'center', * mirrorActors:true, * bottomMarginAdj:1, * useMaxWidth:true, * rightAngles:false, * showSequenceNumbers:false, * }, * gantt:{ * titleTopMargin:25, * barHeight:20, * barGap:4, * topPadding:50, * leftPadding:75, * gridLineStartPadding:35, * fontSize:11, * fontFamily:'"Open-Sans", "sans-serif"', * numberSectionStyles:4, * axisFormat:'%Y-%m-%d', * } * }; * mermaid.initialize(config); * </script> **/