├── .gitignore ├── LICENSE ├── README.md ├── export-diagrams.js └── export-documentation.js /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | build 3 | npm-debug.log 4 | .env 5 | .DS_Store 6 | *.png 7 | *.svg 8 | 9 | .idea 10 | package.json 11 | package-lock.json 12 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Structurizr Puppeteer 2 | 3 | This repo contains some Node.js examples of how to script and automate parts of Structurizr Lite/on-premises/cloud service using Puppeteer (and headless Chrome) from the command line, perhaps as a part of your build process. 4 | 5 | The command line examples that follow assume that you have [Node.js](https://nodejs.org) and [Puppeteer](https://developers.google.com/web/tools/puppeteer/) installed. 6 | 7 | ## Exporting diagrams 8 | 9 | ``` 10 | node export-diagrams.js [username] [password] 11 | ``` 12 | 13 | ### Examples 14 | 15 | Structurizr Lite: 16 | 17 | ``` 18 | node export-diagrams.js http://localhost:8080/workspace/diagrams png 19 | ``` 20 | 21 | Unauthenticated access to diagrams on the cloud service: 22 | 23 | ``` 24 | node export-diagrams.js https://structurizr.com/share/36141/diagrams png 25 | ``` 26 | 27 | Authenticated access to diagrams on an on-premises installation 28 | 29 | ``` 30 | node export-diagrams.js http://localhost:8080/workspace/1/diagrams png username password 31 | ``` 32 | 33 | ## Exporting documentation 34 | 35 | ``` 36 | node export-documentation.js [username] [password] 37 | ``` 38 | 39 | ### Examples 40 | 41 | Structurizr Lite (workspace or default documentation): 42 | 43 | ``` 44 | node export-documentation.js http://localhost:8080/workspace/documentation 45 | ``` 46 | 47 | Unauthenticated access to documentation on the cloud service (specific software system documentation): 48 | 49 | ``` 50 | node export-documentation.js https://structurizr.com/share/31/documentation/Financial%20Risk%20System 51 | ``` 52 | 53 | Authenticated access to documentation on an on-premises installation (workspace or default documentation): 54 | 55 | ``` 56 | node export-documentation.js http://localhost:8080/workspace/1/documentation username password 57 | ``` -------------------------------------------------------------------------------- /export-diagrams.js: -------------------------------------------------------------------------------- 1 | const puppeteer = require('puppeteer'); 2 | const fs = require('fs'); 3 | 4 | const PNG_FORMAT = 'png'; 5 | const SVG_FORMAT = 'svg'; 6 | 7 | const IGNORE_HTTPS_ERRORS = true; 8 | const HEADLESS = true; 9 | 10 | const IMAGE_VIEW_TYPE = 'Image'; 11 | 12 | if (process.argv.length < 4) { 13 | console.log("Usage: [username] [password]") 14 | process.exit(1); 15 | } 16 | 17 | const url = process.argv[2]; 18 | const format = process.argv[3]; 19 | 20 | if (format !== PNG_FORMAT && format !== SVG_FORMAT) { 21 | console.log("The output format must be ' + PNG_FORMAT + ' or ' + SVG_FORMAT + '."); 22 | process.exit(1); 23 | } 24 | 25 | var username; 26 | var password; 27 | 28 | if (process.argv.length > 3) { 29 | username = process.argv[4]; 30 | password = process.argv[5]; 31 | } 32 | 33 | var expectedNumberOfExports = 0; 34 | var actualNumberOfExports = 0; 35 | 36 | (async () => { 37 | const browser = await puppeteer.launch({ignoreHTTPSErrors: IGNORE_HTTPS_ERRORS, headless: HEADLESS}); 38 | const page = await browser.newPage(); 39 | 40 | if (username !== undefined && password !== undefined) { 41 | // sign in 42 | const parts = url.split('://'); 43 | const signinUrl = parts[0] + '://' + parts[1].substring(0, parts[1].indexOf('/')) + '/dashboard'; 44 | console.log(' - Signing in via ' + signinUrl); 45 | 46 | await page.goto(signinUrl, { waitUntil: 'networkidle2' }); 47 | await page.type('#username', username); 48 | await page.type('#password', password); 49 | await page.keyboard.press('Enter'); 50 | await page.waitForSelector('div#dashboard'); 51 | } 52 | 53 | // visit the diagrams page 54 | console.log(" - Opening " + url); 55 | await page.goto(url, { waitUntil: 'domcontentloaded' }); 56 | await page.waitForFunction('structurizr.scripting && structurizr.scripting.isDiagramRendered() === true'); 57 | 58 | if (format === PNG_FORMAT) { 59 | // add a function to the page to save the generated PNG images 60 | await page.exposeFunction('savePNG', (content, filename) => { 61 | console.log(" - " + filename); 62 | content = content.replace(/^data:image\/png;base64,/, ""); 63 | fs.writeFile(filename, content, 'base64', function (err) { 64 | if (err) throw err; 65 | }); 66 | 67 | actualNumberOfExports++; 68 | 69 | if (actualNumberOfExports === expectedNumberOfExports) { 70 | console.log(" - Finished"); 71 | browser.close(); 72 | } 73 | }); 74 | } 75 | 76 | // get the array of views 77 | const views = await page.evaluate(() => { 78 | return structurizr.scripting.getViews(); 79 | }); 80 | 81 | views.forEach(function(view) { 82 | if (view.type === IMAGE_VIEW_TYPE) { 83 | expectedNumberOfExports++; // diagram only 84 | } else { 85 | expectedNumberOfExports++; // diagram 86 | expectedNumberOfExports++; // key 87 | } 88 | }); 89 | 90 | console.log(" - Starting export"); 91 | for (var i = 0; i < views.length; i++) { 92 | const view = views[i]; 93 | 94 | await page.evaluate((view) => { 95 | structurizr.scripting.changeView(view.key); 96 | }, view); 97 | 98 | await page.waitForFunction('structurizr.scripting.isDiagramRendered() === true'); 99 | 100 | if (format === SVG_FORMAT) { 101 | const diagramFilename = view.key + '.svg'; 102 | const diagramKeyFilename = view.key + '-key.svg' 103 | 104 | var svgForDiagram = await page.evaluate(() => { 105 | return structurizr.scripting.exportCurrentDiagramToSVG({ includeMetadata: true }); 106 | }); 107 | 108 | console.log(" - " + diagramFilename); 109 | fs.writeFile(diagramFilename, svgForDiagram, function (err) { 110 | if (err) throw err; 111 | }); 112 | actualNumberOfExports++; 113 | 114 | if (view.type !== IMAGE_VIEW_TYPE) { 115 | var svgForKey = await page.evaluate(() => { 116 | return structurizr.scripting.exportCurrentDiagramKeyToSVG(); 117 | }); 118 | 119 | console.log(" - " + diagramKeyFilename); 120 | fs.writeFile(diagramKeyFilename, svgForKey, function (err) { 121 | if (err) throw err; 122 | }); 123 | actualNumberOfExports++; 124 | } 125 | 126 | if (actualNumberOfExports === expectedNumberOfExports) { 127 | console.log(" - Finished"); 128 | browser.close(); 129 | } 130 | } else { 131 | const diagramFilename = view.key + '.png'; 132 | const diagramKeyFilename = view.key + '-key.png' 133 | 134 | page.evaluate((diagramFilename) => { 135 | structurizr.scripting.exportCurrentDiagramToPNG({ includeMetadata: true, crop: false }, function(png) { 136 | window.savePNG(png, diagramFilename); 137 | }) 138 | }, diagramFilename); 139 | 140 | if (view.type !== IMAGE_VIEW_TYPE) { 141 | page.evaluate((diagramKeyFilename) => { 142 | structurizr.scripting.exportCurrentDiagramKeyToPNG(function(png) { 143 | window.savePNG(png, diagramKeyFilename); 144 | }) 145 | }, diagramKeyFilename); 146 | } 147 | } 148 | } 149 | 150 | })(); -------------------------------------------------------------------------------- /export-documentation.js: -------------------------------------------------------------------------------- 1 | const puppeteer = require('puppeteer'); 2 | const fs = require('fs'); 3 | 4 | const IGNORE_HTTPS_ERRORS = true; 5 | const HEADLESS = true; 6 | 7 | if (process.argv.length < 3) { 8 | console.log("Usage: [username] [password]") 9 | process.exit(1); 10 | } 11 | 12 | const url = process.argv[2]; 13 | 14 | var username; 15 | var password; 16 | 17 | if (process.argv.length > 2) { 18 | username = process.argv[3]; 19 | password = process.argv[4]; 20 | } 21 | 22 | (async () => { 23 | const browser = await puppeteer.launch({ignoreHTTPSErrors: IGNORE_HTTPS_ERRORS, headless: HEADLESS}); 24 | const page = await browser.newPage(); 25 | 26 | if (username !== undefined && password !== undefined) { 27 | // sign in 28 | const parts = url.split('://'); 29 | const signinUrl = parts[0] + '://' + parts[1].substring(0, parts[1].indexOf('/')) + '/dashboard'; 30 | console.log(' - Signing in via ' + signinUrl); 31 | 32 | await page.goto(signinUrl, { waitUntil: 'networkidle2' }); 33 | await page.type('#username', username); 34 | await page.type('#password', password); 35 | await page.keyboard.press('Enter'); 36 | await page.waitForSelector('div#dashboard'); 37 | } 38 | 39 | // visit the documentation page 40 | console.log(" - Opening " + url); 41 | await page.goto(url, { waitUntil: 'domcontentloaded' }); 42 | await page.waitForFunction('structurizr.scripting && structurizr.scripting.isDocumentationRendered() === true'); 43 | 44 | await page.exposeFunction('saveHtml', (content) => { 45 | const filename = 'documentation.html'; 46 | console.log(" - Writing " + filename); 47 | fs.writeFile(filename, content, 'utf8', function (err) { 48 | if (err) throw err; 49 | }); 50 | 51 | console.log(" - Finished"); 52 | browser.close(); 53 | }); 54 | 55 | await page.evaluate(() => { 56 | return structurizr.scripting.exportDocumentationToOfflineHtmlPage(function(html) { 57 | saveHtml(html); 58 | }); 59 | }); 60 | 61 | })(); --------------------------------------------------------------------------------