Skip to content

Commit

Permalink
Initial commit of some examples of how to script Structurizr using Pu…
Browse files Browse the repository at this point in the history
…ppeteer.
  • Loading branch information
simonbrowndotje committed Jun 16, 2018
1 parent f832e2f commit 5799103
Show file tree
Hide file tree
Showing 6 changed files with 401 additions and 2 deletions.
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
node_modules
build
npm-debug.log
.env
.DS_Store
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
# puppeteer
Code samples for scripting Structurizr with Puppeteer.
# Structurizr Puppeteer

This repo contains some examples of how to script the Structurizr web application using Puppeteer. Please note that the scripting facility is not available to workspaces owned by users on the free plan.
41 changes: 41 additions & 0 deletions export-all-diagrams-and-keys-to-png.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
const puppeteer = require('puppeteer');
const fs = require('fs');

const workspaceId = 1;
const filename = 'structurizr-' + workspaceId + '-';

(async () => {
const browser = await puppeteer.launch({ignoreHTTPSErrors: true, headless: false});
const page = await browser.newPage();
await page.goto('https://structurizr.com/share/' + workspaceId);

const views = await page.evaluate(() => {
return Structurizr.scripting.getViews();
});

for (var i = 0; i < views.length; i++) {
var view = views[i];

await page.evaluate((view) => {
Structurizr.scripting.changeView(view);
}, view);

var base64DataForDiagram = await page.evaluate(() => {
return Structurizr.scripting.exportCurrentDiagramToPNG();
});

var base64DataForKey = await page.evaluate(() => {
return Structurizr.scripting.exportCurrentDiagramKeyToPNG();
});

fs.writeFile(filename + view.key + '.png', base64DataForDiagram.replace(/^data:image\/png;base64,/, ""), 'base64', function (err) {
if (err) throw err;
});

fs.writeFile(filename + view.key + '-key.png', base64DataForKey.replace(/^data:image\/png;base64,/, ""), 'base64', function (err) {
if (err) throw err;
});
}

await browser.close();
})();
30 changes: 30 additions & 0 deletions export-current-diagram-and-key-to-png.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
const puppeteer = require('puppeteer');
const fs = require('fs');

const workspaceId = 1;
const diagramKey = 'liveDeployment';
const filename = 'structurizr-' + workspaceId + '-' + diagramKey;

(async () => {
const browser = await puppeteer.launch({ignoreHTTPSErrors: false, headless: true});
const page = await browser.newPage();
await page.goto('https://structurizr.com/share/' + workspaceId + '#' + diagramKey);

const base64DataForDiagram = await page.evaluate(() => {
return Structurizr.scripting.exportCurrentDiagramToPNG();
});

const base64DataForKey = await page.evaluate(() => {
return Structurizr.scripting.exportCurrentDiagramKeyToPNG();
});

fs.writeFile(filename + '.png', base64DataForDiagram.replace(/^data:image\/png;base64,/, ""), 'base64', function (err) {
if (err) throw err;
});

fs.writeFile(filename + '-key.png', base64DataForKey.replace(/^data:image\/png;base64,/, ""), 'base64', function (err) {
if (err) throw err;
});

await browser.close();
})();
22 changes: 22 additions & 0 deletions export-diagrams-to-offline-html-page.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
const puppeteer = require('puppeteer');
const fs = require('fs');

const workspaceId = 1;
const filename = 'structurizr-' + workspaceId + '-diagrams.html';

(async () => {
const browser = await puppeteer.launch({ignoreHTTPSErrors: false, headless: true});
const page = await browser.newPage();
await page.goto('https://structurizr.com/share/' + workspaceId);

page.on('console', msg => {
fs.writeFile(filename, msg.text(), function (err) {
if (err) throw err;
});
browser.close();
});

await page.evaluate(() => {
Structurizr.scripting.exportDiagramsToOfflineHtmlPage(function(html) { console.log(html); });
});
})();
Loading

0 comments on commit 5799103

Please sign in to comment.