Compare commits

..
Author SHA1 Message Date
Sidharth Vinod e953c320fb fix store 2022-08-29 20:49:00 +05:30
Sidharth Vinod a4fe43572b Merge branch 'sidv/historyDownlod' into sidv/updatePersistantStore
* sidv/historyDownlod:
  Metrics
  Tests
  Increase retries
  Temp fix for vite bug
  Update sk
  Update Browserslist
  chore(deps): bump node from 18.7.0 to 18.8.0
  chore(deps-dev): bump @typescript-eslint/eslint-plugin
  chore(deps-dev): bump typescript from 4.7.4 to 4.8.2
  feat: Upload history
  Fix #968 : Ability to download and upload history
  chore(deps): bump daisyui from 2.22.0 to 2.24.0
2022-08-28 23:13:31 +05:30
Sidharth Vinod 732e44b6b9 Update lib 2022-08-24 20:25:13 +05:30
58 changed files with 961 additions and 1646 deletions
+1 -2
View File
@@ -44,7 +44,6 @@ module.exports = {
], ],
'@typescript-eslint/no-unsafe-member-access': 'off', '@typescript-eslint/no-unsafe-member-access': 'off',
'@typescript-eslint/no-unsafe-assignment': 'off', '@typescript-eslint/no-unsafe-assignment': 'off',
'es/no-regexp-lookbehind-assertions': 'error', 'es/no-regexp-lookbehind-assertions': 'error'
curly: ['error', 'all']
} }
}; };
+4 -3
View File
@@ -1,9 +1,10 @@
name: Update Browserslist name: Update Browserslist
on: on:
workflow_dispatch:
push: push:
branches-ignore: branches:
- 'develop' - develop
- 'master'
jobs: jobs:
build: build:
runs-on: ubuntu-latest runs-on: ubuntu-latest
+1 -1
View File
@@ -10,7 +10,7 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v3
- uses: actions/setup-node@v3 - uses: actions/setup-node@v2
with: with:
node-version: 18 node-version: 18
- name: Update monaco version - name: Update monaco version
+1 -6
View File
@@ -1,9 +1,4 @@
{ {
"editor.formatOnSave": true, "editor.formatOnSave": true,
"cSpell.words": ["pako", "Serde", "serdes"], "cSpell.words": ["pako", "Serde", "serdes"]
"vitest.commandLine": "yarn test:unit",
"vitest.enable": true,
"testing.autoRun.mode": "rerun",
"svelte.enable-ts-plugin": true,
"githubPullRequests.ignoredPullRequestBranches": ["develop"]
} }
+1 -1
View File
@@ -6,7 +6,7 @@
# Stop : press ctrl + c # Stop : press ctrl + c
# or # or
# docker stop mermaid-live-editor # docker stop mermaid-live-editor
FROM node:18.11.0 as mermaid-live-editor-builder FROM node:18.8.0 as mermaid-live-editor-builder
COPY --chown=node:node . /home COPY --chown=node:node . /home
WORKDIR /home WORKDIR /home
RUN yarn install RUN yarn install
+3 -2
View File
@@ -1,8 +1,9 @@
import { verifyFileSize } from './util'; import { disableDebounce, verifyFileSize } from './util';
describe('Check actions', () => { describe('Check actions', () => {
beforeEach(() => { beforeEach(() => {
cy.clearLocalStorage(); cy.clearLocalStorage();
cy.visit('/edit'); cy.visit('/edit');
disableDebounce();
}); });
it('should update markdown code', () => { it('should update markdown code', () => {
@@ -35,7 +36,7 @@ describe('Check actions', () => {
// Verify downloaded file is different for different diagrams // Verify downloaded file is different for different diagrams
cy.contains('Sample Diagrams').click(); cy.contains('Sample Diagrams').click();
cy.contains('ER').click(); cy.contains('ER Diagram').click();
cy.get(`#downloadPNG`).click(); cy.get(`#downloadPNG`).click();
verifyFileSize('diagram', 'png', 46_000); verifyFileSize('diagram', 'png', 46_000);
+3 -5
View File
@@ -1,18 +1,17 @@
import { getEditor, cmd } from './util'; import { getEditor, cmd, disableDebounce } from './util';
describe('Auto sync tests', () => { describe('Auto sync tests', () => {
beforeEach(() => { beforeEach(() => {
cy.clearLocalStorage(); cy.clearLocalStorage();
cy.visit('/'); cy.visit('/');
disableDebounce();
}); });
it('should dim diagram when code is edited', () => { it('should dim diagram when code is edited', () => {
cy.contains('Auto sync').click(); cy.contains('Auto sync').click();
cy.get('#view').should('not.have.class', 'outOfSync'); cy.get('#view').should('not.have.class', 'outOfSync');
cy.get('#view').should('not.contain.text', 'Diagram out of sync.');
getEditor().type(' C --> Test'); getEditor().type(' C --> Test');
cy.get('#view').should('have.class', 'outOfSync'); cy.get('#view').should('have.class', 'outOfSync');
cy.get('#view').should('contain.text', 'Diagram out of sync.');
cy.getLocalStorage('codeStore').snapshot(); cy.getLocalStorage('codeStore').snapshot();
}); });
@@ -21,9 +20,7 @@ describe('Auto sync tests', () => {
cy.get('#view').should('not.have.class', 'outOfSync'); cy.get('#view').should('not.have.class', 'outOfSync');
getEditor().type(' C --> Test'); getEditor().type(' C --> Test');
cy.get('#view').should('have.class', 'outOfSync'); cy.get('#view').should('have.class', 'outOfSync');
cy.get('#view').should('contain.text', 'Diagram out of sync.');
getEditor().type(`${cmd}{enter}`); getEditor().type(`${cmd}{enter}`);
cy.get('#view').should('not.contain.text', 'Diagram out of sync.');
cy.get('#view').should('not.have.class', 'outOfSync'); cy.get('#view').should('not.have.class', 'outOfSync');
}); });
@@ -75,6 +72,7 @@ describe.only('Pan and Zoom', () => {
beforeEach(() => { beforeEach(() => {
cy.clearLocalStorage(); cy.clearLocalStorage();
cy.visit('/'); cy.visit('/');
disableDebounce();
}); });
it('should toggle pan and zoom', () => { it('should toggle pan and zoom', () => {
cy.get('#svg-pan-zoom-reset-pan-zoom').should('not.exist'); cy.get('#svg-pan-zoom-reset-pan-zoom').should('not.exist');
+3 -3
View File
@@ -13,13 +13,13 @@ describe('Editor docs tests', () => {
}); });
it('Test to see if the correct URL loads when changing from one diagram to other', () => { it('Test to see if the correct URL loads when changing from one diagram to other', () => {
cy.contains('Flow').click(); cy.contains('Flow Chart').click();
cy.get(`[data-cy=docs][href$="/#/flowchart"]`).should('exist'); cy.get(`[data-cy=docs][href$="/#/flowchart"]`).should('exist');
cy.contains('Config').click(); cy.contains('Config').click();
cy.get(`[data-cy=docs][href$="/#/flowchart?id=configuration"]`).should('exist'); cy.get(`[data-cy=docs][href$="/#/flowchart?id=configuration"]`).should('exist');
cy.contains('Sequence').click(); cy.contains('Sequence Diagram').click();
cy.get(`[data-cy=docs][href$="/#/sequenceDiagram?id=configuration"]`).should('exist'); cy.get(`[data-cy=docs][href$="/#/sequenceDiagram?id=configuration"]`).should('exist');
cy.contains('Code').click(); cy.contains('Code').click();
@@ -27,7 +27,7 @@ describe('Editor docs tests', () => {
}); });
it("Test to check URLs for a case where config URL doesn't exist", () => { it("Test to check URLs for a case where config URL doesn't exist", () => {
cy.contains('State').click(); cy.contains('State Diagram').click();
cy.get(`[data-cy=docs][href$="/#/stateDiagram"]`).should('exist'); cy.get(`[data-cy=docs][href$="/#/stateDiagram"]`).should('exist');
cy.contains('Config').click(); cy.contains('Config').click();
+4 -4
View File
@@ -1,11 +1,11 @@
import { getEditor, verifyFileSnapshot } from './util'; import { getEditor, disableDebounce, verifyFileSnapshot } from './util';
describe('Save History', () => { describe('Save History', () => {
beforeEach(() => { beforeEach(() => {
cy.clock(new Date(2022, 0, 1).getTime()); cy.clock(new Date(2022, 0, 1).getTime());
cy.clearLocalStorage(); cy.clearLocalStorage();
cy.visit('/edit'); cy.visit('/edit');
disableDebounce();
cy.contains('Actions').click(); cy.contains('Actions').click();
cy.contains('History').click(); cy.contains('History').click();
}); });
@@ -17,11 +17,11 @@ describe('Save History', () => {
it('should load history from localstorage', () => { it('should load history from localstorage', () => {
cy.setLocalStorage( cy.setLocalStorage(
'manualHistoryStore', 'manualHistoryStore',
'[{"state":{"code":"graph TD\\n A[Halloween] -->|Get money| B(Go shopping)","mermaid":"{\\n \\"theme\\": \\"dark\\"\\n}","autoSync":true,"updateDiagram":false},"time":0,"type":"manual","id":"d7ea820e-21dd-418a-b984-fd58acde09df","name":"hollow-art"},{"state":{"code":"graph TD\\n A[Christmas] -->|Get money| B(Go shopping)","mermaid":"{\\n \\"theme\\": \\"dark\\"\\n}","autoSync":true,"updateDiagram":true},"time":0,"type":"manual","id":"b749ffc6-522b-4a44-86cf-7c1ffc3146b3","name":"helpful-ocean"}]' '[{"state":{"code":"graph TD\\n A[Halloween] -->|Get money| B(Go shopping)","mermaid":"{\\n \\"theme\\": \\"dark\\"\\n}","updateEditor":false,"autoSync":true,"updateDiagram":false},"time":0,"type":"manual","id":"d7ea820e-21dd-418a-b984-fd58acde09df","name":"hollow-art"},{"state":{"code":"graph TD\\n A[Christmas] -->|Get money| B(Go shopping)","mermaid":"{\\n \\"theme\\": \\"dark\\"\\n}","updateEditor":true,"autoSync":true,"updateDiagram":true},"time":0,"type":"manual","id":"b749ffc6-522b-4a44-86cf-7c1ffc3146b3","name":"helpful-ocean"}]'
); );
cy.setLocalStorage( cy.setLocalStorage(
'autoHistoryStore', 'autoHistoryStore',
'[{"state":{"code":"graph TD\\n A[New Year] -->|Get money| B(Go shopping)","mermaid":"{\\n \\"theme\\": \\"dark\\"\\n}","autoSync":true,"updateDiagram":false},"time":0,"type":"auto","id":"69ea820e-522b-4a44-86cf-fd58acde09df","name":"barking-dog"},{"state":{"code":"graph TD\\n A[Christmas] -->|Get money| B(Go shopping)","mermaid":"{\\n \\"theme\\": \\"dark\\"\\n}","autoSync":true,"updateDiagram":true},"time":0,"type":"manual","id":"x749ffc6-21dd-418a-b984-7c1ffc3146b3","name":"needy-mosquito"}]' '[{"state":{"code":"graph TD\\n A[New Year] -->|Get money| B(Go shopping)","mermaid":"{\\n \\"theme\\": \\"dark\\"\\n}","updateEditor":false,"autoSync":true,"updateDiagram":false},"time":0,"type":"auto","id":"69ea820e-522b-4a44-86cf-fd58acde09df","name":"barking-dog"},{"state":{"code":"graph TD\\n A[Christmas] -->|Get money| B(Go shopping)","mermaid":"{\\n \\"theme\\": \\"dark\\"\\n}","updateEditor":true,"autoSync":true,"updateDiagram":true},"time":0,"type":"manual","id":"x749ffc6-21dd-418a-b984-7c1ffc3146b3","name":"needy-mosquito"}]'
); );
cy.reload(); cy.reload();
cy.contains('Actions').click(); cy.contains('Actions').click();
+6 -4
View File
@@ -1,9 +1,11 @@
import { toBase64 } from 'js-base64'; import { toBase64 } from 'js-base64';
import { disableDebounce } from './util';
describe('Site Loads', () => { describe('Site Loads', () => {
beforeEach(() => { beforeEach(() => {
cy.clearLocalStorage(); cy.clearLocalStorage();
cy.visit('/'); cy.visit('/');
disableDebounce();
}); });
it('Check Home page load', () => { it('Check Home page load', () => {
cy.url().should('include', '/edit'); cy.url().should('include', '/edit');
@@ -20,9 +22,9 @@ describe('Site Loads', () => {
it('should load sample diagrams when clicked', () => { it('should load sample diagrams when clicked', () => {
cy.contains('Sample Diagrams').click(); cy.contains('Sample Diagrams').click();
cy.contains('Pie').click(); cy.contains('Pie Chart').click();
cy.contains('pie title Pets adopted by volunteers'); cy.contains('pie title Pets adopted by volunteers');
cy.contains('Class').click(); cy.contains('Class Diagram').click();
cy.contains('classDiagram'); cy.contains('classDiagram');
}); });
@@ -58,7 +60,7 @@ describe('Site Loads', () => {
// Disabled temporarily. Should be enabled after the issue is fixed in Mermaid. // Disabled temporarily. Should be enabled after the issue is fixed in Mermaid.
// it('should prevent setting the "securityLevel" option via URL', () => { // it('should prevent setting the "securityLevel" option via URL', () => {
// const b64State = toBase64( // const b64State = toBase64(
// `{"code":"graph TD\\nA[\\"<img src='https://via.placeholder.com/64' width=64 />\\"]","mermaid":"{\\"securityLevel\\": \\"loose\\", \\"theme\\": \\"forest\\"}","autoSync":true,"updateDiagram":true}`, // `{"code":"graph TD\\nA[\\"<img src='https://via.placeholder.com/64' width=64 />\\"]","mermaid":"{\\"securityLevel\\": \\"loose\\", \\"theme\\": \\"forest\\"}","updateEditor":true,"autoSync":true,"updateDiagram":true}`,
// true // true
// ); // );
// cy.on('window:confirm', () => true); // cy.on('window:confirm', () => true);
@@ -73,7 +75,7 @@ describe('Site Loads', () => {
it('should allow persisting "securityLevel" using confirm dialogue', () => { it('should allow persisting "securityLevel" using confirm dialogue', () => {
const b64State = toBase64( const b64State = toBase64(
`{"code":"graph TD\\nA[\\"<img src='https://dummyimage.com/64' width=64/>\\"]","mermaid":"{\\"securityLevel\\": \\"loose\\", \\"theme\\": \\"forest\\"}","autoSync":true,"updateDiagram":true}`, `{"code":"graph TD\\nA[\\"<img src='https://dummyimage.com/64' width=64/>\\"]","mermaid":"{\\"securityLevel\\": \\"loose\\", \\"theme\\": \\"forest\\"}","updateEditor":true,"autoSync":true,"updateDiagram":true}`,
true true
); );
cy.on('window:confirm', () => false); cy.on('window:confirm', () => false);
+2
View File
@@ -8,6 +8,8 @@ export const getEditor = ({ bottom = true, newline = false } = {}) =>
.type(`${bottom ? '{pageDown}' : cmd}`) .type(`${bottom ? '{pageDown}' : cmd}`)
.type(`${newline ? '{enter}' : cmd}`); .type(`${newline ? '{enter}' : cmd}`);
export const disableDebounce = () => cy.setLocalStorage('noDebounce', 'true');
const downloadsFolder = Cypress.config('downloadsFolder'); const downloadsFolder = Cypress.config('downloadsFolder');
export const verifyFileSize = ( export const verifyFileSize = (
+8 -8
View File
@@ -1,28 +1,28 @@
module.exports = { module.exports = {
"Site Loads": { "Site Loads": {
"Check Home page load": { "Check Home page load": {
"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 \",\"mermaid\":\"{\\n \\\"theme\\\": \\\"default\\\"\\n}\",\"autoSync\":true,\"updateDiagram\":true}" "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 \",\"mermaid\":\"{\\n \\\"theme\\\": \\\"default\\\"\\n}\",\"updateEditor\":true,\"autoSync\":true,\"updateDiagram\":true}"
}, },
"Check Redirect from old URL": { "Check Redirect from old URL": {
"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]\",\"mermaid\":\"{\\n \\\"theme\\\": \\\"default\\\"\\n}\",\"autoSync\":true,\"updateDiagram\":true}" "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]\",\"mermaid\":\"{\\n \\\"theme\\\": \\\"default\\\"\\n}\",\"updateEditor\":false,\"autoSync\":true,\"updateDiagram\":true}"
}, },
"should load diagram from gist": { "should load diagram from gist": {
"1": "{\"code\":\"graph TD\\n A[Party] -->|Get money| B(Go shopping!!)\\n \",\"mermaid\":\"{\\n \\\"theme\\\": \\\"forest\\\",\\n \\\"test\\\": \\\"hello world\\\"\\n}\",\"autoSync\":true,\"updateDiagram\":true,\"loader\":{\"type\":\"gist\",\"config\":{\"url\":\"https://gist.github.com/sidharthv96/6268a23e673a533dcb198f241fd7012a\"}}}" "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\":\"gist\",\"config\":{\"url\":\"https://gist.github.com/sidharthv96/6268a23e673a533dcb198f241fd7012a\"}}}"
}, },
"should load diagram from gist revision": { "should load diagram from gist revision": {
"1": "{\"code\":\"graph TD\\n A[Party] -->|Get money| B(Go shopping)\\n \",\"mermaid\":\"{\\n \\\"theme\\\": \\\"forest\\\",\\n \\\"test\\\": \\\"hello\\\"\\n}\",\"autoSync\":true,\"updateDiagram\":true,\"loader\":{\"type\":\"gist\",\"config\":{\"url\":\"https://gist.github.com/sidharthv96/6268a23e673a533dcb198f241fd7012a/ec9b4ab0e41e4ff6287326cd3cb47affd7851e19\"}}}" "1": "{\"code\":\"graph TD\\n A[Party] -->|Get money| B(Go shopping)\\n \",\"mermaid\":\"{\\n \\\"theme\\\": \\\"forest\\\",\\n \\\"test\\\": \\\"hello\\\"\\n}\",\"updateEditor\":false,\"autoSync\":true,\"updateDiagram\":true,\"loader\":{\"type\":\"gist\",\"config\":{\"url\":\"https://gist.github.com/sidharthv96/6268a23e673a533dcb198f241fd7012a/ec9b4ab0e41e4ff6287326cd3cb47affd7851e19\"}}}"
}, },
"should load diagram from raw files": { "should load diagram from raw files": {
"1": "{\"code\":\"graph TD\\n A[Party] -->|Get money| B(Go shopping!!)\\n \",\"mermaid\":\"{\\n \\\"theme\\\": \\\"forest\\\",\\n \\\"test\\\": \\\"hello world\\\"\\n}\",\"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\"}}}" "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": "10.10.0", "__version": "10.6.0",
"Auto sync tests": { "Auto sync tests": {
"should dim diagram when code is edited": { "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}\",\"autoSync\":false,\"updateDiagram\":false}" "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}"
}, },
"should not dim diagram when code is in sync": { "should not dim diagram when code is in sync": {
"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 --> Testing\",\"mermaid\":\"{\\n \\\"theme\\\": \\\"default\\\"\\n}\",\"autoSync\":true,\"updateDiagram\":false}" "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 --> Testing\",\"mermaid\":\"{\\n \\\"theme\\\": \\\"default\\\"\\n}\",\"updateEditor\":false,\"autoSync\":true,\"updateDiagram\":false}"
} }
}, },
"Test themes": { "Test themes": {
+34 -35
View File
@@ -5,8 +5,6 @@
"license": "MIT", "license": "MIT",
"scripts": { "scripts": {
"dev": "vite dev", "dev": "vite dev",
"dev:force": "MERMAID_LOCAL=true yarn dev --force",
"dev:test": "yarn dev",
"build": "vite build", "build": "vite build",
"preview": "vite preview", "preview": "vite preview",
"lint": "prettier --check --cache --plugin-search-dir=. .;eslint --ignore-path .gitignore .", "lint": "prettier --check --cache --plugin-search-dir=. .;eslint --ignore-path .gitignore .",
@@ -23,62 +21,63 @@
}, },
"devDependencies": { "devDependencies": {
"@cypress/snapshot": "2.1.7", "@cypress/snapshot": "2.1.7",
"@sveltejs/adapter-static": "1.0.0-next.44", "@sveltejs/adapter-static": "1.0.0-next.39",
"@sveltejs/kit": "1.0.0-next.516", "@sveltejs/kit": "1.0.0-next.442",
"@testing-library/jest-dom": "5.16.5", "@testing-library/jest-dom": "5.16.5",
"@testing-library/svelte": "3.2.2", "@testing-library/svelte": "3.2.1",
"@types/async": "^3.2.15", "@types/mermaid": "8.2.9",
"@types/pako": "2.0.0", "@types/pako": "1.0.3",
"@types/uuid": "8.3.4", "@types/uuid": "^8.3.4",
"@typescript-eslint/eslint-plugin": "5.40.1", "@typescript-eslint/eslint-plugin": "5.35.1",
"@typescript-eslint/parser": "5.40.1", "@typescript-eslint/parser": "5.34.0",
"@vitest/ui": "0.24.3", "@vitest/ui": "0.22.1",
"autoprefixer": "10.4.12", "autoprefixer": "10.4.8",
"c8": "7.12.0", "c8": "7.12.0",
"chai": "4.3.6", "chai": "4.3.6",
"cssnano": "5.1.13", "cssnano": "5.1.13",
"cy-verify-downloads": "0.1.11", "cy-verify-downloads": "0.1.8",
"cypress": "10.10.0", "cypress": "10.6.0",
"cypress-localstorage-commands": "2.2.1", "cypress-localstorage-commands": "2.2.0",
"eslint": "8.25.0", "eslint": "8.22.0",
"eslint-config-prettier": "8.5.0", "eslint-config-prettier": "8.5.0",
"eslint-plugin-cypress": "2.12.1", "eslint-plugin-cypress": "2.12.1",
"eslint-plugin-es": "4.1.0", "eslint-plugin-es": "4.1.0",
"eslint-plugin-postcss-modules": "2.0.0", "eslint-plugin-postcss-modules": "2.0.0",
"eslint-plugin-svelte3": "4.0.0", "eslint-plugin-svelte3": "4.0.0",
"eslint-plugin-tailwindcss": "3.6.2", "eslint-plugin-tailwindcss": "3.6.0",
"eslint-plugin-vitest": "0.0.11", "eslint-plugin-vitest": "0.0.8",
"esserializer": "1.3.2",
"husky": "8.0.1", "husky": "8.0.1",
"jsdom": "20.0.1", "jsdom": "20.0.0",
"lint-staged": "13.0.3", "lint-staged": "13.0.3",
"node-html-parser": "6.1.1", "node-html-parser": "5.4.1",
"postcss": "8.4.18", "postcss": "8.4.16",
"postcss-load-config": "4.0.1", "postcss-load-config": "4.0.1",
"prettier": "2.7.1", "prettier": "2.7.1",
"prettier-plugin-svelte": "2.8.0", "prettier-plugin-svelte": "2.7.0",
"svelte": "3.52.0", "svelte": "3.49.0",
"svelte-preprocess": "4.10.7", "svelte-preprocess": "4.10.7",
"tailwindcss": "3.1.8", "tailwindcss": "3.1.8",
"tslib": "2.4.0", "tslib": "2.4.0",
"typescript": "4.8.4", "typescript": "4.8.2",
"vite": "3.1.8", "vite": "3.0.9",
"vitest": "0.24.3" "vitest": "0.22.1",
"vitest-svelte-kit": "0.0.7"
}, },
"dependencies": { "dependencies": {
"@analytics/google-analytics": "1.0.3",
"@macfja/svelte-persistent-store": "2.0.0",
"analytics": "0.8.1", "analytics": "0.8.1",
"analytics-plugin-plausible": "0.0.6", "analytics-plugin-plausible": "^0.0.6",
"async": "^3.2.4", "daisyui": "2.24.0",
"daisyui": "2.31.0",
"js-base64": "3.7.2", "js-base64": "3.7.2",
"mermaid": "9.2.0-rc6", "mermaid": "9.1.6",
"moment": "2.29.4", "moment": "2.29.4",
"monaco-editor": "0.34.1", "monaco-editor": "0.34.0",
"monaco-mermaid": "1.0.6", "monaco-mermaid": "1.0.6",
"pako": "2.0.4", "pako": "2.0.4",
"random-word-slugs": "0.1.6", "random-word-slugs": "0.1.6",
"svg-pan-zoom": "3.6.1", "svg-pan-zoom": "^3.6.1",
"uuid": "9.0.0" "uuid": "^8.3.2"
}, },
"lint-staged": { "lint-staged": {
"*.{ts,svelte,js,css,md,json}": [ "*.{ts,svelte,js,css,md,json}": [
@@ -88,7 +87,7 @@
}, },
"volta": { "volta": {
"node": "18.5.0", "node": "18.5.0",
"yarn": "1.22.19" "yarn": "1.22.10"
}, },
"engines": { "engines": {
"node": ">=16.7" "node": ">=16.7"
+4
View File
@@ -14,6 +14,10 @@
{ {
"matchUpdateTypes": ["minor", "patch", "pin", "digest"], "matchUpdateTypes": ["minor", "patch", "pin", "digest"],
"automerge": true "automerge": true
},
{
"matchDatasources": ["npm"],
"stabilityDays": 3
} }
], ],
"dependencyDashboard": true, "dependencyDashboard": true,
+11 -13
View File
@@ -11,42 +11,40 @@
<meta <meta
name="description" 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." /> 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="%sveltekit.assets%/favicon.svg" /> <link rel="icon" type="image/png" href="%sveltekit.assets%/favicon.png" />
<link rel="mask-icon" href="%sveltekit.assets%/favicon.svg" color="#000000" />
<meta name="theme-color" content="#6366F1" />
<link rel="manifest" href="%sveltekit.assets%/manifest.json" /> <link rel="manifest" href="%sveltekit.assets%/manifest.json" />
<link <link
rel="stylesheet" rel="stylesheet"
href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.2.0/css/all.min.css" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.2/css/all.min.css"
integrity="sha512-xh6O/CkQoPOWDdYTDqeRdPCVd1SpvCA9XXcUnZS2FmJNp1coAFzvtCN9BmamE+4aHK8yyUHUSCcJHgXloTyT2A==" integrity="sha512-HK5fgLBL+xu6dm/Ii3z4xhlSUyZgTT9tuc/hSrtw6uzJOvgRr2a9jyxxT1ely+B+xFAmJKVSTbpM/CuL7qxO8w=="
crossorigin="anonymous" crossorigin="anonymous"
referrerpolicy="no-referrer" /> referrerpolicy="no-referrer" />
<link <link
rel="stylesheet" rel="stylesheet"
href="https://cdnjs.cloudflare.com/ajax/libs/monaco-editor/0.34.1/min/vs/editor/editor.main.min.css" href="https://cdnjs.cloudflare.com/ajax/libs/monaco-editor/0.34.0/min/vs/editor/editor.main.min.css"
integrity="sha512-GzcoZD7y5zvBofYtImXPZaPVhoY7xLPt+ysmbPb/vU+quSKFkcngxaSrxuwprDZL4MALUqGFmnqCxQZqMozv1Q==" integrity="sha512-iQEIc0rsSDujsfjtD+lfyJ1W23Bh/lbgriubKDAym6VlEIDRj9rrbSIyJRyshOrl8s0yRcQ0+gyrZfSLyjJGWQ=="
crossorigin="anonymous" crossorigin="anonymous"
referrerpolicy="no-referrer" /> referrerpolicy="no-referrer" />
<script> <script>
var require = { var require = {
paths: { paths: {
vs: 'https://cdnjs.cloudflare.com/ajax/libs/monaco-editor/0.34.0/min/vs' vs: "https://cdnjs.cloudflare.com/ajax/libs/monaco-editor/0.34.0/min/vs",
} },
}; };
</script> </script>
<script <script
src="https://cdnjs.cloudflare.com/ajax/libs/monaco-editor/0.34.1/min/vs/loader.min.js" src="https://cdnjs.cloudflare.com/ajax/libs/monaco-editor/0.34.0/min/vs/loader.min.js"
integrity="sha512-6bIYsGqvLpAiEBXPdRQeFf5cueeBECtAKJjIHer3BhBZNTV3WLcLA8Tm3pDfxUwTMIS+kAZwTUvJ1IrMdX8C5w==" integrity="sha512-6bIYsGqvLpAiEBXPdRQeFf5cueeBECtAKJjIHer3BhBZNTV3WLcLA8Tm3pDfxUwTMIS+kAZwTUvJ1IrMdX8C5w=="
crossorigin="anonymous" crossorigin="anonymous"
referrerpolicy="no-referrer"></script> referrerpolicy="no-referrer"></script>
<script <script
src="https://cdnjs.cloudflare.com/ajax/libs/monaco-editor/0.34.1/min/vs/editor/editor.main.nls.min.js" src="https://cdnjs.cloudflare.com/ajax/libs/monaco-editor/0.34.0/min/vs/editor/editor.main.nls.min.js"
integrity="sha512-CCv+DKWw+yZhxf4Z+ExT6HC5G+3S45TeMTYcJyYbdrv4BpK2vyALJ4FoVR/KGWDIPu7w4tNCOC9MJQIkYPR5FA==" integrity="sha512-CCv+DKWw+yZhxf4Z+ExT6HC5G+3S45TeMTYcJyYbdrv4BpK2vyALJ4FoVR/KGWDIPu7w4tNCOC9MJQIkYPR5FA=="
crossorigin="anonymous" crossorigin="anonymous"
referrerpolicy="no-referrer"></script> referrerpolicy="no-referrer"></script>
<script <script
src="https://cdnjs.cloudflare.com/ajax/libs/monaco-editor/0.34.1/min/vs/editor/editor.main.js" src="https://cdnjs.cloudflare.com/ajax/libs/monaco-editor/0.34.0/min/vs/editor/editor.main.js"
integrity="sha512-BtSZPhzoyN8kq1axY6cgOFPSgLJgFwvAZ3WxeDGxEFXeFcFuK2s7Hr+zF75npVHASUY1dxudAfIVzwmgdR89Bw==" integrity="sha512-TTPQbVI87mnVMV+1KbkKJ8vdQ4QqqbKyuTtJ9wQD8CqnwQLSQgXH7MWOQ88VO7pRzxWhqI1vYDeEV651sAH4ig=="
crossorigin="anonymous" crossorigin="anonymous"
referrerpolicy="no-referrer"></script> referrerpolicy="no-referrer"></script>
%sveltekit.head% %sveltekit.head%
-14
View File
@@ -1,14 +0,0 @@
/// <reference types="vite/client" />
interface ImportMetaEnv {
readonly MERMAID_RENDERER_URL: string;
readonly MERMAID_KROKI_RENDERER_URL: string;
readonly MERMAID_CDN_URL: string;
readonly MERMAID_BASE_URL: string;
readonly MERMAID_LOCAL: boolean;
// more env variables...
}
interface ImportMeta {
readonly env: ImportMetaEnv;
}
+4 -1
View File
@@ -1,6 +1,9 @@
import type { Handle } from '@sveltejs/kit'; import type { Handle } from '@sveltejs/kit';
export const handle: Handle = async ({ event, resolve }) => { export const handle: Handle = async ({ event, resolve }) => {
const response = await resolve(event, {}); const response = await resolve(event, {
ssr: false
});
return response; return response;
}; };
+18 -17
View File
@@ -1,13 +1,12 @@
<script lang="ts"> <script lang="ts">
import { browser } from '$app/environment'; import { browser } from '$app/env';
import Card from '$lib/components/card/card.svelte'; import Card from '$lib/components/card/card.svelte';
import { env } from '$lib/util/env'; import { krokiRendererUrl, rendererUrl } from '$lib/util/env';
import { pakoSerde } from '$lib/util/serde'; import { pakoSerde } from '$lib/util/serde';
import { stateStore } from '$lib/util/state'; import { stateStore } from '$lib/util/state';
import { logEvent } from '$lib/util/stats'; import { logEvent } from '$lib/util/stats';
import { toBase64 } from 'js-base64'; import { toBase64 } from 'js-base64';
import moment from 'moment'; import moment from 'moment';
const { krokiRendererUrl, rendererUrl } = env;
type Exporter = (context: CanvasRenderingContext2D, image: HTMLImageElement) => () => void; type Exporter = (context: CanvasRenderingContext2D, image: HTMLImageElement) => () => void;
@@ -116,19 +115,19 @@
const onCopyClipboard = (event: Event) => { const onCopyClipboard = (event: Event) => {
exportImage(event, clipboardCopy); exportImage(event, clipboardCopy);
logEvent('copyClipboard'); void logEvent('copyClipboard');
}; };
const onDownloadPNG = (event: Event) => { const onDownloadPNG = (event: Event) => {
exportImage(event, downloadImage); exportImage(event, downloadImage);
logEvent('download', { void logEvent('download', {
type: 'png' type: 'png'
}); });
}; };
const onDownloadSVG = () => { const onDownloadSVG = () => {
simulateDownload(getFileName('svg'), `data:image/svg+xml;base64,${getBase64SVG()}`); simulateDownload(getFileName('svg'), `data:image/svg+xml;base64,${getBase64SVG()}`);
logEvent('download', { void logEvent('download', {
type: 'svg' type: 'svg'
}); });
}; };
@@ -136,7 +135,7 @@
const onCopyMarkdown = () => { const onCopyMarkdown = () => {
(document.getElementById('markdown') as HTMLInputElement).select(); (document.getElementById('markdown') as HTMLInputElement).select();
document.execCommand('Copy'); document.execCommand('Copy');
logEvent('copyMarkdown'); void logEvent('copyMarkdown');
}; };
let gistURL = ''; let gistURL = '';
@@ -152,7 +151,7 @@
alert('Please enter a Gist URL first'); alert('Please enter a Gist URL first');
} }
window.location.href = `${window.location.pathname}?gist=${gistURL}`; window.location.href = `${window.location.pathname}?gist=${gistURL}`;
logEvent('loadGist'); void logEvent('loadGist');
}; };
let iUrl: string; let iUrl: string;
@@ -167,7 +166,7 @@
isNetlify = true; isNetlify = true;
} }
stateStore.subscribe(({ code, serialized }) => { stateStore.subscribe(({ code, serialized }) => {
iUrl = `${rendererUrl}/img/${serialized}?type=png`; iUrl = `${rendererUrl}/img/${serialized}`;
svgUrl = `${rendererUrl}/svg/${serialized}`; svgUrl = `${rendererUrl}/svg/${serialized}`;
krokiUrl = `${krokiRendererUrl}/mermaid/svg/${pakoSerde.serialize(code)}`; krokiUrl = `${krokiRendererUrl}/mermaid/svg/${pakoSerde.serialize(code)}`;
mdCode = `[![](${iUrl})](${window.location.protocol}//${window.location.host}${window.location.pathname}#${serialized})`; mdCode = `[![](${iUrl})](${window.location.protocol}//${window.location.host}${window.location.pathname}#${serialized})`;
@@ -181,24 +180,26 @@
><i class="far fa-copy mr-2" /> Copy Image to clipboard ><i class="far fa-copy mr-2" /> Copy Image to clipboard
</button> </button>
{/if} {/if}
<button id="downloadPNG" class="action-btn flex-grow" on:click={onDownloadPNG}> <button id="downloadPNG" class="action-btn flex-auto" on:click={onDownloadPNG}>
<i class="fas fa-download mr-2" /> PNG <i class="fas fa-download mr-2" /> PNG
</button> </button>
<button id="downloadSVG" class="action-btn flex-grow" on:click={onDownloadSVG}> <button id="downloadSVG" class="action-btn flex-auto" on:click={onDownloadSVG}>
<i class="fas fa-download mr-2" /> SVG <i class="fas fa-download mr-2" /> SVG
</button> </button>
<a target="_blank" rel="noreferrer" class="flex-grow" href={iUrl}> <a target="_blank" href={iUrl}>
<button class="action-btn w-full"> <button class="action-btn flex-auto">
<i class="fas fa-external-link-alt mr-2" /> PNG <i class="fas fa-external-link-alt mr-2" /> PNG
</button> </button>
</a> </a>
<a target="_blank" rel="noreferrer" class="flex-grow" href={svgUrl}>
<button class="action-btn w-full"> <a target="_blank" href={svgUrl}>
<button class="action-btn flex-auto">
<i class="fas fa-external-link-alt mr-2" /> SVG <i class="fas fa-external-link-alt mr-2" /> SVG
</button> </button>
</a> </a>
<a target="_blank" rel="noreferrer" class="flex-grow" href={krokiUrl}>
<button class="action-btn w-full"> <a target="_blank" href={krokiUrl}>
<button class="action-btn flex-auto">
<i class="fas fa-external-link-alt mr-2" /> Kroki <i class="fas fa-external-link-alt mr-2" /> Kroki
</button> </button>
</a> </a>
+2 -4
View File
@@ -5,7 +5,6 @@
export let isCloseable = true; export let isCloseable = true;
export let isOpen = true; export let isOpen = true;
export let tabs: Tab[] = []; export let tabs: Tab[] = [];
export let activeTabID: string = '';
export let title: string; export let title: string;
$: isOpen = isCloseable ? isOpen : true; $: isOpen = isCloseable ? isOpen : true;
$: isTabsShown = isOpen && tabs.length > 0; $: isTabsShown = isOpen && tabs.length > 0;
@@ -14,10 +13,9 @@
<div class="card rounded overflow-hidden m-2 flex-grow flex flex-col shadow-2xl"> <div class="card rounded overflow-hidden m-2 flex-grow flex flex-col shadow-2xl">
<div <div
class="bg-primary p-2 {isTabsShown ? 'pb-0' : ''} flex-none cursor-pointer" class="bg-primary p-2 {isTabsShown ? 'pb-0' : ''} flex-none cursor-pointer"
on:click={() => (isOpen = !isOpen)} on:click={() => (isOpen = !isOpen)}>
on:keypress={() => (isOpen = !isOpen)}>
<div class="flex justify-between"> <div class="flex justify-between">
<Tabs on:select {tabs} bind:isOpen {title} {isCloseable} {activeTabID} /> <Tabs on:select {tabs} bind:isOpen {title} {isCloseable} />
<div class="flex gap-x-4 items-center {isTabsShown ? '-mt-2' : ''}"> <div class="flex gap-x-4 items-center {isTabsShown ? '-mt-2' : ''}">
<slot name="actions" /> <slot name="actions" />
</div> </div>
+5 -11
View File
@@ -3,14 +3,12 @@
import { createEventDispatcher } from 'svelte'; import { createEventDispatcher } from 'svelte';
import { fade } from 'svelte/transition'; import { fade } from 'svelte/transition';
export let isCloseable = true; export let isCloseable = true;
export let tabs: Tab[]; export let tabs: Tab[] = [];
export let title: string; export let title: string;
export let isOpen = false; export let isOpen = false;
export let activeTabID: string;
if (!activeTabID && tabs.length > 0) { $: activeTabID = tabs[0]?.id;
activeTabID = tabs[0].id;
}
const dispatch = createEventDispatcher<TabEvents>(); const dispatch = createEventDispatcher<TabEvents>();
const toggleTabs = (tab: Tab) => { const toggleTabs = (tab: Tab) => {
activeTabID = tab.id; activeTabID = tab.id;
@@ -19,10 +17,7 @@
</script> </script>
<div class="flex cursor-default"> <div class="flex cursor-default">
<span <span class="mr-2 font-semibold" on:click|stopPropagation={() => (isOpen = !isOpen)}>
class="mr-2 font-semibold"
on:click|stopPropagation={() => (isOpen = !isOpen)}
on:keypress|stopPropagation={() => (isOpen = !isOpen)}>
{#if isCloseable} {#if isCloseable}
<i class="fas fa-chevron-right icon" class:isOpen /> <i class="fas fa-chevron-right icon" class:isOpen />
{/if} {/if}
@@ -32,8 +27,7 @@
{#each tabs as tab} {#each tabs as tab}
<div <div
class="tab tab-lifted {activeTabID === tab.id ? 'tab-active' : 'text-primary-content'}" class="tab tab-lifted {activeTabID === tab.id ? 'tab-active' : 'text-primary-content'}"
on:click|stopPropagation={() => toggleTabs(tab)} on:click|stopPropagation={() => toggleTabs(tab)}>
on:keypress|stopPropagation={() => toggleTabs(tab)}>
<i class="mr-1 {tab.icon}" /> <i class="mr-1 {tab.icon}" />
{tab.title} {tab.title}
</div> </div>
+39 -42
View File
@@ -1,78 +1,75 @@
<script lang="ts"> <script lang="ts">
import type { EditorMode } from '$lib/types'; import type { EditorEvents } from '$lib/types';
import { stateStore, updateCode, updateConfig } from '$lib/util/state'; import { stateStore } from '$lib/util/state';
import { themeStore } from '$lib/util/theme'; import { themeStore } from '$lib/util/theme';
import { syncDiagram } from '$lib/util/util'; import { syncDiagram } from '$lib/util/util';
import type monaco from 'monaco-editor'; import type monaco from 'monaco-editor';
import { onMount } from 'svelte'; import { createEventDispatcher, onMount } from 'svelte';
import initEditor from 'monaco-mermaid'; import initEditor from 'monaco-mermaid';
import { logEvent } from '$lib/util/stats'; import { logEvent } from '$lib/util/stats';
let divEl: HTMLDivElement = null; let divEl: HTMLDivElement = null;
let editor: monaco.editor.IStandaloneCodeEditor; let editor: monaco.editor.IStandaloneCodeEditor;
let Monaco: typeof monaco; let Monaco;
let editorOptions: monaco.editor.IStandaloneEditorConstructionOptions = {
export let text: string;
export let language: string;
export let editorOptions: monaco.editor.IStandaloneEditorConstructionOptions = {
value: text,
language: language,
minimap: { minimap: {
enabled: false enabled: false
}, },
theme: 'mermaid', theme: 'mermaid',
overviewRulerLanes: 0 overviewRulerLanes: 0
}; };
let text = ''; let oldText = text;
$: editor && Monaco?.editor.setModelLanguage(editor.getModel(), language);
stateStore.subscribe(({ errorMarkers, editorMode, code, mermaid }) => { const handleTextUpdate = (newText: string) => {
if (!editor) return; if (newText !== oldText) {
if ($stateStore.updateEditor) {
// Update editor text if it's different editor?.setValue(newText);
const newText = editorMode === 'code' ? code : mermaid; }
if (newText !== text) { oldText = newText;
editor.setValue(newText);
text = newText;
} }
editor && Monaco?.editor.setModelMarkers(editor.getModel(), 'test', $stateStore.errorMarkers);
};
// Update editor mode if it's different $: handleTextUpdate(text);
const language = editorMode === 'code' ? 'mermaid' : 'json';
if (editor.getModel().getLanguageId() !== language) {
Monaco?.editor.setModelLanguage(editor.getModel(), language);
}
// Display/clear errors
Monaco?.editor.setModelMarkers(editor.getModel(), 'mermaid', errorMarkers);
});
themeStore.subscribe(({ isDark }) => { themeStore.subscribe(({ isDark }) => {
editor && Monaco?.editor.setTheme(isDark ? 'mermaid-dark' : 'mermaid'); editor && Monaco?.editor.setTheme(isDark ? 'mermaid-dark' : 'mermaid');
}); });
const handleUpdate = (text: string, mode: EditorMode) => { const dispatch = createEventDispatcher<EditorEvents>();
if (mode === 'code') {
updateCode(text);
} else {
updateConfig(text);
}
};
const loadMonaco = async () => { const loadMonaco = async () => {
console.log('Loading Monaco...');
let i = 0; let i = 0;
while (i++ < 500) { while (i++ < 10) {
// @ts-ignore : This is a hack to handle a svelte-kit error when importing monaco. try {
Monaco = window.monaco; // @ts-ignore : This is a hack to handle a svelte-kit error when importing monaco.
if (Monaco !== undefined) { Monaco = monaco;
return; return;
} catch {
await new Promise((r) => setTimeout(r, 500));
} }
await new Promise((r) => setTimeout(r, 100));
} }
alert('Loading Monaco Editor failed. Please try refreshing the page.'); alert('Loading Monaco Editor failed. Please try refreshing the page.');
}; };
onMount(async () => { onMount(async () => {
await loadMonaco(); // Fix https://github.com/mermaid-js/mermaid-live-editor/issues/175 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
}
initEditor(Monaco); initEditor(Monaco);
editor = Monaco.editor.create(divEl, editorOptions); editor = Monaco.editor.create(divEl, editorOptions);
editor.onDidChangeModelContent(() => { editor.onDidChangeModelContent(() => {
text = editor.getValue(); oldText = editor.getValue();
handleUpdate(text, $stateStore.editorMode); dispatch('update', {
text: oldText
});
}); });
editor.addAction({ editor.addAction({
id: 'mermaid-render-diagram', id: 'mermaid-render-diagram',
@@ -80,7 +77,7 @@
keybindings: [Monaco.KeyMod.CtrlCmd | Monaco.KeyCode.Enter], keybindings: [Monaco.KeyMod.CtrlCmd | Monaco.KeyCode.Enter],
run: function () { run: function () {
syncDiagram(); syncDiagram();
logEvent('renderDiagram', { void logEvent('renderDiagram', {
method: 'keyboadShortcut' method: 'keyboadShortcut'
}); });
} }
+1 -2
View File
@@ -90,7 +90,7 @@
}; };
const restoreHistoryItem = (state: State): void => { const restoreHistoryItem = (state: State): void => {
inputStateStore.set({ ...state, updateDiagram: true }); inputStateStore.set({ ...state, updateEditor: true, updateDiagram: true });
}; };
const relativeTime = (time: number) => { const relativeTime = (time: number) => {
@@ -161,7 +161,6 @@
<a <a
href={url} href={url}
target="_blank" target="_blank"
rel="noreferrer"
title="Open revision in new tab" title="Open revision in new tab"
class="hover:underline text-blue-500">{name}</a> class="hover:underline text-blue-500">{name}</a>
{:else} {:else}
-120
View File
@@ -1,120 +0,0 @@
import type { HistoryEntry } from '$lib/types';
import { describe, it, expect } from 'vitest';
import {
addHistoryEntry,
injectHistoryIDs,
clearHistoryData,
historyModeStore,
historyStore
} from './history';
import { defaultState } from '../../util/state';
import { get } from 'svelte/store';
describe('history', () => {
it('should handle saving individual history entry', () => {
expect(window.localStorage.getItem('manualHistoryStore')).toBe('[]');
expect(window.localStorage.getItem('autoHistoryStore')).toBe('[]');
addHistoryEntry({
state: defaultState,
time: 12345,
type: 'manual'
});
const [manualEntry]: HistoryEntry[] = JSON.parse(
window.localStorage.getItem('manualHistoryStore')
);
expect(manualEntry.time).toBe(12345);
expect(manualEntry.type).toBe('manual');
expect(manualEntry.name).not.toBeNull();
expect(manualEntry.state).not.toBeNull();
addHistoryEntry({
state: defaultState,
time: 54321,
type: 'auto'
});
const [autoEntry]: HistoryEntry[] = JSON.parse(window.localStorage.getItem('autoHistoryStore'));
expect(autoEntry.time).toBe(54321);
expect(autoEntry.type).toBe('auto');
expect(autoEntry.name).not.toBeNull();
expect(autoEntry.state).not.toBeNull();
historyModeStore.set('manual');
clearHistoryData();
historyModeStore.set('auto');
clearHistoryData();
expect(window.localStorage.getItem('manualHistoryStore')).toBe('[]');
expect(window.localStorage.getItem('autoHistoryStore')).toBe('[]');
});
it('should clear history entries', () => {
addHistoryEntry({
state: defaultState,
time: 12345,
type: 'manual'
});
addHistoryEntry({
state: { ...defaultState, code: 'graph TD\\n A[Christmas] -->|Get money| B(Go shopping)' },
time: 123456,
type: 'manual'
});
historyModeStore.set('manual');
const store: HistoryEntry[] = get(historyStore);
expect(store.length).toBe(2);
clearHistoryData(store[1].id);
expect(get(historyStore).length).toBe(1);
clearHistoryData();
expect(get(historyStore).length).toBe(0);
historyModeStore.set('auto');
addHistoryEntry({
state: defaultState,
time: 54321,
type: 'auto'
});
addHistoryEntry({
state: { ...defaultState, code: 'graph TD\\n A[Christmas] -->|Get money| B(Go shopping)' },
time: 654321,
type: 'auto'
});
expect(get(historyStore).length).toBe(2);
clearHistoryData();
expect(get(historyStore).length).toBe(0);
// Test calling when history is empty
clearHistoryData();
expect(get(historyStore).length).toBe(0);
});
});
describe('history migration', () => {
it('should inject history IDs as migration', () => {
window.localStorage.setItem(
'manualHistoryStore',
'[{"state":{"code":"graph TD\\n A[Halloween] -->|Get money| B(Go shopping)","mermaid":"{\\n \\"theme\\": \\"dark\\"\\n}","autoSync":true,"updateDiagram":false},"time":0,"type":"manual","name":"hollow-art"},{"state":{"code":"graph TD\\n A[Christmas] -->|Get money| B(Go shopping)","mermaid":"{\\n \\"theme\\": \\"dark\\"\\n}","autoSync":true,"updateDiagram":true},"time":0,"type":"manual","name":"helpful-ocean"}]'
);
window.localStorage.setItem(
'autoHistoryStore',
'[{"state":{"code":"graph TD\\n A[New Year] -->|Get money| B(Go shopping)","mermaid":"{\\n \\"theme\\": \\"dark\\"\\n}","autoSync":true,"updateDiagram":false},"time":0,"type":"auto","name":"barking-dog"},{"state":{"code":"graph TD\\n A[Christmas] -->|Get money| B(Go shopping)","mermaid":"{\\n \\"theme\\": \\"dark\\"\\n}","autoSync":true,"updateDiagram":true},"time":0,"type":"manual","name":"needy-mosquito"}]'
);
let manualHistoryStore: HistoryEntry[] = JSON.parse(
window.localStorage.getItem('manualHistoryStore')
);
let autoHistoryStore: HistoryEntry[] = JSON.parse(
window.localStorage.getItem('autoHistoryStore')
);
expect(manualHistoryStore.every(({ id }) => id !== undefined)).toBe(false);
expect(autoHistoryStore.every(({ id }) => id !== undefined)).toBe(false);
injectHistoryIDs();
manualHistoryStore = JSON.parse(window.localStorage.getItem('manualHistoryStore'));
autoHistoryStore = JSON.parse(window.localStorage.getItem('autoHistoryStore'));
expect(manualHistoryStore.every(({ id }) => id !== undefined)).toBe(true);
expect(autoHistoryStore.every(({ id }) => id !== undefined)).toBe(true);
});
});
+4 -4
View File
@@ -1,6 +1,6 @@
import { derived, writable, get } from 'svelte/store'; import { derived, writable, get } from 'svelte/store';
import type { Readable, Writable } from 'svelte/store'; import type { Readable, Writable } from 'svelte/store';
import { persist, localStorage } from '$lib/util/persist'; import { persist, createLocalStorage } from '@macfja/svelte-persistent-store';
import { generateSlug } from 'random-word-slugs'; import { generateSlug } from 'random-word-slugs';
import type { HistoryEntry, HistoryType, Optional } from '$lib/types'; import type { HistoryEntry, HistoryType, Optional } from '$lib/types';
import { v4 as uuidV4 } from 'uuid'; import { v4 as uuidV4 } from 'uuid';
@@ -10,19 +10,19 @@ const MAX_AUTO_HISTORY_LENGTH = 30;
export const historyModeStore: Writable<HistoryType> = persist( export const historyModeStore: Writable<HistoryType> = persist(
writable('manual'), writable('manual'),
localStorage(), createLocalStorage(),
'autoHistoryMode' 'autoHistoryMode'
); );
const autoHistoryStore: Writable<HistoryEntry[]> = persist( const autoHistoryStore: Writable<HistoryEntry[]> = persist(
writable([]), writable([]),
localStorage(), createLocalStorage(),
'autoHistoryStore' 'autoHistoryStore'
); );
const manualHistoryStore: Writable<HistoryEntry[]> = persist( const manualHistoryStore: Writable<HistoryEntry[]> = persist(
writable([]), writable([]),
localStorage(), createLocalStorage(),
'manualHistoryStore' 'manualHistoryStore'
); );
+2 -2
View File
@@ -39,7 +39,7 @@
]; ];
</script> </script>
<div class="navbar shadow-lg bg-primary p-0"> <div class="navbar mb-2 shadow-lg bg-primary">
<div class="flex-1 px-2 mx-2"> <div class="flex-1 px-2 mx-2">
<span class="text-lg font-bold"> <span class="text-lg font-bold">
<a href="/">Mermaid<span class="text-xs font-thin">v{version}</span> Live Editor</a> <a href="/">Mermaid<span class="text-xs font-thin">v{version}</span> Live Editor</a>
@@ -61,7 +61,7 @@
<ul class="lg:flex items-center justify-between text-base pt-4 lg:pt-0"> <ul class="lg:flex items-center justify-between text-base pt-4 lg:pt-0">
{#each links as { title, href, icon }} {#each links as { title, href, icon }}
<li> <li>
<a class="btn btn-ghost" target="_blank" rel="noreferrer" {href}> <a class="btn btn-ghost" target="_blank" {href}>
{#if icon} {#if icon}
<i class={icon} /> <i class={icon} />
{/if} {/if}
+47 -76
View File
@@ -4,18 +4,19 @@
import { logEvent } from '$lib/util/stats'; import { logEvent } from '$lib/util/stats';
const samples = { const samples = {
Flow: `graph TD 'Flow Chart': `graph TD
A[Christmas] -->|Get money| B(Go shopping) A[Christmas] -->|Get money| B(Go shopping)
B --> C{Let me think} B --> C{Let me think}
C -->|One| D[Laptop] C -->|One| D[Laptop]
C -->|Two| E[iPhone] C -->|Two| E[iPhone]
C -->|Three| F[fa:fa-car Car]`, C -->|Three| F[fa:fa-car Car]`,
Sequence: `sequenceDiagram 'Sequence Diagram': `sequenceDiagram
Alice->>+John: Hello John, how are you? Alice->>+John: Hello John, how are you?
Alice->>+John: John, can you hear me? Alice->>+John: John, can you hear me?
John-->>-Alice: Hi Alice, I can hear you! John-->>-Alice: Hi Alice, I can hear you!
John-->>-Alice: I feel great!`, John-->>-Alice: I feel great!
Class: `classDiagram `,
'Class Diagram': `classDiagram
Animal <|-- Duck Animal <|-- Duck
Animal <|-- Fish Animal <|-- Fish
Animal <|-- Zebra Animal <|-- Zebra
@@ -35,15 +36,17 @@
class Zebra{ class Zebra{
+bool is_wild +bool is_wild
+run() +run()
}`, }
State: `stateDiagram-v2 `,
'State Diagram': `stateDiagram-v2
[*] --> Still [*] --> Still
Still --> [*] Still --> [*]
Still --> Moving Still --> Moving
Moving --> Still Moving --> Still
Moving --> Crash Moving --> Crash
Crash --> [*]`, Crash --> [*]
Gantt: `gantt `,
'Gantt Chart': `gantt
title A Gantt Diagram title A Gantt Diagram
dateFormat YYYY-MM-DD dateFormat YYYY-MM-DD
section Section section Section
@@ -51,21 +54,24 @@
Another task :after a1 , 20d Another task :after a1 , 20d
section Another section Another
Task in sec :2014-01-12 , 12d Task in sec :2014-01-12 , 12d
another task : 24d`, another task : 24d
Pie: `pie title Pets adopted by volunteers `,
'Pie Chart': `pie title Pets adopted by volunteers
"Dogs" : 386 "Dogs" : 386
"Cats" : 85 "Cats" : 85
"Rats" : 15`, "Rats" : 15
ER: `erDiagram `,
CUSTOMER }|..|{ DELIVERY-ADDRESS : has 'ER Diagram': `erDiagram
CUSTOMER ||--o{ ORDER : places CUSTOMER }|..|{ DELIVERY-ADDRESS : has
CUSTOMER ||--o{ INVOICE : "liable for" CUSTOMER ||--o{ ORDER : places
DELIVERY-ADDRESS ||--o{ ORDER : receives CUSTOMER ||--o{ INVOICE : "liable for"
INVOICE ||--|{ ORDER : covers DELIVERY-ADDRESS ||--o{ ORDER : receives
ORDER ||--|{ ORDER-ITEM : includes INVOICE ||--|{ ORDER : covers
PRODUCT-CATEGORY ||--|{ PRODUCT : contains ORDER ||--|{ ORDER-ITEM : includes
PRODUCT ||--o{ ORDER-ITEM : "ordered in"`, PRODUCT-CATEGORY ||--|{ PRODUCT : contains
'User Journey': `journey PRODUCT ||--o{ ORDER-ITEM : "ordered in"
`,
'User Journey': ` journey
title My working day title My working day
section Go to work section Go to work
Make tea: 5: Me Make tea: 5: Me
@@ -73,72 +79,37 @@
Do work: 1: Me, Cat Do work: 1: Me, Cat
section Go home section Go home
Go downstairs: 5: Me Go downstairs: 5: Me
Sit down: 3: Me`, Sit down: 3: Me
Git: `gitGraph `,
commit 'Git Graph': ` gitGraph
commit commit
branch develop commit
checkout develop branch develop
commit checkout develop
commit commit
checkout main commit
merge develop checkout main
commit merge develop
commit`, commit
Mindmap: `mindmap commit
root((mindmap)) `
Origins
Long history
::icon(fa fa-book)
Popularisation
British popular psychology author Tony Buzan
Research
On effectivness<br/>and features
On Automatic creation
Uses
Creative techniques
Strategic planning
Argument mapping
Tools
Pen and paper
Mermaid`
}; };
const loadSampleDiagram = (diagramType: string): void => { const loadSampleDiagram = (diagramType: string): void => {
updateCode(samples[diagramType], { updateCode(samples[diagramType], {
updateDiagram: true, updateDiagram: true,
updateEditor: true,
resetPanZoom: true resetPanZoom: true
}); });
logEvent('loadSampleDiagram', { diagramType }); void logEvent('loadSampleDiagram', { diagramType });
}; };
// Adding in this array will add an icon to the preset menu
const newDiagrams: Array<keyof typeof samples> = ['Mindmap'];
const diagramOrder: Array<keyof typeof samples> = [
'Sequence',
'Flow',
'Class',
'State',
'ER',
'Gantt',
'User Journey',
'Git',
'Pie',
'Mindmap'
];
</script> </script>
<Card title="Sample Diagrams" isOpen={false}> <Card title="Sample Diagrams" isOpen={false}>
<div class="flex flex-wrap p-2 gap-2"> <div class="flex gap-2 flex-wrap p-2">
{#each diagramOrder as sample} {#each Object.keys(samples) as sample}
<button <button class="btn btn-primary normal-case btn-sm" on:click={() => loadSampleDiagram(sample)}
class="btn btn-sm btn-primary w-28 normal-case flex-grow" >{sample}</button>
on:click={() => loadSampleDiagram(sample)}>
{sample}
{#if newDiagrams.includes(sample)}
<span class="ml-2 fa fa-heart" />
{/if}
</button>
{/each} {/each}
</div> </div>
</Card> </Card>
+22 -27
View File
@@ -2,32 +2,31 @@
import { setTheme, themeStore } from '$lib/util/theme'; import { setTheme, themeStore } from '$lib/util/theme';
const themes = [ const themes = [
'🌝 light', '🌝 light',
'🌚 dark', '🌚 dark',
'🧁 cupcake', '🧁 cupcake',
'🐝 bumblebee', '🐝 bumblebee',
'✳️ emerald', '✳️ emerald',
'🏢 corporate', '🏢 corporate',
'🌃 synthwave', '🌃 synthwave',
'👴 retro', '👴 retro',
'🤖 cyberpunk', '🤖 cyberpunk',
'🌸 valentine', '🌸 valentine',
'🎃 halloween', '🎃 halloween',
'🌷 garden', '🌷 garden',
'🌲 forest', '🌲 forest',
'🐟 aqua', '🐟 aqua',
'👓 lofi', '👓 lofi',
'🖍 pastel', '🖍 pastel',
'🧚‍♀️ fantasy', '🧚‍♀️ fantasy',
'📝 wireframe', '📝 wireframe',
'🏴 black', '🏴 black',
'💎 luxury', '💎 luxury',
'🧛‍♂️ dracula' '🧛‍♂️ dracula'
]; ];
</script> </script>
<div class="hidden lg:block dropdown"> <div class="hidden lg:block dropdown">
<!-- svelte-ignore a11y-no-noninteractive-tabindex -->
<div tabindex="0" class="btn btn-ghost "> <div tabindex="0" class="btn btn-ghost ">
<svg <svg
xmlns="http://www.w3.org/2000/svg" xmlns="http://www.w3.org/2000/svg"
@@ -49,14 +48,10 @@
</div> </div>
<div <div
class="mt-14 overflow-y-auto shadow-2xl top-px dropdown-content h-96 w-56 bg-base-200 text-base-content"> class="mt-14 overflow-y-auto shadow-2xl top-px dropdown-content h-96 w-56 bg-base-200 text-base-content">
<!-- svelte-ignore a11y-no-noninteractive-tabindex -->
<ul tabindex="0" class="p-4 menu compact"> <ul tabindex="0" class="p-4 menu compact">
{#each themes as theme} {#each themes as theme}
<li class={theme.includes($themeStore.theme) ? 'bordered' : ''}> <li class={theme.includes($themeStore.theme) ? 'bordered' : ''}>
<span <span class="btn btn-ghost justify-start" on:click={() => setTheme(theme)}>{theme}</span>
class="btn btn-ghost justify-start"
on:click={() => setTheme(theme)}
on:keypress={() => setTheme(theme)}>{theme}</span>
</li> </li>
{/each} {/each}
</ul> </ul>
+51 -69
View File
@@ -1,12 +1,11 @@
<script lang="ts"> <script lang="ts">
import { inputStateStore, stateStore, updateCodeStore } from '$lib/util/state'; import { inputStateStore, stateStore, updateCodeStore } from '$lib/util/state';
import { onMount } from 'svelte'; import { onMount } from 'svelte';
import mermaid from 'mermaid';
import panzoom from 'svg-pan-zoom'; import panzoom from 'svg-pan-zoom';
import type { State, ValidatedState } from '$lib/types'; import type { State } from '$lib/types';
import { logEvent } from '$lib/util/stats'; import { logEvent } from '$lib/util/stats';
import { cmdKey } from '$lib/util/util';
import { render as renderDiagram, init as mermaidInit } from '$lib/util/mermaid';
const init = mermaidInit();
let code = ''; let code = '';
let config = ''; let config = '';
let container: HTMLDivElement; let container: HTMLDivElement;
@@ -17,12 +16,16 @@
let manualUpdate = true; let manualUpdate = true;
let panZoomEnabled = $stateStore.panZoom; let panZoomEnabled = $stateStore.panZoom;
let pzoom: SvgPanZoom.Instance; let pzoom: SvgPanZoom.Instance;
let debounce: number;
const handlePanZoomChange = () => { const handlePanZoomChange = () => {
const pan = pzoom.getPan(); const pan = pzoom.getPan();
const zoom = pzoom.getZoom(); const zoom = pzoom.getZoom();
updateCodeStore({ pan, zoom }); clearTimeout(debounce);
logEvent('panZoom'); debounce = window.setTimeout(() => {
updateCodeStore({ pan, zoom });
void logEvent('panZoom');
}, 200);
}; };
const handlePanZoom = (state: State) => { const handlePanZoom = (state: State) => {
@@ -50,61 +53,50 @@
}); });
}; };
const handleStateChange = (state: ValidatedState) => { onMount(() => {
if (state.error !== undefined) { stateStore.subscribe((state) => {
error = true; if (state.error !== undefined) {
return; error = true;
} return;
error = false; }
try { error = false;
if (container && state && (state.updateDiagram || state.autoSync)) { try {
if (!state.autoSync) { if (container && state && (state.updateDiagram || state.autoSync)) {
$inputStateStore.updateDiagram = false; if (!state.autoSync) {
} $inputStateStore.updateDiagram = false;
outOfSync = false; }
manualUpdate = true; outOfSync = false;
if (code === state.code && config === state.mermaid && panZoomEnabled === state.panZoom) { manualUpdate = true;
// Do not render if there is no change in Code/Config/PanZoom if (code === state.code && config === state.mermaid && panZoomEnabled === state.panZoom) {
return; // Do not render if there is no change in Code/Config/PanZoom
} return;
code = state.code; }
config = state.mermaid; code = state.code;
panZoomEnabled = state.panZoom; config = state.mermaid;
const scroll = view.parentElement.scrollTop; panZoomEnabled = state.panZoom;
delete container.dataset.processed; const scroll = view.parentElement.scrollTop;
renderDiagram({ delete container.dataset.processed;
config: Object.assign({}, JSON.parse(state.mermaid)), mermaid.initialize(Object.assign({}, JSON.parse(state.mermaid)));
code, mermaid.render('graph-div', code, (svgCode) => {
id: 'graph-div',
callback: (svgCode, bindFunctions) => {
if (svgCode.length > 0) { if (svgCode.length > 0) {
handlePanZoom(state); handlePanZoom(state);
container.innerHTML = svgCode; container.innerHTML = svgCode;
const graphDiv = document.getElementById('graph-div'); const graphDiv = document.getElementById('graph-div');
graphDiv.setAttribute('height', '100%'); graphDiv.setAttribute('height', '100%');
graphDiv.style.maxWidth = '100%'; graphDiv.style.maxWidth = '100%';
if (bindFunctions) {
bindFunctions(graphDiv);
}
} }
} });
}); view.parentElement.scrollTop = scroll;
view.parentElement.scrollTop = scroll; error = false;
error = false; } else if (manualUpdate) {
} else if (manualUpdate) { manualUpdate = false;
manualUpdate = false; } else if (code !== state.code || config !== state.mermaid) {
} else if (code !== state.code || config !== state.mermaid) { outOfSync = true;
outOfSync = true; }
} catch (e) {
console.log('view fail', e);
error = true;
} }
} catch (e) {
console.error('view fail', e);
error = true;
}
};
onMount(() => {
stateStore.subscribe((state) => {
handleStateChange(state);
}); });
window.addEventListener('resize', () => { window.addEventListener('resize', () => {
if ($stateStore.panZoom && pzoom) { if ($stateStore.panZoom && pzoom) {
@@ -114,23 +106,13 @@
}); });
</script> </script>
{#await init} {#if error && $stateStore.error instanceof Error}
Loading... <div class="p-2 text-red-600" id="errorContainer">{$stateStore.error}</div>
{:then} {/if}
{#if error && $stateStore.error instanceof Error}
<div class="p-2 text-red-600" id="errorContainer">{$stateStore.error}</div>
{/if}
{#if outOfSync} <div id="view" bind:this={view} class="p-2 h-full" class:error class:outOfSync>
<div class="absolute w-full p-2 z-10 text-yellow-600 bg-base-100 bg-opacity-80 text-center"> <div id="container" bind:this={container} class="h-full overflow-auto" class:hide />
Diagram out of sync. <br /> </div>
Press <i class="fas fa-sync" /> (Sync button) or <kbd>{cmdKey} + Enter</kbd> to sync.
</div>
{/if}
<div id="view" bind:this={view} class="p-2 h-full" class:error class:outOfSync>
<div id="container" bind:this={container} class="h-full overflow-auto" class:hide />
</div>
{/await}
<style> <style>
#view { #view {
+8 -4
View File
@@ -16,6 +16,13 @@ export interface MarkerData {
endColumn: number; endColumn: number;
} }
export interface EditorUpdateEvent {
text: string;
}
export interface EditorEvents {
update: EditorUpdateEvent;
}
export interface TabEvents { export interface TabEvents {
select: Tab; select: Tab;
} }
@@ -29,9 +36,9 @@ export interface Tab {
export interface State { export interface State {
code: string; code: string;
mermaid: string; mermaid: string;
updateEditor: boolean;
updateDiagram: boolean; updateDiagram: boolean;
autoSync: boolean; autoSync: boolean;
editorMode?: EditorMode;
panZoom?: boolean; panZoom?: boolean;
pan?: { x: number; y: number }; pan?: { x: number; y: number };
zoom?: number; zoom?: number;
@@ -39,7 +46,6 @@ export interface State {
} }
export interface ValidatedState extends State { export interface ValidatedState extends State {
editorMode: EditorMode;
error: unknown; error: unknown;
errorMarkers: MarkerData[]; errorMarkers: MarkerData[];
serialized: string; serialized: string;
@@ -80,7 +86,5 @@ export interface DocConfig {
}; };
} }
export type EditorMode = 'code' | 'config';
export type Loader = (url: string) => Promise<State>; export type Loader = (url: string) => Promise<State>;
export type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>; export type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;
+4 -9
View File
@@ -1,9 +1,4 @@
export const env = { export const rendererUrl: string =
rendererUrl: import.meta.env.MERMAID_RENDERER_URL ?? 'https://mermaid.ink', (import.meta.env.MERMAID_RENDERER_URL as string) ?? 'https://mermaid.ink';
krokiRendererUrl: import.meta.env.MERMAID_KROKI_RENDERER_URL ?? 'https://kroki.io', export const krokiRendererUrl: string =
mermaidCDNUrl: import.meta.env.MERMAID_CDN_URL ?? 'https://unpkg.com/@mermaid-js', (import.meta.env.MERMAID_KROKI_RENDERER_URL as string) ?? 'https://kroki.io';
mermaidBaseURL: import.meta.env.MERMAID_BASE_URL ?? 'http://localhost:9000',
useLocalMermaid: import.meta.env.MERMAID_LOCAL ?? false,
isDev: import.meta.env.DEV,
baseURL: import.meta.env.BASE_URL
};
+2 -1
View File
@@ -54,6 +54,7 @@ export const loadDataFromUrl = async (): Promise<void> => {
updateCodeStore({ updateCodeStore({
...state, ...state,
autoSync: true, autoSync: true,
updateDiagram: true updateDiagram: true,
updateEditor: true
}); });
}; };
-74
View File
@@ -1,74 +0,0 @@
import mermaid from 'mermaid';
// We need to export MermaidConfig and all related types from mermaid.
import type { MermaidConfig } from 'mermaid/dist/config.type';
import { env } from './env';
import queue from 'async/queue';
import type { QueueObject } from 'async';
const { mermaidBaseURL, mermaidCDNUrl, useLocalMermaid } = env;
const getDiagramURL = (name: string, version: string): string => {
if (useLocalMermaid) {
return `${mermaidBaseURL}/${name}-detector.esm.mjs`;
}
return `${mermaidCDNUrl}/${name}@${version}/dist/${name}-detector.esm.mjs`;
};
const initialize = mermaid.initializeAsync({
logLevel: 0,
lazyLoadedDiagrams: [getDiagramURL('mermaid-mindmap', '9.2.0-rc4')],
loadExternalDiagramsAtStartup: true
});
export const init = async () => {
await initialize;
};
interface RenderPayload {
config: MermaidConfig;
code: string;
id: string;
callback: Parameters<typeof mermaid.render>[2];
}
interface ParsePayload {
code: string;
}
interface MermaidTask {
action: 'render' | 'parse';
payload: RenderPayload | ParsePayload;
}
const mermaidQueue: QueueObject<MermaidTask> = queue(async (task: MermaidTask) => {
console.log('adding ', task);
if (task.action === 'render') {
const { config, code, id, callback } = task.payload as RenderPayload;
await mermaid.mermaidAPI.renderAsync(id, code, callback);
}
console.log('done', task);
}, 1);
mermaidQueue.error(function (err, task) {
console.error('task experienced an error', task, err);
});
export const render = async (payload: RenderPayload): Promise<void> => {
// Should be able to call this multiple times without any issues.
// await mermaid.initialize({
// ...config,
// lazyLoadedDiagrams: [
// // We should make SRI mandatory for all lazy-loaded diagrams.
// 'https://unpkg.com/@mermaid-js/mermaid-mindmap@9.2.0-rc2/dist/mermaid-mindmap-detector.esm.mjs'
// ]
// });
// console.log('Rendering', code);
// mermaid.mermaidAPI.render(id, code, callback);
await mermaidQueue.push({
action: 'render',
payload
});
};
export const parse = async (code: string): Promise<boolean> => {
await init();
return mermaid.parseAsync(code);
};
-34
View File
@@ -1,34 +0,0 @@
import type { HistoryEntry } from '$lib/types';
import { describe, it, expect, beforeEach } from 'vitest';
describe('migrations', () => {
beforeEach(() => {
window.localStorage.setItem(
'manualHistoryStore',
'[{"state":{"code":"graph TD\\n A[Halloween] -->|Get money| B(Go shopping)","mermaid":"{\\n \\"theme\\": \\"dark\\"\\n}","autoSync":true,"updateDiagram":false},"time":0,"type":"manual","name":"hollow-art"},{"state":{"code":"graph TD\\n A[Christmas] -->|Get money| B(Go shopping)","mermaid":"{\\n \\"theme\\": \\"dark\\"\\n}","autoSync":true,"updateDiagram":true},"time":0,"type":"manual","name":"helpful-ocean"}]'
);
window.localStorage.setItem(
'autoHistoryStore',
'[{"state":{"code":"graph TD\\n A[New Year] -->|Get money| B(Go shopping)","mermaid":"{\\n \\"theme\\": \\"dark\\"\\n}","autoSync":true,"updateDiagram":false},"time":0,"type":"auto","name":"barking-dog"},{"state":{"code":"graph TD\\n A[Christmas] -->|Get money| B(Go shopping)","mermaid":"{\\n \\"theme\\": \\"dark\\"\\n}","autoSync":true,"updateDiagram":true},"time":0,"type":"manual","name":"needy-mosquito"}]'
);
});
it('should migrate from v0 to v1', async () => {
const { applyMigrations } = await import('./migrations');
let manualHistoryStore: HistoryEntry[] = JSON.parse(
window.localStorage.getItem('manualHistoryStore')
);
let autoHistoryStore: HistoryEntry[] = JSON.parse(
window.localStorage.getItem('autoHistoryStore')
);
expect(manualHistoryStore.every(({ id }) => id !== undefined)).toBe(false);
expect(autoHistoryStore.every(({ id }) => id !== undefined)).toBe(false);
applyMigrations();
manualHistoryStore = JSON.parse(window.localStorage.getItem('manualHistoryStore'));
autoHistoryStore = JSON.parse(window.localStorage.getItem('autoHistoryStore'));
expect(manualHistoryStore.every(({ id }) => id !== undefined)).toBe(true);
expect(autoHistoryStore.every(({ id }) => id !== undefined)).toBe(true);
});
});
+2 -2
View File
@@ -1,5 +1,5 @@
import { writable, get, type Writable } from 'svelte/store'; import { writable, get, type Writable } from 'svelte/store';
import { persist, localStorage } from '$lib/util/persist'; import { persist, createLocalStorage } from '@macfja/svelte-persistent-store';
import { injectHistoryIDs } from '$lib/components/history/history'; import { injectHistoryIDs } from '$lib/components/history/history';
import { logEvent } from './stats'; import { logEvent } from './stats';
@@ -13,7 +13,7 @@ const migrations: { [key: string]: () => void } = {
const migrationStore: Writable<MigrationState> = persist( const migrationStore: Writable<MigrationState> = persist(
writable({ version: -1 }), writable({ version: -1 }),
localStorage(), createLocalStorage(),
'migrations' 'migrations'
); );
-265
View File
@@ -1,265 +0,0 @@
/* eslint-disable @typescript-eslint/no-explicit-any */
// Copied from https://github.com/MacFJA/svelte-persistent-store
// # The MIT License (MIT)
// Copyright (c) 2021 [MacFJA](https://github.com/MacFJA)
// > Permission is hereby granted, free of charge, to any person obtaining a copy
// > of this software and associated documentation files (the "Software"), to deal
// > in the Software without restriction, including without limitation the rights
// > to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// > copies of the Software, and to permit persons to whom the Software is
// > furnished to do so, subject to the following conditions:
// >
// > The above copyright notice and this permission notice shall be included in
// > all copies or substantial portions of the Software.
// >
// > THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// > IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// > FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// > AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// > LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// > OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// > THE SOFTWARE.
import ESSerializer from 'esserializer';
import type { Writable } from 'svelte/store';
/**
* Disabled warnings about missing/unavailable storages
*/
export function disableWarnings(): void {
noWarnings = true;
}
/**
* If set to true, no warning will be emitted if the requested Storage is not found.
* This option can be useful when the lib is used on a server.
*/
let noWarnings = false;
/**
* List of storages where the warning have already been displayed.
*/
const alreadyWarnFor: Array<string> = [];
/**
* Add a log to indicate that the requested Storage have not been found.
* @param {string} storageName
*/
const warnStorageNotFound = (storageName) => {
const isProduction = typeof process !== 'undefined' && process.env?.NODE_ENV === 'production';
if (!noWarnings && alreadyWarnFor.indexOf(storageName) === -1 && !isProduction) {
let message = `Unable to find the ${storageName}. No data will be persisted.`;
if (typeof window === 'undefined') {
message +=
'\n' +
'Are you running on a server? Most of storages are not available while running on a server.';
}
console.warn(message);
alreadyWarnFor.push(storageName);
}
};
const allowedClasses = [];
/**
* Add a class to the allowed list of classes to be serialized
* @param classDef The class to add to the list
*/
export const addSerializableClass = (classDef: () => unknown): void => {
allowedClasses.push(classDef);
};
const serialize = (value: unknown): string => ESSerializer.serialize(value);
const deserialize = (value: string): unknown => {
// @TODO: to remove in the next major
if (value === 'undefined') {
return undefined;
}
if (value !== null && value !== undefined) {
try {
return ESSerializer.deserialize(value, allowedClasses);
} catch (e) {
// Do nothing
// use the value "as is"
}
try {
return JSON.parse(value);
} catch (e) {
// Do nothing
// use the value "as is"
}
}
return value;
};
/**
* A store that keep it's value in time.
*/
export interface PersistentStore<T> extends Writable<T> {
/**
* Delete the store value from the persistent storage
*/
delete(): void;
}
/**
* Storage interface
*/
export interface StorageInterface<T> {
/**
* Get a value from the storage.
*
* If the value doesn't exists in the storage, `null` should be returned.
* This method MUST be synchronous.
* @param key The key/name of the value to retrieve
*/
getValue(key: string): T | null;
/**
* Save a value in the storage.
* @param key The key/name of the value to save
* @param value The value to save
*/
setValue(key: string, value: T): void;
/**
* Remove a value from the storage
* @param key The key/name of the value to remove
*/
deleteValue(key: string): void;
}
export interface SelfUpdateStorageInterface<T> extends StorageInterface<T> {
/**
* Add a listener to the storage values changes
* @param {string} key The key to listen
* @param {(newValue: T) => void} listener The listener callback function
*/
addListener(key: string, listener: (newValue: T) => void): void;
/**
* Remove a listener from the storage values changes
* @param {string} key The key that was listened
* @param {(newValue: T) => void} listener The listener callback function to remove
*/
removeListener(key: string, listener: (newValue: T) => void): void;
}
/**
* Make a store persistent
* @param {Writable<*>} store The store to enhance
* @param {StorageInterface} storage The storage to use
* @param {string} key The name of the data key
*/
export function persist<T>(
store: Writable<T>,
storage: StorageInterface<T>,
key: string
): PersistentStore<T> {
const initialValue = storage.getValue(key);
if (null !== initialValue) {
store.set(initialValue);
}
if ((storage as SelfUpdateStorageInterface<T>).addListener) {
(storage as SelfUpdateStorageInterface<T>).addListener(key, (newValue) => {
store.set(newValue);
});
}
store.subscribe((value) => {
storage.setValue(key, value);
});
return {
...store,
delete() {
storage.deleteValue(key);
}
};
}
function getBrowserStorage(
browserStorage: Storage,
listenExternalChanges = false
): SelfUpdateStorageInterface<any> {
const listeners: Array<{ key: string; listener: (newValue: any) => void }> = [];
const listenerFunction = (event: StorageEvent) => {
const eventKey = event.key;
if (event.storageArea === browserStorage) {
listeners
.filter(({ key }) => key === eventKey)
.forEach(({ listener }) => {
listener(deserialize(event.newValue));
});
}
};
const connect = () => {
if (listenExternalChanges && typeof window !== 'undefined' && window?.addEventListener) {
window.addEventListener('storage', listenerFunction);
}
};
const disconnect = () => {
if (listenExternalChanges && typeof window !== 'undefined' && window?.removeEventListener) {
window.removeEventListener('storage', listenerFunction);
}
};
return {
addListener(key: string, listener: (newValue: any) => void) {
listeners.push({ key, listener });
if (listeners.length === 1) {
connect();
}
},
removeListener(key: string, listener: (newValue: any) => void) {
const index = listeners.indexOf({ key, listener });
if (index !== -1) {
listeners.splice(index, 1);
}
if (listeners.length === 0) {
disconnect();
}
},
getValue(key: string): any | null {
const value = browserStorage.getItem(key);
return deserialize(value);
},
deleteValue(key: string) {
browserStorage.removeItem(key);
},
setValue(key: string, value: any) {
browserStorage.setItem(key, serialize(value));
}
};
}
/**
* Storage implementation that use the browser local storage
* @param {boolean} listenExternalChanges - Update the store if the localStorage is updated from another page
*/
export function localStorage<T>(listenExternalChanges = false): StorageInterface<T> {
if (typeof window !== 'undefined' && window?.localStorage) {
return getBrowserStorage(window.localStorage, listenExternalChanges);
}
warnStorageNotFound('window.localStorage');
return noopStorage();
}
/**
* Storage implementation that do nothing
*/
export function noopStorage(): StorageInterface<any> {
return {
getValue(): null {
return null;
},
deleteValue() {
// Do nothing
},
setValue() {
// Do nothing
}
};
}
+3 -3
View File
@@ -13,19 +13,19 @@ describe('Serde tests', () => {
it('should serialize and deserialize with default serde', () => { it('should serialize and deserialize with default serde', () => {
expect(verifySerde(defaultState)).toMatchInlineSnapshot( expect(verifySerde(defaultState)).toMatchInlineSnapshot(
'"pako:eNpVj81qw0AMhF9F6NRC_AI-BGK7zSXQQHLz5iBsObuk-8Naphjb7551fEl1EjPfiNGEjW8Zc7xHChqulXKQ5lCXOppeLPU3yLL9fGQB6x2PMxQfRw-99iEYd__c-GKFoJxOK8Yg2rjHslnlK__jeIaqPlEQH27vzvXPz_BVm7NO5_87OnJKfdcd5R1lDUUoKb4Q3KHlaMm0qfq0KgpFs2WFeVpb7mj4FYXKLQmlQfxldA3mEgfe4RBaEq4MpaftJi5PNtJU8w"' '"pako:eNpVkM1qw0AMhF9F6JRC_AI-FBo7ySXQQnPz5iC8cnZp9oe1TAm2373rmEKik5j5ZhAasQ2ascRromjgXCsPeT6ayiTbi6P-AkXxPh1ZwAXP9wl2m2OA3oQYrb--rfxugaAaTwvGIMb6n3m1qkf-0_MEdXOiKCFenp3zb5hg39gvk-tfHZM4pw5NR2VHRUsJKkoPBLfoODmyOp8-LopCMexYYZlXzR0NN1Go_JzRIWoS3msrIWGuuvW8RRokfN99i6Wkgf-h2lL-hFvF-Q9-YFyS"'
); );
}); });
it('should serialize and deserialize with base64 serde', () => { it('should serialize and deserialize with base64 serde', () => {
expect(verifySerde(defaultState, 'base64')).toMatchInlineSnapshot( expect(verifySerde(defaultState, 'base64')).toMatchInlineSnapshot(
'"base64:eyJjb2RlIjoiZ3JhcGggVERcbiAgICBBW0NocmlzdG1hc10gLS0-fEdldCBtb25leXwgQihHbyBzaG9wcGluZylcbiAgICBCIC0tPiBDe0xldCBtZSB0aGlua31cbiAgICBDIC0tPnxPbmV8IERbTGFwdG9wXVxuICAgIEMgLS0-fFR3b3wgRVtpUGhvbmVdXG4gICAgQyAtLT58VGhyZWV8IEZbZmE6ZmEtY2FyIENhcl1cbiAgIiwibWVybWFpZCI6IntcbiAgXCJ0aGVtZVwiOiBcImRlZmF1bHRcIlxufSIsImF1dG9TeW5jIjp0cnVlLCJ1cGRhdGVEaWFncmFtIjp0cnVlfQ"' '"base64:eyJjb2RlIjoiZ3JhcGggVERcbiAgICBBW0NocmlzdG1hc10gLS0-fEdldCBtb25leXwgQihHbyBzaG9wcGluZylcbiAgICBCIC0tPiBDe0xldCBtZSB0aGlua31cbiAgICBDIC0tPnxPbmV8IERbTGFwdG9wXVxuICAgIEMgLS0-fFR3b3wgRVtpUGhvbmVdXG4gICAgQyAtLT58VGhyZWV8IEZbZmE6ZmEtY2FyIENhcl1cbiAgIiwibWVybWFpZCI6IntcbiAgXCJ0aGVtZVwiOiBcImRlZmF1bHRcIlxufSIsInVwZGF0ZUVkaXRvciI6ZmFsc2UsImF1dG9TeW5jIjp0cnVlLCJ1cGRhdGVEaWFncmFtIjp0cnVlfQ"'
); );
}); });
it('should serialize and deserialize with pako serde', () => { it('should serialize and deserialize with pako serde', () => {
expect(verifySerde(defaultState, 'pako')).toMatchInlineSnapshot( expect(verifySerde(defaultState, 'pako')).toMatchInlineSnapshot(
'"pako:eNpVj81qw0AMhF9F6NRC_AI-BGK7zSXQQHLz5iBsObuk-8Naphjb7551fEl1EjPfiNGEjW8Zc7xHChqulXKQ5lCXOppeLPU3yLL9fGQB6x2PMxQfRw-99iEYd__c-GKFoJxOK8Yg2rjHslnlK__jeIaqPlEQH27vzvXPz_BVm7NO5_87OnJKfdcd5R1lDUUoKb4Q3KHlaMm0qfq0KgpFs2WFeVpb7mj4FYXKLQmlQfxldA3mEgfe4RBaEq4MpaftJi5PNtJU8w"' '"pako:eNpVkM1qw0AMhF9F6JRC_AI-FBo7ySXQQnPz5iC8cnZp9oe1TAm2373rmEKik5j5ZhAasQ2ascRromjgXCsPeT6ayiTbi6P-AkXxPh1ZwAXP9wl2m2OA3oQYrb--rfxugaAaTwvGIMb6n3m1qkf-0_MEdXOiKCFenp3zb5hg39gvk-tfHZM4pw5NR2VHRUsJKkoPBLfoODmyOp8-LopCMexYYZlXzR0NN1Go_JzRIWoS3msrIWGuuvW8RRokfN99i6Wkgf-h2lL-hFvF-Q9-YFyS"'
); );
}); });
+17 -26
View File
@@ -1,15 +1,13 @@
import { writable, get, derived } from 'svelte/store'; import { writable, get, derived } from 'svelte/store';
import { persist, localStorage } from './persist'; import { persist, createLocalStorage } from '@macfja/svelte-persistent-store';
import { saveStatistics, countLines } from './stats'; import { saveStatistics } from './stats';
import { serializeState, deserializeState } from './serde'; import { serializeState, deserializeState } from './serde';
import { cmdKey } from './util'; import { cmdKey } from './util';
import { parse, init } from './mermaid'; import mermaid from 'mermaid';
import type { Readable } from 'svelte/store'; import type { Readable } from 'svelte/store';
import type { MarkerData, State, ValidatedState } from '$lib/types'; import type { MarkerData, State, ValidatedState } from '$lib/types';
void init();
export const defaultState: State = { export const defaultState: State = {
code: `graph TD code: `graph TD
A[Christmas] -->|Get money| B(Go shopping) A[Christmas] -->|Get money| B(Go shopping)
@@ -25,6 +23,7 @@ export const defaultState: State = {
null, null,
2 2
), ),
updateEditor: false,
autoSync: true, autoSync: true,
updateDiagram: true updateDiagram: true
}; };
@@ -41,7 +40,7 @@ const urlParseFailedState = `graph TD
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"`; 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"`;
// inputStateStore handles all updates and is shared externally when exporting via URL, History, etc. // inputStateStore handles all updates and is shared externally when exporting via URL, History, etc.
export const inputStateStore = persist(writable(defaultState), localStorage(), 'codeStore'); export const inputStateStore = persist(writable(defaultState), createLocalStorage(), 'codeStore');
// All internal reads should be done via stateStore, but it should not be persisted/shared externally. // All internal reads should be done via stateStore, but it should not be persisted/shared externally.
export const stateStore: Readable<ValidatedState> = derived([inputStateStore], ([state]) => { export const stateStore: Readable<ValidatedState> = derived([inputStateStore], ([state]) => {
@@ -49,14 +48,12 @@ export const stateStore: Readable<ValidatedState> = derived([inputStateStore], (
...state, ...state,
serialized: '', serialized: '',
errorMarkers: [], errorMarkers: [],
error: undefined, error: undefined
editorMode: state.editorMode ?? 'code'
}; };
// No changes should be done to fields part of `state`. // No changes should be done to fields part of `state`.
try { try {
processed.serialized = serializeState(state); processed.serialized = serializeState(state);
// await parse(state.code); mermaid.parse(state.code);
JSON.parse(state.mermaid); JSON.parse(state.mermaid);
} catch (e) { } catch (e) {
processed.error = e; processed.error = e;
@@ -105,7 +102,7 @@ export const loadState = (data: string): void => {
state.mermaid = defaultState.mermaid; state.mermaid = defaultState.mermaid;
} }
} }
updateCodeStore(state); updateCodeStore({ ...state, updateEditor: true });
}; };
export const updateCodeStore = (newState: Partial<State>): void => { export const updateCodeStore = (newState: Partial<State>): void => {
@@ -118,12 +115,13 @@ let prompted = false;
export const updateCode = ( export const updateCode = (
code: string, code: string,
{ {
updateEditor,
updateDiagram = false, updateDiagram = false,
resetPanZoom = false resetPanZoom = false
}: { updateDiagram?: boolean; resetPanZoom?: boolean } = {} }: { updateEditor: boolean; updateDiagram?: boolean; resetPanZoom?: boolean }
): void => { ): void => {
const lines = countLines(code);
saveStatistics(code); saveStatistics(code);
const lines = (code.match(/\n/g) || '').length + 1;
if (lines > 50 && !prompted && get(stateStore).autoSync) { if (lines > 50 && !prompted && get(stateStore).autoSync) {
const turnOff = confirm( const turnOff = confirm(
@@ -142,13 +140,13 @@ export const updateCode = (
state.pan = undefined; state.pan = undefined;
state.zoom = undefined; state.zoom = undefined;
} }
return { ...state, code, updateDiagram }; return { ...state, code, updateEditor, updateDiagram };
}); });
}; };
export const updateConfig = (config: string): void => { export const updateConfig = (config: string, updateEditor: boolean): void => {
inputStateStore.update((state) => { inputStateStore.update((state) => {
return { ...state, mermaid: config }; return { ...state, mermaid: config, updateEditor };
}); });
}; };
@@ -159,20 +157,13 @@ export const toggleDarkTheme = (dark: boolean): void => {
config.theme = dark ? 'dark' : 'default'; config.theme = dark ? 'dark' : 'default';
} }
return { ...state, mermaid: JSON.stringify(config, null, 2) }; return { ...state, mermaid: JSON.stringify(config, null, 2), updateEditor: true };
}); });
}; };
let urlDebounce: number;
export const initURLSubscription = (): void => { export const initURLSubscription = (): void => {
stateStore.subscribe(({ serialized }: ValidatedState) => { stateStore.subscribe(({ serialized }) => {
if (serialized.length < 5) { history.replaceState(undefined, undefined, `#${serialized}`);
return;
}
clearTimeout(urlDebounce);
urlDebounce = window.setTimeout(() => {
history.replaceState(undefined, undefined, `#${serialized}`);
}, 250);
}); });
}; };
-19
View File
@@ -1,19 +0,0 @@
import { describe, it, expect } from 'vitest';
import { detectType } from './stats';
describe('diagram detection', () => {
it('should detect diagrams correctly', () => {
expect(
detectType(`%%{{
graph`)
).toBe('graph');
expect(detectType(`gitGraph`)).toBe('gitGraph');
expect(
detectType(`%%{{
flowChart
graph`)
).toBe('flowChart');
expect(detectType(`loki -> thor`)).toBe(undefined);
});
});
+29 -65
View File
@@ -1,17 +1,25 @@
import { browser } from '$app/environment'; import { browser } from '$app/env';
import type { AnalyticsInstance } from 'analytics'; import type { AnalyticsInstance } from 'analytics';
export let analytics: AnalyticsInstance; export let analytics: AnalyticsInstance;
export const initAnalytics = async (): Promise<void> => { export const initAnalytics = async (): Promise<void> => {
if (browser && !analytics) { if (browser && !analytics) {
try { try {
const [{ Analytics }, { default: plausible }] = await Promise.all([ const { Analytics } = await import('analytics');
import('analytics'), // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
import('analytics-plugin-plausible') const googleAnalytics = (await import('@analytics/google-analytics')).default;
]); const plausible = (await import('analytics-plugin-plausible')).default;
analytics = Analytics({ analytics = Analytics({
app: 'mermaid-live-editor', app: 'mermaid-live-editor',
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
plugins: [ plugins: [
// eslint-disable-next-line @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-member-access
googleAnalytics({
measurementIds: ['UA-153180559-1']
}),
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-ignore
plausible({ plausible({
domain: 'mermaid.live', domain: 'mermaid.live',
hashMode: false, hashMode: false,
@@ -27,72 +35,28 @@ export const initAnalytics = async (): Promise<void> => {
} }
}; };
export const detectType = (text: string): string => { const detectType = (text: string): string => {
const possibleDiagramTypes = [ return text
'classDiagram',
'erDiagram',
'flowChart',
'gantt',
'gitGraph',
'graph',
'journey',
'pie',
'stateDiagram'
];
const firstLine = text
.replace(/^\s*%%.*\n/g, '\n') .replace(/^\s*%%.*\n/g, '\n')
.trimStart() .trimStart()
.split(' ')[0] .split(' ')[0];
.toLowerCase();
const detectedDiagram = possibleDiagramTypes.find((d) => firstLine.includes(d.toLowerCase()));
return detectedDiagram;
};
export const countLines = (code: string): number => {
return (code.match(/\n/g) || '').length + 1;
}; };
// manual debounce
let timeout: number;
export const saveStatistics = (graph: string): void => { export const saveStatistics = (graph: string): void => {
const graphType = detectType(graph); if (analytics) {
if (!graphType) { clearTimeout(timeout);
return; // Only save statistics after a 5 sec delay
timeout = window.setTimeout(() => {
const graphType = detectType(graph);
console.debug(`ga: send event: render ${graphType}`);
void logEvent('render', { graphType });
}, 5000);
} }
const length = countLines(graph);
logEvent('render', { graphType, length });
}; };
const minutesToMilliSeconds = (minutes: number): number => { // eslint-disable-next-line @typescript-eslint/no-explicit-any
return minutes * 60_000; export const logEvent = async (name: string, data?: any): Promise<void> => {
}; await analytics?.track(name, data);
const defaultDelay = minutesToMilliSeconds(1);
const delaysPerEvent = {
render: minutesToMilliSeconds(5),
panZoom: minutesToMilliSeconds(10),
copyClipboard: defaultDelay,
download: defaultDelay,
copyMarkdown: defaultDelay,
loadGist: defaultDelay,
loadSampleDiagram: defaultDelay,
renderDiagram: defaultDelay,
history: defaultDelay,
migration: defaultDelay,
themeChange: defaultDelay
};
export type AnalyticsEvent = keyof typeof delaysPerEvent;
const timeouts: Record<string, number> = {};
// manual debounce to reduce the number of events sent to analytics
export const logEvent = (name: AnalyticsEvent, data?: unknown): void => {
if (!analytics) {
return;
}
const key = data ? JSON.stringify({ name, data }) : name;
if (timeouts[key] === undefined) {
void analytics.track(name, data);
} else {
clearTimeout(timeouts[key]);
}
timeouts[key] = window.setTimeout(() => {
delete timeouts[key];
}, delaysPerEvent[name]);
}; };
+3 -3
View File
@@ -1,6 +1,6 @@
import { writable } from 'svelte/store'; import { writable } from 'svelte/store';
import type { Writable } from 'svelte/store'; import type { Writable } from 'svelte/store';
import { persist, localStorage } from '$lib/util/persist'; import { persist, createLocalStorage } from '@macfja/svelte-persistent-store';
import { logEvent } from './stats'; import { logEvent } from './stats';
export interface ThemeConfig { export interface ThemeConfig {
@@ -12,7 +12,7 @@ export const themeStore: Writable<ThemeConfig> = persist(
writable({ writable({
isDark: false isDark: false
}), }),
localStorage(), createLocalStorage(),
'themeStore' 'themeStore'
); );
@@ -34,5 +34,5 @@ export const setTheme = (theme: string): void => {
const isDark = darkThemes.includes(theme); const isDark = darkThemes.includes(theme);
console.log('Setting theme', theme); console.log('Setting theme', theme);
themeStore.set({ theme, isDark }); themeStore.set({ theme, isDark });
logEvent('themeChange', { theme, isDark }); void logEvent('themeChange', { theme, isDark });
}; };
+2 -2
View File
@@ -2,7 +2,6 @@ import { initURLSubscription, loadState, updateCodeStore } from './state';
import { analytics, initAnalytics } from './stats'; import { analytics, initAnalytics } from './stats';
import { loadDataFromUrl } from './fileLoaders/loader'; import { loadDataFromUrl } from './fileLoaders/loader';
import { initLoading } from './loading'; import { initLoading } from './loading';
import { applyMigrations } from './migrations';
export const loadStateFromURL = (): void => { export const loadStateFromURL = (): void => {
loadState(window.location.hash.slice(1)); loadState(window.location.hash.slice(1));
@@ -15,7 +14,6 @@ export const syncDiagram = (): void => {
}; };
export const initHandler = async (): Promise<void> => { export const initHandler = async (): Promise<void> => {
applyMigrations();
loadStateFromURL(); loadStateFromURL();
await initLoading('Loading Gist...', loadDataFromUrl().catch(console.error)); await initLoading('Loading Gist...', loadDataFromUrl().catch(console.error));
syncDiagram(); syncDiagram();
@@ -26,3 +24,5 @@ export const initHandler = async (): Promise<void> => {
export const isMac = navigator.platform.toUpperCase().indexOf('MAC') >= 0; export const isMac = navigator.platform.toUpperCase().indexOf('MAC') >= 0;
export const cmdKey = isMac ? 'Cmd' : 'Ctrl'; export const cmdKey = isMac ? 'Cmd' : 'Ctrl';
export const debounceEnabled = window.localStorage.getItem('noDebounce') !== 'true';
-3
View File
@@ -1,3 +0,0 @@
export const prerender = true;
export const csr = true;
export const ssr = false;
+2
View File
@@ -6,10 +6,12 @@
import { setTheme, themeStore } from '$lib/util/theme'; import { setTheme, themeStore } from '$lib/util/theme';
import { toggleDarkTheme } from '$lib/util/state'; import { toggleDarkTheme } from '$lib/util/state';
import { initHandler } from '$lib/util/util'; import { initHandler } from '$lib/util/util';
import { applyMigrations } from '$lib/util/migrations';
// This can be removed once https://github.com/sveltejs/kit/issues/1612 is fixed. // This can be removed once https://github.com/sveltejs/kit/issues/1612 is fixed.
// Then move it into src and vite will bundle it automatically. // Then move it into src and vite will bundle it automatically.
onMount(() => { onMount(() => {
applyMigrations();
window.addEventListener('hashchange', async (ev) => { window.addEventListener('hashchange', async (ev) => {
await initHandler(); await initHandler();
}); });
@@ -0,0 +1,4 @@
import type { RequestHandler } from './$types';
import { GET as manifestGet } from '../../manifest.json/+server';
export const GET: RequestHandler = manifestGet;
+56 -18
View File
@@ -6,12 +6,20 @@
import View from '$lib/components/view.svelte'; import View from '$lib/components/view.svelte';
import Card from '$lib/components/card/card.svelte'; import Card from '$lib/components/card/card.svelte';
import History from '$lib/components/history/history.svelte'; import History from '$lib/components/history/history.svelte';
import { inputStateStore, stateStore, updateCodeStore } from '$lib/util/state'; import { updateCode, updateConfig, inputStateStore, stateStore } from '$lib/util/state';
import { cmdKey, initHandler, syncDiagram } from '$lib/util/util'; import { cmdKey, debounceEnabled, initHandler, syncDiagram } from '$lib/util/util';
import { onMount } from 'svelte'; import { onMount } from 'svelte';
import type { Tab, DocConfig, EditorMode, ValidatedState } from '$lib/types'; import type { EditorUpdateEvent, State, Tab, DocConfig } from '$lib/types';
import { base } from '$app/paths'; import { base } from '$app/paths';
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 docURLBase = 'https://mermaid-js.github.io/mermaid';
const docMap: DocConfig = { const docMap: DocConfig = {
graph: { graph: {
@@ -52,23 +60,34 @@
config: '/#/gitgraph?id=gitgraph-specific-configuration-options' config: '/#/gitgraph?id=gitgraph-specific-configuration-options'
} }
}; };
let text = '';
let docURL = docURLBase; let docURL = docURLBase;
let activeTabID = 'code'; let language: Languages = 'mermaid';
stateStore.subscribe(({ code, editorMode }: ValidatedState) => { const handleModeUpdate = (mode: Modes) => {
activeTabID = editorMode; if (mode === 'code') {
const codeTypeMatch = /([\S]+)[\s\n]/.exec(code); text = $stateStore.code;
} else {
text = $stateStore.mermaid;
}
};
$: language = languageMap[selectedMode];
$: handleModeUpdate(selectedMode);
stateStore.subscribe((state: State) => {
if (state.updateEditor) {
text = selectedMode === 'code' ? state.code : state.mermaid;
}
const codeTypeMatch = /([\S]+)[\s\n]/.exec(state.code);
if (codeTypeMatch && codeTypeMatch.length > 1) { if (codeTypeMatch && codeTypeMatch.length > 1) {
const docKey = codeTypeMatch[1]; const docKey = codeTypeMatch[1];
const docConfig = docMap[docKey] ?? { code: '' }; const docConfig = docMap[docKey] ?? { code: '' };
docURL = docURLBase + (docConfig[editorMode] ?? docConfig.code ?? ''); docURL = docURLBase + (docConfig[selectedMode] ?? docConfig.code ?? '');
} }
}); });
const tabSelectHandler = (message: CustomEvent<Tab>) => { const tabSelectHandler = (message: CustomEvent<Tab>) => {
const editorMode: EditorMode = message.detail.id === 'code' ? 'code' : 'config'; selectedMode = message.detail.id === 'code' ? 'code' : 'config';
updateCodeStore({ editorMode }); $inputStateStore.updateEditor = true;
}; };
const tabs: Tab[] = [ const tabs: Tab[] = [
{ {
id: 'code', id: 'code',
@@ -82,6 +101,28 @@
} }
]; ];
const handleUpdate = (text: string) => {
if (selectedMode === 'code') {
updateCode(text, {
updateEditor: false
});
} else {
updateConfig(text, false);
}
};
let debounce: { [key: string]: number } = {};
const updateHandler = ({ detail: { text } }: CustomEvent<EditorUpdateEvent>) => {
if (debounceEnabled) {
clearTimeout(debounce[selectedMode]);
debounce[selectedMode] = window.setTimeout(() => {
handleUpdate(text);
}, 300);
} else {
handleUpdate(text);
}
};
onMount(async () => { onMount(async () => {
await initHandler(); await initHandler();
const resizer = document.getElementById('resizeHandler'); const resizer = document.getElementById('resizeHandler');
@@ -108,7 +149,7 @@
<Navbar /> <Navbar />
<div class="flex-1 flex overflow-hidden"> <div class="flex-1 flex overflow-hidden">
<div class="hidden md:flex flex-col" id="editorPane" style="width: 40%"> <div class="hidden md:flex flex-col" id="editorPane" style="width: 40%">
<Card on:select={tabSelectHandler} {tabs} isCloseable={false} {activeTabID} title="Mermaid"> <Card on:select={tabSelectHandler} {tabs} isCloseable={false} title="Mermaid">
<div slot="actions" class="flex flex-row items-center"> <div slot="actions" class="flex flex-row items-center">
<div class="form-control flex-row items-center"> <div class="form-control flex-row items-center">
<label class="cursor-pointer label" for="autoSync"> <label class="cursor-pointer label" for="autoSync">
@@ -130,13 +171,11 @@
{/if} {/if}
<button class="btn btn-secondary btn-xs" title="View documentation"> <button class="btn btn-secondary btn-xs" title="View documentation">
<a target="_blank" rel="noreferrer" href={docURL} data-cy="docs"> <a target="_blank" href={docURL} data-cy="docs"><i class="fas fa-book mr-1" />Docs</a>
<i class="fas fa-book mr-1" />Docs
</a>
</button> </button>
</div> </div>
<Editor /> <Editor on:update={updateHandler} {language} {text} />
</Card> </Card>
<div class="-mt-2"> <div class="-mt-2">
@@ -160,7 +199,6 @@
<a <a
href={`${base}/view#${$stateStore.serialized}`} href={`${base}/view#${$stateStore.serialized}`}
target="_blank" target="_blank"
rel="noreferrer"
class="btn btn-secondary btn-xs" class="btn btn-secondary btn-xs"
title="View diagram in new page" title="View diagram in new page"
><i class="fas fa-external-link-alt mr-1" />Full screen</a> ><i class="fas fa-external-link-alt mr-1" />Full screen</a>
+29
View File
@@ -0,0 +1,29 @@
import { json } from '@sveltejs/kit';
import { base } from '$app/paths';
import type { RequestHandler } from './$types';
export const GET: RequestHandler = () => {
return json({
short_name: 'Mermaid',
name: 'Mermaid Live Editor',
icons: [
{
src: `${base}/icon-192.png`,
type: 'image/png',
sizes: '192x192'
},
{
src: `${base}/icon-512.png`,
type: 'image/png',
sizes: '512x512'
}
],
start_url: `${base}/edit/`,
background_color: '#6366F1',
display: 'standalone',
scope: `${base}/edit/`,
theme_color: '#6366F1',
description: 'FlowChart & Diagrams Editor.',
orientation: 'landscape'
});
};
+1 -1
View File
@@ -5,7 +5,7 @@ expect.extend(matchers);
// TODO: Remove once https://github.com/sveltejs/kit/issues/6259 is closed. // TODO: Remove once https://github.com/sveltejs/kit/issues/6259 is closed.
beforeAll(() => { beforeAll(() => {
vi.mock('$app/environment', () => ({ vi.mock('$app/env', () => ({
browser: 'window' in globalThis browser: 'window' in globalThis
})); }));
}); });
Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.2 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 12 KiB

After

Width:  |  Height:  |  Size: 16 KiB

-6
View File
@@ -1,6 +0,0 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<svg width="100%" height="100%" viewBox="0 0 491 491" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" xmlns:serif="http://www.serif.com/" style="fill-rule:evenodd;clip-rule:evenodd;stroke-linejoin:round;stroke-miterlimit:2;">
<path d="M490.16,84.61C490.16,37.912 452.248,0 405.55,0L84.61,0C37.912,0 0,37.912 0,84.61L0,405.55C0,452.248 37.912,490.16 84.61,490.16L405.55,490.16C452.248,490.16 490.16,452.248 490.16,405.55L490.16,84.61Z" style="fill:rgb(255,54,112);"/>
<path d="M407.48,111.18C335.587,108.103 269.573,152.338 245.08,220C220.587,152.338 154.573,108.103 82.68,111.18C80.285,168.229 107.577,222.632 154.74,254.82C178.908,271.419 193.35,298.951 193.27,328.27L193.27,379.13L296.9,379.13L296.9,328.27C296.816,298.953 311.255,271.42 335.42,254.82C382.596,222.644 409.892,168.233 407.48,111.18Z" style="fill:white;fill-rule:nonzero;"/>
</svg>

Before

Width:  |  Height:  |  Size: 1.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 47 KiB

-18
View File
@@ -1,18 +0,0 @@
{
"short_name": "Mermaid",
"name": "Mermaid Live Editor",
"icons": [
{
"src": "/favicon.png",
"type": "image/png",
"sizes": "512x512"
}
],
"start_url": "/edit/",
"background_color": "#6366F1",
"display": "standalone",
"scope": "/edit/",
"theme_color": "#6366F1",
"description": "FlowChart & Diagrams Editor.",
"orientation": "landscape"
}
+4 -1
View File
@@ -19,7 +19,10 @@ const config = {
base: `/mermaid-live-editor` base: `/mermaid-live-editor`
} }
: {}, : {},
trailingSlash: 'ignore' trailingSlash: 'ignore',
prerender: {
default: true
}
} }
}; };
+1 -2
View File
@@ -5,8 +5,7 @@
"src/**/*.svelte", "src/**/*.svelte",
"cypress/**/*.ts", "cypress/**/*.ts",
"cypress/**/*.js", "cypress/**/*.js",
"static/**/*.js", "static/**/*.js"
"static/**/*.json"
], ],
"compilerOptions": { "compilerOptions": {
"resolveJsonModule": true, "resolveJsonModule": true,
+3
View File
@@ -4,6 +4,9 @@ const config = {
plugins: [sveltekit()], plugins: [sveltekit()],
envPrefix: 'MERMAID_', envPrefix: 'MERMAID_',
optimizeDeps: { include: ['mermaid'] }, optimizeDeps: { include: ['mermaid'] },
ssr: {
noExternal: ['@macfja/svelte-persistent-store']
},
server: { server: {
port: 3000, port: 3000,
host: true host: true
+510 -614
View File
File diff suppressed because it is too large Load Diff