├── .babelrc ├── .eslintrc ├── .github ├── FUNDING.yml └── workflows │ └── build_and_test.yml ├── .gitignore ├── .husky ├── .gitignore └── pre-commit ├── .prettierignore ├── LICENSE ├── README.md ├── package.json ├── pnpm-lock.yaml └── src ├── single-spa-svelte.js └── single-spa-svelte.test.js /.babelrc: -------------------------------------------------------------------------------- 1 | { 2 | "presets": ["@babel/preset-env"], 3 | "env": { 4 | "test": { 5 | "presets": [ 6 | [ 7 | "@babel/preset-env", 8 | { 9 | "targets": { 10 | "node": "current" 11 | } 12 | } 13 | ] 14 | ] 15 | } 16 | } 17 | } 18 | -------------------------------------------------------------------------------- /.eslintrc: -------------------------------------------------------------------------------- 1 | { 2 | "extends": ["important-stuff"], 3 | "parser": "@babel/eslint-parser" 4 | } 5 | -------------------------------------------------------------------------------- /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | 3 | github: ["joeldenning"] 4 | patreon: singlespa 5 | open_collective: # Replace with a single Open Collective username 6 | ko_fi: # Replace with a single Ko-fi username 7 | tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel 8 | community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry 9 | liberapay: # Replace with a single Liberapay username 10 | issuehunt: # Replace with a single IssueHunt username 11 | otechie: # Replace with a single Otechie username 12 | custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] 13 | -------------------------------------------------------------------------------- /.github/workflows/build_and_test.yml: -------------------------------------------------------------------------------- 1 | name: Build and test 2 | 3 | on: 4 | - push 5 | - pull_request 6 | 7 | jobs: 8 | build: 9 | runs-on: ubuntu-latest 10 | 11 | steps: 12 | - uses: actions/checkout@v2 13 | - uses: actions/setup-node@v2 14 | with: 15 | node-version: "16" 16 | - uses: pnpm/action-setup@v2.0.1 17 | with: 18 | version: 6.2.5 19 | - run: pnpm install --frozen-lockfile 20 | - run: pnpm test 21 | - run: pnpm run lint 22 | - run: pnpm run check-format 23 | - run: pnpm run build 24 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | 6 | # Runtime data 7 | pids 8 | *.pid 9 | *.seed 10 | 11 | # Directory for instrumented libs generated by jscoverage/JSCover 12 | lib-cov 13 | 14 | # Coverage directory used by tools like istanbul 15 | coverage 16 | 17 | # nyc test coverage 18 | .nyc_output 19 | 20 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 21 | .grunt 22 | 23 | # node-waf configuration 24 | .lock-wscript 25 | 26 | # Compiled binary addons (http://nodejs.org/api/addons.html) 27 | build/Release 28 | 29 | # Dependency directories 30 | node_modules 31 | jspm_packages 32 | 33 | # Optional npm cache directory 34 | .npm 35 | 36 | # Optional REPL history 37 | .node_repl_history 38 | lib 39 | 40 | -------------------------------------------------------------------------------- /.husky/.gitignore: -------------------------------------------------------------------------------- 1 | _ 2 | -------------------------------------------------------------------------------- /.husky/pre-commit: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | . "$(dirname "$0")/_/husky.sh" 3 | 4 | pnpx pretty-quick --staged && pnpx lint 5 | -------------------------------------------------------------------------------- /.prettierignore: -------------------------------------------------------------------------------- 1 | .gitignore 2 | lib 3 | LICENSE 4 | yarn.lock 5 | .prettierignore 6 | pnpm-lock.yaml -------------------------------------------------------------------------------- /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 | # single-spa-svelte 2 | 3 | Generic lifecycle hooks for Svelte projects that are registered as [single-spa](https://single-spa.js.org) applications. 4 | 5 | [Full documentation](https://single-spa.js.org/docs/ecosystem-svelte.html) 6 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "single-spa-svelte", 3 | "version": "2.1.1", 4 | "description": "a single-spa plugin for svelte applications", 5 | "main": "lib/single-spa-svelte.js", 6 | "scripts": { 7 | "build": "rimraf lib && babel src/single-spa-svelte.js --out-file lib/single-spa-svelte.js --source-maps", 8 | "test": "cross-env BABEL_ENV=test jest", 9 | "lint": "eslint src", 10 | "format": "prettier --write .", 11 | "check-format": "prettier --check .", 12 | "prepublishOnly": "pnpm run build", 13 | "prepare": "husky install" 14 | }, 15 | "files": [ 16 | "lib", 17 | "src" 18 | ], 19 | "repository": { 20 | "type": "git", 21 | "url": "git+https://github.com/single-spa/single-spa-svelte.git" 22 | }, 23 | "keywords": [ 24 | "single-spa", 25 | "svelte", 26 | "microservices" 27 | ], 28 | "author": "Bret Little", 29 | "license": "Apache-2.0", 30 | "bugs": { 31 | "url": "https://github.com/single-spa/single-spa-svelte/issues" 32 | }, 33 | "homepage": "https://github.com/single-spa/single-spa-svelte#readme", 34 | "devDependencies": { 35 | "@babel/cli": "^7.13.16", 36 | "@babel/core": "^7.14.2", 37 | "@babel/eslint-parser": "^7.14.2", 38 | "@babel/preset-env": "^7.14.2", 39 | "@types/jest": "^26.0.23", 40 | "babel-jest": "^26.6.3", 41 | "cross-env": "^7.0.3", 42 | "eslint": "^7.26.0", 43 | "eslint-config-important-stuff": "^1.1.0", 44 | "husky": "^6.0.0", 45 | "jest": "^26.6.3", 46 | "jest-cli": "^26.6.3", 47 | "prettier": "^2.3.0", 48 | "pretty-quick": "^3.1.0", 49 | "rimraf": "^3.0.2" 50 | } 51 | } 52 | -------------------------------------------------------------------------------- /src/single-spa-svelte.js: -------------------------------------------------------------------------------- 1 | const defaultOpts = { 2 | // required opts 3 | component: null, 4 | 5 | // optional opts 6 | domElementGetter: null, 7 | props: {}, 8 | }; 9 | 10 | export default function singleSpaSvelte(userOpts) { 11 | if (typeof userOpts !== "object") { 12 | throw new Error(`single-spa-svelte requires a configuration object`); 13 | } 14 | 15 | const opts = { 16 | ...defaultOpts, 17 | ...userOpts, 18 | }; 19 | 20 | if (!opts.component) { 21 | throw new Error("single-spa-svelte must be passed opts.component"); 22 | } 23 | 24 | // Just a shared object to store the mounted object state 25 | let mountedInstances = {}; 26 | 27 | return { 28 | bootstrap: bootstrap.bind(null, opts, mountedInstances), 29 | mount: mount.bind(null, opts, mountedInstances), 30 | unmount: unmount.bind(null, opts, mountedInstances), 31 | update: update.bind(null, opts, mountedInstances), 32 | }; 33 | } 34 | 35 | function bootstrap(opts) { 36 | return Promise.resolve(); 37 | } 38 | 39 | function mount(opts, mountedInstances, singleSpaProps) { 40 | const defaultOptKeys = Object.keys(defaultOpts); 41 | 42 | const svelteOpts = Object.keys(opts).reduce((object, key) => { 43 | if (!defaultOptKeys.includes(key)) { 44 | object[key] = opts[key]; 45 | } 46 | return object; 47 | }, {}); 48 | 49 | return Promise.resolve().then(() => { 50 | const domElementGetter = chooseDomElementGetter(opts, singleSpaProps); 51 | const domElement = domElementGetter(); 52 | // See https://svelte.dev/docs#Creating_a_component 53 | mountedInstances.instance = new opts.component({ 54 | ...svelteOpts, 55 | target: domElement, 56 | props: Object.assign({}, singleSpaProps, opts.props), 57 | }); 58 | }); 59 | } 60 | 61 | function unmount(opts, mountedInstances) { 62 | return Promise.resolve().then(() => { 63 | mountedInstances.instance.$destroy 64 | ? mountedInstances.instance.$destroy() 65 | : mountedInstances.instance.destroy(); 66 | }); 67 | } 68 | 69 | function update(opts, mountedInstances, props) { 70 | return Promise.resolve().then(() => { 71 | mountedInstances.instance.$set 72 | ? mountedInstances.instance.$set(props) 73 | : mountedInstances.instance.set(props); 74 | }); 75 | } 76 | 77 | function chooseDomElementGetter(opts, props) { 78 | props = props && props.customProps ? props.customProps : props; 79 | if (props.domElement) { 80 | return () => props.domElement; 81 | } else if (props.domElementGetter) { 82 | return () => props.domElementGetter(props); 83 | } else if (opts.domElementGetter) { 84 | return () => opts.domElementGetter(props); 85 | } else { 86 | return defaultDomElementGetter(props); 87 | } 88 | } 89 | 90 | function defaultDomElementGetter(props) { 91 | const appName = props.appName || props.name; 92 | if (!appName) { 93 | throw Error( 94 | `single-spa-svelte was not given an application name as a prop, so it can't make a unique dom element container for the svelte application` 95 | ); 96 | } 97 | const htmlId = `single-spa-application:${appName}`; 98 | 99 | return function defaultDomEl() { 100 | let domElement = document.getElementById(htmlId); 101 | if (!domElement) { 102 | domElement = document.createElement("div"); 103 | domElement.id = htmlId; 104 | document.body.appendChild(domElement); 105 | } 106 | 107 | return domElement; 108 | }; 109 | } 110 | -------------------------------------------------------------------------------- /src/single-spa-svelte.test.js: -------------------------------------------------------------------------------- 1 | import singleSpaSvelte from "./single-spa-svelte"; 2 | 3 | describe(`single-spa-svelte`, () => { 4 | it("can bootstrap, mount, and unmount a svelte application", async () => { 5 | const component = jest.fn(); 6 | const domElementGetter = ({ name }) => { 7 | const domElement = document.createElement("div"); 8 | domElement.id = `single-spa-application:${name}`; 9 | domElement.dataset.testId = name; 10 | 11 | return domElement; 12 | }; 13 | let props = { 14 | name: "app1", 15 | foo: "bar", 16 | domElementGetter, 17 | }; 18 | const $set = jest.fn( 19 | (newProps) => (props = Object.assign({}, props, newProps)) 20 | ); 21 | const $destroy = jest.fn(); 22 | component.mockImplementationOnce(function () { 23 | this.$set = $set; 24 | this.$destroy = $destroy; 25 | }); 26 | const lifecycles = singleSpaSvelte({ 27 | component, 28 | props: { 29 | thing: "value", 30 | }, 31 | }); 32 | expect(component).not.toHaveBeenCalled(); 33 | expect($destroy).not.toHaveBeenCalled(); 34 | await lifecycles.bootstrap(props); 35 | expect(component).not.toHaveBeenCalled(); 36 | expect($destroy).not.toHaveBeenCalled(); 37 | await lifecycles.mount(props); 38 | expect(component).toHaveBeenCalled(); 39 | expect($destroy).not.toHaveBeenCalled(); 40 | const call = component.mock.calls[0][0]; 41 | expect(call.target.dataset.testId).toEqual(props.name); 42 | expect(call.props).toEqual({ ...props, thing: "value" }); 43 | expect($destroy).not.toHaveBeenCalled(); 44 | await lifecycles.update({ foo: "notbar" }); 45 | expect($destroy).not.toHaveBeenCalled(); 46 | expect($set).toHaveBeenCalled(); 47 | expect(props.foo).toEqual("notbar"); 48 | await lifecycles.unmount(); 49 | expect($destroy).toHaveBeenCalled(); 50 | }); 51 | }); 52 | --------------------------------------------------------------------------------