mermaid - npm Package Compare versions

Comparing version 9.3.0 to 9.4.0-rc.1

dist/__mocks__/mermaidAPI.d.ts

@@ -5,7 +5,7 @@ import { type ParseErrorFunction } from '../Diagram';
 export declare const mermaidAPI: {
-    render: import("vitest/dist/index-9f5bc072").x<any[], any>;
-    renderAsync: import("vitest/dist/index-9f5bc072").x<any[], any>;
+    render: import("vitest/dist/index-1cfc7f58").x<any[], any>;
+    renderAsync: import("vitest/dist/index-1cfc7f58").x<any[], any>;
     parse: typeof parse;
-    parseDirective: import("vitest/dist/index-9f5bc072").x<any[], any>;
-    initialize: import("vitest/dist/index-9f5bc072").x<any[], any>;
+    parseDirective: import("vitest/dist/index-1cfc7f58").x<any[], any>;
+    initialize: import("vitest/dist/index-1cfc7f58").x<any[], any>;
     getConfig: () => import("../config.type").MermaidConfig;
@@ -12,0 +12,0 @@ setConfig: (conf: import("../config.type").MermaidConfig) => import("../config.type").MermaidConfig;

dist/accessibility.d.ts

 /**
  * Accessibility (a11y) functions, types, helpers
+ * @see https://www.w3.org/WAI/
+ * @see https://www.w3.org/TR/wai-aria-1.1/
+ * @see https://www.w3.org/TR/svg-aam-1.0/
  *
@@ -7,3 +10,3 @@ */
 /**
- * Add aria-roledescription to the svg element to the diagramType
+ * Add role and aria-roledescription to the svg element
  *
@@ -10,0 +13,0 @@ * @param svg - d3 object that contains the SVG HTML element

dist/dagre-wrapper/edges.d.ts

 export function clear(): void;
-export function insertEdgeLabel(elem: any, edge: any): void;
+export function insertEdgeLabel(elem: any, edge: any): SVGTextElement | SVGForeignObjectElement;
 export function positionEdgeLabel(edge: any, paths: any): void;
@@ -4,0 +4,0 @@ export function intersection(node: any, outsidePoint: any, insidePoint: any): {

dist/dagre-wrapper/nodes.d.ts

@@ -1,4 +0,4 @@
-export function insertNode(elem: any, node: any, dir: any): void;
+export function insertNode(elem: any, node: any, dir: any): any;
 export function setNodeElem(elem: any, node: any): void;
 export function clear(): void;
 export function positionNode(node: any): any;

dist/diagram-api/detectType.d.ts

 import { MermaidConfig } from '../config.type';
-import { DiagramDetector, DiagramLoader } from './types';
+import type { DiagramDetector, DiagramLoader, ExternalDiagramDefinition } from './types';
 /**
@@ -26,3 +26,4 @@ * Detects the type of the graph text.
 export declare const detectType: (text: string, config?: MermaidConfig) => string;
+export declare const registerLazyLoadedDiagrams: (...diagrams: ExternalDiagramDefinition[]) => void;
 export declare const addDetector: (key: string, detector: DiagramDetector, loader?: DiagramLoader) => void;
 export declare const getDiagramLoader: (key: string) => DiagramLoader | undefined;

dist/Diagram.d.ts

@@ -1,2 +0,2 @@
-import { type DetailedError } from './utils';
+import type { DetailedError } from './utils';
 export declare type ParseErrorFunction = (err: string | DetailedError, hash?: any) => void;
@@ -3,0 +3,0 @@ export declare class Diagram {

dist/diagrams/er/erRenderer.d.ts

 /**
  * Return a unique id based on the given string. Start with the prefix, then a hyphen, then the
- * simplified str, then a hyphen, then a unique uuid. (Hyphens are only included if needed.)
+ * simplified str, then a hyphen, then a unique uuid based on the str. (Hyphens are only included if needed.)
  * Although the official XML standard for ids says that many more characters are valid in the id,
@@ -5,0 +5,0 @@ * this keeps things simple by accepting only A-Za-z0-9.

dist/diagrams/flowchart/flowDb.d.ts

@@ -27,2 +27,9 @@ export function parseDirective(statement: any, context: any, type: any): void;
 export function firstGraph(): boolean;
+export function destructLink(_str: any, _startStr: any): {
+    type: string;
+    stroke: string;
+};
+export namespace lex {
+    export { firstGraph };
+}
 declare namespace _default {
@@ -60,5 +67,3 @@ export { parseDirective };
     export { destructLink };
-    export namespace lex {
-        export { firstGraph };
-    }
+    export { lex };
     export { exists };
@@ -75,6 +80,2 @@ export { makeUniq };
 declare function setTooltip(ids: any, tooltip: any): void;
-declare function destructLink(_str: any, _startStr: any): {
-    type: string;
-    stroke: string;
-};
 declare function exists(allSgs: any, _id: any): boolean;
@@ -81,0 +82,0 @@ /**

dist/mermaid.d.ts

@@ -1,9 +0,5 @@
-/**
- * Web page integration module for the mermaid framework. It uses the mermaidAPI for mermaid
- * functionality and to render the diagrams to svg code!
- */
 import { MermaidConfig } from './config.type';
 import { mermaidAPI } from './mermaidAPI';
 import type { ParseErrorFunction } from './Diagram';
-import { type DetailedError } from './utils';
+import type { DetailedError } from './utils';
 import { ExternalDiagramDefinition } from './diagram-api/types';
@@ -10,0 +6,0 @@ export type { MermaidConfig, DetailedError, ExternalDiagramDefinition, ParseErrorFunction };

dist/mermaidAPI.d.ts

@@ -1,2 +0,2 @@
-import { type ParseErrorFunction } from './Diagram';
+import type { ParseErrorFunction } from './Diagram';
 import { MermaidConfig } from './config.type';
@@ -3,0 +3,0 @@ interface DiagramStyleClassDef {

dist/tests/MockedD3.d.ts

@@ -16,5 +16,5 @@ /**
     listChildren(): string;
-    select: import("vitest/dist/index-9f5bc072").x<any[], any>;
-    selectAll: import("vitest/dist/index-9f5bc072").x<any[], any>;
-    append: import("vitest/dist/index-9f5bc072").x<any[], any>;
+    select: import("vitest/dist/index-1cfc7f58").x<any[], any>;
+    selectAll: import("vitest/dist/index-1cfc7f58").x<any[], any>;
+    append: import("vitest/dist/index-1cfc7f58").x<any[], any>;
     insert: (type: string, beforeSelector?: string, id?: string) => MockedD3;
@@ -25,4 +25,4 @@ attr(attrName: string): null | undefined | string | number;
     text(attrValue?: string): this;
-    node: import("vitest/dist/index-9f5bc072").x<any[], any>;
-    nodes: import("vitest/dist/index-9f5bc072").x<any[], any>;
+    node: import("vitest/dist/index-1cfc7f58").x<any[], any>;
+    nodes: import("vitest/dist/index-1cfc7f58").x<any[], any>;
     getBBox: () => {
@@ -34,14 +34,14 @@ x: string | number | null | undefined;
     };
-    insertBefore: import("vitest/dist/index-9f5bc072").x<any[], any>;
-    curveBasis: import("vitest/dist/index-9f5bc072").x<any[], any>;
-    curveBasisClosed: import("vitest/dist/index-9f5bc072").x<any[], any>;
-    curveBasisOpen: import("vitest/dist/index-9f5bc072").x<any[], any>;
-    curveLinear: import("vitest/dist/index-9f5bc072").x<any[], any>;
-    curveLinearClosed: import("vitest/dist/index-9f5bc072").x<any[], any>;
-    curveMonotoneX: import("vitest/dist/index-9f5bc072").x<any[], any>;
-    curveMonotoneY: import("vitest/dist/index-9f5bc072").x<any[], any>;
-    curveNatural: import("vitest/dist/index-9f5bc072").x<any[], any>;
-    curveStep: import("vitest/dist/index-9f5bc072").x<any[], any>;
-    curveStepAfter: import("vitest/dist/index-9f5bc072").x<any[], any>;
-    curveStepBefore: import("vitest/dist/index-9f5bc072").x<any[], any>;
+    insertBefore: import("vitest/dist/index-1cfc7f58").x<any[], any>;
+    curveBasis: import("vitest/dist/index-1cfc7f58").x<any[], any>;
+    curveBasisClosed: import("vitest/dist/index-1cfc7f58").x<any[], any>;
+    curveBasisOpen: import("vitest/dist/index-1cfc7f58").x<any[], any>;
+    curveLinear: import("vitest/dist/index-1cfc7f58").x<any[], any>;
+    curveLinearClosed: import("vitest/dist/index-1cfc7f58").x<any[], any>;
+    curveMonotoneX: import("vitest/dist/index-1cfc7f58").x<any[], any>;
+    curveMonotoneY: import("vitest/dist/index-1cfc7f58").x<any[], any>;
+    curveNatural: import("vitest/dist/index-1cfc7f58").x<any[], any>;
+    curveStep: import("vitest/dist/index-1cfc7f58").x<any[], any>;
+    curveStepAfter: import("vitest/dist/index-1cfc7f58").x<any[], any>;
+    curveStepBefore: import("vitest/dist/index-1cfc7f58").x<any[], any>;
 }

dist/themes/theme-base.d.ts

@@ -9,3 +9,2 @@ export function getThemeVariables(userOverrides: any): Theme;
     background: string;
-    darkMode: boolean;
     primaryColor: string;
@@ -12,0 +11,0 @@ noteBkgColor: string;

dist/utils.d.ts

@@ -83,3 +83,3 @@ import { CurveFactory } from 'd3';
  */
-export declare function interpolateToCurve(interpolate?: string, defaultCurve: CurveFactory): CurveFactory;
+export declare function interpolateToCurve(interpolate: string | undefined, defaultCurve: CurveFactory): CurveFactory;
 /**
@@ -252,2 +252,11 @@ * Formats a URL string
 export declare const insertTitle: (parent: any, cssClass: string, titleTopMargin: number, title?: string) => void;
+/**
+ * Parses a raw fontSize configuration value into a number and string value.
+ *
+ * @param fontSize - a string or number font size configuration value
+ *
+ * @returns parsed number and string style font size values, or nulls if a number value can't
+ * be parsed from an input string.
+ */
+export declare const parseFontSize: (fontSize: string | number | undefined) => [number?, string?];
 declare const _default: {
@@ -292,3 +301,4 @@ assignWithDepth: (dst: any, src: any, config?: {
     insertTitle: (parent: any, cssClass: string, titleTopMargin: number, title?: string | undefined) => void;
+    parseFontSize: (fontSize: string | number | undefined) => [(number | undefined)?, (string | undefined)?];
 };
 export default _default;

package.json

 {
   "name": "mermaid",
-  "version": "9.3.0",
+  "version": "9.4.0-rc.1",
   "description": "Markdown-ish syntax for generating flowcharts, sequence diagrams, class diagrams, gantt charts and git graphs.",
@@ -31,3 +31,3 @@ "main": "./dist/mermaid.min.js",
     "docs:pre:vitepress": "rimraf src/vitepress && pnpm docs:code && ts-node-esm src/docs.mts --vitepress",
-    "docs:build:vitepress": "pnpm docs:pre:vitepress && vitepress build src/vitepress",
+    "docs:build:vitepress": "pnpm docs:pre:vitepress && vitepress build src/vitepress && cpy --flat src/docs/landing/ ./src/vitepress/.vitepress/dist/landing",
     "docs:dev": "pnpm docs:pre:vitepress && concurrently \"vitepress dev src/vitepress\" \"ts-node-esm src/docs.mts --watch --vitepress\"",
@@ -59,3 +59,4 @@ "docs:serve": "pnpm docs:build:vitepress && vitepress serve src/vitepress",
     "dagre-d3-es": "7.0.6",
-    "dompurify": "2.4.1",
+    "dompurify": "2.4.3",
+    "elkjs": "^0.8.2",
     "khroma": "^2.0.0",
@@ -66,2 +67,3 @@ "lodash-es": "^4.17.21",
     "stylis": "^4.1.2",
+    "ts-dedent": "^2.2.0",
     "uuid": "^9.0.0"
@@ -83,2 +85,3 @@ },
     "coveralls": "^3.1.1",
+    "cpy-cli": "^4.2.0",
     "cspell": "^6.14.3",
@@ -94,2 +97,3 @@ "globby": "^13.1.2",
     "remark": "^14.0.2",
+    "remark-gfm": "^3.0.1",
     "rimraf": "^3.0.2",
@@ -101,4 +105,4 @@ "start-server-and-test": "^1.14.0",
     "unist-util-flatmap": "^1.0.0",
-    "vitepress": "^1.0.0-alpha.28",
-    "vitepress-plugin-search": "^1.0.4-alpha.15"
+    "vitepress": "^1.0.0-alpha.31",
+    "vitepress-plugin-search": "^1.0.4-alpha.16"
   },
@@ -105,0 +109,0 @@ "files": [

README.md

@@ -13,3 +13,3 @@ # mermaid
 
-<a href="https://mermaid-js.github.io/mermaid/landing/"><img src="https://github.com/mermaid-js/mermaid/blob/master/docs/img/book-banner-post-release.jpg" alt="Explore Mermaid.js in depth, with real-world examples, tips & tricks from the creator... The first official book on Mermaid is available for purchase. Check it out!"></a>
+<a href="https://mermaid-js.github.io/mermaid/landing/"><img src="https://github.com/mermaid-js/mermaid/blob/master/docs/intro/img/book-banner-post-release.jpg" alt="Explore Mermaid.js in depth, with real-world examples, tips & tricks from the creator... The first official book on Mermaid is available for purchase. Check it out!"></a>
 
@@ -16,0 +16,0 @@ ## About

README.zh-CN.md

@@ -13,3 +13,3 @@ # mermaid
 
-<a href="https://mermaid-js.github.io/mermaid/landing/"><img src="https://github.com/mermaid-js/mermaid/blob/master/docs/img/book-banner-pre-release.jpg" alt="Explore Mermaid.js in depth, with real-world examples, tips & tricks from the creator... The first official book on Mermaid is available for purchase. Check it out!"></a>
+<a href="https://mermaid-js.github.io/mermaid/landing/"><img src="https://github.com/mermaid-js/mermaid/blob/master/docs/intro/img/book-banner-post-release.jpg" alt="Explore Mermaid.js in depth, with real-world examples, tips & tricks from the creator... The first official book on Mermaid is available for purchase. Check it out!"></a>
 
@@ -16,0 +16,0 @@ ## 关于 Mermaid

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

36487251

increased by73.56%

Number of package files

154

increased by14.07%

Worsened metrics

Dependency count

12

increased by20%

Dev dependency count

33

increased by6.45%

Lines of code

120590

decreased by-19.68%

Number of low quality alerts

2

increased by100%

Published versions last two months

6

decreased by-14.29%

Published versions last week

0

decreased by-100%

Published versions last year

23

decreased by-4.17%

Dependency changes

• + Addedelkjs@^0.8.2

• + Addedts-dedent@^2.2.0

• + Addeddompurify@2.4.3(transitive)

• + Addedelkjs@0.8.2(transitive)

• + Addedts-dedent@2.2.0(transitive)

• - Removeddompurify@2.4.1(transitive)

• Updateddompurify@2.4.3