├── .gitignore ├── LICENSE ├── README.md ├── lib ├── index.es.js └── index.js ├── package-lock.json └── package.json /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | package-lock.json 3 | -------------------------------------------------------------------------------- /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 | # pouchdb-svelte 2 | 3 | PouchDB-Svelte is a PouchDB adaptation for Svelte Rollup. 4 | 5 | ## Usage 6 | 7 | ```bash 8 | npm i pouchdb-svelte 9 | npm i -D rollup-plugin-node-polyfills 10 | ``` 11 | ### Svelte 12 | ```js 13 | // rollup.config.js 14 | 15 | import nodePolyfills from 'rollup-plugin-node-polyfills'; 16 | 17 | export default { 18 | plugins: [ 19 | nodePolyfills(), 20 | ... 21 | ] 22 | } 23 | ``` 24 | 25 | ```js 26 | import PouchDB from 'pouchdb-svelte'; 27 | 28 | const testDB = new PouchDB('test'); 29 | ``` 30 | 31 | ### Sapper 32 | ```js 33 | // rollup.config.js 34 | 35 | import nodePolyfills from 'rollup-plugin-node-polyfills'; 36 | 37 | export default { 38 | client: { 39 | plugins: [ 40 | nodePolyfills(), 41 | ... 42 | ] 43 | } 44 | } 45 | 46 | //not in the server nor in the serviceworker 47 | ``` 48 | ```js 49 | import PouchDB from 'pouchdb-svelte'; 50 | 51 | (() => { 52 | if(typeof process !== 'undefined') return; // stops the Sapper SSR 53 | const testDB = new PouchDB('test'); 54 | })(); 55 | ``` 56 | 57 | >Notes: 58 | >- You can put this script in any .svelte file in your app. 59 | >- It is really important to block [Sapper SSR](https://sapper.svelte.dev/docs#Making_a_component_SSR_compatible) in this script. Because SSR will try to run pouchdb-svelte (pouchdb-browser) and attempt to create the LevelDB database on the server. 60 | This is not a good thing for two reasons: 61 | >1. The LevelDB adapter is not present in the [pouchdb-browser](https://pouchdb.com/custom.html) vanilla. 62 | >2. If you want to run a LevelDB database on your server (polka / express), it is better to use [pouchdb or pouchdb-node](https://pouchdb.com/custom.html). 63 | > 64 | >**You could use pouchdb-svelte for the Front and [pouchdb](https://www.npmjs.com/package/pouchdb) for the Back.** 65 | ___ 66 | 67 | ### Why don't use onMount ? 68 | 69 | Example: 70 | We have two .svelte files. 71 | - parent.svelte 72 | - Child.svelte 73 | 74 | Child.svelte is a component of parent.svelte.
75 | In these two files there is an onMount function. 76 | 77 | The svelte runtime will trigger Child.svelte onMount at the first time, then parent.svelte onMount at the second time.
78 | This is a problem if you create a pouchdb instance in parent.svelte and if you want to use it in Child.svelte. 79 | 80 | With pouchdb-svelte you don't have to use onMount and so you can create a single instance that can be passed to components. 81 | 82 | ### API PouchDB 83 | For full API documentation and guides on PouchDB, see [PouchDB.com](http://pouchdb.com/). -------------------------------------------------------------------------------- /package-lock.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "pouchdb-svelte", 3 | "version": "7.2.2-alpha0.0.7", 4 | "lockfileVersion": 1, 5 | "requires": true, 6 | "dependencies": { 7 | "argsarray": { 8 | "version": "0.0.1", 9 | "resolved": "https://registry.npmjs.org/argsarray/-/argsarray-0.0.1.tgz", 10 | "integrity": "sha1-bnIHtOzbObCviDA/pa4ivajfYcs=" 11 | }, 12 | "immediate": { 13 | "version": "3.3.0", 14 | "resolved": "https://registry.npmjs.org/immediate/-/immediate-3.3.0.tgz", 15 | "integrity": "sha512-HR7EVodfFUdQCTIeySw+WDRFJlPcLOJbXfwwZ7Oom6tjsvZ3bOkCDJHehQC3nxJrv7+f9XecwazynjU8e4Vw3Q==" 16 | }, 17 | "inherits": { 18 | "version": "2.0.4", 19 | "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz", 20 | "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==" 21 | }, 22 | "node-fetch": { 23 | "version": "2.6.0", 24 | "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.0.tgz", 25 | "integrity": "sha512-8dG4H5ujfvFiqDmVu9fQ5bOHUC15JMjMY/Zumv26oOvvVJjM67KF8koCWIabKQ1GJIa9r2mMZscBq/TbdOcmNA==" 26 | }, 27 | "spark-md5": { 28 | "version": "3.0.1", 29 | "resolved": "https://registry.npmjs.org/spark-md5/-/spark-md5-3.0.1.tgz", 30 | "integrity": "sha512-0tF3AGSD1ppQeuffsLDIOWlKUd3lS92tFxcsrh5Pe3ZphhnoK+oXIBTzOAThZCiuINZLvpiLH/1VS1/ANEJVig==" 31 | }, 32 | "uuid": { 33 | "version": "3.4.0", 34 | "resolved": "https://registry.npmjs.org/uuid/-/uuid-3.4.0.tgz", 35 | "integrity": "sha512-HjSDRw6gZE5JMggctHBcjVak08+KEVhSIiDzFnT9S9aegmp85S/bReBVTb4QTFaRNptJ9kuYaNhnbNEOkbKb/A==" 36 | }, 37 | "vuvuzela": { 38 | "version": "1.0.3", 39 | "resolved": "https://registry.npmjs.org/vuvuzela/-/vuvuzela-1.0.3.tgz", 40 | "integrity": "sha1-O+FF5YJxxzylUnndhR8SpoIRSws=" 41 | } 42 | } 43 | } 44 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "author": { 3 | "name": "Dale Harvey", 4 | "email": "dale@arandomurl.com" 5 | }, 6 | "bundleDependencies": false, 7 | "dependencies": { 8 | "argsarray": "^0.0.1", 9 | "immediate": "git+https://github.com/axel-recolet/immediate.git", 10 | "inherits": "^2.0.4", 11 | "node-fetch": "^2.6.0", 12 | "spark-md5": "^3.0.0", 13 | "uuid": "^3.3.3", 14 | "vuvuzela": "^1.0.3" 15 | }, 16 | "deprecated": false, 17 | "description": "PouchDB-Svelte is a PouchDB adaptation for Svelte Rollup.", 18 | "jsnext:main": "./lib/index.es.js", 19 | "keywords": [ 20 | "db", 21 | "couchdb", 22 | "pouchdb", 23 | "sapper", 24 | "svelte", 25 | "rollup" 26 | ], 27 | "license": "Apache-2.0", 28 | "main": "./lib/index.js", 29 | "module": "./lib/index.es.js", 30 | "name": "pouchdb-svelte", 31 | "tags": [ 32 | "db", 33 | "couchdb", 34 | "pouchdb", 35 | "sapper", 36 | "rollup" 37 | ], 38 | "version": "7.2.2-alpha0.0.1", 39 | "devDependencies": {}, 40 | "repository": { 41 | "type": "git", 42 | "url": "https://github.com/axel-recolet/pouchdb-svelte.git" 43 | }, 44 | "bugs": { 45 | "url": "https://github.com/axel-recolet/pouchdb-svlete/issues", 46 | "email": "axel.recolet@outlook.fr" 47 | } 48 | } 49 | --------------------------------------------------------------------------------