Add precompress option

fix #861 : Verify file download

.eslintrc.cjs

@@ -11,6 +11,7 @@ module.exports = {
 	ignorePatterns: [
 		'docs/*',
 		'*.cjs',
+		'*.js',
 		'*.md',
 		'snapshots.js',
 		'svelte.config.js',

.github/workflows/codeql-analysis.yml

@@ -39,7 +39,7 @@ jobs:
 
       # Initializes the CodeQL tools for scanning.
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@v1
+        uses: github/codeql-action/init@v2
         with:
           config-file: ./.github/codeql/config.yml
           languages: ${{ matrix.language }}
@@ -65,4 +65,4 @@ jobs:
       #   make release
 
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v1
+        uses: github/codeql-action/analyze@v2

.github/workflows/cypress.yml

@@ -9,8 +9,6 @@ on:
 jobs:
   cypress-run:
     runs-on: ubuntu-latest
-    # Update after https://github.com/cypress-io/cypress-docker-images/issues/487
-    container: cypress/browsers:node14.16.0-chrome90-ff88
 
     steps:
       - name: Checkout
@@ -27,6 +25,11 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-node_modules-build-
 
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          cache: 'yarn'
+
       - name: Build & Lint
         run: |
           yarn install
@@ -36,7 +39,7 @@ jobs:
       # Install NPM dependencies, cache them correctly
       # and run all Cypress tests
       - name: Cypress run
-        uses: cypress-io/github-action@v2
+        uses: cypress-io/github-action@v3
         with:
           start: yarn preview
           wait-on: 'http://localhost:3000'

.github/workflows/deploy.yml

@@ -21,7 +21,6 @@ jobs:
 
       - name: Build & Deploy
         run: |
-          npm i -g yarn
           export DEPLOY=true
           [ "$GITHUB_EVENT_NAME" != "pull_request" ] && rm -rf docs/_app/
           yarn install

.github/workflows/stale.yml

@@ -8,10 +8,13 @@ jobs:
   stale:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/stale@v4
+      - uses: actions/stale@v5
         with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
           exempt-issue-labels: 'retained'
           exempt-pr-labels: 'retained'
-          stale-issue-message: 'This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 7 days'
-          stale-pr-message: 'This pr is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 7 days'
+          stale-issue-message: 'This issue is stale because it has been open 90 days with no activity. Remove stale label or comment or this will be closed in 14 days'
+          stale-pr-message: 'This pr is stale because it has been open 90 days with no activity. Remove stale label or comment or this will be closed in 14 days'
+          days-before-stale: 90
+          days-before-close: 14
+          days-before-pr-close: -1

.github/workflows/update-browserlist.yml

@@ -1,6 +1,9 @@
 name: Update Browserslist
 on:
   workflow_dispatch:
+  push:
+    branches:
+      - develop
 
 jobs:
   build:

.gitignore

@@ -9,5 +9,6 @@ yarn-error.log
 /build
 /functions
 /snapshots.js
+/cypress/downloads
 /cypress/videos
 /cypress/screenshots

Dockerfile

@@ -6,7 +6,7 @@
 # Stop               : press ctrl + c 
 #                                     or 
 #                                        docker stop mermaid-live-editor
-FROM node:17.8.0 as mermaid-live-editor-builder 
+FROM node:18.4.0 as mermaid-live-editor-builder 
 COPY --chown=node:node . /home
 WORKDIR /home
 RUN yarn install

Dockerfile.dev

@@ -1,4 +1,4 @@
-FROM node:17
+FROM node:18
 WORKDIR /app
 COPY package.json .
 COPY yarn.lock .

SECURITY.md

@@ -0,0 +1,13 @@
+# Security Policy
+
+## Supported Versions
+
+Live editor only has a single version, which will be maintained.
+
+| Version | Supported          |
+| ------- | ------------------ |
+| latest   | :white_check_mark: |
+
+## Reporting a Vulnerability
+
+To report a vulnerability, please e-mail security@mermaid.live with a description of the issue, the steps you took to create the issue, affected versions, and if known, mitigations for the issue.

cypress.config.js

@@ -0,0 +1,31 @@
+import { defineConfig } from 'cypress';
+import fs from 'fs';
+import { isFileExist, findFiles } from 'cy-verify-downloads';
+export default defineConfig({
+	projectId: '2ckppp',
+	viewportWidth: 1440,
+	viewportHeight: 768,
+	snapshotFileName: './cypress/snapshots.js',
+	defaultCommandTimeout: 16000,
+	requestTimeout: 16000,
+	e2e: {
+		setupNodeEvents(on, config) {
+			on('task', {
+				isFileExist,
+				findFiles,
+				deleteFile(path) {
+					fs.rmSync(path);
+					return null;
+				},
+				readFileMaybe(filename) {
+					if (fs.existsSync(filename)) {
+						return fs.readFileSync(filename, 'utf8');
+					}
+					return null;
+				}
+			});
+		},
+		baseUrl: 'http://localhost:3000',
+		specPattern: 'cypress/e2e/**/*.{js,jsx,ts,tsx}'
+	}
+});

cypress.json

@@ -1,11 +0,0 @@
-{
-	"projectId": "2ckppp",
-	"$schema": "https://on.cypress.io/cypress.schema.json",
-	"baseUrl": "http://localhost:3000",
-	"pluginsFile": "./cypress/plugins/index.cjs",
-	"viewportWidth": 1440,
-	"viewportHeight": 768,
-	"snapshotFileName": "./cypress/snapshots.js",
-	"defaultCommandTimeout": 16000,
-	"requestTimeout": 16000
-}

cypress/e2e/actions.spec.ts

@@ -0,0 +1,54 @@
+describe('Check actions', () => {
+	beforeEach(() => {
+		cy.clearLocalStorage();
+		cy.visit('/edit');
+	});
+
+	it('should update markdown code', () => {
+		cy.get('#markdown')
+			.invoke('val')
+			.then((oldText) => {
+				cy.get('#editor').click('bottom').type('{enter}C --> HistoryTest');
+				cy.get('#markdown')
+					.invoke('val')
+					.then((newText) => {
+						expect(oldText).to.not.eq(newText);
+					});
+			});
+	});
+
+	it('should load gists from URL', () => {
+		cy.get('#gist').type('https://gist.github.com/sidharthv96/6268a23e673a533dcb198f241fd7012a');
+		cy.contains('Load Gist').click();
+		cy.contains('Go shopping!!');
+	});
+
+	it('should download png and svg', () => {
+		const now = new Date(2022, 0, 1).getTime();
+		cy.clock(now);
+		const downloadsFolder = Cypress.config('downloadsFolder');
+
+		const verifyFileSize = (fileType: string, size: number) => {
+			cy.get(`#download${fileType.toUpperCase()}`).click();
+			const fileName = `mermaid-diagram-2022-01-01-000000.${fileType}`;
+			const filePath = `${downloadsFolder}/${fileName}`;
+			cy.verifyDownload(fileName);
+			cy.readFile(filePath, null, {
+				log: false
+			}).then((buffer) => expect((buffer as ArrayBuffer).byteLength).to.be.gt(size));
+			cy.task('deleteFile', filePath);
+		};
+
+		verifyFileSize('png', 21_000);
+		verifyFileSize('svg', 11_000);
+
+		// Verify downloaded file is different for different diagrams
+		cy.contains('Sample Diagrams').click();
+		cy.contains('ER Diagram').click();
+
+		verifyFileSize('png', 46_000);
+		verifyFileSize('svg', 12_000);
+
+		cy.clock().invoke('restore');
+	});
+});

cypress/e2e/diagramUpdate.spec.ts

@@ -3,6 +3,7 @@ describe('Auto sync tests', () => {
 		cy.clearLocalStorage();
 		cy.visit('/');
 	});
+
 	it('should dim diagram when code is edited', () => {
 		cy.contains('Auto sync').click();
 		cy.get('#view').should('not.have.class', 'outOfSync');
@@ -40,4 +41,17 @@ describe('Auto sync tests', () => {
 		cy.get('#editor').type(`{uparrow}{${cmd}}/`);
 		cy.get('#view').contains('Car').should('exist');
 	});
+
+	it('supports editing code when code is incorrect', () => {
+		cy.visit(
+			'/edit#pako:eNpljjEKwzAMRa8SNOcEnlt6gK5eVFvYJsgOqkwpIXevg9smEE1PnyfxF3DFExgISW-CczQ2D21cYU7a-SGYXRwyvTp9jUhuKlVP-eHy7zA-leQsMEmg_QOM0BLG5FujZVMsaCQmC6ahR5ks2Lw2r84ela4-aREwKpVGwKrl_s7ut3fnkjAIcg_XDzuaUhs'
+		);
+		cy.get('#editor').type(`{enter}branch test`);
+		cy.get('#editor').contains('branch test').should('exist');
+		cy.get('#errorContainer')
+			.contains(
+				'Error: Trying to checkout branch which is not yet created. (Help try using "branch master")'
+			)
+			.should('exist');
+	});
 });

cypress/integration/actions.spec.ts

@@ -1,24 +0,0 @@
-describe('Check actions', () => {
-	beforeEach(() => {
-		cy.clearLocalStorage();
-		cy.visit('/edit');
-	});
-	it('should update markdown code', () => {
-		cy.get('#markdown')
-			.invoke('val')
-			.then((oldText) => {
-				cy.get('#editor').click('bottom').type('{enter}C --> HistoryTest');
-				cy.get('#markdown')
-					.invoke('val')
-					.then((newText) => {
-						expect(oldText).to.not.eq(newText);
-					});
-			});
-	});
-
-	it('should load gists from URL', () => {
-		cy.get('#gist').type('https://gist.github.com/sidharthv96/6268a23e673a533dcb198f241fd7012a');
-		cy.contains('Load Gist').click();
-		cy.contains('Go shopping!!');
-	});
-});

cypress/plugins/index.cjs

@@ -1,31 +0,0 @@
-/// <reference types="cypress" />
-// ***********************************************************
-// This example plugins/index.js can be used to load plugins
-//
-// You can change the location of this file or turn off loading
-// the plugins file with the 'pluginsFile' configuration option.
-//
-// You can read more here:
-// https://on.cypress.io/plugins-guide
-// ***********************************************************
-
-// This function is called when a project is opened or re-opened (e.g. due to
-// the project's config changing)
-
-/**
- * @type {Cypress.PluginConfig}
- */
-// eslint-disable-next-line no-unused-vars
-import * as fs from 'fs';
-
-module.exports = (on, config) => {
-	on('task', {
-		readFileMaybe(filename) {
-			if (fs.existsSync(filename)) {
-				return fs.readFileSync(filename, 'utf8');
-			}
-
-			return null;
-		}
-	});
-};

cypress/snapshots.js

@@ -16,7 +16,7 @@ module.exports = {
       "1": "{\"code\":\"graph TD\\n    A[Party] -->|Get money| B(Go shopping!!)\\n    \",\"mermaid\":\"{\\n  \\\"theme\\\": \\\"forest\\\",\\n  \\\"test\\\": \\\"hello world\\\"\\n}\",\"updateEditor\":false,\"autoSync\":true,\"updateDiagram\":true,\"loader\":{\"type\":\"files\",\"config\":{\"codeURL\":\"https://gist.githubusercontent.com/sidharthv96/6268a23e673a533dcb198f241fd7012a/raw/4eb03887e6a41397e80bdcdbf94017c498f8f1e2/code.mmd\",\"configURL\":\"https://gist.githubusercontent.com/sidharthv96/6268a23e673a533dcb198f241fd7012a/raw/4eb03887e6a41397e80bdcdbf94017c498f8f1e2/config.json\"}}}"
     }
   },
-  "__version": "9.5.1",
+  "__version": "10.2.0",
   "Auto sync tests": {
     "should dim diagram when code is edited": {
       "1": "{\"code\":\"graph TD\\n    A[Christmas] -->|Get money| B(Go shopping)\\n    B --> C{Let me think}\\n    C -->|One| D[Laptop]\\n    C -->|Two| E[iPhone]\\n    C -->|Three| F[fa:fa-car Car]\\n    C --> Test\",\"mermaid\":\"{\\n  \\\"theme\\\": \\\"default\\\"\\n}\",\"updateEditor\":false,\"autoSync\":false,\"updateDiagram\":false}"

cypress/support/e2e.js

@@ -15,6 +15,7 @@
 
 // Import commands.js using ES2015 syntax:
 import './commands';
+require('cy-verify-downloads').addCustomCommand();
 
 // Alternatively you can use CommonJS syntax:
 // require('./commands')

cypress/tsconfig.json

@@ -1,7 +1,7 @@
 {
 	"compilerOptions": {
 		"allowJs": true,
-		"types": ["cypress", "cypress-localstorage-commands"]
+		"types": ["cypress", "cypress-localstorage-commands", "cy-verify-downloads"]
 	},
 	"include": ["**/*.ts"]
 }

package.json

@@ -1,64 +1,65 @@
 {
 	"name": "mermaid-live-editor",
 	"version": "2.0.67",
+	"type": "module",
 	"scripts": {
 		"dev": "svelte-kit dev --host 0.0.0.0",
 		"build": "svelte-kit build",
 		"preview": "svelte-kit preview",
-		"lint": "prettier --check --plugin-search-dir=. .;eslint --ignore-path .gitignore .",
-		"lint:fix": "prettier --write --plugin-search-dir=. .;eslint --fix --ignore-path .gitignore .",
-		"format": "prettier --write --plugin-search-dir=. .",
+		"lint": "prettier --check --cache --plugin-search-dir=. .;eslint --ignore-path .gitignore .",
+		"lint:fix": "prettier --write --cache --plugin-search-dir=. .;eslint --fix --ignore-path .gitignore .",
+		"format": "prettier --write --cache --plugin-search-dir=. .",
 		"pre-commit": "lint-staged",
-		"postinstall": "husky install",
+		"postinstall": "husky install; cypress cache prune",
 		"test": "cypress run",
 		"cy": "cypress open"
 	},
 	"devDependencies": {
 		"@cypress/snapshot": "^2.1.7",
-		"@sveltejs/adapter-static": "1.0.0-next.29",
-		"@sveltejs/kit": "1.0.0-next.303",
+		"@sveltejs/adapter-static": "1.0.0-next.34",
+		"@sveltejs/kit": "1.0.0-next.355",
 		"@types/mermaid": "^8.2.9",
 		"@types/pako": "^1.0.3",
 		"@typescript-eslint/eslint-plugin": "^4.33.0",
 		"@typescript-eslint/parser": "^4.33.0",
-		"autoprefixer": "^10.4.4",
+		"autoprefixer": "^10.4.7",
 		"chai": "^4.3.6",
-		"cssnano": "^5.1.5",
-		"cypress": "9.5.2",
-		"cypress-localstorage-commands": "^1.7.0",
+		"cssnano": "^5.1.12",
+		"cy-verify-downloads": "^0.1.8",
+		"cypress": "10.2.0",
+		"cypress-localstorage-commands": "^2.1.0",
 		"eslint": "^7.32.0",
 		"eslint-config-prettier": "^8.5.0",
 		"eslint-plugin-cypress": "^2.12.1",
 		"eslint-plugin-es": "^4.1.0",
-		"eslint-plugin-mocha": "^10.0.3",
+		"eslint-plugin-mocha": "^10.0.5",
 		"eslint-plugin-postcss-modules": "^2.0.0",
 		"eslint-plugin-svelte3": "^3.4.1",
-		"eslint-plugin-tailwindcss": "^3.5.0",
-		"husky": "^7.0.4",
-		"lint-staged": "^12.3.7",
-		"mocha": "^9.2.2",
+		"eslint-plugin-tailwindcss": "^3.5.2",
+		"husky": "^8.0.1",
+		"lint-staged": "13.0.2",
+		"mocha": "^10.0.0",
 		"node-html-parser": "^5.3.3",
-		"postcss": "^8.4.12",
-		"postcss-load-config": "^3.1.3",
-		"prettier": "~2.6.1",
-		"prettier-plugin-svelte": "^2.6.0",
-		"svelte": "^3.46.4",
-		"svelte-preprocess": "^4.10.4",
-		"tailwindcss": "^3.0.21",
-		"tslib": "^2.3.1",
-		"typescript": "^4.6.3"
+		"postcss": "^8.4.14",
+		"postcss-load-config": "^4.0.1",
+		"prettier": "~2.7.1",
+		"prettier-plugin-svelte": "^2.7.0",
+		"svelte": "^3.48.0",
+		"svelte-preprocess": "4.10.7",
+		"tailwindcss": "^3.1.4",
+		"tslib": "^2.4.0",
+		"typescript": "^4.7.3"
 	},
-	"type": "module",
 	"dependencies": {
 		"@analytics/google-analytics": "^0.5.3",
 		"@macfja/svelte-persistent-store": "^1.3.0",
 		"analytics": "^0.8.1",
-		"daisyui": "2.13.0",
+		"daisyui": "2.17.0",
 		"js-base64": "^3.7.2",
-		"mermaid": "8.14.0",
-		"moment": "^2.29.1",
+		"mermaid": "9.1.2",
+		"moment": "^2.29.3",
 		"monaco-editor": "^0.33.0",
-		"monaco-mermaid": "^1.0.3",
+		"monaco-mermaid": "^1.0.6",
 		"pako": "2.0.4",
 		"random-word-slugs": "^0.1.6"
 	},
@@ -69,8 +70,10 @@
 		]
 	},
 	"volta": {
-		"node": "14.16.1",
-		"yarn": "1.22.10",
-		"npm": "7.11.2"
+		"node": "16.15.0",
+		"yarn": "1.22.10"
+	},
+	"engines": {
+		"node": ">=16.7"
 	}
 }

src/app.html

@@ -11,37 +11,15 @@
 		<meta
 			name="description"
 			content="Simplify documentation and avoid heavy tools. Open source Visio Alternative. Commonly used for explaining your code! Mermaid is a simple markdown-like script language for generating charts from text via javascript." />
-		<link rel="icon" type="image/png" href="%svelte.assets%/favicon.png" />
-		<link rel="manifest" href="%svelte.assets%/manifest.json" />
+		<link rel="icon" type="image/png" href="%sveltekit.assets%/favicon.png" />
+		<link rel="manifest" href="%sveltekit.assets%/manifest.json" />
 		<link
 			rel="stylesheet"
 			href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.2/css/all.min.css" />
-		<link
-			rel="stylesheet"
-			href="https://cdnjs.cloudflare.com/ajax/libs/monaco-editor/0.33.0/min/vs/editor/editor.main.min.css"
-			crossorigin="anonymous"
-			referrerpolicy="no-referrer" />
-		<script>
-			var require = {
-				paths: { vs: 'https://cdnjs.cloudflare.com/ajax/libs/monaco-editor/0.33.0/min/vs' }
-			};
-		</script>
-		<script
-			src="https://cdnjs.cloudflare.com/ajax/libs/monaco-editor/0.33.0/min/vs/loader.min.js"
-			crossorigin="anonymous"
-			referrerpolicy="no-referrer"></script>
-		<script
-			src="https://cdnjs.cloudflare.com/ajax/libs/monaco-editor/0.33.0/min/vs/editor/editor.main.nls.min.js"
-			crossorigin="anonymous"
-			referrerpolicy="no-referrer"></script>
-		<script
-			src="https://cdnjs.cloudflare.com/ajax/libs/monaco-editor/0.33.0/min/vs/editor/editor.main.js"
-			crossorigin="anonymous"
-			referrerpolicy="no-referrer"></script>
 
-		%svelte.head%
+		%sveltekit.head%
 	</head>
 	<body>
-		<div id="svelte">%svelte.body%</div>
+		<div id="svelte">%sveltekit.body%</div>
 	</body>
 </html>

src/lib/components/actions.svelte

@@ -4,17 +4,20 @@
 	import Card from '$lib/components/card/card.svelte';
 	import { krokiRendererUrl, rendererUrl } from '$lib/util/env';
 	import { pakoSerde } from '$lib/util/serde';
-	import { serializedState, codeStore } from '$lib/util/state';
+	import { stateStore } from '$lib/util/state';
 	import { toBase64 } from 'js-base64';
 	import moment from 'moment';
 
 	type Exporter = (context: CanvasRenderingContext2D, image: HTMLImageElement) => () => void;
 
+	const getFileName = (ext: string) =>
+		`mermaid-diagram-${moment().format('YYYY-MM-DD-HHmmss')}.${ext}`;
+
 	const getBase64SVG = (svg?: HTMLElement, width?: number, height?: number): string => {
 		svg?.setAttribute('height', `${height}px`);
 		svg?.setAttribute('width', `${width}px`); // Workaround https://stackoverflow.com/questions/28690643/firefox-error-rendering-an-svg-image-to-html5-canvas-with-drawimage
 		if (!svg) {
-			svg = document.querySelector('#container svg');
+			svg = getSvgEl();
 		}
 		const svgString = svg.outerHTML
 			.replaceAll('<br>', '<br/>')
@@ -50,6 +53,22 @@
 		event.preventDefault();
 	};
 
+	const getSvgEl = () => {
+		const svgEl: HTMLElement = document
+			.querySelector('#container svg')
+			.cloneNode(true) as HTMLElement;
+		const fontAwesomeCdnUrl = Array.from(document.head.getElementsByTagName('link'))
+			.map((l) => l.href)
+			.find((h) => h && h.includes('font-awesome'));
+		if (fontAwesomeCdnUrl == null) {
+			return svgEl;
+		}
+		const styleEl = document.createElement('style');
+		styleEl.innerText = `@import url("${fontAwesomeCdnUrl}");'`;
+		svgEl.prepend(styleEl);
+		return svgEl;
+	};
+
 	const simulateDownload = (download: string, href: string): void => {
 		const a = document.createElement('a');
 		a.download = download;
@@ -62,7 +81,7 @@
 			const { canvas } = context;
 			context.drawImage(image, 0, 0, canvas.width, canvas.height);
 			simulateDownload(
-				`mermaid-diagram-${moment().format('YYYYMMDDHHmmss')}.png`,
+				getFileName('png'),
 				canvas.toDataURL('image/png').replace('image/png', 'image/octet-stream')
 			);
 		};
@@ -102,10 +121,7 @@
 	};
 
 	const onDownloadSVG = () => {
-		simulateDownload(
-			`mermaid-diagram-${moment().format('YYYYMMDDHHmmss')}.svg`,
-			`data:image/svg+xml;base64,${getBase64SVG()}`
-		);
+		simulateDownload(getFileName('svg'), `data:image/svg+xml;base64,${getBase64SVG()}`);
 	};
 
 	const onCopyMarkdown = () => {
@@ -114,10 +130,10 @@
 	};
 
 	let gistURL = '';
-	codeStore.subscribe((state) => {
-		if (state.loader?.type === 'gist') {
+	stateStore.subscribe(({ loader }) => {
+		if (loader?.type === 'gist') {
 			// @ts-ignore Gist will have url
-			gistURL = state.loader.config.url;
+			gistURL = loader.config.url;
 		}
 	});
 
@@ -139,11 +155,11 @@
 	if (browser && ['mermaid.live', 'netlify'].some((path) => window.location.host.includes(path))) {
 		isNetlify = true;
 	}
-	serializedState.subscribe((encodedState: string) => {
-		iUrl = `${rendererUrl}/img/${encodedState}`;
-		svgUrl = `${rendererUrl}/svg/${encodedState}`;
-		krokiUrl = `${krokiRendererUrl}/mermaid/svg/${pakoSerde.serialize($codeStore.code)}`;
-		mdCode = `[![](${iUrl})](${window.location.protocol}//${window.location.host}${window.location.pathname}#${encodedState})`;
+	stateStore.subscribe(({ code, serialized }) => {
+		iUrl = `${rendererUrl}/img/${serialized}`;
+		svgUrl = `${rendererUrl}/svg/${serialized}`;
+		krokiUrl = `${krokiRendererUrl}/mermaid/svg/${pakoSerde.serialize(code)}`;
+		mdCode = `[![](${iUrl})](${window.location.protocol}//${window.location.host}${window.location.pathname}#${serialized})`;
 	});
 </script>
 
@@ -154,21 +170,29 @@
 				><i class="far fa-copy mr-2" /> Copy Image to clipboard
 			</button>
 		{/if}
-		<button class="action-btn flex-auto" on:click={onDownloadPNG}>
+		<button id="downloadPNG" class="action-btn flex-auto" on:click={onDownloadPNG}>
 			<i class="fas fa-download mr-2" /> PNG
 		</button>
-		<button class="action-btn flex-auto" on:click={onDownloadSVG}>
+		<button id="downloadSVG" class="action-btn flex-auto" on:click={onDownloadSVG}>
 			<i class="fas fa-download mr-2" /> SVG
 		</button>
-		<button class="action-btn flex-auto">
-			<a target="_blank" href={iUrl}><i class="fas fa-external-link-alt mr-2" /> PNG</a>
-		</button>
-		<button class="action-btn flex-auto">
-			<a target="_blank" href={svgUrl}><i class="fas fa-external-link-alt mr-2" /> SVG</a>
-		</button>
-		<button class="action-btn flex-auto">
-			<a target="_blank" href={krokiUrl}><i class="fas fa-external-link-alt mr-2" /> Kroki</a>
-		</button>
+		<a target="_blank" href={iUrl}>
+			<button class="action-btn flex-auto">
+				<i class="fas fa-external-link-alt mr-2" /> PNG
+			</button>
+		</a>
+
+		<a target="_blank" href={svgUrl}>
+			<button class="action-btn flex-auto">
+				<i class="fas fa-external-link-alt mr-2" /> SVG
+			</button>
+		</a>
+
+		<a target="_blank" href={krokiUrl}>
+			<button class="action-btn flex-auto">
+				<i class="fas fa-external-link-alt mr-2" /> Kroki
+			</button>
+		</a>
 
 		<div class="flex gap-2 items-center">
 			PNG size

src/lib/components/editor.svelte

@@ -1,7 +1,8 @@
 <script lang="ts">
 	import type { EditorEvents } from '$lib/types';
-	import { codeStore } from '$lib/util/state';
+	import { stateStore } from '$lib/util/state';
 	import { themeStore } from '$lib/util/theme';
+
 	import type monaco from 'monaco-editor';
 	import { createEventDispatcher, onMount } from 'svelte';
 	import initEditor from 'monaco-mermaid';
@@ -21,17 +22,16 @@
 		theme: 'mermaid',
 		overviewRulerLanes: 0
 	};
-	export let errorMarkers: monaco.editor.IMarkerData[] = [];
 	let oldText = text;
 	$: editor && Monaco?.editor.setModelLanguage(editor.getModel(), language);
 	$: {
 		if (text !== oldText) {
-			if ($codeStore.updateEditor) {
+			if ($stateStore.updateEditor) {
 				editor?.setValue(text);
 			}
 			oldText = text;
 		}
-		editor && Monaco?.editor.setModelMarkers(editor.getModel(), 'test', errorMarkers);
+		editor && Monaco?.editor.setModelMarkers(editor.getModel(), 'test', $stateStore.errorMarkers);
 	}
 
 	themeStore.subscribe(({ isDark }) => {
@@ -39,26 +39,43 @@
 	});
 
 	const dispatch = createEventDispatcher<EditorEvents>();
-	const loadMonaco = async () => {
-		let i = 0;
-		while (i++ < 10) {
-			try {
-				// @ts-ignore : This is a hack to handle a svelte-kit error when importing monaco.
-				Monaco = monaco;
-				return;
-			} catch {
-				await new Promise((r) => setTimeout(r, 500));
-			}
-		}
-		alert('Loading Monaco Editor failed. Please try refreshing the page.');
-	};
+
 	onMount(async () => {
-		try {
-			// @ts-ignore : This is a hack to handle a svelte-kit error when importing monaco.
-			Monaco = monaco;
-		} catch {
-			await loadMonaco(); // Fix https://github.com/mermaid-js/mermaid-live-editor/issues/175
-		}
+		// @ts-ignore
+		self.MonacoEnvironment = {
+			getWorker: function (workerId: string, label: string) {
+				const getWorkerModule = (moduleUrl: string, label: string): Worker => {
+					// @ts-ignore
+					return new Worker(self.MonacoEnvironment.getWorkerUrl(moduleUrl), {
+						name: label,
+						type: 'module'
+					});
+				};
+
+				switch (label) {
+					case 'json':
+						return getWorkerModule('/monaco-editor/esm/vs/language/json/json.worker?worker', label);
+					case 'css':
+					case 'scss':
+					case 'less':
+						return getWorkerModule('/monaco-editor/esm/vs/language/css/css.worker?worker', label);
+					case 'html':
+					case 'handlebars':
+					case 'razor':
+						return getWorkerModule('/monaco-editor/esm/vs/language/html/html.worker?worker', label);
+					case 'typescript':
+					case 'javascript':
+						return getWorkerModule(
+							'/monaco-editor/esm/vs/language/typescript/ts.worker?worker',
+							label
+						);
+					default:
+						return getWorkerModule('/monaco-editor/esm/vs/editor/editor.worker?worker', label);
+				}
+			}
+		};
+
+		Monaco = await import('monaco-editor');
 		initEditor(Monaco);
 		editor = Monaco.editor.create(divEl, editorOptions);
 		editor.onDidChangeModelContent(() => {
@@ -67,7 +84,7 @@
 				text
 			});
 		});
-		Monaco?.editor.setTheme($themeStore.isDark ? 'mermaid-dark' : 'mermaid');
+		Monaco.editor.setTheme($themeStore.isDark ? 'mermaid-dark' : 'mermaid');
 		const resizeObserver = new ResizeObserver((entries) => {
 			editor.layout({
 				height: entries[0].contentRect.height,

src/lib/components/history/history.svelte

@@ -1,6 +1,6 @@
 <script lang="ts">
 	import Card from '$lib/components/card/card.svelte';
-	import { codeStore, getStateString } from '$lib/util/state';
+	import { inputStateStore, getStateString } from '$lib/util/state';
 	import {
 		addHistoryEntry,
 		historyModeStore,
@@ -37,7 +37,7 @@
 		const previousState: string = getPreviousState(auto);
 		if (previousState !== currentState) {
 			addHistoryEntry({
-				state: $codeStore,
+				state: $inputStateStore,
 				time: Date.now(),
 				type: auto ? 'auto' : 'manual'
 			});
@@ -54,7 +54,7 @@
 	};
 
 	const restoreHistory = (state: State): void => {
-		codeStore.set({ ...state, updateEditor: true, updateDiagram: true });
+		inputStateStore.set({ ...state, updateEditor: true, updateDiagram: true });
 	};
 
 	const relativeTime = (time: number) => {

src/lib/components/preset.svelte

@@ -79,11 +79,26 @@
     section Go home
       Go downstairs: 5: Me
       Sit down: 3: Me
-      `
+      `,
+		'Git Graph': `    gitGraph
+      commit
+      commit
+      branch develop
+      checkout develop
+      commit
+      commit
+      checkout main
+      merge develop
+      commit
+      commit
+`
 	};
 
 	const loadSampleDiagram = (diagramType: string): void => {
-		updateCode(samples[diagramType], true, true);
+		updateCode(samples[diagramType], {
+			updateDiagram: true,
+			updateEditor: true
+		});
 	};
 </script>
 

src/lib/components/view.svelte

@@ -1,7 +1,5 @@
 <script lang="ts">
-	import { errorStore } from '$lib/util/error';
-
-	import { codeStore } from '$lib/util/state';
+	import { inputStateStore, stateStore } from '$lib/util/state';
 	import { onMount } from 'svelte';
 	import mermaid from 'mermaid';
 
@@ -13,11 +11,16 @@
 	let outOfSync = false;
 	let manualUpdate = true;
 	onMount(() => {
-		codeStore.subscribe((state) => {
+		stateStore.subscribe((state) => {
+			if (state.error !== undefined) {
+				error = true;
+				return;
+			}
+			error = false;
 			try {
 				if (container && state && (state.updateDiagram || state.autoSync)) {
 					if (!state.autoSync) {
-						$codeStore.updateDiagram = false;
+						$inputStateStore.updateDiagram = false;
 					}
 					outOfSync = false;
 					manualUpdate = true;
@@ -31,7 +34,10 @@
 					delete container.dataset.processed;
 					mermaid.initialize(Object.assign({}, JSON.parse(state.mermaid)));
 					mermaid.render('graph-div', code, (svgCode) => {
-						container.innerHTML = svgCode;
+						if (svgCode.length > 0) {
+							console.log(svgCode);
+							container.innerHTML = svgCode;
+						}
 					});
 					view.parentElement.scrollTop = scroll;
 					error = false;
@@ -45,24 +51,19 @@
 				error = true;
 			}
 		});
-		errorStore.subscribe((err) => {
-			if (typeof err === 'undefined') {
-				error = false;
-			} else {
-				error = true;
-				console.log('Error: ', err);
-			}
-		});
 	});
 </script>
 
+{#if error && $stateStore.error instanceof Error}
+	<div class="p-2 text-red-600" id="errorContainer">{$stateStore.error}</div>
+{/if}
+
 <div id="view" bind:this={view} class="p-2" class:error class:outOfSync>
 	<div id="container" bind:this={container} class="flex-1 overflow-auto" />
 </div>
 
 <style>
 	#view {
-		border: 1px solor darkred;
 		flex: 1;
 	}
 	.error,

src/lib/types.d.ts

@@ -6,6 +6,16 @@ export interface Locals {
 	userid: string;
 }
 
+export interface MarkerData {
+	severity: number;
+	message: string;
+	source?: string;
+	startLineNumber: number;
+	startColumn: number;
+	endLineNumber: number;
+	endColumn: number;
+}
+
 export interface EditorUpdateEvent {
 	text: string;
 }
@@ -32,6 +42,12 @@ export interface State {
 	loader?: LoaderConfig;
 }
 
+export interface ValidatedState extends State {
+	error: any;
+	errorMarkers: MarkerData[];
+	serialized: string;
+}
+
 export interface GistLoaderConfig {
 	url: string;
 }
@@ -64,4 +80,4 @@ export interface DocConfig {
 	};
 }
 
-type Loader = (url: string) => Promise<State>;
+export type Loader = (url: string) => Promise<State>;

src/lib/util/error.ts

@@ -1,3 +0,0 @@
-import { writable } from 'svelte/store';
-
-export const errorStore = writable(undefined);

src/lib/util/fileLoaders/loader.ts

@@ -54,5 +54,4 @@ export const loadDataFromUrl = async (): Promise<void> => {
 			updateDiagram: true,
 			updateEditor: true
 		});
-	// window.location.search = '';
 };

src/lib/util/state.ts

@@ -1,9 +1,11 @@
 import { writable, get, derived } from 'svelte/store';
-import type { Readable } from 'svelte/store';
 import { persist, localStorage } from '@macfja/svelte-persistent-store';
-import type { State } from '$lib/types';
 import { saveStatistics } from './stats';
 import { serializeState, deserializeState } from './serde';
+import mermaid from 'mermaid';
+
+import type { Readable } from 'svelte/store';
+import type { MarkerData, State, ValidatedState } from '$lib/types';
 
 export const defaultState: State = {
 	code: `graph TD
@@ -36,9 +38,42 @@ const urlParseFailedState = `graph TD
     G --> |"No :("| H(Try using the Timeline tab in History <br/>from same browser you used to create the diagram.)
     click D href "https://github.com/mermaid-js/mermaid-live-editor/issues/new?assignees=&labels=bug&template=bug_report.md&title=Broken%20link" "Raise issue"`;
 
-export const codeStore = persist(writable(defaultState), localStorage(), 'codeStore');
-export const serializedState: Readable<string> = derived([codeStore], ([code], set) => {
-	set(serializeState(code));
+// inputStateStore handles all updates and is shared externally when exporting via URL, History, etc.
+export const inputStateStore = persist(writable(defaultState), localStorage(), 'codeStore');
+
+// All internal reads should be done via stateStore, but it should not be persisted/shared externally.
+export const stateStore: Readable<ValidatedState> = derived([inputStateStore], ([state]) => {
+	const processed: ValidatedState = {
+		...state,
+		serialized: '',
+		errorMarkers: [],
+		error: undefined
+	};
+	// No changes should be done to fields part of `state`.
+	try {
+		processed.serialized = serializeState(state);
+		mermaid.parse(state.code);
+		JSON.parse(state.mermaid);
+	} catch (e) {
+		processed.error = e;
+		console.error(e);
+		if (e.hash) {
+			try {
+				const marker: MarkerData = {
+					severity: 8, // Error
+					startLineNumber: e.hash.loc.first_line,
+					startColumn: e.hash.loc.first_column,
+					endLineNumber: e.hash.loc.last_line,
+					endColumn: (e.hash.loc.last_column as number) + 1,
+					message: e.str
+				};
+				processed.errorMarkers = [marker];
+			} catch (err) {
+				console.error('Error without line helper', err);
+			}
+		}
+	}
+	return processed;
 });
 
 export const loadState = (data: string): void => {
@@ -57,30 +92,33 @@ export const loadState = (data: string): void => {
 		) {
 			delete mermaidConfig.securityLevel; // Prevent setting overriding securityLevel when loading state to mitigate possible XSS attack
 		}
-
 		state.mermaid = JSON.stringify(mermaidConfig, null, 2);
 	} catch (e) {
-		state = get(codeStore);
+		state = get(inputStateStore);
 		if (data) {
 			console.error('Init error', e);
 			state.code = urlParseFailedState;
+			state.mermaid = defaultState.mermaid;
 		}
 	}
 	updateCodeStore({ ...state, updateEditor: true });
 };
 
 export const updateCodeStore = (newState: State): void => {
-	codeStore.update((state) => {
+	inputStateStore.update((state) => {
 		return { ...state, ...newState };
 	});
 };
 
 let prompted = false;
-export const updateCode = (code: string, updateEditor: boolean, updateDiagram = false): void => {
+export const updateCode = (
+	code: string,
+	{ updateEditor, updateDiagram = false }: { updateEditor: boolean; updateDiagram?: boolean }
+): void => {
 	saveStatistics(code);
 	const lines = (code.match(/\n/g) || '').length + 1;
 
-	if (lines > 50 && !prompted && get(codeStore).autoSync) {
+	if (lines > 50 && !prompted && get(stateStore).autoSync) {
 		const turnOff = confirm(
 			'Long diagram detected. Turn off Auto Sync? Click the sync logo to manually sync.'
 		);
@@ -92,19 +130,19 @@ export const updateCode = (code: string, updateEditor: boolean, updateDiagram =
 		}
 	}
 
-	codeStore.update((state) => {
+	inputStateStore.update((state) => {
 		return { ...state, code, updateEditor, updateDiagram };
 	});
 };
 
 export const updateConfig = (config: string, updateEditor: boolean): void => {
-	codeStore.update((state) => {
+	inputStateStore.update((state) => {
 		return { ...state, mermaid: config, updateEditor };
 	});
 };
 
 export const toggleDarkTheme = (dark: boolean): void => {
-	codeStore.update((state) => {
+	inputStateStore.update((state) => {
 		const config = JSON.parse(state.mermaid);
 		if (!config.theme || ['dark', 'default'].includes(config.theme)) {
 			config.theme = dark ? 'dark' : 'default';
@@ -115,11 +153,11 @@ export const toggleDarkTheme = (dark: boolean): void => {
 };
 
 export const initURLSubscription = (): void => {
-	serializedState.subscribe((state: string) => {
-		history.replaceState(undefined, undefined, `#${state}`);
+	stateStore.subscribe(({ serialized }) => {
+		history.replaceState(undefined, undefined, `#${serialized}`);
 	});
 };
 
 export const getStateString = (): string => {
-	return JSON.stringify(get(codeStore));
+	return JSON.stringify(get(inputStateStore));
 };

src/routes/edit.svelte

@@ -6,17 +6,12 @@
 	import View from '$lib/components/view.svelte';
 	import Card from '$lib/components/card/card.svelte';
 	import History from '$lib/components/history/history.svelte';
-	import { updateCode, updateConfig, codeStore, serializedState } from '$lib/util/state';
+	import { updateCode, updateConfig, inputStateStore, stateStore } from '$lib/util/state';
 	import { initHandler, syncDiagram } from '$lib/util/util';
-	import { errorStore } from '$lib/util/error';
 	import { onMount } from 'svelte';
-	import mermaid from 'mermaid';
-	import type monaco from 'monaco-editor';
 	import type { EditorUpdateEvent, State, Tab, DocConfig } from '$lib/types';
 	import { base } from '$app/paths';
 
-	serializedState; // Weird fix for error > serializedState is not defined. Treeshaking?
-
 	type Modes = 'code' | 'config';
 	type Languages = 'mermaid' | 'json';
 
@@ -59,22 +54,25 @@
 		},
 		journey: {
 			code: '/#/user-journey'
+		},
+		gitGraph: {
+			code: '/#/gitgraph',
+			config: '/#/gitgraph?id=gitgraph-specific-configuration-options'
 		}
 	};
 	let text = '';
 	let docURL = docURLBase;
 	let language: Languages = 'mermaid';
-	let errorMarkers: monaco.editor.IMarkerData[] = [];
 	$: language = languageMap[selectedMode];
 	$: {
 		if (selectedMode === 'code') {
-			text = $codeStore.code;
+			text = $stateStore.code;
 		} else {
-			text = $codeStore.mermaid;
+			text = $stateStore.mermaid;
 		}
 	}
 
-	codeStore.subscribe((state: State) => {
+	stateStore.subscribe((state: State) => {
 		if (state.updateEditor) {
 			text = selectedMode === 'code' ? state.code : state.mermaid;
 		}
@@ -87,7 +85,7 @@
 	});
 	const tabSelectHandler = (message: CustomEvent<Tab>) => {
 		selectedMode = message.detail.id === 'code' ? 'code' : 'config';
-		$codeStore.updateEditor = true;
+		$inputStateStore.updateEditor = true;
 	};
 	const tabs: Tab[] = [
 		{
@@ -102,55 +100,26 @@
 		}
 	];
 
-	const handleCodeUpdate = (code: string): void => {
-		mermaid.parse(code);
-		updateCode(code, false);
-	};
-
-	const handleConfigUpdate = (config: string): void => {
-		JSON.parse(config);
-		updateConfig(config, false);
-	};
-
 	const updateHandler = (message: CustomEvent<EditorUpdateEvent>) => {
-		try {
-			if (selectedMode === 'code') {
-				handleCodeUpdate(message.detail.text);
-			} else {
-				handleConfigUpdate(message.detail.text);
-			}
-			errorStore.set(undefined);
-			errorMarkers = [];
-		} catch (e) {
-			errorStore.set(e);
-			if (e.hash) {
-				const marker: monaco.editor.IMarkerData = {
-					severity: 8, //Error
-					startLineNumber: e.hash.loc.first_line,
-					startColumn: e.hash.loc.first_column,
-					endLineNumber: e.hash.loc.last_line,
-					endColumn: (e.hash.loc.last_column as number) + 1,
-					message: e.str
-				};
-				errorMarkers.push(marker);
-				// Clear all previous errors before this error.
-				errorMarkers = errorMarkers.filter(
-					(m) => m.startLineNumber >= marker.startLineNumber && m.startColumn >= marker.startColumn
-				);
-			}
-			console.error(e);
+		const code = message.detail.text;
+		if (selectedMode === 'code') {
+			updateCode(code, {
+				updateEditor: false
+			});
+		} else {
+			updateConfig(code, false);
 		}
 	};
 
 	const viewDiagram = () => {
-		window.open(`${base}/view#${$serializedState}`, '_blank').focus();
+		window.open(`${base}/view#${$stateStore.serialized}`, '_blank').focus();
 	};
 
 	onMount(async () => {
 		await initHandler();
 		const resizer = document.getElementById('resizeHandler');
 		const element = document.getElementById('editorPane');
-		const resize = (e) => {
+		const resize = (e: { pageX: number }) => {
 			const newWidth = e.pageX - element.getBoundingClientRect().left;
 			if (newWidth > 50) {
 				element.style.width = `${newWidth}px`;
@@ -180,13 +149,13 @@
 								<span> Auto sync</span>
 								<input
 									type="checkbox"
-									class="toggle {$codeStore.autoSync ? 'btn-secondary' : 'toggle-primary'} ml-1"
+									class="toggle {$stateStore.autoSync ? 'btn-secondary' : 'toggle-primary'} ml-1"
 									id="autoSync"
-									bind:checked={$codeStore.autoSync} />
+									bind:checked={$inputStateStore.autoSync} />
 							</label>
 						</div>
 
-						{#if !$codeStore.autoSync}
+						{#if !$stateStore.autoSync}
 							<button
 								class="btn btn-secondary btn-xs mr-1"
 								title="Sync Diagram"
@@ -200,7 +169,7 @@
 					</div>
 				</div>
 
-				<Editor on:update={updateHandler} {language} bind:text {errorMarkers} />
+				<Editor on:update={updateHandler} {language} bind:text />
 			</Card>
 
 			<div class="-mt-2">

svelte.config.js

@@ -12,7 +12,8 @@ const config = {
 	],
 	kit: {
 		adapter: adapter({
-			pages: `docs`
+			pages: `docs`,
+			precompress: true
 		}),
 		paths: process.env['DEPLOY']
 			? {
@@ -23,6 +24,9 @@ const config = {
 		vite: {
 			envPrefix: 'MERMAID_',
 			optimizeDeps: { include: ['mermaid'] }
+		},
+		prerender: {
+			default: true
 		}
 	}
 };

tsconfig.json

@@ -7,5 +7,8 @@
 		"cypress/**/*.js",
 		"static/**/*.js"
 	],
+	"compilerOptions": {
+		"allowSyntheticDefaultImports": true
+	},
 	"extends": "./.svelte-kit/tsconfig.json"
 }