From 10562e72f4340464f113feb45ce18d0f794fa45f Mon Sep 17 00:00:00 2001 From: yari-dewalt Date: Tue, 8 Oct 2024 08:12:42 -0700 Subject: [PATCH 001/242] Initial update to new renderer --- packages/mermaid/src/config.type.ts | 2 + packages/mermaid/src/diagrams/er/erDb.js | 103 -------- packages/mermaid/src/diagrams/er/erDb.ts | 240 ++++++++++++++++++ packages/mermaid/src/diagrams/er/erDiagram.ts | 2 +- .../src/diagrams/er/erRenderer-unified.ts | 46 ++++ packages/mermaid/src/diagrams/er/erTypes.ts | 37 +++ packages/mermaid/src/diagrams/er/styles.js | 33 ++- .../mermaid/src/schemas/config.schema.yaml | 8 + 8 files changed, 364 insertions(+), 107 deletions(-) delete mode 100644 packages/mermaid/src/diagrams/er/erDb.js create mode 100644 packages/mermaid/src/diagrams/er/erDb.ts create mode 100644 packages/mermaid/src/diagrams/er/erRenderer-unified.ts create mode 100644 packages/mermaid/src/diagrams/er/erTypes.ts diff --git a/packages/mermaid/src/config.type.ts b/packages/mermaid/src/config.type.ts index 035a158e0..cd8401d7c 100644 --- a/packages/mermaid/src/config.type.ts +++ b/packages/mermaid/src/config.type.ts @@ -793,6 +793,8 @@ export interface ErDiagramConfig extends BaseDiagramConfig { * */ entityPadding?: number; + nodeSpacing?: number; + rankSpacing?: number; /** * Stroke color of box edges and lines. */ diff --git a/packages/mermaid/src/diagrams/er/erDb.js b/packages/mermaid/src/diagrams/er/erDb.js deleted file mode 100644 index f24f48198..000000000 --- a/packages/mermaid/src/diagrams/er/erDb.js +++ /dev/null @@ -1,103 +0,0 @@ -import { log } from '../../logger.js'; -import { getConfig } from '../../diagram-api/diagramAPI.js'; - -import { - setAccTitle, - getAccTitle, - getAccDescription, - setAccDescription, - clear as commonClear, - setDiagramTitle, - getDiagramTitle, -} from '../common/commonDb.js'; - -let entities = new Map(); -let relationships = []; - -const Cardinality = { - ZERO_OR_ONE: 'ZERO_OR_ONE', - ZERO_OR_MORE: 'ZERO_OR_MORE', - ONE_OR_MORE: 'ONE_OR_MORE', - ONLY_ONE: 'ONLY_ONE', - MD_PARENT: 'MD_PARENT', -}; - -const Identification = { - NON_IDENTIFYING: 'NON_IDENTIFYING', - IDENTIFYING: 'IDENTIFYING', -}; -/** - * Add entity - * @param {string} name - The name of the entity - * @param {string | undefined} alias - The alias of the entity - */ -const addEntity = function (name, alias = undefined) { - if (!entities.has(name)) { - entities.set(name, { attributes: [], alias }); - log.info('Added new entity :', name); - } else if (!entities.get(name).alias && alias) { - entities.get(name).alias = alias; - log.info(`Add alias '${alias}' to entity '${name}'`); - } - - return entities.get(name); -}; - -const getEntities = () => entities; - -const addAttributes = function (entityName, attribs) { - let entity = addEntity(entityName); // May do nothing (if entity has already been added) - - // Process attribs in reverse order due to effect of recursive construction (last attribute is first) - let i; - for (i = attribs.length - 1; i >= 0; i--) { - entity.attributes.push(attribs[i]); - log.debug('Added attribute ', attribs[i].attributeName); - } -}; - -/** - * Add a relationship - * - * @param entA The first entity in the relationship - * @param rolA The role played by the first entity in relation to the second - * @param entB The second entity in the relationship - * @param rSpec The details of the relationship between the two entities - */ -const addRelationship = function (entA, rolA, entB, rSpec) { - let rel = { - entityA: entA, - roleA: rolA, - entityB: entB, - relSpec: rSpec, - }; - - relationships.push(rel); - log.debug('Added new relationship :', rel); -}; - -const getRelationships = () => relationships; - -const clear = function () { - entities = new Map(); - relationships = []; - commonClear(); -}; - -export default { - Cardinality, - Identification, - getConfig: () => getConfig().er, - addEntity, - addAttributes, - getEntities, - addRelationship, - getRelationships, - clear, - setAccTitle, - getAccTitle, - setAccDescription, - getAccDescription, - setDiagramTitle, - getDiagramTitle, -}; diff --git a/packages/mermaid/src/diagrams/er/erDb.ts b/packages/mermaid/src/diagrams/er/erDb.ts new file mode 100644 index 000000000..c8ea3136c --- /dev/null +++ b/packages/mermaid/src/diagrams/er/erDb.ts @@ -0,0 +1,240 @@ +import { log } from '../../logger.js'; +import { getConfig } from '../../diagram-api/diagramAPI.js'; +import type { Edge, Node } from '../../rendering-util/types.js'; +import type { EntityNode, Attribute, Relationship, EntityClass, RelSpec } from './erTypes.js'; + +import { + setAccTitle, + getAccTitle, + getAccDescription, + setAccDescription, + clear as commonClear, + setDiagramTitle, + getDiagramTitle, +} from '../common/commonDb.js'; +import { getEdgeId } from '../../utils.js'; + +let entities = new Map(); +let relationships: Relationship[] = []; +let classes = new Map(); +let direction = 'TB'; + +const Cardinality = { + ZERO_OR_ONE: 'ZERO_OR_ONE', + ZERO_OR_MORE: 'ZERO_OR_MORE', + ONE_OR_MORE: 'ONE_OR_MORE', + ONLY_ONE: 'ONLY_ONE', + MD_PARENT: 'MD_PARENT', +}; + +const Identification = { + NON_IDENTIFYING: 'NON_IDENTIFYING', + IDENTIFYING: 'IDENTIFYING', +}; +/** + * Add entity + * @param name - The name of the entity + * @param alias - The alias of the entity + */ +const addEntity = function (name: string, alias = ''): EntityNode { + if (!entities.has(name)) { + entities.set(name, { + id: `entity-${name}-${entities.size}`, + label: name, + attributes: [], + alias, + shape: 'erBox', + look: getConfig().look || 'default', + cssClasses: [], + cssStyles: [], + }); + log.info('Added new entity :', name); + } else if (!entities.get(name)?.alias && alias) { + entities.get(name)!.alias = alias; + log.info(`Add alias '${alias}' to entity '${name}'`); + } + + return entities.get(name)!; +}; + +const getEntity = function (name: string) { + return entities.get(name); +}; + +const getEntities = () => entities; + +const getClasses = () => classes; + +const addAttributes = function (entityName: string, attribs: Attribute[]) { + const entity = addEntity(entityName); // May do nothing (if entity has already been added) + + // Process attribs in reverse order due to effect of recursive construction (last attribute is first) + let i; + for (i = attribs.length - 1; i >= 0; i--) { + if (!attribs[i].keys) { + attribs[i].keys = []; + } + if (!attribs[i].comment) { + attribs[i].comment = ''; + } + entity.attributes.push(attribs[i]); + log.debug('Added attribute ', attribs[i].name); + } +}; + +/** + * Add a relationship + * + * @param entA - The first entity in the relationship + * @param rolA - The role played by the first entity in relation to the second + * @param entB - The second entity in the relationship + * @param rSpec - The details of the relationship between the two entities + */ +const addRelationship = function (entA: string, rolA: string, entB: string, rSpec: RelSpec) { + const entityA = entities.get(entA); + const entityB = entities.get(entB); + if (!entityA || !entityB) { + return; + } + + const rel = { + entityA: entityA.id, + roleA: rolA, + entityB: entityB.id, + relSpec: rSpec, + }; + + relationships.push(rel); + log.debug('Added new relationship :', rel); +}; + +const getRelationships = () => relationships; + +const getDirection = () => direction; +const setDirection = (dir: string) => { + direction = dir; +}; + +const clear = function () { + entities = new Map(); + classes = new Map(); + relationships = []; + commonClear(); +}; + +export const getData = function () { + const nodes: Node[] = []; + const edges: Edge[] = []; + const config = getConfig(); + + for (const entityKey of entities.keys()) { + const entityNode = entities.get(entityKey); + if (entityNode) { + entityNode.cssCompiledStyles = getCompiledStyles(entityNode.cssClasses!); + nodes.push(entityNode as unknown as Node); + } + } + + let cnt = 0; + for (const relationship of relationships) { + const edge: Edge = { + id: getEdgeId(relationship.entityA, relationship.entityB, { prefix: 'id', counter: cnt++ }), + type: 'normal', + start: relationship.entityA, + end: relationship.entityB, + label: relationship.roleA, + labelpos: 'c', + thickness: 'normal', + classes: 'relationshipLine', + arrowTypeStart: relationship.relSpec.cardB.toLowerCase(), + arrowTypeEnd: relationship.relSpec.cardA.toLowerCase(), + pattern: relationship.relSpec.relType == 'IDENTIFYING' ? 'solid' : 'dashed', + look: config.look, + }; + edges.push(edge); + } + return { nodes, edges, other: {}, config, direction: 'TB' }; +}; + +export const addCssStyles = function (ids: string[], styles: string[]) { + for (const id of ids) { + const entity = entities.get(id); + if (!styles || !entity) { + return; + } + for (const style of styles) { + entity.cssStyles!.push(style); + } + } +}; + +export const addClass = function (ids: string[], style: string[]) { + ids.forEach(function (id) { + let classNode = classes.get(id); + if (classNode === undefined) { + classNode = { id, styles: [], textStyles: [] }; + classes.set(id, classNode); + } + + if (style) { + style.forEach(function (s) { + if (/color/.exec(s)) { + const newStyle = s.replace('fill', 'bgFill'); // .replace('color', 'fill'); + classNode.textStyles.push(newStyle); + } + classNode.styles.push(s); + }); + } + }); +}; + +export const setClass = function (ids: string[], classNames: string[]) { + for (const id of ids) { + const entity = entities.get(id); + if (entity) { + for (const className of classNames) { + entity.cssClasses!.push(className); + } + } + } +}; + +function getCompiledStyles(classDefs: string[]) { + let compiledStyles: string[] = []; + for (const customClass of classDefs) { + const cssClass = classes.get(customClass); + if (cssClass?.styles) { + compiledStyles = [...compiledStyles, ...(cssClass.styles ?? [])].map((s) => s.trim()); + } + if (cssClass?.textStyles) { + compiledStyles = [...compiledStyles, ...(cssClass.textStyles ?? [])].map((s) => s.trim()); + } + } + return compiledStyles; +} + +export default { + Cardinality, + Identification, + getConfig: () => getConfig().er, + addEntity, + addAttributes, + getEntities, + getEntity, + getClasses, + addRelationship, + getRelationships, + clear, + getDirection, + setDirection, + setAccTitle, + getAccTitle, + setAccDescription, + getAccDescription, + setDiagramTitle, + getDiagramTitle, + getData, + addCssStyles, + addClass, + setClass, +}; diff --git a/packages/mermaid/src/diagrams/er/erDiagram.ts b/packages/mermaid/src/diagrams/er/erDiagram.ts index adfa525fc..1647f181b 100644 --- a/packages/mermaid/src/diagrams/er/erDiagram.ts +++ b/packages/mermaid/src/diagrams/er/erDiagram.ts @@ -1,7 +1,7 @@ // @ts-ignore: TODO: Fix ts errors import erParser from './parser/erDiagram.jison'; import erDb from './erDb.js'; -import erRenderer from './erRenderer.js'; +import erRenderer from './erRenderer-unified.js'; import erStyles from './styles.js'; export const diagram = { diff --git a/packages/mermaid/src/diagrams/er/erRenderer-unified.ts b/packages/mermaid/src/diagrams/er/erRenderer-unified.ts new file mode 100644 index 000000000..be668df69 --- /dev/null +++ b/packages/mermaid/src/diagrams/er/erRenderer-unified.ts @@ -0,0 +1,46 @@ +import { getConfig } from '../../diagram-api/diagramAPI.js'; +import { log } from '../../logger.js'; +import { getDiagramElement } from '../../rendering-util/insertElementsForSize.js'; +import { getRegisteredLayoutAlgorithm, render } from '../../rendering-util/render.js'; +import { setupViewPortForSVG } from '../../rendering-util/setupViewPortForSVG.js'; +import type { LayoutData } from '../../rendering-util/types.js'; +import db from './erDb.js'; +import utils from '../../utils.js'; + +export const draw = async function (text: string, id: string, _version: string, diag: any) { + log.info('REF0:'); + log.info('Drawing er diagram (unified)', id); + const { securityLevel, er: conf, layout } = getConfig(); + + // The getData method provided in all supported diagrams is used to extract the data from the parsed structure + // into the Layout data format + const data4Layout = diag.db.getData() as LayoutData; + + // Create the root SVG - the element is the div containing the SVG element + const svg = getDiagramElement(id, securityLevel); + + data4Layout.type = diag.type; + data4Layout.layoutAlgorithm = getRegisteredLayoutAlgorithm(layout); + + // Workaround as when rendering and setting up the graph it uses flowchart spacing before data4Layout spacing? + data4Layout.config.flowchart!.nodeSpacing = conf?.nodeSpacing || 140; + data4Layout.config.flowchart!.rankSpacing = conf?.rankSpacing || 80; + data4Layout.direction = db.getDirection(); + + data4Layout.markers = ['only_one', 'zero_or_one', 'one_or_more', 'zero_or_more']; + data4Layout.diagramId = id; + await render(data4Layout, svg); + const padding = 8; + utils.insertTitle( + svg, + 'erDiagramTitleText', + conf?.titleTopMargin ?? 25, + diag.db.getDiagramTitle() + ); + + setupViewPortForSVG(svg, padding, 'erDiagram', conf?.useMaxWidth ?? true); +}; + +export default { + draw, +}; diff --git a/packages/mermaid/src/diagrams/er/erTypes.ts b/packages/mermaid/src/diagrams/er/erTypes.ts new file mode 100644 index 000000000..7670302f0 --- /dev/null +++ b/packages/mermaid/src/diagrams/er/erTypes.ts @@ -0,0 +1,37 @@ +export interface EntityNode { + id: string; + label: string; + attributes: Attribute[]; + alias: string; + shape: string; + look?: string; + cssClasses?: string[]; + cssStyles?: string[]; + cssCompiledStyles?: string[]; +} + +export interface Attribute { + type: string; + name: string; + keys: ('PK' | 'FK' | 'UK')[]; + comment: string; +} + +export interface Relationship { + entityA: string; + roleA: string; + entityB: string; + relSpec: RelSpec; +} + +export interface RelSpec { + cardA: string; + cardB: string; + relType: string; +} + +export interface EntityClass { + id: string; + styles: string[]; + textStyles: string[]; +} diff --git a/packages/mermaid/src/diagrams/er/styles.js b/packages/mermaid/src/diagrams/er/styles.js index 08ea2e851..45a9dd7ec 100644 --- a/packages/mermaid/src/diagrams/er/styles.js +++ b/packages/mermaid/src/diagrams/er/styles.js @@ -24,9 +24,36 @@ const getStyles = (options) => } } - .relationshipLine { - stroke: ${options.lineColor}; - } + .edgeLabel .label { + fill: ${options.nodeBorder}; + font-size: 14px; + } + + .edgeLabel .label .labelBkg { + background: ${options.mainBkg}; + } + + .node rect, + .node circle, + .node ellipse, + .node polygon, + .node path { + fill: ${options.mainBkg}; + stroke: ${options.nodeBorder}; + stroke-width: 1px; + } + + .relationshipLine { + stroke: ${options.lineColor}; + stroke-width: 1; + fill: none; + } + + .marker { + fill: none !important; + stroke: ${options.lineColor} !important; + stroke-width: 1; + } .entityTitleText { text-anchor: middle; diff --git a/packages/mermaid/src/schemas/config.schema.yaml b/packages/mermaid/src/schemas/config.schema.yaml index a7b3549eb..980561084 100644 --- a/packages/mermaid/src/schemas/config.schema.yaml +++ b/packages/mermaid/src/schemas/config.schema.yaml @@ -1280,6 +1280,14 @@ $defs: # JSON Schema definition (maybe we should move these to a separate file) type: integer default: 15 minimum: 0 + nodeSpacing: + type: integer + default: 140 + minimum: 0 + rankSpacing: + type: integer + default: 80 + minimum: 0 stroke: description: Stroke color of box edges and lines. type: string From f2f1ad46055de83607b9c6683a353e87d68028e8 Mon Sep 17 00:00:00 2001 From: yari-dewalt Date: Tue, 8 Oct 2024 08:22:34 -0700 Subject: [PATCH 002/242] Add erBox shape --- .../rendering-elements/shapes/erBox.ts | 319 ++++++++++++++++++ 1 file changed, 319 insertions(+) create mode 100644 packages/mermaid/src/rendering-util/rendering-elements/shapes/erBox.ts diff --git a/packages/mermaid/src/rendering-util/rendering-elements/shapes/erBox.ts b/packages/mermaid/src/rendering-util/rendering-elements/shapes/erBox.ts new file mode 100644 index 000000000..2c812b862 --- /dev/null +++ b/packages/mermaid/src/rendering-util/rendering-elements/shapes/erBox.ts @@ -0,0 +1,319 @@ +import { updateNodeBounds, getNodeClasses } from './util.js'; +import intersect from '../intersect/index.js'; +import type { Node } from '../../types.js'; +import { userNodeOverrides, styles2String } from './handDrawnShapeStyles.js'; +import rough from 'roughjs'; +import { drawRect } from './drawRect.js'; +import { getConfig } from '../../../config.js'; +import type { EntityNode } from '../../../diagrams/er/erTypes.js'; +import { createText } from '../../createText.js'; +import { evaluate, parseGenericTypes } from '../../../diagrams/common/common.js'; +import { select } from 'd3'; +import { calculateTextWidth } from '../../../utils.js'; +import type { MermaidConfig } from '../../../config.type.js'; + +export const erBox = async (parent: SVGAElement, node: Node) => { + // Treat node as entityNode for certain entityNode checks + const entityNode = node as unknown as EntityNode; + if (entityNode.alias) { + node.label = entityNode.alias; + } + const config = getConfig(); + node.useHtmlLabels = config.htmlLabels; + let PADDING = config.er?.diagramPadding ?? 10; + let TEXT_PADDING = config.er?.entityPadding ?? 6; + + const { cssStyles } = node; + const { labelStyles } = styles2String(node); + + // Draw rect if no attributes are found + if (entityNode.attributes.length === 0 && node.label) { + const options = { + rx: 0, + ry: 0, + labelPaddingX: PADDING, + labelPaddingY: PADDING * 1.5, + classes: '', + }; + // Set minimum width + if ( + calculateTextWidth(node.label, config) + options.labelPaddingX * 2 < + config.er!.minEntityWidth! + ) { + node.width = config.er!.minEntityWidth; + } + const shapeSvg = await drawRect(parent, node, options); + return shapeSvg; + } + + if (!config.htmlLabels) { + PADDING *= 1.25; + TEXT_PADDING *= 1.25; + } + + let cssClasses = getNodeClasses(node); + if (!cssClasses) { + cssClasses = 'node default'; + } + + const shapeSvg = parent + // @ts-ignore Ignore .insert on SVGAElement + .insert('g') + .attr('class', cssClasses) + .attr('id', node.domId || node.id); + + // TODO: Make padding better + + const nameBBox = await addText(shapeSvg, node.label ?? '', config, 0, 0, ['name'], labelStyles); + nameBBox.height += TEXT_PADDING; + let yOffset = 0; + const yOffsets = []; + let maxTypeWidth = 0; + let maxNameWidth = 0; + let maxKeysWidth = 0; + let maxCommentWidth = 0; + let keysPresent = true; + let commentPresent = true; + for (const attribute of entityNode.attributes) { + const typeBBox = await addText( + shapeSvg, + attribute.type, + config, + 0, + yOffset, + ['attribute-type'], + labelStyles + ); + maxTypeWidth = Math.max(maxTypeWidth, typeBBox.width + PADDING); + const nameBBox = await addText( + shapeSvg, + attribute.name, + config, + 0, + yOffset, + ['attribute-name'], + labelStyles + ); + maxNameWidth = Math.max(maxNameWidth, nameBBox.width + PADDING); + const keysBBox = await addText( + shapeSvg, + attribute.keys.join(), + config, + 0, + yOffset, + ['attribute-keys'], + labelStyles + ); + maxKeysWidth = Math.max(maxKeysWidth, keysBBox.width + PADDING); + const commentBBox = await addText( + shapeSvg, + attribute.comment, + config, + 0, + yOffset, + ['attribute-comment'], + labelStyles + ); + maxCommentWidth = Math.max(maxCommentWidth, commentBBox.width + PADDING); + + yOffset += + Math.max(typeBBox.height, nameBBox.height, keysBBox.height, commentBBox.height) + + TEXT_PADDING; + yOffsets.push(yOffset); + } + + yOffsets.pop(); + let totalWidthSections = 4; + + if (maxKeysWidth <= PADDING) { + keysPresent = false; + maxKeysWidth = 0; + totalWidthSections--; + } + if (maxCommentWidth <= PADDING) { + commentPresent = false; + maxCommentWidth = 0; + totalWidthSections--; + } + + const shapeBBox = shapeSvg.node().getBBox(); + // Add extra padding to attribute components to accommodate for difference in width + if ( + nameBBox.width + PADDING * 2 - (maxTypeWidth + maxNameWidth + maxKeysWidth + maxCommentWidth) > + 0 + ) { + const difference = + nameBBox.width + PADDING * 2 - (maxTypeWidth + maxNameWidth + maxKeysWidth + maxCommentWidth); + maxTypeWidth += difference / totalWidthSections; + maxNameWidth += difference / totalWidthSections; + if (maxKeysWidth > 0) { + maxKeysWidth += difference / totalWidthSections; + } + if (maxCommentWidth > 0) { + maxCommentWidth += difference / totalWidthSections; + } + } + + const maxWidth = maxTypeWidth + maxNameWidth + maxKeysWidth + maxCommentWidth; + + // @ts-ignore TODO: Fix rough typings + const rc = rough.svg(shapeSvg); + const options = userNodeOverrides(node, {}); + + if (node.look !== 'handDrawn') { + options.roughness = 0; + options.fillStyle = 'solid'; + } + + const w = Math.max(shapeBBox.width + PADDING * 2, node?.width || 0, maxWidth); + const h = Math.max(shapeBBox.height + (yOffsets[0] || yOffset) + TEXT_PADDING, node?.height || 0); + const x = -w / 2; + const y = -h / 2; + + // Translate attribute text labels + shapeSvg.selectAll('g:not(:first-child)').each((_: any, i: number, nodes: any) => { + const text = select(nodes[i]); + const transform = text.attr('transform'); + let translateX = 0; + let translateY = 0; + + if (transform) { + const regex = RegExp(/translate\(([^,]+),([^)]+)\)/); + const translate = regex.exec(transform); + if (translate) { + translateX = parseFloat(translate[1]); + translateY = parseFloat(translate[2]); + if (text.attr('class').includes('attribute-name')) { + translateX += maxTypeWidth; + } else if (text.attr('class').includes('attribute-keys')) { + translateX += maxTypeWidth + maxNameWidth; + } else if (text.attr('class').includes('attribute-comment')) { + translateX += maxTypeWidth + maxNameWidth + maxKeysWidth; + } + } + } + + text.attr( + 'transform', + `translate(${x + PADDING / 2 + translateX}, ${translateY + y + nameBBox.height + TEXT_PADDING / 2})` + ); + }); + // Center the name + shapeSvg + .select('.name') + .attr('transform', 'translate(' + -nameBBox.width / 2 + ', ' + (y + TEXT_PADDING / 2) + ')'); + + // Draw rect + const roughRect = rc.rectangle(x, y, w, h, options); + const rect = shapeSvg.insert(() => roughRect, ':first-child').attr('style', cssStyles); + + // Draw divider lines + // Name line + let roughLine = rc.line(x, nameBBox.height + y, w + x, nameBBox.height + y, options); + shapeSvg.insert(() => roughLine).attr('class', 'divider'); + // First line + roughLine = rc.line(maxTypeWidth + x, nameBBox.height + y, maxTypeWidth + x, h + y, options); + shapeSvg.insert(() => roughLine).attr('class', 'divider'); + // Second line + if (keysPresent) { + roughLine = rc.line( + maxTypeWidth + maxNameWidth + x, + nameBBox.height + y, + maxTypeWidth + maxNameWidth + x, + h + y, + options + ); + shapeSvg.insert(() => roughLine).attr('class', 'divider'); + } + // Third line + if (commentPresent) { + roughLine = rc.line( + maxTypeWidth + maxNameWidth + maxKeysWidth + x, + nameBBox.height + y, + maxTypeWidth + maxNameWidth + maxKeysWidth + x, + h + y, + options + ); + shapeSvg.insert(() => roughLine).attr('class', 'divider'); + } + + // Attribute divider lines + for (const yOffset of yOffsets) { + roughLine = rc.line( + x, + nameBBox.height + y + yOffset, + w + x, + nameBBox.height + y + yOffset, + options + ); + shapeSvg.insert(() => roughLine).attr('class', 'divider'); + } + + updateNodeBounds(node, rect); + + node.intersect = function (point) { + return intersect.rect(node, point); + }; + return shapeSvg; +}; + +// Helper function to add label text g with translate position and style +async function addText( + shapeSvg: any, + labelText: string, + config: MermaidConfig, + translateX = 0, + translateY = 0, + classes: string[] = [], + style = '' +) { + const label = shapeSvg + .insert('g') + .attr('class', `label ${classes.join(' ')}`) + .attr('transform', `translate(${translateX}, ${translateY})`) + .attr('style', style); + + // Return types need to be parsed + if (labelText !== parseGenericTypes(labelText)) { + labelText = parseGenericTypes(labelText); + // Work around + labelText = labelText.replaceAll('<', '<').replaceAll('>', '>'); + } + + const text = label + .node() + .appendChild( + await createText( + label, + labelText, + { + width: calculateTextWidth(labelText, config) + 100, + style, + useHtmlLabels: config.htmlLabels, + }, + config + ) + ); + // Undo work around now that text passed through correctly + if (labelText.includes('<')) { + let child = text.children[0]; + // Get last child + while (child.childNodes[0]) { + child = child.childNodes[0]; + } + // Replace its text content + child.textContent = child.textContent.replaceAll('<', '<').replaceAll('>', '>'); + } + + let bbox = text.getBBox(); + if (evaluate(config.htmlLabels)) { + const div = text.children[0]; + div.style.textAlign = 'start'; + const dv = select(text); + bbox = div.getBoundingClientRect(); + dv.attr('width', bbox.width); + dv.attr('height', bbox.height); + } + + return bbox; +} From 983c28686f051a573d313c87769c8430fb9271a4 Mon Sep 17 00:00:00 2001 From: yari-dewalt Date: Tue, 8 Oct 2024 08:23:51 -0700 Subject: [PATCH 003/242] Register erBox shape in nodes --- packages/mermaid/src/rendering-util/rendering-elements/nodes.js | 2 ++ 1 file changed, 2 insertions(+) diff --git a/packages/mermaid/src/rendering-util/rendering-elements/nodes.js b/packages/mermaid/src/rendering-util/rendering-elements/nodes.js index 2f69a36bc..1376caaae 100644 --- a/packages/mermaid/src/rendering-util/rendering-elements/nodes.js +++ b/packages/mermaid/src/rendering-util/rendering-elements/nodes.js @@ -22,6 +22,7 @@ import { lean_left } from './shapes/leanLeft.js'; import { trapezoid } from './shapes/trapezoid.js'; import { inv_trapezoid } from './shapes/invertedTrapezoid.js'; import { labelRect } from './shapes/labelRect.js'; +import { erBox } from './shapes/erBox.js'; const shapes = { state, @@ -47,6 +48,7 @@ const shapes = { trapezoid, inv_trapezoid, labelRect, + erBox, }; const nodeElems = new Map(); From d2892ea2490a124bfb3ac97ec799fe63f430dafe Mon Sep 17 00:00:00 2001 From: yari-dewalt Date: Tue, 8 Oct 2024 08:24:41 -0700 Subject: [PATCH 004/242] Add erDiagram specific arrow markers --- .../rendering-elements/edgeMarker.ts | 4 + .../rendering-elements/markers.js | 126 ++++++++++++++++++ 2 files changed, 130 insertions(+) diff --git a/packages/mermaid/src/rendering-util/rendering-elements/edgeMarker.ts b/packages/mermaid/src/rendering-util/rendering-elements/edgeMarker.ts index 5371ac32d..8da8ba95d 100644 --- a/packages/mermaid/src/rendering-util/rendering-elements/edgeMarker.ts +++ b/packages/mermaid/src/rendering-util/rendering-elements/edgeMarker.ts @@ -35,6 +35,10 @@ const arrowTypesMap = { composition: 'composition', dependency: 'dependency', lollipop: 'lollipop', + only_one: 'onlyOne', + zero_or_one: 'zeroOrOne', + one_or_more: 'oneOrMore', + zero_or_more: 'zeroOrMore', } as const; const addEdgeMarker = ( diff --git a/packages/mermaid/src/rendering-util/rendering-elements/markers.js b/packages/mermaid/src/rendering-util/rendering-elements/markers.js index b2592e20e..0830cfe8b 100644 --- a/packages/mermaid/src/rendering-util/rendering-elements/markers.js +++ b/packages/mermaid/src/rendering-util/rendering-elements/markers.js @@ -277,6 +277,128 @@ const barb = (elem, type, id) => { .append('path') .attr('d', 'M 19,7 L9,13 L14,7 L9,1 Z'); }; +// erDiagram specific markers +const only_one = (elem, type, id) => { + elem + .append('defs') + .append('marker') + .attr('id', id + '_' + type + '-onlyOneStart') + .attr('class', 'marker onlyOne ' + type) + .attr('refX', 0) + .attr('refY', 9) + .attr('markerWidth', 18) + .attr('markerHeight', 18) + .attr('orient', 'auto') + .append('path') + .attr('d', 'M9,0 L9,18 M15,0 L15,18'); + + elem + .append('defs') + .append('marker') + .attr('id', id + '_' + type + '-onlyOneEnd') + .attr('class', 'marker onlyOne ' + type) + .attr('refX', 18) + .attr('refY', 9) + .attr('markerWidth', 18) + .attr('markerHeight', 18) + .attr('orient', 'auto') + .append('path') + .attr('d', 'M3,0 L3,18 M9,0 L9,18'); +}; + +const zero_or_one = (elem, type, id) => { + const startMarker = elem + .append('defs') + .append('marker') + .attr('id', id + '_' + type + '-zeroOrOneStart') + .attr('class', 'marker zeroOrOne ' + type) + .attr('refX', 0) + .attr('refY', 9) + .attr('markerWidth', 30) + .attr('markerHeight', 18) + .attr('orient', 'auto'); + startMarker + .append('circle') + .attr('fill', 'white') // Fill white for now? + .attr('cx', 21) + .attr('cy', 9) + .attr('r', 6); + startMarker.append('path').attr('d', 'M9,0 L9,18'); + + const endMarker = elem + .append('defs') + .append('marker') + .attr('id', id + '_' + type + '-zeroOrOneEnd') + .attr('class', 'marker zeroOrOne ' + type) + .attr('refX', 30) + .attr('refY', 9) + .attr('markerWidth', 30) + .attr('markerHeight', 18) + .attr('orient', 'auto'); + endMarker + .append('circle') + .attr('fill', 'white') // Fill white for now? + .attr('cx', 9) + .attr('cy', 9) + .attr('r', 6); + endMarker.append('path').attr('d', 'M21,0 L21,18'); +}; + +const one_or_more = (elem, type, id) => { + elem + .append('defs') + .append('marker') + .attr('id', id + '_' + type + '-oneOrMoreStart') + .attr('class', 'marker oneOrMore ' + type) + .attr('refX', 18) + .attr('refY', 18) + .attr('markerWidth', 45) + .attr('markerHeight', 36) + .attr('orient', 'auto') + .append('path') + .attr('d', 'M0,18 Q 18,0 36,18 Q 18,36 0,18 M42,9 L42,27'); + + elem + .append('defs') + .append('marker') + .attr('id', id + '_' + type + '-oneOrMoreEnd') + .attr('class', 'marker oneOrMore ' + type) + .attr('refX', 27) + .attr('refY', 18) + .attr('markerWidth', 45) + .attr('markerHeight', 36) + .attr('orient', 'auto') + .append('path') + .attr('d', 'M3,9 L3,27 M9,18 Q27,0 45,18 Q27,36 9,18'); +}; + +const zero_or_more = (elem, type, id) => { + const startMarker = elem + .append('defs') + .append('marker') + .attr('id', id + '_' + type + '-zeroOrMoreStart') + .attr('class', 'marker zeroOrMore ' + type) + .attr('refX', 18) + .attr('refY', 18) + .attr('markerWidth', 57) + .attr('markerHeight', 36) + .attr('orient', 'auto'); + startMarker.append('circle').attr('fill', 'white').attr('cx', 48).attr('cy', 18).attr('r', 6); + startMarker.append('path').attr('d', 'M0,18 Q18,0 36,18 Q18,36 0,18'); + + const endMarker = elem + .append('defs') + .append('marker') + .attr('id', id + '_' + type + '-zeroOrMoreEnd') + .attr('class', 'marker zeroOrMore ' + type) + .attr('refX', 39) + .attr('refY', 18) + .attr('markerWidth', 57) + .attr('markerHeight', 36) + .attr('orient', 'auto'); + endMarker.append('circle').attr('fill', 'white').attr('cx', 9).attr('cy', 18).attr('r', 6); + endMarker.append('path').attr('d', 'M21,18 Q39,0 57,18 Q39,36 21,18'); +}; // TODO rename the class diagram markers to something shape descriptive and semantic free const markers = { @@ -289,5 +411,9 @@ const markers = { circle, cross, barb, + only_one, + zero_or_one, + one_or_more, + zero_or_more, }; export default insertMarkers; From d0dd4e6e5e7f7f149423e51603891b24bc8817ee Mon Sep 17 00:00:00 2001 From: yari-dewalt Date: Tue, 8 Oct 2024 08:25:34 -0700 Subject: [PATCH 005/242] Fix cyclical / recursive edges to not show duplicated arrow start markers --- .../mermaid/src/rendering-util/layout-algorithms/dagre/index.js | 2 ++ 1 file changed, 2 insertions(+) diff --git a/packages/mermaid/src/rendering-util/layout-algorithms/dagre/index.js b/packages/mermaid/src/rendering-util/layout-algorithms/dagre/index.js index 9367a65a5..23461d9c5 100644 --- a/packages/mermaid/src/rendering-util/layout-algorithms/dagre/index.js +++ b/packages/mermaid/src/rendering-util/layout-algorithms/dagre/index.js @@ -346,6 +346,7 @@ export const render = async (data4Layout, svg) => { edge1.label = ''; edge1.arrowTypeEnd = 'none'; edge1.id = nodeId + '-cyclic-special-1'; + edgeMid.arrowTypeStart = 'none'; edgeMid.arrowTypeEnd = 'none'; edgeMid.id = nodeId + '-cyclic-special-mid'; edge2.label = ''; @@ -354,6 +355,7 @@ export const render = async (data4Layout, svg) => { edge2.toCluster = nodeId; } edge2.id = nodeId + '-cyclic-special-2'; + edge2.arrowTypeStart = 'none'; graph.setEdge(nodeId, specialId1, edge1, nodeId + '-cyclic-special-0'); graph.setEdge(specialId1, specialId2, edgeMid, nodeId + '-cyclic-special-1'); graph.setEdge(specialId2, nodeId, edge2, nodeId + '-cyc Date: Tue, 8 Oct 2024 08:26:12 -0700 Subject: [PATCH 006/242] Fix diagram title not being centered --- packages/mermaid/src/utils.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/packages/mermaid/src/utils.ts b/packages/mermaid/src/utils.ts index 631b6dd85..cc033528c 100644 --- a/packages/mermaid/src/utils.ts +++ b/packages/mermaid/src/utils.ts @@ -824,6 +824,7 @@ export const insertTitle = ( parent .append('text') .text(title) + .attr('text-anchor', 'middle') .attr('x', bounds.x + bounds.width / 2) .attr('y', -titleTopMargin) .attr('class', cssClass); From 6247bd5f895612710a6216d426af6286812ae638 Mon Sep 17 00:00:00 2001 From: yari-dewalt Date: Tue, 8 Oct 2024 08:26:43 -0700 Subject: [PATCH 007/242] Add test html file --- cypress/platform/yari2.html | 174 ++++++++++++++++++++++++++++++++++++ 1 file changed, 174 insertions(+) create mode 100644 cypress/platform/yari2.html diff --git a/cypress/platform/yari2.html b/cypress/platform/yari2.html new file mode 100644 index 000000000..35fa2493b --- /dev/null +++ b/cypress/platform/yari2.html @@ -0,0 +1,174 @@ + + +

Nodes

+
+
+

Basic ErNode

+ 
+          ---
+            config:
+              htmlLabels: false
+              look: handDrawn
+              theme: forest
+          ---
+          erDiagram
+            _**hiØ**_[*test*] {
+              *__List~List~int~~sdfds__* __driversLicense__ PK "***The l😀icense #***"
+              *string(99)~T~~~~~~* firstName "Only 99 
characters are a
llowed dsfsdfsdfsdfs"
+              string lastName
+              string phone UK
+              int age
+            }
+            style PERSON color:red, stroke:blue,fill:#f9f
+            classDef test,test2 stroke:red
+            class PERSON test,test2
+
+
+
+

Basic ErNode

+ 
+          ---
+            config:
+              htmlLabels: true
+              look: handDrawn
+          ---
+          erDiagram
+            c[CUST😀OMER]
+            p[__PERSON__]
+            style c,p fill:#f9f,stroke:blue, color:grey, font-size:24px,font-weight:bold
+
+
+
+

Diagram Testing

+
+
+

Basic Relationship

+ 
+          ---
+            config:
+              htmlLabels: false
+              look:
+          ---
+          erDiagram
+            "hi" }o..o{ ORDER : places
+
+
+
+

Basic Relationship

+ 
+          ---
+            config:
+              htmlLabels: false
+              look:
+          ---
+          erDiagram
+            CAR ||--|{ NAMED-DRIVER : allows
+            PERSON ||..o{ NAMED-DRIVER : is
+
+
+
+

Basic Relationship

+ 
+          ---
+            config:
+              htmlLabels: true
+          ---
+          erDiagram
+            CAR ||--o{ NAMED-DRIVER : allows
+            CAR {
+                test test PK "comment"
+                string make
+                string model
+                string[] parts
+            }
+            PERSON ||--o{ NAMED-DRIVER : is
+            PERSON ||--o{ CAR : is
+            PERSON {
+                string driversLicense PK "The license #"
+                string(99) firstName "Only 99 characters are allowed"
+                string lastName
+                string phone UK
+                int age
+            }
+            NAMED-DRIVER {
+                string carRegistrationNumber PK, FK
+                string driverLicence PK, FK
+            }
+            MANUFACTURER only one to zero or more CAR : makes      
+
+
+
+

Basic Relationship

+ 
+          ---
+            title: simple ER diagram
+            config:
+              theme: forest
+          ---
+          erDiagram
+          direction TB
+          p[Pers😀on] {
+              string firstName
+              string lastName
+          }
+          a["Customer Account"] {
+              string email
+          }
+          p ||--o| a : has
+           
+
+
+
+

Basic Relationship

+ 
+          erDiagram
+            CUSTOMER ||--o{ CUSTOMER : refers
+            CUSTOMER ||--o{ ORDER : places
+            ORDER ||--|{ LINE-ITEM : contains
+
+
+
+ + + + + From df110e5e11bd38cf60249ede91287c8667749fa6 Mon Sep 17 00:00:00 2001 From: yari-dewalt Date: Tue, 8 Oct 2024 11:47:08 -0700 Subject: [PATCH 008/242] Add default class to nodes and fix styles --- packages/mermaid/src/diagrams/er/erDb.ts | 2 +- packages/mermaid/src/diagrams/er/styles.js | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/packages/mermaid/src/diagrams/er/erDb.ts b/packages/mermaid/src/diagrams/er/erDb.ts index c8ea3136c..ef0b5382d 100644 --- a/packages/mermaid/src/diagrams/er/erDb.ts +++ b/packages/mermaid/src/diagrams/er/erDb.ts @@ -45,7 +45,7 @@ const addEntity = function (name: string, alias = ''): EntityNode { alias, shape: 'erBox', look: getConfig().look || 'default', - cssClasses: [], + cssClasses: ['default'], cssStyles: [], }); log.info('Added new entity :', name); diff --git a/packages/mermaid/src/diagrams/er/styles.js b/packages/mermaid/src/diagrams/er/styles.js index 45a9dd7ec..ae4bc38f1 100644 --- a/packages/mermaid/src/diagrams/er/styles.js +++ b/packages/mermaid/src/diagrams/er/styles.js @@ -36,8 +36,8 @@ const getStyles = (options) => .node rect, .node circle, .node ellipse, - .node polygon, - .node path { + .node polygon + { fill: ${options.mainBkg}; stroke: ${options.nodeBorder}; stroke-width: 1px; From 29c3293265a32e4f6c69dcbb5ae69a72c1e41cb8 Mon Sep 17 00:00:00 2001 From: yari-dewalt Date: Tue, 15 Oct 2024 11:42:47 -0700 Subject: [PATCH 009/242] Update documentation --- docs/syntax/entityRelationshipDiagram.md | 378 ++++++++++++++++-- .../docs/syntax/entityRelationshipDiagram.md | 255 ++++++++++-- 2 files changed, 577 insertions(+), 56 deletions(-) diff --git a/docs/syntax/entityRelationshipDiagram.md b/docs/syntax/entityRelationshipDiagram.md index 693cb53c7..175899994 100644 --- a/docs/syntax/entityRelationshipDiagram.md +++ b/docs/syntax/entityRelationshipDiagram.md @@ -92,7 +92,7 @@ Mermaid syntax for ER diagrams is compatible with PlantUML, with an extension to Where: -- `first-entity` is the name of an entity. Names must begin with an alphabetic character or an underscore (from v10.5.0+), and may also contain digits and hyphens. +- `first-entity` is the name of an entity. Names support any unicode characters and can include spaces if surrounded by double quotes (e.g. "name with space"). - `relationship` describes the way that both entities inter-relate. See below. - `second-entity` is the name of the other entity. - `relationship-label` describes the relationship from the perspective of the first entity. @@ -107,6 +107,34 @@ This statement can be read as _a property contains one or more rooms, and a room Only the `first-entity` part of a statement is mandatory. This makes it possible to show an entity with no relationships, which can be useful during iterative construction of diagrams. If any other parts of a statement are specified, then all parts are mandatory. +#### Unicode text + +Entity names, relationships, and attributes all support unicode text. + +```mermaid-example +erDiagram + "This ❤ Unicode" +``` + +```mermaid +erDiagram + "This ❤ Unicode" +``` + +#### Markdown formatting + +Markdown formatting and text is also supported. + +```mermaid-example +erDiagram + "This **is** _Markdown_" +``` + +```mermaid +erDiagram + "This **is** _Markdown_" +``` + ### Relationship Syntax The `relationship` part of each statement can be broken down into three sub-components: @@ -145,6 +173,11 @@ Cardinality is a property that describes how many elements of another entity can Relationships may be classified as either _identifying_ or _non-identifying_ and these are rendered with either solid or dashed lines respectively. This is relevant when one of the entities in question can not have independent existence without the other. For example a firm that insures people to drive cars might need to store data on `NAMED-DRIVER`s. In modelling this we might start out by observing that a `CAR` can be driven by many `PERSON` instances, and a `PERSON` can drive many `CAR`s - both entities can exist without the other, so this is a non-identifying relationship that we might specify in Mermaid as: `PERSON }|..|{ CAR : "driver"`. Note the two dots in the middle of the relationship that will result in a dashed line being drawn between the two entities. But when this many-to-many relationship is resolved into two one-to-many relationships, we observe that a `NAMED-DRIVER` cannot exist without both a `PERSON` and a `CAR` - the relationships become identifying and would be specified using hyphens, which translate to a solid line: +| Value | Alias for | +| :---: | :---------------: | +| -- | _identifying_ | +| .. | _non-identifying_ | + **Aliases** | Value | Alias for | @@ -155,13 +188,25 @@ Relationships may be classified as either _identifying_ or _non-identifying_ and ```mermaid-example erDiagram CAR ||--o{ NAMED-DRIVER : allows - PERSON ||--o{ NAMED-DRIVER : is + PERSON }o..o{ NAMED-DRIVER : is ``` ```mermaid erDiagram CAR ||--o{ NAMED-DRIVER : allows - PERSON ||--o{ NAMED-DRIVER : is + PERSON }o..o{ NAMED-DRIVER : is +``` + +```mermaid-example +erDiagram + CAR 1 to zero or more NAMED-DRIVER : allows + PERSON many(0) optionally to 0+ NAMED-DRIVER : is +``` + +```mermaid +erDiagram + CAR 1 to zero or more NAMED-DRIVER : allows + PERSON many(0) optionally to 0+ NAMED-DRIVER : is ``` ### Attributes @@ -202,9 +247,9 @@ erDiagram The `type` values must begin with an alphabetic character and may contain digits, hyphens, underscores, parentheses and square brackets. The `name` values follow a similar format to `type`, but may start with an asterisk as another option to indicate an attribute is a primary key. Other than that, there are no restrictions, and there is no implicit set of valid data types. -### Entity Name Aliases (v10.5.0+) +### Entity Name Aliases -An alias can be added to an entity using square brackets. If provided, the alias will be showed in the diagram instead of the entity name. +An alias can be added to an entity using square brackets. If provided, the alias will be showed in the diagram instead of the entity name. Alias names follow all of the same rules as entity names. ```mermaid-example erDiagram @@ -232,7 +277,7 @@ erDiagram #### Attribute Keys and Comments -Attributes may also have a `key` or comment defined. Keys can be `PK`, `FK` or `UK`, for Primary Key, Foreign Key or Unique Key. To specify multiple key constraints on a single attribute, separate them with a comma (e.g., `PK, FK`). A `comment` is defined by double quotes at the end of an attribute. Comments themselves cannot have double-quote characters in them. +Attributes may also have a `key` or comment defined. Keys can be `PK`, `FK` or `UK`, for Primary Key, Foreign Key or Unique Key (markdown formatting and unicode is not supported for keys). To specify multiple key constraints on a single attribute, separate them with a comma (e.g., `PK, FK`). A `comment` is defined by double quotes at the end of an attribute. Comments themselves cannot have double-quote characters in them. ```mermaid-example erDiagram @@ -282,35 +327,312 @@ erDiagram MANUFACTURER only one to zero or more CAR : makes ``` -### Other Things +### Direction -- If you want the relationship label to be more than one word, you must use double quotes around the phrase -- If you don't want a label at all on a relationship, you must use an empty double-quoted string -- (v11.1.0+) If you want a multi-line label on a relationship, use `
` between the two lines (`"first line
second line"`) +The direction statement declares the direction of the diagram. -## Styling +This declares that the diagram is oriented from top to bottom (`TB`). This can be reversed to be oriented from bottom to top (`BT`). -### Config options +```mermaid-example +erDiagram + direction TB + CUSTOMER ||--o{ ORDER : places + CUSTOMER { + string name + string custNumber + string sector + } + ORDER ||--|{ LINE-ITEM : contains + ORDER { + int orderNumber + string deliveryAddress + } + LINE-ITEM { + string productCode + int quantity + float pricePerUnit + } +``` -For simple color customization: +```mermaid +erDiagram + direction TB + CUSTOMER ||--o{ ORDER : places + CUSTOMER { + string name + string custNumber + string sector + } + ORDER ||--|{ LINE-ITEM : contains + ORDER { + int orderNumber + string deliveryAddress + } + LINE-ITEM { + string productCode + int quantity + float pricePerUnit + } +``` -| Name | Used as | -| :------- | :------------------------------------------------------------------- | -| `fill` | Background color of an entity or attribute | -| `stroke` | Border color of an entity or attribute, line color of a relationship | +This declares that the diagram is oriented from left to right (`LR`). This can be reversed to be oriented from right to left (`RL`). -### Classes used +```mermaid-example +erDiagram + direction LR + CUSTOMER ||--o{ ORDER : places + CUSTOMER { + string name + string custNumber + string sector + } + ORDER ||--|{ LINE-ITEM : contains + ORDER { + int orderNumber + string deliveryAddress + } + LINE-ITEM { + string productCode + int quantity + float pricePerUnit + } +``` -The following CSS class selectors are available for richer styling: +```mermaid +erDiagram + direction LR + CUSTOMER ||--o{ ORDER : places + CUSTOMER { + string name + string custNumber + string sector + } + ORDER ||--|{ LINE-ITEM : contains + ORDER { + int orderNumber + string deliveryAddress + } + LINE-ITEM { + string productCode + int quantity + float pricePerUnit + } +``` -| Selector | Description | -| :------------------------- | :---------------------------------------------------- | -| `.er.attributeBoxEven` | The box containing attributes on even-numbered rows | -| `.er.attributeBoxOdd` | The box containing attributes on odd-numbered rows | -| `.er.entityBox` | The box representing an entity | -| `.er.entityLabel` | The label for an entity | -| `.er.relationshipLabel` | The label for a relationship | -| `.er.relationshipLabelBox` | The box surrounding a relationship label | -| `.er.relationshipLine` | The line representing a relationship between entities | +Possible diagram orientations are: + +- TB - Top to bottom +- BT - Bottom to top +- RL - Right to left +- LR - Left to right + +### Styling a node + +It is possible to apply specific styles such as a thicker border or a different background color to a node. + +```mermaid-example +erDiagram + id1||--||id2 : label + style id1 fill:#f9f,stroke:#333,stroke-width:4px + style id2 fill:#bbf,stroke:#f66,stroke-width:2px,color:#fff,stroke-dasharray: 5 5 +``` + +```mermaid +erDiagram + id1||--||id2 : label + style id1 fill:#f9f,stroke:#333,stroke-width:4px + style id2 fill:#bbf,stroke:#f66,stroke-width:2px,color:#fff,stroke-dasharray: 5 5 +``` + +It is also possible to attach styles to a list of nodes in one statement: + +``` + style nodeId1,nodeId2 styleList +``` + +#### Classes + +More convenient than defining the style every time is to define a class of styles and attach this class to the nodes that +should have a different look. + +A class definition looks like the example below: + +``` + classDef className fill:#f9f,stroke:#333,stroke-width:4px +``` + +It is also possible to define multiple classes in one statement: + +``` + classDef firstClassName,secondClassName font-size:12pt +``` + +Attachment of a class to a node is done as per below: + +``` + class nodeId1 className +``` + +It is also possible to attach a class to a list of nodes in one statement: + +``` + class nodeId1,nodeId2 className +``` + +Multiple classes can be attached at the same time as well: + +``` + class nodeId1,nodeId2 className1,className2 +``` + +A shorter form of adding a class is to attach the classname to the node using the `:::`operator as per below: + +```mermaid-example +erDiagram + direction TB + CAR:::someclass { + string registrationNumber + string make + string model + } + PERSON:::someclass { + string firstName + string lastName + int age + } + HOUSE:::someclass + + classDef someclass fill:#f96 +``` + +```mermaid +erDiagram + direction TB + CAR:::someclass { + string registrationNumber + string make + string model + } + PERSON:::someclass { + string firstName + string lastName + int age + } + HOUSE:::someclass + + classDef someclass fill:#f96 +``` + +This form can be used when declaring relationships between entities: + +```mermaid-example +erDiagram + CAR { + string registrationNumber + string make + string model + } + PERSON { + string firstName + string lastName + int age + } + PERSON:::foo ||--|| CAR : owns + PERSON o{--|| HOUSE:::bar : has + + classDef foo stroke:#f00 + classDef bar stroke:#0f0 + classDef foobar stroke:#00f +``` + +```mermaid +erDiagram + CAR { + string registrationNumber + string make + string model + } + PERSON { + string firstName + string lastName + int age + } + PERSON:::foo ||--|| CAR : owns + PERSON o{--|| HOUSE:::bar : has + + classDef foo stroke:#f00 + classDef bar stroke:#0f0 + classDef foobar stroke:#00f +``` + +Similar to the class statement, the shorthand syntax can also apply multiple classes at once: + +``` + nodeId:::className1,className2 +``` + +### Default class + +If a class is named default it will be assigned to all classes without specific class definitions. + +```mermaid-example +erDiagram + CAR { + string registrationNumber + string make + string model + } + PERSON { + string firstName + string lastName + int age + } + PERSON:::foo ||--|| CAR : owns + PERSON o{--|| HOUSE:::bar : has + + classDef default fill:#f9f,stroke-width:4px + classDef foo stroke:#f00 + classDef bar stroke:#0f0 + classDef foobar stroke:#00f +``` + +```mermaid +erDiagram + CAR { + string registrationNumber + string make + string model + } + PERSON { + string firstName + string lastName + int age + } + PERSON:::foo ||--|| CAR : owns + PERSON o{--|| HOUSE:::bar : has + + classDef default fill:#f9f,stroke-width:4px + classDef foo stroke:#f00 + classDef bar stroke:#0f0 + classDef foobar stroke:#00f +``` + +## Configuration + +### Renderer + +The layout of the diagram is done with the renderer. The default renderer is dagre. + +You can opt to use an alternate renderer named elk by editing the configuration. The elk renderer is better for larger and/or more complex diagrams. + +``` +--- + config: + layout: elk +--- +``` + +> **Note** +> Note that the site needs to use mermaid version 9.4+ for this to work and have this featured enabled in the lazy-loading configuration. diff --git a/packages/mermaid/src/docs/syntax/entityRelationshipDiagram.md b/packages/mermaid/src/docs/syntax/entityRelationshipDiagram.md index 8c83d2232..6ff3c6abb 100644 --- a/packages/mermaid/src/docs/syntax/entityRelationshipDiagram.md +++ b/packages/mermaid/src/docs/syntax/entityRelationshipDiagram.md @@ -56,7 +56,7 @@ Mermaid syntax for ER diagrams is compatible with PlantUML, with an extension to Where: -- `first-entity` is the name of an entity. Names must begin with an alphabetic character or an underscore (from v10.5.0+), and may also contain digits and hyphens. +- `first-entity` is the name of an entity. Names support any unicode characters and can include spaces if surrounded by double quotes (e.g. "name with space"). - `relationship` describes the way that both entities inter-relate. See below. - `second-entity` is the name of the other entity. - `relationship-label` describes the relationship from the perspective of the first entity. @@ -71,6 +71,24 @@ This statement can be read as _a property contains one or more rooms, and a room Only the `first-entity` part of a statement is mandatory. This makes it possible to show an entity with no relationships, which can be useful during iterative construction of diagrams. If any other parts of a statement are specified, then all parts are mandatory. +#### Unicode text + +Entity names, relationships, and attributes all support unicode text. + +```mermaid-example +erDiagram + "This ❤ Unicode" +``` + +#### Markdown formatting + +Markdown formatting and text is also supported. + +```mermaid-example +erDiagram + "This **is** _Markdown_" +``` + ### Relationship Syntax The `relationship` part of each statement can be broken down into three sub-components: @@ -109,6 +127,11 @@ Cardinality is a property that describes how many elements of another entity can Relationships may be classified as either _identifying_ or _non-identifying_ and these are rendered with either solid or dashed lines respectively. This is relevant when one of the entities in question can not have independent existence without the other. For example a firm that insures people to drive cars might need to store data on `NAMED-DRIVER`s. In modelling this we might start out by observing that a `CAR` can be driven by many `PERSON` instances, and a `PERSON` can drive many `CAR`s - both entities can exist without the other, so this is a non-identifying relationship that we might specify in Mermaid as: `PERSON }|..|{ CAR : "driver"`. Note the two dots in the middle of the relationship that will result in a dashed line being drawn between the two entities. But when this many-to-many relationship is resolved into two one-to-many relationships, we observe that a `NAMED-DRIVER` cannot exist without both a `PERSON` and a `CAR` - the relationships become identifying and would be specified using hyphens, which translate to a solid line: +| Value | Alias for | +| :---: | :---------------: | +| -- | _identifying_ | +| .. | _non-identifying_ | + **Aliases** | Value | Alias for | @@ -116,10 +139,16 @@ Relationships may be classified as either _identifying_ or _non-identifying_ and | to | _identifying_ | | optionally to | _non-identifying_ | -```mermaid +```mermaid-example erDiagram CAR ||--o{ NAMED-DRIVER : allows - PERSON ||--o{ NAMED-DRIVER : is + PERSON }o..o{ NAMED-DRIVER : is +``` + +```mermaid-example +erDiagram + CAR 1 to zero or more NAMED-DRIVER : allows + PERSON many(0) optionally to 0+ NAMED-DRIVER : is ``` ### Attributes @@ -144,9 +173,9 @@ erDiagram The `type` values must begin with an alphabetic character and may contain digits, hyphens, underscores, parentheses and square brackets. The `name` values follow a similar format to `type`, but may start with an asterisk as another option to indicate an attribute is a primary key. Other than that, there are no restrictions, and there is no implicit set of valid data types. -### Entity Name Aliases (v10.5.0+) +### Entity Name Aliases -An alias can be added to an entity using square brackets. If provided, the alias will be showed in the diagram instead of the entity name. +An alias can be added to an entity using square brackets. If provided, the alias will be showed in the diagram instead of the entity name. Alias names follow all of the same rules as entity names. ```mermaid-example erDiagram @@ -162,7 +191,7 @@ erDiagram #### Attribute Keys and Comments -Attributes may also have a `key` or comment defined. Keys can be `PK`, `FK` or `UK`, for Primary Key, Foreign Key or Unique Key. To specify multiple key constraints on a single attribute, separate them with a comma (e.g., `PK, FK`). A `comment` is defined by double quotes at the end of an attribute. Comments themselves cannot have double-quote characters in them. +Attributes may also have a `key` or comment defined. Keys can be `PK`, `FK` or `UK`, for Primary Key, Foreign Key or Unique Key (markdown formatting and unicode is not supported for keys). To specify multiple key constraints on a single attribute, separate them with a comma (e.g., `PK, FK`). A `comment` is defined by double quotes at the end of an attribute. Comments themselves cannot have double-quote characters in them. ```mermaid-example erDiagram @@ -188,35 +217,205 @@ erDiagram MANUFACTURER only one to zero or more CAR : makes ``` -### Other Things +### Direction -- If you want the relationship label to be more than one word, you must use double quotes around the phrase -- If you don't want a label at all on a relationship, you must use an empty double-quoted string -- (v11.1.0+) If you want a multi-line label on a relationship, use `
` between the two lines (`"first line
second line"`) +The direction statement declares the direction of the diagram. -## Styling +This declares that the diagram is oriented from top to bottom (`TB`). This can be reversed to be oriented from bottom to top (`BT`). -### Config options +```mermaid-example +erDiagram + direction TB + CUSTOMER ||--o{ ORDER : places + CUSTOMER { + string name + string custNumber + string sector + } + ORDER ||--|{ LINE-ITEM : contains + ORDER { + int orderNumber + string deliveryAddress + } + LINE-ITEM { + string productCode + int quantity + float pricePerUnit + } +``` -For simple color customization: +This declares that the diagram is oriented from left to right (`LR`). This can be reversed to be oriented from right to left (`RL`). -| Name | Used as | -| :------- | :------------------------------------------------------------------- | -| `fill` | Background color of an entity or attribute | -| `stroke` | Border color of an entity or attribute, line color of a relationship | +```mermaid-example +erDiagram + direction LR + CUSTOMER ||--o{ ORDER : places + CUSTOMER { + string name + string custNumber + string sector + } + ORDER ||--|{ LINE-ITEM : contains + ORDER { + int orderNumber + string deliveryAddress + } + LINE-ITEM { + string productCode + int quantity + float pricePerUnit + } +``` -### Classes used +Possible diagram orientations are: -The following CSS class selectors are available for richer styling: +- TB - Top to bottom +- BT - Bottom to top +- RL - Right to left +- LR - Left to right -| Selector | Description | -| :------------------------- | :---------------------------------------------------- | -| `.er.attributeBoxEven` | The box containing attributes on even-numbered rows | -| `.er.attributeBoxOdd` | The box containing attributes on odd-numbered rows | -| `.er.entityBox` | The box representing an entity | -| `.er.entityLabel` | The label for an entity | -| `.er.relationshipLabel` | The label for a relationship | -| `.er.relationshipLabelBox` | The box surrounding a relationship label | -| `.er.relationshipLine` | The line representing a relationship between entities | +### Styling a node + +It is possible to apply specific styles such as a thicker border or a different background color to a node. + +```mermaid-example +erDiagram + id1||--||id2 : label + style id1 fill:#f9f,stroke:#333,stroke-width:4px + style id2 fill:#bbf,stroke:#f66,stroke-width:2px,color:#fff,stroke-dasharray: 5 5 +``` + +It is also possible to attach styles to a list of nodes in one statement: + +``` + style nodeId1,nodeId2 styleList +``` + +#### Classes + +More convenient than defining the style every time is to define a class of styles and attach this class to the nodes that +should have a different look. + +A class definition looks like the example below: + +``` + classDef className fill:#f9f,stroke:#333,stroke-width:4px +``` + +It is also possible to define multiple classes in one statement: + +``` + classDef firstClassName,secondClassName font-size:12pt +``` + +Attachment of a class to a node is done as per below: + +``` + class nodeId1 className +``` + +It is also possible to attach a class to a list of nodes in one statement: + +``` + class nodeId1,nodeId2 className +``` + +Multiple classes can be attached at the same time as well: + +``` + class nodeId1,nodeId2 className1,className2 +``` + +A shorter form of adding a class is to attach the classname to the node using the `:::`operator as per below: + +```mermaid-example +erDiagram + direction TB + CAR:::someclass { + string registrationNumber + string make + string model + } + PERSON:::someclass { + string firstName + string lastName + int age + } + HOUSE:::someclass + + classDef someclass fill:#f96 +``` + +This form can be used when declaring relationships between entities: + +```mermaid-example +erDiagram + CAR { + string registrationNumber + string make + string model + } + PERSON { + string firstName + string lastName + int age + } + PERSON:::foo ||--|| CAR : owns + PERSON o{--|| HOUSE:::bar : has + + classDef foo stroke:#f00 + classDef bar stroke:#0f0 + classDef foobar stroke:#00f +``` + +Similar to the class statement, the shorthand syntax can also apply multiple classes at once: + +``` + nodeId:::className1,className2 +``` + +### Default class + +If a class is named default it will be assigned to all classes without specific class definitions. + +```mermaid-example +erDiagram + CAR { + string registrationNumber + string make + string model + } + PERSON { + string firstName + string lastName + int age + } + PERSON:::foo ||--|| CAR : owns + PERSON o{--|| HOUSE:::bar : has + + classDef default fill:#f9f,stroke-width:4px + classDef foo stroke:#f00 + classDef bar stroke:#0f0 + classDef foobar stroke:#00f +``` + +## Configuration + +### Renderer + +The layout of the diagram is done with the renderer. The default renderer is dagre. + +You can opt to use an alternate renderer named elk by editing the configuration. The elk renderer is better for larger and/or more complex diagrams. + +``` +--- + config: + layout: elk +--- +``` + +```note +Note that the site needs to use mermaid version 9.4+ for this to work and have this featured enabled in the lazy-loading configuration. +``` From 0d664b1fd2bce5acf4d7307394617f3c4ef709b5 Mon Sep 17 00:00:00 2001 From: yari-dewalt Date: Tue, 15 Oct 2024 11:44:02 -0700 Subject: [PATCH 010/242] Add tests --- .../rendering/erDiagram-v3.spec.js | 680 ++++++++++++++++++ .../src/diagrams/er/parser/erDiagram.spec.js | 220 +++++- 2 files changed, 880 insertions(+), 20 deletions(-) create mode 100644 cypress/integration/rendering/erDiagram-v3.spec.js diff --git a/cypress/integration/rendering/erDiagram-v3.spec.js b/cypress/integration/rendering/erDiagram-v3.spec.js new file mode 100644 index 000000000..438c032de --- /dev/null +++ b/cypress/integration/rendering/erDiagram-v3.spec.js @@ -0,0 +1,680 @@ +import { imgSnapshotTest, renderGraph } from '../../helpers/util.ts'; + +describe('Entity Relationship Diagram', () => { + it('should render a simple ER diagram', () => { + imgSnapshotTest( + ` + erDiagram + CUSTOMER ||--o{ ORDER : places + ORDER ||--|{ LINE-ITEM : contains + `, + { logLevel: 1 } + ); + }); + + it('should render a simple ER diagram without htmlLabels', () => { + imgSnapshotTest( + ` + erDiagram + CUSTOMER ||--o{ ORDER : places + ORDER ||--|{ LINE-ITEM : contains + `, + { logLevel: 1, htmlLabels: false } + ); + }); + + it('should render an ER diagram with a recursive relationship', () => { + imgSnapshotTest( + ` + erDiagram + CUSTOMER ||..o{ CUSTOMER : refers + CUSTOMER ||--o{ ORDER : places + ORDER ||--|{ LINE-ITEM : contains + `, + { logLevel: 1 } + ); + }); + + it('should render an ER diagram with multiple relationships between the same two entities', () => { + imgSnapshotTest( + ` + erDiagram + CUSTOMER ||--|{ ADDRESS : "invoiced at" + CUSTOMER ||--|{ ADDRESS : "receives goods at" + `, + { logLevel: 1 } + ); + }); + + it('should render a cyclical ER diagram', () => { + imgSnapshotTest( + ` + erDiagram + A ||--|{ B : likes + B ||--|{ C : likes + C ||--|{ A : likes + `, + { logLevel: 1 } + ); + }); + + it('should render a not-so-simple ER diagram', () => { + imgSnapshotTest( + ` + erDiagram + CUSTOMER }|..|{ DELIVERY-ADDRESS : has + CUSTOMER ||--o{ ORDER : places + CUSTOMER ||--o{ INVOICE : "liable for" + DELIVERY-ADDRESS ||--o{ ORDER : receives + INVOICE ||--|{ ORDER : covers + ORDER ||--|{ ORDER-ITEM : includes + PRODUCT-CATEGORY ||--|{ PRODUCT : contains + PRODUCT ||--o{ ORDER-ITEM : "ordered in" + `, + { logLevel: 1 } + ); + }); + + it('should render a not-so-simple ER diagram without htmlLabels', () => { + imgSnapshotTest( + ` + erDiagram + CUSTOMER }|..|{ DELIVERY-ADDRESS : has + CUSTOMER ||--o{ ORDER : places + CUSTOMER ||--o{ INVOICE : "liable for" + DELIVERY-ADDRESS ||--o{ ORDER : receives + INVOICE ||--|{ ORDER : covers + ORDER ||--|{ ORDER-ITEM : includes + PRODUCT-CATEGORY ||--|{ PRODUCT : contains + PRODUCT ||--o{ ORDER-ITEM : "ordered in" + `, + { logLevel: 1, htmlLabels: false } + ); + }); + + it('should render multiple ER diagrams', () => { + imgSnapshotTest( + [ + ` + erDiagram + CUSTOMER ||--o{ ORDER : places + ORDER ||--|{ LINE-ITEM : contains + `, + ` + erDiagram + CUSTOMER ||--o{ ORDER : places + ORDER ||--|{ LINE-ITEM : contains + `, + ], + { logLevel: 1 } + ); + }); + + it('should render an ER diagram with blank or empty labels', () => { + imgSnapshotTest( + ` + erDiagram + BOOK }|..|{ AUTHOR : "" + BOOK }|..|{ GENRE : " " + AUTHOR }|..|{ GENRE : " " + `, + { logLevel: 1 } + ); + }); + + it('should render entities that have no relationships', () => { + renderGraph( + ` + erDiagram + DEAD_PARROT + HERMIT + RECLUSE + SOCIALITE }o--o{ SOCIALITE : "interacts with" + RECLUSE }o--o{ SOCIALITE : avoids + `, + { logLevel: 1 } + ); + }); + + it('should render entities with and without attributes', () => { + renderGraph( + ` + erDiagram + BOOK { string title } + AUTHOR }|..|{ BOOK : writes + BOOK { float price } + `, + { logLevel: 1 } + ); + }); + + it('should render entities with generic and array attributes', () => { + renderGraph( + ` + erDiagram + BOOK { + string title + string[] authors + type~T~ type + } + `, + { logLevel: 1 } + ); + }); + + it('should render entities with generic and array attributes without htmlLabels', () => { + renderGraph( + ` + erDiagram + BOOK { + string title + string[] authors + type~T~ type + } + `, + { logLevel: 1, htmlLabels: false } + ); + }); + + it('should render entities with length in attributes type', () => { + renderGraph( + ` + erDiagram + CLUSTER { + varchar(99) name + string(255) description + } + `, + { logLevel: 1 } + ); + }); + + it('should render entities with length in attributes type without htmlLabels', () => { + renderGraph( + ` + erDiagram + CLUSTER { + varchar(99) name + string(255) description + } + `, + { logLevel: 1, htmlLabels: false } + ); + }); + + it('should render entities and attributes with big and small entity names', () => { + renderGraph( + ` + erDiagram + PRIVATE_FINANCIAL_INSTITUTION { + string name + int turnover + } + PRIVATE_FINANCIAL_INSTITUTION ||..|{ EMPLOYEE : employs + EMPLOYEE { bool officer_of_firm } + `, + { logLevel: 1 } + ); + }); + + it('should render entities and attributes with big and small entity names without htmlLabels', () => { + renderGraph( + ` + erDiagram + PRIVATE_FINANCIAL_INSTITUTION { + string name + int turnover + } + PRIVATE_FINANCIAL_INSTITUTION ||..|{ EMPLOYEE : employs + EMPLOYEE { bool officer_of_firm } + `, + { logLevel: 1, htmlLabels: false } + ); + }); + + it('should render entities with attributes that begin with asterisk', () => { + imgSnapshotTest( + ` + erDiagram + BOOK { + int *id + string name + varchar(99) summary + } + BOOK }o..o{ STORE : soldBy + STORE { + int *id + string name + varchar(50) address + } + `, + { loglevel: 1 } + ); + }); + + it('should render entities with attributes that begin with asterisk without htmlLabels', () => { + imgSnapshotTest( + ` + erDiagram + BOOK { + int *id + string name + varchar(99) summary + } + BOOK }o..o{ STORE : soldBy + STORE { + int *id + string name + varchar(50) address + } + `, + { loglevel: 1, htmlLabels: false } + ); + }); + + it('should render entities with keys', () => { + renderGraph( + ` + erDiagram + AUTHOR_WITH_LONG_ENTITY_NAME { + string name PK + } + AUTHOR_WITH_LONG_ENTITY_NAME }|..|{ BOOK : writes + BOOK { + float price + string author FK + string title PK + } + `, + { logLevel: 1 } + ); + }); + + it('should render entities with keys without htmlLabels', () => { + renderGraph( + ` + erDiagram + AUTHOR_WITH_LONG_ENTITY_NAME { + string name PK + } + AUTHOR_WITH_LONG_ENTITY_NAME }|..|{ BOOK : writes + BOOK { + float price + string author FK + string title PK + } + `, + { logLevel: 1, htmlLabels: false } + ); + }); + + it('should render entities with comments', () => { + renderGraph( + ` + erDiagram + AUTHOR_WITH_LONG_ENTITY_NAME { + string name "comment" + } + AUTHOR_WITH_LONG_ENTITY_NAME }|..|{ BOOK : writes + BOOK { + string author + string title "author comment" + float price "price comment" + } + `, + { logLevel: 1 } + ); + }); + + it('should render entities with comments without htmlLabels', () => { + renderGraph( + ` + erDiagram + AUTHOR_WITH_LONG_ENTITY_NAME { + string name "comment" + } + AUTHOR_WITH_LONG_ENTITY_NAME }|..|{ BOOK : writes + BOOK { + string author + string title "author comment" + float price "price comment" + } + `, + { logLevel: 1, htmlLabels: false } + ); + }); + + it('should render entities with keys and comments', () => { + renderGraph( + ` + erDiagram + AUTHOR_WITH_LONG_ENTITY_NAME { + string name PK "comment" + } + AUTHOR_WITH_LONG_ENTITY_NAME }|..|{ BOOK : writes + BOOK { + string description + float price "price comment" + string title PK "title comment" + string author FK + } + `, + { logLevel: 1 } + ); + }); + + it('should render entities with keys and comments without htmlLabels', () => { + renderGraph( + ` + erDiagram + AUTHOR_WITH_LONG_ENTITY_NAME { + string name PK "comment" + } + AUTHOR_WITH_LONG_ENTITY_NAME }|..|{ BOOK : writes + BOOK { + string description + float price "price comment" + string title PK "title comment" + string author FK + } + `, + { logLevel: 1, htmlLabels: false } + ); + }); + + it('should render entities with aliases', () => { + renderGraph( + ` + erDiagram + T1 one or zero to one or more T2 : test + T2 one or many optionally to zero or one T3 : test + T3 zero or more to zero or many T4 : test + T4 many(0) to many(1) T5 : test + T5 many optionally to one T6 : test + T6 only one optionally to only one T1 : test + T4 0+ to 1+ T6 : test + T1 1 to 1 T3 : test + `, + { logLevel: 1 } + ); + }); + + it('1433: should render a simple ER diagram with a title', () => { + imgSnapshotTest( + `--- +title: simple ER diagram +--- +erDiagram +CUSTOMER ||--o{ ORDER : places +ORDER ||--|{ LINE-ITEM : contains +`, + {} + ); + }); + + it('should render entities with entity name aliases', () => { + imgSnapshotTest( + ` + erDiagram + p[Person] { + varchar(64) firstName + varchar(64) lastName + } + c["Customer Account"] { + varchar(128) email + } + p ||--o| c : has + `, + { logLevel: 1 } + ); + }); + + it('should render relationship labels with line breaks', () => { + imgSnapshotTest( + ` + erDiagram + p[Person] { + string firstName + string lastName + } + a["Customer Account"] { + string email + } + + b["Customer Account Secondary"] { + string email + } + + c["Customer Account Tertiary"] { + string email + } + + d["Customer Account Nth"] { + string email + } + + p ||--o| a : "has
one" + p ||--o| b : "has
one
two" + p ||--o| c : "has
one
two
three" + p ||--o| d : "has
one
two
three
...
Nth" + `, + { logLevel: 1 } + ); + }); + + it('should render an ER diagram with unicode text', () => { + imgSnapshotTest( + ` + erDiagram + _**testẽζ➕Ø😀㌕ぼ**_ { + *__List~List~int~~sdfds__* **driversLicense** PK "***The l😀icense #***" + *string(99)~T~~~~~~* firstName "Only __99__
characters are a
llowed dsfsdfsdfsdfs" + string last*Name* + string __phone__ UK + int _age_ + } + `, + { logLevel: 1 } + ); + }); + + it('should render an ER diagram with unicode text without htmlLabels', () => { + imgSnapshotTest( + ` + erDiagram + _**testẽζ➕Ø😀㌕ぼ**_ { + *__List~List~int~~sdfds__* **driversLicense** PK "***The l😀icense #***" + *string(99)~T~~~~~~* firstName "Only __99__
characters are a
llowed dsfsdfsdfsdfs" + string last*Name* + string __phone__ UK + int _age_ + } + `, + { logLevel: 1, htmlLabels: false } + ); + }); + + it('should render an ER diagram with relationships with unicode text', () => { + imgSnapshotTest( + ` + erDiagram + person[😀] { + string *first*Name + string _**last**Name_ + } + a["*Customer Account*"] { + **string** ema*i*l + } + person ||--o| a : __hẽ😀__ + `, + { logLevel: 1 } + ); + }); + + it('should render an ER diagram with relationships with unicode text without htmlLabels', () => { + imgSnapshotTest( + ` + erDiagram + person[😀] { + string *first*Name + string _**last**Name_ + } + a["*Customer Account*"] { + **string** ema*i*l + } + person ||--o| a : __hẽ😀__ + `, + { logLevel: 1, htmlLabels: false } + ); + }); + + it('should render an ER diagram with TB direction', () => { + imgSnapshotTest( + ` + erDiagram + direction TB + CAR ||--|{ NAMED-DRIVER : allows + PERSON ||..o{ NAMED-DRIVER : is + `, + { logLevel: 1 } + ); + }); + + it('should render an ER diagram with BT direction', () => { + imgSnapshotTest( + ` + erDiagram + direction BT + CAR ||--|{ NAMED-DRIVER : allows + PERSON ||..o{ NAMED-DRIVER : is + `, + { logLevel: 1 } + ); + }); + + it('should render an ER diagram with LR direction', () => { + imgSnapshotTest( + ` + erDiagram + direction LR + CAR ||--|{ NAMED-DRIVER : allows + PERSON ||..o{ NAMED-DRIVER : is + `, + { logLevel: 1 } + ); + }); + + it('should render an ER diagram with RL direction', () => { + imgSnapshotTest( + ` + erDiagram + direction RL + CAR ||--|{ NAMED-DRIVER : allows + PERSON ||..o{ NAMED-DRIVER : is + `, + { logLevel: 1 } + ); + }); + + it('should render entities with styles applied from style statement', () => { + imgSnapshotTest( + ` + erDiagram + c[CUSTOMER] + p[PERSON] + style c,p fill:#f9f,stroke:blue, color:grey, font-size:24px,font-weight:bold + `, + { logLevel: 1 } + ); + }); + + it('should render entities with styles applied from style statement without htmlLabels', () => { + imgSnapshotTest( + ` + erDiagram + c[CUSTOMER] + p[PERSON] + style c,p fill:#f9f,stroke:blue, color:grey, font-size:24px,font-weight:bold + `, + { logLevel: 1, htmlLabels: false } + ); + }); + + it('should render entities with styles applied from class statement', () => { + imgSnapshotTest( + ` + erDiagram + c[CUSTOMER] + p[PERSON]:::blue + classDef bold font-size:24px, font-weight: bold + classDef blue stroke:lightblue, color: #0000FF + class c,p bold + `, + { logLevel: 1 } + ); + }); + + it('should render entities with styles applied from class statement without htmlLabels', () => { + imgSnapshotTest( + ` + erDiagram + c[CUSTOMER] + p[PERSON]:::blue + classDef bold font-size:24px, font-weight: bold + classDef blue stroke:lightblue, color: #0000FF + class c,p bold + `, + { logLevel: 1, htmlLabels: false } + ); + }); + + it('should render entities with the handDrawn look', () => { + imgSnapshotTest( + ` + erDiagram + c[CUSTOMER] + p[PERSON] + `, + { logLevel: 1, look: 'handDrawn' } + ); + }); + + it('should render entities with the handDrawn look without htmlLabels', () => { + imgSnapshotTest( + ` + erDiagram + c[CUSTOMER] + p[PERSON] + `, + { logLevel: 1, look: 'handDrawn', htmlLabels: false } + ); + }); + + it('should render entities with the handDrawn look and styles applied', () => { + imgSnapshotTest( + ` + erDiagram + c[CUSTOMER] + p[PERSON]:::blue + classDef bold font-size:24px, font-weight: bold + classDef blue stroke:black, fill:lightblue, color: #0000FF + class c,p bold + `, + { logLevel: 1, look: 'handDrawn' } + ); + }); + + it('should render entities with the handDrawn look and styles applied without htmlLabels', () => { + imgSnapshotTest( + ` + erDiagram + c[CUSTOMER] + p[PERSON]:::blue + classDef bold font-size:24px, font-weight: bold + classDef blue stroke:black, fill:lightblue, color: #0000FF + class c,p bold + `, + { logLevel: 1, look: 'handDrawn', htmlLabels: false } + ); + }); +}); diff --git a/packages/mermaid/src/diagrams/er/parser/erDiagram.spec.js b/packages/mermaid/src/diagrams/er/parser/erDiagram.spec.js index e36454f31..aad485aea 100644 --- a/packages/mermaid/src/diagrams/er/parser/erDiagram.spec.js +++ b/packages/mermaid/src/diagrams/er/parser/erDiagram.spec.js @@ -143,32 +143,32 @@ describe('when parsing ER diagram it...', function () { expect(entities.get(entity).alias).toBe(alias); }); - it('can have an alias even if the relationship is defined before class', function () { + it('can have an alias even if the relationship is defined before buzz', function () { const firstEntity = 'foo'; const secondEntity = 'bar'; const alias = 'batman'; erDiagram.parser.parse( - `erDiagram\n${firstEntity} ||--o| ${secondEntity} : rel\nclass ${firstEntity}["${alias}"]\n` + `erDiagram\n${firstEntity} ||--o| ${secondEntity} : rel\nbuzz ${firstEntity}["${alias}"]\n` ); const entities = erDb.getEntities(); expect(entities.has(firstEntity)).toBe(true); expect(entities.has(secondEntity)).toBe(true); expect(entities.get(firstEntity).alias).toBe(alias); - expect(entities.get(secondEntity).alias).toBeUndefined(); + expect(entities.get(secondEntity).alias).toBe(''); }); - it('can have an alias even if the relationship is defined after class', function () { + it('can have an alias even if the relationship is defined after buzz', function () { const firstEntity = 'foo'; const secondEntity = 'bar'; const alias = 'batman'; erDiagram.parser.parse( - `erDiagram\nclass ${firstEntity}["${alias}"]\n${firstEntity} ||--o| ${secondEntity} : rel\n` + `erDiagram\nbuzz ${firstEntity}["${alias}"]\n${firstEntity} ||--o| ${secondEntity} : rel\n` ); const entities = erDb.getEntities(); expect(entities.has(firstEntity)).toBe(true); expect(entities.has(secondEntity)).toBe(true); expect(entities.get(firstEntity).alias).toBe(alias); - expect(entities.get(secondEntity).alias).toBeUndefined(); + expect(entities.get(secondEntity).alias).toBe(''); }); it('can start with an underscore', function () { @@ -193,9 +193,9 @@ describe('when parsing ER diagram it...', function () { expect(entities.size).toBe(1); expect(entities.get(entity).attributes.length).toBe(3); - expect(entities.get(entity).attributes[0].attributeName).toBe('myBookTitle'); - expect(entities.get(entity).attributes[1].attributeName).toBe('MYBOOKSUBTITLE_1'); - expect(entities.get(entity).attributes[2].attributeName).toBe('author-ref[name](1)'); + expect(entities.get(entity).attributes[0].name).toBe('myBookTitle'); + expect(entities.get(entity).attributes[1].name).toBe('MYBOOKSUBTITLE_1'); + expect(entities.get(entity).attributes[2].name).toBe('author-ref[name](1)'); }); it('should allow asterisk at the start of attribute name', function () { @@ -258,7 +258,7 @@ describe('when parsing ER diagram it...', function () { const entities = erDb.getEntities(); expect(entities.size).toBe(1); expect(entities.get(entity).attributes.length).toBe(1); - expect(entities.get(entity).attributes[0].attributeComment).toBe('comment'); + expect(entities.get(entity).attributes[0].comment).toBe('comment'); }); it('should allow an entity with a single attribute to be defined with a key and a comment', function () { @@ -297,14 +297,14 @@ describe('when parsing ER diagram it...', function () { `erDiagram\n${entity} {\n${attribute1}\n${attribute2}\n${attribute3}\n${attribute4}\n${attribute5}\n}` ); const entities = erDb.getEntities(); - expect(entities.get(entity).attributes[0].attributeKeyTypeList).toEqual(['PK', 'FK']); - expect(entities.get(entity).attributes[0].attributeComment).toBe('comment1'); - expect(entities.get(entity).attributes[1].attributeKeyTypeList).toEqual(['PK', 'UK', 'FK']); - expect(entities.get(entity).attributes[2].attributeKeyTypeList).toEqual(['PK', 'UK']); - expect(entities.get(entity).attributes[2].attributeComment).toBe('comment3'); - expect(entities.get(entity).attributes[3].attributeKeyTypeList).toBeUndefined(); - expect(entities.get(entity).attributes[4].attributeKeyTypeList).toBeUndefined(); - expect(entities.get(entity).attributes[4].attributeComment).toBe('comment5'); + expect(entities.get(entity).attributes[0].keys).toEqual(['PK', 'FK']); + expect(entities.get(entity).attributes[0].comment).toBe('comment1'); + expect(entities.get(entity).attributes[1].keys).toEqual(['PK', 'UK', 'FK']); + expect(entities.get(entity).attributes[2].keys).toEqual(['PK', 'UK']); + expect(entities.get(entity).attributes[2].comment).toBe('comment3'); + expect(entities.get(entity).attributes[3].keys).toEqual([]); + expect(entities.get(entity).attributes[4].keys).toEqual([]); + expect(entities.get(entity).attributes[4].comment).toBe('comment5'); }); it('should allow an entity with attribute that has a generic type', function () { @@ -341,8 +341,8 @@ describe('when parsing ER diagram it...', function () { const entities = erDb.getEntities(); expect(entities.size).toBe(1); expect(entities.get(entity).attributes.length).toBe(2); - expect(entities.get(entity).attributes[0].attributeType).toBe('character(10)'); - expect(entities.get(entity).attributes[1].attributeType).toBe('varchar(5)'); + expect(entities.get(entity).attributes[0].type).toBe('character(10)'); + expect(entities.get(entity).attributes[1].type).toBe('varchar(5)'); }); it('should allow an entity with multiple attributes to be defined', function () { @@ -764,6 +764,186 @@ describe('when parsing ER diagram it...', function () { }).toThrowError(); }); + it('should be possible to apply a style to an entity', function () { + const entityName = 'CUSTOMER'; + erDiagram.parser.parse(`erDiagram\n${entityName}\nstyle ${entityName} color:red`); + + expect(erDb.getEntity(entityName).cssStyles).toEqual(['color:red']); + }); + + it('should be possible to apply multiple styles to an entity at the same time', function () { + const entityName = 'CUSTOMER'; + erDiagram.parser.parse( + `erDiagram\n${entityName}\nstyle ${entityName} color:red,stroke:blue,fill:#f9f` + ); + + expect(erDb.getEntity(entityName).cssStyles).toEqual(['color:red', 'stroke:blue', 'fill:#f9f']); + }); + + it('should be possible to apply multiple separately defined styles', function () { + const entityName = 'CUSTOMER'; + erDiagram.parser.parse( + `erDiagram\n${entityName}\nstyle ${entityName} color:red\nstyle ${entityName} fill:#f9f` + ); + + expect(erDb.getEntity(entityName).cssStyles).toEqual(['color:red', 'fill:#f9f']); + }); + + it('should be possible to assign a class to an entity', function () { + const entityName = 'CUSTOMER'; + erDiagram.parser.parse(`erDiagram\n${entityName}\nclass ${entityName} myClass`); + + expect(erDb.getEntity(entityName).cssClasses).toEqual(['default', 'myClass']); + }); + + it('should be possible to assign multiple classes to an entity at the same time', function () { + const entityName = 'CUSTOMER'; + erDiagram.parser.parse( + `erDiagram\n${entityName}\nclass ${entityName} firstClass, secondClass, thirdClass` + ); + + expect(erDb.getEntity(entityName).cssClasses).toEqual([ + 'default', + 'firstClass', + 'secondClass', + 'thirdClass', + ]); + }); + + it('should be possible to assign multiple separately defined classes to an entity', function () { + const entityName = 'CUSTOMER'; + erDiagram.parser.parse( + `erDiagram\n${entityName}\nclass ${entityName} firstClass\nclass ${entityName} secondClass` + ); + + expect(erDb.getEntity(entityName).cssClasses).toEqual(['default', 'firstClass', 'secondClass']); + }); + + it('should be possible to configure the default class and have it apply to each entity', function () { + const firstEntity = 'ENTITY1'; + const secondEntity = 'ENTITY2'; + erDiagram.parser.parse( + `erDiagram\n${firstEntity}\n${secondEntity}\nclassDef default fill:#f9f` + ); + + const expectedOutput = new Map([ + [ + 'default', + { + id: 'default', + styles: ['fill:#f9f'], + textStyles: [], + }, + ], + ]); + + expect(erDb.getEntity(firstEntity).cssClasses).toEqual(['default']); + expect(erDb.getEntity(secondEntity).cssClasses).toEqual(['default']); + expect(erDb.getClasses()).toEqual(expectedOutput); + }); + + it('should be possible to define a class with styles', function () { + const className = 'myClass'; + const styles = 'fill:#f9f, stroke: red, color: pink'; + erDiagram.parser.parse(`erDiagram\nclassDef ${className} ${styles}`); + + const expectedOutput = new Map([ + [ + className, + { + id: className, + styles: ['fill:#f9f', 'stroke:red', 'color:pink'], + textStyles: ['color:pink'], + }, + ], + ]); + + expect(erDb.getClasses()).toEqual(expectedOutput); + }); + + it('should be possible to define multiple class with styles at the same time', function () { + const firstClass = 'firstClass'; + const secondClass = 'secondClass'; + const styles = 'fill:#f9f, stroke: red, color: pink'; + erDiagram.parser.parse(`erDiagram\nclassDef ${firstClass},${secondClass} ${styles}`); + + const expectedOutput = new Map([ + [ + firstClass, + { + id: firstClass, + styles: ['fill:#f9f', 'stroke:red', 'color:pink'], + textStyles: ['color:pink'], + }, + ], + [ + secondClass, + { + id: secondClass, + styles: ['fill:#f9f', 'stroke:red', 'color:pink'], + textStyles: ['color:pink'], + }, + ], + ]); + + expect(erDb.getClasses()).toEqual(expectedOutput); + }); + + it('should be possible to assign a class using the shorthand syntax just by itself', function () { + const entityName = 'CUSTOMER'; + const className = 'myClass'; + erDiagram.parser.parse(`erDiagram\n${entityName}:::${className}`); + + expect(erDb.getEntity(entityName).cssClasses).toEqual(['default', 'myClass']); + }); + + it('should be possible to assign a class using the shorthand syntax with empty block', function () { + const entityName = 'CUSTOMER'; + const className = 'myClass'; + erDiagram.parser.parse(`erDiagram\n${entityName}:::${className} {}`); + + expect(erDb.getEntity(entityName).cssClasses).toEqual(['default', 'myClass']); + }); + + it('should be possible to assign a class using the shorthand syntax with block of attributes', function () { + const entityName = 'CUSTOMER'; + const className = 'myClass'; + erDiagram.parser.parse(`erDiagram\n${entityName}:::${className} {\nstring name\n}`); + + expect(erDb.getEntity(entityName).cssClasses).toEqual(['default', 'myClass']); + }); + + it('should be possible to assign multiple classes using the shorthand syntax', function () { + const entityName = 'CUSTOMER'; + const firstClass = 'firstClass'; + const secondClass = 'secondClass'; + erDiagram.parser.parse(`erDiagram\n${entityName}:::${firstClass},${secondClass}`); + + expect(erDb.getEntity(entityName).cssClasses).toEqual(['default', 'firstClass', 'secondClass']); + }); + + it('should be possible to assign classes using the shorthand syntax after defining an alias', function () { + const entityName = 'c'; + const entityAlias = 'CUSTOMER'; + const myClass = 'myClass'; + erDiagram.parser.parse(`erDiagram\n${entityName}[${entityAlias}]:::${myClass}`); + + expect(erDb.getEntity(entityName).alias).toBe(entityAlias); + expect(erDb.getEntity(entityName).cssClasses).toEqual(['default', 'myClass']); + }); + + it('should be possible to assign classes using the shorthand syntax while defining a relationship', function () { + const entityName = 'CUSTOMER'; + const otherEntity = 'PERSON'; + const myClass = 'myClass'; + erDiagram.parser.parse( + `erDiagram\n${entityName}:::${myClass} ||--o{ ${otherEntity}:::${myClass} : allows` + ); + + expect(erDb.getEntity(entityName).cssClasses).toEqual(['default', 'myClass']); + expect(erDb.getEntity(otherEntity).cssClasses).toEqual(['default', 'myClass']); + }); + describe('relationship labels', function () { it('should allow an empty quoted label', function () { erDiagram.parser.parse('erDiagram\nCUSTOMER ||--|{ ORDER : ""'); From 1d4ea56740b106f99e90bc01aa5ea849b62bfa36 Mon Sep 17 00:00:00 2001 From: yari-dewalt Date: Tue, 15 Oct 2024 11:44:58 -0700 Subject: [PATCH 011/242] Support direction data --- packages/mermaid/src/diagrams/er/erDb.ts | 2 +- packages/mermaid/src/diagrams/er/erRenderer-unified.ts | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/packages/mermaid/src/diagrams/er/erDb.ts b/packages/mermaid/src/diagrams/er/erDb.ts index ef0b5382d..ccf543797 100644 --- a/packages/mermaid/src/diagrams/er/erDb.ts +++ b/packages/mermaid/src/diagrams/er/erDb.ts @@ -110,7 +110,7 @@ const addRelationship = function (entA: string, rolA: string, entB: string, rSpe const getRelationships = () => relationships; -const getDirection = () => direction; +export const getDirection = () => direction; const setDirection = (dir: string) => { direction = dir; }; diff --git a/packages/mermaid/src/diagrams/er/erRenderer-unified.ts b/packages/mermaid/src/diagrams/er/erRenderer-unified.ts index be668df69..4679a6f04 100644 --- a/packages/mermaid/src/diagrams/er/erRenderer-unified.ts +++ b/packages/mermaid/src/diagrams/er/erRenderer-unified.ts @@ -4,7 +4,7 @@ import { getDiagramElement } from '../../rendering-util/insertElementsForSize.js import { getRegisteredLayoutAlgorithm, render } from '../../rendering-util/render.js'; import { setupViewPortForSVG } from '../../rendering-util/setupViewPortForSVG.js'; import type { LayoutData } from '../../rendering-util/types.js'; -import db from './erDb.js'; +import { getDirection } from './erDb.js'; import utils from '../../utils.js'; export const draw = async function (text: string, id: string, _version: string, diag: any) { @@ -25,7 +25,7 @@ export const draw = async function (text: string, id: string, _version: string, // Workaround as when rendering and setting up the graph it uses flowchart spacing before data4Layout spacing? data4Layout.config.flowchart!.nodeSpacing = conf?.nodeSpacing || 140; data4Layout.config.flowchart!.rankSpacing = conf?.rankSpacing || 80; - data4Layout.direction = db.getDirection(); + data4Layout.direction = getDirection(); data4Layout.markers = ['only_one', 'zero_or_one', 'one_or_more', 'zero_or_more']; data4Layout.diagramId = id; From b5da91b29a79bd0ceb097480b62e659ed0c406e4 Mon Sep 17 00:00:00 2001 From: yari-dewalt Date: Tue, 15 Oct 2024 11:45:59 -0700 Subject: [PATCH 012/242] Update --- cypress/platform/yari2.html | 163 ++++++++++++++++++++-- pnpm-lock.yaml | 262 +++++++++++++++++++++++++++++------- 2 files changed, 363 insertions(+), 62 deletions(-) diff --git a/cypress/platform/yari2.html b/cypress/platform/yari2.html index 35fa2493b..9c3ce490c 100644 --- a/cypress/platform/yari2.html +++ b/cypress/platform/yari2.html @@ -15,7 +15,7 @@ _**hiØ**_[*test*] { *__List~List~int~~sdfds__* __driversLicense__ PK "***The l😀icense #***" *string(99)~T~~~~~~* firstName "Only 99
characters are a
llowed dsfsdfsdfsdfs" - string lastName + ~str ing~ lastName string phone UK int age } @@ -27,15 +27,23 @@

Basic ErNode

-          ---
-            config:
-              htmlLabels: true
-              look: handDrawn
-          ---
           erDiagram
-            c[CUST😀OMER]
-            p[__PERSON__]
-            style c,p fill:#f9f,stroke:blue, color:grey, font-size:24px,font-weight:bold
+            CAR {
+                string registrationNumber
+                string make
+                string model
+            }
+            PERSON {
+                string firstName
+                string lastName
+                int age
+            }
+
+            CAR:::someclass
+            PERSON:::anotherclass,someclass
+        
+            classDef someclass fill:#f96
+            classDef anotherclass color:blue
@@ -59,7 +67,7 @@ --- config: htmlLabels: false - look: + look: --- erDiagram CAR ||--|{ NAMED-DRIVER : allows @@ -121,10 +129,139 @@

Basic Relationship

+---
+  config:
+    layout: elk
+---
           erDiagram
-            CUSTOMER ||--o{ CUSTOMER : refers
-            CUSTOMER ||--o{ ORDER : places
-            ORDER ||--|{ LINE-ITEM : contains
+          rental{
+                  ~timestamp with time zone~ rental_date "NN"
+                  ~integer~ inventory_id "NN"
+                  ~integer~ customer_id "NN"
+                  ~timestamp with time zone~ return_date
+                  ~integer~ staff_id "NN"
+                  ~integer~ rental_id "NN"
+                  ~timestamp with time zone~ last_update "NN"
+  }
+          film_actor{
+                  ~integer~ actor_id "NN"
+                  ~integer~ film_id "NN"
+                  ~timestamp with time zone~ last_update "NN"
+  }
+          film{
+                  ~text~ title "NN"
+                  ~text~ description
+                  ~public.year~ release_year
+                  ~integer~ language_id "NN"
+                  ~integer~ original_language_id
+                  ~smallint~ length
+                  ~text[]~ special_features
+                  ~tsvector~ fulltext "NN"
+                  ~integer~ film_id "NN"
+                  ~smallint~ rental_duration "NN"
+                  ~numeric(4,2)~ rental_rate "NN"
+                  ~numeric(5,2)~ replacement_cost "NN"
+                  ~public.mpaa_rating~ rating
+                  ~timestamp with time zone~ last_update "NN"
+  }
+          customer{
+                  ~integer~ store_id "NN"
+                  ~text~ first_name "NN"
+                  ~text~ last_name "NN"
+                  ~text~ email
+                  ~integer~ address_id "NN"
+                  ~integer~ active
+                  ~integer~ customer_id "NN"
+                  ~boolean~ activebool "NN"
+                  ~date~ create_date "NN"
+                  ~timestamp with time zone~ last_update
+  }
+          film_category{
+                  ~integer~ film_id "NN"
+                  ~integer~ category_id "NN"
+                  ~timestamp with time zone~ last_update "NN"
+  }
+          actor{
+                  ~text~ first_name "NN"
+                  ~text~ last_name "NN"
+                  ~integer~ actor_id "NN"
+                  ~timestamp with time zone~ last_update "NN"
+  }
+          store{
+                  ~integer~ manager_staff_id "NN"
+                  ~integer~ address_id "NN"
+                  ~integer~ store_id "NN"
+                  ~timestamp with time zone~ last_update "NN"
+  }
+          city{
+                  ~text~ city "NN"
+                  ~integer~ country_id "NN"
+                  ~integer~ city_id "NN"
+                  ~timestamp with time zone~ last_update "NN"
+  }
+          language{
+                  ~character(20)~ name "NN"
+                  ~integer~ language_id "NN"
+                  ~timestamp with time zone~ last_update "NN"
+  }
+          payment{
+                  ~integer~ customer_id "NN"
+                  ~integer~ staff_id "NN"
+                  ~integer~ rental_id "NN"
+                  ~numeric(5,2)~ amount "NN"
+                  ~timestamp with time zone~ payment_date "NN"
+                  ~integer~ payment_id "NN"
+  }
+          category{
+                  ~text~ name "NN"
+                  ~integer~ category_id "NN"
+                  ~timestamp with time zone~ last_update "NN"
+  }
+          inventory{
+                  ~integer~ film_id "NN"
+                  ~integer~ store_id "NN"
+                  ~integer~ inventory_id "NN"
+                  ~timestamp with time zone~ last_update "NN"
+  }
+          address{
+                  ~text~ address "NN"
+                  ~text~ address2
+                  ~text~ district "NN"
+                  ~integer~ city_id "NN"
+                  ~text~ postal_code
+                  ~text~ phone "NN"
+                  ~integer~ address_id "NN"
+                  ~timestamp with time zone~ last_update "NN"
+  }
+          staff{
+                  ~text~ first_name "NN"
+                  ~text~ last_name "NN"
+                  ~integer~ address_id "NN"
+                  ~text~ email
+                  ~integer~ store_id "NN"
+                  ~text~ username "NN"
+                  ~text~ password
+                  ~bytea~ picture
+                  ~integer~ staff_id "NN"
+                  ~boolean~ active "NN"
+                  ~timestamp with time zone~ last_update "NN"
+  }
+          country{
+                  ~text~ country "NN"
+                  ~integer~ country_id "NN"
+                  ~timestamp with time zone~ last_update "NN"
+  }
+  film_actor }|..|| film : film_actor_film_id_fkey
+  film_actor }|..|| actor : film_actor_actor_id_fkey
+  address }|..|| city : address_city_id_fkey
+  city }|..|| country : city_country_id_fkey
+  customer }|..|| store : customer_store_id_fkey
+  customer }|..|| address : customer_address_id_fkey
+  film }|..|| language : film_original_language_id_fkey
+  film }|..|| language : film_language_id_fkey
+  film_category }|..|| film : film_category_film_id_fkey
+  film_category }|..|| category : film_category_category_id_fkey
+  inventory }|..|| store : inventory_store_id_fkey
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index b23b384b6..9045a46db 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -443,6 +443,67 @@ importers: version: link:../mermaid packages/mermaid/src/docs: + dependencies: + '@mdi/font': + specifier: ^7.0.0 + version: 7.4.47 + '@vueuse/core': + specifier: ^10.9.0 + version: 10.11.1(vue@3.4.38(typescript@5.4.5)) + font-awesome: + specifier: ^4.7.0 + version: 4.7.0 + jiti: + specifier: ^1.21.0 + version: 1.21.6 + mermaid: + specifier: workspace:^ + version: link:../.. + vue: + specifier: ^3.4.21 + version: 3.4.38(typescript@5.4.5) + devDependencies: + '@iconify-json/carbon': + specifier: ^1.1.31 + version: 1.1.37 + '@unocss/reset': + specifier: ^0.59.0 + version: 0.59.4 + '@vite-pwa/vitepress': + specifier: ^0.4.0 + version: 0.4.0(vite-plugin-pwa@0.19.8(vite@5.4.2(@types/node@22.5.1)(terser@5.33.0))(workbox-build@7.1.1(@types/babel__core@7.20.5))(workbox-window@7.1.0)) + '@vitejs/plugin-vue': + specifier: ^5.0.0 + version: 5.1.2(vite@5.4.2(@types/node@22.5.1)(terser@5.33.0))(vue@3.4.38(typescript@5.4.5)) + fast-glob: + specifier: ^3.3.2 + version: 3.3.2 + https-localhost: + specifier: ^4.7.1 + version: 4.7.1 + pathe: + specifier: ^1.1.2 + version: 1.1.2 + unocss: + specifier: ^0.59.0 + version: 0.59.4(postcss@8.4.41)(rollup@4.21.1)(vite@5.4.2(@types/node@22.5.1)(terser@5.33.0)) + unplugin-vue-components: + specifier: ^0.26.0 + version: 0.26.0(@babel/parser@7.25.6)(rollup@4.21.1)(vue@3.4.38(typescript@5.4.5)) + vite: + specifier: ^5.0.0 + version: 5.4.2(@types/node@22.5.1)(terser@5.33.0) + vite-plugin-pwa: + specifier: ^0.19.7 + version: 0.19.8(vite@5.4.2(@types/node@22.5.1)(terser@5.33.0))(workbox-build@7.1.1(@types/babel__core@7.20.5))(workbox-window@7.1.0) + vitepress: + specifier: 1.1.4 + version: 1.1.4(@algolia/client-search@4.24.0)(@types/node@22.5.1)(axios@1.7.5)(postcss@8.4.41)(search-insights@2.15.0)(terser@5.33.0)(typescript@5.4.5) + workbox-window: + specifier: ^7.0.0 + version: 7.1.0 + + packages/mermaid/src/vitepress: dependencies: '@mdi/font': specifier: ^7.0.0 @@ -9600,7 +9661,7 @@ snapshots: '@argos-ci/util': 2.1.1 axios: 1.7.5(debug@4.3.7) convict: 6.2.4 - debug: 4.3.7 + debug: 4.3.7(supports-color@8.1.1) fast-glob: 3.3.2 sharp: 0.33.5 tmp: 0.2.3 @@ -9641,7 +9702,7 @@ snapshots: '@babel/traverse': 7.25.3 '@babel/types': 7.25.2 convert-source-map: 2.0.0 - debug: 4.3.7 + debug: 4.3.7(supports-color@8.1.1) gensync: 1.0.0-beta.2 json5: 2.2.3 semver: 6.3.1 @@ -9719,7 +9780,7 @@ snapshots: '@babel/core': 7.25.2 '@babel/helper-compilation-targets': 7.25.2 '@babel/helper-plugin-utils': 7.24.8 - debug: 4.3.7 + debug: 4.3.7(supports-color@8.1.1) lodash.debounce: 4.0.8 resolve: 1.22.8 transitivePeerDependencies: @@ -10444,7 +10505,7 @@ snapshots: '@babel/parser': 7.25.4 '@babel/template': 7.25.0 '@babel/types': 7.25.2 - debug: 4.3.7 + debug: 4.3.7(supports-color@8.1.1) globals: 11.12.0 transitivePeerDependencies: - supports-color @@ -10456,7 +10517,7 @@ snapshots: '@babel/parser': 7.25.6 '@babel/template': 7.25.0 '@babel/types': 7.25.6 - debug: 4.3.7 + debug: 4.3.7(supports-color@8.1.1) globals: 11.12.0 transitivePeerDependencies: - supports-color @@ -11008,7 +11069,7 @@ snapshots: '@babel/preset-env': 7.25.4(@babel/core@7.25.2) babel-loader: 9.1.3(@babel/core@7.25.2)(webpack@5.93.0(esbuild@0.21.5)) bluebird: 3.7.1 - debug: 4.3.6(supports-color@8.1.1) + debug: 4.3.7(supports-color@8.1.1) lodash: 4.17.21 webpack: 5.93.0(esbuild@0.21.5) transitivePeerDependencies: @@ -11209,7 +11270,7 @@ snapshots: '@eslint/config-array@0.18.0': dependencies: '@eslint/object-schema': 2.1.4 - debug: 4.3.7 + debug: 4.3.7(supports-color@8.1.1) minimatch: 3.1.2 transitivePeerDependencies: - supports-color @@ -11219,7 +11280,7 @@ snapshots: '@eslint/eslintrc@3.1.0': dependencies: ajv: 6.12.6 - debug: 4.3.7 + debug: 4.3.7(supports-color@8.1.1) espree: 10.1.0 globals: 14.0.0 ignore: 5.3.2 @@ -11304,7 +11365,7 @@ snapshots: '@antfu/install-pkg': 0.1.1 '@antfu/utils': 0.7.10 '@iconify/types': 2.0.0 - debug: 4.3.7 + debug: 4.3.7(supports-color@8.1.1) kolorist: 1.8.0 local-pkg: 0.5.0 mlly: 1.7.1 @@ -11702,14 +11763,6 @@ snapshots: picomatch: 2.3.1 rollup: 2.79.1 - '@rollup/pluginutils@5.1.0(rollup@2.79.1)': - dependencies: - '@types/estree': 1.0.5 - estree-walker: 2.0.2 - picomatch: 2.3.1 - optionalDependencies: - rollup: 2.79.1 - '@rollup/pluginutils@5.1.0(rollup@4.21.1)': dependencies: '@types/estree': 1.0.5 @@ -11726,6 +11779,14 @@ snapshots: optionalDependencies: rollup: 2.79.1 + '@rollup/pluginutils@5.1.2(rollup@4.21.1)': + dependencies: + '@types/estree': 1.0.6 + estree-walker: 2.0.2 + picomatch: 2.3.1 + optionalDependencies: + rollup: 4.21.1 + '@rollup/rollup-android-arm-eabi@4.21.1': optional: true @@ -12026,7 +12087,7 @@ snapshots: '@types/eslint@9.6.0': dependencies: - '@types/estree': 1.0.5 + '@types/estree': 1.0.6 '@types/json-schema': 7.0.15 '@types/estree@0.0.39': {} @@ -12279,7 +12340,7 @@ snapshots: '@typescript-eslint/types': 8.6.0 '@typescript-eslint/typescript-estree': 8.6.0(typescript@5.4.5) '@typescript-eslint/visitor-keys': 8.6.0 - debug: 4.3.7 + debug: 4.3.7(supports-color@8.1.1) eslint: 9.11.1(jiti@1.21.6) optionalDependencies: typescript: 5.4.5 @@ -12300,7 +12361,7 @@ snapshots: dependencies: '@typescript-eslint/typescript-estree': 8.6.0(typescript@5.4.5) '@typescript-eslint/utils': 8.6.0(eslint@9.11.1(jiti@1.21.6))(typescript@5.4.5) - debug: 4.3.7 + debug: 4.3.7(supports-color@8.1.1) ts-api-utils: 1.3.0(typescript@5.4.5) optionalDependencies: typescript: 5.4.5 @@ -12316,7 +12377,7 @@ snapshots: dependencies: '@typescript-eslint/types': 8.5.0 '@typescript-eslint/visitor-keys': 8.5.0 - debug: 4.3.7 + debug: 4.3.7(supports-color@8.1.1) fast-glob: 3.3.2 is-glob: 4.0.3 minimatch: 9.0.5 @@ -12331,7 +12392,7 @@ snapshots: dependencies: '@typescript-eslint/types': 8.6.0 '@typescript-eslint/visitor-keys': 8.6.0 - debug: 4.3.7 + debug: 4.3.7(supports-color@8.1.1) fast-glob: 3.3.2 is-glob: 4.0.3 minimatch: 9.0.5 @@ -12384,10 +12445,38 @@ snapshots: transitivePeerDependencies: - rollup + '@unocss/astro@0.59.4(rollup@4.21.1)(vite@5.4.2(@types/node@22.5.1)(terser@5.33.0))': + dependencies: + '@unocss/core': 0.59.4 + '@unocss/reset': 0.59.4 + '@unocss/vite': 0.59.4(rollup@4.21.1)(vite@5.4.2(@types/node@22.5.1)(terser@5.33.0)) + optionalDependencies: + vite: 5.4.2(@types/node@22.5.1)(terser@5.33.0) + transitivePeerDependencies: + - rollup + '@unocss/cli@0.59.4(rollup@2.79.1)': dependencies: '@ampproject/remapping': 2.3.0 - '@rollup/pluginutils': 5.1.0(rollup@2.79.1) + '@rollup/pluginutils': 5.1.2(rollup@2.79.1) + '@unocss/config': 0.59.4 + '@unocss/core': 0.59.4 + '@unocss/preset-uno': 0.59.4 + cac: 6.7.14 + chokidar: 3.6.0 + colorette: 2.0.20 + consola: 3.2.3 + fast-glob: 3.3.2 + magic-string: 0.30.11 + pathe: 1.1.2 + perfect-debounce: 1.0.0 + transitivePeerDependencies: + - rollup + + '@unocss/cli@0.59.4(rollup@4.21.1)': + dependencies: + '@ampproject/remapping': 2.3.0 + '@rollup/pluginutils': 5.1.2(rollup@4.21.1) '@unocss/config': 0.59.4 '@unocss/core': 0.59.4 '@unocss/preset-uno': 0.59.4 @@ -12514,7 +12603,23 @@ snapshots: '@unocss/vite@0.59.4(rollup@2.79.1)(vite@5.4.2(@types/node@22.5.1)(terser@5.33.0))': dependencies: '@ampproject/remapping': 2.3.0 - '@rollup/pluginutils': 5.1.0(rollup@2.79.1) + '@rollup/pluginutils': 5.1.2(rollup@2.79.1) + '@unocss/config': 0.59.4 + '@unocss/core': 0.59.4 + '@unocss/inspector': 0.59.4 + '@unocss/scope': 0.59.4 + '@unocss/transformer-directives': 0.59.4 + chokidar: 3.6.0 + fast-glob: 3.3.2 + magic-string: 0.30.11 + vite: 5.4.2(@types/node@22.5.1)(terser@5.33.0) + transitivePeerDependencies: + - rollup + + '@unocss/vite@0.59.4(rollup@4.21.1)(vite@5.4.2(@types/node@22.5.1)(terser@5.33.0))': + dependencies: + '@ampproject/remapping': 2.3.0 + '@rollup/pluginutils': 5.1.2(rollup@4.21.1) '@unocss/config': 0.59.4 '@unocss/core': 0.59.4 '@unocss/inspector': 0.59.4 @@ -12702,7 +12807,7 @@ snapshots: '@vueuse/shared': 10.11.1(vue@3.4.38(typescript@5.4.5)) vue-demi: 0.14.10(vue@3.4.38(typescript@5.4.5)) optionalDependencies: - axios: 1.7.5(debug@4.3.7) + axios: 1.7.5 focus-trap: 7.5.4 transitivePeerDependencies: - '@vue/composition-api' @@ -12714,7 +12819,7 @@ snapshots: '@vueuse/shared': 11.0.3(vue@3.4.38(typescript@5.4.5)) vue-demi: 0.14.10(vue@3.4.38(typescript@5.4.5)) optionalDependencies: - axios: 1.7.5(debug@4.3.7) + axios: 1.7.5 focus-trap: 7.5.4 transitivePeerDependencies: - '@vue/composition-api' @@ -12930,13 +13035,13 @@ snapshots: agent-base@6.0.2: dependencies: - debug: 4.3.7 + debug: 4.3.7(supports-color@8.1.1) transitivePeerDependencies: - supports-color agent-base@7.1.1: dependencies: - debug: 4.3.6(supports-color@8.1.1) + debug: 4.3.7(supports-color@8.1.1) transitivePeerDependencies: - supports-color @@ -13125,7 +13230,7 @@ snapshots: avvio@7.2.5: dependencies: archy: 1.0.0 - debug: 4.3.7 + debug: 4.3.7(supports-color@8.1.1) fastq: 1.17.1 queue-microtask: 1.2.3 transitivePeerDependencies: @@ -13143,6 +13248,15 @@ snapshots: transitivePeerDependencies: - debug + axios@1.7.5: + dependencies: + follow-redirects: 1.15.6(debug@4.3.6) + form-data: 4.0.0 + proxy-from-env: 1.1.0 + transitivePeerDependencies: + - debug + optional: true + axios@1.7.5(debug@4.3.7): dependencies: follow-redirects: 1.15.6(debug@4.3.7) @@ -14268,9 +14382,11 @@ snapshots: optionalDependencies: supports-color: 8.1.1 - debug@4.3.7: + debug@4.3.7(supports-color@8.1.1): dependencies: ms: 2.1.3 + optionalDependencies: + supports-color: 8.1.1 decamelize@1.2.0: {} @@ -14655,7 +14771,7 @@ snapshots: '@es-joy/jsdoccomment': 0.48.0 are-docs-informative: 0.0.2 comment-parser: 1.4.1 - debug: 4.3.7 + debug: 4.3.7(supports-color@8.1.1) escape-string-regexp: 4.0.0 eslint: 9.11.1(jiti@1.21.6) espree: 10.1.0 @@ -14742,7 +14858,7 @@ snapshots: ajv: 6.12.6 chalk: 4.1.2 cross-spawn: 7.0.3 - debug: 4.3.7 + debug: 4.3.7(supports-color@8.1.1) escape-string-regexp: 4.0.0 eslint-scope: 8.0.2 eslint-visitor-keys: 4.0.0 @@ -14951,7 +15067,7 @@ snapshots: extract-zip@2.0.1(supports-color@8.1.1): dependencies: - debug: 4.3.6(supports-color@8.1.1) + debug: 4.3.7(supports-color@8.1.1) get-stream: 5.2.0 yauzl: 2.10.0 optionalDependencies: @@ -15110,7 +15226,7 @@ snapshots: dependencies: chalk: 4.1.2 commander: 5.1.0 - debug: 4.3.7 + debug: 4.3.7(supports-color@8.1.1) transitivePeerDependencies: - supports-color @@ -15168,7 +15284,7 @@ snapshots: follow-redirects@1.15.6(debug@4.3.7): optionalDependencies: - debug: 4.3.7 + debug: 4.3.7(supports-color@8.1.1) font-awesome@4.7.0: {} @@ -15542,14 +15658,14 @@ snapshots: dependencies: '@tootallnate/once': 2.0.0 agent-base: 6.0.2 - debug: 4.3.7 + debug: 4.3.7(supports-color@8.1.1) transitivePeerDependencies: - supports-color http-proxy-agent@7.0.2: dependencies: agent-base: 7.1.1 - debug: 4.3.6(supports-color@8.1.1) + debug: 4.3.7(supports-color@8.1.1) transitivePeerDependencies: - supports-color @@ -15568,7 +15684,7 @@ snapshots: http-proxy@1.18.1: dependencies: eventemitter3: 4.0.7 - follow-redirects: 1.15.6(debug@4.3.7) + follow-redirects: 1.15.6(debug@4.3.6) requires-port: 1.0.0 transitivePeerDependencies: - debug @@ -15598,14 +15714,14 @@ snapshots: https-proxy-agent@5.0.1: dependencies: agent-base: 6.0.2 - debug: 4.3.7 + debug: 4.3.7(supports-color@8.1.1) transitivePeerDependencies: - supports-color https-proxy-agent@7.0.5: dependencies: agent-base: 7.1.1 - debug: 4.3.6(supports-color@8.1.1) + debug: 4.3.7(supports-color@8.1.1) transitivePeerDependencies: - supports-color @@ -15901,7 +16017,7 @@ snapshots: istanbul-lib-source-maps@4.0.1: dependencies: - debug: 4.3.7 + debug: 4.3.7(supports-color@8.1.1) istanbul-lib-coverage: 3.2.2 source-map: 0.6.1 transitivePeerDependencies: @@ -15910,7 +16026,7 @@ snapshots: istanbul-lib-source-maps@5.0.6: dependencies: '@jridgewell/trace-mapping': 0.3.25 - debug: 4.3.6(supports-color@8.1.1) + debug: 4.3.7(supports-color@8.1.1) istanbul-lib-coverage: 3.2.2 transitivePeerDependencies: - supports-color @@ -17011,7 +17127,7 @@ snapshots: micromark@2.11.4: dependencies: - debug: 4.3.7 + debug: 4.3.7(supports-color@8.1.1) parse-entities: 2.0.0 transitivePeerDependencies: - supports-color @@ -17019,7 +17135,7 @@ snapshots: micromark@4.0.0: dependencies: '@types/debug': 4.1.12 - debug: 4.3.7 + debug: 4.3.7(supports-color@8.1.1) decode-named-character-reference: 1.0.2 devlop: 1.1.0 micromark-core-commonmark: 2.0.1 @@ -18304,7 +18420,7 @@ snapshots: spdy-transport@3.0.0: dependencies: - debug: 4.3.6(supports-color@8.1.1) + debug: 4.3.7(supports-color@8.1.1) detect-node: 2.1.0 hpack.js: 2.1.6 obuf: 1.1.2 @@ -18315,7 +18431,7 @@ snapshots: spdy@4.0.2: dependencies: - debug: 4.3.6(supports-color@8.1.1) + debug: 4.3.7(supports-color@8.1.1) handle-thing: 2.0.1 http-deceiver: 1.2.7 select-hose: 2.0.0 @@ -18942,14 +19058,62 @@ snapshots: - rollup - supports-color + unocss@0.59.4(postcss@8.4.41)(rollup@4.21.1)(vite@5.4.2(@types/node@22.5.1)(terser@5.33.0)): + dependencies: + '@unocss/astro': 0.59.4(rollup@4.21.1)(vite@5.4.2(@types/node@22.5.1)(terser@5.33.0)) + '@unocss/cli': 0.59.4(rollup@4.21.1) + '@unocss/core': 0.59.4 + '@unocss/extractor-arbitrary-variants': 0.59.4 + '@unocss/postcss': 0.59.4(postcss@8.4.41) + '@unocss/preset-attributify': 0.59.4 + '@unocss/preset-icons': 0.59.4 + '@unocss/preset-mini': 0.59.4 + '@unocss/preset-tagify': 0.59.4 + '@unocss/preset-typography': 0.59.4 + '@unocss/preset-uno': 0.59.4 + '@unocss/preset-web-fonts': 0.59.4 + '@unocss/preset-wind': 0.59.4 + '@unocss/reset': 0.59.4 + '@unocss/transformer-attributify-jsx': 0.59.4 + '@unocss/transformer-attributify-jsx-babel': 0.59.4 + '@unocss/transformer-compile-class': 0.59.4 + '@unocss/transformer-directives': 0.59.4 + '@unocss/transformer-variant-group': 0.59.4 + '@unocss/vite': 0.59.4(rollup@4.21.1)(vite@5.4.2(@types/node@22.5.1)(terser@5.33.0)) + optionalDependencies: + vite: 5.4.2(@types/node@22.5.1)(terser@5.33.0) + transitivePeerDependencies: + - postcss + - rollup + - supports-color + unpipe@1.0.0: {} unplugin-vue-components@0.26.0(@babel/parser@7.25.6)(rollup@2.79.1)(vue@3.4.38(typescript@5.4.5)): dependencies: '@antfu/utils': 0.7.10 - '@rollup/pluginutils': 5.1.0(rollup@2.79.1) + '@rollup/pluginutils': 5.1.2(rollup@2.79.1) chokidar: 3.6.0 - debug: 4.3.6(supports-color@8.1.1) + debug: 4.3.7(supports-color@8.1.1) + fast-glob: 3.3.2 + local-pkg: 0.4.3 + magic-string: 0.30.11 + minimatch: 9.0.5 + resolve: 1.22.8 + unplugin: 1.12.0 + vue: 3.4.38(typescript@5.4.5) + optionalDependencies: + '@babel/parser': 7.25.6 + transitivePeerDependencies: + - rollup + - supports-color + + unplugin-vue-components@0.26.0(@babel/parser@7.25.6)(rollup@4.21.1)(vue@3.4.38(typescript@5.4.5)): + dependencies: + '@antfu/utils': 0.7.10 + '@rollup/pluginutils': 5.1.2(rollup@4.21.1) + chokidar: 3.6.0 + debug: 4.3.7(supports-color@8.1.1) fast-glob: 3.3.2 local-pkg: 0.4.3 magic-string: 0.30.11 @@ -19030,7 +19194,7 @@ snapshots: vite-node@1.6.0(@types/node@20.16.2)(terser@5.33.0): dependencies: cac: 6.7.14 - debug: 4.3.6(supports-color@8.1.1) + debug: 4.3.7(supports-color@8.1.1) pathe: 1.1.2 picocolors: 1.0.1 vite: 5.4.2(@types/node@20.16.2)(terser@5.33.0) From 8b169f3796d7ed4fadc62d6e0c4415fb4e4925e2 Mon Sep 17 00:00:00 2001 From: yari-dewalt Date: Tue, 15 Oct 2024 11:46:31 -0700 Subject: [PATCH 013/242] Fix issue with text content using < and > --- .../rendering-elements/shapes/erBox.ts | 34 +++++++++---------- 1 file changed, 16 insertions(+), 18 deletions(-) diff --git a/packages/mermaid/src/rendering-util/rendering-elements/shapes/erBox.ts b/packages/mermaid/src/rendering-util/rendering-elements/shapes/erBox.ts index 2c812b862..937d3a921 100644 --- a/packages/mermaid/src/rendering-util/rendering-elements/shapes/erBox.ts +++ b/packages/mermaid/src/rendering-util/rendering-elements/shapes/erBox.ts @@ -280,29 +280,27 @@ async function addText( labelText = labelText.replaceAll('<', '<').replaceAll('>', '>'); } - const text = label - .node() - .appendChild( - await createText( - label, - labelText, - { - width: calculateTextWidth(labelText, config) + 100, - style, - useHtmlLabels: config.htmlLabels, - }, - config - ) - ); + const text = label.node().appendChild( + await createText( + label, + labelText, + { + width: calculateTextWidth(labelText, config) + 100, + style, + useHtmlLabels: config.htmlLabels, + }, + config + ) + ); // Undo work around now that text passed through correctly - if (labelText.includes('<')) { + if (labelText.includes('<') || labelText.includes('>')) { let child = text.children[0]; - // Get last child + child.textContent = child.textContent.replaceAll('<', '<').replaceAll('>', '>'); while (child.childNodes[0]) { child = child.childNodes[0]; + // Replace its text content + child.textContent = child.textContent.replaceAll('<', '<').replaceAll('>', '>'); } - // Replace its text content - child.textContent = child.textContent.replaceAll('<', '<').replaceAll('>', '>'); } let bbox = text.getBBox(); From 49e23c74bce79d704d222a255e5aeff260ee7f60 Mon Sep 17 00:00:00 2001 From: yari-dewalt Date: Tue, 15 Oct 2024 12:19:35 -0700 Subject: [PATCH 014/242] Update parser to include changes --- .../src/diagrams/er/parser/erDiagram.jison | 123 ++++++++++++++++-- 1 file changed, 109 insertions(+), 14 deletions(-) diff --git a/packages/mermaid/src/diagrams/er/parser/erDiagram.jison b/packages/mermaid/src/diagrams/er/parser/erDiagram.jison index 135efc784..668595f43 100644 --- a/packages/mermaid/src/diagrams/er/parser/erDiagram.jison +++ b/packages/mermaid/src/diagrams/er/parser/erDiagram.jison @@ -14,6 +14,10 @@ accDescr\s*":"\s* { this.begin("ac accDescr\s*"{"\s* { this.begin("acc_descr_multiline");} [\}] { this.popState(); } [^\}]* return "acc_descr_multiline_value"; +.*direction\s+TB[^\n]* return 'direction_tb'; +.*direction\s+BT[^\n]* return 'direction_bt'; +.*direction\s+RL[^\n]* return 'direction_rl'; +.*direction\s+LR[^\n]* return 'direction_lr'; [\n]+ return 'NEWLINE'; \s+ /* skip whitespace */ [\s]+ return 'SPACE'; @@ -21,11 +25,15 @@ accDescr\s*"{"\s* { this.begin("acc_descr_multili \"[^"]*\" return 'WORD'; "erDiagram" return 'ER_DIAGRAM'; "{" { this.begin("block"); return 'BLOCK_START'; } -"," return 'COMMA'; +\# return 'BRKT'; +"#" return 'BRKT'; +"," return 'COMMA'; +":::" return 'STYLE_SEPARATOR'; +":" return 'COLON'; \s+ /* skip whitespace in block */ \b((?:PK)|(?:FK)|(?:UK))\b return 'ATTRIBUTE_KEY' -(.*?)[~](.*?)*[~] return 'ATTRIBUTE_WORD'; -[\*A-Za-z_][A-Za-z0-9\-_\[\]\(\)]* return 'ATTRIBUTE_WORD' +([^\s]*)[~].*[~]([^\s]*) return 'ATTRIBUTE_WORD'; +([\*A-Za-z_\u00C0-\uFFFF][A-Za-z0-9\-\_\[\]\(\)\u00C0-\uFFFF\*]*) return 'ATTRIBUTE_WORD'; \"[^"]*\" return 'COMMENT'; [\n]+ /* nothing */ "}" { this.popState(); return 'BLOCK_STOP'; } @@ -33,6 +41,9 @@ accDescr\s*"{"\s* { this.begin("acc_descr_multili "[" return 'SQS'; "]" return 'SQE'; +"style" return 'STYLE'; +"classDef" return 'CLASSDEF'; +"class" return 'CLASS'; "one or zero" return 'ZERO_OR_ONE'; "one or more" return 'ONE_OR_MORE'; "one or many" return 'ONE_OR_MORE'; @@ -61,7 +72,8 @@ o\{ return 'ZERO_OR_MORE'; "optionally to" return 'NON_IDENTIFYING'; \.\- return 'NON_IDENTIFYING'; \-\. return 'NON_IDENTIFYING'; -[A-Za-z_][A-Za-z0-9\-_]* return 'ALPHANUM'; +([^\x00-\x7F]|\w|\-|\*)+ return 'UNICODE_TEXT'; +[0-9] return 'NUM'; . return yytext[0]; <> return 'EOF'; @@ -88,35 +100,118 @@ line statement - : entityName relSpec entityName ':' role + : entityName relSpec entityName COLON role { yy.addEntity($1); yy.addEntity($3); yy.addRelationship($1, $5, $3, $2); } + | entityName STYLE_SEPARATOR idList relSpec entityName STYLE_SEPARATOR idList COLON role + { + yy.addEntity($1); + yy.addEntity($5); + yy.addRelationship($1, $9, $5, $4); + yy.setClass([$1], $3); + yy.setClass([$5], $7); + } + | entityName STYLE_SEPARATOR idList relSpec entityName COLON role + { + yy.addEntity($1); + yy.addEntity($5); + yy.addRelationship($1, $7, $5, $4); + yy.setClass([$1], $3); + } + | entityName relSpec entityName STYLE_SEPARATOR idList COLON role + { + yy.addEntity($1); + yy.addEntity($3); + yy.addRelationship($1, $7, $3, $2); + yy.setClass([$3], $5); + } | entityName BLOCK_START attributes BLOCK_STOP { yy.addEntity($1); yy.addAttributes($1, $3); } + | entityName STYLE_SEPARATOR idList BLOCK_START attributes BLOCK_STOP + { + yy.addEntity($1); + yy.addAttributes($1, $5); + yy.setClass([$1], $3); + } | entityName BLOCK_START BLOCK_STOP { yy.addEntity($1); } + | entityName STYLE_SEPARATOR idList BLOCK_START BLOCK_STOP { yy.addEntity($1); yy.setClass([$1], $3); } | entityName { yy.addEntity($1); } + | entityName STYLE_SEPARATOR idList { yy.addEntity($1); yy.setClass([$1], $3); } | entityName SQS entityName SQE BLOCK_START attributes BLOCK_STOP { yy.addEntity($1, $3); yy.addAttributes($1, $6); } + | entityName SQS entityName SQE STYLE_SEPARATOR idList BLOCK_START attributes BLOCK_STOP + { + yy.addEntity($1, $3); + yy.addAttributes($1, $8); + yy.setClass([$1], $6); + + } | entityName SQS entityName SQE BLOCK_START BLOCK_STOP { yy.addEntity($1, $3); } + | entityName SQS entityName SQE STYLE_SEPARATOR idList BLOCK_START BLOCK_STOP { yy.addEntity($1, $3); yy.setClass([$1], $6); } | entityName SQS entityName SQE { yy.addEntity($1, $3); } + | entityName SQS entityName SQE STYLE_SEPARATOR idList { yy.addEntity($1, $3); yy.setClass([$1], $6); } | title title_value { $$=$2.trim();yy.setAccTitle($$); } | acc_title acc_title_value { $$=$2.trim();yy.setAccTitle($$); } | acc_descr acc_descr_value { $$=$2.trim();yy.setAccDescription($$); } | acc_descr_multiline_value { $$=$1.trim();yy.setAccDescription($$); } + | direction + | classDefStatement + | classStatement + | styleStatement ; +direction + : direction_tb + { yy.setDirection('TB');} + | direction_bt + { yy.setDirection('BT');} + | direction_rl + { yy.setDirection('RL');} + | direction_lr + { yy.setDirection('LR');} + ; + +classDefStatement + : CLASSDEF idList stylesOpt {$$ = $CLASSDEF;yy.addClass($idList,$stylesOpt);} + ; + +idList + : UNICODE_TEXT { $$ = [$UNICODE_TEXT]; } + | idList COMMA UNICODE_TEXT = { $$ = $idList.concat([$UNICODE_TEXT]); } + ; + +classStatement + : CLASS idList idList {$$ = $CLASS;yy.setClass($2, $3);} + ; + +styleStatement + : STYLE idList stylesOpt {$$ = $STYLE;yy.addCssStyles($2,$stylesOpt);} + ; + +stylesOpt + : style { $$ = [$style] } + | stylesOpt COMMA style {$stylesOpt.push($style);$$ = $stylesOpt;} + ; + +style + : styleComponent + | style styleComponent { $$ = $style + $styleComponent; } + ; + +styleComponent: UNICODE_TEXT | NUM | COLON | BRKT | STYLE; + entityName - : 'ALPHANUM' { $$ = $1; } - | 'ENTITY_NAME' { $$ = $1.replace(/"/g, ''); } + : 'ENTITY_NAME' { $$ = $1.replace(/"/g, ''); } + | 'UNICODE_TEXT' { $$ = $1; } ; attributes @@ -125,10 +220,10 @@ attributes ; attribute - : attributeType attributeName { $$ = { attributeType: $1, attributeName: $2 }; } - | attributeType attributeName attributeKeyTypeList { $$ = { attributeType: $1, attributeName: $2, attributeKeyTypeList: $3 }; } - | attributeType attributeName attributeComment { $$ = { attributeType: $1, attributeName: $2, attributeComment: $3 }; } - | attributeType attributeName attributeKeyTypeList attributeComment { $$ = { attributeType: $1, attributeName: $2, attributeKeyTypeList: $3, attributeComment: $4 }; } + : attributeType attributeName { $$ = { type: $1, name: $2 }; } + | attributeType attributeName attributeKeyTypeList { $$ = { type: $1, name: $2, keys: $3 }; } + | attributeType attributeName attributeComment { $$ = { type: $1, name: $2, comment: $3 }; } + | attributeType attributeName attributeKeyTypeList attributeComment { $$ = { type: $1, name: $2, keys: $3, comment: $4 }; } ; @@ -142,7 +237,7 @@ attributeName attributeKeyTypeList : attributeKeyType { $$ = [$1]; } - | attributeKeyTypeList COMMA attributeKeyType { $1.push($3); $$ = $1; } + | attributeKeyTypeList ',' attributeKeyType { $1.push($3); $$ = $1; } ; attributeKeyType @@ -177,7 +272,7 @@ relType role : 'WORD' { $$ = $1.replace(/"/g, ''); } | 'ENTITY_NAME' { $$ = $1.replace(/"/g, ''); } - | 'ALPHANUM' { $$ = $1; } + | 'UNICODE_TEXT' { $$ = $1; } ; -%% +%% \ No newline at end of file From 5be5aa3dfad36785320fc9bd9c3a9bc7e99817f2 Mon Sep 17 00:00:00 2001 From: yari-dewalt Date: Wed, 16 Oct 2024 08:14:13 -0700 Subject: [PATCH 015/242] Register erBox shape --- .../src/rendering-util/rendering-elements/shapes.ts | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/packages/mermaid/src/rendering-util/rendering-elements/shapes.ts b/packages/mermaid/src/rendering-util/rendering-elements/shapes.ts index b336fc823..e19b13ec2 100644 --- a/packages/mermaid/src/rendering-util/rendering-elements/shapes.ts +++ b/packages/mermaid/src/rendering-util/rendering-elements/shapes.ts @@ -55,6 +55,7 @@ import { triangle } from './shapes/triangle.js'; import { waveEdgedRectangle } from './shapes/waveEdgedRectangle.js'; import { waveRectangle } from './shapes/waveRectangle.js'; import { windowPane } from './shapes/windowPane.js'; +import { erBox } from './shapes/erBox.js'; // eslint-disable-next-line @typescript-eslint/no-explicit-any type ShapeHandler = (parent: any, node: Node, options: ShapeRenderOptions) => unknown; @@ -442,6 +443,14 @@ export const shapesDefs: ShapeDefinition[] = [ aliases: ['lined-document'], handler: linedWaveEdgedRect, }, + { + semanticName: 'Entity Relationship Box', + name: 'Entity Relationship Box', + shortName: 'erBox', + description: 'Entity Relationship Box', + aliases: ['er-box'], + handler: erBox, + }, ]; const generateShapeMap = () => { From 723b8f1d3236bbc95c8fadbf49db82c7e6b1d9fd Mon Sep 17 00:00:00 2001 From: "autofix-ci[bot]" <114827586+autofix-ci[bot]@users.noreply.github.com> Date: Wed, 16 Oct 2024 15:20:09 +0000 Subject: [PATCH 016/242] [autofix.ci] apply automated fixes --- docs/syntax/flowchart.md | 95 ++++++++++++++++++++-------------------- 1 file changed, 48 insertions(+), 47 deletions(-) diff --git a/docs/syntax/flowchart.md b/docs/syntax/flowchart.md index 3837e77de..e25851d5f 100644 --- a/docs/syntax/flowchart.md +++ b/docs/syntax/flowchart.md @@ -316,53 +316,54 @@ This syntax creates a node A as a rectangle. It renders in the same way as `A["A Below is a comprehensive list of the newly introduced shapes and their corresponding semantic meanings, short names, and aliases: -| **Semantic Name** | **Shape Name** | **Short Name** | **Description** | **Alias Supported** | -| --------------------------------- | ---------------------- | -------------- | ------------------------------ | ---------------------------------------------------------------- | -| Card | Notched Rectangle | `notch-rect` | Represents a card | `card`, `notched-rectangle` | -| Collate | Hourglass | `hourglass` | Represents a collate operation | `collate`, `hourglass` | -| Com Link | Lightning Bolt | `bolt` | Communication link | `com-link`, `lightning-bolt` | -| Comment | Curly Brace | `brace` | Adds a comment | `brace-l`, `comment` | -| Comment Right | Curly Brace | `brace-r` | Adds a comment | | -| Comment with braces on both sides | Curly Braces | `braces` | Adds a comment | | -| Data Input/Output | Lean Right | `lean-r` | Represents input or output | `in-out`, `lean-right` | -| Data Input/Output | Lean Left | `lean-l` | Represents output or input | `lean-left`, `out-in` | -| Database | Cylinder | `cyl` | Database storage | `cylinder`, `database`, `db` | -| Decision | Diamond | `diam` | Decision-making step | `decision`, `diamond`, `question` | -| Delay | Half-Rounded Rectangle | `delay` | Represents a delay | `half-rounded-rectangle` | -| Direct Access Storage | Horizontal Cylinder | `h-cyl` | Direct access storage | `das`, `horizontal-cylinder` | -| Disk Storage | Lined Cylinder | `lin-cyl` | Disk storage | `disk`, `lined-cylinder` | -| Display | Curved Trapezoid | `curv-trap` | Represents a display | `curved-trapezoid`, `display` | -| Divided Process | Divided Rectangle | `div-rect` | Divided process shape | `div-proc`, `divided-process`, `divided-rectangle` | -| Document | Document | `doc` | Represents a document | `doc`, `document` | -| Event | Rounded Rectangle | `rounded` | Represents an event | `event` | -| Extract | Triangle | `tri` | Extraction process | `extract`, `triangle` | -| Fork/Join | Filled Rectangle | `fork` | Fork or join in process flow | `join` | -| Internal Storage | Window Pane | `win-pane` | Internal storage | `internal-storage`, `window-pane` | -| Junction | Filled Circle | `f-circ` | Junction point | `filled-circle`, `junction` | -| Lined Document | Lined Document | `lin-doc` | Lined document | `lined-document` | -| Lined/Shaded Process | Lined Rectangle | `lin-rect` | Lined process shape | `lin-proc`, `lined-process`, `lined-rectangle`, `shaded-process` | -| Loop Limit | Trapezoidal Pentagon | `notch-pent` | Loop limit step | `loop-limit`, `notched-pentagon` | -| Manual File | Flipped Triangle | `flip-tri` | Manual file operation | `flipped-triangle`, `manual-file` | -| Manual Input | Sloped Rectangle | `sl-rect` | Manual input step | `manual-input`, `sloped-rectangle` | -| Manual Operation | Trapezoid Base Top | `trap-t` | Represents a manual task | `inv-trapezoid`, `manual`, `trapezoid-top` | -| Multi-Document | Stacked Document | `docs` | Multiple documents | `documents`, `st-doc`, `stacked-document` | -| Multi-Process | Stacked Rectangle | `st-rect` | Multiple processes | `processes`, `procs`, `stacked-rectangle` | -| Odd | Odd | `odd` | Odd shape | | -| Paper Tape | Flag | `flag` | Paper tape | `paper-tape` | -| Prepare Conditional | Hexagon | `hex` | Preparation or condition step | `hexagon`, `prepare` | -| Priority Action | Trapezoid Base Bottom | `trap-b` | Priority action | `priority`, `trapezoid`, `trapezoid-bottom` | -| Process | Rectangle | `rect` | Standard process shape | `proc`, `process`, `rectangle` | -| Start | Circle | `circle` | Starting point | `circ` | -| Start | Small Circle | `sm-circ` | Small starting point | `small-circle`, `start` | -| Stop | Double Circle | `dbl-circ` | Represents a stop point | `double-circle` | -| Stop | Framed Circle | `fr-circ` | Stop point | `framed-circle`, `stop` | -| Stored Data | Bow Tie Rectangle | `bow-rect` | Stored data | `bow-tie-rectangle`, `stored-data` | -| Subprocess | Framed Rectangle | `fr-rect` | Subprocess | `framed-rectangle`, `subproc`, `subprocess`, `subroutine` | -| Summary | Crossed Circle | `cross-circ` | Summary | `crossed-circle`, `summary` | -| Tagged Document | Tagged Document | `tag-doc` | Tagged document | `tag-doc`, `tagged-document` | -| Tagged Process | Tagged Rectangle | `tag-rect` | Tagged process | `tag-proc`, `tagged-process`, `tagged-rectangle` | -| Terminal Point | Stadium | `stadium` | Terminal point | `pill`, `terminal` | -| Text Block | Text Block | `text` | Text block | | +| **Semantic Name** | **Shape Name** | **Short Name** | **Description** | **Alias Supported** | +| --------------------------------- | ----------------------- | -------------- | ------------------------------ | ---------------------------------------------------------------- | +| Card | Notched Rectangle | `notch-rect` | Represents a card | `card`, `notched-rectangle` | +| Collate | Hourglass | `hourglass` | Represents a collate operation | `collate`, `hourglass` | +| Com Link | Lightning Bolt | `bolt` | Communication link | `com-link`, `lightning-bolt` | +| Comment | Curly Brace | `brace` | Adds a comment | `brace-l`, `comment` | +| Comment Right | Curly Brace | `brace-r` | Adds a comment | | +| Comment with braces on both sides | Curly Braces | `braces` | Adds a comment | | +| Data Input/Output | Lean Right | `lean-r` | Represents input or output | `in-out`, `lean-right` | +| Data Input/Output | Lean Left | `lean-l` | Represents output or input | `lean-left`, `out-in` | +| Database | Cylinder | `cyl` | Database storage | `cylinder`, `database`, `db` | +| Decision | Diamond | `diam` | Decision-making step | `decision`, `diamond`, `question` | +| Delay | Half-Rounded Rectangle | `delay` | Represents a delay | `half-rounded-rectangle` | +| Direct Access Storage | Horizontal Cylinder | `h-cyl` | Direct access storage | `das`, `horizontal-cylinder` | +| Disk Storage | Lined Cylinder | `lin-cyl` | Disk storage | `disk`, `lined-cylinder` | +| Display | Curved Trapezoid | `curv-trap` | Represents a display | `curved-trapezoid`, `display` | +| Divided Process | Divided Rectangle | `div-rect` | Divided process shape | `div-proc`, `divided-process`, `divided-rectangle` | +| Document | Document | `doc` | Represents a document | `doc`, `document` | +| Entity Relationship Box | Entity Relationship Box | `erBox` | Entity Relationship Box | `er-box` | +| Event | Rounded Rectangle | `rounded` | Represents an event | `event` | +| Extract | Triangle | `tri` | Extraction process | `extract`, `triangle` | +| Fork/Join | Filled Rectangle | `fork` | Fork or join in process flow | `join` | +| Internal Storage | Window Pane | `win-pane` | Internal storage | `internal-storage`, `window-pane` | +| Junction | Filled Circle | `f-circ` | Junction point | `filled-circle`, `junction` | +| Lined Document | Lined Document | `lin-doc` | Lined document | `lined-document` | +| Lined/Shaded Process | Lined Rectangle | `lin-rect` | Lined process shape | `lin-proc`, `lined-process`, `lined-rectangle`, `shaded-process` | +| Loop Limit | Trapezoidal Pentagon | `notch-pent` | Loop limit step | `loop-limit`, `notched-pentagon` | +| Manual File | Flipped Triangle | `flip-tri` | Manual file operation | `flipped-triangle`, `manual-file` | +| Manual Input | Sloped Rectangle | `sl-rect` | Manual input step | `manual-input`, `sloped-rectangle` | +| Manual Operation | Trapezoid Base Top | `trap-t` | Represents a manual task | `inv-trapezoid`, `manual`, `trapezoid-top` | +| Multi-Document | Stacked Document | `docs` | Multiple documents | `documents`, `st-doc`, `stacked-document` | +| Multi-Process | Stacked Rectangle | `st-rect` | Multiple processes | `processes`, `procs`, `stacked-rectangle` | +| Odd | Odd | `odd` | Odd shape | | +| Paper Tape | Flag | `flag` | Paper tape | `paper-tape` | +| Prepare Conditional | Hexagon | `hex` | Preparation or condition step | `hexagon`, `prepare` | +| Priority Action | Trapezoid Base Bottom | `trap-b` | Priority action | `priority`, `trapezoid`, `trapezoid-bottom` | +| Process | Rectangle | `rect` | Standard process shape | `proc`, `process`, `rectangle` | +| Start | Circle | `circle` | Starting point | `circ` | +| Start | Small Circle | `sm-circ` | Small starting point | `small-circle`, `start` | +| Stop | Double Circle | `dbl-circ` | Represents a stop point | `double-circle` | +| Stop | Framed Circle | `fr-circ` | Stop point | `framed-circle`, `stop` | +| Stored Data | Bow Tie Rectangle | `bow-rect` | Stored data | `bow-tie-rectangle`, `stored-data` | +| Subprocess | Framed Rectangle | `fr-rect` | Subprocess | `framed-rectangle`, `subproc`, `subprocess`, `subroutine` | +| Summary | Crossed Circle | `cross-circ` | Summary | `crossed-circle`, `summary` | +| Tagged Document | Tagged Document | `tag-doc` | Tagged document | `tag-doc`, `tagged-document` | +| Tagged Process | Tagged Rectangle | `tag-rect` | Tagged process | `tag-proc`, `tagged-process`, `tagged-rectangle` | +| Terminal Point | Stadium | `stadium` | Terminal point | `pill`, `terminal` | +| Text Block | Text Block | `text` | Text block | | ### Example Flowchart with New Shapes From 5d2b0f74af28697d0bc88a40a1497b369550910c Mon Sep 17 00:00:00 2001 From: yari-dewalt Date: Wed, 16 Oct 2024 09:48:15 -0700 Subject: [PATCH 017/242] Add fix for er markers when using elk layout --- packages/mermaid/src/diagrams/er/erRenderer-unified.ts | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/packages/mermaid/src/diagrams/er/erRenderer-unified.ts b/packages/mermaid/src/diagrams/er/erRenderer-unified.ts index 4679a6f04..084f622ec 100644 --- a/packages/mermaid/src/diagrams/er/erRenderer-unified.ts +++ b/packages/mermaid/src/diagrams/er/erRenderer-unified.ts @@ -30,6 +30,13 @@ export const draw = async function (text: string, id: string, _version: string, data4Layout.markers = ['only_one', 'zero_or_one', 'one_or_more', 'zero_or_more']; data4Layout.diagramId = id; await render(data4Layout, svg); + // Elk layout algorithm displays markers above nodes, so cut off the half that covers the node for the larger markers. + if (data4Layout.layoutAlgorithm === 'elk') { + svg.selectAll('*[id*="oneOrMoreStart"]').attr('viewBox', '18 0 38.5 36'); + svg.selectAll('*[id*="oneOrMoreEnd"]').attr('viewBox', '0 0 27 36'); + svg.selectAll('*[id*="zeroOrMoreStart"]').attr('viewBox', '18 0 38.5 36'); + svg.selectAll('*[id*="zeroOrMoreEnd"]').attr('viewBox', '0 0 38.5 36'); + } const padding = 8; utils.insertTitle( svg, From 1d68c4f0755a2d91a881acf8fc899e0aa83dcc3e Mon Sep 17 00:00:00 2001 From: yari-dewalt Date: Thu, 17 Oct 2024 17:58:19 -0700 Subject: [PATCH 018/242] Update to test elk layout --- cypress/platform/yari2.html | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/cypress/platform/yari2.html b/cypress/platform/yari2.html index 9c3ce490c..fd38424fd 100644 --- a/cypress/platform/yari2.html +++ b/cypress/platform/yari2.html @@ -55,7 +55,7 @@ --- config: htmlLabels: false - look: + layout: elk --- erDiagram "hi" }o..o{ ORDER : places @@ -129,6 +129,24 @@

Basic Relationship

+          ---
+            config:
+              layout: elk
+          ---
+          erDiagram
+          CUSTOMER }|..|{ DELIVERY-ADDRESS : has
+          CUSTOMER ||--o{ ORDER : places
+          CUSTOMER ||--o{ INVOICE : "liable for"
+          DELIVERY-ADDRESS ||--o{ ORDER : receives
+          INVOICE ||--|{ ORDER : covers
+          ORDER ||--|{ ORDER-ITEM : includes
+          PRODUCT-CATEGORY ||--|{ PRODUCT : contains
+          PRODUCT ||--o{ ORDER-ITEM : "ordered in"
+
+
+
+

Basic Relationship

+ 
 ---
   config:
     layout: elk
@@ -267,7 +285,9 @@
+ + + + From 12c120368d16f9b69d00fa44fb6bf20d887b60e1 Mon Sep 17 00:00:00 2001 From: Thomas Di Cizerone Date: Sun, 16 Mar 2025 18:19:09 +0100 Subject: [PATCH 227/242] =?UTF-8?q?=F0=9F=93=9A=20Add=20documentation?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../mermaid/src/docs/.vitepress/config.ts | 1 + .../src/docs/community/contributing.md | 16 ++ packages/mermaid/src/docs/syntax/radar.md | 198 ++++++++++++++++++ 3 files changed, 215 insertions(+) create mode 100644 packages/mermaid/src/docs/syntax/radar.md diff --git a/packages/mermaid/src/docs/.vitepress/config.ts b/packages/mermaid/src/docs/.vitepress/config.ts index f8f740177..d3f4a9aee 100644 --- a/packages/mermaid/src/docs/.vitepress/config.ts +++ b/packages/mermaid/src/docs/.vitepress/config.ts @@ -159,6 +159,7 @@ function sidebarSyntax() { { text: 'Packet 🔥', link: '/syntax/packet' }, { text: 'Kanban 🔥', link: '/syntax/kanban' }, { text: 'Architecture 🔥', link: '/syntax/architecture' }, + { text: 'Radar 🔥', link: '/syntax/radar' }, { text: 'Other Examples', link: '/syntax/examples' }, ], }, diff --git a/packages/mermaid/src/docs/community/contributing.md b/packages/mermaid/src/docs/community/contributing.md index 4cd649563..a962907df 100644 --- a/packages/mermaid/src/docs/community/contributing.md +++ b/packages/mermaid/src/docs/community/contributing.md @@ -240,6 +240,22 @@ Code is the heart of every software project. We strive to make it better. Who if The core of Mermaid is located under `packages/mermaid/src`. +### Building Mermaid Locally + +**Host** + +```bash +pnpm run build +``` + +**Docker** + +```bash +./run build +``` + +This will build the Mermaid library and the documentation site. + ### Running Mermaid Locally **Host** diff --git a/packages/mermaid/src/docs/syntax/radar.md b/packages/mermaid/src/docs/syntax/radar.md new file mode 100644 index 000000000..50293770c --- /dev/null +++ b/packages/mermaid/src/docs/syntax/radar.md @@ -0,0 +1,198 @@ +# Radar Diagram (v+) + +## Introduction + +A radar diagram is a simple way to plot low-dimensional data in a circular format. + +It is also known as a **radar chart**, **spider chart**, **star chart**, **cobweb chart**, **polar chart**, or **Kiviat diagram**. + +## Usage + +This diagram type is particularly useful for developers, data scientists, and engineers who require a clear and concise way to represent data in a circular format. + +It is commonly used to graphically summarize and compare the performance of multiple entities across multiple dimensions. + +## Syntax + +```md +radar-beta +axis A, B, C, D, E +curve c1{1,2,3,4,5} +curve c2{5,4,3,2,1} +... More Fields ... +``` + +## Examples + +```mermaid-example +--- +title: "Grades" +--- +radar-beta + axis m["Math"], s["Science"], e["English"] + axis h["History"], g["Geography"], a["Art"] + curve a["Alice"]{85, 90, 80, 70, 75, 90} + curve b["Bob"]{70, 75, 85, 80, 90, 85} + + max 100 + min 0 +``` + +```mermaid-example +radar-beta + title Restaurant Comparison + axis food["Food Quality"], service["Service"], price["Price"] + axis ambiance["Ambiance"], + + curve a["Restaurant A"]{4, 3, 2, 4} + curve b["Restaurant B"]{3, 4, 3, 3} + curve c["Restaurant C"]{2, 3, 4, 2} + curve d["Restaurant D"]{2, 2, 4, 3} + + graticule polygon + max 5 + +``` + +## Details of Syntax + +### Title + +`title`: The title is an optional field that allows to render a title at the top of the radar diagram. + +``` +radar-beta + title Title of the Radar Diagram + ... +``` + +### Axis + +`axis`: The axis keyword is used to define the axes of the radar diagram. + +Each axis is represented by an ID and an optional label. + +Multiple axes can be defined in a single line. + +``` +radar-beta + axis id1["Label1"] + axis id2["Label2"], id3["Label3"] + ... +``` + +### Curve + +`curve`: The curve keyword is used to define the data points for a curve in the radar diagram. + +Each curve is represented by an ID, an optional label, and a list of values. + +Values can be defined by a list of numbers or a list of key-value pairs. If key-value pairs are used, the key represents the axis ID and the value represents the data point. Else, the data points are assumed to be in the order of the axes defined. + +Multiple curves can be defined in a single line. + +``` +radar-beta + axis axis1, axis2, axis3 + curve id1["Label1"]{1, 2, 3} + curve id2["Label2"]{4, 5, 6}, id3{7, 8, 9} + curve id4{ axis3: 30, axis1: 20, axis2: 10 } + ... +``` + +### Options + +- `showLegend`: The showLegend keyword is used to show or hide the legend in the radar diagram. The legend is shown by default. +- `max`: The maximum value for the radar diagram. This is used to scale the radar diagram. If not provided, the maximum value is calculated from the data points. +- `min`: The minimum value for the radar diagram. This is used to scale the radar diagram. If not provided, the minimum value is `0`. +- `graticule`: The graticule keyword is used to define the type of graticule to be rendered in the radar diagram. The graticule can be `circle` or `polygon`. If not provided, the default graticule is `circle`. +- `ticks`: The ticks keyword is used to define the number of ticks on the graticule. It is the number of concentric circles or polygons drawn to indicate the scale of the radar diagram. If not provided, the default number of ticks is `5`. + +``` +radar-beta + ... + showLegend true + max 100 + min 0 + graticule circle + ticks 5 + ... +``` + +## Configuration + +Please refer to the [configuration](/config/schema-docs/config-defs-radar-diagram-config.html) guide for details. + +| Parameter | Description | Default Value | +| --------------- | ---------------------------------------- | ------------- | +| width | Width of the radar diagram | `600` | +| height | Height of the radar diagram | `600` | +| marginTop | Top margin of the radar diagram | `50` | +| marginBottom | Bottom margin of the radar diagram | `50` | +| marginLeft | Left margin of the radar diagram | `50` | +| marginRight | Right margin of the radar diagram | `50` | +| axisScaleFactor | Scale factor for the axis | `1` | +| axisLabelFactor | Factor to adjust the axis label position | `1.05` | +| curveTension | Tension for the rounded curves | `0.17` | + +## Theme Variables + +### Global Theme Variables + +```note +The default values for these variables depend on the theme used. To override the default values, set the desired values in the themeVariables section of the configuration: +%%{init: {"themeVariables": {"cScale0": "#FF0000", "cScale1": "#00FF00"}} }%% +``` + +Radar charts support the color scales `cScale${i}` where `i` is a number from `0` to the theme's maximum number of colors in its color scale. Usually, the maximum number of colors is `12`. + +| Property | Description | +| ---------- | ------------------------------ | +| fontSize | Font size of the title | +| titleColor | Color of the title | +| cScale${i} | Color scale for the i-th curve | + +### Radar Style Options + +```note +Specific variables for radar resides inside the `radar` key. To set the radar style options, use this syntax. +%%{init: {"themeVariables": {"radar": {"axisColor": "#FF0000"}} } }%% +``` + +| Property | Description | Default Value | +| -------------------- | ---------------------------- | ------------- | +| axisColor | Color of the axis lines | `black` | +| axisStrokeWidth | Width of the axis lines | `1` | +| axisLabelFontSize | Font size of the axis labels | `12px` | +| curveOpacity | Opacity of the curves | `0.7` | +| curveStrokeWidth | Width of the curves | `2` | +| graticuleColor | Color of the graticule | `black` | +| graticuleOpacity | Opacity of the graticule | `0.5` | +| graticuleStrokeWidth | Width of the graticule | `1` | +| legendBoxSize | Size of the legend box | `10` | +| legendFontSize | Font size of the legend | `14px` | + +## Example on config and theme + +```mermaid-example +--- +config: + radar: + axisScaleFactor: 0.25 + curveTension: 0.1 + theme: base + themeVariables: + cScale0: "#FF0000" + cScale1: "#00FF00" + cScale2: "#0000FF" + radar: + curveOpacity: 0 +--- +radar-beta + axis A, B, C, D, E + curve c1{1,2,3,4,5} + curve c2{5,4,3,2,1} + curve c3{3,3,3,3,3} +``` + + From 0f5125b5e30d1a708fa18c91b50cd14d25428289 Mon Sep 17 00:00:00 2001 From: Thomas Di Cizerone Date: Sun, 16 Mar 2025 18:34:00 +0100 Subject: [PATCH 228/242] =?UTF-8?q?=F0=9F=96=BC=EF=B8=8F=20Add=20Radar=20D?= =?UTF-8?q?emo=20with=20custom=20opacity?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- demos/radar.html | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/demos/radar.html b/demos/radar.html index 6e9f8df82..16d03abfe 100644 --- a/demos/radar.html +++ b/demos/radar.html @@ -113,6 +113,27 @@ curve Ninja3["Ninja"] {3, 2, 1, 5, 4} + 
+      ---
+      config:
+        radar:
+          axisScaleFactor: 0.25
+          curveTension: 0.1
+        theme: base
+        themeVariables:
+          cScale0: "#FF0000"
+          cScale1: "#00FF00"
+          cScale2: "#0000FF"
+          radar:
+            curveOpacity: 0
+      ---
+      radar-beta
+        title Custom colors, axisScaleFactor, curveTension, opacity
+        axis A, B, C, D, E
+        curve c1{1,2,3,4,5}
+        curve c2{5,4,3,2,1}
+        curve c3{3,3,3,3,3}
+