svg export via cli command and headless browser

.vscode/launch.json

@@ -5,9 +5,17 @@
             "name": "Vitest: Run All",
             "type": "node",
             "request": "launch",
-            "skipFiles": ["<node_internals>/**", "**/node_modules/**"],
+            "skipFiles": [
+                "<node_internals>/**",
+                "**/node_modules/**"
+            ],
             "program": "${workspaceRoot}/node_modules/vitest/vitest.mjs",
-            "args": ["run", "--no-color", "--no-coverage", "--no-watch"],
+            "args": [
+                "run",
+                "--no-color",
+                "--no-coverage",
+                "--no-watch"
+            ],
             "smartStep": true,
             "console": "integratedTerminal",
         },
@@ -16,9 +24,15 @@
             "type": "node",
             "request": "launch",
             "autoAttachChildProcesses": true,
-            "skipFiles": ["<node_internals>/**", "**/node_modules/**"],
+            "skipFiles": [
+                "<node_internals>/**",
+                "**/node_modules/**"
+            ],
             "program": "${workspaceRoot}/node_modules/vitest/vitest.mjs",
-            "args": ["run", "${relativeFile}"],
+            "args": [
+                "run",
+                "${relativeFile}"
+            ],
             "smartStep": true,
             "console": "integratedTerminal",
         },
@@ -41,6 +55,17 @@
                 "${workspaceFolder}/packages/sprotty-protocol/lib/**/*.js",
                 "${workspaceFolder}/packages/sprotty-elk/lib/**/*.js"
             ]
+        },
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "Trigger export command",
+            "runtimeExecutable": "${workspaceFolder}/packages/sprotty/bin/sprotty",
+            "args": [
+                "export",
+                "http://localhost:8080/jsxample/jsxample.html"
+            ],
+            "cwd": "${workspaceFolder}"
         }
     ]
 }

examples/jsxample/src/standalone.ts

@@ -14,13 +14,17 @@
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
 
-import { LocalModelSource, TYPES } from 'sprotty';
+import { LocalModelSource, RequestExportSvgAction, TYPES } from 'sprotty';
 import createContainer from './di.config';
 
 export default async function runJsxample() {
     const container = createContainer('sprotty');
     const modelSource = container.get<LocalModelSource>(TYPES.ModelSource);
 
+    document.addEventListener('export', () => {
+        modelSource.actionDispatcher.dispatch(RequestExportSvgAction.create());
+    });
+
     const graph = {
         id: 'root',
         type: 'graph',

packages/sprotty/bin/sprotty

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+require('../lib/cli/sprotty')

packages/sprotty/package.json

@@ -23,8 +23,10 @@
   },
   "dependencies": {
     "autocompleter": "^9.1.2",
+    "commander": "^12.0.0",
     "file-saver": "^2.0.5",
     "inversify": "~6.0.2",
+    "puppeteer": "^22.2.0",
     "snabbdom": "~3.5.1",
     "sprotty-protocol": "^1.1.0",
     "tinyqueue": "^2.0.3"
@@ -45,10 +47,14 @@
     "test": "vitest run --config ../../vite.config.ts"
   },
   "files": [
+    "bin",
     "lib",
     "css",
     "src"
   ],
+  "bin": {
+    "sprotty": "bin/sprotty"
+  },
   "main": "lib/index",
   "types": "lib/index"
 }

packages/sprotty/src/cli/sprotty.ts

@@ -0,0 +1,42 @@
+/********************************************************************************
+ * Copyright (c) 2024 TypeFox and others.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * This Source Code may also be made available under the following Secondary
+ * Licenses when the conditions for such availability set forth in the Eclipse
+ * Public License v. 2.0 are satisfied: GNU General Public License, version 2
+ * with the GNU Classpath Exception which is available at
+ * https://www.gnu.org/software/classpath/license.html.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
+ ********************************************************************************/
+
+import { Command } from 'commander';
+import puppeteer from 'puppeteer';
+
+export function sprottyCli(argv: string[]): void {
+    const program = new Command();
+
+    program.command('export')
+        .argument('<url>', 'The url of the Sprotty page')
+        .action(async (url: string) => {
+            const browser = await puppeteer.launch();
+            const page = await browser.newPage();
+            await page.goto(url);
+            await page.evaluate(() => {
+                // trigger the export
+                document.dispatchEvent(new Event('export'));
+            });
+
+            // await browser.close();
+        });
+
+    program.parse(argv);
+
+}
+
+// run the command
+sprottyCli(process.argv);