fix #861 : Verify file download

Bumps [cypress](https://github.com/cypress-io/cypress) from 10.1.0 to 10.2.0.
- [Release notes](https://github.com/cypress-io/cypress/releases)
- [Changelog](https://github.com/cypress-io/cypress/blob/develop/.releaserc.base.js)
- [Commits](https://github.com/cypress-io/cypress/compare/v10.1.0...v10.2.0)

---
updated-dependencies:
- dependency-name: cypress
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

.eslintrc.cjs

@@ -11,6 +11,7 @@ module.exports = {
 	ignorePatterns: [
 		'docs/*',
 		'*.cjs',
+		'*.js',
 		'*.md',
 		'snapshots.js',
 		'svelte.config.js',
@@ -27,7 +28,8 @@ module.exports = {
 		ecmaVersion: 2019,
 		tsconfigRootDir: __dirname,
 		project: ['./tsconfig.json'],
-		extraFileExtensions: ['.svelte']
+		extraFileExtensions: ['.svelte'],
+		allowAutomaticSingleRunInference: true
 	},
 	env: {
 		browser: true,

.github/workflows/codeql-analysis.yml

@@ -35,11 +35,11 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       # 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,14 +9,12 @@ 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
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
-      - uses: actions/cache@v2
+      - uses: actions/cache@v3
         id: yarn-and-build-cache
         with:
           path: |
@@ -27,17 +25,22 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-node_modules-build-
 
-      - name: Lint
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          cache: 'yarn'
+
+      - name: Build & Lint
         run: |
           yarn install
-          yarn run lint
+          yarn build
+          yarn lint
 
       # 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:
-          build: yarn build
           start: yarn preview
           wait-on: 'http://localhost:3000'
           record: true

.github/workflows/deploy.yml

@@ -11,37 +11,22 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/setup-node@v2
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - uses: actions/setup-node@v3
         with:
           node-version: '16'
-
-      - name: Checkout
-        uses: actions/checkout@v2
-
-      - name: Get yarn cache directory path
-        id: yarn-cache-dir-path
-        run: echo "::set-output name=dir::$(yarn cache dir)"
-
-      - uses: actions/cache@v2
-        id: yarn-cache
-        with:
-          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
-          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-yarn-
+          cache: yarn
 
       - name: Build & Deploy
         run: |
-          npm i -g yarn
           export DEPLOY=true
-          [ "$GITHUB_EVENT_NAME" == "pull_request" ] && export BETA=true && rm -rf docs/beta/
           [ "$GITHUB_EVENT_NAME" != "pull_request" ] && rm -rf docs/_app/
           yarn install
-          yarn run lint
           version=$(yarn version --patch --no-git-tag-version | grep "New version" | cut -d':' -f 2)
           yarn build
-          cd bin
-          ./fix-path
+          yarn run lint
           cd ..
 
       - name: Deploy

.github/workflows/docker-publish.yml

@@ -24,7 +24,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Run tests
         run: |
@@ -38,7 +38,7 @@ jobs:
     if: github.event_name == 'push'
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Build image
         run: docker build . --file Dockerfile --tag $IMAGE_NAME

.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,15 +1,18 @@
 name: Update Browserslist
 on:
   workflow_dispatch:
+  push:
+    branches:
+      - develop
 
 jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - run: npx browserslist@latest --update-db
       - name: Commit changes
-        uses: EndBug/add-and-commit@v8
+        uses: EndBug/add-and-commit@v9
         with:
           author_name: ${{ github.actor }}
           author_email: ${{ github.actor }}@users.noreply.github.com

.github/workflows/update-monaco-editor.yml

@@ -1,8 +1,7 @@
 name: Update Monaco-editor
 on:
   workflow_dispatch:
-  pull_request:
-    types: [opened]
+  push:
     branches:
       - 'dependabot/npm_and_yarn/develop/monaco-editor-**'
 
@@ -10,10 +9,10 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - run: ./bin/update-monaco
       - name: Commit changes
-        uses: EndBug/add-and-commit@v8
+        uses: EndBug/add-and-commit@v9
         with:
           author_name: ${{ github.actor }}
           author_email: ${{ github.actor }}@users.noreply.github.com

.gitignore

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

Dockerfile

@@ -6,11 +6,12 @@
 # Stop               : press ctrl + c 
 #                                     or 
 #                                        docker stop mermaid-live-editor
-FROM node:17.4.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
 RUN yarn build
 
 FROM nginx:alpine as mermaid-live-editor-runner
+COPY ./nginx.conf /etc/nginx/conf.d/default.conf
 COPY --from=mermaid-live-editor-builder --chown=nginx:nginx /home/docs /usr/share/nginx/html

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

@@ -30,4 +30,14 @@ describe('Auto sync tests', () => {
 		cy.get('#view').should('not.have.class', 'outOfSync');
 		cy.getLocalStorage('codeStore').snapshot();
 	});
+
+	it('supports commenting code out/in', () => {
+		const cmd = Cypress.platform === 'darwin' ? 'meta' : 'ctrl';
+
+		cy.get('#editor').type(`{uparrow}{${cmd}}/`);
+		cy.get('#view').contains('Car').should('not.exist');
+
+		cy.get('#editor').type(`{uparrow}{${cmd}}/`);
+		cy.get('#view').contains('Car').should('exist');
+	});
 });

cypress/e2e/docMap.spec.ts

@@ -0,0 +1,36 @@
+describe('Editor docs tests', () => {
+	beforeEach(() => {
+		cy.on('uncaught:exception', () => {
+			return false;
+		});
+		cy.clearLocalStorage();
+		cy.visit('/edit');
+		cy.contains('Sample Diagrams').click();
+	});
+
+	it('Test default loading', () => {
+		cy.get(`[data-cy=docs][href^="https://mermaid-js.github.io/mermaid"]`).should('exist');
+	});
+
+	it('Test to see if the correct URL loads when changing from one diagram to other', () => {
+		cy.contains('Flow Chart').click();
+		cy.get(`[data-cy=docs][href$="/#/flowchart"]`).should('exist');
+
+		cy.contains('Config').click();
+		cy.get(`[data-cy=docs][href$="/#/flowchart?id=configuration"]`).should('exist');
+
+		cy.contains('Sequence Diagram').click();
+		cy.get(`[data-cy=docs][href$="/#/sequenceDiagram?id=configuration"]`).should('exist');
+
+		cy.contains('Code').click();
+		cy.get(`[data-cy=docs][href$="/#/sequenceDiagram"]`).should('exist');
+	});
+
+	it("Test to check URLs for a case where config URL doesn't exist", () => {
+		cy.contains('State Diagram').click();
+		cy.get(`[data-cy=docs][href$="/#/stateDiagram"]`).should('exist');
+
+		cy.contains('Config').click();
+		cy.get(`[data-cy=docs][href$="/#/stateDiagram"]`).should('exist');
+	});
+});

cypress/e2e/history.spec.ts

@@ -46,7 +46,9 @@ describe('Save History', () => {
 		cy.get('#historyList').contains('No items in History');
 	});
 
-	it('should auto save history', () => {
+	// TODO: Fix #639
+	// eslint-disable-next-line mocha/no-skipped-tests
+	xit('should auto save history', () => {
 		cy.get('#editor').type('  C --> HistoryTest');
 		cy.tick(70000);
 		cy.contains('Timeline').click();

cypress/e2e/loadSite.spec.ts

@@ -17,7 +17,7 @@ describe('Site Loads', () => {
 		);
 		cy.url().should(
 			'include',
-			'/edit#eyJjb2RlIjoiZ3JhcGggVERcbiAgICBBW0NocmlzdG1hc10gLS0-fEdldCBtb25leXwgQihHbyBzaG9wcGluZylcbiAgICBCIC0tPiBDe0xldCBtZSB0aGlua31cbiAgICBDIC0tPnxPbmV8IERbTGFwdG9wXVxuICAgIEMgLS0-fFR3b3wgRVtpUGhvbmVdXG4gICAgQyAtLT58VGhyZWV8IEZbZmE6ZmEtY2FyIENhcl0iLCJtZXJtYWlkIjp7InRoZW1lIjoiZGVmYXVsdCJ9LCJ1cGRhdGVFZGl0b3IiOmZhbHNlfQ'
+			'/edit#pako:eNpVkM1qw0AMhF9F6NRC_AI-FBo7zSXQQHLz-iC8cnZJ9oe1TAm2373rmkKrk9B8MwyasAuascRbomjgWisPed6byiQ7iKOhhaJ4m48s4ILn5wz7l2OAwYQYrb-9bvx-haCaTivGIMb6-7JJ1Y__0_MMdXOiKCG2f5XrV5jh0NizyfH_FZM4uz6ansqeio4SVJRa3KHj5MjqXHtaDQrFsGOFZV419zQ-RKHyS0bHqEn4oK2EhDnmMfAOaZRwefoOS0kj_0K1pfwFtx2XbzAdW4g'
 		);
 		cy.contains('History').click();
 		cy.getLocalStorage('codeStore').snapshot();

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.2.0",
+  "__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"]
 }

nginx.conf

@@ -0,0 +1,9 @@
+server { 
+ listen 80;
+ server_name mermaid;
+ location / {
+   root /usr/share/nginx/html;
+	 # Fallback to index.html for other paths
+   try_files $uri /index.html;
+ }
+}

package.json

@@ -5,60 +5,61 @@
 		"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.26",
-		"@sveltejs/kit": "1.0.0-next.236",
-		"@types/mermaid": "^8.2.7",
+		"@sveltejs/adapter-static": "1.0.0-next.34",
+		"@sveltejs/kit": "1.0.0-next.354",
+		"@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.2",
-		"chai": "^4.3.4",
-		"cssnano": "^5.0.15",
-		"cypress": "9.3.1",
-		"cypress-localstorage-commands": "^1.6.1",
+		"autoprefixer": "^10.4.7",
+		"chai": "^4.3.6",
+		"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.1.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.0",
-		"eslint-plugin-tailwindcss": "^3.3.0",
-		"husky": "^7.0.4",
-		"lint-staged": "^12.2.2",
-		"mocha": "^9.1.4",
-		"node-html-parser": "^5.2.0",
-		"postcss": "^8.4.5",
-		"postcss-load-config": "^3.1.1",
-		"prettier": "~2.5.1",
-		"prettier-plugin-svelte": "^2.6.0",
-		"svelte": "^3.46.2",
-		"svelte-preprocess": "^4.10.2",
-		"tailwindcss": "^3.0.13",
-		"tslib": "^2.3.1",
-		"typescript": "^4.5.5"
+		"eslint-plugin-svelte3": "^3.4.1",
+		"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.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.2.0",
-		"analytics": "^0.7.21",
-		"daisyui": "1.24.3",
+		"@macfja/svelte-persistent-store": "^1.3.0",
+		"analytics": "^0.8.1",
+		"daisyui": "2.17.0",
 		"js-base64": "^3.7.2",
-		"mermaid": "8.13.10",
-		"moment": "^2.29.1",
-		"monaco-editor": "^0.31.1",
-		"monaco-mermaid": "^1.0.2",
+		"mermaid": "9.1.2",
+		"moment": "^2.29.3",
+		"monaco-editor": "^0.33.0",
+		"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,37 @@
 		<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="favicon.png" />
-		<link rel="manifest" href="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.31.1/min/vs/editor/editor.main.min.css"
+			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.31.1/min/vs' }
+				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.31.1/min/vs/loader.min.js"
+			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.31.1/min/vs/editor/editor.main.nls.min.js"
+			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.31.1/min/vs/editor/editor.main.js"
+			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

@@ -10,11 +10,14 @@
 
 	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 = () => {
@@ -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/card/tabs.svelte

@@ -26,7 +26,7 @@
 		<ul class="tabs" transition:fade>
 			{#each tabs as tab}
 				<div
-					class="tab tab-lifted text-primary-content {activeTabID === tab.id ? 'tab-active' : ''}"
+					class="tab tab-lifted {activeTabID === tab.id ? 'tab-active' : 'text-primary-content'}"
 					on:click|stopPropagation={() => toggleTabs(tab)}>
 					<i class="mr-1 {tab.icon}" />
 					{tab.title}

src/lib/components/preset.svelte

@@ -79,7 +79,19 @@
     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 => {

src/lib/types.d.ts

@@ -57,4 +57,11 @@ export interface HistoryEntry {
 	url?: string;
 }
 
+export interface DocConfig {
+	[key: string]: {
+		code: string;
+		config?: string;
+	};
+}
+
 type Loader = (url: string) => Promise<State>;

src/routes/edit.svelte

@@ -12,17 +12,62 @@
 	import { onMount } from 'svelte';
 	import mermaid from 'mermaid';
 	import type monaco from 'monaco-editor';
-	import type { EditorUpdateEvent, State, Tab } from '$lib/types';
+	import type { EditorUpdateEvent, State, Tab, DocConfig } from '$lib/types';
 	import { base } from '$app/paths';
 
 	serializedState; // Weird fix for error > serializedState is not defined. Treeshaking?
-	let selectedMode = 'code';
-	const languageMap = {
+
+	type Modes = 'code' | 'config';
+	type Languages = 'mermaid' | 'json';
+
+	let selectedMode: Modes = 'code';
+	const languageMap: { [key in Modes]: Languages } = {
 		code: 'mermaid',
 		config: 'json'
 	};
+	const docURLBase = 'https://mermaid-js.github.io/mermaid';
+	const docMap: DocConfig = {
+		graph: {
+			code: '/#/flowchart',
+			config: '/#/flowchart?id=configuration'
+		},
+		flowchart: {
+			code: '/#/flowchart',
+			config: '/#/flowchart?id=configuration'
+		},
+		sequenceDiagram: {
+			code: '/#/sequenceDiagram',
+			config: '/#/sequenceDiagram?id=configuration'
+		},
+		classDiagram: {
+			code: '/#/classDiagram',
+			config: '/#/classDiagram?id=configuration'
+		},
+		'stateDiagram-v2': {
+			code: '/#/stateDiagram'
+		},
+		gantt: {
+			code: '/#/gantt',
+			config: '/#/gantt?id=configuration'
+		},
+		pie: {
+			code: '/#/pie'
+		},
+		erDiagram: {
+			code: '/#/entityRelationshipDiagram',
+			config: '/#/entityRelationshipDiagram?id=styling'
+		},
+		journey: {
+			code: '/#/user-journey'
+		},
+		gitGraph: {
+			code: '/#/gitgraph',
+			config: '/#/gitgraph?id=gitgraph-specific-configuration-options'
+		}
+	};
 	let text = '';
-	let language: 'mermaid' | 'json' = 'mermaid';
+	let docURL = docURLBase;
+	let language: Languages = 'mermaid';
 	let errorMarkers: monaco.editor.IMarkerData[] = [];
 	$: language = languageMap[selectedMode];
 	$: {
@@ -37,10 +82,16 @@
 		if (state.updateEditor) {
 			text = selectedMode === 'code' ? state.code : state.mermaid;
 		}
+		const codeTypeMatch = /([\S]+)[\s\n]/.exec(state.code);
+		if (codeTypeMatch && codeTypeMatch.length > 1) {
+			const docKey = codeTypeMatch[1];
+			const docConfig = docMap[docKey] ?? { code: '' };
+			docURL = docURLBase + (docConfig[selectedMode] ?? docConfig.code ?? '');
+		}
 	});
 	const tabSelectHandler = (message: CustomEvent<Tab>) => {
+		selectedMode = message.detail.id === 'code' ? 'code' : 'config';
 		$codeStore.updateEditor = true;
-		selectedMode = message.detail.id;
 	};
 	const tabs: Tab[] = [
 		{
@@ -128,24 +179,28 @@
 			<Card on:select={tabSelectHandler} {tabs} isCloseable={false} title="Mermaid">
 				<div slot="actions">
 					<div class="flex flex-row items-center">
+						<div class="form-control flex-row items-center">
+							<label class="cursor-pointer label" for="autoSync">
+								<span> Auto sync</span>
+								<input
+									type="checkbox"
+									class="toggle {$codeStore.autoSync ? 'btn-secondary' : 'toggle-primary'} ml-1"
+									id="autoSync"
+									bind:checked={$codeStore.autoSync} />
+							</label>
+						</div>
+
 						{#if !$codeStore.autoSync}
 							<button
-								class="btn btn-secondary btn-xs"
+								class="btn btn-secondary btn-xs mr-1"
 								title="Sync Diagram"
 								data-cy="sync"
 								on:click={syncDiagram}><i class="fas fa-sync" /></button>
 						{/if}
 
-						<div class="form-control">
-							<label class="cursor-pointer label" for="autoSync">
-								<input
-									type="checkbox"
-									class="toggle toggle-primary mr-1"
-									id="autoSync"
-									bind:checked={$codeStore.autoSync} />
-								<span> Auto sync</span>
-							</label>
-						</div>
+						<button class="btn btn-secondary btn-xs" title="View documentation">
+							<a target="_blank" href={docURL} data-cy="docs"><i class="fas fa-book mr-1" />Docs</a>
+						</button>
 					</div>
 				</div>
 
@@ -163,9 +218,9 @@
 			<Card title="Diagram" isCloseable={false}>
 				<button
 					slot="actions"
-					class="btn btn-primary btn-xs shadow-lg"
+					class="btn btn-secondary btn-xs"
 					title="View diagram in new page"
-					on:click|stopPropagation={() => viewDiagram()}><i class="far fa-eye mr-2" /> View</button>
+					on:click|stopPropagation={() => viewDiagram()}><i class="far fa-eye mr-1" />View</button>
 
 				<div class="flex-1 overflow-auto">
 					<View />

svelte.config.js

@@ -12,19 +12,20 @@ const config = {
 	],
 	kit: {
 		adapter: adapter({
-			pages: `docs${process.env['BETA'] ? '/beta' : ''}`
+			pages: `docs`
 		}),
 		paths: process.env['DEPLOY']
 			? {
-					base: `/mermaid-live-editor${process.env['BETA'] ? '/beta' : ''}`
+					base: `/mermaid-live-editor`
 			  }
 			: {},
-		// hydrate the <div id="svelte"> element in src/app.html
-		target: '#svelte',
 		trailingSlash: 'ignore',
 		vite: {
 			envPrefix: 'MERMAID_',
 			optimizeDeps: { include: ['mermaid'] }
+		},
+		prerender: {
+			default: true
 		}
 	}
 };

tsconfig.json

@@ -1,39 +1,14 @@
 {
-	"compilerOptions": {
-		"moduleResolution": "node",
-		"module": "es2020",
-		"lib": ["es2020", "ESNext", "DOM.Iterable", "DOM"],
-		"target": "es2019",
-		/**
-			svelte-preprocess cannot figure out whether you have a value or a type, so tell TypeScript
-			to enforce using \`import type\` instead of \`import\` for Types.
-			*/
-		"importsNotUsedAsValues": "error",
-		"isolatedModules": true,
-		"resolveJsonModule": true,
-		/**
-			To have warnings/errors of the Svelte compiler at the correct position,
-			enable source maps by default.
-			*/
-		"sourceMap": true,
-		"esModuleInterop": true,
-		"skipLibCheck": true,
-		"forceConsistentCasingInFileNames": true,
-		"baseUrl": ".",
-		"allowJs": true,
-		"checkJs": true,
-		"paths": {
-			"$lib/*": ["src/lib/*"]
-		}
-	},
 	"include": [
 		"src/**/*.d.ts",
-		"src/**/*.js",
 		"src/**/*.ts",
 		"src/**/*.svelte",
 		"cypress/**/*.ts",
 		"cypress/**/*.js",
-		"static/**/*.js",
-		"src/pako.mts"
-	]
+		"static/**/*.js"
+	],
+	"compilerOptions": {
+		"allowSyntheticDefaultImports": true
+	},
+	"extends": "./.svelte-kit/tsconfig.json"
 }