[ { "path": ".github/FUNDING.yml", "content": "github: dfahlander\n" }, { "path": ".github/workflows/dexie-cloud-common.yml", "content": "name: dexie-cloud-common Tests\n\non:\n workflow_dispatch:\n push:\n branches:\n - master\n paths:\n - 'libs/dexie-cloud-common/**'\n - '.github/workflows/dexie-cloud-common.yml'\n pull_request:\n types: [opened, synchronize, reopened]\n paths:\n - 'libs/dexie-cloud-common/**'\n - '.github/workflows/dexie-cloud-common.yml'\n\njobs:\n test:\n runs-on: ubuntu-latest\n steps:\n - name: Checkout code\n uses: actions/checkout@v3\n\n - name: Set up pnpm\n uses: pnpm/action-setup@v2\n with:\n version: 9\n\n - name: Set up Node.js\n uses: actions/setup-node@v3\n with:\n node-version: 18\n cache: \"pnpm\"\n\n - name: Install dependencies\n run: pnpm install --no-frozen-lockfile\n\n - name: Build dexie-cloud-common\n run: pnpm --filter dexie-cloud-common run build\n\n - name: Run tests\n run: pnpm --filter dexie-cloud-common test\n" }, { "path": ".github/workflows/main.yml", "content": "name: Build and Test\n\non:\n workflow_dispatch:\n push:\n branches:\n - master # Add also master-4 when dexie@4 is stable and master will represent dexie@5. dexie@3 has its own workflow.\n pull_request:\n types: [opened, synchronize, reopened]\nenv:\n LAMBDATEST: \"true\"\n GH_ACTIONS: \"true\"\n LT_USERNAME: ${{ secrets.LT_USERNAME }}\n LT_ACCESS_KEY: ${{ secrets.LT_ACCESS_KEY }}\n\njobs:\n test:\n runs-on: ubuntu-latest\n strategy:\n matrix:\n TF:\n - test\n - addons/Dexie.Observable/test\n - addons/Dexie.Syncable/test\n - addons/dexie-export-import/test\n - addons/y-dexie/test\n - libs/dexie-react-hooks/test\n fail-fast: true # If one test fails, abort the rest of the tests\n max-parallel: 6 # At least for browserstack, this seems to be needed to avoid timeouts\n steps:\n - name: Checkout code\n uses: actions/checkout@v3\n - name: Set up pnpm\n uses: pnpm/action-setup@v2\n with:\n version: 9\n - name: Set up Node.js\n uses: actions/setup-node@v3\n with:\n node-version: 18\n cache: \"pnpm\"\n - name: Install dependencies\n run: pnpm install --no-frozen-lockfile\n - name: Build\n run: pnpm run build\n - name: Set LT_TUNNEL_NAME\n run: echo \"LT_TUNNEL_NAME=${{ matrix.TF }}-${{ github.run_id }}-${{ github.run_attempt }}\" >> $GITHUB_ENV\n - name: Run headless test\n uses: coactions/setup-xvfb@v1\n with:\n run: bash -e ./gh-actions.sh\n working-directory: ${{ matrix.TF }}\n" }, { "path": ".gitignore", "content": "# Ignore node_modules\nnode_modules/\n\n# Ignore all build output\ndist/*.js\ndist/*.map\ndist/*.ts\ndist/*.gz\ndist/*.mjs\ndist/**/*.js\ndist/**/*.map\ndist/**/*.ts\ndist/**/*.gz\ndist/**/*.mjs\n\n# Other ignores\ntmp/\n.idea/\n.eslintcache\n\n## Ignore Visual Studio temporary files, build results, and\n## files generated by popular Visual Studio add-ons.\n\n# User-specific files\n*.suo\n*.user\n*.sln.docstates\n\n# Build results\n\n[Dd]ebug/\n[Rr]elease/\nx64/\n[Bb]in/\n[Oo]bj/\n\n# Enable \"build/\" folder in the NuGet Packages folder since NuGet packages use it for MSBuild targets\n!packages/*/build/\n\n# MSTest test Results\n[Tt]est[Rr]esult*/\n[Bb]uild[Ll]og.*\n\n*_i.c\n*_p.c\n*.ilk\n*.meta\n*.obj\n*.pch\n*.pdb\n*.pgc\n*.pgd\n*.rsp\n*.sbr\n*.tlb\n*.tli\n*.tlh\n*.tmp\n*.tmp_proj\n*.log\n*.vspscc\n*.vssscc\n.builds\n*.pidb\n*.log\n*.scc\n\n# Visual C++ cache files\nipch/\n*.aps\n*.ncb\n*.opensdf\n*.sdf\n*.cachefile\n\n# Visual Studio profiler\n*.psess\n*.vsp\n*.vspx\n\n# Guidance Automation Toolkit\n*.gpState\n\n# ReSharper is a .NET coding add-in\n_ReSharper*/\n*.[Rr]e[Ss]harper\n\n# TeamCity is a build add-in\n_TeamCity*\n\n# DotCover is a Code Coverage Tool\n*.dotCover\n\n# NCrunch\n*.ncrunch*\n.*crunch*.local.xml\n\n# Installshield output folder\n[Ee]xpress/\n\n# DocProject is a documentation generator add-in\nDocProject/buildhelp/\nDocProject/Help/*.HxT\nDocProject/Help/*.HxC\nDocProject/Help/*.hhc\nDocProject/Help/*.hhk\nDocProject/Help/*.hhp\nDocProject/Help/Html2\nDocProject/Help/html\n\n# Click-Once directory\npublish/\n\n# Publish Web Output\n*.Publish.xml\n*.pubxml\n\n# NuGet Packages Directory\n## TODO: If you have NuGet Package Restore enabled, uncomment the next line\n#packages/\n\n# Windows Azure Build Output\ncsx\n*.build.csdef\n\n# Windows Store app package directory\nAppPackages/\n\n# Others\nsql/\n*.Cache\nClientBin/\n[Ss]tyle[Cc]op.*\n~$*\n*~\n*.dbmdl\n*.[Pp]ublish.xml\n*.pfx\n*.publishsettings\n\n# RIA/Silverlight projects\nGenerated_Code/\n\n# Backup & report files from converting an old project file to a newer\n# Visual Studio version. Backup files are not needed, because we have git ;-)\n_UpgradeReport_Files/\nBackup*/\nUpgradeLog*.XML\nUpgradeLog*.htm\n\n# SQL Server files\nApp_Data/*.mdf\nApp_Data/*.ldf\n\n# =========================\n# Windows detritus\n# =========================\n\n# Windows image file caches\nThumbs.db\nehthumbs.db\n\n# Folder config file\nDesktop.ini\n\n# Recycle Bin used on file shares\n$RECYCLE.BIN/\n\n# Mac crap\n.DS_Store\n\n*.csproj\nDexie.sln\nsamples/typescript/appdb.js\nsamples/typescript/app.js\nsamples/typescript/app.js.map\nsamples/typescript/appdb.js.map\nsamples/typescript/console.js\nsamples/typescript/console.js.map\nsamples/typescript/utils.js\nsamples/typescript/utils.js.map\n/.vscode\n/jsconfig.json\n\n/.ntvs_analysis.dat\n/*.njsproj\nlibs/dexie-cloud-common/tsconfig.tsbuildinfo\n\n#lambdatest tunnel binary\n.lambdatest\ntunnel.pid\n" }, { "path": ".npmignore", "content": "**/tmp/\nsamples/\naddons/\nlibs/\n*.njsproj\n.*\n*.log\ntest/\ntools/\nbower.json\nsrc/\n.lambdatest\ntunnel.pid\ntsconfig.json\npnpm-workspace.yaml\n" }, { "path": ".npmrc", "content": "auto-install-peers=true\n" }, { "path": ".prettierrc", "content": "{\n \"trailingComma\": \"es5\",\n \"tabWidth\": 2,\n \"singleQuote\": true\n}\n" }, { "path": ".prettierrc.yml", "content": "trailingComma: 'none'\ntabWidth: 2\nsemi: true\nsingleQuote: true\n" }, { "path": "CODE_OF_CONDUCT.md", "content": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at code@dexie.org. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" }, { "path": "CONTRIBUTING.md", "content": "HOW TO CONTRIBUTE\n=================\n\nWe appreciate contributions in forms of:\n\n* issues\n* help answering questions in [issues](https://github.com/dexie/Dexie.js/issues) and on [stackoverflow](https://stackexchange.com/filters/233583/dexie-stackoverflow)\n* fixing bugs via pull-requests\n* developing addons or other [derived work](https://dexie.org/docs/DerivedWork)\n* promoting Dexie.js\n* sharing ideas\n\nContribute while developing your own app\n========================================\n\nDexie uses pnpm package manager. Refer to [pnpm.io/installation](https://pnpm.io/installation) for how to install pnpm.\n\nHere is a little cheat-sheet for how to symlink your app's `node_modules/dexie` to a place where you can edit the source, version control your changes and create pull requests back to Dexie. Assuming you've already ran `npm install dexie` for the app your are developing.\n\n1. Fork Dexie.js from the web gui on github\n2. Clone your fork locally by launching a shell/command window and cd to a neutral place (like `~repos/`, `c:\\repos` or whatever)\n3. Run the following commands:\n\n ```\n git clone https://github.com/YOUR-USERNAME/Dexie.js.git dexie\n cd dexie\n pnpm install\n pnpm run build\n npm link # Or yarn link or pnpm link --global depending on what package manager you are using.\n ```\n3. cd to your app directory and write:\n ```\n npm link dexie # Or yarn link dexie / pnpm link dexie depending on your package manager.\n ```\n\nYour app's `node_modules/dexie/` is now sym-linked to the Dexie.js clone on your hard drive so any change you do there will propagate to your app. Build dexie.js using `pnpm run build` or `pnpm run watch`. The latter will react on any source file change and rebuild the dist files.\n\nThat's it. Now you're up and running to test and commit changes to files under dexie/src/* or dexie/test/* and the changes will instantly affect the app you are developing.\n\nIf you're on yarn or pnpm, do the same procedures using yarn link / pnpm link.\n\nPull requests are more than welcome. Some advices are:\n\n* Run pnpm test before making a pull request.\n* If you find an issue, a unit test that reproduces it is lovely ;). If you don't know where to put it, put it in `test/tests-misc.js`. We use qunit. Just look at existing tests in `tests-misc.js` to see how they should be written. Tests are transpiled in the build script so you can use ES6 if you like.\n\nBuild\n-----\n```\n# To install pnpm, see https://pnpm.io/installation\npnpm install\npnpm run build\n```\n\nTest\n----\n```\npnpm test\n```\n\nWatch\n-----\n```\npnpm run watch\n```\n" }, { "path": "LICENSE", "content": "Apache License\n Version 2.0, January 2004\n http://www.apache.org/licenses/\n\n TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n\n 1. Definitions.\n\n \"License\" shall mean the terms and conditions for use, reproduction,\n and distribution as defined by Sections 1 through 9 of this document.\n\n \"Licensor\" shall mean the copyright owner or entity authorized by\n the copyright owner that is granting the License.\n\n \"Legal Entity\" shall mean the union of the acting entity and all\n other entities that control, are controlled by, or are under common\n control with that entity. For the purposes of this definition,\n \"control\" means (i) the power, direct or indirect, to cause the\n direction or management of such entity, whether by contract or\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\n outstanding shares, or (iii) beneficial ownership of such entity.\n\n \"You\" (or \"Your\") shall mean an individual or Legal Entity\n exercising permissions granted by this License.\n\n \"Source\" form shall mean the preferred form for making modifications,\n including but not limited to software source code, documentation\n source, and configuration files.\n\n \"Object\" form shall mean any form resulting from mechanical\n transformation or translation of a Source form, including but\n not limited to compiled object code, generated documentation,\n and conversions to other media types.\n\n \"Work\" shall mean the work of authorship, whether in Source or\n Object form, made available under the License, as indicated by a\n copyright notice that is included in or attached to the work\n (an example is provided in the Appendix below).\n\n \"Derivative Works\" shall mean any work, whether in Source or Object\n form, that is based on (or derived from) the Work and for which the\n editorial revisions, annotations, elaborations, or other modifications\n represent, as a whole, an original work of authorship. For the purposes\n of this License, Derivative Works shall not include works that remain\n separable from, or merely link (or bind by name) to the interfaces of,\n the Work and Derivative Works thereof.\n\n \"Contribution\" shall mean any work of authorship, including\n the original version of the Work and any modifications or additions\n to that Work or Derivative Works thereof, that is intentionally\n submitted to Licensor for inclusion in the Work by the copyright owner\n or by an individual or Legal Entity authorized to submit on behalf of\n the copyright owner. For the purposes of this definition, \"submitted\"\n means any form of electronic, verbal, or written communication sent\n to the Licensor or its representatives, including but not limited to\n communication on electronic mailing lists, source code control systems,\n and issue tracking systems that are managed by, or on behalf of, the\n Licensor for the purpose of discussing and improving the Work, but\n excluding communication that is conspicuously marked or otherwise\n designated in writing by the copyright owner as \"Not a Contribution.\"\n\n \"Contributor\" shall mean Licensor and any individual or Legal Entity\n on behalf of whom a Contribution has been received by Licensor and\n subsequently incorporated within the Work.\n\n 2. Grant of Copyright License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n copyright license to reproduce, prepare Derivative Works of,\n publicly display, publicly perform, sublicense, and distribute the\n Work and such Derivative Works in Source or Object form.\n\n 3. Grant of Patent License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n (except as stated in this section) patent license to make, have made,\n use, offer to sell, sell, import, and otherwise transfer the Work,\n where such license applies only to those patent claims licensable\n by such Contributor that are necessarily infringed by their\n Contribution(s) alone or by combination of their Contribution(s)\n with the Work to which such Contribution(s) was submitted. If You\n institute patent litigation against any entity (including a\n cross-claim or counterclaim in a lawsuit) alleging that the Work\n or a Contribution incorporated within the Work constitutes direct\n or contributory patent infringement, then any patent licenses\n granted to You under this License for that Work shall terminate\n as of the date such litigation is filed.\n\n 4. Redistribution. You may reproduce and distribute copies of the\n Work or Derivative Works thereof in any medium, with or without\n modifications, and in Source or Object form, provided that You\n meet the following conditions:\n\n (a) You must give any other recipients of the Work or\n Derivative Works a copy of this License; and\n\n (b) You must cause any modified files to carry prominent notices\n stating that You changed the files; and\n\n (c) You must retain, in the Source form of any Derivative Works\n that You distribute, all copyright, patent, trademark, and\n attribution notices from the Source form of the Work,\n excluding those notices that do not pertain to any part of\n the Derivative Works; and\n\n (d) If the Work includes a \"NOTICE\" text file as part of its\n distribution, then any Derivative Works that You distribute must\n include a readable copy of the attribution notices contained\n within such NOTICE file, excluding those notices that do not\n pertain to any part of the Derivative Works, in at least one\n of the following places: within a NOTICE text file distributed\n as part of the Derivative Works; within the Source form or\n documentation, if provided along with the Derivative Works; or,\n within a display generated by the Derivative Works, if and\n wherever such third-party notices normally appear. The contents\n of the NOTICE file are for informational purposes only and\n do not modify the License. You may add Your own attribution\n notices within Derivative Works that You distribute, alongside\n or as an addendum to the NOTICE text from the Work, provided\n that such additional attribution notices cannot be construed\n as modifying the License.\n\n You may add Your own copyright statement to Your modifications and\n may provide additional or different license terms and conditions\n for use, reproduction, or distribution of Your modifications, or\n for any such Derivative Works as a whole, provided Your use,\n reproduction, and distribution of the Work otherwise complies with\n the conditions stated in this License.\n\n 5. Submission of Contributions. Unless You explicitly state otherwise,\n any Contribution intentionally submitted for inclusion in the Work\n by You to the Licensor shall be under the terms and conditions of\n this License, without any additional terms or conditions.\n Notwithstanding the above, nothing herein shall supersede or modify\n the terms of any separate license agreement you may have executed\n with Licensor regarding such Contributions.\n\n 6. Trademarks. This License does not grant permission to use the trade\n names, trademarks, service marks, or product names of the Licensor,\n except as required for reasonable and customary use in describing the\n origin of the Work and reproducing the content of the NOTICE file.\n\n 7. Disclaimer of Warranty. Unless required by applicable law or\n agreed to in writing, Licensor provides the Work (and each\n Contributor provides its Contributions) on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n implied, including, without limitation, any warranties or conditions\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n PARTICULAR PURPOSE. You are solely responsible for determining the\n appropriateness of using or redistributing the Work and assume any\n risks associated with Your exercise of permissions under this License.\n\n 8. Limitation of Liability. In no event and under no legal theory,\n whether in tort (including negligence), contract, or otherwise,\n unless required by applicable law (such as deliberate and grossly\n negligent acts) or agreed to in writing, shall any Contributor be\n liable to You for damages, including any direct, indirect, special,\n incidental, or consequential damages of any character arising as a\n result of this License or out of the use or inability to use the\n Work (including but not limited to damages for loss of goodwill,\n work stoppage, computer failure or malfunction, or any and all\n other commercial damages or losses), even if such Contributor\n has been advised of the possibility of such damages.\n\n 9. Accepting Warranty or Additional Liability. While redistributing\n the Work or Derivative Works thereof, You may choose to offer,\n and charge a fee for, acceptance of support, warranty, indemnity,\n or other liability obligations and/or rights consistent with this\n License. However, in accepting such obligations, You may act only\n on Your own behalf and on Your sole responsibility, not on behalf\n of any other Contributor, and only if You agree to indemnify,\n defend, and hold each Contributor harmless for any liability\n incurred by, or claims asserted against, such Contributor by reason\n of your accepting any such warranty or additional liability.\n\n END OF TERMS AND CONDITIONS\n\n APPENDIX: How to apply the Apache License to your work.\n\n To apply the Apache License to your work, attach the following\n boilerplate notice, with the fields enclosed by brackets \"{}\"\n replaced with your own identifying information. (Don't include\n the brackets!) The text should be enclosed in the appropriate\n comment syntax for the file format. We also recommend that a\n file or class name and description of purpose be included on the\n same \"printed page\" as the copyright notice for easier\n identification within third-party archives.\n\n Copyright {yyyy} {name of copyright owner}\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use this file except in compliance with the License.\n You may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\n Unless required by applicable law or agreed to in writing, software\n distributed under the License is distributed on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n See the License for the specific language governing permissions and\n limitations under the License.\n\n" }, { "path": "NOTICE", "content": "Dexie.js\n\nCopyright (c) 2014-2017 David Fahlander\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n" }, { "path": "README.md", "content": "# Dexie.js\n\n[![NPM Version][npm-image]][npm-url] ![Build Status](https://github.com/dexie/Dexie.js/actions/workflows/main.yml/badge.svg) [![Join our Discord](https://img.shields.io/discord/1328303736363421747?label=Discord&logo=discord&style=badge)](https://discord.gg/huhre7MHBF)\n\nDexie.js is a wrapper library for indexedDB - the standard database in the browser. https://dexie.org.\n\n#### Why Dexie.js?\n\nIndexedDB is the portable database for all browser engines. Dexie.js makes it fun and easy to work with.\n\nBut also:\n\n* Dexie.js is widely used by 100,000 of web sites, apps and other projects and supports all browsers, Electron for Desktop apps, Capacitor for iOS / Android apps and of course pure PWAs.\n* Dexie.js works around bugs in the IndexedDB implementations, giving a more stable user experience.\n* Need sync? [Dexie Cloud](https://dexie.org/cloud/) adds real-time sync, auth, and collaboration on top of Dexie.js — no backend needed.\n\n#### Hello World (vanilla JS)\n\n```html\n\n\n \n \n \n\n```\n\nYes, it's that simple. Read [the docs](https://dexie.org/docs/) to get into the details.\n\n#### Hello World (legacy script tags)\n\n```html\n\n\n \n \n \n \n\n```\n\n#### Hello World (React + Typescript)\n\nReal-world apps are often built using components in various frameworks. Here's a version of Hello World written for React and Typescript. There are also links below this sample to more tutorials for different frameworks...\n\n```tsx\nimport React from 'react';\nimport { Dexie, type EntityTable } from 'dexie';\nimport { useLiveQuery } from 'dexie-react-hooks';\n\n// Typing for your entities (hint is to move this to its own module)\nexport interface Friend {\n id: number;\n name: string;\n age: number;\n}\n\n// Database declaration (move this to its own module also)\nexport const db = new Dexie('FriendDatabase') as Dexie & {\n friends: EntityTable;\n};\ndb.version(1).stores({\n friends: '++id, age',\n});\n\n// Component:\nexport function MyDexieReactComponent() {\n const youngFriends = useLiveQuery(() =>\n db.friends\n .where('age')\n .below(30)\n .toArray()\n );\n\n return (\n <>\n

My young friends

\n \n {\n db.friends.add({ name: 'Alice', age: 21 });\n }}\n >\n Add another friend\n \n \n );\n}\n```\n\n[Tutorials for React, Svelte, Vue, Angular and vanilla JS](https://dexie.org/docs/Tutorial/Getting-started)\n\n[API Reference](https://dexie.org/docs/API-Reference)\n\n[Samples](https://dexie.org/docs/Samples)\n\n### Performance\n\nDexie has kick-ass performance. Its [bulk methods]() take advantage of a lesser-known feature in IndexedDB that makes it possible to store stuff without listening to every onsuccess event. This speeds up the performance to a maximum.\n\n#### Supported operations\n\n```js\nabove(key): Collection;\naboveOrEqual(key): Collection;\nadd(item, key?): Promise;\nand(filter: (x) => boolean): Collection;\nanyOf(keys[]): Collection;\nanyOfIgnoreCase(keys: string[]): Collection;\nbelow(key): Collection;\nbelowOrEqual(key): Collection;\nbetween(lower, upper, includeLower?, includeUpper?): Collection;\nbulkAdd(items: Array): Promise;\nbulkDelete(keys: Array): Promise;\nbulkPut(items: Array): Promise;\nclear(): Promise;\ncount(): Promise;\ndelete(key): Promise;\ndistinct(): Collection;\neach(callback: (obj) => any): Promise;\neachKey(callback: (key) => any): Promise;\neachPrimaryKey(callback: (key) => any): Promise;\neachUniqueKey(callback: (key) => any): Promise;\nequals(key): Collection;\nequalsIgnoreCase(key): Collection;\nfilter(fn: (obj) => boolean): Collection;\nfirst(): Promise;\nget(key): Promise;\ninAnyRange(ranges): Collection;\nkeys(): Promise;\nlast(): Promise;\nlimit(n: number): Collection;\nmodify(changeCallback: (obj: T, ctx:{value: T}) => void): Promise;\nmodify(changes: { [keyPath: string]: any } ): Promise;\nnoneOf(keys: Array): Collection;\nnotEqual(key): Collection;\noffset(n: number): Collection;\nor(indexOrPrimayKey: string): WhereClause;\norderBy(index: string): Collection;\nprimaryKeys(): Promise;\nput(item: T, key?: Key): Promise;\nreverse(): Collection;\nsortBy(keyPath: string): Promise;\nstartsWith(key: string): Collection;\nstartsWithAnyOf(prefixes: string[]): Collection;\nstartsWithAnyOfIgnoreCase(prefixes: string[]): Collection;\nstartsWithIgnoreCase(key: string): Collection;\ntoArray(): Promise;\ntoCollection(): Collection;\nuniqueKeys(): Promise;\nuntil(filter: (value) => boolean, includeStopEntry?: boolean): Collection;\nupdate(key: Key, changes: { [keyPath: string]: any }): Promise;\n```\n\nThis is a mix of methods from [WhereClause](https://dexie.org/docs/WhereClause/WhereClause), [Table](https://dexie.org/docs/Table/Table) and [Collection](https://dexie.org/docs/Collection/Collection). Dive into the [API reference](https://dexie.org/docs/API-Reference) to see the details.\n\n## Dexie Cloud\n\n[Dexie Cloud](https://dexie.org/cloud/) is the easiest way to add sync, authentication, and real-time collaboration to your Dexie app. You keep writing frontend code with Dexie.js — Dexie Cloud handles the rest.\n\n**What you get:**\n- 🔄 **Sync across devices** — changes propagate in real time, no polling needed\n- 🔐 **Authentication** — built-in user auth, no identity provider required\n- 🛡️ **Access control** — share data between users with fine-grained permissions\n- 📁 **File & blob storage** — store attachments alongside your structured data\n- ✈️ **Offline-first** — works fully offline, syncs when back online\n\n**Getting started is just a few lines:**\n\n```bash\nnpm install dexie-cloud-addon\n```\n\n```ts\nimport Dexie from 'dexie';\nimport dexieCloud from 'dexie-cloud-addon';\n\nconst db = new Dexie('MyDatabase', { addons: [dexieCloud] });\ndb.version(1).stores({ items: '@id, title' });\ndb.cloud.configure({ databaseUrl: 'https://.dexie.cloud' });\n```\n\nThat's it. Your existing Dexie app now syncs. Hosted cloud or self-hosted on your own infrastructure. 👋\n\n→ [Quickstart guide](https://dexie.org/cloud/docs/quickstart)\n\n**Sample app:**\n\nSource: [Dexie Cloud To-do app](https://github.com/dexie/Dexie.js/tree/master/samples/dexie-cloud-todo-app)\n\nLive demo: https://dexie.github.io/Dexie.js/dexie-cloud-todo-app/\n\n## Samples\n\nhttps://dexie.org/docs/Samples\n\nhttps://github.com/dexie/Dexie.js/tree/master/samples\n\n## Knowledge Base\n\n[https://dexie.org/docs/Questions-and-Answers](https://dexie.org/docs/Questions-and-Answers)\n\n## Website\n\n[https://dexie.org](https://dexie.org)\n\n## Install via npm\n\n```\nnpm install dexie\n```\n\n## Download\n\nFor those who don't like package managers, here's the download links:\n\n### UMD (for legacy script includes as well as commonjs require):\n\nhttps://unpkg.com/dexie@latest/dist/dexie.min.js\n\nhttps://unpkg.com/dexie@latest/dist/dexie.min.js.map\n\n### Modern (ES module):\n\nhttps://unpkg.com/dexie@latest/dist/modern/dexie.min.mjs\n\nhttps://unpkg.com/dexie@latest/dist/modern/dexie.min.mjs.map\n\n### Typings:\n\nhttps://unpkg.com/dexie@latest/dist/dexie.d.ts\n\n# Contributing\n\nSee [CONTRIBUTING.md](CONTRIBUTING.md)\n\n## Build\n\n```\npnpm install\npnpm run build\n```\n\n## Test\n\n```\npnpm test\n```\n\n## Watch\n\n```\npnpm run watch\n```\n\n
\n\n[![Browser testing via LAMDBATEST](https://dexie.org/assets/images/lambdatest2.png)](https://www.lambdatest.com/)\n\n[npm-image]: https://img.shields.io/npm/v/dexie.svg?style=flat\n[npm-url]: https://npmjs.org/package/dexie\n" }, { "path": "SECURITY.md", "content": "# Security Policy\n\n## Supported Versions\n\n| Version | Supported | Branch\n| ------- | ------------------ | --------\n| 4.x | :white_check_mark: | master\n| 3.x | :white_check_mark: | master-3\n| 2.0.x | :x: | master-2\n| 1.5.x | :x: | master-1\n| < 1.5.1 | :x: |\n\n## Reporting a Vulnerability\n\nTo report a security vulnerability in Dexie.js, please send an email to code@dexie.org describing the vulnerability and how to reproduce it.\n\nIf we find an issue to be regarded as a security vulnerability, we will patch and release a new version in all the supported versions as soon as possible.\nKeep in mind though that this is an uncommercial open source project which means that sometimes you might have to be the one that\n*fixes* the issue and not just report it.\n\n## Fixing a Vulnerability\n\nFix the issue in the corresponding branch for the major version according to the table above where it applies and\ncreate pull requests. Make sure that you have the words \"security\" or \"vulnerability\" in the title of the Pull Request\nin order to get the correct attention for it to be merged and released as soon as possible.\n\n" }, { "path": "addons/Dexie.Observable/.gitignore", "content": "dist/*.js\ndist/*.map\ndist/*.ts\ndist/*.gz\n**/tmp/\n" }, { "path": "addons/Dexie.Observable/.npmignore", "content": "tools/\nsrc/\n.*\ntmp/\n**/tmp/\ntest\n*.log\n" }, { "path": "addons/Dexie.Observable/README.md", "content": "# Dexie.Observable.js\n\n*NOTE! Dexie's liveQuery feature is NOT dependent on this old package. This package has been unmaintained for a looong time and might be retired*\n\nObserve changes to database - even when they happen in another browser window.\n\n### Install\n```\nnpm install dexie --save\nnpm install dexie-observable --save\n```\n\n### Use\n```js\nimport Dexie from 'dexie';\nimport 'dexie-observable';\n\n// Use Dexie as normally - but you can also subscribe to db.on('changes').\n\n```\n\n#### Usage with existing DB\n\nIn case you want to use Dexie.Observable with your existing database, you will have to do a schema upgrade. Without it Dexie.Observable will not be able to properly work.\n\n```javascript\nimport Dexie from 'dexie';\nimport 'dexie-observable';\n\nvar db = new Dexie('myExistingDb');\ndb.version(1).stores(... existing schema ...);\n\n// Now, add another version, just to trigger an upgrade for Dexie.Observable\ndb.version(2).stores({}); // No need to add / remove tables. This is just to allow the addon to install its tables.\n```\n\n### Dependency Tree\n\n * [Dexie.Syncable.js](https://dexie.org/docs/Syncable/Dexie.Syncable.js)\n * **Dexie.Observable.js**\n * [Dexie.js](https://dexie.org/docs/Dexie/Dexie.js)\n * [IndexedDB](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API)\n\n### Source\n\n[Dexie.Observable.js](https://github.com/dexie/Dexie.js/blob/master/addons/Dexie.Observable/src/Dexie.Observable.js)\n\n### Description\n\nDexie.Observable is an add-on to Dexie.js makes it possible to listen for changes on the database even if the changes are made in a foreign window. The addon provides a \"storage\" event for IndexedDB, much like the storage event (onstorage) for localStorage.\n\nIn contrary to the [Dexie CRUD hooks](https://dexie.org/docs/Tutorial/Design#the-crud-hooks-create-read-update-delete), this event reacts not only on changes made on the current db instance but also on changes occurring on db instances in other browser windows. This enables a Web Apps to react to database changes and update their views accordingly.\n\nDexie.Observable is also the base of [Dexie.Syncable.js](https://dexie.org/docs/Syncable//Dexie.Syncable.js) - an add-on that enables two-way replication with a remote server.\n\n### Extended Methods, Properties and Events\n\n#### UUID key generator\nWhen defining your stores in [Version.stores()](https://dexie.org/docs/Version/Version.stores()) you may use the $$ (double dollar) prefix to your primary key. This will make it auto-generated to a UUID string. See sample below.\n\n#### Dexie.Observable.createUUID()\nA static method added to Dexie that creates a UUID. This method is used internally when using the $$ prefix to primary keys. To change the format of $$ primary keys, just override Dexie.createUUID by setting it to your desired function instead.\n\n#### db.on('changes') event\nSubscribe to any database changes no matter if they occur locally or in other browser window.\n\nParameters to your callback:\n\n\n\n\n
changes : Array<DatabaseChange>Array of changes that have occured in database (locally or in other window) since last time event was triggered, or the time of starting subscribing to changes.
partial: BooleanTrue in case the array does not contain all changes. In this case, your callback will soon be called again with the additional changes and partial=false when all changes are delivered.
\n\n#### Example (here we're using plain ES6 script tags):\n```html\n\n \n \n \n \n \n \n \n\n```\n" }, { "path": "addons/Dexie.Observable/api.d.ts", "content": "/**\n * API for Dexie.Observable.\n *\n * Contains interfaces used by dexie-observable.\n *\n * By separating module 'dexie-observable' from 'dexie-observable/api' we\n * distinguish that:\n *\n * import {...} from 'dexie-observable/api' is only for getting access to its\n * interfaces and has no side-effects.\n * Typescript-only import.\n *\n * import 'dexie-observable' is only for side effects - to extend Dexie with\n * functionality of dexie-observable.\n * Javascript / Typescript import.\n *\n */\nexport const enum DatabaseChangeType {\n Create = 1,\n Update = 2,\n Delete = 3,\n}\n\nexport interface ICreateChange {\n type: DatabaseChangeType.Create;\n table: string;\n key: any;\n obj: any;\n source?: string;\n}\n\nexport interface IUpdateChange {\n type: DatabaseChangeType.Update;\n table: string;\n key: any;\n mods: { [keyPath: string]: any | undefined };\n obj: any;\n oldObj: any;\n source?: string;\n}\n\nexport interface IDeleteChange {\n type: DatabaseChangeType.Delete;\n table: string;\n key: any;\n oldObj: any;\n source?: string;\n}\n\nexport type IDatabaseChange = ICreateChange | IUpdateChange | IDeleteChange;\n" }, { "path": "addons/Dexie.Observable/api.js", "content": "// This file is deliberatly left empty to allow the api.d.ts to contain the definitions for Dexie.Observable without generating an error on webpack\n" }, { "path": "addons/Dexie.Observable/dist/README.md", "content": "## Can't find dexie-observable.js?\nTranspiled code (dist version) IS ONLY checked in to\nthe [releases](https://github.com/dexie/Dexie.js/tree/releases/addons/Dexie.Observable/dist)\nbranch.\n\n## Download\n[unpkg.com/dexie-observable/dist/dexie-observable.js](https://unpkg.com/dexie-observable/dist/dexie-observable.js)\n\n[unpkg.com/dexie-observable/dist/dexie-observable.min.js](https://unpkg.com/dexie-observable/dist/dexie-observable.min.js)\n\n[unpkg.com/dexie-observable/dist/dexie-observable.js.map](https://unpkg.com/dexie-observable/dist/dexie-observable.js.map)\n\n[unpkg.com/dexie-observable/dist/dexie-observable.min.js.map](https://unpkg.com/dexie-observable/dist/dexie-observable.min.js.map)\n\n## npm\n```\nnpm install dexie-observable --save\n```\n## bower\nSince Dexie v1.3.4, addons are included in the dexie bower package. \n```\n$ bower install dexie --save\n$ ls bower_components/dexie/addons/Dexie.Observable/dist\ndexie-observable.js dexie-observable.js.map dexie-observable.min.js dexie-observable.min.js.map\n\n```\n## Or build them yourself...\nFork Dexie.js, then:\n```\ngit clone https://github.com/YOUR-USERNAME/Dexie.js.git\ncd Dexie.js\nnpm install\ncd addons/Dexie.Observable\nnpm run build # or npm run watch\n\n```\nIf you're on windows, you need to use an elevated command prompt of some reason to get `npm install` to work.\n" }, { "path": "addons/Dexie.Observable/package.json", "content": "{\n \"name\": \"dexie-observable\",\n \"version\": \"4.0.1-beta.13\",\n \"description\": \"Addon to Dexie that makes it possible to observe database changes no matter if they occur on other db instance or other window.\",\n \"main\": \"dist/dexie-observable.js\",\n \"module\": \"dist/dexie-observable.es.js\",\n \"jsnext:main\": \"dist/dexie-observable.es.js\",\n \"typings\": \"dist/dexie-observable.d.ts\",\n \"jspm\": {\n \"format\": \"cjs\",\n \"ignore\": [\n \"src/\"\n ]\n },\n \"repository\": {\n \"type\": \"git\",\n \"url\": \"https://github.com/dexie/Dexie.js.git\"\n },\n \"keywords\": [\n \"indexeddb\",\n \"browser\",\n \"dexie\",\n \"addon\"\n ],\n \"author\": \"David Fahlander\",\n \"contributors\": [\n \"Nikolas Poniros \",\n \"Yury Solovyov \",\n \"Martin Diphoorn \",\n \"Corbin Crutchley \"\n ],\n \"license\": \"Apache-2.0\",\n \"bugs\": {\n \"url\": \"https://github.com/dexie/Dexie.js/issues\"\n },\n \"scripts\": {\n \"build\": \"just-build\",\n \"watch\": \"just-build --watch\",\n \"test\": \"pnpm run build && pnpm run test:typings && pnpm run test:unit && pnpm run test:integration\",\n \"test:unit\": \"karma start test/unit/karma.conf.js --single-run\",\n \"test:integration\": \"karma start test/integration/karma.conf.js --single-run\",\n \"test:typings\": \"just-build test-typings\",\n \"test:unit:debug\": \"karma start test/unit/karma.conf.js --log-level debug\",\n \"test:integration:debug\": \"karma start test/integrations/karma.conf.js --log-level debug\",\n \"test:ltcloud\": \"cross-env LAMBDATEST=true pnpm run test:ltTunnel & sleep 10 && pnpm run test:unit; UNIT_STATUS=$?; exit $UNIT_STATUS\",\n \"test:ltTunnel\": \"node ../../test/lt-local\",\n \"test:ltcloud:integration\": \"cross-env LAMBDATEST=true pnpm run test:integration; UNIT_STATUS=$?; kill $(cat tunnel.pid); exit $UNIT_STATUS\"\n },\n \"just-build\": {\n \"default\": [\n \"just-build release test\"\n ],\n \"dev\": [\n \"just-build dexie-observable test\"\n ],\n \"dexie-observable\": [\n \"# Build UMD module\",\n \"tsc --allowJs -t es5 -m es2015 --outDir tools/tmp/es5/src/ --sourceMap --skipLibCheck src/Dexie.Observable.js [--watch 'Compilation complete.']\",\n \"rollup -c tools/build-configs/rollup.config.mjs\",\n \"node tools/replaceVersionAndDate.js dist/dexie-observable.js\",\n \"# eslint \",\n \"eslint src --cache\"\n ],\n \"release\": [\n \"just-build dexie-observable\",\n \"# Copy Dexie.Observable.d.ts to dist and replace version in it\",\n \"node -e \\\"fs.writeFileSync('dist/dexie-observable.d.ts', fs.readFileSync('src/Dexie.Observable.d.ts'))\\\"\",\n \"node tools/replaceVersionAndDate.js dist/dexie-observable.d.ts\",\n \"# Minify the default ES5 UMD module\",\n \"cd dist\",\n \"uglifyjs dexie-observable.js -m -c negate_iife=0 -o dexie-observable.min.js --source-map\"\n ],\n \"test\": [\n \"# Build the unit tests (integration tests need no build)\",\n \"tsc --allowJs --moduleResolution node --lib es2018,dom -t es5 -m es2015 --outDir tools/tmp/es5/test --rootDir ../.. --sourceMap --skipLibCheck test/unit/unit-tests-all.js [--watch 'Compilation complete.']\",\n \"rollup -c tools/build-configs/rollup.tests.config.mjs\"\n ],\n \"test-typings\": [\n \"tsc -p test/typings/\"\n ]\n },\n \"homepage\": \"https://dexie.org\",\n \"peerDependencies\": {\n \"dexie\": \"workspace:^\"\n },\n \"devDependencies\": {\n \"@types/node\": \"^18.11.18\",\n \"dexie\": \"workspace:^\",\n \"eslint\": \"^7.27.0\",\n \"just-build\": \"^0.9.24\",\n \"qunit\": \"2.10.0\",\n \"qunitjs\": \"1.23.1\",\n \"typescript\": \"^5.3.3\",\n \"uglify-js\": \"^3.5.6\",\n \"undici-types\": \"^6.21.0\"\n }\n}\n" }, { "path": "addons/Dexie.Observable/src/.eslintrc.json", "content": "{\n \"extends\": \"eslint:recommended\",\n \"parserOptions\": {\n \"ecmaVersion\": 2020,\n \"sourceType\": \"module\",\n \"ecmaFeatures\": {\n }\n },\n \"rules\": {\n \"no-undef\": [\"error\"],\n \"no-unused-vars\": 1,\n \"no-console\": 0,\n \"no-empty\": 0\n },\n \"globals\": {\n \"indexedDB\": false,\n \"IDBKeyRange\": false,\n \"setTimeout\": false,\n \"clearTimeout\": false,\n \"Symbol\": false,\n \"setImmediate\": false,\n \"console\": false,\n \"self\": false,\n \"window\": false,\n \"global\": false,\n \"navigator\": false,\n \"location\": false,\n \"chrome\": false,\n \"document\": false,\n \"MutationObserver\": false,\n \"CustomEvent\": false,\n \"dispatchEvent\": false,\n \"localStorage\": false\n }\n}\n" }, { "path": "addons/Dexie.Observable/src/Dexie.Observable.d.ts", "content": "// Type definitions for dexie-observable v{version}\n// Project: https://github.com/dexie/Dexie.js/tree/master/addons/Dexie.Observable\n// Definitions by: David Fahlander \n\nimport Dexie, { DexieEventSet } from 'dexie';\nimport { IDatabaseChange } from '../api';\n\nexport interface SyncNodeConstructor {\n new() : SyncNode;\n}\n\n//\n// Interfaces of Dexie.Observable\n// \n\n\n/**\n * A SyncNode represents a local database instance that subscribes\n * to changes made on the database.\n * SyncNodes are stored in the _syncNodes table.\n * \n * Dexie.Syncable extends this interface and allows 'remote' nodes to be stored\n * as well.\n */\nexport interface SyncNode {\n id?: number,\n myRevision: number,\n type: 'local' | 'remote',\n lastHeartBeat: number,\n deleteTimeStamp: number, // In case lastHeartBeat is too old, a value of now + HIBERNATE_GRACE_PERIOD will be set here. If reached before node wakes up, node will be deleted.\n isMaster: number // 1 if true. Not using Boolean because it's not possible to index Booleans.\n}\n\nexport interface ObservableEventSet extends DexieEventSet {\n (eventName: 'latestRevisionIncremented', subscriber: (dbName: string, latestRevision: number) => void): void;\n (eventName: 'suicideNurseCall', subscriber: (dbName: string, nodeID: number) => void): void;\n (eventName: 'intercomm', subscriber: (dbName: string) => void): void;\n (eventName: 'beforeunload', subscriber: () => void): void;\n}\n\n// Object received by on('message') after sendMessage() or broadcastMessage()\ninterface MessageEvent {\n id: number;\n type: string;\n message: any;\n destinationNode: number;\n wantReply?: boolean;\n resolve(result: any): void;\n reject(error: any): void;\n}\n\n//\n// Extend Dexie interface\n//\ndeclare module 'dexie' {\n // Extend methods on db (db.sendMessage(), ...)\n interface Dexie {\n // Placeholder where to access the SyncNode class constructor.\n // (makes it valid to do new db.observable.SyncNode())\n observable: {\n version: string;\n SyncNode: SyncNodeConstructor;\n sendMessage(\n type: string, // Don't use 'response' as it is used internally by the framework\n message: any, // anything that can be saved by IndexedDB\n destinationNode: number,\n options: {\n wantReply?: boolean;\n }\n ): Promise | void; // When wantReply is undefined or false return is void\n\n broadcastMessage(\n type: string,\n message: any, // anything that can be saved by IndexedDB\n bIncludeSelf: boolean\n ): void;\n }\n\n readonly _localSyncNode: SyncNode;\n\n _changes: Dexie.Table;\n _syncNodes: Dexie.Table;\n _intercomm: Dexie.Table;\n }\n\n // Extended events db.on('changes', subscriber), ...\n interface DbEvents {\n (eventName: 'changes', subscriber: (changes: IDatabaseChange[], partial: boolean)=>void): void;\n (eventName: 'cleanup', subscriber: ()=>any): void;\n (eventName: 'message', subscriber: (msg: MessageEvent)=>any): void;\n }\n\n // Extended IndexSpec with uuid boolean for primary key.\n interface IndexSpec {\n uuid: boolean;\n }\n\n interface DexieConstructor {\n Observable: {\n (db: Dexie) : void;\n\n version: string;\n createUUID: () => string;\n on: ObservableEventSet;\n localStorageImpl: {\n setItem(key: string, value: string): void,\n getItem(key: string): string,\n removeItem(key: string): void; \n };\n _onStorage: (event: StorageEvent) => void;\n }\n\n }\n}\n\nexport default Dexie.Observable;\n" }, { "path": "addons/Dexie.Observable/src/Dexie.Observable.js", "content": "/* ========================================================================== \n * dexie-observable.js\n * ==========================================================================\n *\n * Dexie addon for observing database changes not just on local db instance\n * but also on other instances, tabs and windows.\n *\n * Comprises a base framework for dexie-syncable.js\n *\n * By David Fahlander, david.fahlander@gmail.com,\n * Nikolas Poniros, https://github.com/nponiros\n *\n * ==========================================================================\n *\n * Version {version}, {date}\n *\n * https://dexie.org\n *\n * Apache License Version 2.0, January 2004, http://www.apache.org/licenses/\n * \n */\nimport Dexie from 'dexie';\nimport { nop, promisableChain, createUUID } from './utils';\n\nimport initOverrideCreateTransaction from './override-create-transaction';\nimport initWakeupObservers from './wakeup-observers';\nimport initCrudMonitor from './hooks/crud-monitor';\nimport initOnStorage from './on-storage';\nimport initOverrideOpen from './override-open';\nimport initIntercomm from './intercomm';\n\nimport overrideParseStoresSpec from './override-parse-stores-spec';\n\nimport deleteOldChanges from './delete-old-changes';\n\nvar global = self;\n\n/** class DatabaseChange\n *\n * Object contained by the _changes table.\n */\nvar DatabaseChange = Dexie.defineClass({\n rev: Number, // Auto-incremented primary key\n source: String, // Optional source creating the change. Set if transaction.source was set when doing the operation.\n table: String, // Table name\n key: Object, // Primary key. Any type.\n type: Number, // 1 = CREATE, 2 = UPDATE, 3 = DELETE\n obj: Object, // CREATE: obj contains the object created.\n mods: Object, // UPDATE: mods contains the modifications made to the object.\n oldObj: Object // DELETE: oldObj contains the object deleted. UPDATE: oldObj contains the old object before updates applied.\n});\n\n// Import some usable helper functions\nvar override = Dexie.override;\nvar Promise = Dexie.Promise;\nvar browserIsShuttingDown = false;\n\n/** Dexie addon for change tracking and real-time observation.\n * \n * @param {Dexie} db \n */\nfunction Observable(db) {\n if (!/^(3|4)\\./.test(Dexie.version))\n throw new Error(`Missing dexie version 3.x or 4.x`);\n if (db.observable) {\n if (db.observable.version !== \"{version}\") throw new Error(`Mixed versions of dexie-observable`);\n return; // Addon already active.\n }\n\n var NODE_TIMEOUT = 20000, // 20 seconds before local db instances are timed out. This is so that old changes can be deleted when not needed and to garbage collect old _syncNodes objects.\n HIBERNATE_GRACE_PERIOD = 20000, // 20 seconds\n // LOCAL_POLL: The time to wait before polling local db for changes and cleaning up old nodes. \n // Polling for changes is a fallback only needed in certain circomstances (when the onstorage event doesnt reach all listeners - when different browser windows doesnt share the same process)\n LOCAL_POLL = 500, // 500 ms. In real-world there will be this value + the time it takes to poll(). A small value is needed in Workers where we cannot rely on storage event.\n HEARTBEAT_INTERVAL = NODE_TIMEOUT - 5000;\n\n var localStorage = Observable.localStorageImpl;\n\n /** class SyncNode\n *\n * Object contained in the _syncNodes table.\n */\n var SyncNode = Dexie.defineClass({\n //id: Number,\n myRevision: Number,\n type: String, // \"local\" or \"remote\"\n lastHeartBeat: Number,\n deleteTimeStamp: Number, // In case lastHeartBeat is too old, a value of now + HIBERNATE_GRACE_PERIOD will be set here. If reached before node wakes up, node will be deleted.\n url: String, // Only applicable for \"remote\" nodes. Only used in Dexie.Syncable.\n isMaster: Number, // 1 if true. Not using Boolean because it's not possible to index Booleans in IE implementation of IDB.\n\n // Below properties should be extended in Dexie.Syncable. Not here. They apply to remote nodes only (type == \"remote\"):\n syncProtocol: String, // Tells which implementation of ISyncProtocol to use for remote syncing. \n syncContext: null,\n syncOptions: Object,\n connected: false, // FIXTHIS: Remove! Replace with status.\n status: Number,\n appliedRemoteRevision: null,\n remoteBaseRevisions: [{ local: Number, remote: null }],\n dbUploadState: {\n tablesToUpload: [String],\n currentTable: String,\n currentKey: null,\n localBaseRevision: Number\n }\n });\n\n db.observable = {version: \"{version}\"};\n db.observable.SyncNode = SyncNode;\n\n const wakeupObservers = initWakeupObservers(db, Observable, localStorage);\n const overrideCreateTransaction = initOverrideCreateTransaction(db, wakeupObservers);\n const crudMonitor = initCrudMonitor(db);\n const overrideOpen = initOverrideOpen(db, SyncNode, crudMonitor);\n\n var mySyncNode = {node: null};\n\n const intercomm = initIntercomm(db, Observable, SyncNode, mySyncNode, localStorage);\n const onIntercomm = intercomm.onIntercomm;\n const consumeIntercommMessages = intercomm.consumeIntercommMessages;\n\n // Allow other addons to access the local sync node. May be needed by Dexie.Syncable.\n Object.defineProperty(db, \"_localSyncNode\", {\n get: function() { return mySyncNode.node; }\n });\n\n var pollHandle = null,\n heartbeatHandle = null;\n\n if (Dexie.fake) {\n // This code will never run.\n // It's here just to enable auto-complete in visual studio - helps a lot when writing code.\n db.version(1).stores({\n _syncNodes: \"++id,myRevision,lastHeartBeat\",\n _changes: \"++rev\",\n _intercomm: \"++id,destinationNode\",\n _uncommittedChanges: \"++id,node\"\n });\n db._syncNodes.mapToClass(SyncNode);\n db._changes.mapToClass(DatabaseChange);\n mySyncNode.node = new SyncNode({\n myRevision: 0,\n type: \"local\",\n lastHeartBeat: Date.now(),\n deleteTimeStamp: null\n });\n }\n\n //\n // Override parsing the stores to add \"_changes\" and \"_syncNodes\" tables.\n // It also adds UUID support for the primary key and sets tables as observable tables.\n //\n db.Version.prototype._parseStoresSpec = override(db.Version.prototype._parseStoresSpec, overrideParseStoresSpec);\n\n // changes event on db:\n db.on.addEventType({\n changes: 'asap',\n cleanup: [promisableChain, nop], // fire (nodesTable, changesTable, trans). Hook called when cleaning up nodes. Subscribers may return a Promise to to more stuff. May do additional stuff if local sync node is master.\n message: 'asap'\n });\n\n //\n // Override transaction creation to always include the \"_changes\" store when any observable store is involved.\n //\n db._createTransaction = override(db._createTransaction, overrideCreateTransaction);\n\n // If Observable.latestRevsion[db.name] is undefined, set it to 0 so that comparing against it always works.\n // You might think that it will always be undefined before this call, but in case another Dexie instance in the same\n // window with the same database name has been created already, this static property will already be set correctly.\n Observable.latestRevision[db.name] = Observable.latestRevision[db.name] || 0;\n\n //\n // Override open to setup hooks for db changes and map the _syncNodes table to class\n //\n db.open = override(db.open, overrideOpen);\n\n db.close = override(db.close, function(origClose) {\n return function () {\n if (db.dynamicallyOpened()) return origClose.apply(this, arguments); // Don't observe dynamically opened databases.\n // Teardown our framework.\n if (wakeupObservers.timeoutHandle) {\n clearTimeout(wakeupObservers.timeoutHandle);\n delete wakeupObservers.timeoutHandle;\n }\n Observable.on('latestRevisionIncremented').unsubscribe(onLatestRevisionIncremented);\n Observable.on('suicideNurseCall').unsubscribe(onSuicide);\n Observable.on('intercomm').unsubscribe(onIntercomm);\n Observable.on('beforeunload').unsubscribe(onBeforeUnload);\n // Inform other db instances in same window that we are dying:\n if (mySyncNode.node && mySyncNode.node.id) {\n Observable.on.suicideNurseCall.fire(db.name, mySyncNode.node.id);\n // Inform other windows as well:\n if (localStorage) {\n localStorage.setItem('Dexie.Observable/deadnode:' + mySyncNode.node.id.toString() + '/' + db.name, \"dead\"); // In IE, this will also wakeup our own window. cleanup() may trigger twice per other db instance. But that doesnt to anything.\n }\n mySyncNode.node.deleteTimeStamp = 1; // One millisecond after 1970. Makes it occur in the past but still keeps it truthy.\n mySyncNode.node.lastHeartBeat = 0;\n db._syncNodes.put(mySyncNode.node); // This async operation may be cancelled since the browser is closing down now.\n mySyncNode.node = null;\n }\n\n if (pollHandle) clearTimeout(pollHandle);\n pollHandle = null;\n if (heartbeatHandle) clearTimeout(heartbeatHandle);\n heartbeatHandle = null;\n return origClose.apply(this, arguments);\n };\n });\n\n // Override Dexie.delete() in order to delete Observable.latestRevision[db.name].\n db.delete = override(db.delete, function(origDelete) {\n return function() {\n return origDelete.apply(this, arguments).then(function(result) {\n // Reset Observable.latestRevision[db.name]\n Observable.latestRevision[db.name] = 0;\n return result;\n });\n };\n });\n\n // When db opens, make sure to start monitor any changes before other db operations will start.\n db.on(\"ready\", function startObserving() {\n if (db.dynamicallyOpened()) return db; // Don't observe dynamically opened databases.\n \n return db.table(\"_changes\").orderBy(\"rev\").last(function(lastChange) {\n // Since startObserving() is called before database open() method, this will be the first database operation enqueued to db.\n // Therefore we know that the retrieved value will be This query will\n var latestRevision = (lastChange ? lastChange.rev : 0);\n mySyncNode.node = new SyncNode({\n myRevision: latestRevision,\n type: \"local\",\n lastHeartBeat: Date.now(),\n deleteTimeStamp: null,\n isMaster: 0\n });\n if (Observable.latestRevision[db.name] < latestRevision) {\n // Side track . For correctness whenever setting Observable.latestRevision[db.name] we must make sure the event is fired if increased:\n // There are other db instances in same window that hasnt yet been informed about a new revision\n Observable.latestRevision[db.name] = latestRevision;\n Dexie.ignoreTransaction(function() {\n Observable.on.latestRevisionIncremented.fire(latestRevision);\n });\n }\n // Add new sync node or if this is a reopening of the database after a close() call, update it.\n return db._syncNodes.put(mySyncNode.node).then(Dexie.ignoreTransaction(() => {\n // By default, this node will become master unless we discover an existing, up-to-date master\n var mySyncNodeShouldBecomeMaster = 1;\n return db._syncNodes.orderBy('isMaster').reverse().modify(existingNode => {\n if (existingNode.isMaster) {\n if (existingNode.lastHeartBeat < Date.now() - NODE_TIMEOUT) {\n // Existing master record is out-of-date; demote it\n existingNode.isMaster = 0;\n } else {\n // An existing up-to-date master record exists, so it will remain master\n mySyncNodeShouldBecomeMaster = 0;\n }\n }\n\n // The local node reference may be unassigned at any point by a database close() operation\n if (!mySyncNode.node) return;\n\n // Assign the local node state\n // This is guaranteed to apply *after* any existing master records have been inspected, due to the orderBy clause\n if (existingNode.id === mySyncNode.node.id) {\n existingNode.isMaster = mySyncNode.node.isMaster = mySyncNodeShouldBecomeMaster;\n }\n });\n })).then(() => {\n Observable.on('latestRevisionIncremented', onLatestRevisionIncremented); // Wakeup when a new revision is available.\n Observable.on('beforeunload', onBeforeUnload);\n Observable.on('suicideNurseCall', onSuicide);\n Observable.on('intercomm', onIntercomm);\n // Start polling for changes and do cleanups:\n pollHandle = setTimeout(poll, LOCAL_POLL);\n // Start heartbeat\n heartbeatHandle = setTimeout(heartbeat, HEARTBEAT_INTERVAL);\n }).then(function () {\n cleanup();\n });\n });\n }, true); // True means the on(ready) event will survive a db reopening (db.close() / db.open()).\n\n var handledRevision = 0;\n\n function onLatestRevisionIncremented(dbname, latestRevision) {\n if (dbname === db.name) {\n if (handledRevision >= latestRevision) return; // Make sure to only run once per revision. (Workaround for IE triggering storage event on same window)\n handledRevision = latestRevision;\n Dexie.vip(function() {\n readChanges(latestRevision).catch('DatabaseClosedError', ()=>{\n // Handle database closed error gracefully while reading changes.\n // Don't trigger 'unhandledrejection'.\n // Even though we intercept the close() method, it might be called when in the middle of\n // reading changes and then that flow will cancel with DatabaseClosedError.\n });\n });\n }\n }\n\n function readChanges(latestRevision, recursion, wasPartial) {\n // Whenever changes are read, fire db.on(\"changes\") with the array of changes. Eventually, limit the array to 1000 entries or so (an entire database is\n // downloaded from server AFTER we are initiated. For example, if first sync call fails, then after a while we get reconnected. However, that scenario\n // should be handled in case database is totally empty we should fail if sync is not available)\n if (!recursion && readChanges.ongoingOperation) {\n // We are already reading changes. Prohibit a parallell execution of this which would lead to duplicate trigging of 'changes' event.\n // Instead, the callback in toArray() will always check Observable.latestRevision[db.name] to see if it has changed and if so, re-launch readChanges().\n // The caller should get the Promise instance from the ongoing operation so that the then() method will resolve when operation is finished.\n return readChanges.ongoingOperation;\n }\n\n var partial = false;\n var ourSyncNode = mySyncNode.node; // Because mySyncNode can suddenly be set to null on database close, and worse, can be set to a new value if database is reopened.\n if (!ourSyncNode) {\n return Promise.reject(new Dexie.DatabaseClosedError());\n }\n var LIMIT = 1000;\n var promise = db._changes.where(\"rev\").above(ourSyncNode.myRevision).limit(LIMIT).toArray(function (changes) {\n if (changes.length > 0) {\n var lastChange = changes[changes.length - 1];\n partial = (changes.length === LIMIT);\n db.on('changes').fire(changes, partial);\n ourSyncNode.myRevision = lastChange.rev;\n } else if (wasPartial) {\n // No more changes, BUT since we have triggered on('changes') with partial = true,\n // we HAVE TO trigger changes again with empty list and partial = false\n db.on('changes').fire([], false);\n }\n\n let ourNodeStillExists = false;\n return db._syncNodes.where(':id').equals(ourSyncNode.id).modify(syncNode => {\n ourNodeStillExists = true;\n syncNode.lastHeartBeat = Date.now(); // Update heart beat (not nescessary, but why not!)\n syncNode.deleteTimeStamp = null; // Reset \"deleteTimeStamp\" flag if it was there.\n syncNode.myRevision = Math.max(syncNode.myRevision, ourSyncNode.myRevision);\n }).then(()=>ourNodeStillExists);\n }).then(ourNodeStillExists =>{\n if (!ourNodeStillExists) {\n // My node has been deleted. We must have been lazy and got removed by another node.\n if (browserIsShuttingDown) {\n throw new Error(\"Browser is shutting down\");\n } else {\n db.close();\n console.error(\"Out of sync\"); // TODO: What to do? Reload the page?\n if (global.location) global.location.reload(true);\n throw new Error(\"Out of sync\"); // Will make current promise reject\n }\n }\n\n // Check if more changes have come since we started reading changes in the first place. If so, relaunch readChanges and let the ongoing promise not\n // resolve until all changes have been read.\n if (partial || Observable.latestRevision[db.name] > ourSyncNode.myRevision) {\n // Either there were more than 1000 changes or additional changes where added while we were reading these changes,\n // In either case, call readChanges() again until we're done.\n return readChanges(Observable.latestRevision[db.name], (recursion || 0) + 1, partial);\n }\n\n }).finally(function() {\n delete readChanges.ongoingOperation;\n });\n\n if (!recursion) {\n readChanges.ongoingOperation = promise;\n }\n return promise;\n }\n\n /**\n * The reason we need heartbeat in parallell with poll() is due to the risk of long-running\n * transactions while syncing changes from server to client in Dexie.Syncable. That transaction will\n * include _changes (which will block readChanges()) but not _syncNodes. So this heartbeat will go on\n * during that changes are being applied and update our lastHeartBeat property while poll() is waiting.\n * When cleanup() (who also is blocked by the sync) wakes up, it won't kill the master node because this\n * heartbeat job will have updated the master node's heartbeat during the long-running sync transaction.\n * \n * If we did not have this heartbeat, and a server send lots of changes that took more than NODE_TIMEOUT\n * (20 seconds), another node waking up after the sync would kill the master node and take over because\n * it would believe it was dead.\n */\n function heartbeat() {\n heartbeatHandle = null;\n var currentInstance = mySyncNode.node && mySyncNode.node.id;\n if (!currentInstance) return;\n db.transaction('rw!', db._syncNodes, ()=>{\n db._syncNodes.where({id: currentInstance}).first(ourSyncNode => {\n if (!ourSyncNode) {\n // We do not exist anymore. Call db.close() to teardown polls etc.\n if (db.isOpen()) db.close();\n return;\n }\n ourSyncNode.lastHeartBeat = Date.now();\n ourSyncNode.deleteTimeStamp = null; // Reset \"deleteTimeStamp\" flag if it was there.\n return db._syncNodes.put(ourSyncNode);\n });\n }).catch('DatabaseClosedError', () => {\n // Ignore silently\n }).finally(() => {\n if (mySyncNode.node && mySyncNode.node.id === currentInstance && db.isOpen()) {\n heartbeatHandle = setTimeout(heartbeat, HEARTBEAT_INTERVAL);\n }\n });\n }\n\n function poll() {\n pollHandle = null;\n var currentInstance = mySyncNode.node && mySyncNode.node.id;\n if (!currentInstance) return;\n Dexie.vip(function() { // VIP ourselves. Otherwise we might not be able to consume intercomm messages from master node before database has finished opening. This would make DB stall forever. Cannot rely on storage-event since it may not always work in some browsers of different processes.\n readChanges(Observable.latestRevision[db.name]).then(cleanup).then(consumeIntercommMessages)\n .catch('DatabaseClosedError', ()=>{\n // Handle database closed error gracefully while reading changes.\n // Don't trigger 'unhandledrejection'.\n // Even though we intercept the close() method, it might be called when in the middle of\n // reading changes and then that flow will cancel with DatabaseClosedError.\n })\n .finally(function() {\n // Poll again in given interval:\n if (mySyncNode.node && mySyncNode.node.id === currentInstance && db.isOpen()) {\n pollHandle = setTimeout(poll, LOCAL_POLL);\n }\n });\n });\n }\n\n \n function cleanup() {\n var ourSyncNode = mySyncNode.node;\n if (!ourSyncNode) return Promise.reject(new Dexie.DatabaseClosedError());\n return db.transaction('rw', '_syncNodes', '_changes', '_intercomm', function() {\n // Cleanup dead local nodes that has no heartbeat for over a minute\n // Dont do the following:\n //nodes.where(\"lastHeartBeat\").below(Date.now() - NODE_TIMEOUT).and(function (node) { return node.type == \"local\"; }).delete();\n // Because client may have been in hybernate mode and recently woken up. That would lead to deletion of all nodes.\n // Instead, we should mark any old nodes for deletion in a minute or so. If they still dont wakeup after that minute we could consider them dead.\n var weBecameMaster = false;\n db._syncNodes.where(\"lastHeartBeat\").below(Date.now() - NODE_TIMEOUT).filter(node => node.type === 'local').modify(function(node) {\n if (node.deleteTimeStamp && node.deleteTimeStamp < Date.now()) {\n // Delete the node.\n delete this.value;\n // Cleanup localStorage \"deadnode:\" entry for this node (localStorage API was used to wakeup other windows (onstorage event) - an event type missing in indexedDB.)\n if (localStorage) {\n localStorage.removeItem('Dexie.Observable/deadnode:' + node.id + '/' + db.name);\n }\n // Check if we are deleting a master node\n if (node.isMaster) {\n // The node we are deleting is master. We must take over that role.\n // OK to call nodes.update(). No need to call Dexie.vip() because nodes is opened in existing transaction!\n db._syncNodes.update(ourSyncNode, { isMaster: 1 });\n weBecameMaster = true;\n }\n // Cleanup intercomm messages destinated to the node being deleted.\n // Those that waits for reply should be redirected to us.\n db._intercomm.where({destinationNode: node.id}).modify(function(msg) {\n if (msg.wantReply)\n msg.destinationNode = ourSyncNode.id;\n else\n // Delete the message from DB and if someone is waiting for reply, let ourselved answer the request.\n delete this.value;\n });\n } else if (!node.deleteTimeStamp) {\n // Mark the node for deletion\n node.deleteTimeStamp = Date.now() + HIBERNATE_GRACE_PERIOD;\n }\n }).then(function() {\n // Cleanup old revisions that no node is interested of.\n Observable.deleteOldChanges(db);\n return db.on(\"cleanup\").fire(weBecameMaster);\n });\n });\n }\n\n function onBeforeUnload() {\n // Mark our own sync node for deletion.\n if (!mySyncNode.node) return;\n browserIsShuttingDown = true;\n mySyncNode.node.deleteTimeStamp = 1; // One millisecond after 1970. Makes it occur in the past but still keeps it truthy.\n mySyncNode.node.lastHeartBeat = 0;\n db._syncNodes.put(mySyncNode.node); // This async operation may be cancelled since the browser is closing down now.\n Observable.wereTheOneDying = true; // If other nodes in same window wakes up by this call, make sure they dont start taking over mastership and stuff...\n // Inform other windows that we're gone, so that they may take over our role if needed. Setting localStorage item below will trigger Observable.onStorage, which will trigger onSuicie() below:\n if (localStorage) {\n localStorage.setItem('Dexie.Observable/deadnode:' + mySyncNode.node.id.toString() + '/' + db.name, \"dead\"); // In IE, this will also wakeup our own window. However, that is doublechecked in nursecall subscriber below.\n }\n }\n\n function onSuicide(dbname, nodeID) {\n if (dbname === db.name && !Observable.wereTheOneDying) {\n // Make sure it's dead indeed. Second bullet. Why? Because it has marked itself for deletion in the onbeforeunload event, which is fired just before window dies.\n // It's own call to put() may have been cancelled.\n // Note also that in IE, this event may be called twice, but that doesnt harm!\n Dexie.vip(function() {\n db._syncNodes.update(nodeID, { deleteTimeStamp: 1, lastHeartBeat: 0 }).then(cleanup);\n });\n }\n }\n\n}\n\n//\n// Static properties and methods\n// \n\nObservable.version = \"{version}\";\nObservable.latestRevision = {}; // Latest revision PER DATABASE. Example: Observable.latestRevision.FriendsDB = 37;\nObservable.on = Dexie.Events(null, \"latestRevisionIncremented\", \"suicideNurseCall\", \"intercomm\", \"beforeunload\"); // fire(dbname, value);\nObservable.createUUID = createUUID;\n\nObservable.deleteOldChanges = deleteOldChanges;\n\nObservable._onStorage = initOnStorage(Observable);\n\nObservable._onBeforeUnload = function() {\n Observable.on.beforeunload.fire();\n};\n\ntry {\n Observable.localStorageImpl = global.localStorage;\n} catch (ex){}\n\n//\n// Map window events to static events in Dexie.Observable:\n//\nif (global?.addEventListener) {\n global.addEventListener(\"storage\", Observable._onStorage);\n global.addEventListener(\"beforeunload\", Observable._onBeforeUnload);\n}\n\nif (Dexie.Observable) {\n if (Dexie.Observable.version !== \"{version}\") {\n throw new Error (`Mixed versions of dexie-observable`);\n }\n} else {\n // Register addon:\n Dexie.Observable = Observable;\n Dexie.addons.push(Observable);\n}\n\nexport default Dexie.Observable;\n" }, { "path": "addons/Dexie.Observable/src/change_types.js", "content": "// Change Types\nexport const CREATE = 1;\nexport const UPDATE = 2;\nexport const DELETE = 3;\n" }, { "path": "addons/Dexie.Observable/src/delete-old-changes.js", "content": "import Dexie from 'dexie';\n\nexport default function deleteOldChanges(db) {\n // This is a background job and should never be done within\n // a caller's transaction. Use Dexie.ignoreTransaction() to ensure that.\n // We should not return the Promise but catch it ourselves instead.\n\n // To prohibit starving the database we want to lock transactions as short as possible\n // and since we're not in a hurry, we could do this job in chunks and reschedule a\n // continuation every 500 ms.\n const CHUNK_SIZE = 100;\n\n Dexie.ignoreTransaction(()=>{\n return db._syncNodes.orderBy(\"myRevision\").first(oldestNode => {\n return db._changes\n .where(\"rev\").below(oldestNode.myRevision)\n .limit(CHUNK_SIZE)\n .primaryKeys();\n }).then(keysToDelete => {\n if (keysToDelete.length === 0) return; // Done.\n return db._changes.bulkDelete(keysToDelete).then(()=> {\n // If not done garbage collecting, reschedule a continuation of it until done.\n if (keysToDelete.length === CHUNK_SIZE) {\n // Limit reached. Changes are there are more job to do. Schedule again:\n setTimeout(() => db.isOpen() && deleteOldChanges(db), 500);\n }\n });\n });\n }).catch(()=>{\n // The operation is not crucial. A failure could almost only be due to that database has been closed.\n // No need to log this.\n });\n}\n" }, { "path": "addons/Dexie.Observable/src/hooks/creating.js", "content": "import Dexie from 'dexie';\n\nimport {CREATE} from '../change_types';\n\nexport default function initCreatingHook(db, table) {\n return function creatingHook(primKey, obj, trans) {\n /// \n var rv = undefined;\n if (primKey === undefined && table.schema.primKey.uuid) {\n primKey = rv = Dexie.Observable.createUUID();\n if (table.schema.primKey.keyPath) {\n Dexie.setByKeyPath(obj, table.schema.primKey.keyPath, primKey);\n }\n }\n\n var change = {\n source: trans.source || null, // If a \"source\" is marked on the transaction, store it. Useful for observers that want to ignore their own changes.\n table: table.name,\n key: primKey === undefined ? null : primKey,\n type: CREATE,\n obj: obj\n };\n\n var promise = db._changes.add(change).then(function (rev) {\n trans._lastWrittenRevision = Math.max(trans._lastWrittenRevision, rev);\n return rev;\n });\n\n // Wait for onsuccess so that we have the primKey if it is auto-incremented and update the change item if so.\n this.onsuccess = function (resultKey) {\n if (primKey != resultKey)\n promise._then(function () {\n change.key = resultKey;\n db._changes.put(change);\n });\n };\n\n this.onerror = function () {\n // If the main operation fails, make sure to regret the change\n promise._then(function (rev) {\n // Will only happen if app code catches the main operation error to prohibit transaction from aborting.\n db._changes.delete(rev);\n });\n };\n\n return rv;\n };\n}\n" }, { "path": "addons/Dexie.Observable/src/hooks/crud-monitor.js", "content": "import initCreatingHook from './creating';\nimport initUpdatingHook from './updating';\nimport initDeletingHook from './deleting';\n\nexport default function initCrudMonitor(db) {\n//\n// The Creating/Updating/Deleting hook will make sure any change is stored to the changes table\n//\n return function crudMonitor(table) {\n /// \n if (table.hook._observing) return;\n table.hook._observing = true;\n\n const tableName = table.name;\n table.hook('creating').subscribe(initCreatingHook(db, table));\n\n table.hook('updating').subscribe(initUpdatingHook(db, tableName));\n\n table.hook('deleting').subscribe(initDeletingHook(db, tableName));\n };\n}\n" }, { "path": "addons/Dexie.Observable/src/hooks/deleting.js", "content": "import {DELETE} from '../change_types';\n\nexport default function initDeletingHook(db, tableName) {\n return function deletingHook(primKey, obj, trans) {\n /// \n var promise = db._changes.add({\n source: trans.source || null, // If a \"source\" is marked on the transaction, store it. Useful for observers that want to ignore their own changes.\n table: tableName,\n key: primKey,\n type: DELETE,\n oldObj: obj\n }).then(function (rev) {\n trans._lastWrittenRevision = Math.max(trans._lastWrittenRevision, rev);\n return rev;\n })\n .catch((e) => {\n console.log(obj)\n console.log(e.stack)\n })\n this.onerror = function () {\n // If the main operation fails, make sure to regret the change.\n // Using _then because if promise is already fullfilled, the standard then() would\n // do setTimeout() and we would loose the transaction.\n promise._then(function (rev) {\n // Will only happen if app code catches the main operation error to prohibit transaction from aborting.\n db._changes.delete(rev);\n });\n };\n };\n}\n" }, { "path": "addons/Dexie.Observable/src/hooks/updating.js", "content": "import Dexie from 'dexie';\n\nimport {UPDATE} from '../change_types';\n\nexport default function initUpdatingHook(db, tableName) {\n return function updatingHook(mods, primKey, oldObj, trans) {\n /// \n // mods may contain property paths with undefined as value if the property\n // is being deleted. Since we cannot persist undefined we need to act\n // like those changes is setting the value to null instead.\n var modsWithoutUndefined = {};\n // As of current Dexie version (1.0.3) hook may be called even if it wouldn't really change.\n // Therefore we may do that kind of optimization here - to not add change entries if\n // there's nothing to change.\n var anythingChanged = false;\n var newObj = Dexie.deepClone(oldObj);\n for (var propPath in mods) {\n var mod = mods[propPath];\n if (typeof mod === 'undefined') {\n Dexie.delByKeyPath(newObj, propPath);\n modsWithoutUndefined[propPath] = null; // Null is as close we could come to deleting a property when not allowing undefined.\n anythingChanged = true;\n } else {\n var currentValue = Dexie.getByKeyPath(oldObj, propPath);\n if (mod !== currentValue && JSON.stringify(mod) !== JSON.stringify(currentValue)) {\n Dexie.setByKeyPath(newObj, propPath, mod);\n modsWithoutUndefined[propPath] = mod;\n anythingChanged = true;\n }\n }\n }\n if (anythingChanged) {\n var change = {\n source: trans.source || null, // If a \"source\" is marked on the transaction, store it. Useful for observers that want to ignore their own changes.\n table: tableName,\n key: primKey,\n type: UPDATE,\n mods: modsWithoutUndefined,\n oldObj: oldObj,\n obj: newObj\n };\n var promise = db._changes.add(change); // Just so we get the correct revision order of the update...\n this.onsuccess = function () {\n promise._then(function (rev) {\n trans._lastWrittenRevision = Math.max(trans._lastWrittenRevision, rev);\n });\n };\n this.onerror = function () {\n // If the main operation fails, make sure to regret the change.\n promise._then(function (rev) {\n // Will only happen if app code catches the main operation error to prohibit transaction from aborting.\n db._changes.delete(rev);\n });\n };\n }\n };\n}\n" }, { "path": "addons/Dexie.Observable/src/intercomm.js", "content": "import Dexie from 'dexie';\n\nconst Promise = Dexie.Promise;\n\nexport default function initIntercomm(db, Observable, SyncNode, mySyncNode, localStorage) {\n//\n// Intercommunication between nodes\n//\n// Enable inter-process communication between browser windows using localStorage storage event (is registered in Dexie.Observable)\n\n var requestsWaitingForReply = {};\n\n /**\n * @param {string} type Type of message\n * @param message Message to send\n * @param {number} destinationNode ID of destination node\n * @param {{wantReply: boolean, isFailure: boolean, requestId: number}} options If {wantReply: true}, the returned promise will complete with the reply from remote. Otherwise it will complete when message has been successfully sent.\n */\n db.observable.sendMessage = function (type, message, destinationNode, options) {\n /// Type of message\n /// Message to send\n /// ID of destination node\n /// {wantReply: Boolean, isFailure: Boolean, requestId: Number}. If wantReply, the returned promise will complete with the reply from remote. Otherwise it will complete when message has been successfully sent.\n options = options || {};\n if (!mySyncNode.node)\n return options.wantReply ?\n Promise.reject(new Dexie.DatabaseClosedError()) :\n Promise.resolve(); // If caller doesn't want a reply, it won't catch errors either.\n\n var msg = {message: message, destinationNode: destinationNode, sender: mySyncNode.node.id, type: type};\n Dexie.extend(msg, options); // wantReply: wantReply, success: !isFailure, requestId: ...\n return Dexie.ignoreTransaction(()=> {\n var tables = [\"_intercomm\"];\n if (options.wantReply) tables.push(\"_syncNodes\"); // If caller wants a reply, include \"_syncNodes\" in transaction to check that there's a receiver there. Otherwise, new master will get it.\n var promise = db.transaction('rw', tables, () => {\n if (options.wantReply) {\n // Check that there is a receiver there to take the request.\n return db._syncNodes.where('id').equals(destinationNode).count(receiverAlive => {\n if (receiverAlive)\n return db._intercomm.add(msg);\n else // If we couldn't find a node -> send to master\n return db._syncNodes.where('isMaster').above(0).first(function (masterNode) {\n msg.destinationNode = masterNode.id;\n return db._intercomm.add(msg)\n });\n });\n } else {\n // If caller doesn't need a response, we don't have to make sure that it gets one.\n return db._intercomm.add(msg);\n }\n }).then(messageId => {\n var rv = null;\n if (options.wantReply) {\n rv = new Promise(function (resolve, reject) {\n requestsWaitingForReply[messageId.toString()] = {resolve: resolve, reject: reject};\n });\n }\n if (localStorage) {\n localStorage.setItem(\"Dexie.Observable/intercomm/\" + db.name, messageId.toString());\n }\n Observable.on.intercomm.fire(db.name);\n return rv;\n });\n\n if (!options.wantReply) {\n promise.catch(()=> {\n });\n return;\n } else {\n // Forward rejection to caller if it waits for reply.\n return promise;\n }\n });\n };\n\n // Send a message to all local _syncNodes\n db.observable.broadcastMessage = function (type, message, bIncludeSelf) {\n if (!mySyncNode.node) return;\n var mySyncNodeId = mySyncNode.node.id;\n Dexie.ignoreTransaction(()=> {\n db._syncNodes.toArray(nodes => {\n return Promise.all(nodes\n .filter(node => node.type === 'local' && (bIncludeSelf || node.id !== mySyncNodeId))\n .map(node => db.observable.sendMessage(type, message, node.id)));\n }).catch(()=> {\n });\n });\n };\n\n function consumeIntercommMessages() {\n // Check if we got messages:\n if (!mySyncNode.node) return Promise.reject(new Dexie.DatabaseClosedError());\n\n return Dexie.ignoreTransaction(()=> {\n return db.transaction('rw', '_intercomm', function() {\n return db._intercomm.where({destinationNode: mySyncNode.node.id}).toArray(messages => {\n messages.forEach(msg => consumeMessage(msg));\n return db._intercomm.where('id').anyOf(messages.map(msg => msg.id)).delete();\n });\n });\n });\n }\n\n function consumeMessage(msg) {\n if (msg.type === 'response') {\n // This is a response. Lookup pending request and fulfill its promise.\n var request = requestsWaitingForReply[msg.requestId.toString()];\n if (request) {\n if (msg.isFailure) {\n request.reject(msg.message.error);\n } else {\n request.resolve(msg.message.result);\n }\n delete requestsWaitingForReply[msg.requestId.toString()];\n }\n } else {\n // This is a message or request. Fire the event and add an API for the subscriber to use if reply is requested\n msg.resolve = function (result) {\n db.observable.sendMessage('response', {result: result}, msg.sender, {requestId: msg.id});\n };\n msg.reject = function (error) {\n db.observable.sendMessage('response', {error: error.toString()}, msg.sender, {isFailure: true, requestId: msg.id});\n };\n db.on.message.fire(msg);\n }\n }\n\n // Listener for 'intercomm' events\n // Gets fired when we get a 'storage' event from local storage or when sendMessage is called\n // 'storage' is used to communicate between tabs (sendMessage changes the localStorage to trigger the event)\n // sendMessage is used to communicate in the same tab and to trigger a storage event\n function onIntercomm(dbname) {\n // When storage event trigger us to check\n if (dbname === db.name) {\n consumeIntercommMessages().catch('DatabaseClosedError', ()=> {});\n }\n }\n\n return {\n onIntercomm,\n consumeIntercommMessages\n };\n}\n" }, { "path": "addons/Dexie.Observable/src/on-storage.js", "content": "import Dexie from 'dexie';\n\nexport default function initOnStorage(Observable) {\n return function onStorage(event) {\n // We use the onstorage event to trigger onLatestRevisionIncremented since we will wake up when other windows modify the DB as well!\n if (event.key && event.key.indexOf(\"Dexie.Observable/\") === 0) { // For example \"Dexie.Observable/latestRevision/FriendsDB\"\n var parts = event.key.split('/');\n var prop = parts[1];\n var dbname = parts[2];\n if (prop === 'latestRevision') {\n var rev = parseInt(event.newValue, 10);\n if (!isNaN(rev) && rev > Observable.latestRevision[dbname]) {\n Observable.latestRevision[dbname] = rev;\n Dexie.ignoreTransaction(function () {\n Observable.on('latestRevisionIncremented').fire(dbname, rev);\n });\n }\n } else if (prop.indexOf(\"deadnode:\") === 0) {\n var nodeID = parseInt(prop.split(':')[1], 10);\n if (event.newValue) {\n Observable.on.suicideNurseCall.fire(dbname, nodeID);\n }\n } else if (prop === 'intercomm') {\n if (event.newValue) {\n Observable.on.intercomm.fire(dbname);\n }\n }\n }\n };\n}\n" }, { "path": "addons/Dexie.Observable/src/override-create-transaction.js", "content": "export default function initOverrideCreateTransaction(db, wakeupObservers) {\n return function overrideCreateTransaction(origFunc) {\n return function (mode, storenames, dbschema, parent) {\n if (db.dynamicallyOpened()) return origFunc.apply(this, arguments); // Don't observe dynamically opened databases.\n var addChanges = false;\n if (mode === 'readwrite' && storenames.some(function (storeName) {\n return dbschema[storeName] && dbschema[storeName].observable;\n })) {\n // At least one included store is a observable store. Make sure to also include the _changes store.\n addChanges = true;\n storenames = storenames.slice(0); // Clone\n if (storenames.indexOf(\"_changes\") === -1)\n storenames.push(\"_changes\"); // Otherwise, firefox will hang... (I've reported the bug to Mozilla@Bugzilla)\n }\n // Call original db._createTransaction()\n var trans = origFunc.call(this, mode, storenames, dbschema, parent);\n // If this transaction is bound to any observable table, make sure to add changes when transaction completes.\n if (addChanges) {\n trans._lastWrittenRevision = 0;\n trans.on('complete', function () {\n if (trans._lastWrittenRevision) {\n // Changes were written in this transaction.\n if (!parent) {\n // This is root-level transaction, i.e. a physical commit has happened.\n // Delay-trigger a wakeup call:\n if (wakeupObservers.timeoutHandle) clearTimeout(wakeupObservers.timeoutHandle);\n wakeupObservers.timeoutHandle = setTimeout(function () {\n delete wakeupObservers.timeoutHandle;\n wakeupObservers(trans._lastWrittenRevision);\n }, 25);\n } else {\n // This is just a virtual commit of a sub transaction.\n // Wait with waking up observers until root transaction has committed.\n // Make sure to mark root transaction so that it will wakeup observers upon commit.\n var rootTransaction = (function findRootTransaction(trans) {\n return trans.parent ? findRootTransaction(trans.parent) : trans;\n })(parent);\n rootTransaction._lastWrittenRevision = Math.max(\n trans._lastWrittenRevision,\n rootTransaction.lastWrittenRevision || 0);\n }\n }\n });\n // Derive \"source\" property from parent transaction by default\n if (trans.parent && trans.parent.source) trans.source = trans.parent.source;\n }\n return trans;\n };\n };\n}\n" }, { "path": "addons/Dexie.Observable/src/override-open.js", "content": "export default function initOverrideOpen(db, SyncNode, crudMonitor) {\n return function overrideOpen(origOpen) {\n return function () {\n //\n // Make sure to subscribe to \"creating\", \"updating\" and \"deleting\" hooks for all observable tables that were created in the stores() method.\n //\n Object.keys(db._allTables).forEach(tableName => {\n let table = db._allTables[tableName];\n if (table.schema.observable) {\n crudMonitor(table);\n }\n if (table.name === \"_syncNodes\") {\n table.mapToClass(SyncNode);\n }\n });\n return origOpen.apply(this, arguments);\n }\n };\n}\n" }, { "path": "addons/Dexie.Observable/src/override-parse-stores-spec.js", "content": "export default function overrideParseStoresSpec(origFunc) {\n return function(stores, dbSchema) {\n // Create the _changes and _syncNodes tables\n stores[\"_changes\"] = \"++rev\";\n stores[\"_syncNodes\"] = \"++id,myRevision,lastHeartBeat,&url,isMaster,type,status\";\n stores[\"_intercomm\"] = \"++id,destinationNode\";\n stores[\"_uncommittedChanges\"] = \"++id,node\"; // For remote syncing when server returns a partial result.\n // Call default implementation. Will populate the dbSchema structures.\n origFunc.call(this, stores, dbSchema);\n // Allow UUID primary keys using $$ prefix on primary key or indexes\n Object.keys(dbSchema).forEach(function(tableName) {\n var schema = dbSchema[tableName];\n if (schema.primKey.name.indexOf('$$') === 0) {\n schema.primKey.uuid = true;\n schema.primKey.name = schema.primKey.name.substr(2);\n schema.primKey.keyPath = schema.primKey.keyPath.substr(2);\n }\n });\n // Now mark all observable tables\n Object.keys(dbSchema).forEach(function(tableName) {\n // Marked observable tables with \"observable\" in their TableSchema.\n if (tableName.indexOf('_') !== 0 && tableName.indexOf('$') !== 0) {\n dbSchema[tableName].observable = true;\n }\n });\n };\n}\n" }, { "path": "addons/Dexie.Observable/src/utils.js", "content": "export function nop() {}\n\nexport function promisableChain(f1, f2) {\n if (f1 === nop) return f2;\n return function() {\n var res = f1.apply(this, arguments);\n if (res && typeof res.then === 'function') {\n var thiz = this, args = arguments;\n return res.then(function() {\n return f2.apply(thiz, args);\n });\n }\n return f2.apply(this, arguments);\n };\n}\n\nexport function createUUID() {\n // Decent solution from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript\n var d = Date.now();\n var uuid = 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function(c) {\n var r = (d + Math.random() * 16) % 16 | 0;\n d = Math.floor(d / 16);\n return (c === 'x' ? r : (r & 0x7 | 0x8)).toString(16);\n });\n return uuid;\n}\n" }, { "path": "addons/Dexie.Observable/src/wakeup-observers.js", "content": "import Dexie from 'dexie';\n\nexport default function initWakeupObservers(db, Observable, localStorage) {\n return function wakeupObservers(lastWrittenRevision) {\n // Make sure Observable.latestRevision[db.name] is still below our value, now when some time has elapsed and other db instances in same window possibly could have made changes too.\n if (Observable.latestRevision[db.name] < lastWrittenRevision) {\n // Set the static property lastRevision[db.name] to the revision of the last written change.\n Observable.latestRevision[db.name] = lastWrittenRevision;\n // Wakeup ourselves, and any other db instances on this window:\n Dexie.ignoreTransaction(function () {\n Observable.on('latestRevisionIncremented').fire(db.name, lastWrittenRevision);\n });\n // Observable.on.latestRevisionIncremented will only wakeup db's in current window.\n // We need a storage event to wakeup other windwos.\n // Since indexedDB lacks storage events, let's use the storage event from WebStorage just for\n // the purpose to wakeup db instances in other windows.\n if (localStorage) localStorage.setItem('Dexie.Observable/latestRevision/' + db.name, lastWrittenRevision); // In IE, this will also wakeup our own window. However, onLatestRevisionIncremented will work around this by only running once per revision id.\n }\n };\n}\n" }, { "path": "addons/Dexie.Observable/test/gh-actions.sh", "content": "#!/bin/bash -e\necho \"Installing dependencies for dexie-observable\"\npnpm install >/dev/null\npnpm run build\npnpm run test:typings\npnpm run test:ltcloud\npnpm run test:ltcloud:integration\n" }, { "path": "addons/Dexie.Observable/test/integration/karma-env.js", "content": "// workerImports will be used by tests-open.js in the dexie test suite when\n// launching a Worker. This line will instruct the worker to import dexie-observable.\nwindow.workerImports.push(\"../addons/Dexie.Observable/dist/dexie-observable.js\");\n" }, { "path": "addons/Dexie.Observable/test/integration/karma.conf.js", "content": "// Include common configuration\nconst {karmaCommon, getKarmaConfig, defaultBrowserMatrix} = require('../../../../test/karma.common');\n\nmodule.exports = function (config) {\n const browserMatrixOverrides = {\n // Be fine with testing on local travis firefox + browserstack chrome, latest supported.\n ci: [\"remote_chrome\"],\n // Safari fails to reply on browserstack. Need to not have it here.\n // Just complement with old chrome browser that is not part of CI test suite.\n pre_npm_publish: [\n \"Chrome\",\n ]\n };\n\n const cfg = getKarmaConfig(browserMatrixOverrides, {\n // Base path should point at the root \n basePath: '../../../../',\n // The files needed to apply dexie-observable to the standard dexie unit tests.\n files: karmaCommon.files.concat([\n 'dist/dexie.js',\n 'addons/Dexie.Observable/test/integration/karma-env.js',\n 'addons/Dexie.Observable/dist/dexie-observable.js', // Apply observable addon\n 'test/bundle.js', // The dexie standard test suite\n { pattern: 'addons/Dexie.Observable/dist/*.map', watched: false, included: false }\n ])\n });\n\n config.set(cfg);\n}\n" }, { "path": "addons/Dexie.Observable/test/integration/test-observable-dexie-tests.html", "content": "\n\n\n \n Dexie Unit tests with Dexie.Observable applied\n \n \n\n\n
\n
\n \n \n \n \n \n \n\n\n" }, { "path": "addons/Dexie.Observable/test/typings/test-typings.ts", "content": "\nimport Dexie from 'dexie';\nimport '../../src/Dexie.Observable';\nimport dexieObservable from '../../src/Dexie.Observable';\nimport { IDatabaseChange, DatabaseChangeType } from '../../api';\n\ninterface Foo {\n id: string;\n}\n\nclass MyDb extends Dexie {\n foos: Dexie.Table;\n\n constructor() {\n super('testdb', {addons: [dexieObservable, Dexie.Observable]});\n this.version(1).stores({foos: '$$id'});\n }\n}\n\nlet db = new MyDb();\n\nlet syncNode = new db.observable.SyncNode();\nsyncNode.isMaster;\nsyncNode.deleteTimeStamp.toExponential();\nsyncNode.lastHeartBeat.toExponential();\nsyncNode.myRevision.toFixed();\n\ndb.on('message', msg => {\n msg.type;\n msg.message;\n msg.destinationNode * 1;\n msg.wantReply;\n msg.resolve('foo');\n msg.reject(new Error('Foo'));\n});\ndb.observable.sendMessage('myMsgType', {foo: 'bar'}, 13, {wantReply: true});\ndb.observable.sendMessage('myMsgType', 'foobar', 13, {wantReply: false});\n\ndb.observable.broadcastMessage('myBroadcastMsgType', {foo2: 'bar2'}, false);\n\ndb.on('changes', changes => {\n changes.forEach(change => {\n switch (change.type) {\n case DatabaseChangeType.Create:\n change.table.toLowerCase();\n change.key;\n change.obj; \n break;\n case DatabaseChangeType.Update:\n change.table.toLowerCase();\n change.key;\n change.mods;\n break;\n case DatabaseChangeType.Delete:\n change.table.toLowerCase();\n change.key;\n break;\n }\n })\n});\n\nDexie.Observable.createUUID().toLowerCase();\nDexie.Observable.on('latestRevisionIncremented', (dbName, rev) => {dbName.toLowerCase(); rev.toFixed()});\nDexie.Observable.on('latestRevisionIncremented').subscribe(()=>{});\nDexie.Observable.on('latestRevisionIncremented').fire(()=>{});\nDexie.Observable.on('latestRevisionIncremented').unsubscribe(()=>{});\n\nDexie.Observable.on('suicideNurseCall', (dbName, nodeId)=>{dbName.toLowerCase(); nodeId.toExponential()});\nDexie.Observable.on('intercomm', dbName=>{dbName.toLowerCase()});\nDexie.Observable.on('beforeunload', ()=>{});\n\nDexie.Observable.on('latestRevisionIncremented').unsubscribe(()=>{});\nvar x: IDatabaseChange = {key: 1, table: \"\", type: DatabaseChangeType.Delete, oldObj: {}};\nx.key;\nx.type;\nx.oldObj;\n" }, { "path": "addons/Dexie.Observable/test/typings/tsconfig.json", "content": "{\n \"compilerOptions\": {\n \"module\": \"es6\",\n \"target\": \"es5\",\n \"noImplicitAny\": true,\n \"strictNullChecks\": true,\n \"outDir\": \"../../tools/tmp/test-typings\",\n \"moduleResolution\": \"node\",\n \"lib\": [\"dom\", \"es2020\"]\n },\n \"files\": [\n \"test-typings.ts\"\n ]\n}\n" }, { "path": "addons/Dexie.Observable/test/unit/.eslintrc.json", "content": "{\n \"parserOptions\": {\n \"ecmaVersion\": 6,\n \"sourceType\": \"module\",\n \"ecmaFeatures\": {\n }\n },\n \"env\": {\n \"browser\": true,\n \"node\": true\n },\n \"rules\": {\n \"no-undef\": [\"error\"]\n },\n \"globals\": {\n \"Promise\": true\n }\n}\n" }, { "path": "addons/Dexie.Observable/test/unit/.gitignore", "content": "/bundle.js\n/bundle.js.map\n" }, { "path": "addons/Dexie.Observable/test/unit/deep-equal.js", "content": "import {equal} from 'QUnit';\n\n// Must use this rather than QUnit's deepEqual() because that one fails on Safari when run via karma-browserstack-launcher\nexport function deepEqual(a, b, description) {\n if (typeof a === 'object' && typeof b === 'object' && a != null && b != null) {\n equal(JSON.stringify(sortMembers(a), null, 2), JSON.stringify(sortMembers(b), null, 2), description);\n } else {\n equal(JSON.stringify(a, null, 2), JSON.stringify(b, null, 2), description);\n }\n}\n\n/**\n * \n * @param {object} obj \n */\nfunction sortMembers (obj) {\n return Object.keys(obj).sort().reduce((result, key) => {\n result[key] = obj[key];\n return result;\n }, {});\n}\n" }, { "path": "addons/Dexie.Observable/test/unit/hooks/tests-creating.js", "content": "import Dexie from 'dexie';\nimport {module, asyncTest, start, stop, strictEqual, ok} from 'QUnit';\nimport {deepEqual} from '../deep-equal';\nimport {resetDatabase} from '../../../../../test/dexie-unittest-utils';\nimport initCreatingHook from '../../../src/hooks/creating';\nimport initWakeupObservers from '../../../src/wakeup-observers';\nimport initOverrideCreateTransaction from '../../../src/override-create-transaction';\nimport {CREATE} from '../../../src/change_types';\n\nconst db = new Dexie('TestDBTable', {addons: []});\ndb.version(1).stores({\n foo: \"id\",\n bar: \"$$id\",\n baz: \"++id\",\n _changes: \"++rev\"\n});\n\nconst wakeupObservers = initWakeupObservers(db, {latestRevision: {}}, self.localStorage);\nconst overrideCreateTransaction = initOverrideCreateTransaction(db, wakeupObservers);\ndb._createTransaction = Dexie.override(db._createTransaction, overrideCreateTransaction);\n\nmodule('creating Hook', {\n setup: () => {\n stop();\n // Do a full DB reset to clean _changes table\n db._hasBeenCreated = false;\n resetDatabase(db).catch(function (e) {\n ok(false, \"Error resetting database: \" + e.stack);\n }).finally(start);\n },\n teardown: () => {\n }\n});\n\nasyncTest('should create a UUID key if $$ was given', () => {\n db.bar.schema.primKey.uuid = true;\n db.bar.schema.observable = true;\n const creatingHook = initCreatingHook(db, db.bar);\n\n db.bar.hook('creating', function(primKey, obj, trans) {\n const ctx = {onsuccess: null, onerror: null};\n const res = creatingHook.call(ctx, primKey, obj, trans);\n // Note that this regex is not spec compliant but should be good enough for this test\n const regex = /^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[0-9a-f]{4}-[0-9a-f]{12}$/;\n ok(regex.test(res), 'We got a UUID');\n\n this.onsuccess = function(resKey) {\n try {\n strictEqual(res, resKey, 'Key from success and hook should match');\n db._changes.toArray((changes) => {\n strictEqual(changes.length, 1, 'We have one change');\n strictEqual(changes[0].key, resKey, 'Key should match');\n strictEqual(changes[0].type, CREATE, 'CREATE type');\n strictEqual(changes[0].table, 'bar', 'bar table');\n // Normally $$ would be removed from the id in overrideParseStoresSpec\n deepEqual(changes[0].obj, {foo: 'bar', $$id: resKey}, 'obj should match');\n strictEqual(changes[0].source, null, 'We have no source');\n ok(typeof trans._lastWrittenRevision !== 'undefined', '_lastWrittenRevision should be defined');\n })\n .catch((e) => {\n ok(false, 'Error: ' + e);\n })\n } catch (e) {\n ok(false, 'Error: ' + e);\n }\n };\n\n this.onerror = function(e) {\n ok(false, 'Error: ' + e);\n }\n });\n\n db.bar.add({foo: 'bar'})\n .catch(function(err) {\n ok(false, \"Error: \" + err);\n })\n .finally(start);\n});\n\nasyncTest('should not create a key if one was given', () => {\n db.foo.schema.observable = true;\n const creatingHook = initCreatingHook(db, db.foo);\n const ID = 1;\n const source = 10;\n\n db.foo.hook('creating', function(primKey, obj, trans) {\n trans.source = source;\n const ctx = {onsuccess: null, onerror: null};\n const res = creatingHook.call(ctx, primKey, obj, trans);\n strictEqual(res, undefined, 'ID was given return undefined');\n\n this.onsuccess = function(resKey) {\n try {\n strictEqual(resKey, ID, 'We got the given ID');\n db._changes.toArray((changes) => {\n strictEqual(changes.length, 1, 'We have one change');\n strictEqual(changes[0].key, ID, 'Key should match');\n strictEqual(changes[0].type, CREATE, 'CREATE type');\n strictEqual(changes[0].table, 'foo', 'foo table');\n deepEqual(changes[0].obj, {foo: 'bar', id: ID}, 'obj should match');\n strictEqual(changes[0].source, source, 'We have source');\n ok(typeof trans._lastWrittenRevision !== 'undefined', '_lastWrittenRevision should be defined');\n })\n .catch((e) => {\n ok(false, 'Error: ' + e);\n })\n } catch (e) {\n ok(false, 'Error: ' + e);\n }\n };\n\n this.onerror = function(e) {\n ok(false, 'Error: ' + e);\n }\n });\n\n db.foo.add({id: ID, foo: 'bar'})\n .catch(function(err) {\n ok(false, \"Error: \" + err);\n })\n .finally(start);\n});\n\nasyncTest('should use the auto-incremented key if ++ was given', () => {\n db.baz.schema.observable = true;\n const creatingHook = initCreatingHook(db, db.baz);\n const ID = 1;\n\n db.baz.hook('creating', function(primKey, obj, trans) {\n const ctx = {onsuccess: null, onerror: null};\n const res = creatingHook.call(ctx, primKey, obj, trans);\n strictEqual(res, undefined, 'ID was auto-increment return undefined');\n\n this.onsuccess = function(resKey) {\n try {\n strictEqual(resKey, ID, 'We got the given ID');\n db._changes.toArray((changes) => {\n strictEqual(changes.length, 1, 'We have one change');\n strictEqual(changes[0].key, null, 'Key should be null');\n strictEqual(changes[0].type, CREATE, 'CREATE type');\n strictEqual(changes[0].table, 'baz', 'baz table');\n deepEqual(changes[0].obj, {foo: 'bar'}, 'obj should match');\n strictEqual(changes[0].source, null, 'We have no source');\n ok(typeof trans._lastWrittenRevision !== 'undefined', '_lastWrittenRevision should be defined');\n })\n .catch((e) => {\n ok(false, 'Error: ' + e);\n })\n } catch (e) {\n ok(false, 'Error: ' + e);\n }\n };\n\n this.onerror = function(e) {\n ok(false, 'Error: ' + e);\n }\n });\n\n db.baz.add({foo: 'bar'})\n .catch(function(err) {\n ok(false, \"Error: \" + err);\n })\n .finally(start);\n});\n" }, { "path": "addons/Dexie.Observable/test/unit/hooks/tests-deleting.js", "content": "import Dexie from 'dexie';\nimport {module, asyncTest, start, stop, strictEqual, ok} from 'QUnit';\nimport {deepEqual} from '../deep-equal';\nimport {resetDatabase} from '../../../../../test/dexie-unittest-utils';\nimport initDeletingHook from '../../../src/hooks/deleting';\nimport initWakeupObservers from '../../../src/wakeup-observers';\nimport initOverrideCreateTransaction from '../../../src/override-create-transaction';\nimport {DELETE} from '../../../src/change_types';\n\nconst db = new Dexie('TestDBTable', {addons: []});\ndb.version(1).stores({\n foo: \"id\",\n _changes: \"++rev\"\n});\n\nconst wakeupObservers = initWakeupObservers(db, {latestRevision: {}}, self.localStorage);\nconst overrideCreateTransaction = initOverrideCreateTransaction(db, wakeupObservers);\ndb._createTransaction = Dexie.override(db._createTransaction, overrideCreateTransaction);\n\nmodule('deleting Hook', {\n setup: () => {\n stop();\n // Do a full DB reset to clean _changes table\n db._hasBeenCreated = false;\n resetDatabase(db).catch(function (e) {\n ok(false, \"Error resetting database: \" + e.stack);\n }).finally(start);\n },\n teardown: () => {\n }\n});\n\nasyncTest('should create a DELETE change', () => {\n db.foo.schema.observable = true;\n const deletingHook = initDeletingHook(db, db.foo.name);\n const ID = 10;\n const source = 10;\n\n db.foo.hook('deleting', function(primKey, obj, trans) {\n trans.source = 10;\n const ctx = {onsuccess: null, onerror: null};\n deletingHook.call(ctx, primKey, obj, trans);\n\n this.onsuccess = function() {\n try {\n db._changes.toArray((changes) => {\n strictEqual(changes.length, 1, 'We have one change');\n strictEqual(changes[0].key, ID, 'Key should match');\n strictEqual(changes[0].type, DELETE, 'DELETE type');\n strictEqual(changes[0].table, 'foo', 'foo table');\n deepEqual(changes[0].oldObj, {foo: 'bar', id: ID}, 'oldObj should match');\n strictEqual(changes[0].source, source, 'We have source');\n ok(typeof trans._lastWrittenRevision !== 'undefined', '_lastWrittenRevision should be defined');\n })\n .catch((e) => {\n ok(false, 'Error: ' + e);\n })\n } catch (e) {\n ok(false, 'Error: ' + e);\n }\n };\n\n this.onerror = function(e) {\n ok(false, 'Error: ' + e);\n }\n });\n\n db.foo.add({id: ID, foo: 'bar'})\n .then(() => {\n return db.foo.delete(ID)\n })\n .catch(function(err) {\n ok(false, \"Error: \" + err);\n })\n .finally(start);\n});\n" }, { "path": "addons/Dexie.Observable/test/unit/hooks/tests-updating.js", "content": "import Dexie from 'dexie';\nimport {module, asyncTest, start, stop, strictEqual, ok} from 'QUnit';\nimport {deepEqual} from '../deep-equal';\nimport {resetDatabase} from '../../../../../test/dexie-unittest-utils';\nimport initUpdatingHook from '../../../src/hooks/updating';\nimport initWakeupObservers from '../../../src/wakeup-observers';\nimport initOverrideCreateTransaction from '../../../src/override-create-transaction';\nimport {UPDATE} from '../../../src/change_types';\n\nconst db = new Dexie('TestDBTable', {addons: []});\ndb.version(1).stores({\n foo: \"id\",\n _changes: \"++rev\"\n});\n\nconst wakeupObservers = initWakeupObservers(db, {latestRevision: {}}, self.localStorage);\nconst overrideCreateTransaction = initOverrideCreateTransaction(db, wakeupObservers);\ndb._createTransaction = Dexie.override(db._createTransaction, overrideCreateTransaction);\n\nmodule('updating Hook', {\n setup: () => {\n stop();\n // Do a full DB reset to clean _changes table\n db._hasBeenCreated = false;\n resetDatabase(db).catch(function (e) {\n ok(false, \"Error resetting database: \" + e.stack);\n }).finally(start);\n },\n teardown: () => {\n }\n});\n\nasyncTest('should create an UPDATE change', () => {\n db.foo.schema.observable = true;\n const updatingHook = initUpdatingHook(db, db.foo.name);\n const ID = 1;\n const source = 10;\n\n db.foo.hook('updating', function hook(mods, primKey, obj, trans) {\n // Remove this hook now otherwise other tests might call it\n db.foo.hook('updating').unsubscribe(hook);\n\n trans.source = source;\n const ctx = {onsuccess: null, onerror: null};\n updatingHook.call(ctx, mods, primKey, obj, trans);\n\n this.onsuccess = function() {\n try {\n db._changes.toArray((changes) => {\n strictEqual(changes.length, 1, 'We have one change');\n strictEqual(changes[0].key, ID, 'Key should match');\n strictEqual(changes[0].type, UPDATE, 'UPDATE type');\n strictEqual(changes[0].table, 'foo', 'foo table');\n deepEqual(changes[0].obj, {foo: 'baz', id: ID}, 'obj should match');\n strictEqual(changes[0].source, source, 'We have source');\n ok(typeof trans._lastWrittenRevision !== 'undefined', '_lastWrittenRevision should be defined');\n })\n .catch((e) => {\n ok(false, 'Error: ' + e);\n })\n } catch (e) {\n ok(false, 'Error: ' + e);\n }\n };\n\n this.onerror = function(e) {\n ok(false, 'Error: ' + e);\n }\n });\n\n db.foo.add({id: ID, foo: 'bar'})\n .then(() => {\n return db.foo.update(ID, {foo: 'baz'});\n })\n .catch(function(err) {\n ok(false, \"Error: \" + err);\n })\n .finally(start);\n});\n\nasyncTest('should not create an UPDATE change if the mods are already in the old object', () => {\n db.foo.schema.observable = true;\n const updatingHook = initUpdatingHook(db, db.foo.name);\n const ID = 2;\n const source = 10;\n\n db.foo.hook('updating', function hook(mods, primKey, obj, trans) {\n // Remove this hook now otherwise other tests might call it\n db.foo.hook('updating').unsubscribe(hook);\n\n trans.source = source;\n const ctx = {onsuccess: null, onerror: null};\n updatingHook.call(ctx, mods, primKey, obj, trans);\n\n this.onsuccess = function() {\n try {\n db._changes.toArray((changes) => {\n strictEqual(changes.length, 0, 'We have no change');\n })\n .catch((e) => {\n ok(false, 'Error: ' + e);\n })\n } catch (e) {\n ok(false, 'Error: ' + e);\n }\n };\n\n this.onerror = function(e) {\n ok(false, 'Error: ' + e);\n }\n });\n\n db.foo.add({id: ID, foo: 'bar'})\n .then(() => {\n return db.foo.update(ID, {foo: 'bar'});\n }).then(()=>{\n return db._changes.toArray((changes) => {\n strictEqual(changes.length, 0, 'We have no change');\n });\n })\n .catch(function(err) {\n ok(false, \"Error: \" + err);\n })\n .finally(start);\n});\n\n" }, { "path": "addons/Dexie.Observable/test/unit/karma.conf.js", "content": "// Include common configuration\nconst {karmaCommon, getKarmaConfig, defaultBrowserMatrix} = require('../../../../test/karma.common');\n\nmodule.exports = function (config) {\n const browserMatrixOverrides = {\n // Be fine with testing on local travis firefox + browserstack chrome, latest supported.\n ci: [\"remote_chrome\"],\n // Safari fails to reply on browserstack. Need to not have it here.\n // Just complement with old chrome browser that is not part of CI test suite.\n pre_npm_publish: [\n \"Chrome\",\n ]\n };\n\n const cfg = getKarmaConfig(browserMatrixOverrides, {\n // Base path should point at the root \n basePath: '../../../../',\n files: karmaCommon.files.concat([\n 'dist/dexie.js',\n 'addons/Dexie.Observable/dist/dexie-observable.js',\n 'addons/Dexie.Observable/test/unit/bundle.js',\n { pattern: 'addons/Dexie.Observable/test/unit/*.map', watched: false, included: false },\n { pattern: 'addons/Dexie.Observable/dist/*.map', watched: false, included: false }\n ])\n });\n\n config.set(cfg);\n}\n" }, { "path": "addons/Dexie.Observable/test/unit/run-unit-tests.html", "content": "\n\n\n \n Dexie.Observable Unit tests\n \n\n\n
\n
\n \n \n \n \n \n\n\n" }, { "path": "addons/Dexie.Observable/test/unit/tests-observable-misc.js", "content": "import {module, asyncTest, equal, strictEqual, ok, start} from 'QUnit';\nimport {deepEqual} from './deep-equal';\nimport Dexie from 'dexie';\nimport 'dexie-observable';\n\nmodule(\"tests-observable-misc\", {\n setup: function () {\n stop();\n Dexie.delete(\"ObservableTest\").then(function () {\n start();\n }).catch(function (e) {\n ok(false, \"Could not delete database\");\n });\n },\n teardown: function () {\n stop();\n Dexie.delete(\"ObservableTest\").then(start);\n }\n});\n\nfunction createDB() {\n var db = new Dexie(\"ObservableTest\");\n db.version(1).stores({\n friends: \"++id,name,shoeSize\",\n CapitalIdTest: \"$$Id,name\"\n //pets: \"++id,name,kind\",\n //$emailWords: \"\",\n });\n return db;\n}\n\n// Basically check if Dexie.Observable adds a 'changes' event\n// Test works because of the second parameter to asyncTest which expects 4 assertions\nasyncTest(\"changes in on DB instance should trigger a change event in an other instance\", 4, function () {\n var db1 = createDB();\n var db2 = createDB();\n\n db2.on('changes', function (changes, partitial) {\n changes.forEach(function (change) {\n switch (change.type) {\n case 1:\n ok(true, \"obj created: \" + JSON.stringify(change.obj));\n break;\n case 2:\n ok(true, \"obj updated: \" + JSON.stringify(change.mods));\n equal(JSON.stringify(change.mods), JSON.stringify({name: \"David\"}), \"Only modifying the name property\");\n break;\n case 3:\n ok(true, \"obj deleted: \" + JSON.stringify(change.oldObj));\n db1.close();\n db2.close();\n start();\n break;\n }\n });\n });\n\n db1.open();\n db2.open();\n\n db1.friends.put({name: \"Dave\", shoeSize: 43}).then(function (id) {\n // Update object:\n return db1.friends.put({id: id, name: \"David\", shoeSize: 43});\n }).then(function (id) {\n // Delete object:\n return db1.friends.delete(id);\n }).catch(function (e) {\n ok(false, \"Error: \" + e.stack || e);\n start();\n });\n});\n\n// Test UUID primary key\nasyncTest(\"Capital$$Id-test\", function () {\n var db = createDB();\n db.open();\n db.CapitalIdTest.put({name: \"Hilda\"}).then(function () {\n return db.CapitalIdTest.toCollection().first();\n }).then(function (firstItem) {\n ok(firstItem.name == \"Hilda\", \"Got first item\");\n ok(firstItem.Id, \"First item has a primary key set: \" + firstItem.Id);\n // Note that this regex is not spec compliant but should be good enough for this test\n const regex = /^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[0-9a-f]{4}-[0-9a-f]{12}$/;\n ok(regex.test(firstItem.Id), 'We got a UUID');\n }).catch(function (e) {\n ok(false, \"Error: \" + e);\n }).finally(function () {\n db.close();\n start();\n });\n});\n\n//\n// Test intercomm in same window\n//\nasyncTest('should receive a message from the first sync node', 4, () => {\n const db1 = createDB();\n const db2 = createDB();\n let senderID;\n let receiverID;\n db2.on('message', (msg) => {\n strictEqual(msg.message, 'foobar', 'We got the correct message');\n strictEqual(msg.sender, senderID, 'We got the right sender ID');\n strictEqual(msg.type, 'request', 'We got the correct type');\n strictEqual(msg.destinationNode, receiverID, 'We got the correct destination node');\n start();\n });\n\n db1.on('message', () => {\n ok(false, 'We should not receive a message');\n });\n\n db1._syncNodes.toArray()\n .then((arr) => {\n senderID = arr[0].id;\n return db2._syncNodes.toArray();\n })\n .then((arr) => {\n receiverID = arr.filter((node) => node.id !== senderID)[0].id;\n db1.observable.sendMessage('request', 'foobar', receiverID, {});\n })\n .catch((e) => {\n ok(false, 'Error: ' + e);\n });\n});\n\nasyncTest('master node should receive the message if the destination is not present and we want a reply', 5, () => {\n const db1 = createDB();\n let senderID;\n db1.on('message', (msg) => {\n deepEqual(msg.message, {foo: 'foobar'}, 'We got the correct message');\n strictEqual(msg.sender, senderID, 'We got the right sender ID');\n strictEqual(msg.type, 'request', 'We got the correct type');\n strictEqual(msg.destinationNode, senderID, 'We got the correct destination node');\n start();\n });\n\n db1._syncNodes.toArray()\n .then((arr) => {\n senderID = arr[0].id;\n strictEqual(arr[0].isMaster, 1, 'We are master');\n db1.observable.sendMessage('request', {foo: 'foobar'}, 10, {wantReply: true});\n })\n .catch((e) => {\n ok(false, 'Error: ' + e);\n });\n});\n\nasyncTest('sender should react on successful reply', 1, () => {\n const db1 = createDB();\n const db2 = createDB();\n let senderID;\n let receiverID;\n db2.on('message', (msg) => {\n msg.resolve('reply msg');\n });\n\n db1._syncNodes.toArray()\n .then((arr) => {\n senderID = arr[0].id;\n return db2._syncNodes.toArray();\n })\n .then((arr) => {\n receiverID = arr.filter((node) => node.id !== senderID)[0].id;\n return db1.observable.sendMessage('request', {foo: 'foobar'}, receiverID, {wantReply: true});\n })\n .then((result) => {\n strictEqual(result, 'reply msg', 'We got the correct result msg');\n })\n .catch((e) => {\n ok(false, 'Error: ' + e);\n })\n .finally(start);\n});\n\nasyncTest('sender should react on failure reply', 1, () => {\n const db1 = createDB();\n const db2 = createDB();\n let senderID;\n let receiverID;\n db2.on('message', (msg) => {\n msg.reject('error msg');\n });\n\n db1._syncNodes.toArray()\n .then((arr) => {\n senderID = arr[0].id;\n return db2._syncNodes.toArray();\n })\n .then((arr) => {\n receiverID = arr.filter((node) => node.id !== senderID)[0].id;\n return db1.observable.sendMessage('request', {foo: 'foobar'}, receiverID, {wantReply: true});\n })\n .catch((msg) => {\n strictEqual(msg, 'error msg');\n })\n .finally(start);\n});\n\nasyncTest('sync nodes should react on broadcast', 4, () => {\n const db1 = createDB();\n const db2 = createDB();\n let senderID;\n let receiverID;\n db2.on('message', (msg) => {\n deepEqual(msg.message, {foo: 'foobar'}, 'We got the correct message');\n strictEqual(msg.sender, senderID, 'We got the right sender ID');\n strictEqual(msg.type, 'request', 'We got the correct type');\n strictEqual(msg.destinationNode, receiverID, 'We got the correct destination node');\n start();\n });\n\n db1.on('message', () => {\n ok(false, 'We should not receive a message');\n });\n\n db1._syncNodes.toArray()\n .then((arr) => {\n senderID = arr[0].id;\n return db2._syncNodes.toArray();\n })\n .then((arr) => {\n receiverID = arr.filter((node) => node.id !== senderID)[0].id;\n db1.observable.broadcastMessage('request', {foo: 'foobar'});\n })\n .catch((e) => {\n ok(false, 'Error: ' + e);\n });\n});\n\nasyncTest('sender should be able to react on broadcast if bIncludeSelf is true', 4, () => {\n const db1 = createDB();\n const db2 = createDB();\n let senderID;\n let receiverID;\n\n db1.on('message', (msg) => {\n deepEqual(msg.message, {foo: 'foobar'}, 'We got the correct message');\n strictEqual(msg.sender, senderID, 'We got the right sender ID');\n strictEqual(msg.type, 'broadcast', 'We got the correct type');\n strictEqual(msg.destinationNode, senderID, 'We got the correct destination node');\n start();\n });\n\n db1._syncNodes.toArray()\n .then((arr) => {\n senderID = arr[0].id;\n return db2._syncNodes.toArray();\n })\n .then((arr) => {\n receiverID = arr.filter((node) => node.id !== senderID)[0].id;\n const bIncludeSelf = true;\n db1.observable.broadcastMessage('broadcast', {foo: 'foobar'}, bIncludeSelf);\n })\n .catch((e) => {\n ok(false, 'Error: ' + e);\n });\n});\n\n// This tests relates to https://github.com/dexie/Dexie.js/issues/429#issuecomment-269793599\n// If db2 receives its message multiple times qunit will error as start() is called multiple times\nasyncTest('no matter how many times sendMessage is called a receiver should receive its message only once', 4, () => {\n const db1 = createDB();\n const db2 = createDB();\n let senderID;\n let receiverID;\n db2.on('message', (msg) => {\n deepEqual(msg.message, {foo: 'foobar'}, 'We got the correct message');\n strictEqual(msg.sender, senderID, 'We got the right sender ID');\n strictEqual(msg.type, 'request', 'We got the correct type');\n strictEqual(msg.destinationNode, receiverID, 'We got the correct destination node');\n start();\n });\n\n db1._syncNodes.toArray()\n .then((arr) => {\n senderID = arr[0].id;\n return db2._syncNodes.toArray();\n })\n .then((arr) => {\n receiverID = arr.filter((node) => node.id !== senderID)[0].id;\n db1.observable.sendMessage('request', {foo: 'foobar'}, receiverID, {});\n // Send messages for receivers that don't exist\n db1.observable.sendMessage('request', {foo: 'foobar'}, 'foobar', {});\n db1.observable.sendMessage('request', {foo: 'foobar'}, 'barbaz', {});\n })\n .catch((e) => {\n ok(false, 'Error: ' + e);\n });\n});\n" }, { "path": "addons/Dexie.Observable/test/unit/tests-override-open.js", "content": "import {module, test, strictEqual, deepEqual, ok} from 'QUnit';\nimport initOverrideOpen from '../../src/override-open';\n\nmodule('override-open', {\n setup: () => {\n },\n teardown: () => {\n }\n});\n\ntest('should call the given original function', () => {\n let wasCalled = false;\n function origFn() {\n wasCalled = true;\n }\n\n const db = {\n _allTables: {}\n };\n\n initOverrideOpen(db, function SyncNode() {}, function crudMonitor() {})(origFn)();\n ok(wasCalled);\n});\n\ntest('should call the crudMonitor function for every observable table', () => {\n const tables = [];\n function crudMonitor(table) {\n tables.push(table);\n }\n\n const db = {\n _allTables: {\n foo: {\n // TableSchema: for more info see https://github.com/dfahlander/Dexie.js/wiki/TableSchema\n schema: {\n observable: true\n }\n },\n _bar: {\n schema: {}\n }\n }\n };\n\n initOverrideOpen(db, function SyncNode() {}, crudMonitor)(() => {})();\n deepEqual(tables, [db._allTables.foo]);\n});\n\ntest('should call mapToClass for the _syncNodes table', () => {\n function SyncNode() {}\n let calledWithClass;\n const db = {\n _allTables: {\n _syncNodes: {\n name: '_syncNodes',\n mapToClass(cls) {\n calledWithClass = cls;\n },\n schema: {}\n }\n }\n };\n\n initOverrideOpen(db, SyncNode, function crudMonitor(){})(() => {})();\n strictEqual(calledWithClass, SyncNode);\n});\n" }, { "path": "addons/Dexie.Observable/test/unit/tests-override-parse-stores-spec.js", "content": "import {module, test, strictEqual, deepEqual, ok} from 'QUnit';\nimport overrideParseStoresSpec from '../../src/override-parse-stores-spec';\n\nmodule('override-parse-stores', {\n setup: () => {\n },\n teardown: () => {\n }\n});\n\ntest('should create stores for Dexie.Observable and Dexie.Syncable', () => {\n function origFunc(stores/*, dbSchema*/) {\n ok(typeof stores._changes === 'string', 'Should have _changes store');\n ok(typeof stores._syncNodes === 'string', 'Should have _syncNodes store');\n ok(typeof stores._intercomm === 'string', 'Should have _intercomm store');\n ok(typeof stores._uncommittedChanges === 'string', 'Should have _uncommittedChanges store');\n }\n\n const stores = {};\n const dbSchema = {};\n overrideParseStoresSpec(origFunc)(stores, dbSchema);\n});\n\ntest('should add UUID keys to the schema', () => {\n function origFunc(){}\n\n const stores = {\n foo: '$$id',\n };\n const dbSchema = {\n // TableSchema: for more info see https://github.com/dfahlander/Dexie.js/wiki/TableSchema\n foo: {\n name: 'foo',\n // IndexSpec: for more info see https://github.com/dfahlander/Dexie.js/wiki/IndexSpec\n primKey: {\n name: '$$id',\n keyPath: '$$id'\n }\n }\n };\n overrideParseStoresSpec(origFunc)(stores, dbSchema);\n\n strictEqual(dbSchema.foo.primKey.name, 'id', 'Should remove $$ from the name');\n strictEqual(dbSchema.foo.primKey.keyPath, 'id', 'Should remove $$ from keyPath');\n strictEqual(dbSchema.foo.primKey.uuid, true, 'uuid should be set to true');\n});\n\ntest('should observe tables without _ and $', () => {\n function origFunc(){}\n\n const stores = {\n foo: 'id',\n _foo: 'id',\n $bar: 'id'\n };\n const dbSchema = {\n foo: {primKey: {name: 'id'}},\n _foo: {primKey: {name: 'id'}},\n $bar: {primKey: {name: 'id'}}\n };\n overrideParseStoresSpec(origFunc)(stores, dbSchema);\n\n strictEqual(dbSchema.foo.observable, true, 'foo should be observed');\n strictEqual(dbSchema._foo.observable, undefined, '_foo should not be observed');\n strictEqual(dbSchema.$bar.observable, undefined, '$bar should not be observed');\n});\n" }, { "path": "addons/Dexie.Observable/test/unit/unit-tests-all.js", "content": "import './hooks/tests-creating.js';\nimport './hooks/tests-deleting.js';\nimport './hooks/tests-updating.js';\nimport './tests-override-open.js';\nimport './tests-override-parse-stores-spec.js';\nimport './tests-observable-misc';\n" }, { "path": "addons/Dexie.Observable/tools/build-configs/banner.txt", "content": "/* ========================================================================== \n * dexie-observable.js\n * ==========================================================================\n *\n * Dexie addon for observing database changes not just on local db instance\n * but also on other instances, tabs and windows.\n *\n * Comprises a base framework for dexie-syncable.js\n *\n * By David Fahlander, david.fahlander@gmail.com,\n * Nikolas Poniros, https://github.com/nponiros\n *\n * ==========================================================================\n *\n * Version {version}, {date}\n *\n * https://dexie.org\n *\n * Apache License Version 2.0, January 2004, http://www.apache.org/licenses/\n * \n */\n" }, { "path": "addons/Dexie.Observable/tools/build-configs/rollup.config.mjs", "content": "import sourcemaps from 'rollup-plugin-sourcemaps';\nimport {readFileSync} from 'fs';\nimport path from 'path';\nimport { fileURLToPath } from 'url';\n\nconst __filename = fileURLToPath(import.meta.url);\nconst __dirname = path.dirname(__filename);\nconst packageJson = JSON.parse(readFileSync(path.resolve(__dirname, '../../package.json'), 'utf-8'));\nconst version = packageJson.version;\n\nexport default {\n input: 'tools/tmp/es5/src/Dexie.Observable.js',\n output: [{\n file: 'dist/dexie-observable.js',\n format: 'umd',\n banner: readFileSync(path.resolve(__dirname, 'banner.txt')),\n globals: {dexie: \"Dexie\"},\n name: 'Dexie.Observable',\n sourcemap: true\n },{\n file: 'dist/dexie-observable.es.js',\n format: 'es',\n banner: readFileSync(path.resolve(__dirname, 'banner.txt')),\n globals: {dexie: \"Dexie\"},\n name: 'Dexie.Observable',\n sourcemap: true\n }],\n external: ['dexie'],\n plugins: [ sourcemaps() ]\n};\n" }, { "path": "addons/Dexie.Observable/tools/build-configs/rollup.tests.config.js", "content": "import sourcemaps from 'rollup-plugin-sourcemaps';\nimport commonjs from '@rollup/plugin-commonjs';\nimport nodeResolve from '@rollup/plugin-node-resolve';\n\nconst ERRORS_TO_IGNORE = [\n \"THIS_IS_UNDEFINED\"\n];\n\nexport default {\n input: 'tools/tmp/es5/test/addons/Dexie.Observable/test/unit/unit-tests-all.js',\n output: {\n file: 'test/unit/bundle.js',\n format: 'umd',\n globals: {dexie: \"Dexie\", \"dexie-observable\": \"Dexie.Observable\", QUnit: \"QUnit\"},\n sourcemap: true,\n name: 'dexieTests'\n },\n external: ['dexie', 'dexie-observable', 'QUnit'],\n plugins: [\n sourcemaps(),\n nodeResolve({browser: true}),\n commonjs()\n ],\n onwarn ({loc, frame, code, message}) {\n if (ERRORS_TO_IGNORE.includes(code)) return;\n if ( loc ) {\n console.warn( `${loc.file} (${loc.line}:${loc.column}) ${message}` );\n if ( frame ) console.warn( frame );\n } else {\n console.warn(`${code} ${message}`);\n } \n }\n};\n" }, { "path": "addons/Dexie.Observable/tools/build-configs/rollup.tests.config.mjs", "content": "import sourcemaps from 'rollup-plugin-sourcemaps';\nimport commonjs from '@rollup/plugin-commonjs';\nimport nodeResolve from '@rollup/plugin-node-resolve';\n\nconst ERRORS_TO_IGNORE = [\n \"THIS_IS_UNDEFINED\"\n];\n\nexport default {\n input: 'tools/tmp/es5/test/addons/Dexie.Observable/test/unit/unit-tests-all.js',\n output: {\n file: 'test/unit/bundle.js',\n format: 'umd',\n globals: {dexie: \"Dexie\", \"dexie-observable\": \"Dexie.Observable\", QUnit: \"QUnit\"},\n sourcemap: true,\n name: 'dexieTests'\n },\n external: ['dexie', 'dexie-observable', 'QUnit'],\n plugins: [\n sourcemaps(),\n nodeResolve({browser: true}),\n commonjs()\n ],\n onwarn ({loc, frame, code, message}) {\n if (ERRORS_TO_IGNORE.includes(code)) return;\n if ( loc ) {\n console.warn( `${loc.file} (${loc.line}:${loc.column}) ${message}` );\n if ( frame ) console.warn( frame );\n } else {\n console.warn(`${code} ${message}`);\n } \n }\n};\n" }, { "path": "addons/Dexie.Observable/tools/build-configs/rollup.tests.unit.config.js", "content": "import sourcemaps from 'rollup-plugin-sourcemaps';\nimport commonjs from '@rollup/plugin-commonjs';\nimport nodeResolve from '@rollup/plugin-node-resolve';\n\nconst ERRORS_TO_IGNORE = [\n \"THIS_IS_UNDEFINED\"\n];\n\nexport default {\n input: 'tools/tmp/es5/test/addons/Dexie.Observable/test/unit/unit-tests-all.js',\n output: {\n file: 'test/unit/bundle.js',\n format: 'umd',\n globals: {dexie: \"Dexie\", \"dexie-observable\": \"Dexie.Observable\", QUnit: \"QUnit\"},\n sourcemap: true,\n name: 'dexieTests'\n },\n external: ['dexie', 'dexie-observable', 'QUnit'],\n plugins: [\n sourcemaps(),\n nodeResolve({browser: true}),\n commonjs()\n ],\n onwarn ({loc, frame, code, message}) {\n if (ERRORS_TO_IGNORE.includes(code)) return;\n if ( loc ) {\n console.warn( `${loc.file} (${loc.line}:${loc.column}) ${message}` );\n if ( frame ) console.warn( frame );\n } else {\n console.warn(`${code} ${message}`);\n } \n }\n};\n" }, { "path": "addons/Dexie.Observable/tools/build-configs/rollup.tests.unit.config.mjs", "content": "import sourcemaps from 'rollup-plugin-sourcemaps';\nimport commonjs from '@rollup/plugin-commonjs';\nimport nodeResolve from '@rollup/plugin-node-resolve';\n\nconst ERRORS_TO_IGNORE = [\n \"THIS_IS_UNDEFINED\"\n];\n\nexport default {\n input: 'tools/tmp/es5/test/addons/Dexie.Observable/test/unit/unit-tests-all.js',\n output: {\n file: 'test/unit/bundle.js',\n format: 'umd',\n globals: {dexie: \"Dexie\", \"dexie-observable\": \"Dexie.Observable\", QUnit: \"QUnit\"},\n sourcemap: true,\n name: 'dexieTests'\n },\n external: ['dexie', 'dexie-observable', 'QUnit'],\n plugins: [\n sourcemaps(),\n nodeResolve({browser: true}),\n commonjs()\n ],\n onwarn ({loc, frame, code, message}) {\n if (ERRORS_TO_IGNORE.includes(code)) return;\n if ( loc ) {\n console.warn( `${loc.file} (${loc.line}:${loc.column}) ${message}` );\n if ( frame ) console.warn( frame );\n } else {\n console.warn(`${code} ${message}`);\n } \n }\n};\n" }, { "path": "addons/Dexie.Observable/tools/replaceVersionAndDate.js", "content": "const fs = require('fs');\nconst files = process.argv.slice(2);\nconst version = require('../package.json').version;\n\nfiles.forEach(file => {\n let fileContent = fs.readFileSync(file, \"utf-8\");\n fileContent = fileContent\n .replace(/{version}/g, version)\n .replace(/{date}/g, new Date().toDateString());\n fs.writeFileSync(file, fileContent, \"utf-8\");\n});\n" }, { "path": "addons/Dexie.Syncable/.gitignore", "content": "dist/*.js\ndist/*.map\ndist/*.ts\ndist/*.gz\n.eslintcache\n**/tmp/\n" }, { "path": "addons/Dexie.Syncable/.npmignore", "content": "tools/\nsrc/\n.*\ntmp/\n**/tmp/\ntest\n*.log\n" }, { "path": "addons/Dexie.Syncable/README.md", "content": "# Dexie.Syncable.js\n\nEnables two-way synchronization with remote database.\n\n*NOTE! This package has been unmaintained for a looong time and might be retired. Some people go under the impression that Dexie Cloud would be based on this package, but it's not - it has its own sync system based on middlewares - all source for it is in addons/dexie-cloud.*\n\n### Install\n```\nnpm install dexie --save\nnpm install dexie-observable --save\nnpm install dexie-syncable --save\n```\n\n### Use\n```js\nimport Dexie from 'dexie';\nimport 'dexie-syncable'; // will import dexie-observable as well.\n\n// Use Dexie as normally - but you can also register your sync protocols though\n// Dexie.Syncable.registerSyncProtocol() api as well as using the db.syncable api\n// as documented here.\n\n```\n\n### Dependency Tree\n\n * **Dexie.Syncable.js**\n * [Dexie.Observable.js](https://dexie.org/docs/Observable/Dexie.Observable.js)\n * [Dexie.js](https://dexie.org/docs/Dexie/Dexie.js)\n * [IndexedDB](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API)\n * _An implementation of [ISyncProtocol](https://dexie.org/docs/Syncable/Dexie.Syncable.ISyncProtocol)_\n\n### Tutorial\n\n#### 1. Include Required Sources\nIn your HTML, make sure to include Dexie.js, Dexie.Observable.js, Dexie.Syncable.js and an implementation of [ISyncProtocol](https://dexie.org/docs/Syncable/Dexie.Syncable.ISyncProtocol).\n\n \n \n \n \n \n ...\n \n \n \n##### Usage with existing DB\n\nIn case you want to use Dexie.Syncable with your existing database, but do not want to use UUID based Primary Keys as described below, you will have to do a schema upgrade. Without it Dexie.Syncable will not be able to properly work.\n\n```javascript\nimport Dexie from 'dexie';\nimport 'dexie-observable';\nimport 'dexie-syncable';\nimport 'your-sync-protocol-implementation';\n\nvar db = new Dexie('myExistingDb');\ndb.version(1).stores(... existing schema ...);\n\n// Now, add another version, just to trigger an upgrade for Dexie.Syncable\ndb.version(2).stores({}); // No need to add / remove tables. This is just to allow the addon to install its tables.\n```\n\n#### 2. Use UUID based Primary Keys ($$)\nTwo way replication cannot use auto-incremented keys if any sync node should be able to create objects no matter if it is offline or online. Dexie.Syncable comes with a new syntax when defining your store schemas: the double-dollar prefix ($$). Similarly to the ++ prefix in Dexie (meaning auto-incremented primary key), the double-dollar prefix means that the key will be given a universally unique identifier (UUID), in string format (For example \"9cc6768c-358b-4d21-ac4d-58cc0fddd2d6\").\n\n var db = new Dexie(\"MySyncedDB\");\n db.version(1).stores({\n friends: \"$$oid,name,shoeSize\",\n pets: \"$$oid,name,kind\"\n });\n\n#### 3. Connect to Server\nYou must specify the URL of the server you want to keep in-sync with. This has to be done once in the entire database life-time, but doing it on every startup is ok as well, since it won't affect already connected URLs.\n\n // This example uses the WebSocketSyncProtocol included in earlier steps.\n db.syncable.connect (\"websocket\", \"https://syncserver.com/sync\");\n db.syncable.on('statusChanged', function (newStatus, url) {\n console.log (\"Sync Status changed: \" + Dexie.Syncable.StatusTexts[newStatus]);\n });\n\n#### 4. Use Your Database\nQuery and modify your database as if it was a simple Dexie instance. Any changes will be replicated to the server and changes on the server or an other window will replicate back to you.\n\n db.transaction('rw', db.friends, function (friends) {\n friends.add({name: \"Arne\", shoeSize: 47});\n friends.where('shoeSize').above(40).each(function (friend) {\n console.log(\"Friend with shoeSize over 40: \" + friend.name);\n });\n });\n\n_NOTE: Transactions only provide the Atomicity part of the [ACID](http://en.wikipedia.org/wiki/ACID) properties when using 2-way synchronization. This is due to the fact that the syncronization phase may result in another change overwriting the changes. However, it's still meaningful to use the transaction() method for atomicity. Atomicity is guaranteed not only locally but also when synced to the server, meaning that a part of the changes will never commit on the server until all changes from the transaction have been synced. In practice, you cannot increment a counter in the database (for example) and expect it to be consistent, but you can have a guaranteed that if you add a sequence of objects, all or none of them will replicate._\n\n### API Reference\n\n#### Static Members\n\n[Dexie.Syncable.registerSyncProtocol (name, protocolInstance)](https://dexie.org/docs/Syncable/Dexie.Syncable.registerSyncProtocol())\nDefine how to replicate changes with your type of server.\n\n[Dexie.Syncable.Statuses](https://dexie.org/docs/Syncable/Dexie.Syncable.Statuses)\nEnum of possible sync statuses, such as OFFLINE, CONNECTING, ONLINE and ERROR.\n\n[Dexie.Syncable.StatusTexts](https://dexie.org/docs/Syncable/Dexie.Syncable.StatusTexts)\nText lookup for status numbers\n\n#### Non-Static Methods and Events\n\n[db.syncable.connect (protocol, url, options)](https://dexie.org/docs/Syncable/db.syncable.connect())\nCreate a persistend two-way sync connection with the given URL.\n\n[db.syncable.disconnect (url)](https://dexie.org/docs/Syncable/db.syncable.disconnect())\nStop syncing with the given URL but keep revision states until next connect.\n\n[db.syncable.delete(url)](https://dexie.org/docs/Syncable/db.syncable.delete())\nDelete all states and change queue for given URL.\n\n[db.syncable.list()](https://dexie.org/docs/Syncable/db.syncable.list())\nList the URLs of each remote node we have a state saved for.\n\n[db.syncable.on('statusChanged')](https://dexie.org/docs/Syncable/db.syncable.on('statusChanged'))\nEvent triggered when sync status changes.\n\n[db.syncable.setFilter ([criteria], filter)](https://dexie.org/docs/Syncable/db.syncable.setFilter())\nIgnore certain objects from being synced defined by the given filter.\n\n[db.syncable.getStatus (url)](https://dexie.org/docs/Syncable/db.syncable.getStatus())\nGet sync status for the given URL.\n\n[db.syncable.getOptions (url)](https://dexie.org/docs/Syncable/db.syncable.getOptions())\nGet the options object for the given URL.\n\n\n### Source\n\n[Dexie.Syncable.js](https://github.com/dexie/Dexie.js/blob/master/addons/Dexie.Syncable/src/Dexie.Syncable.js)\n\n### Description\n\nDexie.Syncable enables synchronization with a remote database (of almost any kind). It has its own API [ISyncProtocol](https://dexie.org/docs/Syncable/Dexie.Syncable.ISyncProtocol).\nThe [ISyncProtocol](https://dexie.org/docs/Syncable/Dexie.Syncable.ISyncProtocol) is pretty straight-forward to implement.\nThe implementation of that API defines how client- and server- changes are transported between local and remote nodes. The API support both poll-patterns\n(such as ajax calls) and direct reaction pattern (such as WebSocket or long-polling methods). See samples below for each pattern.\n\n### Sample [ISyncProtocol](https://dexie.org/docs/Syncable/Dexie.Syncable.ISyncProtocol) Implementations\n * [https://github.com/nponiros/sync_client](https://github.com/nponiros/sync_client)\n * [AjaxSyncProtocol.js](https://github.com/dfahlander/Dexie.js/blob/master/samples/remote-sync/ajax/AjaxSyncProtocol.js)\n * [WebSocketSyncProtocol.js](https://github.com/dfahlander/Dexie.js/blob/master/samples/remote-sync/websocket/WebSocketSyncProtocol.js)\n\n### Sample Sync Servers\n * [https://github.com/nponiros/sync_server](https://github.com/nponiros/sync_server)\n * [WebSocketSyncServer.js](https://github.com/dfahlander/Dexie.js/blob/master/samples/remote-sync/websocket/WebSocketSyncServer.js)\n" }, { "path": "addons/Dexie.Syncable/api.d.ts", "content": "/* dexie-syncable API - an independant syncronization API used by 'dexie-syncable'.\n * Version: 1.1\n * Date: December 2016\n *\n * Some assumptions are made upon how the database is structured though. We assume that:\n * * Databases has 1..N tables. (For NOSQL databases without tables, this also works since it could be considered a db with a single table.)\n * * Each table has a primary key.\n *\t* The primary key is a UUID of some kind since auto-incremented primary keys are not suitable for syncronization\n * (auto-incremented key would work but changes of conflicts would increase on create).\n * * A database record is a JSON compatible object.\n * * Always assume that the client may send the same set of changes twice. For example if client sent changes that server stored, but network went down before\n * client got the ack from server, the client may try resending same set of changes again. This means that the same Object Create change may be sent twice etc.\n * The implementation must not fail if trying to create an object with the same key twice, or delete an object with a key that does not exist.\n * * Client and server must resolve conflicts in such way that the result on both sides are equal.\n * * Since a server is the point of the most up-to-date database, conflicts should be resolved by prefering server changes over client changes.\n * This makes it predestinable for client that the more often the client syncs, the more chance to prohibit conflicts.\n *\n * By separating module 'dexie-syncable' from 'dexie-syncable/api' we\n * distinguish that:\n *\n * import {...} from 'dexie-syncable/api' is only for getting access to its\n * interfaces and has no side-effects.\n * Typescript-only import.\n *\n * import 'dexie-syncable' is only for side effects - to extend Dexie with\n * functionality of dexie-syncable.\n * Javascript / Typescript import.\n *\n */\n\nimport {IDatabaseChange} from 'dexie-observable/api';\nexport {DatabaseChangeType} from 'dexie-observable/api';\n\n/* ISyncProtocol\n\n Interface to implement for enabling syncronization with a remote database server. The remote database server may be SQL- or NOSQL based\n as long as it is capable of storing JSON compliant objects into some kind of object stores and reference them by a primary key.\n The server must also be revision- and changes aware. This is something that for many databases needs to be implemented by a REST- or\n WebSocket gateway between the client and the backend database. The gateway can act as a controller and make sure any changes\n are registered in the 'changes' table and that the API provides a sync() method to interchange changes between client and server.\n\n Two examples of a ISyncProtocol instances are found in:\n https://github.com/dfahlander/Dexie.js/tree/master/samples/remote-sync/ajax/AjaxSyncProtocol.js\n https://github.com/dfahlander/Dexie.js/tree/master/samples/remote-sync/websocket/WebSocketSyncProtocol.js\n\n*/\n\n/**\n * The interface to implement to provide sync towards a remote server.\n *\n * Documentation for this interface: https://github.com/dfahlander/Dexie.js/wiki/Dexie.Syncable.ISyncProtocol\n *\n */\nexport interface ISyncProtocol {\n partialsThreshold?: number;\n sync (\n context: IPersistedContext,\n url: string,\n options: any,\n baseRevision: any,\n syncedRevision: any,\n changes: IDatabaseChange[],\n partial: boolean,\n applyRemoteChanges: ApplyRemoteChangesFunction,\n onChangesAccepted: ()=>void,\n onSuccess: (continuation: PollContinuation | ReactiveContinuation)=>void,\n onError: (error: any, again?: number) => void) : void;\n}\n\n/**\n * Documentation for this interface: https://github.com/dfahlander/Dexie.js/wiki/Dexie.Syncable.IPersistedContext\n */\nexport interface IPersistedContext {\n save() : Promise;\n [customProp: string] : any;\n}\n\n/**\n * Documentation for this function: https://github.com/dfahlander/Dexie.js/wiki/Dexie.Syncable.ISyncProtocol\n */\nexport type ApplyRemoteChangesFunction = (\n changes: IDatabaseChange[],\n lastRevision: any,\n partial?: boolean,\n clear?: boolean)\n => Promise;\n\n/**\n * Provide a poll continuation if your backend is a reqest/response service, such as a REST API.\n */\nexport interface PollContinuation {\n /** Implementation should return number of milliseconds until you want the framework to call sync() again. */\n again: number\n}\n\n/**\n * Provide a reactive continuation if your backend is connected to over WebSocket, socket-io, signalR or such,\n * and may push changes back to the client as they occur.\n */\nexport interface ReactiveContinuation {\n react (\n /** List of local changes to send to server. */\n changes: IDatabaseChange[],\n\n /** Server revision that server needs to know in order to apply the changes correcly. */\n baseRevision: any,\n\n /** If true, it means that reach() will be called upon again with additional changes once you'version\n * called onChangesAccepted(). An implementation may handle this transactionally, i.e. wait with applying\n * these changes and instead buffer them in a temporary table and the apply everything once reac() is called\n * with partial=false.\n */\n partial: boolean,\n\n /** Callback to call when the given changes has been acknowledged and persisted at the server side.\n * This will mark the change-set as delivered and the framework wont try resending these changes anymore.\n */\n onChangesAccepted: ()=>void): void;\n\n /** Implementation should disconned the underlying transport and stop calling applyRemoteChanges(). */\n disconnect(): void;\n}\n\nexport enum SyncStatus {\n /** An irrepairable error occurred and the sync provider is dead. */\n ERROR = -1,\n\n /** The sync provider hasnt yet become online, or it has been disconnected. */\n OFFLINE = 0,\n\n /** Trying to connect to server */\n CONNECTING = 1,\n\n /** Connected to server and currently in sync with server */\n ONLINE = 2,\n\n /** Syncing with server. For poll pattern, this is every poll call.\n * For react pattern, this is when local changes are being sent to server. */\n SYNCING = 3,\n\n /** An error occured such as net down but the sync provider will retry to connect. */\n ERROR_WILL_RETRY = 4\n}\n" }, { "path": "addons/Dexie.Syncable/api.js", "content": "// This file is deliberatly left empty to allow the api.d.ts to contain the definitions for Dexie.Syncable without generating an error on webpack\n" }, { "path": "addons/Dexie.Syncable/dist/README.md", "content": "## Can't find dexie-syncable.js?\nTranspiled code (dist version) IS ONLY checked in to\nthe [releases](https://github.com/dexie/Dexie.js/tree/releases/addons/Dexie.Syncable/dist).\nbranch.\n\n## Download\n[unpkg.com/dexie-syncable/dist/dexie-syncable.js](https://unpkg.com/dexie-syncable/dist/dexie-syncable.js)\n\n[unpkg.com/dexie-syncable/dist/dexie-syncable.min.js](https://unpkg.com/dexie-syncable/dist/dexie-syncable.min.js)\n\n[unpkg.com/dexie-syncable/dist/dexie-syncable.js.map](https://unpkg.com/dexie-syncable/dist/dexie-syncable.js.map)\n\n[unpkg.com/dexie-syncable/dist/dexie-syncable.min.js.map](https://unpkg.com/dexie-syncable/dist/dexie-syncable.min.js.map)\n\n## npm\n```\nnpm install dexie-syncable --save\n```\n## bower\nSince Dexie v1.3.4, addons are included in the dexie bower package. \n```\n$ bower install dexie --save\n$ ls bower_components/dexie/addons/Dexie.Syncable/dist\ndexie-syncable.js dexie-syncable.js.map dexie-syncable.min.js dexie-syncable.min.js.map\n\n```\n## Or build them yourself...\nFork Dexie.js, then:\n```\ngit clone https://github.com/YOUR-USERNAME/Dexie.js.git\ncd Dexie.js\nnpm install\ncd addons/Dexie.Syncable\nnpm run build # or npm run watch\n\n```\nIf you're on windows, you need to use an elevated command prompt of some reason to get `npm install` to work.\n" }, { "path": "addons/Dexie.Syncable/package.json", "content": "{\n \"name\": \"dexie-syncable\",\n \"version\": \"4.0.1-beta.13\",\n \"description\": \"Addon to Dexie that makes it possible to sync indexeDB with remote databases.\",\n \"main\": \"dist/dexie-syncable.js\",\n \"module\": \"dist/dexie-syncable.es.js\",\n \"jsnext:main\": \"dist/dexie-syncable.es.js\",\n \"typings\": \"dist/dexie-syncable.d.ts\",\n \"jspm\": {\n \"format\": \"cjs\",\n \"ignore\": [\n \"src/\"\n ]\n },\n \"repository\": {\n \"type\": \"git\",\n \"url\": \"https://github.com/dexie/Dexie.js.git\"\n },\n \"keywords\": [\n \"indexeddb\",\n \"dexie\",\n \"addon\",\n \"database\",\n \"sync\"\n ],\n \"author\": \"David Fahlander \",\n \"contributors\": [\n \"Nikolas Poniros \",\n \"Martin Diphoorn \"\n ],\n \"license\": \"Apache-2.0\",\n \"bugs\": {\n \"url\": \"https://github.com/dexie/Dexie.js/issues\"\n },\n \"scripts\": {\n \"build\": \"just-build\",\n \"watch\": \"just-build --watch\",\n \"test\": \"pnpm run build && pnpm run test:typings && pnpm run test:unit && pnpm run test:integration\",\n \"test:unit\": \"karma start test/unit/karma.conf.js --single-run\",\n \"test:integration\": \"karma start test/integration/karma.conf.js --single-run\",\n \"test:typings\": \"tsc -p test/test-typings/\",\n \"test:unit:debug\": \"karma start test/unit/karma.conf.js --log-level debug\",\n \"test:integration:debug\": \"karma start test/integrations/karma.conf.js --log-level debug\",\n \"test:ltcloud\": \"cross-env LAMBDATEST=true pnpm run test:ltTunnel & sleep 10 && pnpm run test:unit; UNIT_STATUS=$?; exit $UNIT_STATUS\",\n \"test:ltTunnel\": \"node ../../test/lt-local\",\n \"test:ltcloud:integration\": \"cross-env LAMBDATEST=true pnpm run test:integration; UNIT_STATUS=$?; kill $(cat tunnel.pid); exit $UNIT_STATUS\"\n },\n \"just-build\": {\n \"default\": [\n \"just-build release\"\n ],\n \"dev\": [\n \"just-build dexie-syncable\"\n ],\n \"dexie-syncable\": [\n \"# Build UMD module and the tests (two bundles)\",\n \"tsc --allowJs --moduleResolution node --lib es2020,dom -t es5 -m es2015 --outDir tools/tmp/es5 --rootDir ../.. --sourceMap src/Dexie.Syncable.js test/unit/unit-tests-all.js [--watch 'Compilation complete.']\",\n \"rollup -c tools/build-configs/rollup.config.mjs\",\n \"rollup -c tools/build-configs/rollup.tests.config.mjs\",\n \"node tools/replaceVersionAndDate.js dist/dexie-syncable.js\",\n \"node tools/replaceVersionAndDate.js test/unit/bundle.js\",\n \"# eslint \",\n \"eslint src --cache\"\n ],\n \"release\": [\n \"just-build dexie-syncable\",\n \"# Copy Dexie.Syncable.d.ts to dist and replace version in it\",\n \"node -e \\\"fs.writeFileSync('dist/dexie-syncable.d.ts', fs.readFileSync('src/Dexie.Syncable.d.ts'))\\\"\",\n \"node tools/replaceVersionAndDate.js dist/dexie-syncable.d.ts\",\n \"# Minify the default ES5 UMD module\",\n \"cd dist\",\n \"uglifyjs dexie-syncable.js -m -c negate_iife=0 -o dexie-syncable.min.js --source-map\"\n ]\n },\n \"homepage\": \"https://dexie.org\",\n \"peerDependencies\": {\n \"dexie\": \"workspace:^\",\n \"dexie-observable\": \"workspace:^\"\n },\n \"devDependencies\": {\n \"dexie\": \"workspace:^\",\n \"dexie-observable\": \"workspace:^\",\n \"eslint\": \"^5.16.0\",\n \"just-build\": \"^0.9.24\",\n \"qunit\": \"2.10.0\",\n \"qunitjs\": \"1.23.1\",\n \"typescript\": \"^5.3.3\",\n \"uglify-js\": \"^3.5.6\"\n }\n}\n" }, { "path": "addons/Dexie.Syncable/src/.eslintrc.json", "content": "{\n \"extends\": \"eslint:recommended\",\n \"parserOptions\": {\n \"ecmaVersion\": 6,\n \"sourceType\": \"module\",\n \"ecmaFeatures\": {\n }\n },\n \"rules\": {\n \"no-undef\": [\"error\"],\n \"no-unused-vars\": 1,\n \"no-console\": 0,\n \"no-empty\": 0\n },\n \"globals\": {\n \"indexedDB\": false,\n \"IDBKeyRange\": false,\n \"setTimeout\": false,\n \"clearTimeout\": false,\n \"Symbol\": false,\n \"setImmediate\": false,\n \"console\": false,\n \"self\": false,\n \"window\": false,\n \"global\": false,\n \"navigator\": false,\n \"location\": false,\n \"chrome\": false,\n \"document\": false,\n \"MutationObserver\": false,\n \"CustomEvent\": false,\n \"dispatchEvent\": false,\n \"localStorage\": false\n }\n}\n" }, { "path": "addons/Dexie.Syncable/src/Dexie.Syncable.d.ts", "content": "// Type definitions for dexie-syncable v{version}\n// Project: https://github.com/dfahlander/Dexie.js/tree/master/addons/Dexie.Syncable\n// Definitions by: David Fahlander \n\nimport Dexie, { DexieEventSet } from 'dexie';\nimport 'dexie-observable';\nimport { ISyncProtocol, SyncStatus } from '../api';\nimport {IDatabaseChange} from 'dexie-observable/api';\n\n\nexport interface SyncableEventSet extends DexieEventSet {\n (eventName: 'statusChanged', subscriber: (status: number, url: string) => void): void;\n}\n\n//\n// Extend Dexie interface\n//\ndeclare module 'dexie' {\n interface Dexie {\n syncable: {\n version: string;\n /**\n * Connect to given URL using given protocol and options. See documentation at:\n * https://github.com/dfahlander/Dexie.js/wiki/db.syncable.connect()\n */\n connect(protocol: string, url: string, options?: any): Dexie.Promise;\n\n /**\n * Stop syncing with given url.. See docs at:\n * https://github.com/dfahlander/Dexie.js/wiki/db.syncable.disconnect()\n */\n disconnect(url: string): Dexie.Promise;\n\n /**\n * Stop syncing and delete all sync state for given URL. See docs at:\n * https://github.com/dfahlander/Dexie.js/wiki/db.syncable.delete()\n */\n delete(url: string): Dexie.Promise;\n\n /**\n * List remote URLs. See docs at:\n * https://github.com/dfahlander/Dexie.js/wiki/db.syncable.list()\n */\n list (): Dexie.Promise;\n\n /**\n * Get sync status for given URL. See docs at:\n * https://github.com/dfahlander/Dexie.js/wiki/db.syncable.getStatus()\n */\n getStatus(url: string): Dexie.Promise;\n\n /**\n * Syncable events. See docs at:\n * https://github.com/dfahlander/Dexie.js/wiki/db.syncable.on('statusChanged')\n */\n on: SyncableEventSet;\n }\n\n /**\n * Table used for storing uncommitted changes when downloading partial change sets from\n * a sync server.\n *\n * Each change is bound to a node id (represents the remote server that the change was\n * downloaded from)\n */\n _uncommittedChanges: Dexie.Table;\n }\n\n interface DexieConstructor {\n Syncable: {\n (db: Dexie) : void;\n\n version: string;\n\n /**\n * See documentation at:\n * https://dexie.org/docs/Syncable/Dexie.Syncable.registerSyncProtocol()\n */\n registerSyncProtocol: (name: string, prototocolInstance: ISyncProtocol) => void;\n\n /** Translates a sync status number into a string \"ERROR_WILL_RETRY\", \"ERROR\", etc */\n StatusTexts: {[syncStatus:number]: string};\n }\n }\n}\n\n//\n// Extend dexie-observable interfaces\n//\ndeclare module \"dexie-observable\" {\n // Extend SyncNode interface from Dexie.Observable to\n // allow storing remote nodes in table _syncNodes.\n interface SyncNode {\n url: string, // Only applicable for \"remote\" nodes. Only used in Dexie.Syncable.\n syncProtocol: string, // Tells which implementation of ISyncProtocol to use for remote syncing.\n syncContext: any,\n syncOptions: any,\n status: number,\n appliedRemoteRevision: any,\n remoteBaseRevisions: { local: number, remote: any }[],\n dbUploadState: {\n tablesToUpload: string[],\n currentTable: string,\n currentKey: any,\n localBaseRevision: number\n }\n }\n}\n\nexport default Dexie.Syncable;\n\n" }, { "path": "addons/Dexie.Syncable/src/Dexie.Syncable.js", "content": "/* ========================================================================== \n * dexie-syncable.js\n * ==========================================================================\n *\n * Dexie addon for syncing indexedDB with remote endpoints.\n *\n * By David Fahlander, david.fahlander@gmail.com,\n * Nikolas Poniros, https://github.com/nponiros\n *\n * ==========================================================================\n *\n * Version {version}, {date}\n *\n * https://dexie.org\n *\n * Apache License Version 2.0, January 2004, http://www.apache.org/licenses/\n * \n */\n\nimport Dexie from \"dexie\";\n// Depend on 'dexie-observable'\n// To support both ES6,AMD,CJS and UMD (plain script), we just import it and then access it as \"Dexie.Observable\".\n// That way, our plugin works in all UMD cases.\n// If target platform would only be module based (ES6/AMD/CJS), we could have done 'import Observable from \"dexie-observable\"'.\nimport \"dexie-observable\";\n\nimport initSyncableConnect from './syncable-connect';\nimport initConnectFn from './connect-fn';\nimport {Statuses, StatusTexts} from './statuses';\n\nvar override = Dexie.override,\n Promise = Dexie.Promise,\n Observable = Dexie.Observable;\n\n/** Dexie addon for remote database sync.\n * \n * @param {Dexie} db \n */\nfunction Syncable (db) {\n if (!/^(3|4)\\./.test(Dexie.version))\n throw new Error(`Missing dexie version 3.x or 4.x`);\n if (!db.observable || (db.observable.version !== \"{version}\" && !/^(3|4)\\./.test(db.observable.version)))\n throw new Error(`Missing dexie-observable version 3.x or 4.x`);\n if (db.syncable) {\n if (db.syncable.version !== \"{version}\") throw new Error(`Mixed versions of dexie-syncable: \"{version}\" vs \"${db.syncable.version}\"`);\n return; // Addon already active.\n }\n\n var activePeers = [];\n\n const connectFn = initConnectFn(db, activePeers);\n const syncableConnect = initSyncableConnect(db, connectFn);\n\n db.on('message', function(msg) {\n // Message from other local node arrives...\n Dexie.vip(function() {\n if (msg.type === 'connect') {\n // We are master node and another non-master node wants us to do the connect.\n db.syncable.connect(msg.message.protocolName, msg.message.url, msg.message.options).then(msg.resolve, msg.reject);\n } else if (msg.type === 'disconnect') {\n db.syncable.disconnect(msg.message.url).then(msg.resolve, msg.reject);\n } else if (msg.type === 'syncStatusChanged') {\n // We are client and a master node informs us about syncStatus change.\n // Lookup the connectedProvider and call its event\n db.syncable.on.statusChanged.fire(msg.message.newStatus, msg.message.url);\n }\n });\n });\n\n db.on('cleanup', function(weBecameMaster) {\n // A cleanup (done in Dexie.Observable) may result in that a master node is removed and we become master.\n if (weBecameMaster) {\n // We took over the master role in Observable's cleanup method.\n // We should connect to remote servers now.\n // At this point, also reconnect servers with status ERROR_WILL_RETRY as well as plain ERROR.\n // Reason to reconnect to those with plain \"ERROR\" is that the ERROR state may occur when a database\n // connection has been closed. The new master would then be expected to reconnect.\n // Also, this is not an infinite poll(). This is rare event that a new browser tab takes over from\n // an old closed one. \n Dexie.ignoreTransaction(()=>Dexie.vip(()=>{\n return db._syncNodes.where({type: 'remote'})\n .filter(node => node.status !== Statuses.OFFLINE)\n .toArray(connectedRemoteNodes => Promise.all(connectedRemoteNodes.map(node => \n db.syncable.connect(node.syncProtocol, node.url, node.syncOptions).catch(e => {\n console.warn(`Dexie.Syncable: Could not connect to ${node.url}. ${e.stack || e}`);\n })\n )));\n })).catch('DatabaseClosedError', ()=>{});\n }\n });\n\n // \"ready\" subscriber for the master node that makes sure it will always connect to sync server\n // when the database opens. It will not wait for the connection to complete, just initiate the\n // connection so that it will continue syncing as long as the database is open.\n\n // Dexie.Observable's 'ready' subscriber will have been invoked prior to this, making sure\n // that db._localSyncNode exists and persisted before this subscriber kicks in.\n db.on('ready', function onReady() {\n // Again, in onReady: If we ARE master, make sure to connect to remote servers that is in a connected state.\n if (db._localSyncNode && db._localSyncNode.isMaster) {\n // Make sure to connect to remote servers that is in a connected state (NOT OFFLINE or ERROR!)\n // This \"ready\" subscriber will never be the one performing the initial sync request, because\n // even after calling db.syncable.connect(), there won't exist any \"remote\" sync node yet.\n // Instead, db.syncable.connect() will subscribe to \"ready\" also, and that subscriber will be\n // called after this one. There, in that subscriber, the initial sync request will take place\n // and the \"remote\" node will be created so that this \"ready\" subscriber can auto-connect the\n // next time this database is opened.\n // CONCLUSION: We can always assume that the local DB has been in sync with the server at least\n // once in the past for each \"connectedRemoteNode\" we find in query below.\n\n // Don't halt db.ready while connecting (i.e. we do not return a promise here!)\n db._syncNodes\n .where('type').equals('remote')\n .and(node => node.status !== Statuses.OFFLINE)\n .toArray(connectedRemoteNodes => {\n // There are connected remote nodes that we must manage (or take over to manage)\n connectedRemoteNodes.forEach(\n node => db.syncable.connect(\n node.syncProtocol,\n node.url,\n node.syncOptions) \n .catch (()=>{}) // A failure will be triggered in on('statusChanged'). We can ignore.\n );\n }).catch('DatabaseClosedError', ()=>{});\n }\n }, true); // True means the ready event will survive a db reopen - db.close()/db.open()\n\n db.syncable = {\n version: \"{version}\"\n };\n\n db.syncable.getStatus = function(url, cb) {\n if (db.isOpen()) {\n return Dexie.vip(function() {\n return db._syncNodes.where('url').equals(url).first(function(node) {\n return node ? node.status : Statuses.OFFLINE;\n });\n }).then(cb);\n } else {\n return Promise.resolve(Syncable.Statuses.OFFLINE).then(cb);\n }\n };\n\n db.syncable.getOptions = function(url, cb) {\n return db.transaction('r?', db._syncNodes, () => {\n return db._syncNodes.where('url').equals(url).first(function(node) {\n return node.syncOptions;\n }).then(cb);\n });\n };\n\n db.syncable.list = function() {\n return db.transaction('r?', db._syncNodes, ()=>{\n return db._syncNodes.where('type').equals('remote').toArray(function(a) {\n return a.map(function(node) { return node.url; });\n });\n });\n };\n\n db.syncable.on = Dexie.Events(db, { statusChanged: \"asap\" });\n\n db.syncable.disconnect = function(url) {\n return Dexie.ignoreTransaction(()=>{\n return Promise.resolve().then(()=>{\n if (db._localSyncNode && db._localSyncNode.isMaster) {\n return Promise.all(activePeers.filter(peer => peer.url === url).map(peer => {\n return peer.disconnect(Statuses.OFFLINE);\n }));\n } else {\n return db._syncNodes.where('isMaster').above(0).first(masterNode => {\n return db.observable.sendMessage('disconnect', { url: url }, masterNode.id, {wantReply: true});\n });\n }\n }).then(()=>{\n return db._syncNodes.where(\"url\").equals(url).modify(node => {\n node.status = Statuses.OFFLINE;\n });\n });\n });\n };\n\n db.syncable.connect = function(protocolName, url, options) {\n options = options || {}; // Make sure options is always an object because 1) Provider expects it to be. 2) We'll be persisting it and you cannot persist undefined.\n var protocolInstance = Syncable.registeredProtocols[protocolName];\n if (protocolInstance) {\n return syncableConnect(protocolInstance, protocolName, url, options);\n } else {\n return Promise.reject(\n new Error(\"ISyncProtocol '\" + protocolName + \"' is not registered in Dexie.Syncable.registerSyncProtocol()\")\n );\n }\n };\n\n db.syncable.delete = function(url) {\n return db.syncable.disconnect(url).then(()=>{\n return db.transaction('rw!', db._syncNodes, db._changes, db._uncommittedChanges, ()=>{\n // Find the node(s)\n // Several can be found, as detected by @martindiphoorn,\n // let's delete them and cleanup _uncommittedChanges and _changes \n // accordingly.\n let nodeIDsToDelete;\n return db._syncNodes\n .where(\"url\").equals(url)\n .toArray(nodes => nodes.map(node => node.id))\n .then(nodeIDs => {\n nodeIDsToDelete = nodeIDs;\n // Delete the syncNode that represents the remote endpoint.\n return db._syncNodes.where('id').anyOf(nodeIDs).delete()\n })\n .then (() =>\n // In case there were uncommittedChanges belonging to this, delete them as well\n db._uncommittedChanges.where('node').anyOf(nodeIDsToDelete).delete());\n }).then(()=> {\n // Spawn background job to delete old changes, now that a node has been deleted,\n // there might be changes in _changes table that is not needed to keep anymore.\n // This is done in its own transaction, or possible several transaction to prohibit\n // starvation\n Observable.deleteOldChanges(db);\n });\n });\n };\n\n db.syncable.unsyncedChanges = function(url) {\n return db._syncNodes.where(\"url\").equals(url).first(function(node) {\n return db._changes.where('rev').above(node.myRevision).toArray();\n });\n };\n\n db.close = override(db.close, function(origClose) {\n return function() {\n activePeers.forEach(function(peer) {\n peer.disconnect();\n });\n return origClose.apply(this, arguments);\n };\n });\n\n Object.defineProperty(\n db.observable.SyncNode.prototype,\n 'save', {\n enumerable: false,\n configurable: true,\n writable: true,\n value() {\n return db.transaction('rw?', db._syncNodes, () => {\n return db._syncNodes.put(this);\n });\n }\n });\n}\n\nSyncable.version = \"{version}\";\n\nSyncable.Statuses = Statuses;\n\nSyncable.StatusTexts = StatusTexts;\n\nSyncable.registeredProtocols = {}; // Map when key is the provider name.\n\nSyncable.registerSyncProtocol = function(name, protocolInstance) {\n /// \n /// Register a synchronization protocol that can synchronize databases with remote servers.\n /// \n /// Provider name\n /// Implementation of ISyncProtocol\n const partialsThreshold = protocolInstance.partialsThreshold;\n if (typeof partialsThreshold === 'number') {\n // Don't allow NaN or negative threshold\n if (isNaN(partialsThreshold) || partialsThreshold < 0) {\n throw new Error('The given number for the threshold is not supported');\n }\n // If the threshold is 0 we will not send any client changes but will get server changes\n } else {\n // Use Infinity as the default so simple protocols don't have to care about partial synchronization\n protocolInstance.partialsThreshold = Infinity;\n }\n Syncable.registeredProtocols[name] = protocolInstance;\n};\n\nif (Dexie.Syncable) {\n if (Dexie.Syncable.version !== \"{version}\") {\n throw new Error (`Mixed versions of dexie-syncable: \"{version}\" vs \"${Dexie.Syncable.version}\"`);\n }\n} else {\n // Register addon in Dexie:\n Dexie.Syncable = Syncable;\n Dexie.addons.push(Syncable);\n}\n\nexport default Dexie.Syncable;\n" }, { "path": "addons/Dexie.Syncable/src/PersistedContext.js", "content": "import Dexie from 'dexie';\n\nexport default function initPersistedContext(node) {\n //\n // PersistedContext : IPersistedContext\n //\n return class PersistedContext {\n constructor(nodeID, otherProps) {\n this.nodeID = nodeID;\n if (otherProps) Dexie.extend(this, otherProps);\n }\n\n save() {\n // Store this instance in the syncContext property of the node it belongs to.\n return Dexie.vip(() => {\n return node.save();\n });\n }\n }\n}\n" }, { "path": "addons/Dexie.Syncable/src/apply-changes.js", "content": "import { CREATE, DELETE, UPDATE } from './change_types';\nimport bulkUpdate from './bulk-update';\n\nexport default function initApplyChanges(db) {\n return function applyChanges(changes) {\n let collectedChanges = {};\n changes.forEach((change) => {\n if (!collectedChanges.hasOwnProperty(change.table)) {\n collectedChanges[change.table] = { [CREATE]: [], [DELETE]: [], [UPDATE]: [] };\n }\n collectedChanges[change.table][change.type].push(change);\n });\n let table_names = Object.keys(collectedChanges);\n let tables = table_names.map((table) => db.table(table));\n\n return db.transaction(\"rw\", tables, () => {\n table_names.forEach((table_name) => {\n const table = db.table(table_name);\n const specifyKeys = !table.schema.primKey.keyPath;\n const createChangesToApply = collectedChanges[table_name][CREATE];\n const deleteChangesToApply = collectedChanges[table_name][DELETE];\n const updateChangesToApply = collectedChanges[table_name][UPDATE];\n if (createChangesToApply.length > 0)\n table.bulkPut(createChangesToApply.map(c => c.obj), specifyKeys ?\n createChangesToApply.map(c => c.key) : undefined);\n if (updateChangesToApply.length > 0)\n bulkUpdate(table, updateChangesToApply);\n if (deleteChangesToApply.length > 0)\n table.bulkDelete(deleteChangesToApply.map(c => c.key));\n });\n });\n };\n}\n" }, { "path": "addons/Dexie.Syncable/src/bulk-update.js", "content": "import Dexie from 'dexie';\n\nexport default function bulkUpdate(table, changes) {\n let keys = changes.map(c => c.key);\n let map = {};\n // Retrieve current object of each change to update and map each\n // found object's primary key to the existing object:\n return table.where(':id').anyOf(keys).raw().each((obj, cursor) => {\n map[cursor.primaryKey+''] = obj;\n }).then(()=>{\n // Filter away changes whose key wasn't found in the local database\n // (we can't update them if we do not know the existing values)\n let updatesThatApply = changes.filter(c => map.hasOwnProperty(c.key+''));\n // Apply modifications onto each existing object (in memory)\n // and generate array of resulting objects to put using bulkPut():\n let objsToPut = updatesThatApply.map (c => {\n let curr = map[c.key+''];\n Object.keys(c.mods).forEach(keyPath => {\n Dexie.setByKeyPath(curr, keyPath, c.mods[keyPath]);\n });\n return curr;\n });\n return table.bulkPut(objsToPut);\n });\n}\n" }, { "path": "addons/Dexie.Syncable/src/change_types.js", "content": "// Change Types\nexport const CREATE = 1;\nexport const UPDATE = 2;\nexport const DELETE = 3;\n" }, { "path": "addons/Dexie.Syncable/src/combine-create-and-update.js", "content": "import Dexie from 'dexie';\n\nexport default function combineCreateAndUpdate(prevChange, nextChange) {\n var clonedChange = Dexie.deepClone(prevChange); // Clone object before modifying since the earlier change in db.changes[] would otherwise be altered.\n Object.keys(nextChange.mods).forEach(function (keyPath) {\n Dexie.setByKeyPath(clonedChange.obj, keyPath, nextChange.mods[keyPath]);\n });\n return clonedChange;\n}\n" }, { "path": "addons/Dexie.Syncable/src/combine-update-and-update.js", "content": "import Dexie from 'dexie';\n\nexport default function combineUpdateAndUpdate(prevChange, nextChange) {\n var clonedChange = Dexie.deepClone(prevChange); // Clone object before modifying since the earlier change in db.changes[] would otherwise be altered.\n Object.keys(nextChange.mods).forEach(function (keyPath) {\n // If prev-change was changing a parent path of this keyPath, we must update the parent path rather than adding this keyPath\n var hadParentPath = false;\n Object.keys(prevChange.mods).filter(function (parentPath) { return keyPath.indexOf(parentPath + '.') === 0; }).forEach(function (parentPath) {\n Dexie.setByKeyPath(clonedChange.mods[parentPath], keyPath.substr(parentPath.length + 1), nextChange.mods[keyPath]);\n hadParentPath = true;\n });\n if (!hadParentPath) {\n // Add or replace this keyPath and its new value\n clonedChange.mods[keyPath] = nextChange.mods[keyPath];\n }\n // In case prevChange contained sub-paths to the new keyPath, we must make sure that those sub-paths are removed since\n // we must mimic what would happen if applying the two changes after each other:\n Object.keys(prevChange.mods).filter(function (subPath) { return subPath.indexOf(keyPath + '.') === 0; }).forEach(function (subPath) {\n delete clonedChange.mods[subPath];\n });\n });\n return clonedChange;\n}\n" }, { "path": "addons/Dexie.Syncable/src/connect-fn.js", "content": "import Dexie from 'dexie';\n\nimport initGetOrCreateSyncNode from './get-or-create-sync-node';\nimport initConnectProtocol from './connect-protocol';\nimport {Statuses} from './statuses';\n\nexport default function initConnectFn(db, activePeers) {\n return function connect(protocolInstance, protocolName, url, options, dbAliveID) {\n /// \n var existingPeer = activePeers.filter(function (peer) {\n return peer.url === url;\n });\n if (existingPeer.length > 0) {\n const activePeer = existingPeer[0];\n const diffObject = {};\n Dexie.getObjectDiff(activePeer.syncOptions, options, diffObject);\n // Options have been changed\n // We need to disconnect and reconnect\n if (Object.keys(diffObject).length !== 0) {\n return db.syncable.disconnect(url)\n .then(() => {\n return execConnect();\n })\n } else {\n // Never create multiple syncNodes with same protocolName and url. Instead, let the next call to connect() return the same promise that\n // have already been started and eventually also resolved. If promise has already resolved (node connected), calling existing promise.then() will give a callback directly.\n return existingPeer[0].connectPromise;\n }\n }\n\n function execConnect() {\n // Use an object otherwise we wouldn't be able to get the reject promise from\n // connectProtocol\n var rejectConnectPromise = {p: null};\n const connectProtocol = initConnectProtocol(db, protocolInstance, dbAliveID, options, rejectConnectPromise);\n const getOrCreateSyncNode = initGetOrCreateSyncNode(db, protocolName, url);\n var connectPromise = getOrCreateSyncNode(options).then(function (node) {\n return connectProtocol(node, activePeer);\n });\n\n var disconnected = false;\n var activePeer = {\n url: url,\n status: Statuses.OFFLINE,\n connectPromise: connectPromise,\n syncOptions: options,\n on: Dexie.Events(null, \"disconnect\"),\n disconnect: function (newStatus, error) {\n var pos = activePeers.indexOf(activePeer);\n if (pos >= 0) activePeers.splice(pos, 1);\n if (error && rejectConnectPromise.p) rejectConnectPromise.p(error);\n if (!disconnected) {\n activePeer.on.disconnect.fire(newStatus, error);\n }\n disconnected = true;\n }\n };\n activePeers.push(activePeer);\n\n return connectPromise;\n }\n\n return execConnect();\n };\n}\n" }, { "path": "addons/Dexie.Syncable/src/connect-protocol.js", "content": "import Dexie from 'dexie';\n\nimport initEnqueue from './enqueue';\nimport initSaveToUncommittedChanges from './save-to-uncommitted-changes';\nimport initFinallyCommitAllChanges from './finally-commit-all-changes';\nimport initGetLocalChangesForNode from './get-local-changes-for-node/get-local-changes-for-node';\nimport {Statuses} from './statuses';\n\nconst Promise = Dexie.Promise;\n\nexport default function initConnectProtocol(db, protocolInstance, dbAliveID, options, rejectConnectPromise) {\n const enqueue = initEnqueue(db);\n var hasMoreToGive = {hasMoreToGive: true};\n\n function stillAlive() {\n // A better method than doing db.isOpen() because the same db instance may have been reopened, but then this sync call should be dead\n // because the new instance should be considered a fresh instance and will have another local node.\n return db._localSyncNode && db._localSyncNode.id === dbAliveID;\n }\n\n return function connectProtocol(node, activePeer) {\n /// \n const getLocalChangesForNode = initGetLocalChangesForNode(db, hasMoreToGive, protocolInstance.partialsThreshold);\n\n const url = activePeer.url;\n\n function changeStatusTo(newStatus) {\n if (node.status !== newStatus) {\n node.status = newStatus;\n node.save().then(()=> {\n db.syncable.on.statusChanged.fire(newStatus, url);\n // Also broadcast message to other nodes about the status\n db.observable.broadcastMessage(\"syncStatusChanged\", {newStatus: newStatus, url: url}, false);\n }).catch('DatabaseClosedError', ()=> {\n });\n }\n }\n\n activePeer.on('disconnect', function (newStatus) {\n if (!isNaN(newStatus)) changeStatusTo(newStatus);\n });\n\n var connectedContinuation;\n changeStatusTo(Statuses.CONNECTING);\n return doSync();\n\n function doSync() {\n // Use enqueue() to ensure only a single promise execution at a time.\n return enqueue(doSync, function () {\n // By returning the Promise returned by getLocalChangesForNode() a final catch() on the sync() method will also catch error occurring in entire sequence.\n return getLocalChangesForNode_autoAckIfEmpty(node, sendChangesToProvider);\n }, dbAliveID);\n }\n\n function sendChangesToProvider(changes, remoteBaseRevision, partial, nodeModificationsOnAck) {\n // Create a final Promise for the entire sync() operation that will resolve when provider calls onSuccess().\n // By creating finalPromise before calling protocolInstance.sync() it is possible for provider to call onError() immediately if it wants.\n var finalSyncPromise = new Promise(function (resolve, reject) {\n rejectConnectPromise.p = function (err) {\n reject(err);\n };\n Dexie.asap(function () {\n try {\n protocolInstance.sync(\n node.syncContext,\n url,\n options,\n remoteBaseRevision,\n node.appliedRemoteRevision,\n changes,\n partial,\n applyRemoteChanges,\n onChangesAccepted,\n function (continuation) {\n resolve(continuation);\n },\n onError);\n } catch (ex) {\n onError(ex, Infinity);\n }\n\n function onError(error, again) {\n reject(error);\n if (stillAlive()) {\n if (!isNaN(again) && again < Infinity) {\n setTimeout(function () {\n if (stillAlive()) {\n changeStatusTo(Statuses.SYNCING);\n doSync().catch('DatabaseClosedError', abortTheProvider);\n }\n }, again);\n changeStatusTo(Statuses.ERROR_WILL_RETRY, error);\n if (connectedContinuation && connectedContinuation.disconnect) connectedContinuation.disconnect();\n connectedContinuation = null;\n } else {\n abortTheProvider(error); // Will fire ERROR on statusChanged event.\n }\n }\n }\n });\n });\n\n return finalSyncPromise.then(function () {\n // Resolve caller of db.syncable.connect() with undefined. Not with continuation!\n return undefined;\n }).finally(()=> {\n // In case error happens after connect, don't try reject the connect promise anymore.\n // This is important. A Dexie unit test that verifies unhandled rejections will fail when Dexie.Syncable addon\n // is active and this happens. It would fire unhandledrejection but that we do not want.\n rejectConnectPromise.p = null;\n });\n\n function onChangesAccepted() {\n Object.keys(nodeModificationsOnAck).forEach(function (keyPath) {\n Dexie.setByKeyPath(node, keyPath, nodeModificationsOnAck[keyPath]);\n });\n // We dont know if onSuccess() was called by provider yet. If it's already called, finalPromise.then() will execute immediately,\n // otherwise it will execute when finalSyncPromise resolves.\n finalSyncPromise.then(continueSendingChanges);\n return node.save();\n }\n }\n\n function abortTheProvider(error) {\n activePeer.disconnect(Statuses.ERROR, error);\n }\n\n function getLocalChangesForNode_autoAckIfEmpty(node, cb) {\n return getLocalChangesForNode(node, function autoAck(changes, remoteBaseRevision, partial, nodeModificationsOnAck) {\n if (changes.length === 0 && 'myRevision' in nodeModificationsOnAck && nodeModificationsOnAck.myRevision !== node.myRevision) {\n Object.keys(nodeModificationsOnAck).forEach(function (keyPath) {\n Dexie.setByKeyPath(node, keyPath, nodeModificationsOnAck[keyPath]);\n });\n node.save().catch('DatabaseClosedError', ()=> {\n });\n return getLocalChangesForNode(node, autoAck);\n } else {\n return cb(changes, remoteBaseRevision, partial, nodeModificationsOnAck);\n }\n });\n }\n\n function applyRemoteChanges(remoteChanges, remoteRevision, partial/*, clear*/) {\n const saveToUncommittedChanges = initSaveToUncommittedChanges(db, node);\n const finallyCommitAllChanges = initFinallyCommitAllChanges(db, node);\n\n return enqueue(applyRemoteChanges, function () {\n if (!stillAlive()) return Promise.reject(new Dexie.DatabaseClosedError());\n // FIXTHIS: Check what to do if clear() is true!\n return (partial ? saveToUncommittedChanges(remoteChanges, remoteRevision) : finallyCommitAllChanges(remoteChanges, remoteRevision))\n .catch(function (error) {\n abortTheProvider(error);\n return Promise.reject(error);\n });\n }, dbAliveID);\n }\n\n //\n //\n // Continuation Patterns Follows\n //\n //\n\n function continueSendingChanges(continuation) {\n if (!stillAlive()) { // Database was closed.\n if (continuation.disconnect)\n continuation.disconnect();\n return;\n }\n\n connectedContinuation = continuation;\n activePeer.on('disconnect', function () {\n if (connectedContinuation) {\n if (connectedContinuation.react) {\n try {\n // react pattern must provide a disconnect function.\n connectedContinuation.disconnect();\n } catch (e) {\n }\n }\n connectedContinuation = null; // Stop poll() pattern from polling again and abortTheProvider() from being called twice.\n }\n });\n\n if (continuation.react) {\n continueUsingReactPattern(continuation);\n } else {\n continueUsingPollPattern(continuation);\n }\n }\n\n // React Pattern (eager)\n function continueUsingReactPattern(continuation) {\n var changesWaiting, // Boolean\n isWaitingForServer; // Boolean\n\n\n function onChanges() {\n if (connectedContinuation) {\n changeStatusTo(Statuses.SYNCING);\n if (isWaitingForServer)\n changesWaiting = true;\n else {\n reactToChanges();\n }\n }\n }\n\n db.on('changes', onChanges);\n\n activePeer.on('disconnect', function () {\n db.on.changes.unsubscribe(onChanges);\n });\n\n function reactToChanges() {\n if (!connectedContinuation) return;\n changesWaiting = false;\n isWaitingForServer = true;\n getLocalChangesForNode_autoAckIfEmpty(node, function (changes, remoteBaseRevision, partial, nodeModificationsOnAck) {\n if (!connectedContinuation) return;\n if (changes.length > 0) {\n continuation.react(changes, remoteBaseRevision, partial, function onChangesAccepted() {\n Object.keys(nodeModificationsOnAck).forEach(function (keyPath) {\n Dexie.setByKeyPath(node, keyPath, nodeModificationsOnAck[keyPath]);\n });\n node.save().catch('DatabaseClosedError', ()=> {\n });\n // More changes may be waiting:\n reactToChanges();\n });\n } else {\n isWaitingForServer = false;\n if (changesWaiting) {\n // A change jumped in between the time-spot of quering _changes and getting called back with zero changes.\n // This is an expreemely rare scenario, and eventually impossible. But need to be here because it could happen in theory.\n reactToChanges();\n } else {\n changeStatusTo(Statuses.ONLINE);\n }\n }\n }).catch(ex => {\n console.error(`Got ${ex.message} caught by reactToChanges`);\n abortTheProvider(ex);\n });\n }\n\n reactToChanges();\n }\n\n // Poll Pattern\n function continueUsingPollPattern() {\n\n function syncAgain() {\n getLocalChangesForNode_autoAckIfEmpty(node, function (changes, remoteBaseRevision, partial, nodeModificationsOnAck) {\n\n protocolInstance.sync(node.syncContext, url, options, remoteBaseRevision, node.appliedRemoteRevision, changes, partial, applyRemoteChanges, onChangesAccepted, onSuccess, onError);\n\n function onChangesAccepted() {\n Object.keys(nodeModificationsOnAck).forEach(function (keyPath) {\n Dexie.setByKeyPath(node, keyPath, nodeModificationsOnAck[keyPath]);\n });\n node.save().catch('DatabaseClosedError', ()=> {\n });\n }\n\n function onSuccess(continuation) {\n if (!connectedContinuation) {\n // Got disconnected before succeeding. Quit.\n return;\n }\n connectedContinuation = continuation;\n if (partial) {\n // We only sent partial changes. Need to do another round asap.\n syncAgain();\n } else {\n // We've sent all changes now (in sync!)\n if (!isNaN(continuation.again) && continuation.again < Infinity) {\n // Provider wants to keep polling. Set Status to ONLINE.\n changeStatusTo(Statuses.ONLINE);\n setTimeout(function () {\n if (connectedContinuation) {\n changeStatusTo(Statuses.SYNCING);\n syncAgain();\n }\n }, continuation.again);\n } else {\n // Provider seems finished polling. Since we are never going to poll again,\n // disconnect provider and set status to OFFLINE until another call to db.syncable.connect().\n activePeer.disconnect(Statuses.OFFLINE);\n }\n }\n }\n\n function onError(error, again) {\n if (!isNaN(again) && again < Infinity) {\n if (connectedContinuation) {\n setTimeout(function () {\n if (connectedContinuation) {\n changeStatusTo(Statuses.SYNCING);\n syncAgain();\n }\n }, again);\n changeStatusTo(Statuses.ERROR_WILL_RETRY);\n } // else status is already changed since we got disconnected.\n } else {\n abortTheProvider(error); // Will fire ERROR on onStatusChanged.\n }\n }\n }).catch(abortTheProvider);\n }\n\n if (hasMoreToGive.hasMoreToGive) {\n syncAgain();\n } else if (connectedContinuation && !isNaN(connectedContinuation.again) && connectedContinuation.again < Infinity) {\n changeStatusTo(Statuses.ONLINE);\n setTimeout(function () {\n if (connectedContinuation) {\n changeStatusTo(Statuses.SYNCING);\n syncAgain();\n }\n }, connectedContinuation.again);\n } else {\n // Provider seems finished polling. Since we are never going to poll again,\n // disconnect provider and set status to OFFLINE until another call to db.syncable.connect().\n activePeer.disconnect(Statuses.OFFLINE);\n }\n }\n };\n}\n" }, { "path": "addons/Dexie.Syncable/src/enqueue.js", "content": "import Dexie from 'dexie';\n\nexport default function initEnqueue(db) {\n return function enqueue(context, fn, instanceID) {\n function _enqueue() {\n if (!context.ongoingOperation) {\n context.ongoingOperation = Dexie.ignoreTransaction(function () {\n return Dexie.vip(function () {\n return fn();\n });\n }).finally(()=> {\n delete context.ongoingOperation;\n });\n } else {\n context.ongoingOperation = context.ongoingOperation.then(function () {\n return enqueue(context, fn, instanceID);\n });\n }\n return context.ongoingOperation;\n }\n\n if (!instanceID) {\n // Caller wants to enqueue it until database becomes open.\n if (db.isOpen()) {\n return _enqueue();\n } else {\n return Dexie.Promise.reject(new Dexie.DatabaseClosedError());\n }\n } else if (db._localSyncNode && instanceID === db._localSyncNode.id) {\n // DB is already open but queue doesn't want it to be queued if database has been closed (request bound to current instance of DB)\n return _enqueue();\n } else {\n return Dexie.Promise.reject(new Dexie.DatabaseClosedError());\n }\n };\n}\n" }, { "path": "addons/Dexie.Syncable/src/finally-commit-all-changes.js", "content": "import Dexie from 'dexie';\nimport initApplyChanges from './apply-changes';\n\nexport default function initFinallyCommitAllChanges(db, node) {\n const applyChanges = initApplyChanges(db);\n\n return function finallyCommitAllChanges(changes, remoteRevision) {\n // 1. Open a write transaction on all tables in DB\n const tablesToIncludeInTrans = db.tables.filter(table => table.name === '_changes' ||\n table.name === '_uncommittedChanges' ||\n table.schema.observable);\n\n return db.transaction('rw!', tablesToIncludeInTrans, () => {\n var trans = Dexie.currentTransaction;\n var localRevisionBeforeChanges = 0;\n return db._changes.orderBy('rev').last(function (lastChange) {\n // Store what revision we were at before committing the changes\n localRevisionBeforeChanges = (lastChange && lastChange.rev) || 0;\n }).then(() => {\n // Specify the source. Important for the change consumer to ignore changes originated from self!\n trans.source = node.id;\n // 2. Apply uncommitted changes and delete each uncommitted change\n return db._uncommittedChanges.where('node').equals(node.id).toArray();\n }).then(function (uncommittedChanges) {\n return applyChanges(uncommittedChanges);\n }).then(function () {\n return db._uncommittedChanges.where('node').equals(node.id).delete();\n }).then(function () {\n // 3. Apply last chunk of changes\n return applyChanges(changes);\n }).then(function () {\n // Get what revision we are at now:\n return db._changes.orderBy('rev').last();\n }).then(function (lastChange) {\n var currentLocalRevision = (lastChange && lastChange.rev) || 0;\n // 4. Update node states (appliedRemoteRevision, remoteBaseRevisions and eventually myRevision)\n node.appliedRemoteRevision = remoteRevision;\n node.remoteBaseRevisions.push({remote: remoteRevision, local: currentLocalRevision});\n if (node.myRevision === localRevisionBeforeChanges) {\n // If server was up-to-date before we added new changes from the server, update myRevision to last change\n // because server is still up-to-date! This is also important in order to prohibit getLocalChangesForNode() from\n // ever sending an empty change list to server, which would otherwise be done every second time it would send changes.\n node.myRevision = currentLocalRevision;\n }\n // Garbage collect remoteBaseRevisions not in use anymore:\n if (node.remoteBaseRevisions.length > 1) {\n for (var i = node.remoteBaseRevisions.length - 1; i > 0; --i) {\n if (node.myRevision >= node.remoteBaseRevisions[i].local) {\n node.remoteBaseRevisions.splice(0, i);\n break;\n }\n }\n }\n // We are not including _syncNodes in transaction, so this save() call will execute in its own transaction.\n node.save().catch(err=> {\n console.warn(\"Dexie.Syncable: Unable to save SyncNode after applying remote changes: \" + (err.stack || err));\n });\n });\n });\n };\n}\n" }, { "path": "addons/Dexie.Syncable/src/get-local-changes-for-node/get-base-revision-and-max-client-revision.js", "content": "export default function getBaseRevisionAndMaxClientRevision(node) {\n /// \n if (node.remoteBaseRevisions.length === 0)\n return {\n // No remoteBaseRevisions have arrived yet. No limit on clientRevision and provide null as remoteBaseRevision:\n maxClientRevision: Infinity,\n remoteBaseRevision: null\n };\n for (var i = node.remoteBaseRevisions.length - 1; i >= 0; --i) {\n if (node.myRevision >= node.remoteBaseRevisions[i].local) {\n // Found a remoteBaseRevision that fits node.myRevision. Return remoteBaseRevision and eventually a roof maxClientRevision pointing out where next remoteBaseRevision bases its changes on.\n return {\n maxClientRevision: i === node.remoteBaseRevisions.length - 1 ? Infinity : node.remoteBaseRevisions[i + 1].local,\n remoteBaseRevision: node.remoteBaseRevisions[i].remote\n };\n }\n }\n // There are at least one item in the list but the server hasn't yet become up-to-date with the 0 revision from client.\n return {\n maxClientRevision: node.remoteBaseRevisions[0].local,\n remoteBaseRevision: null\n };\n}\n" }, { "path": "addons/Dexie.Syncable/src/get-local-changes-for-node/get-changes-since-revision.js", "content": "import {CREATE, UPDATE} from '../change_types';\nimport mergeChange from '../merge-change';\n\nexport default function initGetChangesSinceRevision(db, node, hasMoreToGive) {\n return function getChangesSinceRevision(revision, maxChanges, maxRevision, cb) {\n /// Callback that will retrieve next chunk of changes and a boolean telling if it's a partial result or not. If truthy, result is partial and there are more changes to come. If falsy, these changes are the final result.\n var changeSet = {};\n var numChanges = 0;\n var partial = false;\n var ignoreSource = node.id;\n var nextRevision = revision;\n return db.transaction('r', db._changes, function () {\n var query = db._changes.where('rev').between(revision, maxRevision, false, true);\n return query.until(() => {\n if (numChanges === maxChanges) {\n partial = true;\n return true;\n }\n }).each(function (change) {\n // Note the revision in nextRevision:\n nextRevision = change.rev;\n // change.source is set based on currentTransaction.source\n if (change.source === ignoreSource) return;\n // Our _changes table contains more info than required (old objs, source etc). Just make sure to include the necessary info:\n var changeToSend = {\n type: change.type,\n table: change.table,\n key: change.key\n };\n if (change.type === CREATE)\n changeToSend.obj = change.obj;\n else if (change.type === UPDATE)\n changeToSend.mods = change.mods;\n\n var id = change.table + \":\" + change.key;\n var prevChange = changeSet[id];\n if (!prevChange) {\n // This is the first change on this key. Add it unless it comes from the source that we are working against\n changeSet[id] = changeToSend;\n ++numChanges;\n } else {\n // Merge the oldchange with the new change\n var nextChange = changeToSend;\n var mergedChange = mergeChange(prevChange, nextChange);\n changeSet[id] = mergedChange;\n }\n });\n }).then(function () {\n var changes = Object.keys(changeSet).map(function (key) {\n return changeSet[key];\n });\n hasMoreToGive.hasMoreToGive = partial;\n return cb(changes, partial, {myRevision: nextRevision});\n });\n };\n}\n" }, { "path": "addons/Dexie.Syncable/src/get-local-changes-for-node/get-local-changes-for-node.js", "content": "import Dexie from 'dexie';\n\nimport getBaseRevisionAndMaxClientRevision from './get-base-revision-and-max-client-revision';\nimport initGetChangesSinceRevision from './get-changes-since-revision';\nimport initGetTableObjectsAsChanges from './get-table-objects-as-changes';\n\nexport default function initGetLocalChangesForNode(db, hasMoreToGive, partialsThreshold) {\n var MAX_CHANGES_PER_CHUNK = partialsThreshold;\n\n return function getLocalChangesForNode(node, cb) {\n /// \n /// Based on given node's current revision and state, this function makes sure to retrieve next chunk of changes\n /// for that node.\n /// \n /// \n /// Callback that will retrieve next chunk of changes and a boolean telling if it's a partial result or not. If truthy, result is partial and there are more changes to come. If falsy, these changes are the final result.\n\n const getChangesSinceRevision = initGetChangesSinceRevision(db, node, hasMoreToGive);\n const getTableObjectsAsChanges = initGetTableObjectsAsChanges(db, node, MAX_CHANGES_PER_CHUNK, getChangesSinceRevision, hasMoreToGive, cb);\n\n // Only a \"remote\" SyncNode created by Dexie.Syncable\n // could not pass this test (remote nodes have myRevision: -1 on instantiation)\n if (node.myRevision >= 0) {\n // Node is based on a revision in our local database and will just need to get the changes that have occurred since that revision.\n var brmcr = getBaseRevisionAndMaxClientRevision(node);\n return getChangesSinceRevision(node.myRevision, MAX_CHANGES_PER_CHUNK, brmcr.maxClientRevision, function (changes, partial, nodeModificationsOnAck) {\n return cb(changes, brmcr.remoteBaseRevision, partial, nodeModificationsOnAck);\n });\n } else {\n // Node hasn't got anything from our local database yet. We will need to upload the entire DB to the node in the form of CREATE changes.\n // Check if we're in the middle of already doing that:\n if (node.dbUploadState === null) {\n // Initialize dbUploadState\n var tablesToUpload = db.tables.filter(function (table) {\n return table.schema.observable;\n }).map(function (table) {\n return table.name;\n });\n if (tablesToUpload.length === 0) return Dexie.Promise.resolve(cb([], null, false, {})); // There are no synced tables at all.\n var dbUploadState = {\n tablesToUpload: tablesToUpload,\n currentTable: tablesToUpload.shift(),\n currentKey: null\n };\n return db._changes.orderBy('rev').last(function (lastChange) {\n dbUploadState.localBaseRevision = (lastChange && lastChange.rev) || 0;\n var collection = db.table(dbUploadState.currentTable).orderBy(':id');\n return getTableObjectsAsChanges(dbUploadState, [], collection);\n });\n } else if (node.dbUploadState.currentKey) {\n const collection = db.table(node.dbUploadState.currentTable).where(':id').above(node.dbUploadState.currentKey);\n return getTableObjectsAsChanges(Dexie.deepClone(node.dbUploadState), [], collection);\n } else {\n const collection = db.table(dbUploadState.currentTable).orderBy(':id');\n return getTableObjectsAsChanges(Dexie.deepClone(node.dbUploadState), [], collection);\n }\n }\n };\n}\n" }, { "path": "addons/Dexie.Syncable/src/get-local-changes-for-node/get-table-objects-as-changes.js", "content": "import {CREATE} from '../change_types';\nimport getBaseRevisionAndMaxClientRevision from './get-base-revision-and-max-client-revision';\n\nexport default function initGetTableObjectsAsChanges(db, node, MAX_CHANGES_PER_CHUNK, getChangesSinceRevision, hasMoreToGive, cb) {\n return function getTableObjectsAsChanges(state, changes, collection) {\n /// \n /// \n /// \n var limitReached = false;\n return collection.until(function () {\n if (changes.length === MAX_CHANGES_PER_CHUNK) {\n limitReached = true;\n return true;\n }\n }).each(function (item, cursor) {\n changes.push({\n type: CREATE,\n table: state.currentTable,\n key: cursor.key,\n obj: cursor.value\n });\n state.currentKey = cursor.key;\n }).then(function () {\n if (limitReached) {\n // Limit reached. Send partial result.\n hasMoreToGive.hasMoreToGive = true;\n return cb(changes, null, true, {dbUploadState: state});\n } else {\n // Done iterating this table. Check if there are more tables to go through:\n if (state.tablesToUpload.length === 0) {\n // Done iterating all tables\n // Now append changes occurred during our dbUpload:\n var brmcr = getBaseRevisionAndMaxClientRevision(node);\n return getChangesSinceRevision(state.localBaseRevision, MAX_CHANGES_PER_CHUNK - changes.length, brmcr.maxClientRevision, function (additionalChanges, partial, nodeModificationsOnAck) {\n changes = changes.concat(additionalChanges);\n nodeModificationsOnAck.dbUploadState = null;\n return cb(changes, brmcr.remoteBaseRevision, partial, nodeModificationsOnAck);\n });\n } else {\n // Not done iterating all tables. Continue on next table:\n state.currentTable = state.tablesToUpload.shift();\n return getTableObjectsAsChanges(state, changes, db.table(state.currentTable).orderBy(':id'));\n }\n }\n });\n };\n}\n" }, { "path": "addons/Dexie.Syncable/src/get-or-create-sync-node.js", "content": "import Dexie from 'dexie';\n\nimport initPersistedContext from './PersistedContext';\n\nexport default function initGetOrCreateSyncNode(db, protocolName, url) {\n return function getOrCreateSyncNode(options) {\n return db.transaction('rw', db._syncNodes, db._changes, function () {\n if (!url) throw new Error(\"Url cannot be empty\");\n\n // Returning a promise from transaction scope will make the transaction promise resolve with the value of that promise.\n return db._syncNodes.where(\"url\").equalsIgnoreCase(url).first(function (node) {\n // If we found a node it will be instanceof SyncNode as Dexie.Observable\n // maps to class\n if (node) {\n const PersistedContext = initPersistedContext(node);\n // Node already there. Make syncContext become an instance of PersistedContext:\n node.syncContext = new PersistedContext(node.id, node.syncContext);\n node.syncProtocol = protocolName; // In case it was changed (would be very strange but...) could happen...\n node.syncOptions = options; // Options could have been changed\n db._syncNodes.put(node);\n } else {\n // Create new node and sync everything\n node = new db.observable.SyncNode();\n node.myRevision = -1;\n node.appliedRemoteRevision = null;\n node.remoteBaseRevisions = [];\n node.type = \"remote\";\n node.syncProtocol = protocolName;\n node.url = url;\n node.syncOptions = options;\n node.lastHeartBeat = Date.now();\n node.dbUploadState = null;\n const PersistedContext = initPersistedContext(node);\n Dexie.Promise.resolve(function () {\n // If options.initialUpload is explicitely false, set myRevision to currentRevision.\n if (options.initialUpload === false)\n return db._changes.toCollection().lastKey(function (currentRevision) {\n node.myRevision = currentRevision;\n });\n }()).then(function () {\n db._syncNodes.add(node).then(function (nodeID) {\n node.syncContext = new PersistedContext(nodeID); // Update syncContext in db with correct nodeId.\n db._syncNodes.put(node);\n });\n });\n }\n\n return node; // returning node will make the db.transaction()-promise resolve with this value.\n });\n });\n };\n}\n" }, { "path": "addons/Dexie.Syncable/src/merge-change.js", "content": "import { CREATE, UPDATE, DELETE } from './change_types';\nimport combineCreateAndUpdate from './combine-create-and-update.js';\nimport combineUpdateAndUpdate from './combine-update-and-update.js';\n\nexport default function mergeChange(prevChange, nextChange) {\n switch (prevChange.type) {\n case CREATE:\n switch (nextChange.type) {\n case CREATE:\n return nextChange; // Another CREATE replaces previous CREATE.\n case UPDATE:\n return combineCreateAndUpdate(prevChange, nextChange); // Apply nextChange.mods into prevChange.obj\n case DELETE:\n return nextChange; // Object created and then deleted. If it wasnt for that we MUST handle resent changes, we would skip entire change here. But what if the CREATE was sent earlier, and then CREATE/DELETE at later stage? It would become a ghost object in DB. Therefore, we MUST keep the delete change! If object doesnt exist, it wont harm!\n }\n break;\n case UPDATE:\n switch (nextChange.type) {\n case CREATE:\n return nextChange; // Another CREATE replaces previous update.\n case UPDATE:\n return combineUpdateAndUpdate(prevChange, nextChange); // Add the additional modifications to existing modification set.\n case DELETE:\n return nextChange; // Only send the delete change. What was updated earlier is no longer of interest.\n }\n break;\n case DELETE:\n switch (nextChange.type) {\n case CREATE:\n return nextChange; // A resurection occurred. Only create change is of interest.\n case UPDATE:\n return prevChange; // Nothing to do. We cannot update an object that doesnt exist. Leave the delete change there.\n case DELETE:\n return prevChange; // Still a delete change. Leave as is.\n }\n break;\n }\n}\n" }, { "path": "addons/Dexie.Syncable/src/save-to-uncommitted-changes.js", "content": "export default function initSaveToUncommittedChanges(db, node) {\n return function saveToUncommittedChanges(changes, remoteRevision) {\n return db.transaction('rw!', db._uncommittedChanges, () => {\n return db._uncommittedChanges.bulkAdd(changes.map(change => {\n let changeWithNodeId = {\n node: node.id,\n type: change.type,\n table: change.table,\n key: change.key\n };\n if (change.obj) changeWithNodeId.obj = change.obj;\n if (change.mods) changeWithNodeId.mods = change.mods;\n return changeWithNodeId;\n }));\n }).then(() => {\n node.appliedRemoteRevision = remoteRevision;\n return node.save();\n });\n };\n}\n" }, { "path": "addons/Dexie.Syncable/src/statuses.js", "content": "export const Statuses = {\n ERROR: -1, // An irreparable error occurred and the sync provider is dead.\n OFFLINE: 0, // The sync provider hasn't yet become online, or it has been disconnected.\n CONNECTING: 1, // Trying to connect to server\n ONLINE: 2, // Connected to server and currently in sync with server\n SYNCING: 3, // Syncing with server. For poll pattern, this is every poll call. For react pattern, this is when local changes are being sent to server.\n ERROR_WILL_RETRY: 4 // An error occurred such as net down but the sync provider will retry to connect.\n};\n\nexport const StatusTexts = {\n \"-1\": \"ERROR\",\n \"0\": \"OFFLINE\",\n \"1\": \"CONNECTING\",\n \"2\": \"ONLINE\",\n \"3\": \"SYNCING\",\n \"4\": \"ERROR_WILL_RETRY\"\n};\n" }, { "path": "addons/Dexie.Syncable/src/syncable-connect.js", "content": "import Dexie from 'dexie';\n\nconst Promise = Dexie.Promise;\n\nexport default function initSyncableConnect(db, connect) {\n return function syncableConnect(protocolInstance, protocolName, url, options) {\n if (db.isOpen()) {\n // Database is open\n if (!db._localSyncNode)\n throw new Error(\"Precondition failed: local sync node is missing. Make sure Dexie.Observable is active!\");\n\n if (db._localSyncNode.isMaster) {\n // We are master node\n return connect(protocolInstance, protocolName, url, options, db._localSyncNode.id);\n } else {\n // We are not master node\n // Request master node to do the connect:\n return db.table('_syncNodes').where('isMaster').above(0).first(function (masterNode) {\n // There will always be a master node. In theory we may self have become master node when we come here. But that's ok. We'll request ourselves.\n return db.observable.sendMessage('connect', {\n protocolName: protocolName,\n url: url,\n options: options\n }, masterNode.id, {wantReply: true});\n });\n }\n } else if (db.hasBeenClosed()) {\n // Database has been closed.\n return Promise.reject(new Dexie.DatabaseClosedError());\n } else if (db.hasFailed()) {\n // Database has failed to open\n return Promise.reject(new Dexie.InvalidStateError(\n \"Dexie.Syncable: Cannot connect. Database has failed to open\"));\n } else {\n // Database not yet open. It may be on its way to open, or open() hasn't yet been called.\n // Wait for it to open, then connect.\n var promise = new Promise(function (resolve, reject) {\n db.on(\"ready\", () => {\n // First, check if this is the very first time we connect to given URL.\n // Need to know, because if it is, we should stall the promise returned to\n // db.on('ready') to not be fulfilled until the initial sync has succeeded.\n return db._syncNodes.get({url}, node => {\n // Ok, now we know whether we should await the connect promise or not.\n // No matter, we should now connect (will maybe create the SyncNode instance\n // representing the given URL)\n let connectPromise = db.syncable.connect(protocolName, url, options);\n connectPromise.then(resolve, reject);// Resolve the returned promise when connected.\n // Ok, so let's see if we should suspend DB queries until connected or not:\n if (node && node.appliedRemoteRevision) {\n // The very first initial sync has been done so we need not wait\n // for the connect promise to complete. It can continue in background.\n // Returning here will resume db.on('ready') and resume all queries that\n // the application has put to the database.\n return;\n }\n // This was the very first time we connect to the remote server,\n // we must make sure that the initial sync request succeeeds before resuming\n // database queries that the application code puts onto the database.\n // If OFFLINE or other error, don't allow the application to proceed.\n // We are assuming that an initial sync is essential for the application to\n // function correctly.\n return connectPromise;\n });\n });\n // Force open() to happen. Otherwise connect() may stall forever.\n db.open().catch(ex => {\n // If open fails, db.on('ready') may not have been called and we must\n // reject promise with InvalidStateError\n reject(new Dexie.InvalidStateError(\n `Dexie.Syncable: Couldn't connect. Database failed to open`,\n ex\n ));\n });\n });\n return promise;\n }\n };\n}\n" }, { "path": "addons/Dexie.Syncable/test/gh-actions.sh", "content": "#!/bin/bash -e\ncd ../../Dexie.Observable\necho \"Installing dependencies for dexie-observable\"\npnpm install >/dev/null\necho \"Building dexie-observable\"\npnpm run build\ncd -\necho \"Installing dependencies for dexie-syncable\"\npnpm install >/dev/null\necho \"Building dexie-syncable\"\npnpm run build\n\npnpm run test:typings\npnpm run test:ltcloud\npnpm run test:ltcloud:integration\n" }, { "path": "addons/Dexie.Syncable/test/integration/dummy-sync-protocol.js", "content": "Dexie.Syncable.registerSyncProtocol(\"logger\", {\n sync: function (context, url, options, baseRevision, syncedRevision, changes, partial, applyRemoteChanges, onChangesAccepted, onSuccess, onError) {\n /// \n /// \n /// \n console.log(\"sync(changes.length: \"+ changes.length + \", baseRevision:\" + baseRevision + \", \" + (partial ? \"partial\" : \"full\") + \", syncedRevision:\" + syncedRevision + \")\");\n changes.forEach(function (change) {\n console.log(JSON.stringify(change, null, true));\n });\n \n setTimeout(function () {\n var dummyRev = 1,\n CREATE = 1,\n UPDATE = 2,\n DELETE = 3;\n\n onChangesAccepted().catch('DatabaseClosedError', function () {\n console.log(\"Got DatabaseClosedError while calling onChangesAccepted()\");\n });\n\n applyRemoteChanges([], \"ServerRevision\" + dummyRev++, true, false).catch('DatabaseClosedError', function() {\n console.log(\"Got DatabaseClosedError while calling applyRemoteChanges()\");\n });\n applyRemoteChanges([], \"ServerRevision\" + dummyRev++, false, false).catch('DatabaseClosedError', function(){\n console.log(\"Got DatabaseClosedError while calling applyRemoteChanges()\");\n })\n\n /*var dummyPoller = setInterval(function(){\n applyRemoteChanges([], \"ServerRevision\" + dummyRev++, true, false);\n applyRemoteChanges([], \"ServerRevision\" + dummyRev++, false, false);\n }, 10);*/\n \n onSuccess({\n react: function (changes, baseRevision, partial, onChangesAccepted) {\n console.log(\"react(changes.length: \" + changes.length + \", baseRevision:\" + baseRevision + \", \" + (partial ? \"partial\" : \"full\") + \")\");\n changes.forEach(function (change) {\n console.log(JSON.stringify(change, null, true));\n });\n setTimeout(onChangesAccepted, 0);\n },\n disconnect: function () {\n console.log(\"disconned()\");\n //clearInterval(dummyPoller);\n }\n });\n }, 0);\n }\n});\n\n// Make sure to always call sync() before any call to open().\nDexie.addons.push(function (db) {\n db.open = Dexie.override(db.open, function (origFunc) {\n return function () {\n if (!db.dynamicallyOpened() && !db.connectAlreadyCalled) {\n db.connectAlreadyCalled = true;\n console.log(\"Calling db.sync() on \" + db.name);\n db.syncable.connect(\"logger\", \"logger\").then(function() {\n console.log(\"connect() promise was resolved (database=\" + db.name + \")\");\n }).catch('DatabaseClosedError', function(){\n }).catch(function(err) {\n console.error(\"Error from connect() (database=\" + db.name + \"): \" + err.stack || err);\n });\n }\n return origFunc.apply(this, arguments);\n }\n });\n db.close = Dexie.override(db.close, function (origFunc) {\n return function() {\n db.connectAlreadyCalled = false;\n return origFunc.apply(this, arguments);\n }\n });\n});\n" }, { "path": "addons/Dexie.Syncable/test/integration/karma-env.js", "content": "// workerImports will be used by tests-open.js in the dexie test suite when\n// launching a Worker. This line will instruct the worker to import dexie-observable\n// and dexie-syncable.\nwindow.workerImports.push(\"../addons/Dexie.Observable/dist/dexie-observable.js\");\nwindow.workerImports.push(\"../addons/Dexie.Syncable/dist/dexie-syncable.js\");\n" }, { "path": "addons/Dexie.Syncable/test/integration/karma.conf.js", "content": "// Include common configuration\nconst {karmaCommon, getKarmaConfig, defaultBrowserMatrix} = require('../../../../test/karma.common');\n\nmodule.exports = function (config) {\n const browserMatrixOverrides = {\n // Be fine with testing on local travis firefox + browserstack chrome, latest supported.\n ci: [\"remote_chrome\"],\n // Safari fails to reply on browserstack. Need to not have it here.\n // Just complement with old chrome browser that is not part of CI test suite.\n pre_npm_publish: [\n \"Chrome\",\n ]\n };\n\n const cfg = getKarmaConfig(browserMatrixOverrides, {\n // Base path should point at the root \n basePath: '../../../../',\n // The files needed to apply dexie-observable to the standard dexie unit tests.\n files: karmaCommon.files.concat([\n 'dist/dexie.js',\n 'addons/Dexie.Syncable/test/integration/karma-env.js',\n 'addons/Dexie.Observable/dist/dexie-observable.js', // Apply observable addon\n 'addons/Dexie.Syncable/dist/dexie-syncable.js', // Apply syncable addon\n 'addons/Dexie.Syncable/test/integration/dummy-sync-protocol.js',\n 'test/bundle.js', // The dexie standard test suite\n { pattern: 'addons/Dexie.Observable/dist/*.map', watched: false, included: false },\n { pattern: 'addons/Dexie.Syncable/dist/*.map', watched: false, included: false }\n ])\n });\n\n config.set(cfg);\n}\n" }, { "path": "addons/Dexie.Syncable/test/integration/test-syncable-dexie-tests.html", "content": "\n\n\n \n Dexie Unit tests with Dexie.Syncable applied and dummy ISyncProtocol\n \n \n\n \n
\n
\n \n \n \n \n \n \n \n \n \n\n" }, { "path": "addons/Dexie.Syncable/test/test-typings/test-typings.ts", "content": "\nimport Dexie from 'dexie';\nimport 'dexie-observable';\nimport '../../src/Dexie.Syncable';\nimport dexieSyncable from '../../src/Dexie.Syncable';\nimport {DatabaseChangeType} from '../../api';\nimport {IDatabaseChange} from 'dexie-observable/api';\n\n//\n// Typings for registerSyncProtocol():\n//\nDexie.Syncable.registerSyncProtocol(\"myProtocol\", {\n sync: (context,\n url,\n options,\n baseRevision,\n syncedRevision,\n changes,\n partial,\n applyRemoteChanges,\n onChangesAccepted,\n onSuccess,\n onError) => {\n context[\"customProp\"] = 3;\n context.save().catch(ex=>{});\n url.toLowerCase();\n changes.forEach(change => {\n if (change.type === DatabaseChangeType.Create) {\n change.obj.hello; // Should be able to access custom props on change.obj.\n change.key;\n change.table.toLowerCase();\n change.type.toExponential();\n } else if (change.type === DatabaseChangeType.Update) {\n Object.keys(change.mods).forEach(keyPath => {\n change.mods[keyPath];\n });\n } else if (change.type === DatabaseChangeType.Delete) {\n change.key;\n change.table;\n }\n });\n partial.valueOf(); // boolean\n applyRemoteChanges(changes, {anyType:'anyValue'}, true);\n applyRemoteChanges(changes, {anyType:'anyValue'});\n onChangesAccepted();\n onError(new Error(\"hoohoo\"), 5000);\n // Poll pattern typings:\n onSuccess({ again: 5000 }); \n // React pattern typings:\n onSuccess({\n react (changes, baseRevision, partial, onChangesAccepted) {\n changes.forEach(change => change.key && change.table.toUpperCase() && change.type.toExponential());\n baseRevision;\n partial.valueOf();\n onChangesAccepted();\n },\n disconnect(){}\n });\n }\n});\n\n//\n// 2. Declare Your Database.\n//\nclass Foo {\n id: Date;\n bar() {};\n age: number;\n address: {\n city: string;\n }\n}\n\nclass MyDb extends Dexie {\n foo: Dexie.Table;\n constructor() {\n super('mydb', {addons: [dexieSyncable, Dexie.Syncable]});\n this.version(1).stores({foo: 'id'});\n //\n // Connect\n //\n this.syncable.connect(\n \"myProtocol\",\n \"https://remote-server/...\",\n {anyOption: 'anyValue'})\n .catch(err => {\n console.error (`Failed to connect: ${err.stack || err}`);\n });\n }\n}\n\nvar db = new MyDb();\n// Start using the database as normal.\ndb.foo.where('x').notEqual(1).toArray(foos => {\n foos.forEach(foo => foo.bar());\n}).catch(err => {\n});\ndb.foo.get(new Date()).then(foo => foo && foo.bar());\n\ndb.syncable.disconnect(\"myUrl\");\ndb.syncable.delete(\"myUrl\");\ndb.syncable.getStatus(\"myUrl\").finally(()=>{}).catch('DatabaseClosedError', ex => ex.name);\n/* BUGBUG: Fails! See issue #537. Need to fix db.syncable.list().then(urls => Promise.all(\n urls.map(url => db.syncable.getStatus(url).then (status => ({url: url, status: status})))\n)).then(urlsAndStatuses => {\n urlsAndStatuses.forEach(urlAndStatus => {\n urlAndStatus.url.toLowerCase();\n urlAndStatus.status.toExponential();\n });\n});*/\n// With async/await\nasync function getUrlsAndStatuses() {\n let urls = await db.syncable.list();\n let statuses = await Dexie.Promise.all(urls.map(url => db.syncable.getStatus(url)));\n}\n\nfunction statusChanged(status: number, url: string) {\n status.toExponential();\n url.toLowerCase();\n}\ndb.syncable.on('statusChanged', statusChanged);\ndb.syncable.on('statusChanged').unsubscribe(statusChanged);\n\n" }, { "path": "addons/Dexie.Syncable/test/test-typings/tsconfig.json", "content": "{\n \"compilerOptions\": {\n \"module\": \"es6\",\n \"target\": \"es5\",\n \"noImplicitAny\": true,\n \"strictNullChecks\": true,\n \"outDir\": \"../../tools/tmp/test-typings\",\n \"moduleResolution\": \"node\",\n \"lib\": [\"dom\", \"es2020\"]\n },\n \"files\": [\n \"test-typings.ts\"\n ]\n}\n" }, { "path": "addons/Dexie.Syncable/test/unit/.eslintrc.json", "content": "{\n \"parserOptions\": {\n \"ecmaVersion\": 6,\n \"sourceType\": \"module\",\n \"ecmaFeatures\": {\n }\n },\n \"env\": {\n \"browser\": true,\n \"node\": true\n },\n \"rules\": {\n \"no-undef\": [\"error\"]\n },\n \"globals\": {\n \"Promise\": true\n }\n}\n" }, { "path": "addons/Dexie.Syncable/test/unit/.gitignore", "content": "/bundle.js\n/bundle.js.map\n" }, { "path": "addons/Dexie.Syncable/test/unit/get-local-changes-for-node/tests-get-base-revision-and-max-client-revision.js", "content": "import {module, test, deepEqual, equal, ok} from 'QUnit';\nimport getBaseRevisionAndMaxClientRevision from '../../../src/get-local-changes-for-node/get-base-revision-and-max-client-revision';\n\nmodule('getBaseRevisionAndMaxClientRevision', {\n setup: () => {\n },\n teardown: () => {\n }\n});\n\ntest('maxClientRevision should be Infinity and remoteBaseRevision null if we haven\\'t gotten any server changes yet', () => {\n const syncNode = {\n remoteBaseRevisions: []\n };\n\n const res = getBaseRevisionAndMaxClientRevision(syncNode);\n deepEqual(res, { maxClientRevision: Infinity, remoteBaseRevision: null});\n});\n\ntest('remoteBaseRevision should be null and maxClientRevision should match the first server change if the sync node\\'s revision is not bigger that at least one remoteBaseRevisions', () => {\n const syncNode = {\n remoteBaseRevisions: [{ local: 2, remote: 1 }, { local: 3, remote: 1 }],\n myRevision: 1\n };\n\n const res = getBaseRevisionAndMaxClientRevision(syncNode);\n deepEqual(res, { maxClientRevision: 2, remoteBaseRevision: null});\n});\n\ntest('remoteBaseRevision should have the value of \"remote\" for a remoteBaseRevision\\'s \"local\" matching \"myRevision\"', () => {\n const syncNode = {\n remoteBaseRevisions: [{ local: 2, remote: 1 }, { local: 3, remote: 2 }],\n myRevision: 2\n };\n\n const res = getBaseRevisionAndMaxClientRevision(syncNode);\n equal(res.remoteBaseRevision, 1);\n});\n\ntest('maxClientRevision should have the value of the next \"local\" for a remoteBaseRevision\\'s \"local\" matching \"myRevision\"', () => {\n const syncNode = {\n remoteBaseRevisions: [{ local: 2, remote: 1 }, { local: 3, remote: 2 }],\n myRevision: 2\n };\n\n const res = getBaseRevisionAndMaxClientRevision(syncNode);\n equal(res.maxClientRevision, 3);\n});\n\ntest('maxClientRevision should be Infinity if the last remoteBaseRevision\\'s \"local\" matches \"myRevision\"', () => {\n const syncNode = {\n remoteBaseRevisions: [{ local: 2, remote: 1 }, { local: 3, remote: 2 }],\n myRevision: 3\n };\n\n const res = getBaseRevisionAndMaxClientRevision(syncNode);\n equal(res.maxClientRevision, Infinity);\n});\n" }, { "path": "addons/Dexie.Syncable/test/unit/get-local-changes-for-node/tests-get-changes-since-revision.js", "content": "import Dexie from 'dexie';\nimport 'dexie-observable';\nimport {module, asyncTest, start, stop, strictEqual, deepEqual, ok} from 'QUnit';\nimport {resetDatabase} from '../../../../../test/dexie-unittest-utils';\nimport initGetChangesSinceRevision from '../../../src/get-local-changes-for-node/get-changes-since-revision';\nimport {CREATE, UPDATE} from '../../../src/change_types';\n\nconst db = new Dexie('TestDBTable');\ndb.version(1).stores({\n foo: \"id\"\n});\n\nconst syncNode = new db.observable.SyncNode();\nconst nodeID = 1;\nsyncNode.id = nodeID;\nconst hasMoreToGive = {hasMoreToGive: false};\nconst getChangesSinceRevision = initGetChangesSinceRevision(db, syncNode, hasMoreToGive);\nmodule('getChangesSinceRevision', {\n setup: () => {\n stop();\n\n // Do a full DB reset to clean _changes table\n db._hasBeenCreated = false;\n resetDatabase(db).catch(function (e) {\n ok(false, \"Error resetting database: \" + e.stack);\n }).finally(start);\n },\n teardown: () => {\n }\n});\n\nasyncTest('should return relevant (between revision and maxRevision) changes', () => {\n const createChange1 = {\n rev: 1,\n key: 1,\n type: CREATE,\n source: 2,\n table: 'foo',\n obj: {foo: 'bar'}\n };\n const createChange2 = {\n rev: 2,\n key: 2,\n type: CREATE,\n source: 2,\n table: 'foo',\n obj: {foo: 'bar'}\n };\n const createChange3 = {\n rev: 3,\n key: 3,\n type: CREATE,\n source: 2,\n table: 'foo',\n obj: {foo: 'bar'}\n };\n const createChange4 = {\n rev: 4,\n key: 4,\n type: CREATE,\n source: 2,\n table: 'foo',\n obj: {foo: 'bar'}\n };\n const revision = 1;\n const maxChanges = 10;\n const maxRevision = 3;\n function cb(changes, partial, revisionObject) {\n strictEqual(revisionObject.myRevision, createChange3.rev, 'myRevision');\n strictEqual(partial, false, 'is not a partial change');\n strictEqual(changes.length, 2, 'get only 2 changes');\n deepEqual(changes, [{\n key: 2,\n table: 'foo',\n type: CREATE,\n obj: {foo: 'bar'}\n }, {\n key: 3,\n table: 'foo',\n type: CREATE,\n obj: {foo: 'bar'}\n }], 'changes');\n deepEqual(hasMoreToGive, {hasMoreToGive: false}, 'hasMoreToGive remains false');\n }\n const changesToAdd = [createChange1, createChange2, createChange3, createChange4];\n db._changes.bulkAdd(changesToAdd)\n .then(() => {\n return getChangesSinceRevision(revision, maxChanges, maxRevision, cb)\n })\n .catch(function(err) {\n ok(false, \"Error: \" + err);\n })\n .finally(start);\n});\n\nasyncTest('should ignore a change if it was set by this node', () => {\n const createChange1 = {\n rev: 1,\n key: 1,\n type: CREATE,\n source: 2,\n table: 'foo',\n obj: {foo: 'bar'}\n };\n const createChange2 = {\n rev: 2,\n key: 2,\n type: CREATE,\n source: 1,\n table: 'foo',\n obj: {foo: 'bar'}\n };\n const createChange3 = {\n rev: 3,\n key: 3,\n type: CREATE,\n source: 2,\n table: 'foo',\n obj: {foo: 'bar'}\n };\n const createChange4 = {\n rev: 4,\n key: 4,\n type: CREATE,\n source: 2,\n table: 'foo',\n obj: {foo: 'bar'}\n };\n const revision = 1;\n const maxChanges = 10;\n const maxRevision = 3;\n function cb(changes/*, partial, revisionObject*/) {\n strictEqual(changes.length, 1, 'get only 1 changes');\n deepEqual(changes, [{\n key: 3,\n table: 'foo',\n type: CREATE,\n obj: {foo: 'bar'}\n }], 'changes');\n }\n const changesToAdd = [createChange1, createChange2, createChange3, createChange4];\n db._changes.bulkAdd(changesToAdd)\n .then(() => {\n return getChangesSinceRevision(revision, maxChanges, maxRevision, cb)\n })\n .catch(function(err) {\n ok(false, \"Error: \" + err);\n })\n .finally(start);\n});\n\nasyncTest('should merge changes', () => {\n const createChange1 = {\n rev: 2,\n key: 2,\n type: CREATE,\n source: 2,\n table: 'foo',\n obj: {foo: 'bar'}\n };\n const createChange2 = {\n rev: 3,\n key: 2,\n type: UPDATE,\n source: 2,\n table: 'foo',\n mods: {foo: 'baz'}\n };\n const revision = 1;\n const maxChanges = 10;\n const maxRevision = 3;\n function cb(changes/*, partial, revisionObject*/) {\n strictEqual(changes.length, 1, 'get only 1 changes');\n deepEqual(changes, [{\n key: 2,\n table: 'foo',\n type: CREATE,\n obj: {foo: 'baz'}\n }], 'changes');\n }\n const changesToAdd = [createChange1, createChange2];\n db._changes.bulkAdd(changesToAdd)\n .then(() => {\n return getChangesSinceRevision(revision, maxChanges, maxRevision, cb)\n })\n .catch(function(err) {\n ok(false, \"Error: \" + err);\n })\n .finally(start);\n});\n\nasyncTest('should set hasMoreToGive to true if we have more changes than maxChanges', () => {\n const createChange1 = {\n rev: 1,\n key: 1,\n type: CREATE,\n source: 2,\n table: 'foo',\n obj: {foo: 'bar'}\n };\n const createChange2 = {\n rev: 2,\n key: 2,\n type: CREATE,\n source: 2,\n table: 'foo',\n obj: {foo: 'bar'}\n };\n const createChange3 = {\n rev: 3,\n key: 3,\n type: CREATE,\n source: 2,\n table: 'foo',\n obj: {foo: 'bar'}\n };\n const createChange4 = {\n rev: 4,\n key: 4,\n type: CREATE,\n source: 2,\n table: 'foo',\n obj: {foo: 'bar'}\n };\n const revision = 1;\n const maxChanges = 2;\n const maxRevision = 4;\n hasMoreToGive.hasMoreToGive = false;\n function cb(changes, partial, revisionObject) {\n strictEqual(revisionObject.myRevision, createChange3.rev, 'myRevision');\n strictEqual(partial, true, 'is a partial change');\n strictEqual(changes.length, 2, 'get only 2 changes');\n deepEqual(hasMoreToGive, {hasMoreToGive: true}, 'hasMoreToGive is true');\n }\n const changesToAdd = [createChange1, createChange2, createChange3, createChange4];\n db._changes.bulkAdd(changesToAdd)\n .then(() => {\n return getChangesSinceRevision(revision, maxChanges, maxRevision, cb)\n })\n .catch(function(err) {\n ok(false, \"Error: \" + err);\n })\n .finally(start);\n});\n\n\nasyncTest('should set hasMoreToGive to true but give no changes if maxChanges is 0', () => {\n const createChange1 = {\n rev: 1,\n key: 1,\n type: CREATE,\n source: 2,\n table: 'foo',\n obj: {foo: 'bar'}\n };\n const createChange2 = {\n rev: 2,\n key: 2,\n type: CREATE,\n source: 2,\n table: 'foo',\n obj: {foo: 'bar'}\n };\n const createChange3 = {\n rev: 3,\n key: 3,\n type: CREATE,\n source: 2,\n table: 'foo',\n obj: {foo: 'bar'}\n };\n const createChange4 = {\n rev: 4,\n key: 4,\n type: CREATE,\n source: 2,\n table: 'foo',\n obj: {foo: 'bar'}\n };\n const revision = 1;\n const maxChanges = 0;\n const maxRevision = 4;\n hasMoreToGive.hasMoreToGive = false;\n function cb(changes, partial, revisionObject) {\n strictEqual(revisionObject.myRevision, revision, 'revision should not change');\n strictEqual(partial, true, 'is a partial change');\n strictEqual(changes.length, 0, 'get no changes');\n deepEqual(hasMoreToGive, {hasMoreToGive: true}, 'hasMoreToGive is true');\n }\n const changesToAdd = [createChange1, createChange2, createChange3, createChange4];\n db._changes.bulkAdd(changesToAdd)\n .then(() => {\n return getChangesSinceRevision(revision, maxChanges, maxRevision, cb)\n })\n .catch(function(err) {\n ok(false, \"Error: \" + err);\n })\n .finally(start);\n});\n" }, { "path": "addons/Dexie.Syncable/test/unit/get-local-changes-for-node/tests-get-local-changes-for-node.js", "content": "import Dexie from 'dexie';\nimport 'dexie-observable';\nimport {module, asyncTest, start, stop, strictEqual, deepEqual, ok} from 'QUnit';\nimport {resetDatabase} from '../../../../../test/dexie-unittest-utils';\nimport initGetLocalChangesForNode from '../../../src/get-local-changes-for-node/get-local-changes-for-node';\nimport {CREATE} from '../../../src/change_types';\n\nconst db = new Dexie('TestDBTable');\ndb.version(1).stores({\n foo: \"id\",\n bar: \"id\"\n});\n\nconst syncNode = new db.observable.SyncNode();\nconst nodeID = 1;\nsyncNode.id = nodeID;\nconst hasMoreToGive = {hasMoreToGive: false};\nmodule('getLocalChangesForNode', {\n setup: () => {\n stop();\n\n // Do a full DB reset to clean _changes table\n db._hasBeenCreated = false;\n resetDatabase(db).catch(function (e) {\n ok(false, \"Error resetting database: \" + e.stack);\n }).finally(start);\n },\n teardown: () => {\n }\n});\n\nasyncTest('should get the contents of our tables and create CREATE changes if node.myRevision is -1', () => {\n syncNode.myRevision = -1;\n syncNode.dbUploadState = null;\n syncNode.remoteBaseRevisions = [];\n const getLocalChangesForNode = initGetLocalChangesForNode(db, hasMoreToGive, 10);\n const fooTableObject = {\n id: 1,\n foo: 'bar'\n };\n const barTableObject = {\n id: 1,\n bar: 'foo'\n };\n function cb(changes/*, remoteBaseRevision, partial, nodeModificationsOnAck*/) {\n strictEqual(changes.length, 2, 'We have 2 changes');\n deepEqual(changes, [{\n key: 1,\n obj: fooTableObject,\n type: CREATE,\n table: 'foo'\n }, {\n key: 1,\n obj: barTableObject,\n type: CREATE,\n table: 'bar'\n }], 'Changes match the objects in the tables');\n deepEqual(hasMoreToGive, {hasMoreToGive: false}, 'it should\\'t change hasMoreToGive');\n }\n db.foo.add(fooTableObject)\n .then(() => {\n return db.bar.add(barTableObject);\n })\n .then(() => {\n return getLocalChangesForNode(syncNode, cb);\n })\n .catch(function(err) {\n ok(false, \"Error: \" + err);\n })\n .finally(start);\n});\n\nasyncTest('should return changes in _changes if myRevision >= 0', () => {\n syncNode.myRevision = -1;\n syncNode.dbUploadState = null;\n syncNode.remoteBaseRevisions = [];\n const getLocalChangesForNode = initGetLocalChangesForNode(db, hasMoreToGive, 10);\n const fooTableObject1 = {\n id: 1,\n foo: 'bar'\n };\n const fooTableObject2 = {\n id: 2,\n foo: 'foobar'\n };\n function cb(changes/*, remoteBaseRevision, partial, nodeModificationsOnAck*/) {\n strictEqual(changes.length, 2, 'We have 2 changes');\n deepEqual(changes, [{\n key: 1,\n obj: fooTableObject1,\n type: CREATE,\n table: 'foo'\n }, {\n key: 2,\n obj: fooTableObject2,\n type: CREATE,\n table: 'foo'\n }], 'Changes match the objects in the tables');\n deepEqual(hasMoreToGive, {hasMoreToGive: false}, 'it should\\'t change hasMoreToGive');\n }\n // This also adds changes to _changes\n db.foo.bulkAdd([fooTableObject1, fooTableObject2])\n .then(() => {\n return getLocalChangesForNode(syncNode, cb);\n })\n .catch(function(err) {\n ok(false, \"Error: \" + err);\n })\n .finally(start);\n});\n\nasyncTest('should return partial changes in _changes if myRevision >= 0 and threshold was reached', () => {\n syncNode.myRevision = -1;\n syncNode.dbUploadState = null;\n syncNode.remoteBaseRevisions = [];\n hasMoreToGive.hasMoreToGive = false;\n const getLocalChangesForNode = initGetLocalChangesForNode(db, hasMoreToGive, 1);\n const fooTableObject1 = {\n id: 1,\n foo: 'bar'\n };\n const fooTableObject2 = {\n id: 2,\n foo: 'foobar'\n };\n function cb(changes/*, remoteBaseRevision, partial, nodeModificationsOnAck*/) {\n strictEqual(changes.length, 1, 'We have 1 change');\n deepEqual(changes, [{\n key: 1,\n obj: fooTableObject1,\n type: CREATE,\n table: 'foo'\n }], 'Changes match the objects in the tables');\n deepEqual(hasMoreToGive, {hasMoreToGive: true}, 'it should change hasMoreToGive');\n }\n // This also adds changes to _changes\n db.foo.bulkAdd([fooTableObject1, fooTableObject2])\n .then(() => {\n return getLocalChangesForNode(syncNode, cb);\n })\n .catch(function(err) {\n ok(false, \"Error: \" + err);\n })\n .finally(start);\n});\n\nasyncTest('should not return any changed if the threshold is 0 but should set hasMoreToGive to true', () => {\n syncNode.myRevision = -1;\n syncNode.dbUploadState = null;\n syncNode.remoteBaseRevisions = [];\n hasMoreToGive.hasMoreToGive = false;\n const getLocalChangesForNode = initGetLocalChangesForNode(db, hasMoreToGive, 0);\n const fooTableObject1 = {\n id: 1,\n foo: 'bar'\n };\n const fooTableObject2 = {\n id: 2,\n foo: 'foobar'\n };\n function cb(changes/*, remoteBaseRevision, partial, nodeModificationsOnAck*/) {\n strictEqual(changes.length, 0, 'We have 0 changes');\n deepEqual(hasMoreToGive, {hasMoreToGive: true}, 'it should change hasMoreToGive');\n }\n // This also adds changes to _changes\n db.foo.bulkAdd([fooTableObject1, fooTableObject2])\n .then(() => {\n return getLocalChangesForNode(syncNode, cb);\n })\n .catch(function(err) {\n ok(false, \"Error: \" + err);\n })\n .finally(start);\n});\n" }, { "path": "addons/Dexie.Syncable/test/unit/karma-env.js", "content": "QUnit.config.autostart = false;\n" }, { "path": "addons/Dexie.Syncable/test/unit/karma.conf.js", "content": "// Include common configuration\nconst {karmaCommon, getKarmaConfig, defaultBrowserMatrix} = require('../../../../test/karma.common');\n\nmodule.exports = function (config) {\n const browserMatrixOverrides = {\n // Be fine with testing on local travis firefox + browserstack chrome, latest supported.\n ci: [\"remote_chrome\"],\n // Safari fails to reply on browserstack. Need to not have it here.\n // Just complement with old chrome browser that is not part of CI test suite.\n pre_npm_publish: [\n \"Chrome\",\n ]\n };\n\n const cfg = getKarmaConfig(browserMatrixOverrides, {\n // Base path should point at the root \n basePath: '../../../../',\n files: karmaCommon.files.concat([\n 'dist/dexie.js',\n 'addons/Dexie.Observable/dist/dexie-observable.js',\n\n 'samples/remote-sync/websocket/websocketserver-shim.js',\n 'samples/remote-sync/websocket/WebSocketSyncServer.js',// With shim applied, we can run the server in the browser\n\n 'addons/Dexie.Syncable/test/unit/bundle.js',\n { pattern: 'addons/Dexie.Observable/dist/*.map', watched: false, included: false },\n { pattern: 'addons/Dexie.Syncable/dist/*.map', watched: false, included: false },\n { pattern: 'addons/Dexie.Syncable/test/unit/*.map', watched: false, included: false },\n ])\n });\n\n config.set(cfg);\n}\n" }, { "path": "addons/Dexie.Syncable/test/unit/run-unit-tests.html", "content": "\n\n\n \n Dexie.Syncable Unit tests\n \n\n\n
\n
\n \n \n \n \n \n \n \n \n\n\n" }, { "path": "addons/Dexie.Syncable/test/unit/tests-PersistedContext.js", "content": "import Dexie from 'dexie';\nimport observable from 'dexie-observable';\n// Add this so we have the SyncNode.prototype.save method\nimport syncable from '../../src/Dexie.Syncable';\nimport {module, asyncTest, test, start, stop, propEqual, deepEqual, ok} from 'QUnit';\nimport {resetDatabase} from '../../../../test/dexie-unittest-utils';\nimport initPersistedContext from '../../src/PersistedContext';\n\nconst db = new Dexie('TestDBTable', {addons: [observable, syncable]});\ndb.version(1).stores({foo: '++id'});\n\nmodule('PersistedContext', {\n setup: () => {\n stop();\n resetDatabase(db).catch(function (e) {\n ok(false, \"Error resetting database: \" + e.stack);\n }).finally(start);\n },\n teardown: () => {\n }\n});\n\nasyncTest('should save any properties we add to the context into the DB', () => {\n const syncNode = new db.observable.SyncNode();\n const PersistedContext = initPersistedContext(syncNode);\n let addedNodeID;\n db._syncNodes.add(syncNode)\n .then((nodeID) => {\n addedNodeID = nodeID;\n const persistedContext = new PersistedContext(syncNode.id);\n syncNode.syncContext = persistedContext;\n persistedContext.foobar = 'foobar';\n return persistedContext.save()\n })\n .then(() => {\n return db._syncNodes.get(addedNodeID);\n })\n .then((node) => {\n deepEqual(node.syncContext, {foobar: 'foobar', nodeID: addedNodeID});\n })\n .catch(function(err) {\n ok(false, \"Error: \" + err);\n })\n .finally(start);\n});\n\ntest('should extend the instance with the given options object', () => {\n const syncNode = new db.observable.SyncNode();\n const PersistedContext = initPersistedContext(syncNode);\n const persistedContext = new PersistedContext(1, {foo: 'bar'});\n propEqual(persistedContext, {nodeID: 1, foo: 'bar'});\n});\n" }, { "path": "addons/Dexie.Syncable/test/unit/tests-WebSocketSyncServer.js", "content": "import 'dexie-observable';\nimport '../../src/Dexie.Syncable';\nimport {module, asyncTest, start, stop, strictEqual, deepEqual, ok} from 'QUnit';\n\nmodule(\"tests-WebSocketSyncServer\");\n\nasyncTest(\"testWebSocketSyncServer\", function () {\n var server = new SyncServer(1234);\n server.start();\n\n var ws = new WebSocket(\"http://dummy:1234\");\n ws.onopen = function () {\n ok(true, \"WebSocket opened\");\n ws.send(JSON.stringify({\n type: \"clientIdentity\",\n clientIdentity: null\n }));\n ws.send(JSON.stringify({\n type: \"subscribe\",\n syncedRevision: null\n }));\n }\n ws.onclose = function (reason) {\n ok(true, \"WebSocket closed. Reason: \" + reason);\n start();\n }\n ws.onerror = function (event) {\n ok(false, \"Error: \" + event.reason);\n start();\n }\n\n ws.onmessage = function (event) {\n var requestFromServer = JSON.parse(event.data);\n if (requestFromServer.type === \"clientIdentity\") {\n ok(true, \"Got client identity: \" + requestFromServer.clientIdentity);\n // Now send changes to server\n ws.send(JSON.stringify({\n type: \"changes\",\n changes: [],\n partial: false,\n baseRevision: null,\n requestId: 1\n }));\n } else if (requestFromServer.type == \"ack\") {\n ok(true, \"Got ack from server: \" + requestFromServer.requestId);\n equal(requestFromServer.requestId, 1, \"The request ID 1 was acked\");\n\n // Now connect another WebSocket and send its changes to server so that server will react and send us the changes:\n var ws2 = new WebSocket(\"http://dummy:1234\");\n ws2.onopen = function () {\n ws2.send(JSON.stringify({\n type: \"clientIdentity\",\n clientIdentity: null\n }));\n ws2.send(JSON.stringify({\n type: \"changes\",\n changes: [{type: 1, table: \"UllaBella\", key: \"apa\", obj: {name: \"Apansson\"}}],\n partial: false,\n baseRevision: null,\n requestId: 1\n }));\n }\n } else if (requestFromServer.type == \"changes\") {\n if (requestFromServer.currentRevision == 0) {\n ok(true, \"Got initial changes sent to us with current revision 0\");\n } else {\n ok(true, \"Got changes from server: \" + JSON.stringify(requestFromServer.changes));\n equal(JSON.stringify(requestFromServer.changes), JSON.stringify([\n {\n rev: 1,\n source: 2, // WebSocket2 was the source of the changes.\n type: 1,\n table: \"UllaBella\",\n key: \"apa\",\n obj: {name: \"Apansson\"}\n }\n ]), \"Changes where the same as the ones sent by WebSocket2\");\n start();\n }\n }\n }\n});\n" }, { "path": "addons/Dexie.Syncable/test/unit/tests-apply-changes.js", "content": "import Dexie from 'dexie';\nimport {module, asyncTest, start, stop, strictEqual, deepEqual, ok} from 'QUnit';\nimport {resetDatabase} from '../../../../test/dexie-unittest-utils';\nimport initApplyChanges from '../../src/apply-changes';\nimport {CREATE, DELETE, UPDATE} from '../../src/change_types';\n\nconst db = new Dexie('TestDBTable', {addons: []});\ndb.version(1).stores({\n foo: \"id\",\n bar: \"++id\"\n});\n\nconst applyChanges = initApplyChanges(db);\nmodule('applyChanges', {\n setup: () => {\n stop();\n resetDatabase(db).catch(function (e) {\n ok(false, \"Error resetting database: \" + e.stack);\n }).finally(start);\n },\n teardown: () => {\n }\n});\n\n\nasyncTest('should be able to handle changes belonging to different tables', () => {\n const fooCreateChange = {\n key: 1,\n table: 'foo',\n obj: { foo: 'bar', id: 1 },\n type: CREATE\n };\n const barCreateChange = {\n table: 'bar',\n obj: { foo: 'baz' },\n type: CREATE\n };\n const changes = [fooCreateChange, barCreateChange];\n applyChanges(changes, 0)\n .then(() => {\n return db.table('foo').get(fooCreateChange.key);\n })\n .then((obj) => {\n // Works when key is given\n deepEqual(obj, fooCreateChange.obj, 'fooCreateChange found in table');\n return db.table('bar').toArray();\n })\n .then((objects) => {\n // Works with auto-incremented key\n strictEqual(objects[0].foo, barCreateChange.obj.foo, 'barCreateChange found in table');\n })\n .catch(function(err) {\n ok(false, \"Error: \" + err);\n })\n .finally(start);\n});\n\nasyncTest('should be able to handle large number of changes', () => {\n let changes = [];\n for( let i = 0; i < 10000; i++ ) {\n changes.push({key : i, table: \"foo\", obj: { id: i, foo: \"bar\" }, type: CREATE});\n }\n applyChanges(changes)\n .then(() => {\n ok(true, \"Tests passed!\");\n })\n .catch(function(err) {\n ok(false, \"Error: \" + err);\n })\n .finally(start);\n});\n\nasyncTest('should be able to handle different types of changes', () => {\n const tableData = [{ id: 2, foo: 'foobar' }, { id: 3, foo: 'bar' }];\n const createChange = {\n key: 1,\n table: 'foo',\n obj: { foo: 'bar', id: 1 },\n type: CREATE\n };\n const updateChange = {\n key: 2,\n table: 'foo',\n mods: { foo: 'baz' },\n type: UPDATE\n };\n const deleteChange = {\n key: 3,\n table: 'foo',\n type: DELETE\n };\n const changes = [createChange, updateChange, deleteChange];\n db.table('foo').bulkPut(tableData)\n .then(() => {\n return applyChanges(changes, 0);\n })\n .then(() => {\n return db.table('foo').get(createChange.key);\n })\n .then((obj) => {\n deepEqual(obj, createChange.obj, 'createChange found in table');\n return db.table('foo').get(updateChange.key);\n })\n .then((obj) => {\n strictEqual(obj.foo, 'baz', 'updateChange found in table');\n return db.table('foo').get(deleteChange.key);\n })\n .then((obj) => {\n strictEqual(obj, undefined, 'deleteChange was executed on table');\n })\n .catch(function(err) {\n ok(false, \"Error: \" + err);\n })\n .finally(start);\n});\n" }, { "path": "addons/Dexie.Syncable/test/unit/tests-bulk-update.js", "content": "import Dexie from 'dexie';\nimport {module, asyncTest, start, stop, strictEqual, deepEqual, ok} from 'QUnit';\nimport {resetDatabase} from '../../../../test/dexie-unittest-utils';\nimport bulkUpdate from '../../src/bulk-update';\nimport {UPDATE} from '../../src/change_types';\n\nconst db = new Dexie('TestDBTable', {addons: []});\ndb.version(1).stores({\n foo: \"id\"\n});\n\ndb.on(\"populate\", function () {\n db.table('foo').add({foo: 'bar', id: 1});\n db.table('foo').add({bar: 'baz', foo: { bar: 'foobar' }, id: 2});\n});\n\nmodule('bulkUpdate', {\n setup: () => {\n stop();\n resetDatabase(db).catch(function (e) {\n ok(false, \"Error resetting database: \" + e.stack);\n }).finally(start);\n },\n teardown: () => {\n }\n});\n\nasyncTest('should ignore any changes for which we didn\\'t find an object in the table', () => {\n const changes = [{\n key: 3,\n mods: {id: 3, foo: 'bar'},\n table: 'foo',\n type: UPDATE\n }];\n bulkUpdate(db.table('foo'), changes)\n .then(() => {\n return db.table('foo').count();\n })\n .then((count) => {\n strictEqual(count, 2, 'No changes made to the table');\n })\n .catch(function(err) {\n ok(false, \"Error: \" + err);\n })\n .finally(start);\n});\n\nasyncTest('should update the object in the table according to the changes', () => {\n const updateKey1 = {\n key: 1,\n mods: {id: 1, foo: 'bar'},\n table: 'foo',\n type: UPDATE\n };\n const updateKey2 = {\n key: 2,\n mods: {id: 2, bar: 'bar', 'foo.bar': 'bazzz'},\n table: 'foo',\n type: UPDATE\n };\n const changes = [updateKey1, updateKey2];\n bulkUpdate(db.table('foo'), changes)\n .then(() => {\n return db.table('foo').get(updateKey1.key);\n })\n .then((obj) => {\n deepEqual(obj, updateKey1.mods, 'Key 1 updated');\n return db.table('foo').get(updateKey2.key);\n })\n .then((obj) => {\n deepEqual(obj, {id: 2, bar: 'bar', foo: {bar: 'bazzz'}}, 'Key 2 updated');\n })\n .catch(function(err) {\n ok(false, \"Error: \" + err);\n })\n .finally(start);\n});\n" }, { "path": "addons/Dexie.Syncable/test/unit/tests-changing-options.js", "content": "import Dexie from 'dexie';\nimport 'dexie-observable';\nimport '../../src/Dexie.Syncable';\nimport {module, asyncTest, start, stop, strictEqual, deepEqual, ok} from 'QUnit';\n\n/* The following is being tested:\n\n 1. getOptions method\n 2. changing options on an existing connected node by using connect() with a different options object than before\n 3. changing options on an existing disconnected node by using connect() with a different options object than before\n */\nconst db = new Dexie(\"optionsTestDB\");\nconst deletePromise = Dexie.delete(\"optionsTestDB\");\n\nmodule(\"tests-changing-options\", {\n setup: function () {\n db.close();\n stop();\n deletePromise.then(function () {\n start()\n });\n },\n teardown: function () {\n }\n});\n\nasyncTest('Change options on an existing node', function () {\n const protocolName = 'testProtocolChanges';\n const serverUrl = 'http://dummy.local';\n const syncProtocol = {\n sync: undefined,\n partialsThreshold: 1000\n };\n\n Dexie.Syncable.registerSyncProtocol(protocolName, syncProtocol);\n\n db.version(1).stores({objects: \"$$\"});\n db.open();\n\n syncProtocol.sync = function (context, url, options, baseRevision, syncedRevision, changes, partial, applyRemoteChanges, onChangesAccepted, onSuccess) {\n propEqual(options, {option1: 'option1'}, 'sync got the correct options');\n onSuccess({again: 1000});\n };\n\n db.syncable.connect(protocolName, serverUrl, {option1: \"option1\"})\n .then(() => {\n return db.syncable.getOptions(serverUrl);\n })\n .then((options) => {\n propEqual(options, {option1: 'option1'}, 'getOptions got the correct options');\n\n syncProtocol.sync = function (context, url, options, baseRevision, syncedRevision, changes, partial, applyRemoteChanges, onChangesAccepted, onSuccess) {\n propEqual(options, {newOptions: 'other options'}, 'sync got the new options');\n onSuccess({again: 1000});\n };\n\n // Test changing options on an already connected node\n // We are already connected but are changing options\n // We expect that the next getOptions/sync call has the new options\n return db.syncable.connect(protocolName, serverUrl, {newOptions: 'other options'});\n })\n .then(() => {\n return db.syncable.getOptions(serverUrl);\n })\n .then((options) => {\n propEqual(options, {newOptions: 'other options'}, 'getOptions got the new options');\n // Test changing options on a disconnected existing node\n return db.syncable.disconnect(serverUrl);\n })\n .then(() => {\n syncProtocol.sync = function (context, url, options, baseRevision, syncedRevision, changes, partial, applyRemoteChanges, onChangesAccepted, onSuccess) {\n propEqual(options, {evenNewerOptions: 'super new options'}, 'sync got the even newer options');\n onSuccess({again: 1000});\n };\n\n return db.syncable.connect(protocolName, serverUrl, {evenNewerOptions: 'super new options'});\n })\n .then(() => {\n return db.syncable.getOptions(serverUrl);\n })\n .then((options) => {\n propEqual(options, {evenNewerOptions: 'super new options'}, 'getOptions got the even newer options');\n })\n .catch(function (err) {\n ok(false, \"Error: \" + err);\n })\n .finally(start);\n});\n" }, { "path": "addons/Dexie.Syncable/test/unit/tests-combine-create-and-update.js", "content": "import {module, test, deepEqual, ok} from 'QUnit';\nimport combineCreateAndUpdate from '../../src/combine-create-and-update';\n\nmodule('combineCreateAndUpdate', {\n setup: () => {\n },\n teardown: () => {\n }\n});\n\ntest('should get a create change and update change and return a combined object', () => {\n const createChange = {\n obj: {\n foo: 'value',\n },\n };\n const updateChange = {\n mods: {\n foo: 'value2',\n bar: 'new Value',\n },\n };\n\n const res = combineCreateAndUpdate(createChange, updateChange);\n deepEqual(res.obj, { foo: 'value2', bar: 'new Value' });\n});\n\ntest('should not change the original createObject', () => {\n const createChange = {\n obj: {\n foo: 'value',\n },\n };\n const updateChange = {\n mods: {\n foo: 'value2',\n bar: 'new Value',\n },\n };\n\n combineCreateAndUpdate(createChange, updateChange);\n deepEqual(createChange.obj, { foo: 'value' });\n});\n" }, { "path": "addons/Dexie.Syncable/test/unit/tests-combine-update-and-update.js", "content": "import {module, test, deepEqual, ok} from 'QUnit';\nimport combineUpdateAndUpdate from '../../src/combine-update-and-update';\n\nmodule('combineUpdateAndUpdate', {\n setup: () => {\n },\n teardown: () => {\n }\n});\n\ntest('should combine the keys of nextChange.mods and prevChange.mods', () => {\n const prevChange = {\n mods: {\n foo: 'bar',\n },\n };\n const nextChange = {\n mods: {\n bar: 'baz',\n },\n };\n\n const res = combineUpdateAndUpdate(prevChange, nextChange);\n deepEqual(res.mods, {foo: 'bar', bar: 'baz'});\n});\n\ntest('should leave the original object untouched', () => {\n const prevChange = {\n mods: {\n foo: 'bar',\n },\n };\n const nextChange = {\n mods: {\n bar: 'baz',\n },\n };\n\n combineUpdateAndUpdate(prevChange, nextChange);\n deepEqual(prevChange, {mods: {foo: 'bar'}});\n});\n\ntest('should overwrite a previous change with the same key', () => {\n const prevChange = {\n mods: {\n foo: 'bar',\n },\n };\n const nextChange = {\n mods: {\n foo: 'baz',\n },\n };\n\n const res = combineUpdateAndUpdate(prevChange, nextChange);\n deepEqual(res.mods, {foo: 'baz'});\n});\n\ntest('should ignore a previous change which changed a parent object of the next change', () => {\n const prevChange = {\n mods: {\n 'foo': {bar: 'baz', baz: 'bar'},\n },\n };\n const nextChange = {\n mods: {\n 'foo.bar': 'foobar',\n },\n };\n\n const res = combineUpdateAndUpdate(prevChange, nextChange);\n deepEqual(res, {mods: {foo: {bar: 'foobar', baz: 'bar'}}});\n});\n\ntest('should ignore a previous change which changed a sub value of the nextChange', () => {\n const prevChange = {\n mods: {\n 'foo.bar': 'foobar',\n },\n };\n const nextChange = {\n mods: {\n 'foo': {bar: 'baz'},\n },\n };\n\n const res = combineUpdateAndUpdate(prevChange, nextChange);\n deepEqual(res, {mods: {'foo': {bar: 'baz'}}});\n});\n" }, { "path": "addons/Dexie.Syncable/test/unit/tests-finally-commit-all-changes.js", "content": "import Dexie from 'dexie';\nimport observable from 'dexie-observable';\nimport {module, asyncTest, start, stop, strictEqual, deepEqual, ok} from 'QUnit';\nimport {resetDatabase} from '../../../../test/dexie-unittest-utils';\nimport initFinallyCommitAllChanges from '../../src/finally-commit-all-changes';\nimport {CREATE, DELETE, UPDATE} from '../../src/change_types';\n\nconst db = new Dexie('TestDBTable', {addons: [observable]});\ndb.version(1).stores({\n foo: \"id\"\n});\n\nconst nodeID = 1;\n\nlet syncNode;\nlet finallyCommitAllChanges;\nmodule('finallyCommitAllChanges', {\n setup: () => {\n stop();\n\n db.observable.SyncNode.prototype.save = function() { return { catch() {} }; };\n syncNode = new db.observable.SyncNode();\n syncNode.id = nodeID;\n syncNode.remoteBaseRevisions = [];\n finallyCommitAllChanges = initFinallyCommitAllChanges(db, syncNode);\n\n // Do a full DB reset to clean _changes table\n db._hasBeenCreated = false;\n resetDatabase(db).catch(function (e) {\n ok(false, \"Error resetting database: \" + e.stack);\n }).finally(start);\n },\n teardown: () => {\n }\n});\n\nasyncTest('should call node.save()', () => {\n let wasCalled = false;\n db.observable.SyncNode.prototype.save = function() {\n wasCalled = true;\n return { catch() {} };\n };\n finallyCommitAllChanges([], 1)\n .then(() => {\n ok(wasCalled);\n })\n .catch(function(err) {\n ok(false, \"Error: \" + err);\n })\n .finally(start);\n});\n\nasyncTest('should apply _uncommittedChanges and remove them from that table', () => {\n const createChange = {\n key: 1,\n node: nodeID,\n type: CREATE,\n obj: { id: 1, foo: 'bar' },\n table: 'foo'\n };\n db._uncommittedChanges\n .add(createChange)\n .then(() => {\n return finallyCommitAllChanges([], 1);\n })\n .then(() => {\n return db.foo.get(createChange.key);\n })\n .then((obj) => {\n deepEqual(obj, createChange.obj, 'Change was found in table \"foo\"');\n return db._uncommittedChanges.where('node').equals(nodeID).count();\n })\n .then((count) => {\n strictEqual(count, 0, 'No more entries in _uncommittedChanges for the given nodeID');\n })\n .catch(function(err) {\n ok(false, \"Error: \" + err);\n })\n .finally(start);\n});\n\n\nasyncTest('should put the changes into the given table', () => {\n const createChange = {\n key: 2,\n node: nodeID,\n type: CREATE,\n obj: { id: 2, foo: 'barbaz' },\n table: 'foo'\n };\n return finallyCommitAllChanges([createChange], 1)\n .then(() => {\n return db.foo.get(createChange.key);\n })\n .then((obj) => {\n deepEqual(obj, createChange.obj, 'Change was found in table \"foo\"');\n })\n .catch(function(err) {\n ok(false, \"Error: \" + err);\n })\n .finally(start);\n});\n\nasyncTest('should set the nodeID as source for the currentTransaction', () => {\n db.observable.SyncNode.prototype.save = function() {\n strictEqual(Dexie.currentTransaction.source, nodeID);\n return { catch() {} };\n };\n finallyCommitAllChanges([], 1)\n .catch(function(err) {\n ok(false, \"Error: \" + err);\n })\n .finally(start);\n});\n\nasyncTest('should update remoteBaseRevisions and remove any old revisions', () => {\n const createChange = {\n key: 1,\n node: nodeID,\n type: CREATE,\n obj: { id: 1, foo: 'bar' },\n table: 'foo'\n };\n syncNode.remoteBaseRevisions = [{local: 1, remote: 2}];\n syncNode.myRevision = 2;\n\n const remoteRevision = 3;\n finallyCommitAllChanges([createChange], remoteRevision)\n .then(() => {\n strictEqual(syncNode.remoteBaseRevisions.length, 1, 'Only one remoteBaseRevision');\n // We had no changes yet so the next local revision is 1\n deepEqual(syncNode.remoteBaseRevisions, [{local: 1, remote: remoteRevision}], 'Make sure remoteBaseRevisions contains the correct object');\n })\n .catch(function(err) {\n ok(false, \"Error: \" + err);\n })\n .finally(start);\n});\n\nasyncTest('should update node.appliedRemoteRevision', () => {\n const remoteRevision = 3;\n finallyCommitAllChanges([], remoteRevision)\n .then(() => {\n strictEqual(syncNode.appliedRemoteRevision, remoteRevision);\n })\n .catch(function(err) {\n ok(false, \"Error: \" + err);\n })\n .finally(start);\n});\n\nasyncTest('should update myRevision to the latest rev we got', () => {\n const createChange = {\n rev: 1,\n key: 1,\n node: nodeID,\n type: CREATE,\n obj: { id: 1, foo: 'bar' },\n table: 'foo'\n };\n syncNode.remoteBaseRevisions = [{local: 1, remote: 2}];\n // We had no revision before and no changes\n syncNode.myRevision = 0;\n\n const remoteRevision = 3;\n finallyCommitAllChanges([createChange], remoteRevision)\n .then(() => {\n strictEqual(syncNode.myRevision, createChange.rev);\n })\n .catch(function(err) {\n ok(false, \"Error: \" + err);\n })\n .finally(start);\n});\n" }, { "path": "addons/Dexie.Syncable/test/unit/tests-get-or-create-sync-node.js", "content": "import Dexie from 'dexie';\nimport observable from 'dexie-observable';\n// Add this so we have the SyncNode.prototype.save method\nimport syncable from '../../src/Dexie.Syncable';\nimport {module, asyncTest, test, start, stop, propEqual, deepEqual, strictEqual, ok} from 'QUnit';\nimport {resetDatabase} from '../../../../test/dexie-unittest-utils';\nimport initGetOrCreateSyncNode from '../../src/get-or-create-sync-node';\n\nconst db = new Dexie('TestDBTable', {addons: [observable, syncable]});\ndb.version(1).stores({foo: '++id'});\n\nconst protocolName = 'protocolName';\nconst url = 'http://foo.invalid';\nconst getOrCreateSyncNode = initGetOrCreateSyncNode(db, protocolName, url);\nmodule('getOrCreateSyncNode', {\n setup: () => {\n stop();\n resetDatabase(db).catch(function (e) {\n ok(false, \"Error resetting database: \" + e.stack);\n }).finally(start);\n },\n teardown: () => {\n }\n});\n\nasyncTest('should throw an error if no URL was passed', () => {\n const getOrCreateSyncNode = initGetOrCreateSyncNode(db, protocolName);\n getOrCreateSyncNode({})\n .catch((e) => {\n strictEqual(e.message, 'Url cannot be empty');\n })\n .finally(start);\n});\n\nasyncTest('should return a new node if none exists for the given URL', () => {\n const nodeOpts = {foo: 'bar'};\n let nodeID;\n getOrCreateSyncNode(nodeOpts)\n .then((node) => {\n nodeID = node.id;\n ok(node instanceof db.observable.SyncNode, 'returned node is instance of SyncNode');\n strictEqual(node.syncProtocol, protocolName, 'syncProtocol is protocol name');\n strictEqual(node.url, url, 'url is the url we passed to init');\n deepEqual(node.syncOptions, nodeOpts, 'syncOptions are the same as the options we passed');\n strictEqual(node.myRevision, -1, 'myRevision is -1');\n propEqual(node.syncContext, {nodeID}, 'syncContext contains the correct nodeID');\n return db._syncNodes.get(nodeID);\n })\n .then((node) => {\n strictEqual(node.id, nodeID, 'Node was saved in the DB');\n })\n .catch(function(err) {\n ok(false, \"Error: \" + err);\n })\n .finally(start);\n});\n\nasyncTest('should return an existing node if one exists for the given URL', () => {\n const nodeOpts = {foo: 'bar'};\n let nodeID;\n // Don't reuse the save URL, it would cause an error because the index is not unique\n const otherUrl = 'http://bar.invalid';\n const getOrCreateSyncNode = initGetOrCreateSyncNode(db, protocolName, otherUrl);\n const syncNode = new db.observable.SyncNode();\n syncNode.url = otherUrl;\n let addedNodeID;\n db._syncNodes.add(syncNode)\n .then((nodeID) => {\n addedNodeID = nodeID;\n return getOrCreateSyncNode(nodeOpts)\n })\n .then((node) => {\n ok(node instanceof db.observable.SyncNode, 'returned node is instance of SyncNode');\n strictEqual(node.id, addedNodeID, 'We got the correct node back');\n propEqual(node.syncContext, {nodeID: addedNodeID}, 'syncContext contains the correct nodeID');\n propEqual(node.syncOptions, nodeOpts, 'node contains the given options');\n return db._syncNodes.get(addedNodeID);\n })\n .then((node) => {\n strictEqual(node.syncContext.nodeID, addedNodeID, 'Node was saved in the DB with the correct context');\n })\n .catch(function(err) {\n ok(false, \"Error: \" + err);\n })\n .finally(start);\n});\n\nasyncTest('should set myRevision to the last _changes if initialUpload is false', () => {\n const nodeOpts = {initialUpload: false};\n // Don't reuse the save URL, it would cause an error because the index is not unique\n const otherUrl = 'http://baz.invalid';\n const getOrCreateSyncNode = initGetOrCreateSyncNode(db, protocolName, otherUrl);\n db._changes.add({key: 1, obj: {foo: 'bar'}, table: 'foo', type: 1})\n .then(() => {\n return getOrCreateSyncNode(nodeOpts);\n })\n .then((node) => {\n strictEqual(node.myRevision, 1);\n })\n .catch(function(err) {\n ok(false, \"Error: \" + err);\n })\n .finally(start);\n});\n" }, { "path": "addons/Dexie.Syncable/test/unit/tests-merge-change.js", "content": "import {module, test, deepEqual} from 'QUnit';\nimport mergeChange from '../../src/merge-change';\nimport {CREATE, UPDATE, DELETE} from '../../src/change_types';\n\n// Tests for if a key exists multiple times in a table\nmodule('mergeChange: prev change was CREATE', {\n setup: () => {\n },\n teardown: () => {\n }\n});\n\ntest('should just return the nextChange if it is CREATE', () => {\n const prevChange = {\n key: 1,\n table: 'foo',\n obj: {},\n type: CREATE,\n };\n const nextChange = {\n key: 1,\n table: 'foo',\n obj: {foo: 'bar'},\n type: CREATE,\n };\n const res = mergeChange(prevChange, nextChange);\n deepEqual(res, nextChange);\n});\n\ntest('should just return the nextChange if it is DELETE', () => {\n const prevChange = {\n key: 1,\n table: 'foo',\n obj: {},\n type: CREATE,\n };\n const nextChange = {\n rev: 1,\n key: 1,\n table: 'foo',\n type: DELETE,\n };\n const res = mergeChange(prevChange, nextChange);\n deepEqual(res, nextChange);\n});\n\ntest('should combine the CREATE and UPDATE change if nextChange is UPATE', () => {\n const prevChange = {\n key: 1,\n table: 'foo',\n obj: {\n foo: 'baz',\n },\n type: CREATE,\n };\n const nextChange = {\n key: 1,\n table: 'foo',\n mods: {\n title: 'bar',\n },\n type: UPDATE,\n };\n\n const res = mergeChange(prevChange, nextChange);\n const expectedResult = {\n key: 1,\n table: 'foo',\n obj: {\n title: 'bar',\n foo: 'baz'\n },\n type: CREATE\n };\n deepEqual(res, expectedResult);\n});\n\nmodule('mergeChange: prev change was UPDATE', {\n setup: () => {\n },\n teardown: () => {\n }\n});\n\ntest('should return the nextChange if it is CREATE', () => {\n const prevChange = {\n key: 1,\n table: 'foo',\n mods: {foo: 'bar'},\n type: UPDATE,\n };\n const nextChange = {\n key: 1,\n table: 'foo',\n obj: {foo: 'bar baz'},\n type: CREATE,\n };\n const res = mergeChange(prevChange, nextChange);\n deepEqual(res, nextChange);\n});\n\ntest('should return the nextChange if it is DELETE', () => {\n const prevChange = {\n key: 1,\n table: 'foo',\n mods: {foo: 'bar'},\n type: UPDATE,\n };\n const nextChange = {\n rev: 1,\n key: 1,\n table: 'foo',\n type: DELETE,\n };\n const res = mergeChange(prevChange, nextChange);\n deepEqual(res, nextChange);\n});\n\ntest('should the changes if the nextChange is UPDATE', () => {\n const prevChange = {\n key: 1,\n table: 'foo',\n mods: {\n foo: 'baz',\n },\n type: UPDATE,\n };\n const nextChange = {\n key: 1,\n table: 'foo',\n mods: {\n title: 'bar',\n },\n type: UPDATE,\n };\n const res = mergeChange(prevChange, nextChange);\n const expectedResult = {\n key: 1,\n table: 'foo',\n mods: {\n title: 'bar',\n foo: 'baz'\n },\n type: UPDATE\n };\n deepEqual(res, expectedResult);\n});\n\nmodule('mergeChange: prev change was DELETE', {\n setup: () => {\n },\n teardown: () => {\n }\n});\n\ntest('should return nextChange if it is CREATE', () => {\n const prevChange = {\n key: 1,\n table: 'foo',\n type: DELETE,\n };\n const nextChange = {\n key: 1,\n table: 'foo',\n obj: {foo: 'bar'},\n type: CREATE,\n };\n const res = mergeChange(prevChange, nextChange);\n deepEqual(res, nextChange);\n});\n\ntest('should return the prevChange if nextChange is DELETE', () => {\n const prevChange = {\n key: 1,\n table: 'foo',\n type: DELETE,\n };\n const nextChange = {\n key: 1,\n table: 'foo',\n type: DELETE,\n };\n const res = mergeChange(prevChange, nextChange);\n deepEqual(res, prevChange);\n});\n\ntest('should return prevChange if nextChange is UPDATE', () => {\n const prevChange = {\n rev: 0,\n key: 1,\n table: 'foo',\n type: DELETE,\n };\n const nextChange = {\n rev: 1,\n key: 1,\n table: 'foo',\n mods: {foo: 'bar'},\n type: UPDATE,\n };\n const res = mergeChange(prevChange, nextChange);\n deepEqual(res, prevChange);\n});\n" }, { "path": "addons/Dexie.Syncable/test/unit/tests-register-sync-protocol.js", "content": "import Dexie from 'dexie';\nimport '../../src/Dexie.Syncable';\nimport {module, test, strictEqual, raises} from 'QUnit';\n\nmodule('registerSyncProtocol', {\n setup: () => {\n },\n teardown: () => {\n }\n});\n\ntest('should set partialsThreshold to Infinity if no threshold was given', () => {\n const protocolName = 'foo';\n Dexie.Syncable.registerSyncProtocol(protocolName, {\n sync() {},\n });\n\n strictEqual(Dexie.Syncable.registeredProtocols[protocolName].partialsThreshold, Infinity);\n});\n\ntest('should save the given partialsThreshold', () => {\n const protocolName = 'foo';\n Dexie.Syncable.registerSyncProtocol(protocolName, {\n sync() {},\n partialsThreshold: 1000\n });\n\n strictEqual(Dexie.Syncable.registeredProtocols[protocolName].partialsThreshold, 1000);\n});\n\ntest('should throw an error if the partialsThreshold is NaN or smaller 0', () => {\n const protocolName = 'foo';\n\n function fn1() {\n Dexie.Syncable.registerSyncProtocol(protocolName, {\n sync() {},\n partialsThreshold: NaN\n });\n }\n\n raises(fn1, Error, 'NaN test');\n\n function fn2() {\n Dexie.Syncable.registerSyncProtocol(protocolName, {\n sync() {},\n partialsThreshold: -10\n });\n }\n\n raises(fn2, Error, 'Negative number test');\n});\n" }, { "path": "addons/Dexie.Syncable/test/unit/tests-save-to-uncommitted-changes.js", "content": "import Dexie from 'dexie';\nimport observable from 'dexie-observable';\nimport {module, asyncTest, start, stop, strictEqual, deepEqual, ok} from 'QUnit';\nimport {resetDatabase} from '../../../../test/dexie-unittest-utils';\nimport initSaveToUncommittedChanges from '../../src/save-to-uncommitted-changes';\nimport {CREATE, DELETE, UPDATE} from '../../src/change_types';\n\nconst db = new Dexie('TestDBTable', {addons: [observable]});\ndb.version(1).stores({\n foo: \"id\"\n});\n\nconst nodeID = 1;\ndb.observable.SyncNode.prototype.save = function() {\n return {\n then(cb){ cb(); }\n };\n};\nlet syncNode;\nlet saveToUncommittedChanges;\nmodule('saveToUncommittedChanges', {\n setup: () => {\n stop();\n\n syncNode = new db.observable.SyncNode();\n syncNode.id = nodeID;\n saveToUncommittedChanges = initSaveToUncommittedChanges(db, syncNode);\n\n resetDatabase(db).catch(function (e) {\n ok(false, \"Error resetting database: \" + e.stack);\n }).finally(start);\n },\n teardown: () => {\n }\n});\n\nasyncTest('should save the given changes in the _uncommittedChanges table', () => {\n const create = {\n key: 1,\n table: 'foo',\n type: CREATE,\n obj: {foo: 'bar'}\n };\n const update = {\n key: 2,\n table: 'foo',\n type: UPDATE,\n mods: {bar: 'baz'}\n };\n const remove = {\n key: 3,\n table: 'foo',\n type: DELETE\n };\n const changes = [create, update, remove];\n saveToUncommittedChanges(changes, 10)\n .then(() => {\n return db._uncommittedChanges.toArray();\n })\n .then((changes) => {\n strictEqual(changes.length, 3, 'Number of changes matches');\n deepEqual(changes[0], {\n id: 1,\n key: 1,\n type: CREATE,\n node: nodeID,\n table: 'foo',\n obj: {foo: 'bar'}\n }, 'Create change');\n deepEqual(changes[1], {\n id: 2,\n key: 2,\n type: UPDATE,\n node: nodeID,\n table: 'foo',\n mods: {bar: 'baz'}\n }, 'Update change');\n deepEqual(changes[2], {\n id: 3,\n key: 3,\n type: DELETE,\n node: nodeID,\n table: 'foo'\n }, 'Delete change');\n })\n .catch(function(err) {\n ok(false, \"Error: \" + err);\n })\n .finally(start);\n});\n\nasyncTest('should add the remoteRevision to the given node', () => {\n const remoteRevision = 20;\n saveToUncommittedChanges([], remoteRevision)\n .then(() => {\n strictEqual(syncNode.appliedRemoteRevision, remoteRevision);\n })\n .catch(function(err) {\n ok(false, \"Error: \" + err);\n })\n .finally(start);\n});\n" }, { "path": "addons/Dexie.Syncable/test/unit/tests-syncable-partials.js", "content": "import Dexie from 'dexie';\nimport 'dexie-observable';\nimport '../../src/Dexie.Syncable';\nimport {module, asyncTest, start, stop, strictEqual, deepEqual, ok} from 'QUnit';\n\n/* The following is being tested:\n\n 1. Client partials\n 2. Receiving partials from the server\n 3. What happens when the partialsThreshold is 0\n */\nvar db1 = new Dexie(\"db1\");\nvar deletePromise = Dexie.delete(\"db1\");\n\nmodule(\"tests-syncable-partials\", {\n setup: function () {\n db1.close();\n stop();\n deletePromise.then(function () {\n start()\n });\n },\n teardown: function () {\n }\n});\n\nconst partialsThreshold = 100;\nasyncTest(\"client/server partials\", function () {\n var testNo = 0;\n var callbacks = [];\n Dexie.Syncable.registerSyncProtocol(\"testProtocol\", {\n sync: function (context, url, options, baseRevision, syncedRevision, changes, partial, applyRemoteChanges, onChangesAccepted, onSuccess, onError) {\n var thiz = this, args = arguments;\n Dexie.vip(function () {\n try {\n callbacks[testNo++].apply(thiz, args);\n } catch (err) {\n db1.close();\n ok(false, err);\n start();\n }\n });\n },\n partialsThreshold: partialsThreshold\n });\n\n db1.version(1).stores({objects: \"$$\"});\n\n db1.on('populate', function () {\n db1.objects.add({name: \"one\"});\n db1.objects.add({name: \"two\"});\n db1.objects.add({name: \"three\"});\n });\n\n db1.open();\n\n db1.syncable.connect(\"testProtocol\", \"http://dummy.local\");\n\n // Prepare tests\n callbacks.push(function (context, url, options, baseRevision, syncedRevision, changes, partial, applyRemoteChanges, onChangesAccepted, onSuccess, onError) {\n // applyRemoteChanges\n applyRemoteChanges([], \"revision one\", false, false).then(function () {\n // onChangesAccepted\n onChangesAccepted();\n }).then(function () {\n // onSuccess\n onSuccess({again: 1});\n });\n });\n\n // Bulk add changes to pass the threshold\n callbacks.push(function (context, url, options, baseRevision, syncedRevision, changes, partial, applyRemoteChanges, onChangesAccepted, onSuccess, onError) {\n // baseRevision\n equal(baseRevision, \"revision one\", \"Now we get changes based on revision two\");\n // syncedRevision\n equal(syncedRevision, \"revision one\", \"Sync revision is 'revision two' because client has got it\");\n // partial\n equal(partial, false, 'partial should be false');\n onChangesAccepted();\n db1.transaction('rw', db1.objects, function () {\n for (var i = 0; i < partialsThreshold + 1; ++i) {\n db1.objects.add({name: \"bulk\"});\n }\n }).then(function () {\n onSuccess({again: 1});\n });\n });\n\n // Make sure that we didn't receive more changes than the threshold\n callbacks.push(function (context, url, options, baseRevision, syncedRevision, changes, partial, applyRemoteChanges, onChangesAccepted, onSuccess, onError) {\n // baseRevision\n equal(baseRevision, \"revision one\", \"Now we get changes based on revision two\");\n // syncedRevision\n equal(syncedRevision, \"revision one\", \"Sync revision is 'revision two' because client has got it\");\n // changes\n equal(changes.length, partialsThreshold, `Got ${partialsThreshold} changes`);\n equal(changes[0].obj.name, \"bulk\", \"change is bulk\");\n equal(partial, true, `More than ${partialsThreshold} changes gives partial=true`);\n onChangesAccepted();\n onSuccess({again: 1});\n });\n\n // Make sure we now get the rest of the changes\n // Revisions shouldn't change\n callbacks.push(function (context, url, options, baseRevision, syncedRevision, changes, partial, applyRemoteChanges, onChangesAccepted, onSuccess, onError) {\n // baseRevision\n equal(baseRevision, \"revision one\", \"Now we get changes based on revision two\");\n // syncedRevision\n equal(syncedRevision, \"revision one\", \"Sync revision is 'revision two' because client has got it\");\n // changes\n equal(changes.length, 1, \"Got 1 change\");\n equal(changes[0].obj.name, \"bulk\", \"change is bulk\");\n equal(partial, false, \"Last chunk with 1 change\");\n onSuccess({again: 1});\n });\n\n // Test that a server partial is added to _uncommittedChanges and not to _changes\n callbacks.push(function (context, url, options, baseRevision, syncedRevision, changes, partial, applyRemoteChanges, onChangesAccepted, onSuccess, onError) {\n applyRemoteChanges([{\n type: 1,\n table: \"objects\",\n key: \"apa\",\n obj: {name: \"uncommittedChange\"}\n }], \"revision with uncommitted\", true, false)\n .then(() => {\n return db1._uncommittedChanges.toArray().then((changes) => {\n strictEqual(changes.length, 1, 'Should have one uncommitted change');\n strictEqual(changes[0].key, 'apa', 'Key should match');\n deepEqual(changes[0].obj, {name: 'uncommittedChange'}, 'Saved obj should match');\n strictEqual(changes[0].table, 'objects', 'Table should match');\n strictEqual(changes[0].type, 1, 'Type should match');\n\n return db1._changes.toArray();\n });\n })\n .then((changes) => {\n ok(changes.every(function (change) {\n return change.obj.name !== 'uncommittedChange'\n }), 'The uncommitted change should not be in _changes');\n return db1._syncNodes.where('url').equals('http://dummy.local').toArray();\n })\n .then((nodes) => {\n strictEqual(nodes[0].appliedRemoteRevision, 'revision with uncommitted', \"The node's appliedRemoteRevision should be updated\");\n onSuccess({again: 1});\n });\n });\n\n // Test that if we don't have partial anymore -> move _uncommittedChanges to _changes\n callbacks.push(function (context, url, options, baseRevision, syncedRevision, changes, partial, applyRemoteChanges, onChangesAccepted, onSuccess, onError) {\n applyRemoteChanges([{\n type: 1,\n table: \"objects\",\n key: \"abba\",\n obj: {name: \"committedChange\"}\n }], \"revision one\", false, false)\n .then(() => {\n return db1._uncommittedChanges.toArray().then((changes) => {\n strictEqual(changes.length, 0, 'Should have no uncommitted change');\n return db1._changes.toArray();\n });\n })\n .then((changes) => {\n ok(changes.some(function (change) {\n return change.obj.name === 'uncommittedChange'\n }), 'The uncommitted change should now be in _changes');\n ok(changes.some(function (change) {\n return change.obj.name === 'committedChange'\n }), 'The committedChange should also be in _changes');\n })\n .then(function () {\n return db1.delete();\n }).catch(function (err) {\n ok(false, \"Got error: \" + err);\n }).finally(start);\n });\n});\n\nasyncTest('partialsThreshold is zero', () => {\n var testNo = 0;\n var callbacks = [];\n Dexie.Syncable.registerSyncProtocol(\"testProtocol\", {\n sync: function (context, url, options, baseRevision, syncedRevision, changes, partial, applyRemoteChanges, onChangesAccepted, onSuccess, onError) {\n var thiz = this, args = arguments;\n Dexie.vip(function () {\n try {\n callbacks[testNo++].apply(thiz, args);\n } catch (err) {\n db1.close();\n ok(false, err);\n start();\n }\n });\n },\n partialsThreshold: 0\n });\n\n db1.version(1).stores({objects: \"$$\"});\n\n db1.on('populate', function () {\n db1.objects.add({name: \"one\"});\n db1.objects.add({name: \"two\"});\n });\n\n db1.open();\n\n db1.syncable.connect(\"testProtocol\", \"http://dummy.local\", {option1: \"option1\"});\n\n callbacks.push(function (context, url, options, baseRevision, syncedRevision, changes, partial) {\n // changes\n equal(changes.length, 0, \"No changes\");\n equal(partial, true, \"Partial since threshold is 0\");\n start();\n });\n});\n" }, { "path": "addons/Dexie.Syncable/test/unit/tests-syncable.js", "content": "import Dexie from 'dexie';\nimport 'dexie-observable';\nimport '../../src/Dexie.Syncable';\nimport {module, asyncTest, start, stop, strictEqual, deepEqual, ok} from 'QUnit';\n\n/* The following is being tested:\n\n 1. A dummy implementation of ISyncProtocol is registered so that the unit test can interact with the database correctly.\n 2. Test status changes\n 3. Test disconnect/reconnect and that we get changes which happened as we were disconnected\n */\nvar db1 = new Dexie(\"db1\");\nvar db2 = new Dexie(\"db1\");\nvar deletePromise = Dexie.delete(\"db1\");\n\nmodule(\"tests-syncable\", {\n setup: function () {\n db1.close();\n db2.close();\n stop();\n deletePromise.then(function () {\n start()\n });\n },\n teardown: function () {\n }\n});\n\nasyncTest(\"connect(), disconnect()\", function () {\n var testNo = 0;\n var callbacks = [];\n Dexie.Syncable.registerSyncProtocol(\"testProtocol\", {\n sync: function (context, url, options, baseRevision, syncedRevision, changes, partial, applyRemoteChanges, onChangesAccepted, onSuccess, onError) {\n var thiz = this, args = arguments;\n Dexie.vip(function () {\n try {\n callbacks[testNo++].apply(thiz, args);\n } catch (err) {\n db1.close();\n ok(false, err);\n start();\n }\n });\n },\n partialsThreshold: 1000\n });\n\n db1.version(1).stores({objects: \"$$\"});\n db2.version(1).stores({objects: \"$$\"});\n\n db1.on('populate', function () {\n db1.objects.add({name: \"one\"});\n db1.objects.add({name: \"two\"});\n db1.objects.add({name: \"three\"}).then(function (key) {\n db1.objects.update(key, {name: \"four\"});\n });\n });\n\n db1.syncable.on('statusChanged', function (newStatus) {\n ok(true, \"Status changed to \" + Dexie.Syncable.StatusTexts[newStatus]);\n });\n db2.syncable.on('statusChanged', function (newStatus) {\n ok(true, \"Status changed to \" + Dexie.Syncable.StatusTexts[newStatus]);\n });\n\n db1.open();\n\n var connectPromise = db1.syncable.connect(\"testProtocol\", \"http://dummy.local\", {option1: \"option1\"});\n\n // Test first sync call\n callbacks.push(function (context, url, options, baseRevision, syncedRevision, changes, partial, applyRemoteChanges, onChangesAccepted, onSuccess, onError) {\n // url\n equal(url, \"http://dummy.local\", \"URL got through\");\n // options\n equal(options.option1, \"option1\", \"Options got through\");\n // baseRevision\n equal(baseRevision, null, \"Base revision is null\");\n // syncedRevision\n equal(syncedRevision, null, \"Sync revision is null\");\n // changes\n equal(changes.length, 3, \"Three changes (change number four should be reduced into change no 3\");\n ok(changes.every(function (change) {\n return change.type == 1\n }), \"All three changes are create changes\");\n ok(changes.some(function (change) {\n return change.obj.name == \"one\"\n }), \"'one' is among changes\");\n ok(changes.some(function (change) {\n return change.obj.name == \"two\"\n }), \"'two' is among changes\");\n ok(changes.some(function (change) {\n return change.obj.name == \"four\"\n }), \"'four' is among changes\");\n // partial\n equal(partial, false, \"Not partial since number of changes are below 1000\");\n // applyRemoteChanges\n applyRemoteChanges([{\n type: 1,\n table: \"objects\",\n key: \"apa\",\n obj: {name: \"five\"}\n }], \"revision one\", false, false).then(function () {\n // Create a local change between remoteChanges application\n return db1.objects.add({name: \"six\"});\n }).then(function () {\n return applyRemoteChanges([{\n type: 1,\n table: \"objects\",\n key: \"apa2\",\n obj: {name: \"seven\"}\n }], \"revision two\", false, false);\n }).then(function () {\n // onChangesAccepted\n onChangesAccepted();\n return db1.objects.add({name: \"eight\"});\n }).then(function () {\n // onSuccess\n onSuccess({again: 1});\n });\n });\n\n connectPromise.then(function () {\n db1.objects.count(function (count) {\n equal(count, 7, \"There should be seven objects in db after sync\");\n // From populate:\n // 1: one\n // 2: two\n // 3: four\n // 4: applyRemoteChanges: \"five\" (\"apa\")\n // 5: db.objects.add(\"six\")\n // 6: applyRemoteChanges: \"seven\" (\"apa2\")\n // 7: db.objects.add(\"eight\");\n });\n db1.objects.get(\"apa2\", function (seven) {\n equal(seven.name, \"seven\", \"Have got the change from the server. If not, check that promise does not fire until all changes have committed.\");\n });\n }).catch('DatabaseClosedError', function () {\n console.warn(\"DatabaseClosedError\");\n }).catch(function (ex) {\n ok(false, \"Could not connect. Error: \" + (ex.stack || ex));\n });\n\n callbacks.push(function (context, url, options, baseRevision, syncedRevision, changes, partial, applyRemoteChanges, onChangesAccepted, onSuccess, onError) {\n // url\n equal(url, \"http://dummy.local\", \"URL still there\");\n // options\n equal(options.option1, \"option1\", \"Options still there\");\n // baseRevision\n equal(baseRevision, \"revision one\", \"First chunk of changes is based on revision one because 'six' was created based on revision one\");\n // syncedRevision\n equal(syncedRevision, \"revision two\", \"Sync revision is 'revision two' because client has got it\");\n // changes\n equal(changes.length, 1, \"Even though there's two changes, we should only get the first one because they are based on different revisions\");\n equal(changes[0].obj.name, \"six\", \"First change is six\");\n equal(partial, false);\n onChangesAccepted();\n onSuccess({again: 1});\n });\n\n // Prepare disconnect test\n callbacks.push(function (context, url, options, baseRevision, syncedRevision, changes, partial, applyRemoteChanges, onChangesAccepted, onSuccess, onError) {\n // baseRevision\n equal(baseRevision, \"revision two\", \"Now we get changes based on revision two\");\n // syncedRevision\n equal(syncedRevision, \"revision two\", \"Sync revision is 'revision two' because client has got it\");\n // changes\n equal(changes.length, 1, \"Got another change\");\n equal(changes[0].obj.name, \"eight\", \"change is eight\");\n equal(partial, false);\n onChangesAccepted();\n\n // Test disconnect()\n db1.syncable.disconnect(\"http://dummy.local\");\n onSuccess({again: 1}); // Framework should ignore again: 1 since it's disconnected.\n setTimeout(reconnect, 500);\n db1.objects.add({name: \"changeAfterDisconnect\"});\n });\n\n function reconnect() {\n db1.close();\n db1 = db2;\n db1.open().then(function () {\n return db1.objects.add({name: \"changeBeforeReconnect\"});\n }).then(function () {\n return db1.syncable.getStatus(\"http://dummy.local\", function (status) {\n equal(status, Dexie.Syncable.Statuses.OFFLINE, \"Status is OFFLINE\");\n });\n }).then(function () {\n db1.syncable.connect(\"testProtocol\", \"http://dummy.local\");\n });\n }\n\n callbacks.push(function (context, url, options, baseRevision, syncedRevision, changes, partial, applyRemoteChanges, onChangesAccepted, onSuccess, onError) {\n // baseRevision\n equal(baseRevision, \"revision two\", \"baseRevision Still revision two\");\n // syncedRevision\n equal(syncedRevision, \"revision two\", \"syncedRevision Still revision two\");\n // changes\n equal(changes.length, 2, \"Got 2 changes after reconnect.\");\n equal(changes[0].obj.name, \"changeAfterDisconnect\", \"change one is changeAfterDisconnect\");\n equal(changes[1].obj.name, \"changeBeforeReconnect\", \"change two is changeBeforeReconnect\");\n onChangesAccepted();\n\n onSuccess({again: 10000}); // Wait a looong time for calling us again (so that we have the time to close and reopen and then force a sync sooner)\n\n setTimeout(function () {\n db1.syncable.getStatus(\"http://dummy.local\", function (status) {\n // Close and open again and it will be status connected at once\n equal(status, Dexie.Syncable.Statuses.ONLINE, \"Status is ONLINE\");\n }).then(function () {\n // Close and open again and it will be status connected at once\n return db1.delete();\n }).catch(function (err) {\n ok(false, \"Got error: \" + err);\n }).finally(start);\n }, 100);\n });\n});\n\nasyncTest('delete()', () => {\n var testNo = 0;\n var callbacks = [];\n Dexie.Syncable.registerSyncProtocol(\"testProtocol\", {\n sync: function (context, url, options, baseRevision, syncedRevision, changes, partial, applyRemoteChanges, onChangesAccepted, onSuccess, onError) {\n var thiz = this, args = arguments;\n Dexie.vip(function () {\n try {\n callbacks[testNo++].apply(thiz, args);\n } catch (err) {\n db1.close();\n ok(false, err);\n start();\n }\n });\n },\n partialsThreshold: 10\n });\n\n db1.version(1).stores({objects: \"$$\"});\n\n db1.on('populate', function () {\n db1.objects.add({name: \"one\"});\n db1.objects.add({name: \"two\"});\n });\n\n db1.open();\n\n const url = \"http://urlToDelete.local\";\n db1.syncable.connect(\"testProtocol\", url);\n\n db1.syncable.on('statusChanged', function (newStatus) {\n ok(true, \"Status changed to \" + Dexie.Syncable.StatusTexts[newStatus]);\n });\n\n const originalDisconnect = db1.syncable.disconnect;\n\n let disconnectWasCalled = false;\n db1.syncable.disconnect = function (url) {\n disconnectWasCalled = true;\n return originalDisconnect(url);\n };\n\n const originalDeleteOldChanges = Dexie.Observable.deleteOldChanges;\n\n let deleteOldChangesWasCalled = false;\n Dexie.Observable.deleteOldChanges = function (db) {\n deleteOldChangesWasCalled = true;\n return originalDeleteOldChanges(db);\n };\n\n callbacks.push(function (context, url, options, baseRevision, syncedRevision, changes, partial, applyRemoteChanges, onChangesAccepted, onSuccess, onError) {\n // Add some uncommitted changes\n applyRemoteChanges([{\n type: 1,\n table: \"objects\",\n key: \"apa\",\n obj: {name: \"uncommittedChangeBeforeDelete\"}\n }], \"revision with uncommitted\", true, false)\n .then(() => {\n return db1.syncable.delete(url);\n })\n .then(() => {\n ok(disconnectWasCalled, 'We got disconnected');\n return db1._uncommittedChanges.toArray();\n })\n .then((uncommittedChanges) => {\n ok(uncommittedChanges.every(function (change) {\n return change.obj.name !== 'uncommittedChangeBeforeDelete'\n }), 'The uncommitted change should not be in _uncommittedChanges anymore');\n return db1._syncNodes.where('url').equals(url).toArray();\n })\n .then((nodes) => {\n strictEqual(nodes.length, 0, 'All nodes with this url should be deleted');\n ok(deleteOldChangesWasCalled, 'Observable.deleteOldChanges was called');\n })\n .catch(function (err) {\n ok(false, \"Got error: \" + err);\n }).finally(start);\n onSuccess(); // Stop syncing\n });\n});\n" }, { "path": "addons/Dexie.Syncable/test/unit/tests-syncprovider.js", "content": "import Dexie from 'dexie';\nimport 'dexie-observable';\nimport '../../src/Dexie.Syncable';\nimport {module, asyncTest, start, stop, strictEqual, deepEqual, ok} from 'QUnit';\n\n/* To Test:\n * db.sync() using WebSocketSyncProtocol and WebSocketSyncServer with two db's of different names in same window.\n * Add object to db1\n * Make sure it appears in db2\n * Add 1100 objects to db2\n * Make sure they all appear in db1 - ALSO DEBUG THAT:\n * db2 sends it's changes as two chunks where first one is partial and second final\n * SyncServer gets partial and applies to uncommittedChanges\n * SyncServer gets final and commits changes, as well as triggers db1 provider, who\n * calls applyRemoteChanges on all objects.\n * db1.on('changes') gets triggered.\n * Add 1000 objects the same way and debug that:\n * db2 sents it's changes as one or two chunks depending on how I implemented it.\n * Add another db with same name as one of the two dbs.\n * Make sure that the third DB is not master\n * Make sure that sync() on third db will call master and make it sync, or connect to existing syncing.\n * Make sure that the third DB gets changes added to other remote db.\n * Take down master and make sure third DB becomes master and can continue syncing.\n */\n\n/* WebSocketSyncProtocol\n * Was copied from /samples/remote-sync/websocket/WebSocketSyncProtocol.js\n * The tests would hang with the original file. Probably because of different instances of\n * Dexie and Dexie.Syncable (there were no registered protocols in the test when using directly the file from samples)\n */\n\n// Constants:\nvar RECONNECT_DELAY = 5000;\nDexie.Syncable.registerSyncProtocol(\"websocket\", {\n\n sync: function (context, url, options, baseRevision, syncedRevision, changes, partial, applyRemoteChanges, onChangesAccepted, onSuccess, onError) {\n var requestId = 0;\n var acceptCallbacks = {};\n var ws = new WebSocket(url);\n function sendChanges(changes, baseRevision, partial, onChangesAccepted) {\n ++requestId;\n acceptCallbacks[requestId.toString()] = onChangesAccepted;\n ws.send(JSON.stringify({\n type: 'changes',\n changes: changes,\n partial: partial,\n baseRevision: baseRevision,\n requestId: requestId\n }));\n }\n\n ws.onopen = function (event) {\n ws.send(JSON.stringify({\n type: \"clientIdentity\",\n clientIdentity: context.clientIdentity || null\n }));\n sendChanges(changes, baseRevision, partial, onChangesAccepted);\n ws.send(JSON.stringify({\n type: \"subscribe\",\n syncedRevision: syncedRevision\n }));\n }\n ws.onerror = function (event) {\n ws.close();\n onError(event.message, RECONNECT_DELAY);\n }\n ws.onclose = function (event) {\n onError(\"Socket closed: \" + event.reason, RECONNECT_DELAY);\n }\n var isFirstRound = true;\n ws.onmessage = function (event) {\n try {\n var requestFromServer = JSON.parse(event.data);\n if (requestFromServer.type == \"changes\") {\n applyRemoteChanges(requestFromServer.changes, requestFromServer.currentRevision, requestFromServer.partial);\n if (isFirstRound && !requestFromServer.partial) {\n onSuccess({\n react: function (changes, baseRevision, partial, onChangesAccepted) {\n sendChanges(changes, baseRevision, partial, onChangesAccepted);\n },\n disconnect: function () {\n ws.close();\n }\n });\n isFirstRound = false;\n }\n } else if (requestFromServer.type == \"ack\") {\n var requestId = requestFromServer.requestId;\n var acceptCallback = acceptCallbacks[requestId.toString()];\n acceptCallback(); // Tell framework that server has acknowledged the changes sent.\n delete acceptCallbacks[requestId.toString()];\n } else if (requestFromServer.type == \"clientIdentity\") {\n context.clientIdentity = requestFromServer.clientIdentity;\n context.save();\n } else if (requestFromServer.type == \"error\") {\n var requestId = requestFromServer.requestId;\n ws.close();\n onError(requestFromServer.message, Infinity); // Don't reconnect - an error in application level means we have done something wrong.\n }\n } catch (e) {\n ws.close();\n onError(e, Infinity); // Something went crazy. Server sends invalid format or our code is buggy. Dont reconnect - it would continue failing.\n }\n }\n }\n});\n\nmodule(\"tests-syncprovider\", {\n setup: function () {\n stop();\n Dexie.Promise.all(Dexie.delete(\"SyncProviderTest\"), Dexie.delete(\"OtherClientDB\")).then(function () {\n start();\n }).catch(function (e) {\n ok(false, \"Could not delete database\");\n });\n },\n teardown: function () {\n stop();\n Dexie.Promise.all(Dexie.delete(\"SyncProviderTest\"), Dexie.delete(\"OtherClientDB\")\n ).catch('DatabaseClosedError', function () {\n }).then(function () {\n start();\n });\n }\n});\n\nasyncTest(\"testSyncProvider\", function () {\n var CREATE = 1,\n UPDATE = 2,\n DELETE = 3;\n\n var db = new Dexie(\"SyncProviderTest\");\n db.version(1).stores({\n friends: \"$$id,name\",\n pets: \"$$id,kind,name\"\n });\n\n // Setup the sync server\n var server = new SyncServer(5000);\n server.start();\n\n // Connect our db client to it\n db.syncable.connect(\"websocket\", \"http://dummy:5000\");\n db.syncable.on('statusChanged', function (newStatus, url) {\n console.log(\"Sync State Changed: \" + Dexie.Syncable.StatusTexts[newStatus]);\n });\n\n // Open database\n db.open();\n\n // Create another database to sync with:\n var db2 = new Dexie(\"OtherClientDB\");\n db2.version(1).stores({\n friends: \"$$id\",\n pets: \"$$id\"\n });\n\n db2.syncable.connect(\"websocket\", \"http://dummy:5000\");\n db2.open().then(function () {\n console.log(\"db2 opened\");\n });\n\n db2.on('changes', function (changes, partial) {\n console.log(\"db2.on('changes'): changes.length: \" + changes.length + \"\\tpartial: \" + (partial ? \"true\" : \"false\"));\n changes.forEach(function (change) {\n //console.log(JSON.stringify(change));\n db2.checkChange(change);\n });\n });\n\n db.on('changes', function (changes, partial) {\n console.log(\"db.on('changes'): changes.length: \" + changes.length + \"\\tpartial: \" + (partial ? \"true\" : \"false\"));\n changes.forEach(function (change) {\n if (db.checkChange) db.checkChange(change);\n });\n });\n\n function waitFor(db, params) {\n return new Dexie.Promise(function (resolve, reject) {\n db.checkChange = function (change) {\n var checker = {};\n Dexie.extend(checker, change);\n if (change.type == CREATE) Dexie.extend(checker, change.obj);\n if (change.type == UPDATE) Dexie.extend(checker, change.mods);\n var found = true;\n Object.keys(params).forEach(function (param) {\n if (!(param in checker)) found = false;\n if (params[param] != checker[param]) found = false;\n });\n if (found) resolve();\n }\n });\n }\n\n db.friends.add({name: \"David\"});\n\n waitFor(db2, {type: CREATE, name: \"David\"}).then(function () {\n ok(true, \"The CREATE of friend 'David' was sent all the way to server and then back again to db2.\");\n db.friends.where('name').equals('David').modify({name: \"Ylva\"});\n return waitFor(db2, {type: UPDATE, name: \"Ylva\"});\n }).then(function () {\n ok(true, \"The UPDATE of friend 'David' to 'Ylva' was sent all the way around as well\");\n return db.friends.where('name').equals('Ylva').first(function (friend) {\n return friend.id;\n })\n }).then(function (id) {\n db.friends.delete(id);\n return waitFor(db2, {type: DELETE, key: id});\n }).then(function () {\n ok(true, \"The DELETE of friend 'Ylva' was sent all the way around as well\");\n // Now send 1100 create requests\n var petsToAdd = new Array(1100);\n for (var i = 0; i < petsToAdd.length; ++i) {\n petsToAdd[i] = {name: \"Josephina\" + (i + 1), kind: \"Dog\"};\n }\n return db2.pets.bulkAdd(petsToAdd);\n }).then(function () {\n ok(true, \"Successfully added 1100 pets into db2. Now wait for the last change to be synced into db1.\");\n return waitFor(db, {type: CREATE, name: \"Josephina1100\"});\n }).then(function () {\n ok(true, \"All 1100 dogs where sent all the way around (db2-->db this time)\");\n // Now check that db2 contains all dogs and that its _uncommittedChanges is emptied\n return db.pets.count(function (count) {\n equal(count, 1100, \"DB2 has 1100 pets now\");\n });\n }).then(function () {\n return db._uncommittedChanges.count(function (count) {\n equal(count, 0, \"DB2 has no uncommitted changes anymore\");\n });\n }).then(function () {\n ok(true, \"Now send 1000 create this time (exact number of max changes per chunk)\");\n var petsToAdd = new Array(1000);\n for (var i = 0; i < petsToAdd.length; ++i) {\n petsToAdd[i] = {name: \"Tito\" + (i + 1), kind: \"Cat\"};\n }\n return db.pets.bulkAdd(petsToAdd);\n }).then(function () {\n ok(true, \"Successfully added 1000 cats. Now wait for them to arrive in db2.\");\n return waitFor(db2, {type: CREATE, name: \"Tito1000\"});\n }).then(function () {\n ok(true, \"All 1000 cats where sent all the way around (db-->db2 this time)\");\n }).finally(function () {\n console.log(\"Closing down\");\n db.close();\n db2.close();\n start();\n });\n});\n" }, { "path": "addons/Dexie.Syncable/test/unit/unit-tests-all.js", "content": "import './get-local-changes-for-node/tests-get-base-revision-and-max-client-revision.js';\nimport './get-local-changes-for-node/tests-get-changes-since-revision.js';\nimport './get-local-changes-for-node/tests-get-local-changes-for-node.js';\nimport './tests-apply-changes.js';\nimport './tests-bulk-update.js';\nimport './tests-changing-options.js';\nimport './tests-combine-create-and-update.js';\nimport './tests-combine-update-and-update.js';\nimport './tests-finally-commit-all-changes.js';\nimport './tests-get-or-create-sync-node.js';\nimport './tests-merge-change.js';\nimport './tests-PersistedContext.js';\nimport './tests-register-sync-protocol.js';\nimport './tests-save-to-uncommitted-changes.js';\nimport './tests-syncable.js';\nimport './tests-syncable-partials.js';\nimport './tests-syncprovider.js';\nimport './tests-WebSocketSyncServer.js';\n" }, { "path": "addons/Dexie.Syncable/tools/build-configs/banner.txt", "content": "/* ========================================================================== \n * dexie-syncable.js\n * ==========================================================================\n *\n * Dexie addon for syncing indexedDB with remote endpoints.\n *\n * By David Fahlander, david.fahlander@gmail.com,\n * Nikolas Poniros, https://github.com/nponiros\n *\n * ==========================================================================\n *\n * Version {version}, {date}\n *\n * https://dexie.org\n *\n * Apache License Version 2.0, January 2004, http://www.apache.org/licenses/\n * \n */\n" }, { "path": "addons/Dexie.Syncable/tools/build-configs/rollup.config.mjs", "content": "import sourcemaps from 'rollup-plugin-sourcemaps';\nimport {readFileSync} from 'fs';\nimport path from 'path';\nimport { fileURLToPath } from 'url';\n\nconst __filename = fileURLToPath(import.meta.url);\nconst __dirname = path.dirname(__filename);\nconst packageJson = JSON.parse(readFileSync(path.resolve(__dirname, '../../package.json'), 'utf-8'));\nconst version = packageJson.version;\n\nexport default {\n input: 'tools/tmp/es5/addons/Dexie.Syncable/src/Dexie.Syncable.js',\n output: [{\n file: 'dist/dexie-syncable.js',\n format: 'umd',\n banner: readFileSync(path.resolve(__dirname, 'banner.txt')),\n globals: {dexie: \"Dexie\", \"dexie-observable\": \"Dexie.Observable\"},\n name: \"Dexie.Syncable\",\n },{\n file: 'dist/dexie-syncable.es.js',\n format: 'es',\n banner: readFileSync(path.resolve(__dirname, 'banner.txt')),\n globals: {dexie: \"Dexie\", \"dexie-observable\": \"Dexie.Observable\"},\n name: \"Dexie.Syncable\",\n }],\n external: ['dexie', 'dexie-observable'],\n plugins: [ sourcemaps() ]\n};\n" }, { "path": "addons/Dexie.Syncable/tools/build-configs/rollup.tests.config.js", "content": "import sourcemaps from 'rollup-plugin-sourcemaps';\nimport commonjs from '@rollup/plugin-commonjs';\nimport nodeResolve from '@rollup/plugin-node-resolve';\n\nconst ERRORS_TO_IGNORE = [\n \"THIS_IS_UNDEFINED\"\n];\n\nexport default {\n input: 'tools/tmp/es5/addons/Dexie.Syncable/test/unit/unit-tests-all.js',\n output: [{\n file: 'test/unit/bundle.js',\n format: 'umd',\n name: 'dexieSyncableTests',\n globals: {dexie: \"Dexie\", \"dexie-observable\": \"Dexie.Observable\", QUnit: \"QUnit\"},\n }],\n external: ['dexie', 'dexie-observable', 'QUnit'],\n plugins: [\n sourcemaps(),\n nodeResolve({browser: true}),\n commonjs()\n ],\n onwarn ({loc, frame, code, message}) {\n if (ERRORS_TO_IGNORE.includes(code)) return;\n if ( loc ) {\n console.warn( `${loc.file} (${loc.line}:${loc.column}) ${message}` );\n if ( frame ) console.warn( frame );\n } else {\n console.warn(`${code} ${message}`);\n } \n }\n};\n" }, { "path": "addons/Dexie.Syncable/tools/build-configs/rollup.tests.config.mjs", "content": "import sourcemaps from 'rollup-plugin-sourcemaps';\nimport commonjs from '@rollup/plugin-commonjs';\nimport nodeResolve from '@rollup/plugin-node-resolve';\n\nconst ERRORS_TO_IGNORE = [\n \"THIS_IS_UNDEFINED\"\n];\n\nexport default {\n input: 'tools/tmp/es5/addons/Dexie.Syncable/test/unit/unit-tests-all.js',\n output: [{\n file: 'test/unit/bundle.js',\n format: 'umd',\n name: 'dexieSyncableTests',\n globals: {dexie: \"Dexie\", \"dexie-observable\": \"Dexie.Observable\", QUnit: \"QUnit\"},\n }],\n external: ['dexie', 'dexie-observable', 'QUnit'],\n plugins: [\n sourcemaps(),\n nodeResolve({browser: true}),\n commonjs()\n ],\n onwarn ({loc, frame, code, message}) {\n if (ERRORS_TO_IGNORE.includes(code)) return;\n if ( loc ) {\n console.warn( `${loc.file} (${loc.line}:${loc.column}) ${message}` );\n if ( frame ) console.warn( frame );\n } else {\n console.warn(`${code} ${message}`);\n } \n }\n};\n" }, { "path": "addons/Dexie.Syncable/tools/replaceVersionAndDate.js", "content": "const fs = require('fs');\nconst files = process.argv.slice(2);\nconst version = require('../package.json').version;\n\nfiles.forEach(file => {\n let fileContent = fs.readFileSync(file, \"utf-8\");\n fileContent = fileContent\n .replace(/{version}/g, version)\n .replace(/{date}/g, new Date().toDateString());\n fs.writeFileSync(file, fileContent, \"utf-8\");\n});\n" }, { "path": "addons/dexie-cloud/.gitignore", "content": "dist/\nesnext/\n.eslintcache\n**/tmp/\ntest/**/bundle.*\ndexie-cloud.key\ndexie-cloud.json\n" }, { "path": "addons/dexie-cloud/.npmignore", "content": ".DS_Store\ntools/\nsrc/\nbin-src/\n.*\ntmp/\n**/tmp/\ntest\n*.log\ndexie-cloud.key\ndexie-cloud.json\n" }, { "path": "addons/dexie-cloud/.vscode/settings.json", "content": "{\n \"editor.formatOnSave\": true\n}\n" }, { "path": "addons/dexie-cloud/README.md", "content": "The web client for [Dexie Cloud](https://dexie.org/cloud/).\n\n## Getting started\n\n```\nnpm install dexie@latest\nnpm install dexie-cloud-addon@latest\n```\n\n```ts\nimport { Dexie } from 'dexie';\nimport dexieCloud from 'dexie-cloud-addon';\n\nconst db = new Dexie('dbname', { addons: [dexieCloud]});\n\ndb.version(1).stores({\n yourTable: '@primKeyProp, indexedProp1, indexedProp2, ...'\n});\n\ndb.cloud.configure({\n databaseUrl: 'https://.dexie.cloud'\n})\n```\n\n## See also\n\nhttps://dexie.org/cloud/docs/dexie-cloud-addon#api\n\n## Obtaining a database URL\n\nRun the following command in a console / terminal:\n\n```\nnpx dexie-cloud create\n```\n\nSee also https://dexie.org/cloud/#getting-started\n\n*Having problems getting started, please [file an issue](https://github.com/dexie/Dexie.js/issues/new)*\n\n# The Cloud Service\n\n[![Better Stack Badge](https://uptime.betterstack.com/status-badges/v2/monitor/jist.svg)](https://www.dexie-cloud-status.com)\n\nThe official production service for Dexie Cloud Server is forever free of charge so you do not need to install any server to get started. The free service has some limits, see https://dexie.org/cloud/pricing\n\n# On-Prem version\n\nDexie Cloud Server is a closed source software that can be purchased and installed on own hardware, see [On-Prem Silver / On-Prem Gold](https://dexie.org/cloud/pricing)\n\n# CLI\n\nSee https://dexie.org/cloud/docs/cli\n\n# APIs\n\nSee https://dexie.org/cloud/docs/dexie-cloud-api\n" }, { "path": "addons/dexie-cloud/TODO-SOCIALAUTH.md", "content": "# Social Authentication for Dexie Cloud\n\n## Overview\n\nThis feature adds support for OAuth 2.0 social login providers (Google, GitHub, Microsoft, Apple, and custom OAuth2) as an alternative to the existing OTP (One-Time Password) email authentication in Dexie Cloud.\n\n**Key Design Principle**: The Dexie Cloud server acts as an OAuth broker, handling all provider interactions including the OAuth callback. The client library (dexie-cloud-addon) never receives provider tokens - only Dexie Cloud authorization codes which are exchanged for Dexie Cloud tokens.\n\n### Related Files\n\n- **Detailed flow diagram**: [oauth_flow.md](oauth_flow.md) - Sequence diagrams and detailed protocol description\n- **Server implementation**: See `dexie-cloud-server` repository\n - `src/api/oauth/registerOAuthEndpoints.ts` - OAuth endpoints\n - `src/api/oauth/oauth-helpers.ts` - Provider exchange logic\n - `src/api/registerTokenEndpoint.ts` - Token endpoint (authorization_code grant)\n\n### Flow Summary\n\n1. **Client** fetches available auth providers from `GET /auth-providers`\n2. **Client** redirects to `GET /oauth/login/:provider` (full page redirect)\n3. **Dexie Cloud Server** redirects to OAuth provider and handles callback at `/oauth/callback/:provider`\n4. **Server** exchanges provider code for tokens, verifies email, generates single-use Dexie auth code\n5. **Server** redirects back to client with `dxc-auth` query parameter (base64url-encoded JSON)\n6. **Client** detects `dxc-auth` in `db.cloud.configure()`, exchanges code for tokens via `POST /token`\n\n### Supported Providers\n- **Google** - OpenID Connect with PKCE\n- **GitHub** - OAuth 2.0 (client secret only)\n- **Microsoft** - OpenID Connect with PKCE\n- **Apple** - Sign in with Apple (form_post response mode)\n- **Custom OAuth2** - Configurable endpoints for self-hosted identity providers\n\n### Client Delivery Methods\n\n| Method | Use Case | Delivery Mechanism |\n|--------|----------|-------------------|\n| **Full Page Redirect** | Web SPAs (recommended) | HTTP redirect with `dxc-auth` query param |\n| **Custom URL Scheme** | Capacitor/Native apps | Deep link redirect (e.g., `myapp://`) |\n\n---\n\n## Implementation Status\n\n### ✅ Server-Side (dexie-cloud-server) - COMPLETE\n\n- [x] **OAuth provider configuration type** (`OAuthProviderConfig`)\n- [x] **`GET /auth-providers` endpoint** - Returns enabled providers and OTP status\n- [x] **`GET /oauth/login/:provider` endpoint** - Initiates OAuth flow with PKCE\n- [x] **`GET /oauth/callback/:provider` endpoint** - Handles provider callback, redirects with `dxc-auth`\n- [x] **`POST /token` with `grant_type: \"authorization_code\"`** - Exchanges Dexie auth code for tokens\n- [x] **OAuth helper functions** (`oauth-helpers.ts`)\n- [x] **Configuration GUI in dexie-cloud-manager**\n\n### ✅ Client-Side (dexie-cloud-addon) - COMPLETE\n\n#### Types in dexie-cloud-common\n\n- [x] **`OAuthProviderInfo` type** - Provider metadata\n- [x] **`AuthProvidersResponse` type** - Response from `/auth-providers`\n- [x] **`AuthorizationCodeTokenRequest` type** - Token request for OAuth codes\n\n#### Types and Interfaces in dexie-cloud-addon\n\n- [x] **Extended `LoginHints` interface** - Added `provider`, `oauthCode`\n- [x] **`DXCProviderSelection` interaction type** - For provider selection UI\n- [x] **`DexieCloudOptions` extension** - Added `socialAuth`, `oauthRedirectUri`\n\n#### Core Authentication Flow\n\n- [x] **`fetchAuthProviders()`** - Fetches available providers from server\n- [x] **`startOAuthRedirect()`** - Initiates OAuth via full page redirect\n- [x] **`parseOAuthCallback()`** - Parses `dxc-auth` query parameter\n- [x] **`cleanupOAuthUrl()`** - Removes `dxc-auth` from URL via `history.replaceState()`\n- [x] **`exchangeOAuthCode()`** - Exchanges Dexie auth code for tokens\n- [x] **OAuth detection in `configure()`** - Auto-detects `dxc-auth` on page load\n- [x] **OAuth processing in `onDbReady`** - Completes login when database is ready\n- [x] **Updated `login()` function** - Supports `provider` and `oauthCode` hints\n\n#### Default UI Components\n\n- [x] **`ProviderSelectionDialog`** - Renders provider selection screen\n- [x] **`AuthProviderButton`** - Renders individual provider buttons with icons\n- [x] **`OtpButton`** - \"Continue with email\" option\n- [x] **Updated `LoginDialog.tsx`** - Handles OAuth redirect flow\n- [x] **Updated `Styles.ts`** - Provider button styles\n\n#### Error Handling\n\n- [x] **`OAuthError` class** - Error codes: `access_denied`, `invalid_state`, `email_not_verified`, `expired_code`, `provider_error`, `network_error`\n\n---\n\n## 🔲 Remaining TODO\n\n### Testing\n\n- [ ] **Unit tests for OAuth flow**\n - Test `parseOAuthCallback()` with various `dxc-auth` payloads\n - Test error scenarios\n - Test URL cleanup\n\n- [ ] **Integration tests**\n - Test full redirect flow with mock server\n - Test token exchange\n\n- [ ] **Manual testing**\n - Test with `samples/dexie-cloud-todo-app`\n - Test with Capacitor app (deep links)\n\n### Documentation\n\n- [ ] **Update README.md**\n - Document OAuth login: `db.cloud.login({ provider: 'google' })`\n - Show Capacitor integration pattern\n - Explain redirect flow\n\n- [ ] **Update dexie.org docs**\n - Add OAuth configuration guide\n - Document `socialAuth` and `oauthRedirectUri` options\n\n---\n\n## Client Integration Patterns\n\n### Web SPA (Redirect Flow)\n\n```typescript\n// Configure database\ndb.cloud.configure({\n databaseUrl: 'https://mydb.dexie.cloud'\n});\n\n// OAuth callback is handled automatically!\n// When page loads with ?dxc-auth=..., the addon:\n// 1. Detects the parameter in configure()\n// 2. Cleans up the URL immediately\n// 3. Completes login in db.on('ready')\n\n// To manually initiate OAuth (e.g., from custom UI):\nawait db.cloud.login({ provider: 'google' });\n// Page redirects to OAuth provider, then back with auth code\n```\n\n### Capacitor / Native App\n\n```typescript\n// Configure with custom URL scheme\ndb.cloud.configure({\n databaseUrl: 'https://mydb.dexie.cloud',\n oauthRedirectUri: 'myapp://'\n});\n\n// Handle deep link in app\nApp.addListener('appUrlOpen', async ({ url }) => {\n const callback = handleOAuthCallback(url);\n if (callback) {\n await db.cloud.login({ \n oauthCode: callback.code, \n provider: callback.provider \n });\n }\n});\n\n// Initiate login (opens system browser)\nawait db.cloud.login({ provider: 'google' });\n```\n\n---\n\n## Architecture Diagram\n\n```\n┌──────────────────────────────────────────────────────────────────────────────┐\n│ CLIENT (dexie-cloud-addon) │\n│ │\n│ ┌─────────────────┐ ┌───────────────────┐ │\n│ │ LoginDialog │───▶│ startOAuthRedirect│──▶ window.location.href = │\n│ │ (default UI) │ │ () │ /oauth/login/:provider │\n│ └─────────────────┘ └───────────────────┘ │\n│ │\n│ ... page navigates away, user authenticates ... │\n│ │\n│ ┌─────────────────┐ ┌───────────────────┐ │\n│ │ Page loads with │───▶│ db.cloud. │──▶ Detects dxc-auth param │\n│ │ ?dxc-auth=... │ │ configure() │ Cleans URL immediately │\n│ └─────────────────┘ └───────────────────┘ Stores pending code │\n│ │ │\n│ ▼ │\n│ ┌─────────────────┐ ┌─────────────────────────┐ │\n│ │ db.on('ready') │───▶│ POST /token │ │\n│ │ │ │ grant_type: │ │\n│ │ │◀───│ authorization_code │ │\n│ └─────────────────┘ └─────────────────────────┘ │\n│ │ │\n│ ▼ │\n│ ┌─────────────────┐ │\n│ │ User logged in! │ │\n│ └─────────────────┘ │\n└──────────────────────────────────────────────────────────────────────────────┘\n\n┌──────────────────────────────────────────────────────────────────────────────┐\n│ DEXIE CLOUD SERVER │\n│ │\n│ /oauth/login/:provider │\n│ ├── Generate state, PKCE │\n│ ├── Store in challenges table │\n│ └── Redirect to OAuth provider │\n│ │\n│ /oauth/callback/:provider ◀── OAuth provider redirects here │\n│ ├── Verify state │\n│ ├── Exchange code for provider tokens (server-side!) │\n│ ├── Fetch user info, verify email │\n│ ├── Generate Dexie auth code (single-use, 5 min TTL) │\n│ └── HTTP 302 redirect with ?dxc-auth= │\n│ │\n│ POST /token (grant_type: authorization_code) │\n│ ├── Validate Dexie auth code │\n│ ├── Extract stored user claims │\n│ └── Return Dexie Cloud access + refresh tokens │\n└──────────────────────────────────────────────────────────────────────────────┘\n```\n\n---\n\n## The `dxc-auth` Query Parameter\n\nThe OAuth callback uses a single `dxc-auth` query parameter containing base64url-encoded JSON to avoid collisions with app query parameters:\n\n**Success:**\n```json\n{ \"code\": \"DEXIE_AUTH_CODE\", \"provider\": \"google\", \"state\": \"...\" }\n```\n\n**Error:**\n```json\n{ \"error\": \"Error message\", \"provider\": \"google\", \"state\": \"...\" }\n```\n\nExample URL:\n```\nhttps://myapp.com/?dxc-auth=eyJjb2RlIjoiLi4uIiwicHJvdmlkZXIiOiJnb29nbGUiLCJzdGF0ZSI6Ii4uLiJ9\n```\n\n---\n\n## Security Properties\n\n- 🛡 **No provider tokens reach client** - All provider exchange happens server-side\n- 🛡 **Single-use Dexie auth codes** - 5 minute TTL, deleted after use\n- 🛡 **PKCE protection** - Prevents code interception (where supported)\n- 🛡 **State parameter** - CSRF protection, stored server-side\n- 🛡 **Origin validation** - redirect_uri validated and whitelisted\n- 🛡 **Email verification enforced** - Server rejects unverified emails\n- 🛡 **No tokens in URL fragments** - Auth code in query param, not fragment\n\n---\n\n## Key Files\n\n**dexie-cloud-common:**\n- `src/OAuthProviderInfo.ts`\n- `src/AuthProvidersResponse.ts`\n- `src/AuthorizationCodeTokenRequest.ts`\n\n**dexie-cloud-addon:**\n- `src/authentication/oauthLogin.ts` - `startOAuthRedirect()`, `mapOAuthError()`\n- `src/authentication/handleOAuthCallback.ts` - `parseOAuthCallback()`, `cleanupOAuthUrl()`\n- `src/authentication/exchangeOAuthCode.ts` - Token exchange\n- `src/authentication/fetchAuthProviders.ts` - Fetch available providers\n- `src/errors/OAuthError.ts` - OAuth-specific errors\n- `src/default-ui/ProviderSelectionDialog.tsx` - Provider selection UI\n- `src/default-ui/AuthProviderButton.tsx` - Provider button component\n- `src/dexie-cloud-client.ts` - OAuth detection in `configure()`, processing in `onDbReady`\n- `src/DexieCloudOptions.ts` - `socialAuth`, `oauthRedirectUri` options\n" }, { "path": "addons/dexie-cloud/dexie-cloud-import.json", "content": "{\n \"demoUsers\": {\n \"foo@demo.local\": {},\n \"bar@demo.local\": {},\n \"issue2228@demo.local\": {}\n }\n}" }, { "path": "addons/dexie-cloud/oauth_flow.md", "content": "# OAuth Authorization Code Flow for Dexie Cloud SPA Integration\n\n## Actors\n\n- **SPA** – Customer's frontend application\n- **Dexie Cloud** – Auth broker + database access control\n- **OAuth Provider** – Google, GitHub, Apple, Microsoft, etc.\n\n## Preconditions\n\nThe SPA:\n\n- Generates a persistent public/private keypair\n - Private key stored securely in IndexedDB\n - Public key sent later during token exchange\n- Needs two JWTs after login:\n - Access Token (short-lived)\n - Refresh Token (long-lived)\n\nDexie Cloud acts as OAuth broker and manages tenant + identity linkage.\n\n---\n\n## Flow Overview\n\n### 1. User Initiates Login\n\nUser clicks \"Login\", SPA displays list of providers:\n\n```\nGoogle | GitHub | Apple | Microsoft\n```\n\nNo nonce or PKCE is created yet.\n\n---\n\n### 2. User Selects Provider\n\nExample: User selects **Google**\n\nThe client initiates the OAuth flow. There are two ways to do this:\n\n#### 2a. Full Page Redirect (Recommended for Web SPAs)\n\n```js\nwindow.location.href = `https://.dexie.cloud/oauth/login/google?redirect_uri=${encodeURIComponent(location.href)}`;\n```\n\nThe `redirect_uri` parameter specifies where Dexie Cloud should redirect after authentication.\nThis can be any page in your app - no dedicated callback route is needed.\n\n#### 2b. Custom URL Scheme (Capacitor / Native Apps)\n\n```js\n// Open in system browser or in-app browser\nBrowser.open({\n url: `https://.dexie.cloud/oauth/login/google?redirect_uri=${encodeURIComponent('myapp://')}`\n});\n```\n\nThe custom scheme `myapp://` tells Dexie Cloud to redirect back via deep link.\n\n---\n\n### 3. Dexie Cloud Prepares OAuth\n\nDexie Cloud receives `/oauth/login/google` and generates:\n\n- `state` (anti-CSRF)\n- `code_verifier` (PKCE)\n- `code_challenge` (PKCE)\n\nStores these in the challenges table, then redirects the browser to provider:\n\n```\nhttps://accounts.google.com/o/oauth2/v2/auth?\n client_id=...\n redirect_uri=https://.dexie.cloud/oauth/callback/google\n state=STATE\n code_challenge=CHALLENGE\n code_challenge_method=S256\n response_type=code\n scope=openid email profile\n```\n\nNote: `redirect_uri` points to the **Dexie Cloud server** callback endpoint.\n\n---\n\n### 4. Provider Authenticates User\n\nProvider authenticates the user and requests consent if needed.\n\n---\n\n### 5. Provider Callback to Dexie Cloud\n\nProvider redirects back to Dexie Cloud:\n\n```\nhttps://.dexie.cloud/oauth/callback/google?code=CODE&state=STATE\n```\n\nDexie Cloud:\n\n1. Verifies `state`\n2. Performs token exchange with provider using PKCE\n3. Extracts identity claims (email/id/name/…)\n4. Verifies email is verified\n5. Links identity to tenant/database\n6. Generates a **single-use Dexie Cloud authorization code**\n7. Deletes the OAuth state (one-time use)\n\n---\n\n### 6. Dexie Cloud Delivers Auth Code to Client\n\nDexie Cloud issues an HTTP 302 redirect back to the client with the authorization code.\nThe auth data is encapsulated in a single `dxc-auth` query parameter containing base64url-encoded JSON.\nThis avoids collisions with the app's own query parameters.\n\n#### 6a. Full Page Redirect (Web SPAs)\n\nIf the client passed an http/https `redirect_uri`, Dexie Cloud redirects:\n\n```\nHTTP/1.1 302 Found\nLocation: https://myapp.com/?dxc-auth=eyJjb2RlIjoiLi4uIiwicHJvdmlkZXIiOiJnb29nbGUiLCJzdGF0ZSI6Ii4uLiJ9\n```\n\nThe `dxc-auth` parameter contains base64url-encoded JSON:\n\n```json\n{ \"code\": \"DEXIE_AUTH_CODE\", \"provider\": \"google\", \"state\": \"STATE\" }\n```\n\nOr in case of error:\n\n```json\n{ \"error\": \"Error message\", \"provider\": \"google\", \"state\": \"STATE\" }\n```\n\nThe app doesn't need a dedicated OAuth callback route - the dexie-cloud client library\ndetects and processes the `dxc-auth` parameter on any page load.\n\n#### 6b. Custom URL Scheme (Capacitor / Native Apps)\n\nIf the client passed a `redirect_uri` with a custom scheme (e.g., `myapp://`),\nDexie Cloud redirects to that URL with the same `dxc-auth` parameter:\n\n```\nHTTP/1.1 302 Found\nLocation: myapp://?dxc-auth=eyJjb2RlIjoiLi4uIiwicHJvdmlkZXIiOiJnb29nbGUiLCJzdGF0ZSI6Ii4uLiJ9\n```\n\nThe native app intercepts this deep link and decodes the parameter.\n\n#### 6c. Error Case\n\nIf no valid `redirect_uri` was provided, an error page is displayed\nexplaining that the auth flow cannot complete.\n\n---\n\n### 7. Client Receives Authorization Code\n\n**For Full Page Redirect (6a):**\n\nThe `dexie-cloud-addon` library handles OAuth callback detection automatically:\n\n1. When `db.cloud.configure()` is called, the addon checks for the `dxc-auth` query parameter\n2. This check only runs in DOM environments (not in Web Workers)\n3. If the parameter is present:\n - The URL is immediately cleaned up using `history.replaceState()` to remove `dxc-auth`\n - A `setTimeout(cb, 0)` is scheduled to initiate the token exchange\n - The token exchange fetches from the configured `databaseUrl`\n - The response is processed in the existing `db.on('ready')` callback when Dexie is ready\n\n```js\n// Pseudocode for dexie-cloud-addon implementation\nfunction configure(options) {\n // Only check in DOM environment, not workers\n if (typeof window !== 'undefined' && window.location) {\n const encoded = new URLSearchParams(location.search).get('dxc-auth');\n if (encoded) {\n // Decode base64url (unpadded) to JSON\n const padded = encoded + '='.repeat((4 - (encoded.length % 4)) % 4);\n const base64 = padded.replace(/-/g, '+').replace(/_/g, '/');\n const payload = JSON.parse(atob(base64));\n const { code, provider, state, error } = payload;\n\n // Clean up URL immediately (remove dxc-auth param)\n const url = new URL(location.href);\n url.searchParams.delete('dxc-auth');\n history.replaceState(null, '', url.toString());\n\n if (!error) {\n // Schedule token exchange (processed in db.on('ready'))\n setTimeout(() => {\n // Perform token exchange with options.databaseUrl\n }, 0);\n }\n }\n }\n}\n```\n\n**For Capacitor/Native Apps (6b):**\n\nApp registers a deep link handler and decodes the same parameter:\n\n```js\n// Capacitor example\nApp.addListener('appUrlOpen', ({ url }) => {\n const parsedUrl = new URL(url);\n const encoded = parsedUrl.searchParams.get('dxc-auth');\n if (encoded) {\n const padded = encoded + '='.repeat((4 - (encoded.length % 4)) % 4);\n const base64 = padded.replace(/-/g, '+').replace(/_/g, '/');\n const payload = JSON.parse(atob(base64));\n const { code, provider, state, error } = payload;\n // Proceed to token exchange\n }\n});\n```\n\nUpon success, client proceeds to token exchange.\n\n---\n\n### 8. Client Performs Token Exchange\n\nClient sends:\n\n```http\nPOST /token\nContent-Type: application/json\n```\n\nPayload:\n\n```json\n{\n \"grant_type\": \"authorization_code\",\n \"code\": \"\",\n \"public_key\": \"\",\n \"scopes\": [\"ACCESS_DB\"]\n}\n```\n\nDexie Cloud validates:\n\n- Dexie authorization code integrity\n- TTL (5 minutes)\n- Single-use constraint\n- Database context\n- User identity and claims from stored data\n- Subscription/license status\n\n---\n\n### 9. Dexie Cloud Issues Tokens\n\nDexie Cloud responds with:\n\n```json\n{\n \"access_token\": \"...\",\n \"refresh_token\": \"...\",\n \"expires_in\": 3600,\n \"token_type\": \"Bearer\"\n}\n```\n\nThis completes authentication.\n\n---\n\n## Security Properties Achieved\n\n- 🛑 No JWTs exposed via URL fragments\n- 🛑 Provider tokens never reach SPA (only Dexie tokens)\n- 🛡 Single-use Dexie authorization code (5 min TTL)\n- 🛡 PKCE prevents provider code interception\n- 🛡 State stored server-side with TTL (30 min)\n- 🛡 CSRF protection via `state` parameter\n- 🛡 OAuth state deleted after use\n- 🛡 Dexie auth code deleted after use\n- 🛡 Email verification enforced by server\n- 🛡 All provider exchanges happen server-side\n- 🛡 CORS + origin protections during `/token` exchange\n- 🛡 Future PoP (Proof-of-Possession) enabled via SPA public key\n- 🛡 Works with Apple, Google, Microsoft, GitHub\n\n---\n\n## Resulting Benefits\n\n- Works for SPA / PWA / Capacitor / WebViews\n- Supports multi-tenant architectures\n- Supports native account linking\n- Enables refresh token rotation\n- Supports offline-first/local-first model\n\nThis aligns with modern OIDC/OAuth best practices (2023+) and matches architectures used by:\nAuth0, Firebase, Supabase, Okta, MSAL, Google Identity Services, Clerk, etc.\n" }, { "path": "addons/dexie-cloud/package.json", "content": "{\n \"name\": \"dexie-cloud-addon\",\n \"version\": \"4.4.1\",\n \"description\": \"Dexie addon that syncs with to Dexie Cloud\",\n \"type\": \"module\",\n \"module\": \"dist/modern/dexie-cloud-addon.js\",\n \"homepage\": \"https://dexie.org/cloud/docs/dexie-cloud-addon\",\n \"exports\": {\n \".\": {\n \"development\": {\n \"import\": \"./dist/modern/dexie-cloud-addon.js\",\n \"require\": null,\n \"types\": \"./dist/modern/dexie-cloud-addon.d.ts\"\n },\n \"production\": {\n \"import\": \"./dist/modern/dexie-cloud-addon.min.js\",\n \"require\": null,\n \"types\": \"./dist/modern/dexie-cloud-addon.d.ts\"\n },\n \"default\": {\n \"import\": \"./dist/modern/dexie-cloud-addon.min.js\",\n \"require\": null,\n \"types\": \"./dist/modern/dexie-cloud-addon.d.ts\"\n }\n },\n \"./service-worker\": {\n \"development\": {\n \"import\": \"./dist/modern/service-worker.js\",\n \"require\": \"./dist/umd/service-worker.js\",\n \"default\": \"./dist/umd/service-worker.js\",\n \"types\": \"./dist/modern/service-worker.d.ts\"\n },\n \"production\": {\n \"import\": \"./dist/modern/service-worker.min.js\",\n \"require\": \"./dist/umd/service-worker.min.js\",\n \"default\": \"./dist/umd/service-worker.min.js\",\n \"types\": \"./dist/modern/service-worker.d.ts\"\n },\n \"default\": {\n \"import\": \"./dist/modern/service-worker.min.js\",\n \"require\": \"./dist/umd/service-worker.min.js\",\n \"default\": \"./dist/umd/service-worker.min.js\",\n \"types\": \"./dist/modern/service-worker.d.ts\"\n }\n }\n },\n \"types\": \"dist/modern/dexie-cloud-addon.d.ts\",\n \"engines\": {\n \"node\": \">=14\"\n },\n \"repository\": {\n \"type\": \"git\",\n \"url\": \"https://github.com/dexie/Dexie.js.git\"\n },\n \"scripts\": {\n \"test\": \"just-build test && pnpm run test-unit\",\n \"test-unit\": \"karma start test/unit/karma.conf.cjs --single-run\",\n \"build\": \"rollup -c tools/build-configs/rollup.config.mjs\",\n \"watch\": \"rollup -c tools/build-configs/rollup.config.mjs --watch\",\n \"clean\": \"rm -rf tools/tmp dist test/unit/bundle.*\",\n \"prepack\": \"pnpm run build\"\n },\n \"just-build\": {\n \"default\": [\n \"rollup -c tools/build-configs/rollup.config.mjs\"\n ],\n \"test\": [\n \"just-build test-unit\"\n ],\n \"test-unit\": [\n \"tsc -p test [--watch 'Watching for file changes.']\",\n \"rollup -c tools/build-configs/rollup.test.unit.config.js\"\n ]\n },\n \"author\": \"david.fahlander@gmail.com\",\n \"license\": \"Apache-2.0\",\n \"devDependencies\": {\n \"@rollup/plugin-commonjs\": \"^29.0.0\",\n \"@rollup/plugin-node-resolve\": \"^16.0.3\",\n \"@rollup/plugin-replace\": \"^5.0.4\",\n \"@rollup/plugin-terser\": \"^0.4.4\",\n \"@rollup/plugin-typescript\": \"^12.3.0\",\n \"@types/node\": \"^18.11.18\",\n \"just-build\": \"*\",\n \"karma\": \"*\",\n \"karma-chrome-launcher\": \"*\",\n \"karma-firefox-launcher\": \"*\",\n \"karma-qunit\": \"*\",\n \"karma-webdriver-launcher\": \"*\",\n \"qunit\": \"2.10.0\",\n \"qunitjs\": \"1.23.1\",\n \"lib0\": \"^0.2.97\",\n \"preact\": \"*\",\n \"rollup\": \"^4.53.3\",\n \"terser\": \"^5.20.0\",\n \"tslib\": \"*\",\n \"typescript\": \"^5.6.3\",\n \"y-dexie\": \"workspace:>=4.2.0-alpha.1 <5.0.0\"\n },\n \"dependencies\": {\n \"dexie-cloud-common\": \"workspace:^\",\n \"y-dexie\": \"workspace:^\",\n \"rxjs\": \"^7.x\",\n \"yjs\": \"^13.6.27\",\n \"y-protocols\": \"^1.0.6\"\n },\n \"peerDependencies\": {\n \"dexie\": \"workspace:^\"\n }\n}\n" }, { "path": "addons/dexie-cloud/src/DISABLE_SERVICEWORKER_STRATEGY.ts", "content": "import { isFirefox } from './isFirefox';\nimport { isSafari, safariVersion } from './isSafari';\n\n// What we know: Safari 14.1 (version 605) crashes when using dexie-cloud's service worker.\n// We don't know what exact call is causing this. Have tried safari-14-idb-fix with no luck.\n// Something we do in the service worker is triggering the crash.\n// When next Safari version (606) is out we will start enabling SW again, hoping that the bug is solved.\n// If not, we might increment 605 to 606.\nexport const DISABLE_SERVICEWORKER_STRATEGY =\n (isSafari && safariVersion <= 605) || // Disable for Safari for now.\n isFirefox; // Disable for Firefox for now. Seems to have a bug in reading CryptoKeys from IDB from service workers\n" }, { "path": "addons/dexie-cloud/src/DXCWebSocketStatus.ts", "content": "export type DXCWebSocketStatus = \"not-started\" | \"connecting\" | \"connected\" | \"disconnected\" | \"error\";\n\n" }, { "path": "addons/dexie-cloud/src/DexieCloudAPI.ts", "content": "import { DexieCloudOptions } from './DexieCloudOptions';\nimport { DBRealmRole, DexieCloudSchema, AuthProvidersResponse } from 'dexie-cloud-common';\nimport { UserLogin } from './db/entities/UserLogin';\nimport { PersistedSyncState } from './db/entities/PersistedSyncState';\nimport { SyncState } from './types/SyncState';\nimport { DXCUserInteraction } from './types/DXCUserInteraction';\nimport { DXCWebSocketStatus } from './DXCWebSocketStatus';\nimport { PermissionChecker } from './PermissionChecker';\nimport { DexieCloudSyncOptions } from \"./DexieCloudSyncOptions\";\nimport { Invite } from './Invite';\nimport { BehaviorSubject, Observable } from 'rxjs';\n\n/** Progress state for blob downloads */\nexport interface BlobProgress {\n /** Whether blob downloads are currently in progress */\n isDownloading: boolean;\n \n /** Number of blobs remaining to download */\n blobsRemaining: number;\n \n /** Total bytes remaining to download (estimated from BlobRef.$size) */\n bytesRemaining: number;\n}\n\n/** The API of db.cloud, where `db` is an instance of Dexie with dexie-cloud-addon active.\n */\n\nexport interface LoginHints {\n email?: string;\n userId?: string;\n grant_type?: 'demo' | 'otp';\n otpId?: string;\n otp?: string;\n /** OAuth provider name to initiate OAuth flow (e.g., 'google', 'github') */\n provider?: string;\n /** Dexie Cloud authorization code received from OAuth callback */\n oauthCode?: string;\n /** Optional redirect path (relative or absolute) to use for OAuth redirect URI. */\n redirectPath?: string;\n}\n\nexport interface DexieCloudAPI {\n // Version of dexie-cloud-addon\n version: string;\n\n // Options configured using db.cloud.configure()\n options: DexieCloudOptions | null;\n\n // Dexie-Cloud specific schema (complementary to dexie schema)\n schema: DexieCloudSchema | null;\n\n // UserID of the currently logged in user. If not logged in,\n // this string will be \"unauthorized\"\n currentUserId: string;\n\n // Observable of currently logged in user\n currentUser: BehaviorSubject;\n\n // Observable of current WebSocket status\n webSocketStatus: BehaviorSubject;\n\n // Observable of current Sync State\n syncState: BehaviorSubject;\n\n // Observable of persisted sync state\n persistedSyncState: BehaviorSubject;\n\n /** Observable of blob download progress.\n * \n * Shows the current state of background blob downloads (when blobMode='eager')\n * or provides insight into unresolved blobs (when blobMode='lazy').\n * \n * Use this to show progress indicators or \"downloading for offline\" status.\n */\n blobProgress: Observable;\n\n events: {\n syncComplete: Observable;\n }\n\n // Observable reflecting the GUI data that Dexie Cloud wants you to render if using\n // db.cloud.configure({customLoginGui: true}).\n // The information it wants you to render is login dialogs and error alerts.\n // The information also contains action callbacks to call from Submit / Cancel buttons.\n userInteraction: BehaviorSubject;\n\n // Observable of invites for the user to accept or reject\n invites: Observable;\n\n // Observable of global application roles - a liveQuery() of the 'roles' table\n roles: Observable<{[roleName: string]: DBRealmRole}>;\n\n // Boolean whether service worker is used or not\n usingServiceWorker?: boolean;\n \n // Boolean whether this Dexie instance is a private Dexie instance owned by\n // the built-in Dexie Cloud service worker.\n isServiceWorkerDB?: boolean;\n\n /** Login using Dexie Cloud OTP or Demo user.\n *\n * @param email Email to authenticate\n * @param userId Optional userId to authenticate\n * @param grant_type requested grant type\n */\n login(hint?: LoginHints): Promise;\n\n logout(options?: {force?: boolean}): Promise;\n\n /**\n * Connect to given URL\n */\n configure(options: DexieCloudOptions): void;\n\n /** Trigger a sync\n *\n */\n sync(options?: DexieCloudSyncOptions): Promise;\n\n /** Method that returns an observable of the available permissions of given\n * entity.\n * \n * @param entity Entity to check permission for\n */\n permissions string; }>(entity: T): Observable>;\n\n /** Method that returns an observable of the available permissions of given\n * object and table name.\n * \n * @param obj Object retrieved from a dexie query\n * @param table Table name that the object was retrieved from\n */\n permissions(obj: T, table: string): Observable>;\n\n /** Query available authentication providers from the server.\n * \n * Returns information about which OAuth providers are configured\n * and whether OTP (email) authentication is enabled.\n * \n * Useful for apps that want to build their own login UI and show\n * provider-specific buttons.\n * \n * @returns Promise resolving to available auth providers\n */\n getAuthProviders(): Promise;\n}\n" }, { "path": "addons/dexie-cloud/src/DexieCloudOptions.ts", "content": "import type { TokenFinalResponse } from 'dexie-cloud-common';\nimport type { LoginHints } from './DexieCloudAPI';\n\nexport interface PeriodicSyncOptions {\n // The minimum interval time, in milliseconds, at which the service-worker's\n // periodic sync should occur.\n minInterval?: number;\n}\nexport interface DexieCloudOptions {\n // URL to a database created with `npx dexie-cloud create`\n databaseUrl: string;\n\n // Whether to require authentication or opt-in to it using db.cloud.login()\n requireAuth?: boolean | LoginHints\n\n // Whether to use service worker. Combine with registering your own service\n // worker and import \"dexie-cloud-addon/dist/modern/service-worker.min.js\" from it.\n tryUseServiceWorker?: boolean;\n\n // Optional customization of periodic sync.\n // See https://developer.mozilla.org/en-US/docs/Web/API/PeriodicSyncManager/register\n periodicSync?: PeriodicSyncOptions;\n\n // Disable default login GUI and replace it with your own by\n // subscribing to the `db.cloud.userInteraction` observable and render its emitted data.\n customLoginGui?: boolean;\n\n // Array of table names that should be considered local-only and\n // not be synced with Dexie Cloud\n unsyncedTables?: string[];\n\n unsyncedProperties?: {\n [tableName: string]: string[];\n }\n\n // By default Dexie Cloud will suffix the cloud DB ID to your IndexedDB database name\n // in order to ensure that the local database is uniquely tied to the remote one and\n // will use another local database if databaseURL is changed or if dexieCloud addon\n // is not being used anymore.\n //\n // By setting this value to `false`, no suffix will be added to the database name and\n // instead, it will use the exact name that is specified in the Dexie constructor, \n // without a suffix.\n nameSuffix?: boolean;\n\n // Disable websocket connection\n disableWebSocket?: boolean;\n\n // Disable automatic sync on changes\n disableEagerSync?: boolean;\n\n // Provides a custom way of fetching the JWT tokens. This option\n // can be used when integrating with custom authentication.\n // See https://dexie.org/cloud/docs/db.cloud.configure()#fetchtoken\n fetchTokens?: (tokenParams: {\n public_key: string;\n hints?: { userId?: string; email?: string };\n }) => Promise;\n\n awarenessProtocol?: typeof import('y-protocols/awareness');\n\n /** Enable social/OAuth authentication.\n * - true (default): Fetch providers from server, show if available\n * - false: Disable OAuth, always use OTP flow\n * \n * Use `false` for backward compatibility if your custom login UI\n * doesn't handle the `DXCSelect` interaction type yet.\n */\n socialAuth?: boolean;\n\n /** Redirect URI for OAuth callback.\n * Defaults to window.location.href for web SPAs.\n * \n * For Capacitor/native apps, set this to a custom URL scheme:\n * ```\n * oauthRedirectUri: 'myapp://'\n * ```\n */\n oauthRedirectUri?: string;\n\n /** How to handle blob downloads from cloud storage.\n * \n * - 'eager' (default): Download blobs in background immediately after sync.\n * Best for offline-first apps that need all data available offline ASAP.\n * \n * - 'lazy': Download blobs on-demand when accessed.\n * Best for apps with large media that may not all be needed offline.\n */\n blobMode?: 'eager' | 'lazy';\n\n /** Maximum string length (in characters) before offloading to blob storage during sync.\n * \n * Strings longer than this threshold are uploaded as blobs during sync,\n * reducing sync payload size. The original string is kept intact in IndexedDB.\n * \n * Set to `Infinity` to disable string offloading.\n * Minimum value is 100 to prevent accidental offloading of primary keys.\n * Maximum value is 32768 (server limit).\n * \n * @default 32768\n */\n maxStringLength?: number;\n}\n" }, { "path": "addons/dexie-cloud/src/DexieCloudSyncOptions.ts", "content": "\nexport interface DexieCloudSyncOptions {\n wait: boolean;\n purpose: 'push' | 'pull';\n}\n" }, { "path": "addons/dexie-cloud/src/DexieCloudTable.ts", "content": "import { EntityTable, InsertType } from 'dexie';\n\nexport interface DexieCloudEntity {\n owner: string;\n realmId: string;\n}\n\n/** Don't force the declaration of owner and realmId on every entity (some \n * types may not be interested of these props if they are never going to be shared)\n * Let the type system behave the same as the runtime and merge these props in automatically\n * when declaring the table where the props aren't explicitely declared.\n * User may also explicitely declare these props in order to manually set them when\n * they are interested of taking control over access.\n */\ntype WithDexieCloudProps = T extends DexieCloudEntity ? T : T & DexieCloudEntity;\n\n/** Syntactic sugar for declaring a synced table of arbritary entity.\n * \n */\nexport type DexieCloudTable =\n EntityTable<\n WithDexieCloudProps,\n TKeyPropName,\n InsertType, TKeyPropName | 'owner' | 'realmId'>\n >;\n\n" }, { "path": "addons/dexie-cloud/src/InvalidLicenseError.ts", "content": "export class InvalidLicenseError extends Error {\n name = 'InvalidLicenseError';\n license?: 'expired' | 'deactivated';\n constructor(license?: 'expired' | 'deactivated') {\n super(\n license === 'expired'\n ? `License expired`\n : license === 'deactivated'\n ? `User deactivated`\n : 'Invalid license'\n );\n if (license) {\n this.license = license;\n }\n }\n}\n" }, { "path": "addons/dexie-cloud/src/Invite.ts", "content": "import { DBPermissionSet, DBRealm, DBRealmMember } from 'dexie-cloud-common';\n\nexport interface Invite extends DBRealmMember {\n realm?: DBRealm & { permissions: DBPermissionSet };\n accept(): Promise;\n reject(): Promise;\n}\n" }, { "path": "addons/dexie-cloud/src/PermissionChecker.ts", "content": "import { KeyPaths } from 'dexie';\nimport { DBPermissionSet } from 'dexie-cloud-common';\n\ntype TableName = T extends {table: ()=>infer TABLE} ? TABLE extends string ? TABLE : string : string;\n\nexport class PermissionChecker> {\n private permissions: DBPermissionSet;\n private tableName: TableNames;\n private isOwner: boolean;\n\n constructor(\n permissions: DBPermissionSet,\n tableName: TableNames,\n isOwner: boolean\n ) {\n this.permissions = permissions || {};\n this.tableName = tableName;\n this.isOwner = isOwner;\n }\n\n add(...tableNames: TableNames[]): boolean {\n // If user can manage the whole realm, return true.\n if (this.permissions.manage === '*') return true;\n // If user can manage given table in realm, return true\n if (this.permissions.manage?.includes(this.tableName)) return true;\n // If user can add any type, return true\n if (this.permissions.add === '*') return true;\n // If user can add objects into given table names in the realm, return true\n if (\n tableNames.every((tableName) => this.permissions.add?.includes(tableName))\n ) {\n return true;\n }\n return false;\n }\n\n update(...props: KeyPaths[]): boolean {\n // If user is owner of this object, or if user can manage the whole realm, return true.\n if (this.isOwner || this.permissions.manage === '*') return true;\n // If user can manage given table in realm, return true\n if (this.permissions.manage?.includes(this.tableName)) return true;\n // If user can update any prop in any table in this realm, return true unless\n // it regards to ownership change:\n if (this.permissions.update === '*') {\n // @ts-ignore\n return props.every((prop) => prop !== 'owner');\n }\n const tablePermissions = this.permissions.update?.[this.tableName];\n // If user can update any prop in table and realm, return true unless\n // accessing special props owner or realmId\n if (tablePermissions === '*')\n return props.every((prop) => prop !== 'owner');\n\n // Explicitely listed properties to allow updates on:\n return props.every((prop) =>\n tablePermissions?.some(\n (permittedProp) =>\n permittedProp === prop || (permittedProp === '*' && prop !== 'owner')\n )\n );\n }\n\n delete(): boolean {\n // If user is owner of this object, or if user can manage the whole realm, return true.\n if (this.isOwner || this.permissions.manage === '*') return true;\n // If user can manage given table in realm, return true\n if (this.permissions.manage?.includes(this.tableName)) return true;\n return false;\n }\n}\n" }, { "path": "addons/dexie-cloud/src/TSON.ts", "content": "import { \n TypesonSimplified, \n undefinedTypeDef,\n blobTypeDef,\n typedArrayTypeDefs,\n arrayBufferTypeDef,\n fileTypeDef,\n dateTypeDef,\n setTypeDef,\n mapTypeDef,\n numberTypeDef,\n} from 'dexie-cloud-common';\nimport { TypeDefSet } from 'dexie-cloud-common';\nimport { PropModSpec, PropModification } from 'dexie';\n\n// Since server revisions are stored in bigints, we need to handle clients without\n// bigint support to not fail when serverRevision is passed over to client.\n// We need to not fail when reviving it and we need to somehow store the information.\n// Since the revived version will later on be put into indexedDB we have another\n// issue: When reading it back from indexedDB we will get a poco object that we\n// cannot replace correctly when sending it to server. So we will also need\n// to do an explicit workaround in the protocol where a bigint is supported.\n// The workaround should be there regardless if browser supports BigInt or not, because\n// the serverRev might have been stored in IDB before the browser was upgraded to support bigint.\n//\n// if (typeof serverRev.rev !== \"bigint\")\n// if (hasBigIntSupport)\n// serverRev.rev = bigIntDef.bigint.revive(server.rev)\n// else\n// serverRev.rev = new FakeBigInt(server.rev)\nexport const hasBigIntSupport =\n typeof BigInt === 'function' && typeof BigInt(0) === 'bigint';\n\nfunction getValueOfBigInt(x: bigint | FakeBigInt | string) {\n if (typeof x === 'bigint') {\n return x;\n }\n if (hasBigIntSupport) {\n return typeof x === 'string' ? BigInt(x) : BigInt(x.v);\n } else {\n return typeof x === 'string' ? Number(x) : Number(x.v);\n }\n}\n\nexport function compareBigInts(\n a: bigint | FakeBigInt | string,\n b: bigint | FakeBigInt | string\n) {\n const valA = getValueOfBigInt(a);\n const valB = getValueOfBigInt(b);\n return valA < valB ? -1 : valA > valB ? 1 : 0;\n}\nexport class FakeBigInt {\n v: string;\n toString() {\n return this.v;\n }\n constructor(value: string) {\n this.v = value;\n }\n}\n\nconst bigIntDef = hasBigIntSupport\n ? {}\n : {\n bigint: {\n test: (val: any) => val instanceof FakeBigInt,\n replace: (fakeBigInt: any) => {\n return {\n $t: 'bigint',\n ...fakeBigInt,\n };\n },\n revive: ({ v }: { $t: 'bigint'; v: string }) =>\n new FakeBigInt(v) as any as bigint,\n },\n };\n\nconst defs: TypeDefSet = {\n ...undefinedTypeDef,\n ...bigIntDef,\n ...fileTypeDef,\n PropModification: {\n test: (val: any) => val instanceof PropModification,\n replace: (propModification: any) => {\n return {\n $t: 'PropModification',\n ...propModification['@@propmod'],\n };\n },\n revive: ({\n $t, // strip '$t'\n ...propModSpec // keep the rest\n }: {\n $t: 'PropModification';\n } & PropModSpec) => new PropModification(propModSpec),\n },\n};\n\nexport const TSON = TypesonSimplified(\n // Standard type definitions - TSON is transparent to BlobRefs\n // BlobRefs use _bt convention and are handled by blobResolveMiddleware, not TSON\n typedArrayTypeDefs,\n arrayBufferTypeDef,\n blobTypeDef,\n // Non-binary built-in types\n numberTypeDef,\n dateTypeDef,\n setTypeDef,\n mapTypeDef,\n // Custom type definitions\n defs\n);\n" }, { "path": "addons/dexie-cloud/src/WSObservable.ts", "content": "import { DBOperationsSet } from 'dexie-cloud-common';\nimport { BehaviorSubject, Observable, Subscriber, Subscription, tap } from 'rxjs';\nimport { TokenExpiredError } from './authentication/TokenExpiredError';\nimport { DXCWebSocketStatus } from './DXCWebSocketStatus';\nimport { TSON } from './TSON';\nimport type { YClientMessage, YServerMessage } from 'dexie-cloud-common';\nimport { DexieCloudDB } from './db/DexieCloudDB';\nimport { createYClientUpdateObservable } from './yjs/createYClientUpdateObservable';\nimport { applyYServerMessages } from './yjs/applyYMessages';\nimport { Table } from 'dexie';\nimport { getDocAwareness } from './yjs/awareness';\nimport * as awap from 'y-protocols/awareness';\nimport { encodeYMessage, decodeYMessage } from 'dexie-cloud-common';\nimport { UserLogin } from './dexie-cloud-client';\nimport { isEagerSyncDisabled } from './isEagerSyncDisabled';\nimport { getOpenDocSignal } from './yjs/reopenDocSignal';\nimport { getUpdatesTable } from './yjs/getUpdatesTable';\nimport { DEXIE_CLOUD_SYNCER_ID } from './sync/DEXIE_CLOUD_SYNCER_ID';\nimport { DexieYProvider, YSyncState } from 'y-dexie';\n\nconst SERVER_PING_TIMEOUT = 20000;\nconst CLIENT_PING_INTERVAL = 30000;\nconst FAIL_RETRY_WAIT_TIME = 60000;\n\nexport type WSClientToServerMsg = ReadyForChangesMessage | YClientMessage;\nexport interface ReadyForChangesMessage {\n type: 'ready';\n realmSetHash: string;\n rev: string;\n}\n\nexport type WSConnectionMsg =\n | RevisionChangedMessage\n | RealmAddedMessage\n | RealmAcceptedMessage\n | RealmRemovedMessage\n | RealmsChangedMessage\n | ChangesFromServerMessage\n | TokenExpiredMessage;\ninterface PingMessage {\n type: 'ping';\n}\n\ninterface PongMessage {\n type: 'pong';\n}\n\ninterface ErrorMessage {\n type: 'error';\n error: string;\n}\n\nexport interface ChangesFromServerMessage {\n type: 'changes';\n baseRev: string;\n realmSetHash: string;\n newRev: string;\n changes: DBOperationsSet;\n}\nexport interface RevisionChangedMessage {\n type: 'rev';\n rev: string;\n}\n\nexport interface RealmAddedMessage {\n type: 'realm-added';\n realm: string;\n}\n\nexport interface RealmAcceptedMessage {\n type: 'realm-accepted';\n realm: string;\n}\n\nexport interface RealmRemovedMessage {\n type: 'realm-removed';\n realm: string;\n}\n\nexport interface RealmsChangedMessage {\n type: 'realms-changed';\n realmsHash: string;\n}\nexport interface TokenExpiredMessage {\n type: 'token-expired';\n}\n\nexport class WSObservable extends Observable {\n constructor(\n db: DexieCloudDB,\n rev: string | undefined,\n yrev: string | undefined,\n realmSetHash: string,\n clientIdentity: string,\n messageProducer: Observable,\n webSocketStatus: BehaviorSubject,\n user: UserLogin\n ) {\n super(\n (subscriber) =>\n new WSConnection(\n db,\n rev,\n yrev,\n realmSetHash,\n clientIdentity,\n user,\n subscriber,\n messageProducer,\n webSocketStatus\n )\n );\n }\n}\n\nlet counter = 0;\n\nexport class WSConnection extends Subscription {\n db: DexieCloudDB;\n ws: WebSocket | null;\n lastServerActivity: Date;\n lastUserActivity: Date;\n lastPing: Date;\n databaseUrl: string;\n rev: string | undefined;\n yrev: string | undefined;\n realmSetHash: string;\n clientIdentity: string;\n user: UserLogin;\n subscriber: Subscriber;\n pauseUntil?: Date;\n messageProducer: Observable;\n webSocketStatus: BehaviorSubject;\n id = ++counter;\n\n private pinger: any;\n private subscriptions: Set = new Set();\n\n constructor(\n db: DexieCloudDB,\n rev: string | undefined,\n yrev: string | undefined,\n realmSetHash: string,\n clientIdentity: string,\n user: UserLogin,\n subscriber: Subscriber,\n messageProducer: Observable,\n webSocketStatus: BehaviorSubject\n ) {\n super(() => this.teardown());\n console.debug(\n 'New WebSocket Connection',\n this.id,\n user.accessToken ? 'authorized' : 'unauthorized'\n );\n this.db = db;\n this.databaseUrl = db.cloud.options!.databaseUrl;\n this.rev = rev;\n this.yrev = yrev;\n this.realmSetHash = realmSetHash;\n this.clientIdentity = clientIdentity;\n this.user = user;\n this.subscriber = subscriber;\n this.lastUserActivity = new Date();\n this.messageProducer = messageProducer;\n this.webSocketStatus = webSocketStatus;\n this.connect();\n }\n\n private teardown() {\n console.debug('Teardown WebSocket Connection', this.id);\n this.disconnect();\n }\n\n private disconnect() {\n this.webSocketStatus.next('disconnected');\n if (this.pinger) {\n clearInterval(this.pinger);\n this.pinger = null;\n }\n if (this.ws) {\n try {\n this.ws.close();\n } catch {}\n }\n this.ws = null;\n for (const sub of this.subscriptions) {\n sub.unsubscribe();\n }\n this.subscriptions.clear();\n }\n\n reconnecting = false;\n reconnect() {\n if (this.reconnecting) return;\n this.reconnecting = true;\n try {\n this.disconnect();\n } catch {}\n this.connect()\n .catch(() => {})\n .then(() => (this.reconnecting = false)); // finally()\n }\n\n async connect() {\n this.lastServerActivity = new Date();\n if (this.pauseUntil && this.pauseUntil > new Date()) {\n console.debug('WS not reconnecting just yet', {\n id: this.id,\n pauseUntil: this.pauseUntil,\n });\n return;\n }\n if (this.ws) {\n throw new Error(`Called connect() when a connection is already open`);\n }\n if (!this.databaseUrl)\n throw new Error(`Cannot connect without a database URL`);\n if (this.closed) {\n //console.debug('SyncStatus: DUBB: Ooops it was closed!');\n return;\n }\n const tokenExpiration = this.user.accessTokenExpiration;\n if (tokenExpiration && tokenExpiration < new Date()) {\n this.subscriber.error(new TokenExpiredError()); // Will be handled in connectWebSocket.ts.\n return;\n }\n this.webSocketStatus.next('connecting');\n this.pinger = setInterval(async () => {\n // setInterval here causes unnecessary pings when server is proved active anyway.\n // TODO: Use setTimout() here instead. When triggered, check if we really need to ping.\n // In case we've had server activity, we don't need to ping. Then schedule then next ping\n // to the time when we should ping next time (based on lastServerActivity + CLIENT_PING_INTERVAL).\n // Else, ping now and schedule next ping to CLIENT_PING_INTERVAL from now.\n if (this.closed) {\n console.debug('pinger check', this.id, 'CLOSED.');\n this.teardown();\n return;\n }\n if (this.ws) {\n try {\n this.ws.send(JSON.stringify({ type: 'ping' } as PingMessage));\n setTimeout(() => {\n console.debug(\n 'pinger setTimeout',\n this.id,\n this.pinger ? `alive` : 'dead'\n );\n if (!this.pinger) return;\n if (this.closed) {\n console.debug(\n 'pinger setTimeout',\n this.id,\n 'subscription is closed'\n );\n this.teardown();\n return;\n }\n if (\n this.lastServerActivity <\n new Date(Date.now() - SERVER_PING_TIMEOUT)\n ) {\n // Server inactive. Reconnect if user is active.\n console.debug('pinger: server is inactive');\n console.debug('pinger reconnecting');\n this.reconnect();\n } else {\n console.debug('pinger: server still active');\n }\n }, SERVER_PING_TIMEOUT);\n } catch {\n console.debug('pinger catch error', this.id, 'reconnecting');\n this.reconnect();\n }\n } else {\n console.debug('pinger', this.id, 'reconnecting');\n this.reconnect();\n }\n }, CLIENT_PING_INTERVAL);\n\n // The following vars are needed because we must know which callback to ack when server sends it's ack to us.\n const wsUrl = new URL(this.databaseUrl);\n wsUrl.protocol = wsUrl.protocol === 'http:' ? 'ws' : 'wss';\n const searchParams = new URLSearchParams();\n if (this.subscriber.closed) return;\n searchParams.set('v', '2');\n if (this.rev) searchParams.set('rev', this.rev);\n if (this.yrev) searchParams.set('yrev', this.yrev);\n searchParams.set('realmsHash', this.realmSetHash);\n searchParams.set('clientId', this.clientIdentity);\n searchParams.set('dxcv', this.db.cloud.version);\n if (this.user.accessToken) {\n searchParams.set('token', this.user.accessToken);\n }\n\n // Connect the WebSocket to given url:\n console.debug('dexie-cloud WebSocket create');\n const ws = (this.ws = new WebSocket(`${wsUrl}/changes?${searchParams}`));\n ws.binaryType = \"arraybuffer\";\n\n ws.onclose = (event: Event) => {\n if (!this.pinger) return;\n console.debug('dexie-cloud WebSocket onclosed', this.id);\n this.reconnect();\n };\n\n ws.onmessage = (event: MessageEvent) => {\n if (!this.pinger) return;\n\n this.lastServerActivity = new Date();\n try {\n const msg = typeof event.data === 'string'\n ? TSON.parse(event.data) as\n | WSConnectionMsg\n | PongMessage\n | ErrorMessage\n | YServerMessage \n : decodeYMessage(new Uint8Array(event.data)) as\n | YServerMessage;\n console.debug('dexie-cloud WebSocket onmessage', msg.type, msg);\n if (msg.type === 'error') {\n throw new Error(`Error message from dexie-cloud: ${msg.error}`);\n } else if (msg.type === 'aware') {\n const docCache = DexieYProvider.getDocCache(this.db.dx);\n const doc = docCache.find(msg.table, msg.k, msg.prop);\n if (doc) {\n const awareness = getDocAwareness(doc);\n if (awareness) {\n awap.applyAwarenessUpdate(\n awareness,\n msg.u,\n 'server',\n );\n }\n }\n } else if (msg.type === 'pong') {\n // Do nothing\n } else if (msg.type === 'doc-open') {\n const docCache = DexieYProvider.getDocCache(this.db.dx);\n const doc = docCache.find(msg.table, msg.k, msg.prop);\n if (doc) {\n getOpenDocSignal(doc).next(); // Make yHandler reopen the document on server.\n }\n } else if (msg.type === 'u-ack' || msg.type === 'u-reject' || msg.type === 'u-s' || msg.type === 'in-sync' || msg.type === 'outdated-server-rev' || msg.type === 'y-complete-sync-done') {\n applyYServerMessages([msg], this.db).then(async ({resyncNeeded, yServerRevision, receivedUntils}) => {\n if (yServerRevision) {\n await this.db.$syncState.update('syncState', { yServerRevision: yServerRevision });\n }\n if (msg.type === 'u-s' && receivedUntils) {\n const utbl = getUpdatesTable(this.db, msg.table, msg.prop) as any as Table;\n if (utbl) {\n const receivedUntil = receivedUntils[utbl.name];\n if (receivedUntil) {\n await utbl.update(DEXIE_CLOUD_SYNCER_ID, { receivedUntil });\n }\n }\n }\n if (resyncNeeded) {\n await this.db.cloud.sync({ purpose: 'pull', wait: true });\n }\n })\n } else {\n // Forward the request to our subscriber, wich is in messageFromServerQueue.ts (via connectWebSocket's subscribe() at the end!)\n this.subscriber.next(msg);\n }\n } catch (e) {\n this.subscriber.error(e);\n }\n };\n\n try {\n let everConnected = false;\n await new Promise((resolve, reject) => {\n ws.onopen = (event) => {\n console.debug('dexie-cloud WebSocket onopen');\n everConnected = true;\n resolve(null);\n };\n ws.onerror = (event: ErrorEvent) => {\n if (!everConnected) {\n const error = event.error || new Error('WebSocket Error');\n this.subscriber.error(error);\n this.webSocketStatus.next('error');\n reject(error);\n } else {\n this.reconnect();\n }\n };\n });\n this.subscriptions.add(this.messageProducer.subscribe(\n (msg) => {\n if (!this.closed) {\n if (\n msg.type === 'ready' &&\n this.webSocketStatus.value !== 'connected'\n ) {\n this.webSocketStatus.next('connected');\n }\n console.debug('dexie-cloud WebSocket send', msg.type, msg);\n if (msg.type === 'ready') {\n // Ok, we are certain to have stored everything up until revision msg.rev.\n // Update this.rev in case of reconnect - remember where we were and don't just start over!\n this.rev = msg.rev; \n // ... and then send along the request to the server so it would also be updated!\n this.ws?.send(TSON.stringify(msg));\n } else {\n // If it's not a \"ready\" message, it's an YMessage.\n // YMessages can be sent binary encoded.\n this.ws?.send(encodeYMessage(msg));\n }\n }\n }\n ));\n if (this.user.isLoggedIn && !isEagerSyncDisabled(this.db)) {\n this.subscriptions.add(\n createYClientUpdateObservable(this.db).subscribe(\n this.db.messageProducer\n )\n );\n }\n } catch (error) {\n this.pauseUntil = new Date(Date.now() + FAIL_RETRY_WAIT_TIME);\n }\n }\n}\n" }, { "path": "addons/dexie-cloud/src/associate.ts", "content": "export function associate(factory: (x: T)=>M): (x: T) => M {\n const wm = new WeakMap();\n return (x: T) => {\n let rv = wm.get(x);\n if (!rv) {\n rv = factory(x);\n wm.set(x, rv);\n }\n return rv;\n }\n}\n" }, { "path": "addons/dexie-cloud/src/authentication/AuthPersistedContext.ts", "content": "import { DexieCloudDB } from \"../db/DexieCloudDB\";\nimport { UserLogin } from \"../db/entities/UserLogin\";\n\nexport interface AuthPersistedContext extends UserLogin {\n save(): Promise;\n}\n\n// Emulate true-private property db. Why? So it's not stored in DB.\nconst wm = new WeakMap();\n\nexport class AuthPersistedContext {\n constructor(db: DexieCloudDB, userLogin: UserLogin) {\n wm.set(this, db);\n Object.assign(this, userLogin);\n }\n\n static load(db: DexieCloudDB, userId: string) {\n return db\n .table(\"$logins\")\n .get(userId)\n .then(\n (userLogin) => new AuthPersistedContext(db, userLogin || {\n userId,\n claims: {\n sub: userId\n },\n lastLogin: new Date(0)\n })\n );\n }\n\n async save() {\n const db = wm.get(this)!;\n db.table(\"$logins\").put(this);\n }\n}\n" }, { "path": "addons/dexie-cloud/src/authentication/TokenErrorResponseError.ts", "content": "import { TokenErrorResponse } from 'dexie-cloud-common';\n\nexport class TokenErrorResponseError extends Error {\n title: string;\n messageCode:\n | 'INVALID_OTP'\n | 'INVALID_EMAIL'\n | 'LICENSE_LIMIT_REACHED'\n | 'GENERIC_ERROR';\n message: string;\n messageParams?: { [param: string]: string };\n\n constructor({\n title,\n message,\n messageCode,\n messageParams,\n }: TokenErrorResponse) {\n super(message);\n this.name = 'TokenErrorResponseError';\n this.title = title;\n this.messageCode = messageCode;\n this.messageParams = messageParams;\n }\n}\n" }, { "path": "addons/dexie-cloud/src/authentication/TokenExpiredError.ts", "content": "export class TokenExpiredError extends Error {\n name = \"TokenExpiredError\";\n}\n" }, { "path": "addons/dexie-cloud/src/authentication/UNAUTHORIZED_USER.ts", "content": "import { UserLogin } from '../db/entities/UserLogin';\n\nexport const UNAUTHORIZED_USER: UserLogin = {\n userId: \"unauthorized\",\n name: \"Unauthorized\",\n claims: {\n sub: \"unauthorized\",\n },\n lastLogin: new Date(0)\n}\n\ntry {\n Object.freeze(UNAUTHORIZED_USER);\n Object.freeze(UNAUTHORIZED_USER.claims);\n} catch {}\n" }, { "path": "addons/dexie-cloud/src/authentication/authenticate.ts", "content": "import Dexie from 'dexie';\nimport type {\n RefreshTokenRequest,\n TokenErrorResponse,\n TokenFinalResponse,\n} from 'dexie-cloud-common';\nimport { b64encode } from 'dexie-cloud-common';\nimport { BehaviorSubject } from 'rxjs';\nimport { DexieCloudDB } from '../db/DexieCloudDB';\nimport { UserLogin } from '../db/entities/UserLogin';\nimport { DXCAlert } from '../types/DXCAlert';\nimport {\n DXCMessageAlert,\n DXCUserInteraction,\n} from '../types/DXCUserInteraction';\nimport { TokenErrorResponseError } from './TokenErrorResponseError';\nimport { alertUser, interactWithUser } from './interactWithUser';\nimport { InvalidLicenseError } from '../InvalidLicenseError';\nimport { LoginHints } from '../DexieCloudAPI';\nimport { OAuthRedirectError } from '../errors/OAuthRedirectError';\nimport { MINUTES } from '../helpers/date-constants';\n\nexport type FetchTokenCallback = (tokenParams: {\n public_key: string;\n hints?: LoginHints;\n}) => Promise;\n\nexport async function loadAccessToken(\n db: DexieCloudDB\n): Promise {\n const currentUser = await db.getCurrentUser();\n const {\n accessToken,\n accessTokenExpiration,\n refreshToken,\n refreshTokenExpiration,\n claims,\n } = currentUser;\n if (!accessToken) return null;\n const expTime = accessTokenExpiration?.getTime() ?? Infinity;\n if (expTime > (Date.now() + 5 * MINUTES) && (currentUser.license?.status || 'ok') === 'ok') {\n return currentUser;\n }\n if (!refreshToken) {\n throw new Error(`Refresh token missing`);\n }\n const refreshExpTime = refreshTokenExpiration?.getTime() ?? Infinity;\n if (refreshExpTime <= Date.now()) {\n throw new Error(`Refresh token has expired`);\n }\n const refreshedLogin = await refreshAccessToken(\n db.cloud.options!.databaseUrl,\n currentUser\n );\n await db.table('$logins').update(claims.sub, {\n accessToken: refreshedLogin.accessToken,\n accessTokenExpiration: refreshedLogin.accessTokenExpiration,\n claims: refreshedLogin.claims,\n license: refreshedLogin.license,\n data: refreshedLogin.data,\n });\n return refreshedLogin;\n}\n\nexport async function authenticate(\n url: string,\n context: UserLogin,\n fetchToken: FetchTokenCallback,\n userInteraction: BehaviorSubject,\n hints?: LoginHints\n): Promise {\n if (\n context.accessToken &&\n context.accessTokenExpiration!.getTime() > Date.now()\n ) {\n return context;\n } else if (\n context.refreshToken &&\n (!context.refreshTokenExpiration ||\n context.refreshTokenExpiration.getTime() > Date.now())\n ) {\n return await refreshAccessToken(url, context);\n } else {\n return await userAuthenticate(context, fetchToken, userInteraction, hints);\n }\n}\n\nexport async function refreshAccessToken(\n url: string,\n login: UserLogin\n): Promise {\n if (!login.refreshToken)\n throw new Error(`Cannot refresh token - refresh token is missing.`);\n if (!login.nonExportablePrivateKey)\n throw new Error(\n `login.nonExportablePrivateKey is missing - cannot sign refresh token without a private key.`\n );\n\n const time_stamp = Date.now();\n const signing_algorithm = 'RSASSA-PKCS1-v1_5';\n const textEncoder = new TextEncoder();\n const data = textEncoder.encode(login.refreshToken + time_stamp);\n const binarySignature = await crypto.subtle.sign(\n signing_algorithm,\n login.nonExportablePrivateKey,\n data\n );\n const signature = b64encode(binarySignature);\n\n const tokenRequest: RefreshTokenRequest = {\n grant_type: 'refresh_token',\n refresh_token: login.refreshToken,\n scopes: ['ACCESS_DB'],\n signature,\n signing_algorithm,\n time_stamp,\n };\n const res = await fetch(`${url}/token`, {\n body: JSON.stringify(tokenRequest),\n method: 'post',\n headers: { 'Content-Type': 'application/json' },\n mode: 'cors',\n });\n if (res.status !== 200)\n throw new Error(`RefreshToken: Status ${res.status} from ${url}/token`);\n const response: TokenFinalResponse | TokenErrorResponse = await res.json();\n if (response.type === 'error') {\n throw new TokenErrorResponseError(response);\n }\n login.accessToken = response.accessToken;\n login.accessTokenExpiration = response.accessTokenExpiration\n ? new Date(response.accessTokenExpiration)\n : undefined;\n login.claims = response.claims;\n login.license = {\n type: response.userType,\n status: response.claims.license || 'ok',\n }\n if (response.evalDaysLeft != null) {\n login.license.evalDaysLeft = response.evalDaysLeft;\n }\n if (response.userValidUntil != null) {\n login.license.validUntil = new Date(response.userValidUntil);\n }\n if (response.data) {\n login.data = response.data;\n }\n return login;\n}\n\nasync function userAuthenticate(\n context: UserLogin,\n fetchToken: FetchTokenCallback,\n userInteraction: BehaviorSubject,\n hints?: LoginHints\n) {\n if (!crypto.subtle) {\n if (typeof location !== 'undefined' && location.protocol === 'http:') {\n throw new Error(`Dexie Cloud Addon needs to use WebCrypto, but your browser has disabled it due to being served from an insecure location. Please serve it from https or http://localhost: (See https://stackoverflow.com/questions/46670556/how-to-enable-crypto-subtle-for-unsecure-origins-in-chrome/46671627#46671627)`);\n } else {\n throw new Error(`This browser does not support WebCrypto.`);\n }\n }\n const { privateKey, publicKey } = await crypto.subtle.generateKey(\n {\n name: 'RSASSA-PKCS1-v1_5',\n modulusLength: 2048,\n publicExponent: new Uint8Array([0x01, 0x00, 0x01]),\n hash: { name: 'SHA-256' },\n },\n false, // Non-exportable...\n ['sign', 'verify']\n );\n if (!privateKey || !publicKey)\n throw new Error(`Could not generate RSA keypair`); // Typings suggest these can be undefined...\n context.nonExportablePrivateKey = privateKey; //...but storable!\n const publicKeySPKI = await crypto.subtle.exportKey('spki', publicKey);\n const publicKeyPEM = spkiToPEM(publicKeySPKI);\n context.publicKey = publicKey;\n\n try {\n const response2 = await fetchToken({\n public_key: publicKeyPEM,\n hints,\n });\n\n if (response2.type === 'error') {\n throw new TokenErrorResponseError(response2);\n }\n\n if (response2.type !== 'tokens')\n throw new Error(\n `Unexpected response type from token endpoint: ${(response2 as any).type}`\n );\n\n /*const licenseStatus = response2.claims.license || 'ok';\n if (licenseStatus !== 'ok') {\n throw new InvalidLicenseError(licenseStatus);\n }*/\n\n context.accessToken = response2.accessToken;\n context.accessTokenExpiration = new Date(response2.accessTokenExpiration);\n context.refreshToken = response2.refreshToken;\n if (response2.refreshTokenExpiration) {\n context.refreshTokenExpiration = new Date(\n response2.refreshTokenExpiration\n );\n }\n context.userId = response2.claims.sub;\n context.email = response2.claims.email;\n context.name = response2.claims.name;\n context.claims = response2.claims;\n context.license = {\n type: response2.userType,\n status: response2.claims.license || 'ok',\n }\n context.data = response2.data;\n if (response2.evalDaysLeft != null) {\n context.license.evalDaysLeft = response2.evalDaysLeft;\n }\n if (response2.userValidUntil != null) {\n context.license.validUntil = new Date(response2.userValidUntil);\n }\n\n if (response2.alerts && response2.alerts.length > 0) {\n await interactWithUser(userInteraction, {\n type: 'message-alert',\n title: 'Authentication Alert',\n fields: {},\n alerts: response2.alerts as DXCAlert[],\n });\n }\n return context;\n } catch (error: any) {\n // OAuth redirect is not an error - page is navigating away\n if (error instanceof OAuthRedirectError || error?.name === 'OAuthRedirectError') {\n throw error; // Re-throw without logging\n }\n if (error instanceof TokenErrorResponseError) {\n await alertUser(userInteraction, error.title, {\n type: 'error',\n messageCode: error.messageCode,\n message: error.message,\n messageParams: {},\n });\n throw error;\n }\n let message = `We're having a problem authenticating right now.`;\n console.error (`Error authenticating`, error);\n if (error instanceof TypeError) {\n const isOffline = typeof navigator !== 'undefined' && !navigator.onLine;\n if (isOffline) {\n message = `You seem to be offline. Please connect to the internet and try again.`;\n } else if (typeof location !== 'undefined' && (Dexie.debug || location.hostname === 'localhost' || location.hostname === '127.0.0.1')) {\n // The audience is most likely the developer. Suggest to whitelist the localhost origin:\n const whitelistCommand = `npx dexie-cloud whitelist ${location.origin}`;\n message = `Could not connect to server. Please verify that your origin '${location.origin}' is whitelisted using \\`npx dexie-cloud whitelist\\``;\n await alertUser(userInteraction, 'Authentication Failed', {\n type: 'error',\n messageCode: 'GENERIC_ERROR',\n message,\n messageParams: {},\n copyText: whitelistCommand,\n }).catch(() => {});\n } else {\n message = `Could not connect to server. Please verify the connection.`;\n await alertUser(userInteraction, 'Authentication Failed', {\n type: 'error',\n messageCode: 'GENERIC_ERROR',\n message,\n messageParams: {},\n }).catch(() => {});\n } \n }\n\n throw error;\n }\n}\n\nfunction spkiToPEM(keydata: ArrayBuffer) {\n const keydataB64 = b64encode(keydata);\n const keydataB64Pem = formatAsPem(keydataB64);\n return keydataB64Pem;\n}\n\nfunction formatAsPem(str: string) {\n let finalString = '-----BEGIN PUBLIC KEY-----\\n';\n\n while (str.length > 0) {\n finalString += str.substring(0, 64) + '\\n';\n str = str.substring(64);\n }\n\n finalString = finalString + '-----END PUBLIC KEY-----';\n\n return finalString;\n}\n" }, { "path": "addons/dexie-cloud/src/authentication/currentUserObservable.ts", "content": "import { Dexie } from \"dexie\";\nimport { BehaviorSubject } from 'rxjs';\nimport { UserLogin } from '../db/entities/UserLogin';\n\n//export const currentUserWeakMap = new WeakMap>();\n\n" }, { "path": "addons/dexie-cloud/src/authentication/exchangeOAuthCode.ts", "content": "import type {\n AuthorizationCodeTokenRequest,\n TokenFinalResponse,\n TokenErrorResponse,\n} from 'dexie-cloud-common';\nimport { OAuthError } from '../errors/OAuthError';\nimport { TokenErrorResponseError } from './TokenErrorResponseError';\n\n/** Options for exchanging an OAuth code */\nexport interface ExchangeOAuthCodeOptions {\n /** The Dexie Cloud database URL */\n databaseUrl: string;\n /** The Dexie Cloud authorization code from OAuth callback */\n code: string;\n /** The client's public key in PEM format */\n publicKey: string;\n /** Requested scopes (defaults to ['ACCESS_DB']) */\n scopes?: string[];\n}\n\n/**\n * Exchanges a Dexie Cloud authorization code for access and refresh tokens.\n * \n * This is called after the OAuth callback delivers the authorization code\n * via postMessage (popup flow) or redirect.\n * \n * @param options - Exchange options\n * @returns Promise resolving to TokenFinalResponse\n * @throws OAuthError or TokenErrorResponseError on failure\n */\nexport async function exchangeOAuthCode(\n options: ExchangeOAuthCodeOptions\n): Promise {\n const { databaseUrl, code, publicKey, scopes = ['ACCESS_DB'] } = options;\n\n const tokenRequest: AuthorizationCodeTokenRequest = {\n grant_type: 'authorization_code',\n code,\n public_key: publicKey,\n scopes,\n };\n\n try {\n const res = await fetch(`${databaseUrl}/token`, {\n method: 'POST',\n headers: { 'Content-Type': 'application/json' },\n body: JSON.stringify(tokenRequest),\n mode: 'cors',\n });\n\n if (!res.ok) {\n // Read body once as text to avoid stream consumption issues\n const bodyText = await res.text().catch(() => res.statusText);\n \n if (res.status === 400 || res.status === 401) {\n // Try to parse error response as JSON\n try {\n const errorResponse: TokenErrorResponse = JSON.parse(bodyText);\n if (errorResponse.type === 'error') {\n // Check for specific error codes\n if (errorResponse.messageCode === 'INVALID_OTP') {\n // In the context of OAuth, this likely means expired code\n throw new OAuthError('expired_code', undefined, errorResponse.message);\n }\n throw new TokenErrorResponseError(errorResponse);\n }\n } catch (e) {\n if (e instanceof OAuthError || e instanceof TokenErrorResponseError) {\n throw e;\n }\n // Fall through to generic error\n }\n }\n \n throw new OAuthError('provider_error', undefined, `Token exchange failed: ${res.status} ${bodyText}`);\n }\n\n const response: TokenFinalResponse | TokenErrorResponse = await res.json();\n\n if (response.type === 'error') {\n throw new TokenErrorResponseError(response);\n }\n\n if (response.type !== 'tokens') {\n throw new OAuthError('provider_error', undefined, `Unexpected response type: ${(response as any).type}`);\n }\n\n return response;\n } catch (error) {\n if (error instanceof OAuthError || error instanceof TokenErrorResponseError) {\n throw error;\n }\n \n if (error instanceof TypeError) {\n // Network error\n throw new OAuthError('network_error');\n }\n \n throw error;\n }\n}\n" }, { "path": "addons/dexie-cloud/src/authentication/fetchAuthProviders.ts", "content": "import type { AuthProvidersResponse } from 'dexie-cloud-common';\n\n/** Default response when OAuth is disabled or unavailable */\nconst OTP_ONLY_RESPONSE: AuthProvidersResponse = {\n providers: [],\n otpEnabled: true,\n};\n\n/**\n * Fetches available authentication providers from the Dexie Cloud server.\n * \n * @param databaseUrl - The Dexie Cloud database URL\n * @param socialAuthEnabled - Whether social auth is enabled in client config (default: true)\n * @returns Promise resolving to AuthProvidersResponse\n * \n * Handles failures gracefully:\n * - 404 → Returns OTP-only (old server version)\n * - Network error → Returns OTP-only\n * - socialAuthEnabled: false → Returns OTP-only without fetching\n */\nexport async function fetchAuthProviders(\n databaseUrl: string,\n socialAuthEnabled: boolean = true\n): Promise {\n // If social auth is disabled, return OTP-only without fetching\n if (!socialAuthEnabled) {\n return OTP_ONLY_RESPONSE;\n }\n\n try {\n const res = await fetch(`${databaseUrl}/auth-providers`, {\n method: 'GET',\n headers: { 'Accept': 'application/json' },\n mode: 'cors',\n });\n\n if (res.status === 404) {\n // Old server version without OAuth support\n console.debug('[dexie-cloud] Server does not support /auth-providers endpoint. Using OTP-only authentication.');\n return OTP_ONLY_RESPONSE;\n }\n\n if (!res.ok) {\n console.warn(`[dexie-cloud] Failed to fetch auth providers: ${res.status} ${res.statusText}`);\n return OTP_ONLY_RESPONSE;\n }\n\n return await res.json();\n } catch (error) {\n // Network error or other failure - fall back to OTP\n console.debug('[dexie-cloud] Could not fetch auth providers, falling back to OTP:', error);\n return OTP_ONLY_RESPONSE;\n }\n}\n" }, { "path": "addons/dexie-cloud/src/authentication/handleOAuthCallback.ts", "content": "import { OAuthError } from '../errors/OAuthError';\n\n/** Parsed OAuth callback parameters from dxc-auth query parameter */\nexport interface OAuthCallbackParams {\n /** The Dexie Cloud authorization code */\n code: string;\n /** The OAuth provider that was used */\n provider: string;\n /** The state parameter */\n state: string;\n}\n\n/** Decoded dxc-auth payload structure */\ninterface DxcAuthPayload {\n code?: string;\n provider: string;\n state: string;\n error?: string;\n}\n\n/**\n * Decodes a base64url-encoded string to a regular string.\n * Base64url uses - instead of + and _ instead of /, and may omit padding.\n */\nfunction decodeBase64Url(encoded: string): string {\n // Add padding if needed\n const padded = encoded + '='.repeat((4 - (encoded.length % 4)) % 4);\n // Convert base64url to base64\n const base64 = padded.replace(/-/g, '+').replace(/_/g, '/');\n return atob(base64);\n}\n\n/**\n * Parses OAuth callback parameters from the dxc-auth query parameter.\n * \n * The dxc-auth parameter contains base64url-encoded JSON with the following structure:\n * - On success: { \"code\": \"...\", \"provider\": \"...\", \"state\": \"...\" }\n * - On error: { \"error\": \"...\", \"provider\": \"...\", \"state\": \"...\" }\n * \n * @param url - The URL to parse (defaults to window.location.href)\n * @returns OAuthCallbackParams if valid callback, null otherwise\n * @throws OAuthError if there's an error in the callback\n */\nexport function parseOAuthCallback(url?: string): OAuthCallbackParams | null {\n const targetUrl = url || (typeof window !== 'undefined' ? window.location.href : '');\n \n if (!targetUrl) {\n return null;\n }\n\n const parsed = new URL(targetUrl);\n const encoded = parsed.searchParams.get('dxc-auth');\n\n if (!encoded) {\n return null; // Not an OAuth callback URL\n }\n\n let payload: DxcAuthPayload;\n try {\n const json = decodeBase64Url(encoded);\n payload = JSON.parse(json);\n } catch (e) {\n console.warn('[dexie-cloud] Failed to parse dxc-auth parameter:', e);\n return null;\n }\n\n const { code, provider, state, error } = payload;\n\n // Check for error first\n if (error) {\n if (error.toLowerCase().includes('access_denied') || error.toLowerCase().includes('access denied')) {\n throw new OAuthError('access_denied', provider, error);\n }\n if (error.toLowerCase().includes('email') && error.toLowerCase().includes('verif')) {\n throw new OAuthError('email_not_verified', provider, error);\n }\n \n throw new OAuthError('provider_error', provider, error);\n }\n\n // Validate required fields for success case\n if (!code || !provider || !state) {\n console.warn('[dexie-cloud] Invalid dxc-auth payload: missing required fields');\n return null;\n }\n\n return { code, provider, state };\n}\n\n/**\n * Validates the OAuth state parameter against the stored state.\n * \n * @param receivedState - The state from the callback URL\n * @returns true if valid, false otherwise\n */\nexport function validateOAuthState(receivedState: string): boolean {\n if (typeof sessionStorage === 'undefined') {\n console.warn('[dexie-cloud] sessionStorage not available, cannot validate OAuth state');\n return false; // Fail closed - reject if we cannot validate CSRF protection\n }\n\n const storedState = sessionStorage.getItem('dexie-cloud-oauth-state');\n \n if (!storedState) {\n console.warn('[dexie-cloud] No stored OAuth state found');\n return false;\n }\n\n // Clear the stored state after validation attempt\n sessionStorage.removeItem('dexie-cloud-oauth-state');\n \n return storedState === receivedState;\n}\n\n/**\n * Cleans up the dxc-auth query parameter from the URL.\n * Call this after successfully handling the callback to clean up the browser URL.\n */\nexport function cleanupOAuthUrl(): void {\n if (typeof window === 'undefined' || !window.history?.replaceState) {\n return;\n }\n\n const url = new URL(window.location.href);\n \n if (!url.searchParams.has('dxc-auth')) {\n return;\n }\n\n url.searchParams.delete('dxc-auth');\n const cleanUrl = url.pathname + (url.searchParams.toString() ? `?${url.searchParams.toString()}` : '') + url.hash;\n window.history.replaceState(null, '', cleanUrl);\n}\n\n/**\n * Complete handler for OAuth callback.\n * \n * Parses the dxc-auth query parameter, validates state, and returns the parameters\n * needed to complete the login flow.\n * \n * Note: For web SPAs using full page redirect, the dexie-cloud-addon automatically\n * detects and processes the dxc-auth parameter when db.cloud.configure() is called.\n * This function is primarily useful for Capacitor/native apps handling deep links.\n * \n * @param url - The callback URL (defaults to window.location.href)\n * @returns OAuthCallbackParams if valid callback, null otherwise\n * @throws OAuthError on validation failure or if callback contains an error\n * \n * @example\n * ```typescript\n * // Capacitor deep link handler:\n * App.addListener('appUrlOpen', async ({ url }) => {\n * const callback = handleOAuthCallback(url);\n * if (callback) {\n * await db.cloud.login({ oauthCode: callback.code, provider: callback.provider });\n * }\n * });\n * ```\n */\nexport function handleOAuthCallback(url?: string): OAuthCallbackParams | null {\n const params = parseOAuthCallback(url);\n \n if (!params) {\n return null;\n }\n\n // Validate state for CSRF protection\n if (!validateOAuthState(params.state)) {\n throw new OAuthError('invalid_state', params.provider);\n }\n\n return params;\n}\n" }, { "path": "addons/dexie-cloud/src/authentication/interactWithUser.ts", "content": "import Dexie from 'dexie';\nimport type { OAuthProviderInfo } from 'dexie-cloud-common';\nimport { BehaviorSubject } from 'rxjs';\nimport { take } from 'rxjs/operators';\nimport { DexieCloudDB } from '../db/DexieCloudDB';\nimport { DXCAlert } from '../types/DXCAlert';\nimport { DXCInputField } from '../types/DXCInputField';\nimport { DXCUserInteraction, DXCGenericUserInteraction, DXCOption } from '../types/DXCUserInteraction';\n\n/** Email/envelope icon data URL for OTP option */\nconst EmailIcon = `data:image/svg+xml;base64,${btoa('')}`;\n\n/**\n * Converts an OAuthProviderInfo to a generic DXCOption.\n */\nfunction providerToOption(provider: OAuthProviderInfo): DXCOption {\n return {\n name: 'provider',\n value: provider.name,\n displayName: `Continue with ${provider.displayName}`,\n iconUrl: provider.iconUrl,\n styleHint: provider.type,\n };\n}\n\nexport interface DXCUserInteractionRequest {\n type: DXCUserInteraction['type'];\n title: string;\n alerts: DXCAlert[];\n submitLabel?: string;\n cancelLabel?: string | null;\n fields: { [name: string]: DXCInputField };\n}\n\nexport function interactWithUser(\n userInteraction: BehaviorSubject,\n req: T\n): Promise<{\n [P in keyof T['fields']]: string;\n}> {\n let done = false;\n return new Promise<{\n [P in keyof T['fields']]: string;\n }>((resolve, reject) => {\n const interactionProps = {\n submitLabel: 'Submit',\n cancelLabel: 'Cancel',\n ...req,\n onSubmit: (res: {\n [P in keyof T['fields']]: string;\n }) => {\n userInteraction.next(undefined);\n done = true;\n resolve(res);\n },\n onCancel: () => {\n userInteraction.next(undefined);\n done = true;\n reject(new Dexie.AbortError('User cancelled'));\n },\n } as DXCUserInteraction;\n userInteraction.next(interactionProps);\n // Start subscribing for external updates to db.cloud.userInteraction, and if so, cancel this request.\n /*const subscription = userInteraction.subscribe((currentInteractionProps) => {\n if (currentInteractionProps !== interactionProps) {\n if (subscription) subscription.unsubscribe();\n if (!done) {\n reject(new Dexie.AbortError(\"User cancelled\"));\n }\n }\n });*/\n });\n}\n\nexport function alertUser(\n userInteraction: BehaviorSubject,\n title: string,\n ...alerts: DXCAlert[]\n) {\n return interactWithUser(userInteraction, {\n type: 'message-alert',\n title,\n alerts,\n fields: {},\n submitLabel: 'OK',\n cancelLabel: null,\n });\n}\n\nexport async function promptForEmail(\n userInteraction: BehaviorSubject,\n title: string,\n emailHint?: string\n) {\n let email = emailHint || '';\n // Regular expression for email validation\n // ^[\\w-+.]+@([\\w-]+\\.)+[\\w-]{2,10}(\\sas\\s[\\w-+.]+@([\\w-]+\\.)+[\\w-]{2,10})?$\n //\n // ^[\\w-+.]+ : Matches the start of the string. Allows one or more word characters\n // (a-z, A-Z, 0-9, and underscore), hyphen, plus, or dot.\n //\n // @ : Matches the @ symbol.\n // ([\\w-]+\\.)+ : Matches one or more word characters or hyphens followed by a dot.\n // The plus sign outside the parentheses means this pattern can repeat one or more times,\n // allowing for subdomains.\n // [\\w-]{2,10} : Matches between 2 and 10 word characters or hyphens. This is typically for\n // the domain extension like .com, .net, etc.\n // (\\sas\\s[\\w-+.]+@([\\w-]+\\.)+[\\w-]{2,10})?$ : This part is optional (due to the ? at the end).\n // If present, it matches \" as \" followed by another valid email address. This allows for the\n // input to be either a single email address or two email addresses separated by \" as \". \n //\n // The use case for \" as \"\" is for when a database owner with full access to the\n // database needs to impersonate another user in the database in order to troubleshoot. This\n // format will only be possible to use when email1 is the owner of an API client with GLOBAL_READ\n // and GLOBAL_WRITE permissions on the database. The email will be checked on the server before\n // allowing it and giving out a token for email2, using the OTP sent to email1.\n while (!email || !/^[\\w-+.]+@([\\w-]+\\.)+[\\w-]{2,10}(\\sas\\s[\\w-+.]+@([\\w-]+\\.)+[\\w-]{2,10})?$/.test(email)) {\n email = (\n await interactWithUser(userInteraction, {\n type: 'email',\n title,\n alerts: email\n ? [\n {\n type: 'error',\n messageCode: 'INVALID_EMAIL',\n message: 'Please enter a valid email address',\n messageParams: {},\n },\n ]\n : [],\n fields: {\n email: {\n type: 'email',\n placeholder: 'you@somedomain.com',\n },\n },\n })\n ).email;\n }\n return email;\n}\n\nexport async function promptForOTP(\n userInteraction: BehaviorSubject,\n email: string,\n alert?: DXCAlert\n) {\n const alerts: DXCAlert[] = [\n {\n type: 'info',\n messageCode: 'OTP_SENT',\n message: `A One-Time password has been sent to {email}`,\n messageParams: { email },\n },\n ];\n if (alert) {\n alerts.push(alert);\n }\n const { otp } = await interactWithUser(userInteraction, {\n type: 'otp',\n title: 'Enter OTP',\n alerts,\n fields: {\n otp: {\n type: 'otp',\n label: 'OTP',\n placeholder: 'Paste OTP here',\n },\n },\n });\n return otp;\n}\n\nexport async function confirmLogout(\n userInteraction: BehaviorSubject,\n currentUserId: string,\n numUnsyncedChanges: number\n) {\n const alerts: DXCAlert[] = [\n {\n type: 'warning',\n messageCode: 'LOGOUT_CONFIRMATION',\n message: `{numUnsyncedChanges} unsynced changes will get lost!\n Logout anyway?`,\n messageParams: {\n currentUserId,\n numUnsyncedChanges: numUnsyncedChanges.toString(),\n }\n },\n ];\n return await interactWithUser(userInteraction, {\n type: 'logout-confirmation',\n title: 'Confirm Logout',\n alerts,\n fields: {},\n submitLabel: 'Confirm logout',\n cancelLabel: 'Cancel'\n })\n .then(() => true)\n .catch(() => false);\n}\n\n/** Result from provider selection prompt */\nexport type ProviderSelectionResult =\n | { type: 'provider'; provider: string }\n | { type: 'otp' };\n\n/**\n * Prompts the user to select an authentication method (OAuth provider or OTP).\n * \n * This function converts OAuth providers and OTP option into generic DXCOption[]\n * for the DXCSelect interaction, handling icon fetching and style hints.\n * \n * @param userInteraction - The user interaction BehaviorSubject\n * @param providers - Available OAuth providers\n * @param otpEnabled - Whether OTP is available\n * @param title - Dialog title\n * @param alerts - Optional alerts to display\n * @returns Promise resolving to the user's selection\n */\nexport async function promptForProvider(\n userInteraction: BehaviorSubject,\n providers: OAuthProviderInfo[],\n otpEnabled: boolean,\n title: string = 'Choose login method',\n alerts: DXCAlert[] = []\n): Promise {\n // Convert providers to generic options\n const providerOptions = providers.map(providerToOption);\n \n // Build the options array\n const options: DXCOption[] = [...providerOptions];\n \n // Add OTP option if enabled\n if (otpEnabled) {\n options.push({\n name: 'otp',\n value: 'email',\n displayName: 'Continue with email',\n iconUrl: EmailIcon,\n styleHint: 'otp',\n });\n }\n \n return new Promise((resolve, reject) => {\n const interactionProps: DXCGenericUserInteraction = {\n type: 'generic',\n title,\n alerts,\n options,\n fields: {},\n submitLabel: '', // No submit button - just options\n cancelLabel: 'Cancel',\n onSubmit: (params: { [key: string]: string }) => {\n userInteraction.next(undefined);\n // Check which option was selected\n if ('otp' in params) {\n resolve({ type: 'otp' });\n } else if ('provider' in params) {\n resolve({ type: 'provider', provider: params.provider });\n } else {\n // Unknown - default to OTP\n resolve({ type: 'otp' });\n }\n },\n onCancel: () => {\n userInteraction.next(undefined);\n reject(new Dexie.AbortError('User cancelled'));\n },\n };\n \n userInteraction.next(interactionProps);\n });\n}\n" }, { "path": "addons/dexie-cloud/src/authentication/login.ts", "content": "import { DexieCloudDB } from '../db/DexieCloudDB';\nimport { LoginHints } from '../DexieCloudAPI';\nimport { triggerSync } from '../sync/triggerSync';\nimport { authenticate, loadAccessToken } from './authenticate';\nimport { AuthPersistedContext } from './AuthPersistedContext';\nimport { logout } from './logout';\nimport { otpFetchTokenCallback } from './otpFetchTokenCallback';\nimport { setCurrentUser } from './setCurrentUser';\nimport { UNAUTHORIZED_USER } from './UNAUTHORIZED_USER';\n\nexport async function login(\n db: DexieCloudDB,\n hints?: LoginHints\n) {\n const currentUser = await db.getCurrentUser();\n const origUserId = currentUser.userId;\n if (currentUser.isLoggedIn && (!hints || (!hints.email && !hints.userId))) {\n const licenseStatus = currentUser.license?.status || 'ok';\n if (\n licenseStatus === 'ok' &&\n currentUser.accessToken &&\n (!currentUser.accessTokenExpiration ||\n currentUser.accessTokenExpiration.getTime() > Date.now())\n ) {\n // Already authenticated according to given hints. And license is valid.\n return false;\n }\n if (\n currentUser.refreshToken &&\n (!currentUser.refreshTokenExpiration ||\n currentUser.refreshTokenExpiration.getTime() > Date.now())\n ) {\n // Refresh the token\n await loadAccessToken(db);\n return false;\n }\n // No refresh token - must re-authenticate:\n }\n const context = new AuthPersistedContext(db, {\n claims: {},\n lastLogin: new Date(0),\n });\n try {\n await authenticate(\n db.cloud.options!.databaseUrl,\n context,\n db.cloud.options!.fetchTokens || otpFetchTokenCallback(db),\n db.cloud.userInteraction,\n hints\n );\n } catch (err) {\n if (err.name === 'OAuthRedirectError') {\n return false; // Page is redirecting for OAuth login\n }\n throw err;\n }\n if (\n origUserId !== UNAUTHORIZED_USER.userId &&\n context.userId !== origUserId\n ) {\n // User was logged in before, but now logged in as another user.\n await logout(db);\n }\n\n /*try {\n await context.save();\n } catch (e) {\n try {\n if (e.name === 'DataCloneError') {\n console.debug(`Login context property names:`, Object.keys(context));\n console.debug(`Login context:`, context);\n console.debug(`Login context JSON:`, JSON.stringify(context));\n }\n } catch {}\n throw e;\n }*/\n await setCurrentUser(db, context);\n // Make sure to resync as the new login will be authorized\n // for new realms.\n triggerSync(db, 'pull');\n return context.userId !== origUserId;\n}\n" }, { "path": "addons/dexie-cloud/src/authentication/logout.ts", "content": "import { DexieCloudDB } from '../db/DexieCloudDB';\nimport { TXExpandos } from '../types/TXExpandos';\nimport { confirmLogout } from './interactWithUser';\nimport { UNAUTHORIZED_USER } from './UNAUTHORIZED_USER';\nimport { waitUntil } from './waitUntil';\n\nexport async function logout(db: DexieCloudDB) {\n const numUnsyncedChanges = await _logout(db);\n if (numUnsyncedChanges) {\n if (\n await confirmLogout(\n db.cloud.userInteraction,\n db.cloud.currentUserId,\n numUnsyncedChanges\n )\n ) {\n await _logout(db, { deleteUnsyncedData: true });\n } else {\n throw new Error(`User cancelled logout due to unsynced changes`);\n }\n }\n}\n\nexport async function _logout(db: DexieCloudDB, { deleteUnsyncedData = false } = {}) {\n // Clear the database without emptying configuration options.\n const [numUnsynced, loggedOut] = await db.dx.transaction('rw', db.dx.tables, async (tx) => {\n // @ts-ignore\n const idbtrans: IDBTransaction & TXExpandos = tx.idbtrans;\n idbtrans.disableChangeTracking = true;\n idbtrans.disableAccessControl = true;\n const mutationTables = tx.storeNames.filter((tableName) =>\n tableName.endsWith('_mutations')\n );\n\n // Count unsynced changes\n const unsyncCounts = await Promise.all(\n mutationTables.map((mutationTable) => tx.table(mutationTable).count())\n );\n const sumUnSynced = unsyncCounts.reduce((a, b) => a + b, 0);\n\n if (sumUnSynced > 0 && !deleteUnsyncedData) {\n // Let caller ask user if they want to delete unsynced data.\n return [sumUnSynced, false];\n }\n \n // Either there are no unsynched changes, or caller provided flag deleteUnsynchedData = true.\n // Clear all tables except $jobs and $syncState (except the persisted sync state which is\n // also cleared because we're going to rebuild it using a fresh sync).\n db.$syncState.delete('syncState');\n for (const table of db.dx.tables) {\n if (table.name !== '$jobs' && table.name !== '$syncState') {\n table.clear();\n }\n }\n return [sumUnSynced, true];\n });\n\n if (loggedOut) {\n // Wait for currentUser observable to emit UNAUTHORIZED_USER\n await waitUntil(db.cloud.currentUser, (user) => user.userId === UNAUTHORIZED_USER.userId);\n // Then perform an initial sync\n await db.cloud.sync({purpose: 'pull', wait: true});\n }\n return numUnsynced;\n}\n" }, { "path": "addons/dexie-cloud/src/authentication/oauthLogin.ts", "content": "import { OAuthError } from '../errors/OAuthError';\n\n/** Options for initiating OAuth redirect */\nexport interface OAuthRedirectOptions {\n /** The Dexie Cloud database URL */\n databaseUrl: string;\n /** The OAuth provider name */\n provider: string;\n /** Optional redirect URI override.\n * Defaults to window.location.href for web apps.\n * For Capacitor/native apps, use a custom URL scheme like 'myapp://'\n */\n redirectUri?: string;\n}\n\n/** Build the OAuth login URL */\nfunction buildOAuthLoginUrl(options: OAuthRedirectOptions): string {\n const url = new URL(`${options.databaseUrl}/oauth/login/${options.provider}`);\n \n // Set the redirect URI - defaults to current page URL for web SPAs\n const redirectUri = options.redirectUri || \n (typeof window !== 'undefined' ? window.location.href : '');\n if (redirectUri) {\n url.searchParams.set('redirect_uri', redirectUri);\n }\n \n return url.toString();\n}\n\n/**\n * Initiates OAuth login via full page redirect.\n * \n * The page will navigate to the OAuth provider. After authentication,\n * the user is redirected back to the app with a `dxc-auth` query parameter\n * containing base64url-encoded JSON with the authorization code.\n * \n * The dexie-cloud-addon automatically detects and processes this parameter\n * when db.cloud.configure() is called on page load.\n * \n * @param options - OAuth redirect options\n * \n * @example\n * ```typescript\n * // Initiate OAuth login\n * startOAuthRedirect({\n * databaseUrl: 'https://mydb.dexie.cloud',\n * provider: 'google'\n * });\n * // Page navigates away, user authenticates, then returns with auth code\n * ```\n */\nexport function startOAuthRedirect(options: OAuthRedirectOptions): void {\n if (typeof window === 'undefined') {\n throw new Error('OAuth redirect requires a browser environment');\n }\n \n const loginUrl = buildOAuthLoginUrl(options);\n window.location.href = loginUrl;\n}\n\n/** Map OAuth error strings to error codes */\nexport function mapOAuthError(error: string): OAuthError['code'] {\n const lowerError = error.toLowerCase();\n \n if (lowerError.includes('access_denied') || lowerError.includes('access denied')) {\n return 'access_denied';\n }\n if (lowerError.includes('email') && lowerError.includes('verif')) {\n return 'email_not_verified';\n }\n if (lowerError.includes('expired')) {\n return 'expired_code';\n }\n if (lowerError.includes('state')) {\n return 'invalid_state';\n }\n \n return 'provider_error';\n}\n" }, { "path": "addons/dexie-cloud/src/authentication/otpFetchTokenCallback.ts", "content": "import {\n AuthorizationCodeTokenRequest,\n DemoTokenRequest,\n OTPTokenRequest1,\n OTPTokenRequest2,\n TokenErrorResponse,\n TokenFinalResponse,\n TokenRequest,\n TokenResponse,\n} from 'dexie-cloud-common';\nimport { DexieCloudDB } from '../db/DexieCloudDB';\nimport { HttpError } from '../errors/HttpError';\nimport { FetchTokenCallback } from './authenticate';\nimport { exchangeOAuthCode } from './exchangeOAuthCode';\nimport { fetchAuthProviders } from './fetchAuthProviders';\nimport { alertUser, promptForEmail, promptForOTP, promptForProvider } from './interactWithUser';\nimport { startOAuthRedirect } from './oauthLogin';\nimport { OAuthRedirectError } from '../errors/OAuthRedirectError';\n\nexport function otpFetchTokenCallback(db: DexieCloudDB): FetchTokenCallback {\n const { userInteraction } = db.cloud;\n return async function otpAuthenticate({ public_key, hints }) {\n let tokenRequest: TokenRequest;\n const url = db.cloud.options?.databaseUrl;\n if (!url) throw new Error(`No database URL given.`);\n \n // Handle OAuth code exchange (from redirect/deep link flows)\n if (hints?.oauthCode && hints.provider) {\n return await exchangeOAuthCode({\n databaseUrl: url,\n code: hints.oauthCode,\n publicKey: public_key,\n scopes: ['ACCESS_DB'],\n });\n }\n \n // Handle OAuth provider login via redirect\n if (hints?.provider) {\n let resolvedRedirectUri: string | undefined = undefined;\n if (hints.redirectPath) {\n // If redirectPath is absolute, use as is. If relative, resolve against current location\n if (/^https?:\\/\\//i.test(hints.redirectPath)) {\n resolvedRedirectUri = hints.redirectPath;\n } else if (typeof window !== 'undefined' && window.location) {\n // Use URL constructor to resolve relative path\n resolvedRedirectUri = new URL(hints.redirectPath, window.location.href).toString();\n } else if (typeof location !== 'undefined' && location.href) {\n resolvedRedirectUri = new URL(hints.redirectPath, location.href).toString();\n }\n }\n initiateOAuthRedirect(db, hints.provider, resolvedRedirectUri);\n // This function never returns - page navigates away\n throw new OAuthRedirectError(hints.provider);\n }\n \n if (hints?.grant_type === 'demo') {\n const demo_user = await promptForEmail(\n userInteraction,\n 'Enter a demo user email',\n hints?.email || hints?.userId\n );\n tokenRequest = {\n demo_user,\n grant_type: 'demo',\n scopes: ['ACCESS_DB'],\n public_key\n } satisfies DemoTokenRequest;\n } else if (hints?.otpId && hints.otp) {\n // User provided OTP ID and OTP code. This means that the OTP email\n // has already gone out and the user may have clicked a magic link\n // in the email with otp and otpId in query and the app has picked\n // up those values and passed them to db.cloud.login().\n tokenRequest = {\n grant_type: 'otp',\n otp_id: hints.otpId,\n otp: hints.otp,\n scopes: ['ACCESS_DB'],\n public_key,\n } satisfies OTPTokenRequest2;\n } else if (hints?.grant_type === 'otp' || hints?.email) {\n // User explicitly requested OTP flow - skip provider selection\n const email = hints?.email || await promptForEmail(\n userInteraction,\n 'Enter email address'\n );\n if (/@demo.local$/.test(email)) {\n tokenRequest = {\n demo_user: email,\n grant_type: 'demo',\n scopes: ['ACCESS_DB'],\n public_key\n } satisfies DemoTokenRequest;\n } else {\n tokenRequest = {\n email,\n grant_type: 'otp',\n scopes: ['ACCESS_DB'],\n } satisfies OTPTokenRequest1;\n }\n } else {\n // Check for available auth providers (OAuth + OTP)\n const socialAuthEnabled = db.cloud.options?.socialAuth !== false;\n const authProviders = await fetchAuthProviders(url, socialAuthEnabled);\n \n // If we have OAuth providers available, prompt for selection\n if (authProviders.providers.length > 0) {\n const selection = await promptForProvider(\n userInteraction,\n authProviders.providers,\n authProviders.otpEnabled,\n 'Sign in',\n );\n \n if (selection.type === 'provider') {\n // User selected an OAuth provider - initiate redirect\n initiateOAuthRedirect(db, selection.provider);\n // This function never returns - page navigates away\n throw new OAuthRedirectError(selection.provider);\n }\n // User chose OTP - continue with email prompt below\n }\n \n const email = await promptForEmail(\n userInteraction,\n 'Enter email address',\n hints?.email\n );\n if (/@demo.local$/.test(email)) {\n tokenRequest = {\n demo_user: email,\n grant_type: 'demo',\n scopes: ['ACCESS_DB'],\n public_key\n } satisfies DemoTokenRequest;\n } else {\n tokenRequest = {\n email,\n grant_type: 'otp',\n scopes: ['ACCESS_DB'],\n } satisfies OTPTokenRequest1;\n }\n }\n const res1 = await fetch(`${url}/token`, {\n body: JSON.stringify(tokenRequest),\n method: 'post',\n headers: { 'Content-Type': 'application/json' },\n mode: 'cors',\n });\n if (res1.status !== 200) {\n const errMsg = await res1.text();\n await alertUser(userInteraction, \"Token request failed\", {\n type: 'error',\n messageCode: 'GENERIC_ERROR',\n message: errMsg,\n messageParams: {}\n }).catch(()=>{});\n throw new HttpError(res1, errMsg);\n }\n const response: TokenResponse = await res1.json();\n if (response.type === 'tokens' || response.type === 'error') {\n // Demo user request can get a \"tokens\" response right away\n // Error can also be returned right away.\n return response;\n } else if (tokenRequest.grant_type === 'otp' && 'email' in tokenRequest) {\n if (response.type !== 'otp-sent')\n throw new Error(`Unexpected response from ${url}/token`);\n const otp = await promptForOTP(userInteraction, tokenRequest.email);\n const tokenRequest2 = {\n ...tokenRequest,\n otp: otp || '',\n otp_id: response.otp_id,\n public_key\n } satisfies OTPTokenRequest2;\n\n let res2 = await fetch(`${url}/token`, {\n body: JSON.stringify(tokenRequest2),\n method: 'post',\n headers: { 'Content-Type': 'application/json' },\n mode: 'cors',\n });\n while (res2.status === 401) {\n const errorText = await res2.text();\n tokenRequest2.otp = await promptForOTP(userInteraction, tokenRequest.email, {\n type: 'error',\n messageCode: 'INVALID_OTP',\n message: errorText,\n messageParams: {}\n });\n res2 = await fetch(`${url}/token`, {\n body: JSON.stringify(tokenRequest2),\n method: 'post',\n headers: { 'Content-Type': 'application/json' },\n mode: 'cors',\n });\n }\n if (res2.status !== 200) {\n const errMsg = await res2.text();\n throw new HttpError(res2, errMsg);\n }\n const response2: TokenFinalResponse | TokenErrorResponse = await res2.json();\n return response2;\n } else {\n throw new Error(`Unexpected response from ${url}/token`);\n }\n };\n}\n\n/**\n * Initiates OAuth login via full page redirect.\n * \n * The page will navigate away to the OAuth provider. After authentication,\n * the user is redirected back with a dxc-auth query parameter that is\n * automatically detected by db.cloud.configure().\n */\nfunction initiateOAuthRedirect(\n db: DexieCloudDB,\n provider: string,\n redirectUriOverride?: string\n): void {\n const url = db.cloud.options?.databaseUrl;\n if (!url) throw new Error(`No database URL given.`);\n \n const redirectUri =\n redirectUriOverride ||\n db.cloud.options?.oauthRedirectUri ||\n (typeof location !== 'undefined' ? location.href : undefined);\n \n // CodeRabbit suggested to fail fast here, but the only situation where\n // redirectUri would be undefined is in non-browser environments, and\n // in those environments OAuth redirect does not make sense anyway\n // and will fail fast in startOAuthRedirect().\n \n // Start OAuth redirect flow - page navigates away\n startOAuthRedirect({\n databaseUrl: url,\n provider,\n redirectUri,\n });\n}\n" }, { "path": "addons/dexie-cloud/src/authentication/setCurrentUser.ts", "content": "import { DexieCloudDB } from '../db/DexieCloudDB';\nimport { prodLog } from '../prodLog';\nimport { AuthPersistedContext } from './AuthPersistedContext';\nimport { waitUntil } from './waitUntil';\n\n/** This function changes or sets the current user as requested.\n *\n * Use cases:\n * * Initially on db.ready after reading the current user from db.$logins.\n * This will make sure that any unsynced operations from the previous user is synced before\n * changing the user.\n * * Upon user request\n *\n * @param db\n * @param newUser\n */\nexport async function setCurrentUser(\n db: DexieCloudDB,\n user: AuthPersistedContext\n) {\n const $logins = db.table('$logins');\n await db.transaction('rw', $logins, async (tx) => {\n const existingLogins = await $logins.toArray();\n await Promise.all(\n existingLogins\n .filter((login) => login.userId !== user.userId && login.isLoggedIn)\n .map((login) => {\n login.isLoggedIn = false;\n return $logins.put(login);\n })\n );\n user.isLoggedIn = true;\n user.lastLogin = new Date();\n try {\n await user.save();\n } catch (e) {\n try {\n if (e.name === 'DataCloneError') {\n // We've seen this buggy behavior in some browsers and in case it happens\n // again we really need to collect the details to understand what's going on.\n prodLog('debug', `Login context property names:`, Object.keys(user));\n prodLog('debug', `Login context property names:`, Object.keys(user));\n prodLog('debug', `Login context:`, user);\n prodLog('debug', `Login context JSON:`, JSON.stringify(user));\n }\n } catch {}\n throw e;\n }\n console.debug('Saved new user', user.email);\n });\n await waitUntil(\n db.cloud.currentUser,\n (currentUser) => currentUser.userId === user.userId\n );\n}\n" }, { "path": "addons/dexie-cloud/src/authentication/waitUntil.ts", "content": "import { filter, firstValueFrom, from, InteropObservable, Observable } from 'rxjs';\n\nexport function waitUntil(\n o: Observable | InteropObservable, // Works with Dexie's liveQuery observables if we'd need that\n predicate: (value: T) => boolean\n) {\n return firstValueFrom(from(o).pipe(\n filter(predicate),\n ));\n}\n" }, { "path": "addons/dexie-cloud/src/computeSyncState.ts", "content": "import { combineLatest, Observable, of } from 'rxjs';\nimport { debounceTime, map, startWith, switchMap } from 'rxjs/operators';\nimport { getCurrentUserEmitter } from './currentUserEmitter';\nimport { DexieCloudDB, SyncStateChangedEventData } from './db/DexieCloudDB';\nimport { isOnline } from './sync/isOnline';\nimport { SyncState } from './types/SyncState';\nimport { userIsActive, userIsReallyActive } from './userIsActive';\n\nexport function computeSyncState(db: DexieCloudDB): Observable {\n let _prevStatus = db.cloud.webSocketStatus.value;\n const lazyWebSocketStatus = db.cloud.webSocketStatus.pipe(\n switchMap((status) => {\n const prevStatus = _prevStatus;\n _prevStatus = status;\n const rv = of(status);\n switch (status) {\n // A normal scenario is that the WS reconnects and falls shortly in disconnected-->connection-->connected.\n // Don't distract user with this unless these things take more time than normal:\n\n // Only show disconnected if disconnected more than 500ms, or if we can\n // see that the user is indeed not active.\n case 'disconnected':\n return userIsActive.value ? rv.pipe(debounceTime(500)) : rv;\n\n // Only show connecting if previous state was 'not-started' or 'error', or if\n // the time it takes to connect goes beyond 4 seconds.\n case 'connecting':\n return prevStatus === 'not-started' || prevStatus === 'error'\n ? rv\n : rv.pipe(debounceTime(4000));\n default:\n return rv;\n }\n })\n );\n return combineLatest([\n lazyWebSocketStatus,\n db.syncStateChangedEvent.pipe(startWith({ phase: 'initial' } as SyncStateChangedEventData)),\n getCurrentUserEmitter(db.dx._novip),\n userIsReallyActive\n ]).pipe(\n map(([status, syncState, user, userIsActive]) => {\n if (user.license?.status && user.license.status !== 'ok') {\n return {\n phase: 'offline',\n status: 'offline',\n license: user.license.status\n } satisfies SyncState;\n }\n let { phase, error, progress } = syncState;\n let adjustedStatus = status;\n if (phase === 'error') {\n // Let users only rely on the status property to display an icon.\n // If there's an error in the sync phase, let it show on that\n // status icon also.\n adjustedStatus = 'error';\n }\n if (status === 'not-started') {\n // If websocket isn't yet connected becase we're doing\n // the startup sync, let the icon show the symbol for connecting.\n if (phase === 'pushing' || phase === 'pulling') {\n adjustedStatus = 'connecting';\n }\n } \n const previousPhase = db.cloud.syncState.value.phase;\n //const previousStatus = db.cloud.syncState.value.status;\n if (previousPhase === 'error' && (syncState.phase === 'pushing' || syncState.phase === 'pulling')) {\n // We were in an errored state but is now doing sync. Show \"connecting\" icon.\n adjustedStatus = 'connecting';\n }\n /*if (syncState.phase === 'in-sync' && adjustedStatus === 'connecting') {\n adjustedStatus = 'connected';\n }*/\n \n if (!userIsActive) {\n adjustedStatus = 'disconnected';\n }\n\n const retState: SyncState = {\n phase,\n error,\n progress,\n status: isOnline ? adjustedStatus : 'offline',\n license: 'ok'\n };\n\n return retState;\n })\n );\n}\n" }, { "path": "addons/dexie-cloud/src/createSharedValueObservable.ts", "content": "import {\n concat,\n from,\n InteropObservable,\n map,\n Observable,\n ObservableInput,\n share,\n timer,\n} from 'rxjs';\nimport { ObservableWithCurrentValue } from './mapValueObservable';\n\nexport function createSharedValueObservable(\n o: ObservableInput,\n defaultValue: T\n): ObservableWithCurrentValue {\n let currentValue = defaultValue;\n let shared = from(o).pipe(\n map((x) => (currentValue = x)),\n share({ resetOnRefCountZero: () => timer(1000) })\n ) as ObservableWithCurrentValue;\n\n const rv = new Observable((observer) => {\n let didEmit = false;\n const subscription = shared.subscribe({\n next(value) {\n didEmit = true;\n observer.next(value);\n },\n error(error) {\n observer.error(error);\n },\n complete() {\n observer.complete();\n }\n });\n if (!didEmit && !subscription.closed) {\n observer.next(currentValue);\n }\n return subscription;\n }) as ObservableWithCurrentValue;\n\n rv.getValue = () => currentValue;\n return rv;\n}\n" }, { "path": "addons/dexie-cloud/src/currentUserEmitter.ts", "content": "import Dexie from \"dexie\";\nimport { BehaviorSubject } from \"rxjs\";\nimport { associate } from \"./associate\";\nimport { UNAUTHORIZED_USER } from \"./authentication/UNAUTHORIZED_USER\";\nimport { UserLogin } from \"./dexie-cloud-client\";\n\nexport const getCurrentUserEmitter = associate((db: Dexie) => new BehaviorSubject(\n {...UNAUTHORIZED_USER, isLoading: true}\n));\n" }, { "path": "addons/dexie-cloud/src/db/DexieCloudDB.ts", "content": "import Dexie, { Table } from 'dexie';\nimport { GuardedJob } from './entities/GuardedJob';\nimport { UserLogin } from './entities/UserLogin';\nimport { PersistedSyncState } from './entities/PersistedSyncState';\nimport { UNAUTHORIZED_USER } from '../authentication/UNAUTHORIZED_USER';\nimport { DexieCloudOptions } from '../DexieCloudOptions';\nimport { BehaviorSubject, Subject } from 'rxjs';\nimport { BaseRevisionMapEntry } from './entities/BaseRevisionMapEntry';\nimport {\n DBRealm,\n DBRealmMember,\n DBRealmRole,\n DexieCloudSchema,\n} from 'dexie-cloud-common';\nimport { BroadcastedAndLocalEvent } from '../helpers/BroadcastedAndLocalEvent';\nimport { SyncState, SyncStatePhase } from '../types/SyncState';\nimport { MessagesFromServerConsumer } from '../sync/messagesFromServerQueue';\nimport { YClientMessage } from 'dexie-cloud-common';\nimport { BlobDownloadTracker } from '../sync/BlobDownloadTracker';\n\n/*export interface DexieCloudDB extends Dexie {\n table(name: string): Table;\n table(name: \"$jobs\"): Table;\n table(name: \"$logins\"): Table;\n table(name: \"$syncState\"): Table;\n //table(name: \"$pendingChangesFromServer\"): Table;\n}\n*/\n\nexport interface SyncStateChangedEventData {\n phase: SyncStatePhase;\n error?: Error;\n progress?: number;\n}\n\ntype SyncStateTable = Table<\n PersistedSyncState | DexieCloudSchema | DexieCloudOptions,\n 'syncState' | 'options' | 'schema'\n>;\nexport interface DexieCloudDBBase {\n readonly name: Dexie['name'];\n readonly close: Dexie['close'];\n transaction: Dexie['transaction'];\n table: Dexie['table'];\n readonly tables: Dexie['tables'];\n readonly cloud: Dexie['cloud'];\n readonly $jobs: Table;\n readonly $logins: Table;\n readonly $syncState: SyncStateTable;\n readonly $baseRevs: Table;\n\n readonly realms: Table;\n readonly members: Table;\n readonly roles: Table;\n\n readonly localSyncEvent: Subject<{ purpose?: 'pull' | 'push' }>;\n readonly syncStateChangedEvent: BroadcastedAndLocalEvent;\n readonly syncCompleteEvent: BroadcastedAndLocalEvent;\n readonly dx: Dexie;\n readonly initiallySynced: boolean;\n}\n\nexport interface DexieCloudDB extends DexieCloudDBBase {\n getCurrentUser(): Promise;\n getSchema(): Promise;\n getOptions(): Promise;\n getPersistedSyncState(): Promise;\n setInitiallySynced(initiallySynced: boolean): void;\n reconfigure(): void;\n messageConsumer: MessagesFromServerConsumer;\n messageProducer: Subject;\n blobDownloadTracker: BlobDownloadTracker;\n}\n\nconst wm = new WeakMap();\n\nexport const DEXIE_CLOUD_SCHEMA = {\n members: '@id, [userId+realmId], [email+realmId], realmId',\n roles: '[realmId+name]',\n realms: '@realmId',\n $jobs: '',\n $syncState: '',\n $baseRevs: '[tableName+clientRev]',\n $logins: 'claims.sub, lastLogin',\n};\n\nlet static_counter = 0;\nexport function DexieCloudDB(dx: Dexie): DexieCloudDB {\n if ('vip' in dx) dx = dx['vip']; // Avoid race condition. Always map to a vipped dexie that don't block during db.on.ready().\n let db = wm.get(dx);\n if (!db) {\n const localSyncEvent = new Subject<{ purpose: 'push' | 'pull' }>();\n let syncStateChangedEvent =\n new BroadcastedAndLocalEvent(\n `syncstatechanged-${dx.name}`\n );\n let syncCompleteEvent = new BroadcastedAndLocalEvent(\n `synccomplete-${dx.name}`\n );\n localSyncEvent['id'] = ++static_counter;\n let initiallySynced = false;\n db = {\n get name() {\n return dx.name;\n },\n close() {\n return dx.close();\n },\n transaction: dx.transaction.bind(dx),\n table: dx.table.bind(dx),\n get tables() {\n return dx.tables;\n },\n get cloud() {\n return dx.cloud;\n },\n get $jobs() {\n return dx.table('$jobs') as Table;\n },\n get $syncState() {\n return dx.table('$syncState') as SyncStateTable;\n },\n get $baseRevs() {\n return dx.table('$baseRevs') as Table<\n BaseRevisionMapEntry,\n [string, number]\n >;\n },\n get $logins() {\n return dx.table('$logins') as Table;\n },\n\n get realms() {\n return dx.realms;\n },\n get members() {\n return dx.members;\n },\n get roles() {\n return dx.roles;\n },\n get initiallySynced() {\n return initiallySynced;\n },\n localSyncEvent,\n get syncStateChangedEvent() {\n return syncStateChangedEvent;\n },\n get syncCompleteEvent() {\n return syncCompleteEvent;\n },\n dx,\n } as DexieCloudDB;\n\n const helperMethods: Partial = {\n getCurrentUser() {\n return db!.$logins\n .toArray()\n .then(\n (logins) => logins.find((l) => l.isLoggedIn) || UNAUTHORIZED_USER\n );\n },\n getPersistedSyncState() {\n return db!.$syncState.get('syncState') as Promise<\n PersistedSyncState | undefined\n >;\n },\n getSchema() {\n return db!.$syncState.get('schema').then((schema: DexieCloudSchema) => {\n if (schema) {\n for (const table of db!.tables) {\n if (table.schema.primKey && table.schema.primKey.keyPath && schema[table.name]) {\n schema[table.name].primaryKey = nameFromKeyPath(\n table.schema.primKey.keyPath\n );\n }\n }\n }\n return schema;\n }) as Promise;\n },\n getOptions() {\n return db!.$syncState.get('options') as Promise<\n DexieCloudOptions | undefined\n >;\n },\n setInitiallySynced(value) {\n initiallySynced = value;\n },\n reconfigure() {\n syncStateChangedEvent = new BroadcastedAndLocalEvent(\n `syncstatechanged-${dx.name}`\n );\n syncCompleteEvent = new BroadcastedAndLocalEvent(\n `synccomplete-${dx.name}`\n );\n },\n };\n\n Object.assign(db, helperMethods);\n db.messageConsumer = MessagesFromServerConsumer(db);\n db.messageProducer = new Subject();\n db.blobDownloadTracker = new BlobDownloadTracker(db);\n wm.set(dx, db);\n }\n return db;\n}\n\nfunction nameFromKeyPath (keyPath?: string | string[]): string {\n return typeof keyPath === 'string' ?\n keyPath :\n keyPath ? ('[' + [].join.call(keyPath, '+') + ']') : \"\";\n}\n" }, { "path": "addons/dexie-cloud/src/db/entities/BaseRevisionMapEntry.ts", "content": "// This interface has been moved to dexie-cloud-common. TODO: Remove file and update imports.\nexport interface BaseRevisionMapEntry {\n tableName: string;\n clientRev: number;\n serverRev: any;\n}" }, { "path": "addons/dexie-cloud/src/db/entities/EntityCommon.ts", "content": "export interface EntityCommon {\n realmId?: string;\n owner?: string;\n $ts?: string;\n _hasBlobRefs?: 1; // Indicates that the entity has unresolved BlobRefs\n}\n" }, { "path": "addons/dexie-cloud/src/db/entities/GuardedJob.ts", "content": "\nexport interface GuardedJob {\n nodeId: string;\n started: Date;\n heartbeat: Date;\n}\n" }, { "path": "addons/dexie-cloud/src/db/entities/Member.ts", "content": "export interface Member {\n id?: string; // Auto-generated universal primary key\n realmId: string;\n userId?: string; // User identity. Set by the system when user accepts invite.\n email?: string; // The email of the requested user (for invites).\n name?: string; // The name of the requested user (for invites).\n invite?: boolean;\n invited?: Date;\n accepted?: Date;\n rejected?: Date;\n roles?: string[]; // Array of role names for this user.\n permissions?: {\n add?: string[] | \"*\"; // array of tables or \"*\" (all).\n update?: {\n [tableName: string]: string[] | \"*\"; // array of properties or \"*\" (all).\n };\n manage?: string[] | \"*\"; // array of tables or \"*\" (all).\n };\n}\n" }, { "path": "addons/dexie-cloud/src/db/entities/PersistedSyncState.ts", "content": "export interface PersistedSyncState {\n serverRevision?: any;\n yServerRevision?: string;\n latestRevisions: {\n [tableName: string]: number\n };\n realms: string[];\n inviteRealms: string[];\n clientIdentity: string;\n initiallySynced?: boolean;\n remoteDbId?: string;\n syncedTables: string[];\n timestamp?: Date;\n error?: string;\n yDownloadedRealms?: {\n [realmId: string]: \"*\" | {\n tbl: string;\n prop: string;\n key: any;\n }\n }\n}\n" }, { "path": "addons/dexie-cloud/src/db/entities/Realm.ts", "content": "export interface Realm {\n /** Primary key of the realm.\n */\n realmId: string;\n\n /** The name of the realm.\n *\n * This property is optional but it can be a good practice to name a realm for what it represents.\n */\n name?: string;\n\n /** Contains the user-ID of the owner. An owner has implicit full write-access to the realm\n * and all obejcts connected to it.\n */\n owner?: string;\n}\n" }, { "path": "addons/dexie-cloud/src/db/entities/Role.ts", "content": "export interface Role {\n realmId: string;\n name: string;\n permissions: {\n add?: string[] | \"*\"; // array of tables or \"*\" (all).\n update?: {\n [tableName: string]: string[] | \"*\"; // array of properties or \"*\" (all).\n };\n manage?: string[] | \"*\"; // array of tables or \"*\" (all).\n };\n}\n" }, { "path": "addons/dexie-cloud/src/db/entities/UserLogin.ts", "content": "import { DXCUserInteraction } from \"../../types/DXCUserInteraction\";\n\nexport interface UserLogin {\n userId?: string;\n name?: string;\n email?: string;\n claims: {\n [claimName: string]: any;\n }\n license?: {\n type: 'demo' | 'eval' | 'prod' | 'client';\n status: 'ok' | 'expired' | 'deactivated';\n validUntil?: Date;\n evalDaysLeft?: number;\n }\n lastLogin: Date;\n accessToken?: string;\n accessTokenExpiration?: Date;\n refreshToken?: string;\n refreshTokenExpiration?: Date;\n nonExportablePrivateKey?: CryptoKey;\n publicKey?: CryptoKey;\n isLoggedIn?: boolean;\n data?: any; // From user data\n isLoading?: boolean; // true while we still are loading user info\n}\n" }, { "path": "addons/dexie-cloud/src/default-ui/Dialog.tsx", "content": "import { Styles } from './Styles';\nimport { ComponentChildren, h } from 'preact';\n\nexport function Dialog({ children, className }: { children?: ComponentChildren, className?: string }) {\n return (\n
\n
\n
\n
{children}
\n
\n
\n );\n}\n" }, { "path": "addons/dexie-cloud/src/default-ui/LoginDialog.tsx", "content": "import { Dialog } from './Dialog';\nimport { Styles } from './Styles';\nimport { h, Fragment } from 'preact';\nimport { useLayoutEffect, useRef, useState } from 'preact/hooks';\nimport { DXCUserInteraction, DXCOption } from '../types/DXCUserInteraction';\nimport { resolveText } from '../helpers/resolveText';\nimport { DXCInputField } from '../types/DXCInputField';\nimport { OptionButton, Divider } from './OptionButton';\nimport { DXCAlert } from '../types/DXCAlert';\n\nconst OTP_LENGTH = 8;\n\n/** Props for LoginDialog - accepts any user interaction */\ninterface LoginDialogProps {\n title: string;\n alerts: DXCAlert[];\n fields: { [name: string]: DXCInputField };\n options?: DXCOption[];\n submitLabel?: string;\n cancelLabel?: string | null;\n onSubmit: (params: { [paramName: string]: string }) => void;\n onCancel: () => void;\n}\n\n/**\n * Generic dialog that can render:\n * - Form fields (text inputs)\n * - Selectable options (buttons)\n * - Or both together\n * \n * When an option is clicked, calls onSubmit({ [option.name]: option.value }).\n * This unified approach means the same callback handles both form submission\n * and option selection.\n */\nexport function LoginDialog({\n title,\n alerts,\n fields,\n options,\n submitLabel,\n cancelLabel,\n onCancel,\n onSubmit,\n}: LoginDialogProps) {\n const [params, setParams] = useState<{ [param: string]: string }>({});\n\n const firstFieldRef = useRef(null);\n useLayoutEffect(() => firstFieldRef.current?.focus(), []);\n\n const fieldEntries = Object.entries(fields || {}) as [string, DXCInputField][];\n const hasFields = fieldEntries.length > 0;\n const hasOptions = options && options.length > 0;\n\n // Group options by name to detect if we have multiple groups\n const optionGroups = new Map();\n if (options) {\n for (const option of options) {\n const group = optionGroups.get(option.name) || [];\n group.push(option);\n optionGroups.set(option.name, group);\n }\n }\n const hasMultipleGroups = optionGroups.size > 1;\n\n // Handler for option clicks - calls onSubmit with { [option.name]: option.value }\n const handleOptionClick = (option: DXCOption) => {\n onSubmit({ [option.name]: option.value });\n };\n\n return (\n \n <>\n

{title}

\n {alerts.map((alert, idx) => (\n
\n

{resolveText(alert)}

\n {alert.copyText && }\n
\n ))}\n\n {/* Render options if present */}\n {hasOptions && (\n
\n {hasMultipleGroups ? (\n // Render with dividers between groups\n Array.from(optionGroups.entries()).map(([groupName, groupOptions], groupIdx) => (\n \n {groupIdx > 0 && }\n {groupOptions!.map((option) => (\n handleOptionClick(option)}\n />\n ))}\n \n ))\n ) : (\n // Simple case: all options in one group\n options!.map((option) => (\n handleOptionClick(option)}\n />\n ))\n )}\n
\n )}\n\n {/* Divider between options and fields if both are present */}\n {hasOptions && hasFields && }\n\n {/* Render form fields if present */}\n {hasFields && (\n {\n ev.preventDefault();\n onSubmit(params);\n }}\n >\n {fieldEntries.map(\n ([fieldName, { type, label, placeholder }], idx) => (\n \n )\n )}\n \n )}\n \n
\n <>\n {/* Show submit button if there are fields, OR if there are no options and no fields (e.g., message alert) */}\n {submitLabel && (hasFields || (!hasOptions && !hasFields)) && (\n onSubmit(params)}\n >\n {submitLabel}\n \n )}\n {cancelLabel && (\n \n )}\n \n
\n \n );\n}\n\nfunction valueTransformer(type: string, value: string) {\n switch (type) {\n case 'email':\n return value.toLowerCase();\n case 'otp':\n return value.toUpperCase();\n default:\n return value;\n }\n}\n\nfunction CopyButton({ text }: { text: string }) {\n const [copied, setCopied] = useState(false);\n const timeoutRef = useRef | null>(null);\n\n // Cleanup timeout on unmount\n useLayoutEffect(() => {\n return () => {\n if (timeoutRef.current !== null) clearTimeout(timeoutRef.current);\n };\n }, []);\n\n const scheduleCopiedReset = () => {\n if (timeoutRef.current !== null) clearTimeout(timeoutRef.current);\n setCopied(true);\n timeoutRef.current = setTimeout(() => {\n timeoutRef.current = null;\n setCopied(false);\n }, 2000);\n };\n\n const handleClick = () => {\n if (typeof navigator !== 'undefined' && navigator.clipboard?.writeText) {\n navigator.clipboard.writeText(text).then(scheduleCopiedReset).catch(() => {\n fallbackCopy(text, scheduleCopiedReset);\n });\n } else {\n fallbackCopy(text, scheduleCopiedReset);\n }\n };\n\n return (\n \n {copied ? '✓ Copied!' : `📋 ${text}`}\n \n );\n}\n\nfunction fallbackCopy(text: string, onSuccess: () => void) {\n const textarea = document.createElement('textarea');\n textarea.value = text;\n textarea.style.position = 'fixed';\n textarea.style.opacity = '0';\n document.body.appendChild(textarea);\n textarea.select();\n const success = document.execCommand('copy');\n document.body.removeChild(textarea);\n if (success) onSuccess();\n}\n" }, { "path": "addons/dexie-cloud/src/default-ui/OptionButton.tsx", "content": "import { h } from 'preact';\nimport { DXCOption } from '../types/DXCUserInteraction';\nimport { Styles } from './Styles';\n\nexport interface OptionButtonProps {\n option: DXCOption;\n onClick: () => void;\n}\n\n/** Get style based on styleHint (for provider branding, etc.) */\nfunction getOptionStyle(styleHint?: string): Record {\n const baseStyle = { ...Styles.ProviderButton };\n \n if (!styleHint) {\n return baseStyle;\n }\n \n switch (styleHint) {\n case 'google':\n return { ...baseStyle, ...Styles.ProviderGoogle };\n case 'github':\n return { ...baseStyle, ...Styles.ProviderGitHub };\n case 'microsoft':\n return { ...baseStyle, ...Styles.ProviderMicrosoft };\n case 'apple':\n return { ...baseStyle, ...Styles.ProviderApple };\n case 'otp':\n return { ...Styles.OtpButton };\n case 'custom-oauth2':\n return { ...baseStyle, ...Styles.ProviderCustom };\n default:\n return baseStyle;\n }\n}\n\n/**\n * Generic button component for selectable options.\n * Displays the option's icon and display name.\n * \n * Style is determined by the styleHint property for branding purposes.\n */\nexport function OptionButton({ option, onClick }: OptionButtonProps) {\n const { displayName, iconUrl, styleHint } = option;\n const style = getOptionStyle(styleHint);\n \n return (\n \n {iconUrl && (\n \n )}\n {displayName}\n \n );\n}\n\n/**\n * Visual divider with \"or\" text.\n */\nexport function Divider() {\n return (\n
\n
\n or\n
\n
\n );\n}\n" }, { "path": "addons/dexie-cloud/src/default-ui/Styles.ts", "content": "export const Styles: { [styleAlias: string]: Partial | any} = {\n Error: {\n color: \"red\",\n },\n Alert: {\n error: {\n color: \"red\",\n fontWeight: \"bold\"\n },\n warning: {\n color: \"#f80\",\n fontWeight: \"bold\"\n },\n info: {\n color: \"black\"\n }\n },\n Darken: {\n position: \"fixed\",\n top: 0,\n left: 0,\n opacity: 0.5,\n backgroundColor: \"#000\",\n width: \"100vw\",\n height: \"100vh\",\n zIndex: 150,\n webkitBackdropFilter: \"blur(2px)\",\n backdropFilter: \"blur(2px)\",\n },\n DialogOuter: {\n position: \"fixed\",\n top: 0,\n left: 0,\n width: \"100vw\",\n height: \"100vh\",\n zIndex: 150,\n alignItems: \"center\",\n display: \"flex\",\n justifyContent: \"center\",\n padding: \"16px\",\n boxSizing: \"border-box\"\n },\n DialogInner: {\n position: \"relative\",\n color: \"#222\",\n backgroundColor: \"#fff\",\n padding: \"24px\",\n marginBottom: \"2em\",\n maxWidth: \"400px\",\n width: \"100%\",\n maxHeight: \"90%\",\n overflowY: \"auto\",\n border: \"3px solid #3d3d5d\",\n borderRadius: \"8px\",\n boxShadow: \"0 0 80px 10px #666\",\n fontFamily: \"sans-serif\",\n boxSizing: \"border-box\"\n },\n Input: {\n height: \"35px\",\n width: \"100%\",\n maxWidth: \"100%\",\n borderColor: \"#ccf4\",\n outline: \"none\",\n fontSize: \"16px\",\n padding: \"8px\",\n boxSizing: \"border-box\",\n backgroundColor: \"#f9f9f9\",\n borderRadius: \"4px\",\n border: \"1px solid #ccc\",\n marginTop: \"6px\",\n fontFamily: \"inherit\"\n },\n Button: {\n padding: \"10px 20px\",\n margin: \"0 4px\",\n border: \"1px solid #d1d5db\",\n borderRadius: \"6px\",\n backgroundColor: \"#ffffff\",\n cursor: \"pointer\",\n fontSize: \"14px\",\n fontWeight: \"500\",\n color: \"#374151\",\n transition: \"all 0.2s ease\"\n },\n PrimaryButton: {\n padding: \"10px 20px\",\n margin: \"0 4px\",\n border: \"1px solid #3b82f6\",\n borderRadius: \"6px\",\n backgroundColor: \"#3b82f6\",\n color: \"white\",\n cursor: \"pointer\",\n fontSize: \"14px\",\n fontWeight: \"500\",\n transition: \"all 0.2s ease\"\n },\n ButtonsDiv: {\n display: \"flex\",\n justifyContent: \"flex-end\",\n gap: \"12px\",\n marginTop: \"24px\",\n paddingTop: \"20px\"\n },\n Label: {\n display: \"block\",\n marginBottom: \"12px\",\n fontSize: \"14px\",\n fontWeight: \"500\",\n color: \"#333\"\n },\n WindowHeader: {\n margin: \"0 0 20px 0\",\n fontSize: \"18px\",\n fontWeight: \"600\",\n color: \"#333\",\n borderBottom: \"1px solid #eee\",\n paddingBottom: \"10px\"\n },\n // OAuth Provider Button Styles\n ProviderButton: {\n display: \"flex\",\n alignItems: \"center\",\n justifyContent: \"center\",\n width: \"100%\",\n padding: \"12px 16px\",\n marginBottom: \"10px\",\n border: \"1px solid #d1d5db\",\n borderRadius: \"6px\",\n backgroundColor: \"#ffffff\",\n cursor: \"pointer\",\n fontSize: \"14px\",\n fontWeight: \"500\",\n color: \"#374151\",\n transition: \"all 0.2s ease\",\n gap: \"12px\"\n },\n ProviderButtonIcon: {\n width: \"20px\",\n height: \"20px\",\n flexShrink: 0,\n display: \"flex\",\n alignItems: \"center\",\n justifyContent: \"center\"\n },\n ProviderButtonText: {\n flex: 1,\n textAlign: \"left\" as const\n },\n // Provider-specific colors\n ProviderGoogle: {\n backgroundColor: \"#ffffff\",\n border: \"1px solid #dadce0\",\n color: \"#3c4043\"\n },\n ProviderGitHub: {\n backgroundColor: \"#ffffff\",\n border: \"1px solid #dadce0\",\n color: \"#181717\"\n },\n ProviderMicrosoft: {\n backgroundColor: \"#ffffff\",\n border: \"1px solid #dadce0\",\n color: \"#5e5e5e\"\n },\n ProviderApple: {\n backgroundColor: \"#000000\",\n border: \"1px solid #000000\",\n color: \"#ffffff\"\n },\n ProviderCustom: {\n backgroundColor: \"#ffffff\",\n border: \"1px solid #dadce0\",\n color: \"#181717\"\n },\n // Divider styles\n Divider: {\n display: \"flex\",\n alignItems: \"center\",\n margin: \"20px 0\",\n color: \"#6b7280\",\n fontSize: \"13px\"\n },\n DividerLine: {\n flex: 1,\n height: \"1px\",\n backgroundColor: \"#e5e7eb\"\n },\n DividerText: {\n padding: \"0 12px\",\n color: \"#9ca3af\"\n },\n // OTP Button (Continue with email)\n OtpButton: {\n display: \"flex\",\n alignItems: \"center\",\n justifyContent: \"center\",\n width: \"100%\",\n padding: \"12px 16px\",\n border: \"1px solid #d1d5db\",\n borderRadius: \"6px\",\n backgroundColor: \"#f9fafb\",\n cursor: \"pointer\",\n fontSize: \"14px\",\n fontWeight: \"500\",\n color: \"#374151\",\n transition: \"all 0.2s ease\",\n gap: \"12px\"\n },\n // Copy button for alerts with copyText\n CopyButton: {\n display: \"inline-flex\",\n alignItems: \"center\",\n gap: \"4px\",\n padding: \"4px 10px\",\n marginTop: \"8px\",\n border: \"1px solid #d1d5db\",\n borderRadius: \"4px\",\n backgroundColor: \"#f9fafb\",\n cursor: \"pointer\",\n fontSize: \"12px\",\n fontWeight: \"500\",\n color: \"#374151\",\n transition: \"all 0.15s ease\",\n fontFamily: \"monospace\"\n },\n CopyButtonCopied: {\n display: \"inline-flex\",\n alignItems: \"center\",\n gap: \"4px\",\n padding: \"4px 10px\",\n marginTop: \"8px\",\n border: \"1px solid #22c55e\",\n borderRadius: \"4px\",\n backgroundColor: \"#f0fdf4\",\n cursor: \"default\",\n fontSize: \"12px\",\n fontWeight: \"500\",\n color: \"#16a34a\",\n fontFamily: \"monospace\"\n },\n // Cancel button for provider selection\n CancelButtonRow: {\n display: \"flex\",\n justifyContent: \"center\",\n marginTop: \"16px\"\n }\n};\n" }, { "path": "addons/dexie-cloud/src/default-ui/index.tsx", "content": "import Dexie from \"dexie\";\nimport \"../extend-dexie-interface\";\nimport { h, Component } from \"preact\";\nimport { from, Subscription } from \"rxjs\";\nimport { LoginDialog } from './LoginDialog';\nimport { DXCUserInteraction } from \"../types/DXCUserInteraction\";\nimport * as preact from \"preact\";\n\nexport interface Props {\n db: Dexie;\n}\n\ninterface State {\n userInteraction: DXCUserInteraction | undefined;\n}\n\nexport default class LoginGui extends Component {\n subscription?: Subscription;\n observer = (userInteraction: DXCUserInteraction | undefined) => this.setState({userInteraction});\n\n constructor(props: Props) {\n super(props);\n this.state = { userInteraction: undefined };\n }\n\n componentDidMount() {\n this.subscription = from(this.props.db.cloud.userInteraction).subscribe(this.observer);\n }\n\n componentWillUnmount() {\n if (this.subscription) {\n this.subscription.unsubscribe();\n delete this.subscription;\n }\n }\n\n render(props: Props, {userInteraction}: State) {\n if (!userInteraction) return null;\n \n // LoginDialog handles all interaction types uniformly\n // (forms with fields, options, or both)\n return ;\n }\n}\n\nexport function setupDefaultGUI(db: Dexie) {\n let closed = false;\n\n const el = document.createElement('div');\n if (document.body) {\n document.body.appendChild(el);\n preact.render(, el);\n } else {\n addEventListener('DOMContentLoaded', ()=>{\n if (!closed) {\n document.body.appendChild(el);\n preact.render(, el);\n }\n });\n }\n\n return {\n unsubscribe() {\n try { el.remove(); } catch {}\n closed = true;\n },\n get closed() {\n return closed;\n }\n }\n}\n" }, { "path": "addons/dexie-cloud/src/define-ydoc-trigger.ts", "content": "import Dexie, {\n RangeSet,\n type DBCore,\n type Middleware,\n type Table,\n} from 'dexie';\nimport { DexieYProvider, YUpdateRow } from 'y-dexie';\nimport type { Doc as YjsDoc } from 'yjs';\n\nconst ydocTriggers: {\n [ydocTable: string]: {\n trigger: (ydoc: YjsDoc, parentId: any) => any;\n parentTable: string;\n prop: string;\n };\n} = {};\n\nconst middlewares = new WeakMap>();\nlet subscribedToProviderBeforeUnload = false;\nconst txRunner = TriggerRunner(\"tx\"); // Trigger registry for transaction completion. Avoids open docs.\nconst unloadRunner = TriggerRunner(\"unload\"); // Trigger registry for unload. Runs when a document is closed.\n\ntype TriggerRegistry = Map<\n string,\n {\n db: Dexie;\n parentTable: string;\n parentId: any;\n prop: string;\n triggers: Set<(ydoc: YjsDoc, parentId: any) => any>;\n }\n>;\n\nfunction TriggerRunner(name: string) {\n let triggerExecPromise: Promise | null = null;\n let triggerScheduled = false;\n let registry: TriggerRegistry = new Map<\n string,\n {\n db: Dexie;\n parentTable: string;\n parentId: any;\n prop: string;\n triggers: Set<(ydoc: YjsDoc, parentId: any) => any>;\n }\n >();\n\n async function execute(registryCopy: TriggerRegistry) {\n for (const {\n db,\n parentId,\n triggers,\n parentTable,\n prop,\n } of registryCopy.values()) {\n const yDoc = DexieYProvider.getOrCreateDocument(\n db,\n parentTable,\n prop,\n parentId\n );\n try {\n const provider = DexieYProvider.load(yDoc); // If doc is open, this would just be a ++refount\n await provider.whenLoaded; // If doc is loaded, this would resolve immediately\n for (const trigger of triggers) {\n await trigger(yDoc, parentId);\n }\n } catch (error) {\n if (error?.name === 'AbortError') {\n // Ignore abort errors. They are expected when the document is closed.\n } else {\n console.error(`Error in YDocTrigger ${error}`);\n }\n } finally {\n DexieYProvider.release(yDoc);\n }\n }\n }\n\n return {\n name,\n async run() {\n console.log(`Running trigger (${name})?`, triggerScheduled, registry.size, !!triggerExecPromise);\n if (!triggerScheduled && registry.size > 0) {\n triggerScheduled = true;\n if (triggerExecPromise) await triggerExecPromise.catch(() => {});\n setTimeout(() => {\n // setTimeout() is to escape from Promise.PSD zones and never run within liveQueries or transaction scopes\n console.log(\"Running trigger really!\", name);\n triggerScheduled = false;\n const registryCopy = registry;\n registry = new Map();\n triggerExecPromise = execute(registryCopy).finally(\n () => {\n triggerExecPromise = null;\n }\n );\n }, 0);\n }\n },\n enqueue(\n db: Dexie,\n parentTable: string,\n parentId: any,\n prop: string,\n trigger: (ydoc: YjsDoc, parentId: any) => any\n ) {\n const key = `${db.name}:${parentTable}:${parentId}:${prop}`;\n let entry = registry.get(key);\n if (!entry) {\n entry = {\n db,\n parentTable,\n parentId,\n prop,\n triggers: new Set(),\n };\n console.log(`Adding trigger ${key}`);\n registry.set(key, entry);\n }\n entry.triggers.add(trigger);\n },\n };\n}\n\nconst createMiddleware: (db: Dexie) => Middleware = (db) => ({\n stack: 'dbcore',\n level: 10,\n name: 'yTriggerMiddleware',\n create: (down) => {\n return {\n ...down,\n transaction: (stores, mode, options) => {\n const idbtrans = down.transaction(stores, mode, options);\n if (mode === 'readonly') return idbtrans;\n if (!stores.some((store) => ydocTriggers[store])) return idbtrans;\n (idbtrans as IDBTransaction).addEventListener(\n 'complete',\n onTransactionCommitted\n );\n return idbtrans;\n },\n table: (updatesTable) => {\n const coreTable = down.table(updatesTable);\n const triggerSpec = ydocTriggers[updatesTable];\n if (!triggerSpec) return coreTable;\n const { trigger, parentTable, prop } = triggerSpec;\n return {\n ...coreTable,\n mutate(req) {\n switch (req.type) {\n case 'add': {\n for (const yUpdateRow of req.values) {\n if (yUpdateRow.k == undefined) continue; // A syncer or garbage collection state does not point to a key\n const primaryKey = (yUpdateRow as YUpdateRow).k;\n const doc = DexieYProvider.getDocCache(db).find(\n parentTable,\n primaryKey,\n prop\n );\n const runner =\n doc && DexieYProvider.for(doc)?.refCount\n ? unloadRunner // Document is open. Wait with trigger until it's closed.\n : txRunner; // Document is closed. Run trigger immediately after transaction commits.\n runner.enqueue(db, parentTable, primaryKey, prop, trigger);\n }\n break;\n }\n case 'delete':\n // @ts-ignore\n if (req.trans._rejecting_y_ypdate) {\n // The deletion came from a rejection, not garbage collection.\n // When that happens, let the triggers run to compute new values\n // based on the deleted updates.\n coreTable\n .getMany({\n keys: req.keys,\n trans: req.trans,\n cache: 'immutable',\n })\n .then((updates) => {\n const keySet = new RangeSet();\n for (const { k } of updates as YUpdateRow[]) {\n if (k != undefined) keySet.addKey(k);\n }\n for (const interval of keySet) {\n txRunner.enqueue(\n db,\n parentTable,\n interval.from,\n prop,\n trigger\n );\n }\n });\n }\n break;\n }\n return coreTable.mutate(req);\n },\n };\n },\n };\n },\n});\n\nfunction onTransactionCommitted() {\n txRunner.run();\n}\n\nfunction beforeProviderUnload() {\n unloadRunner.run();\n}\n\nexport function defineYDocTrigger(\n table: Table,\n prop: keyof T & string,\n trigger: (ydoc: YjsDoc, parentId: TKey) => any\n) {\n const updatesTable = table.schema.yProps?.find(\n (p) => p.prop === prop\n )?.updatesTable;\n if (!updatesTable)\n throw new Error(\n `Table ${table.name} does not have a Yjs property named ${prop}`\n );\n ydocTriggers[updatesTable] = {\n trigger,\n parentTable: table.name,\n prop,\n };\n const db = table.db._novip;\n let mw = middlewares.get(db);\n if (!mw) {\n mw = createMiddleware(db);\n middlewares.set(db, mw);\n }\n db.use(mw);\n\n if (!subscribedToProviderBeforeUnload) {\n DexieYProvider.on('beforeunload', beforeProviderUnload);\n }\n}\n" }, { "path": "addons/dexie-cloud/src/dexie-cloud-addon.ts", "content": "import dexieCloudAddon from './dexie-cloud-client';\nexport * from './dexie-cloud-client';\nexport default dexieCloudAddon;\n" }, { "path": "addons/dexie-cloud/src/dexie-cloud-client.ts", "content": "import Dexie, { liveQuery, Subscription, Table } from 'dexie';\nimport {\n DBPermissionSet,\n DBRealmMember,\n getDbNameFromDbUrl,\n} from 'dexie-cloud-common';\nimport { BehaviorSubject, combineLatest, firstValueFrom, from, fromEvent, Subject } from 'rxjs';\nimport { createDownloadingState, observeBlobProgress } from './sync/blobProgress';\nimport { downloadUnresolvedBlobs } from './sync/eagerBlobDownloader';\nimport { filter, map, skip, startWith, switchMap, take } from 'rxjs/operators';\nimport { login } from './authentication/login';\nimport { UNAUTHORIZED_USER } from './authentication/UNAUTHORIZED_USER';\nimport { DexieCloudDB } from './db/DexieCloudDB';\nimport { PersistedSyncState } from './db/entities/PersistedSyncState';\nimport { DexieCloudOptions } from './DexieCloudOptions';\nimport { DISABLE_SERVICEWORKER_STRATEGY } from './DISABLE_SERVICEWORKER_STRATEGY';\nimport './extend-dexie-interface';\nimport { DexieCloudSyncOptions } from './DexieCloudSyncOptions';\nimport { IS_SERVICE_WORKER } from './helpers/IS_SERVICE_WORKER';\nimport { throwVersionIncrementNeeded } from './helpers/throwVersionIncrementNeeded';\nimport { createIdGenerationMiddleware } from './middlewares/createIdGenerationMiddleware';\nimport { createImplicitPropSetterMiddleware } from './middlewares/createImplicitPropSetterMiddleware';\nimport { createMutationTrackingMiddleware } from './middlewares/createMutationTrackingMiddleware';\nimport { createBlobResolveMiddleware } from './middlewares/blobResolveMiddleware';\n//import { dexieCloudSyncProtocol } from \"./dexieCloudSyncProtocol\";\nimport { overrideParseStoresSpec } from './overrideParseStoresSpec';\nimport { performInitialSync } from './performInitialSync';\nimport { connectWebSocket } from './sync/connectWebSocket';\nimport { isSyncNeeded } from './sync/isSyncNeeded';\nimport { LocalSyncWorker } from './sync/LocalSyncWorker';\nimport {\n registerPeriodicSyncEvent,\n registerSyncEvent,\n} from './sync/registerSyncEvent';\nimport { triggerSync } from './sync/triggerSync';\nimport { DXCUserInteraction } from './types/DXCUserInteraction';\nimport { SyncState } from './types/SyncState';\nimport { updateSchemaFromOptions } from './updateSchemaFromOptions';\nimport { verifySchema } from './verifySchema';\nimport { setupDefaultGUI } from './default-ui';\nimport { DXCWebSocketStatus } from './DXCWebSocketStatus';\nimport { computeSyncState } from './computeSyncState';\nimport { generateKey } from './middleware-helpers/idGenerationHelpers';\nimport { permissions } from './permissions';\nimport { getCurrentUserEmitter } from './currentUserEmitter';\nimport { NewIdOptions } from './types/NewIdOptions';\nimport { getInvitesObservable } from './getInvitesObservable';\nimport { getGlobalRolesObservable } from './getGlobalRolesObservable';\nimport { UserLogin } from './db/entities/UserLogin';\nimport { InvalidLicenseError } from './InvalidLicenseError';\nimport { logout, _logout } from './authentication/logout';\nimport { loadAccessToken } from './authentication/authenticate';\nimport { isEagerSyncDisabled } from './isEagerSyncDisabled';\nimport { createYHandler } from \"./yjs/createYHandler\";\nimport { DexieYProvider } from 'y-dexie';\nimport { parseOAuthCallback, cleanupOAuthUrl } from './authentication/handleOAuthCallback';\nimport { OAuthError } from './errors/OAuthError';\nimport { alertUser } from './authentication/interactWithUser';\nimport { fetchAuthProviders } from './authentication/fetchAuthProviders';\nexport { DexieCloudTable } from './DexieCloudTable';\nexport * from './getTiedRealmId';\nexport {\n DBRealm,\n DBRealmMember,\n DBRealmRole,\n DBSyncedObject,\n DBPermissionSet,\n AuthProvidersResponse,\n OAuthProviderInfo,\n} from 'dexie-cloud-common';\nexport { resolveText } from './helpers/resolveText';\nexport { Invite } from './Invite';\nexport type { UserLogin, DXCWebSocketStatus, SyncState };\nexport type { DexieCloudSyncOptions };\nexport type { DexieCloudOptions, PeriodicSyncOptions } from './DexieCloudOptions';\nexport * from './types/DXCAlert';\nexport * from './types/DXCInputField';\nexport * from './types/DXCUserInteraction';\nexport { defineYDocTrigger } from './define-ydoc-trigger';\n\nconst DEFAULT_OPTIONS: Partial = {\n nameSuffix: true,\n};\n\nexport function dexieCloud(dexie: Dexie) {\n const origIdbName = dexie.name;\n //\n //\n //\n const currentUserEmitter = getCurrentUserEmitter(dexie);\n const subscriptions: Subscription[] = [];\n let configuredProgramatically = false;\n \n // Pending OAuth auth code from dxc-auth redirect (detected in configure())\n let pendingOAuthCode: { code: string; provider: string } | null = null;\n \n // Pending OAuth error from dxc-auth redirect (detected in configure())\n let pendingOAuthError: OAuthError | null = null;\n\n // local sync worker - used when there's no service worker.\n let localSyncWorker: { start: () => void; stop: () => void } | null = null;\n dexie.on(\n 'ready',\n async (dexie: Dexie) => {\n try {\n await onDbReady(dexie);\n } catch (error) {\n console.error(error);\n // Make sure to succeed with database open even if network is down.\n }\n },\n true // true = sticky\n );\n\n /** Void starting subscribers after a close has happened. */\n let closed = false;\n function throwIfClosed() {\n if (closed) throw new Dexie.DatabaseClosedError();\n }\n\n dexie.once('close', () => {\n subscriptions.forEach((subscription) => subscription.unsubscribe());\n subscriptions.splice(0, subscriptions.length);\n closed = true;\n localSyncWorker && localSyncWorker.stop();\n localSyncWorker = null;\n currentUserEmitter.next(UNAUTHORIZED_USER);\n });\n\n const syncComplete = new Subject();\n const downloading$ = createDownloadingState();\n\n dexie.cloud = {\n // @ts-ignore\n version: __VERSION__,\n options: { ...DEFAULT_OPTIONS } as DexieCloudOptions,\n schema: null,\n get currentUserId() {\n return currentUserEmitter.value.userId || UNAUTHORIZED_USER.userId!;\n },\n currentUser: currentUserEmitter,\n syncState: new BehaviorSubject({\n phase: 'initial',\n status: 'not-started',\n }),\n\n events: {\n syncComplete,\n },\n\n persistedSyncState: new BehaviorSubject(\n undefined\n ),\n blobProgress: observeBlobProgress(DexieCloudDB(dexie), downloading$),\n userInteraction: new BehaviorSubject(\n undefined\n ),\n webSocketStatus: new BehaviorSubject('not-started'),\n async login(hint) {\n const db = DexieCloudDB(dexie);\n await db.cloud.sync();\n await login(db, hint);\n },\n invites: getInvitesObservable(dexie),\n roles: getGlobalRolesObservable(dexie),\n configure(options: DexieCloudOptions) {\n // Validate maxStringLength — Infinity disables offloading, otherwise must be\n // a finite number between 100 and the server limit (32768).\n // Minimum 100 prevents accidental offloading of primary keys and short strings\n // that would break sync.\n const MIN_STRING_LENGTH = 100;\n const MAX_SERVER_STRING_LENGTH = 32768;\n if (\n options.maxStringLength !== undefined &&\n options.maxStringLength !== Infinity &&\n (!Number.isFinite(options.maxStringLength) ||\n options.maxStringLength < MIN_STRING_LENGTH ||\n options.maxStringLength > MAX_SERVER_STRING_LENGTH)\n ) {\n throw new Error(\n `maxStringLength must be Infinity or a finite number in [${MIN_STRING_LENGTH}, ${MAX_SERVER_STRING_LENGTH}]. Got: ${options.maxStringLength}`\n );\n }\n options = dexie.cloud.options = { ...dexie.cloud.options, ...options };\n configuredProgramatically = true;\n if (options.databaseUrl && options.nameSuffix) {\n // @ts-ignore\n dexie.name = `${origIdbName}-${getDbNameFromDbUrl(\n options.databaseUrl\n )}`;\n DexieCloudDB(dexie).reconfigure(); // Update observable from new dexie.name\n }\n updateSchemaFromOptions(dexie.cloud.schema, dexie.cloud.options);\n \n // Check for OAuth callback (dxc-auth query parameter)\n // Only check in DOM environment, not workers\n if (typeof window !== 'undefined' && window.location) {\n try {\n const callback = parseOAuthCallback();\n if (callback) {\n // Store the pending auth code for processing when db is ready\n pendingOAuthCode = { code: callback.code, provider: callback.provider };\n console.debug('[dexie-cloud] OAuth callback detected, auth code stored for processing');\n }\n } catch (error) {\n // parseOAuthCallback throws OAuthError on error callbacks\n if (error instanceof OAuthError) {\n pendingOAuthError = error;\n console.error('[dexie-cloud] OAuth callback error:', error.message);\n } else {\n console.error('[dexie-cloud] OAuth callback error:', error);\n }\n }\n }\n },\n async logout({ force } = {}) {\n force\n ? await _logout(DexieCloudDB(dexie), { deleteUnsyncedData: true })\n : await logout(DexieCloudDB(dexie));\n },\n async getAuthProviders() {\n const options = dexie.cloud.options;\n if (!options?.databaseUrl) {\n throw new Error('Dexie Cloud not configured. Call db.cloud.configure() first.');\n }\n const socialAuthEnabled = options.socialAuth !== false;\n return fetchAuthProviders(options.databaseUrl, socialAuthEnabled);\n },\n async sync(\n { wait, purpose }: DexieCloudSyncOptions = { wait: true, purpose: 'push' }\n ) {\n if (wait === undefined) wait = true;\n const db = DexieCloudDB(dexie);\n const licenseStatus = db.cloud.currentUser.value.license?.status || 'ok';\n if (licenseStatus !== 'ok') {\n // Refresh access token to check for updated license\n await loadAccessToken(db);\n }\n if (purpose === 'pull') {\n const syncState = db.cloud.persistedSyncState.value;\n triggerSync(db, purpose);\n if (wait) {\n const newSyncState = await firstValueFrom(\n db.cloud.persistedSyncState.pipe(\n filter(\n (newSyncState) =>\n newSyncState?.timestamp != null &&\n (!syncState || newSyncState.timestamp > syncState.timestamp!)\n )\n )\n );\n if (newSyncState?.error) {\n throw new Error(`Sync error: ` + newSyncState.error);\n }\n }\n } else if (await isSyncNeeded(db)) {\n const syncState = db.cloud.persistedSyncState.value;\n triggerSync(db, purpose);\n if (wait) {\n console.debug('db.cloud.login() is waiting for sync completion...');\n await firstValueFrom(\n from(\n liveQuery(async () => {\n const syncNeeded = await isSyncNeeded(db);\n const newSyncState = await db.getPersistedSyncState();\n if (\n newSyncState?.timestamp !== syncState?.timestamp &&\n newSyncState?.error\n )\n throw new Error(`Sync error: ` + newSyncState.error);\n return syncNeeded;\n })\n ).pipe(filter((isNeeded) => !isNeeded))\n );\n console.debug(\n 'Done waiting for sync completion because we have nothing to push anymore'\n );\n }\n }\n },\n permissions(\n obj: { owner: string; realmId: string; table?: () => string },\n tableName?: string\n ) {\n return permissions(dexie._novip, obj, tableName);\n },\n };\n\n dexie.Version.prototype['_parseStoresSpec'] = Dexie.override(\n dexie.Version.prototype['_parseStoresSpec'],\n (origFunc) => overrideParseStoresSpec(origFunc, dexie)\n );\n\n dexie.Table.prototype.newId = function (\n this: Table,\n { colocateWith }: NewIdOptions = {}\n ) {\n const shardKey =\n colocateWith && colocateWith.substr(colocateWith.length - 3);\n return generateKey(dexie.cloud.schema![this.name].idPrefix || '', shardKey);\n };\n\n dexie.Table.prototype.idPrefix = function (this: Table) {\n return this.db.cloud.schema?.[this.name]?.idPrefix || '';\n };\n\n dexie.use(createBlobResolveMiddleware(DexieCloudDB(dexie)));\n dexie.use(\n createMutationTrackingMiddleware({\n currentUserObservable: dexie.cloud.currentUser,\n db: DexieCloudDB(dexie),\n })\n );\n dexie.use(createImplicitPropSetterMiddleware(DexieCloudDB(dexie)));\n dexie.use(createIdGenerationMiddleware(DexieCloudDB(dexie)));\n\n async function onDbReady(dexie: Dexie) {\n closed = false; // As Dexie calls us, we are not closed anymore. Maybe reopened? Remember db.ready event is registered with sticky flag!\n const db = DexieCloudDB(dexie);\n // Setup default GUI:\n if (typeof window !== 'undefined' && typeof document !== 'undefined') {\n if (!db.cloud.options?.customLoginGui) {\n subscriptions.push(setupDefaultGUI(dexie));\n }\n }\n if (!db.cloud.isServiceWorkerDB) {\n subscriptions.push(computeSyncState(db).subscribe(dexie.cloud.syncState));\n }\n\n // Forward db.syncCompleteEvent to be publicly consumable via db.cloud.events.syncComplete:\n subscriptions.push(db.syncCompleteEvent.subscribe(syncComplete));\n\n // Eager blob download: When blobMode='eager' (default), download unresolved blobs after sync\n const blobMode = db.cloud.options?.blobMode ?? 'eager';\n if (blobMode === 'eager') {\n let eagerBlobDownloadInFlight: Promise | null = null;\n const downloadBlobs = () => {\n if (eagerBlobDownloadInFlight) return;\n eagerBlobDownloadInFlight = Dexie.ignoreTransaction(\n () => downloadUnresolvedBlobs(db, downloading$)\n )\n .catch(err => {\n console.error('[dexie-cloud] Eager blob download failed:', err);\n })\n .finally(() => {\n eagerBlobDownloadInFlight = null;\n });\n };\n setTimeout(downloadBlobs, 0); // Don't block ready event. Start downloading blobs in the background right after.\n // And also after every sync completes:\n subscriptions.push(db.syncCompleteEvent.subscribe(downloadBlobs));\n }\n\n\n //verifyConfig(db.cloud.options); Not needed (yet at least!)\n // Verify the user has allowed version increment.\n if (!db.tables.every((table) => table.core)) {\n throwVersionIncrementNeeded();\n }\n const swRegistrations =\n 'serviceWorker' in navigator\n ? await navigator.serviceWorker.getRegistrations()\n : [];\n\n const [initiallySynced, lastSyncedRealms] = await db.transaction(\n 'rw',\n db.$syncState,\n async () => {\n const { options, schema } = db.cloud;\n const [persistedOptions, persistedSchema, persistedSyncState] =\n await Promise.all([\n db.getOptions(),\n db.getSchema(),\n db.getPersistedSyncState(),\n ]);\n if (!configuredProgramatically) {\n // Options not specified programatically (use case for SW!)\n // Take persisted options:\n db.cloud.options = persistedOptions || null;\n } else if (\n !persistedOptions ||\n JSON.stringify(persistedOptions) !== JSON.stringify(options)\n ) {\n // Update persisted options:\n if (!options) throw new Error(`Internal error`); // options cannot be null if configuredProgramatically is set.\n const newPersistedOptions: DexieCloudOptions = {\n ...options,\n };\n delete newPersistedOptions.fetchTokens;\n delete newPersistedOptions.awarenessProtocol;\n await db.$syncState.put(newPersistedOptions, 'options');\n }\n if (\n db.cloud.options?.tryUseServiceWorker &&\n 'serviceWorker' in navigator &&\n swRegistrations.length > 0 &&\n !DISABLE_SERVICEWORKER_STRATEGY\n ) {\n // * Configured for using service worker if available.\n // * Browser supports service workers\n // * There are at least one service worker registration\n console.debug('Dexie Cloud Addon: Using service worker');\n db.cloud.usingServiceWorker = true;\n } else {\n // Not configured for using service worker or no service worker\n // registration exists. Don't rely on service worker to do any job.\n // Use LocalSyncWorker instead.\n if (\n db.cloud.options?.tryUseServiceWorker &&\n !db.cloud.isServiceWorkerDB\n ) {\n console.debug(\n 'dexie-cloud-addon: Not using service worker.',\n swRegistrations.length === 0\n ? 'No SW registrations found.'\n : 'serviceWorker' in navigator && DISABLE_SERVICEWORKER_STRATEGY\n ? 'Avoiding SW background sync and SW periodic bg sync for this browser due to browser bugs.'\n : 'navigator.serviceWorker not present'\n );\n }\n db.cloud.usingServiceWorker = false;\n }\n updateSchemaFromOptions(schema, db.cloud.options);\n updateSchemaFromOptions(persistedSchema, db.cloud.options);\n if (!schema) {\n // Database opened dynamically (use case for SW!)\n // Take persisted schema:\n db.cloud.schema = persistedSchema || null;\n } else if (\n !persistedSchema ||\n JSON.stringify(persistedSchema) !== JSON.stringify(schema)\n ) {\n // Update persisted schema (but don't overwrite table prefixes)\n const newPersistedSchema = persistedSchema || {};\n for (const [table, tblSchema] of Object.entries(schema)) {\n const newTblSchema = newPersistedSchema[table];\n if (!newTblSchema) {\n newPersistedSchema[table] = { ...tblSchema };\n } else {\n newTblSchema.markedForSync = tblSchema.markedForSync;\n tblSchema.deleted = newTblSchema.deleted;\n newTblSchema.generatedGlobalId = tblSchema.generatedGlobalId;\n }\n }\n await db.$syncState.put(newPersistedSchema, 'schema');\n\n // Make sure persisted table prefixes are being used instead of computed ones:\n // Let's assign all props as the newPersistedSchems should be what we should be working with.\n Object.assign(schema, newPersistedSchema);\n }\n return [persistedSyncState?.initiallySynced, persistedSyncState?.realms];\n }\n );\n\n if (initiallySynced) {\n db.setInitiallySynced(true);\n }\n\n verifySchema(db);\n\n // Manage CurrentUser observable:\n throwIfClosed();\n if (!db.cloud.isServiceWorkerDB) {\n subscriptions.push(\n liveQuery(() => db.getCurrentUser().then(user => {\n if (!user.isLoggedIn && typeof location !== 'undefined' && /dxc-auth\\=/.test(location.search)) {\n // Still loading user because OAuth redirect just happened.\n // Keep isLoading true.\n return { ...user, isLoading: true };\n }\n return user;\n })).subscribe(currentUserEmitter)\n );\n // Manage PersistendSyncState observable:\n subscriptions.push(\n liveQuery(() => db.getPersistedSyncState()).subscribe(\n db.cloud.persistedSyncState\n )\n );\n // Wait till currentUser and persistedSyncState gets populated\n // with things from the database and not just the default values.\n // This is so that when db.open() completes, user should be safe\n // to subscribe to these observables and get actual data.\n await firstValueFrom(combineLatest([\n currentUserEmitter.pipe(skip(1), take(1)),\n db.cloud.persistedSyncState.pipe(skip(1), take(1)),\n ]));\n\n const yHandler = createYHandler(db);\n DexieYProvider.on.new.subscribe(yHandler);\n db.dx.once('close', () => {\n DexieYProvider.on.new.unsubscribe(yHandler);\n });\n }\n\n // HERE: If requireAuth, do athentication now.\n let changedUser = false;\n let user = await db.getCurrentUser();\n \n // Show pending OAuth error if present (from dxc-auth redirect)\n if (pendingOAuthError && !db.cloud.isServiceWorkerDB) {\n const error = pendingOAuthError;\n pendingOAuthError = null; // Clear pending error\n console.debug('[dexie-cloud] Showing OAuth error:', error.message);\n // Show alert to user about the OAuth error\n // Guard so UI errors don't abort initialization\n try {\n await alertUser(db.cloud.userInteraction, 'Authentication Error', {\n type: 'error',\n messageCode: 'GENERIC_ERROR',\n message: error.message,\n messageParams: { provider: error.provider || 'unknown' }\n });\n // Clean up URL (remove dxc-auth param)\n cleanupOAuthUrl();\n } catch (uiError) {\n console.error('[dexie-cloud] Failed to show OAuth error alert:', uiError);\n }\n }\n \n // Process pending OAuth callback if present (from dxc-auth redirect)\n if (pendingOAuthCode && !db.cloud.isServiceWorkerDB) {\n const { code, provider } = pendingOAuthCode;\n pendingOAuthCode = null; // Clear pending code\n console.debug('[dexie-cloud] Processing OAuth callback, provider:', provider);\n try {\n changedUser = await login(db, { oauthCode: code, provider });\n user = await db.getCurrentUser();\n // Clean up URL (remove dxc-auth param)\n cleanupOAuthUrl();\n } catch (error) {\n console.error('[dexie-cloud] OAuth login failed:', error);\n // Continue with normal flow - user can try again\n }\n }\n \n const requireAuth = db.cloud.options?.requireAuth;\n if (requireAuth) {\n if (db.cloud.isServiceWorkerDB) {\n // If this is a service worker DB, we can't do authentication here,\n // we just wait until the application has done it.\n console.debug('Dexie Cloud Service worker. Waiting for application to authenticate.');\n await firstValueFrom(currentUserEmitter.pipe(filter((user) => !!user.isLoggedIn), take(1)));\n console.debug('Dexie Cloud Service worker. Application has authenticated.');\n } else {\n if (typeof requireAuth === 'object') {\n // requireAuth contains login hints. Check if we already fulfil it:\n if (\n !user.isLoggedIn ||\n (requireAuth.userId && user.userId !== requireAuth.userId) ||\n (requireAuth.email && user.email !== requireAuth.email)\n ) {\n // If not, login the configured user:\n changedUser = await login(db, requireAuth);\n }\n } else if (!user.isLoggedIn) {\n // requireAuth is true and user is not logged in\n changedUser = await login(db);\n }\n }\n }\n if (user.isLoggedIn && (!lastSyncedRealms || !lastSyncedRealms.includes(user.userId!))) {\n // User has been logged in but this is not reflected in the sync state.\n // This can happen if page is reloaded after login but before the sync call following\n // the login was complete.\n // The user is to be viewed as changed becuase current syncState does not reflect the presence\n // of the logged-in user.\n changedUser = true; // Set changedUser to true to trigger a pull-sync later down.\n }\n\n if (localSyncWorker) localSyncWorker.stop();\n localSyncWorker = null;\n throwIfClosed();\n\n const doInitialSync = db.cloud.options?.databaseUrl && (!initiallySynced || changedUser);\n if (doInitialSync) {\n // Do the initial sync directly in the browser thread no matter if we are using service worker or not.\n await performInitialSync(db, db.cloud.options!, db.cloud.schema!);\n db.setInitiallySynced(true);\n }\n\n throwIfClosed();\n if (db.cloud.usingServiceWorker && db.cloud.options?.databaseUrl) {\n if (!doInitialSync) {\n registerSyncEvent(db, 'push').catch(() => {});\n }\n registerPeriodicSyncEvent(db).catch(() => {});\n } else if (\n db.cloud.options?.databaseUrl &&\n db.cloud.schema &&\n !db.cloud.isServiceWorkerDB\n ) {\n // There's no SW. Start SyncWorker instead.\n localSyncWorker = LocalSyncWorker(db, db.cloud.options, db.cloud.schema!);\n localSyncWorker.start();\n if (!doInitialSync) {\n triggerSync(db, 'push');\n }\n }\n\n // Listen to online event and do sync.\n throwIfClosed();\n if (!db.cloud.isServiceWorkerDB) {\n subscriptions.push(\n fromEvent(self, 'online').subscribe(() => {\n console.debug('online!');\n db.syncStateChangedEvent.next({\n phase: 'not-in-sync',\n });\n if (!isEagerSyncDisabled(db)) {\n triggerSync(db, 'push');\n }\n }),\n fromEvent(self, 'offline').subscribe(() => {\n console.debug('offline!');\n db.syncStateChangedEvent.next({\n phase: 'offline',\n });\n })\n );\n }\n\n // Connect WebSocket unless we are in a service worker or websocket is disabled.\n if (\n db.cloud.options?.databaseUrl &&\n !db.cloud.options?.disableWebSocket &&\n !IS_SERVICE_WORKER\n ) {\n subscriptions.push(connectWebSocket(db));\n }\n }\n}\n\n// @ts-ignore\ndexieCloud.version = __VERSION__;\n\nDexie.Cloud = dexieCloud;\n\nexport default dexieCloud;\n" }, { "path": "addons/dexie-cloud/src/errors/HttpError.ts", "content": "export class HttpError extends Error {\n httpStatus: number;\n constructor(\n res: Response,\n message?: string)\n {\n super(message || `${res.status} ${res.statusText}`);\n this.httpStatus = res.status;\n }\n\n get name() {\n return \"HttpError\";\n }\n}\n" }, { "path": "addons/dexie-cloud/src/errors/OAuthError.ts", "content": "/** OAuth-specific error codes */\nexport type OAuthErrorCode =\n | 'access_denied'\n | 'invalid_state'\n | 'email_not_verified'\n | 'expired_code'\n | 'provider_error'\n | 'network_error';\n\n/** User-friendly messages for OAuth error codes */\nconst ERROR_MESSAGES: Record = {\n access_denied: 'Access was denied by the authentication provider.',\n invalid_state: 'The authentication response could not be verified. Please try again.',\n email_not_verified: 'Your email address must be verified before you can log in.',\n expired_code: 'The authentication code has expired. Please try again.',\n provider_error: 'An error occurred with the authentication provider.',\n network_error: 'A network error occurred during authentication. Please check your connection and try again.',\n};\n\n/** Error class for OAuth-specific errors */\nexport class OAuthError extends Error {\n readonly code: OAuthErrorCode;\n readonly provider?: string;\n\n constructor(code: OAuthErrorCode, provider?: string, customMessage?: string) {\n super(customMessage || ERROR_MESSAGES[code]);\n this.name = 'OAuthError';\n this.code = code;\n this.provider = provider;\n }\n\n /** Get user-friendly message for this error */\n get userMessage(): string {\n return ERROR_MESSAGES[this.code] || this.message;\n }\n}\n" }, { "path": "addons/dexie-cloud/src/errors/OAuthRedirectError.ts", "content": "/**\n * Error thrown when initiating an OAuth redirect.\n * \n * This is not a real error - it's used to signal that the page is\n * navigating away to an OAuth provider. It should be caught and\n * silently ignored at the appropriate level.\n */\nexport class OAuthRedirectError extends Error {\n readonly provider: string;\n \n constructor(provider: string) {\n super(`OAuth redirect initiated for provider: ${provider}`);\n this.name = 'OAuthRedirectError';\n this.provider = provider;\n }\n}\n" }, { "path": "addons/dexie-cloud/src/extend-dexie-interface.ts", "content": "import { IndexableType, TableProp } from 'dexie';\nimport {\n DBRealm,\n DBRealmMember,\n DBRealmRole,\n} from 'dexie-cloud-common';\nimport { Member } from './db/entities/Member';\nimport { Role } from './db/entities/Role';\nimport { EntityCommon } from './db/entities/EntityCommon';\nimport { DexieCloudAPI } from './DexieCloudAPI';\nimport { DexieCloudTable } from './DexieCloudTable';\nimport { NewIdOptions } from './types/NewIdOptions';\n\ntype Optional = Omit & Partial;\n\n//\n// Extend Dexie interface\n//\ndeclare module 'dexie' {\n interface Dexie {\n cloud: DexieCloudAPI;\n realms: Table>;\n members: Table>;\n roles: Table>;\n }\n\n interface Table {\n newId(options: NewIdOptions): string;\n idPrefix(): string;\n }\n\n interface DexieConstructor {\n Cloud: {\n (db: Dexie): void;\n\n version: string;\n };\n }\n}\n" }, { "path": "addons/dexie-cloud/src/getGlobalRolesObservable.ts", "content": "import Dexie, { liveQuery } from 'dexie';\nimport { DBRealmRole } from 'dexie-cloud-common';\nimport { associate } from './associate';\nimport { createSharedValueObservable } from './createSharedValueObservable';\n\nexport const getGlobalRolesObservable = associate((db: Dexie) => {\n return createSharedValueObservable(\n liveQuery(() =>\n db.roles\n .where({ realmId: 'rlm-public' })\n .toArray()\n .then((roles) => {\n const rv: { [roleName: string]: DBRealmRole } = {};\n for (const role of roles\n .slice()\n .sort((a, b) => (a.sortOrder || 0) - (b.sortOrder || 0))) {\n rv[role.name] = role;\n }\n return rv;\n })\n ),\n {}\n );\n});\n" }, { "path": "addons/dexie-cloud/src/getInternalAccessControlObservable.ts", "content": "import Dexie, { liveQuery } from 'dexie';\nimport { DBRealm, DBRealmMember } from 'dexie-cloud-common';\nimport { concat, Observable, timer } from 'rxjs';\nimport { share, switchMap } from 'rxjs/operators';\nimport { associate } from './associate';\nimport { createSharedValueObservable } from './createSharedValueObservable';\nimport { getCurrentUserEmitter } from './currentUserEmitter';\n\nexport type InternalAccessControlData = {\n readonly selfMembers: DBRealmMember[];\n readonly realms: DBRealm[];\n readonly userId: string;\n};\n\nexport const getInternalAccessControlObservable = associate((db: Dexie) => {\n return createSharedValueObservable(\n getCurrentUserEmitter(db._novip).pipe(\n switchMap((currentUser) =>\n liveQuery(() =>\n db.transaction('r', 'realms', 'members', () =>\n Promise.all([\n db.members.where({ userId: currentUser.userId }).toArray(),\n db.realms.toArray(),\n currentUser.userId!,\n ] as const).then(([selfMembers, realms, userId]) => {\n //console.debug(`PERMS: Result from liveQUery():`, JSON.stringify({selfMembers, realms, userId}, null, 2))\n return { selfMembers, realms, userId };\n })\n )\n )\n )\n ), {\n selfMembers: [],\n realms: [],\n get userId() {\n return db.cloud.currentUserId;\n },\n }\n );\n /* let refCount = 0;\n return new Observable(observer => {\n const subscription = o.subscribe(observer);\n console.debug ('PERMS subscribe', ++refCount);\n return {\n unsubscribe() {\n console.debug ('PERMS unsubscribe', --refCount);\n subscription.unsubscribe();\n }\n }\n })*/\n});\n" }, { "path": "addons/dexie-cloud/src/getInvitesObservable.ts", "content": "import { Dexie, liveQuery } from 'dexie';\nimport { DBRealmMember } from 'dexie-cloud-common';\nimport { combineLatest } from 'rxjs';\nimport { map, switchMap } from 'rxjs/operators';\nimport { associate } from './associate';\nimport { createSharedValueObservable } from './createSharedValueObservable';\nimport { getCurrentUserEmitter } from './currentUserEmitter';\nimport { getInternalAccessControlObservable } from './getInternalAccessControlObservable';\nimport { getPermissionsLookupObservable } from './getPermissionsLookupObservable';\nimport { Invite } from './Invite';\nimport { mapValueObservable } from './mapValueObservable';\n\nexport const getInvitesObservable = associate((db: Dexie) => {\n const membersByEmail = getCurrentUserEmitter(db._novip).pipe(\n switchMap((currentUser) =>\n liveQuery(() =>\n db.members.where({ email: currentUser.email || '' }).toArray()\n )\n )\n );\n const permissions = getPermissionsLookupObservable(db._novip);\n const accessControl = getInternalAccessControlObservable(db._novip);\n return createSharedValueObservable(\n combineLatest([membersByEmail, accessControl, permissions]).pipe(\n map(([membersByEmail, accessControl, realmLookup]) => {\n const reducer = (\n result: { [id: string]: Invite },\n m: DBRealmMember\n ) => ({ ...result, [m.id!]: { ...m, realm: realmLookup[m.realmId] } });\n const emailMembersById = membersByEmail.reduce(reducer, {});\n const membersById = accessControl.selfMembers.reduce(\n reducer,\n emailMembersById\n );\n return Object.values(membersById)\n .filter((invite: DBRealmMember) => !invite.accepted)\n .map(\n (invite: DBRealmMember) =>\n ({\n ...invite,\n async accept() {\n await db.members.update(invite.id!, { accepted: new Date() });\n },\n async reject() {\n await db.members.update(invite.id!, { rejected: new Date() });\n },\n } satisfies Invite)\n );\n })\n ),\n []\n );\n});\n" }, { "path": "addons/dexie-cloud/src/getPermissionsLookupObservable.ts", "content": "import Dexie from 'dexie';\nimport { DBPermissionSet, DBRealm, DBRealmMember } from 'dexie-cloud-common';\nimport { combineLatest, Observable } from 'rxjs';\nimport { map, startWith, tap } from 'rxjs/operators';\nimport { associate } from './associate';\nimport { UNAUTHORIZED_USER } from './authentication/UNAUTHORIZED_USER';\nimport { createSharedValueObservable } from './createSharedValueObservable';\nimport { getGlobalRolesObservable } from './getGlobalRolesObservable';\nimport { getInternalAccessControlObservable } from './getInternalAccessControlObservable';\nimport { flatten } from './helpers/flatten';\nimport { mapValueObservable } from './mapValueObservable';\nimport { mergePermissions } from './mergePermissions';\n\nexport type PermissionsLookup = {\n [realmId: string]: DBRealm & { permissions: DBPermissionSet };\n};\n\nexport type PermissionsLookupObservable = Observable & {\n getValue(): PermissionsLookup;\n};\n\nexport const getPermissionsLookupObservable = associate((db: Dexie) => {\n const o = createSharedValueObservable(\n combineLatest([\n getInternalAccessControlObservable(db._novip),\n getGlobalRolesObservable(db._novip),\n ]).pipe(\n map(([{ selfMembers, realms, userId }, globalRoles]) => ({\n selfMembers,\n realms,\n userId,\n globalRoles,\n }))\n ),\n {\n selfMembers: [],\n realms: [],\n userId: UNAUTHORIZED_USER.userId!,\n globalRoles: {},\n }\n );\n\n return mapValueObservable(\n o,\n ({ selfMembers, realms, userId, globalRoles }) => {\n const rv = realms\n .map((realm) => {\n const selfRealmMembers = selfMembers.filter(\n (m) => m.realmId === realm.realmId\n );\n const directPermissionSets = selfRealmMembers\n .map((m) => m.permissions!)\n .filter((p) => p);\n const rolePermissionSets = flatten(\n selfRealmMembers.map((m) => m.roles!).filter((roleName) => roleName)\n )\n .map((role) => globalRoles[role]!)\n .filter((role) => role)\n .map((role) => role.permissions);\n\n return {\n ...realm,\n permissions:\n realm.owner === userId\n ? ({ manage: '*' } as DBPermissionSet)\n : mergePermissions(\n ...directPermissionSets,\n ...rolePermissionSets\n ),\n };\n })\n .reduce((p, c) => ({ ...p, [c.realmId]: c }), {\n [userId!]: {\n realmId: userId,\n owner: userId,\n name: userId,\n permissions: { manage: '*' },\n } as DBRealm & { permissions: DBPermissionSet },\n });\n return rv;\n }\n );\n});\n" }, { "path": "addons/dexie-cloud/src/getTiedRealmId.ts", "content": "\nexport function getTiedRealmId(objectId: string) {\n return 'rlm~' + objectId;\n}\n\nexport function getTiedObjectId(realmId: string) {\n return realmId.startsWith('rlm~') ? realmId.substr(4) : null;\n}\n" }, { "path": "addons/dexie-cloud/src/helpers/BroadcastedAndLocalEvent.ts", "content": "import { Observable } from \"rxjs\";\nimport { SWBroadcastChannel } from \"./SWBroadcastChannel\";\n\nconst events: Mapvoid>> =\n globalThis['lbc-events'] || (globalThis['lbc-events'] = new Mapvoid>>());\n\nfunction addListener(name: string, listener: (ev: CustomEvent)=>void) {\n if (events.has(name)) {\n events.get(name)!.push(listener);\n } else {\n events.set(name, [listener]);\n }\n}\nfunction removeListener(name: string, listener: (ev: CustomEvent)=>void) {\n const listeners = events.get(name);\n if (listeners) {\n const idx = listeners.indexOf(listener);\n if (idx !== -1) {\n listeners.splice(idx, 1);\n }\n }\n}\nfunction dispatch(ev: CustomEvent) {\n const listeners = events.get(ev.type);\n if (listeners) {\n listeners.forEach(listener => {\n try {\n listener(ev);\n } catch {\n }\n });\n }\n}\n\nexport class BroadcastedAndLocalEvent extends Observable{\n name: string;\n bc: BroadcastChannel | SWBroadcastChannel\n\n constructor(name: string) {\n const bc = typeof BroadcastChannel === \"undefined\"\n ? new SWBroadcastChannel(name) : new BroadcastChannel(name);\n super(subscriber => {\n function onCustomEvent(ev: CustomEvent) {\n subscriber.next(ev.detail);\n }\n function onMessageEvent(ev: MessageEvent) {\n console.debug(\"BroadcastedAndLocalEvent: onMessageEvent\", ev);\n subscriber.next(ev.data);\n }\n let unsubscribe: ()=>void;\n //self.addEventListener(`lbc-${name}`, onCustomEvent); // Fails in service workers\n addListener(`lbc-${name}`, onCustomEvent); // Works better in service worker\n\n try { \n if (bc instanceof SWBroadcastChannel) {\n unsubscribe = bc.subscribe(message => subscriber.next(message));\n } else {\n console.debug(\"BroadcastedAndLocalEvent: bc.addEventListener()\", name, \"bc is a\", bc);\n bc.addEventListener(\"message\", onMessageEvent);\n }\n } catch (err) {\n // Service workers might fail to subscribe outside its initial script.\n console.warn('Failed to subscribe to broadcast channel', err);\n }\n return () => {\n //self.removeEventListener(`lbc-${name}`, onCustomEvent);\n removeListener(`lbc-${name}`, onCustomEvent);\n if (bc instanceof SWBroadcastChannel) {\n unsubscribe!();\n } else {\n bc.removeEventListener(\"message\", onMessageEvent);\n }\n }\n });\n this.name = name;\n this.bc = bc;\n }\n\n next(message: T) {\n console.debug(\"BroadcastedAndLocalEvent: bc.postMessage()\", {...message}, \"bc is a\", this.bc);\n this.bc.postMessage(message);\n const ev = new CustomEvent(`lbc-${this.name}`, { detail: message });\n //self.dispatchEvent(ev);\n dispatch(ev);\n }\n}\n" }, { "path": "addons/dexie-cloud/src/helpers/CancelToken.ts", "content": "import Dexie from \"dexie\";\n\nexport interface CancelToken {\n cancelled: boolean;\n}\n\nexport function throwIfCancelled(cancelToken?: CancelToken) {\n if (cancelToken?.cancelled) throw new Dexie.AbortError(`Operation was cancelled`);\n}\n" }, { "path": "addons/dexie-cloud/src/helpers/IS_SERVICE_WORKER.ts", "content": "export const IS_SERVICE_WORKER =\n typeof self !== \"undefined\" && \"clients\" in self && !self.document;\n" }, { "path": "addons/dexie-cloud/src/helpers/SWBroadcastChannel.ts", "content": "const swHolder: { registration?: ServiceWorkerRegistration } = {};\nconst swContainer = typeof self !== 'undefined' && self.document && // self.document is to verify we're not the SW ourself\n typeof navigator !== 'undefined' && navigator.serviceWorker; \nif (swContainer)\n swContainer.ready.then(\n (registration) => (swHolder.registration = registration)\n );\n\nif (typeof self !== 'undefined' && 'clients' in self && !self.document) {\n // We are the service worker. Propagate messages to all our clients.\n addEventListener('message', (ev: any) => {\n if (ev.data?.type?.startsWith('sw-broadcast-')) {\n [...self['clients'].matchAll({ includeUncontrolled: true })].forEach(\n (client) => client.id !== ev.source?.id && client.postMessage(ev.data)\n );\n }\n });\n}\n\n/** This class is a fallback for browsers that lacks BroadcastChannel but have\n * service workers (which is Safari versions 11.1 through 15.3).\n * Safari 15.4 with BroadcastChannel was released on 2022-03-14.\n * We might be able to remove this class in a near future as Safari < 15.4 is\n * already very low in market share as of 2023-03-10.\n */\nexport class SWBroadcastChannel {\n name: string;\n constructor(name: string) {\n this.name = name;\n }\n subscribe(listener: (message: any) => void) {\n if (!swContainer) return () => {};\n const forwarder = (ev: MessageEvent) => {\n if (ev.data?.type === `sw-broadcast-${this.name}`) {\n listener(ev.data.message);\n }\n };\n swContainer.addEventListener('message', forwarder);\n return () => swContainer.removeEventListener('message', forwarder);\n }\n postMessage(message: any) {\n if (typeof self['clients'] === 'object') {\n // We're a service worker. Propagate to our browser clients.\n [...self['clients'].matchAll({ includeUncontrolled: true })].forEach(\n (client) =>\n client.postMessage({\n type: `sw-broadcast-${this.name}`,\n message,\n })\n );\n } else if (swHolder.registration) {\n // We're a client (browser window or other worker)\n // Post to SW so it can repost to all its clients and to itself\n swHolder.registration.active?.postMessage({\n type: `sw-broadcast-${this.name}`,\n message,\n });\n }\n }\n}\n" }, { "path": "addons/dexie-cloud/src/helpers/allSettled.ts", "content": "\nexport function allSettled(possiblePromises: any[]) {\n return new Promise(resolve => {\n if (possiblePromises.length === 0) resolve([]);\n let remaining = possiblePromises.length;\n const results = new Array(remaining);\n possiblePromises.forEach((p, i) => Promise.resolve(p).then(\n value => results[i] = {status: \"fulfilled\", value},\n reason => results[i] = {status: \"rejected\", reason})\n .then(()=>--remaining || resolve(results)));\n });\n}\n" }, { "path": "addons/dexie-cloud/src/helpers/bulkUpdate.ts", "content": "import Dexie, { Table, cmp } from 'dexie';\n\nexport async function bulkUpdate(\n table: Table,\n keys: any[],\n changeSpecs: { [keyPath: string]: any }[]\n) {\n const objs = await table.bulkGet(keys);\n const resultKeys: any[] = [];\n const resultObjs: any[] = [];\n keys.forEach((key, idx) => {\n const obj = objs[idx];\n if (obj) {\n for (const [keyPath, value] of Object.entries(changeSpecs[idx])) {\n if (keyPath === table.schema.primKey.keyPath) {\n if (cmp(value, key) !== 0) {\n throw new Error(`Cannot change primary key`);\n }\n } else {\n Dexie.setByKeyPath(obj, keyPath, value);\n }\n }\n resultKeys.push(key);\n resultObjs.push(obj);\n }\n });\n await (table.schema.primKey.keyPath == null\n ? table.bulkPut(resultObjs, resultKeys)\n : table.bulkPut(resultObjs));\n}\n" }, { "path": "addons/dexie-cloud/src/helpers/computeRealmSetHash.ts", "content": "import { PersistedSyncState } from '../db/entities/PersistedSyncState';\nimport { b64encode } from 'dexie-cloud-common';\n\nexport async function computeRealmSetHash({\n realms,\n inviteRealms,\n}: PersistedSyncState) {\n const data = JSON.stringify(\n [\n ...realms.map((realmId) => ({ realmId, accepted: true })),\n ...inviteRealms.map((realmId) => ({ realmId, accepted: false })),\n ].sort((a, b) =>\n a.realmId < b.realmId ? -1 : a.realmId > b.realmId ? 1 : 0\n )\n );\n const byteArray = new TextEncoder().encode(data);\n const digestBytes = await crypto.subtle.digest('SHA-1', byteArray);\n const base64 = b64encode(digestBytes);\n return base64;\n}\n" }, { "path": "addons/dexie-cloud/src/helpers/date-constants.ts", "content": "export const SECONDS = 1000;\nexport const MINUTES = 60 * SECONDS;\nexport const HOURS = 60 * MINUTES;\nexport const DAYS = 24 * HOURS;\nexport const WEEKS = 7 * DAYS;\n" }, { "path": "addons/dexie-cloud/src/helpers/flatten.ts", "content": "const concat = [].concat;\nexport function flatten(a: (T | T[])[]): T[] {\n return concat.apply([], a);\n}\n" }, { "path": "addons/dexie-cloud/src/helpers/getMutationTable.ts", "content": "\n\nexport function getMutationTable(tableName: string) {\n return `$${tableName}_mutations`;\n}\n" }, { "path": "addons/dexie-cloud/src/helpers/getSyncableTables.ts", "content": "import { IndexableType, Table } from \"dexie\";\nimport { DexieCloudDB } from \"../db/DexieCloudDB\";\nimport { EntityCommon } from \"../db/entities/EntityCommon\";\n\nexport function getSyncableTables(db: DexieCloudDB): Table[] {\n return Object.entries(db.cloud.schema || {})\n .filter(([, { markedForSync }]) => markedForSync)\n .map(([tbl]) => db.tables.find(({name}) => name === tbl))\n .filter((syncableTable): syncableTable is Table => !!syncableTable);\n}\n" }, { "path": "addons/dexie-cloud/src/helpers/getTableFromMutationTable.ts", "content": "\n\nexport function getTableFromMutationTable(mutationTable: string) {\n const tableName = /^\\$(.*)_mutations$/.exec(mutationTable)?.[1];\n if (!tableName) throw new Error(`Given mutationTable ${mutationTable} is not correct`);\n return tableName;\n}\n" }, { "path": "addons/dexie-cloud/src/helpers/makeArray.ts", "content": "\nexport function makeArray(iterable: Iterable): T[] {\n return [].slice.call(iterable);\n}\n" }, { "path": "addons/dexie-cloud/src/helpers/randomString.ts", "content": "export function randomString(bytes: number) {\n const buf = new Uint8Array(bytes);\n if (typeof crypto !== 'undefined') {\n crypto.getRandomValues(buf);\n } else {\n for (let i = 0; i < bytes; i++) buf[i] = Math.floor(Math.random() * 256);\n }\n if (typeof Buffer !== 'undefined' && Buffer.from) {\n return Buffer.from(buf).toString('base64');\n } else if (typeof btoa !== 'undefined') {\n return btoa(String.fromCharCode.apply(null, buf));\n } else {\n throw new Error('No btoa or Buffer available');\n }\n}\n" }, { "path": "addons/dexie-cloud/src/helpers/resolveText.ts", "content": "import { DXCAlert } from \"../types/DXCAlert\";\n\n/** Resolve a message template with parameters.\n * \n * Example:\n * resolveText({\n * message: \"Hello {name}!\",\n * messageCode: \"HELLO\",\n * messageParams: {name: \"David\"}\n * }) => \"Hello David!\"\n * \n * @param message Template message with {vars} in it.\n * @param messageCode Unique code for the message. Can be used for translation.\n * @param messageParams Parameters to be used in the message.\n * @returns A final message where parameters have been replaced with values.\n */\nexport function resolveText({message, messageCode, messageParams}: DXCAlert) {\n return message.replace(/\\{\\w+\\}/ig, n => messageParams[n.substring(1, n.length-1)]);\n}\n" }, { "path": "addons/dexie-cloud/src/helpers/throwVersionIncrementNeeded.ts", "content": "import Dexie from \"dexie\";\n\nexport function throwVersionIncrementNeeded() {\n throw new Dexie.SchemaError(\n `Version increment needed to allow dexie-cloud change tracking`\n );\n}\n" }, { "path": "addons/dexie-cloud/src/helpers/visibilityState.ts", "content": "import { BehaviorSubject, from, fromEvent } from 'rxjs';\nimport { map, startWith } from 'rxjs/operators';\n\nexport function createVisibilityStateObservable() {\n return fromEvent(document, 'visibilitychange').pipe(\n map(() => document.visibilityState),\n startWith(document.visibilityState)\n );\n}\n" }, { "path": "addons/dexie-cloud/src/isEagerSyncDisabled.ts", "content": "import { DexieCloudDB } from './db/DexieCloudDB';\n\nexport function isEagerSyncDisabled(db: DexieCloudDB) {\n return (\n db.cloud.options?.disableEagerSync ||\n db.cloud.currentUser.value?.license?.status !== 'ok' ||\n !db.cloud.options?.databaseUrl\n );\n}\n" }, { "path": "addons/dexie-cloud/src/isFirefox.ts", "content": "// @ts-ignore\nexport const isFirefox = typeof InstallTrigger !== 'undefined';\n" }, { "path": "addons/dexie-cloud/src/isSafari.ts", "content": "export const isSafari =\n typeof navigator !== 'undefined' &&\n /Safari\\//.test(navigator.userAgent) &&\n !/Chrom(e|ium)\\/|Edge\\//.test(navigator.userAgent);\n\nexport const safariVersion = isSafari\n ? // @ts-ignore\n [].concat(navigator.userAgent.match(/Safari\\/(\\d*)/))[1]\n : NaN;\n" }, { "path": "addons/dexie-cloud/src/mapValueObservable.ts", "content": "import { map, Observable } from 'rxjs';\n\nexport interface ObservableWithCurrentValue extends Observable {\n getValue(): T;\n}\n\nexport function mapValueObservable(\n o: ObservableWithCurrentValue,\n mapper: (x: T) => R\n): ObservableWithCurrentValue {\n let currentValue: R | undefined;\n const rv = o.pipe(\n map((x) => (currentValue = mapper(x)))\n ) as ObservableWithCurrentValue;\n rv.getValue = () =>\n currentValue !== undefined\n ? currentValue\n : (currentValue = mapper(o.getValue()));\n return rv;\n}\n" }, { "path": "addons/dexie-cloud/src/mergePermissions.ts", "content": "// TODO: Move to dexie-cloud-common\n\nimport { DBPermissionSet } from 'dexie-cloud-common';\n\nexport function mergePermissions(\n ...permissions: DBPermissionSet[]\n): DBPermissionSet {\n if (permissions.length === 0) return {};\n const reduced = permissions.reduce((result, next) => {\n const ret = { ...result } as DBPermissionSet;\n for (const [verb, rights] of Object.entries(next) as [\n keyof DBPermissionSet,\n DBPermissionSet[keyof DBPermissionSet]\n ][]) {\n if (verb in ret && ret[verb]) {\n if (ret[verb] === '*') continue;\n if (rights === '*') {\n ret[verb] = '*';\n } else if (Array.isArray(rights) && Array.isArray(ret[verb])) {\n // Both are arrays (verb is 'add' or 'manage')\n const r = ret as { [v in typeof verb]?: string[] };\n const retVerb = r[verb]!; // \"!\" because Array.isArray(ret[verb])\n r[verb] = [...new Set([...retVerb, ...rights])];\n } else if (\n typeof rights === 'object' &&\n rights &&\n typeof ret[verb] === 'object'\n ) {\n // Both are objects (verb is 'update')\n const mergedRights = ret[verb] as {\n [tableName: string]: '*' | string[];\n }; // because we've checked that typeof ret[verb] === 'object' and earlier that not ret[verb] === '*'.\n for (const [tableName, tableRights] of Object.entries(rights) as [\n string,\n string[] | '*'\n ][]) {\n if (mergedRights[tableName] === '*') continue;\n if (tableRights === '*') {\n mergedRights[tableName] = '*';\n } else if (\n Array.isArray(mergedRights[tableName]) &&\n Array.isArray(tableRights)\n ) {\n mergedRights[tableName] = [\n ...new Set([...mergedRights[tableName], ...tableRights]),\n ];\n }\n }\n }\n } else {\n /* This compiles without type assertions. Keeping the comment to\n explain why we do tsignore on the next statement.\n if (verb === \"add\") {\n ret[verb] = next[verb];\n } else if (verb === \"update\") {\n ret[verb] = next[verb];\n } else if (verb === \"manage\") {\n ret[verb] = next[verb];\n } else {\n ret[verb] = next[verb];\n }\n */\n //@ts-ignore\n ret[verb] = next[verb];\n }\n }\n return ret;\n });\n return reduced;\n}\n" }, { "path": "addons/dexie-cloud/src/middleware-helpers/guardedTable.ts", "content": "import { DBCoreTable, DBCoreTransaction } from \"dexie\";\nimport { allSettled } from \"../helpers/allSettled\";\n\nlet counter = 0;\n\nexport function guardedTable(table: DBCoreTable) {\n const prop = \"$lock\"+ (++counter);\n return {\n ...table,\n count: readLock(table.count, prop),\n get: readLock(table.get, prop),\n getMany: readLock(table.getMany, prop),\n openCursor: readLock(table.openCursor, prop),\n query: readLock(table.query, prop),\n mutate: writeLock(table.mutate, prop),\n };\n}\n\nfunction readLock(\n fn: (req: TReq) => Promise,\n prop: string\n): (req: TReq) => Promise {\n return function readLocker(req): Promise {\n const {\n readers,\n writers,\n }: { writers: Promise[]; readers: Promise[] } =\n req.trans[prop] || (req.trans[prop] = { writers: [], readers: [] });\n const numWriters = writers.length;\n const promise = (numWriters > 0\n ? writers[numWriters - 1].then(() => fn(req), () => fn(req))\n : fn(req)\n ).finally(() => {readers.splice(readers.indexOf(promise))});\n readers.push(promise);\n return promise;\n };\n}\n\nfunction writeLock(\n fn: (req: TReq) => Promise,\n prop: string\n): (req: TReq) => Promise {\n return function writeLocker(req): Promise {\n const {\n readers,\n writers,\n }: { writers: Promise[]; readers: Promise[] } =\n req.trans[prop] || (req.trans[prop] = { writers: [], readers: [] });\n let promise = (writers.length > 0\n ? writers[writers.length - 1].then(() => fn(req), () => fn(req))\n : readers.length > 0\n ? allSettled(readers).then(() => fn(req))\n : fn(req)\n ).finally(() => {writers.shift();});\n writers.push(promise);\n return promise;\n };\n}\n" }, { "path": "addons/dexie-cloud/src/middleware-helpers/idGenerationHelpers.ts", "content": "import {\n DBCoreAddRequest,\n DBCoreDeleteRequest,\n DBCoreIndex, DBCorePutRequest\n} from 'dexie';\nimport { b64LexEncode } from 'dexie-cloud-common';\n\nconst { toString } = {};\nexport function toStringTag(o: Object) {\n return toString.call(o).slice(8, -1);\n}\n\nexport function getEffectiveKeys(\n primaryKey: DBCoreIndex,\n req: (Pick & {\n keys?: any[];\n }) |\n Pick\n) {\n if (req.type === 'delete')\n return req.keys;\n return req.keys?.slice() || req.values.map(primaryKey.extractKey!);\n}\nfunction applyToUpperBitFix(orig: string, bits: number) {\n return (\n (bits & 1 ? orig[0].toUpperCase() : orig[0].toLowerCase()) +\n (bits & 2 ? orig[1].toUpperCase() : orig[1].toLowerCase()) +\n (bits & 4 ? orig[2].toUpperCase() : orig[2].toLowerCase())\n );\n}\nconst consonants = /b|c|d|f|g|h|j|k|l|m|n|p|q|r|s|t|v|x|y|z/i;\nfunction isUpperCase(ch: string) {\n return ch >= 'A' && ch <= 'Z';\n}\n\nexport function generateTablePrefix(\n tableName: string,\n allPrefixes: Set\n) {\n let rv = tableName[0].toLocaleLowerCase(); // \"users\" = \"usr\", \"friends\" = \"frn\", \"realms\" = \"rlm\", etc.\n for (let i = 1, l = tableName.length; i < l && rv.length < 3; ++i) {\n if (consonants.test(tableName[i]) || isUpperCase(tableName[i]))\n rv += tableName[i].toLowerCase();\n }\n while (allPrefixes.has(rv)) {\n if (/\\d/g.test(rv)) {\n rv = rv.substr(0, rv.length - 1) + (rv[rv.length - 1] + 1);\n if (rv.length > 3)\n rv = rv.substr(0, 3);\n else\n continue;\n } else if (rv.length < 3) {\n rv = rv + '2';\n continue;\n }\n let bitFix = 1;\n let upperFixed = rv;\n while (allPrefixes.has(upperFixed) && bitFix < 8) {\n upperFixed = applyToUpperBitFix(rv, bitFix);\n ++bitFix;\n }\n if (bitFix < 8)\n rv = upperFixed;\n else {\n let nextChar = (rv.charCodeAt(2) + 1) & 127;\n rv = rv.substr(0, 2) + String.fromCharCode(nextChar);\n // Here, in theory we could get an infinite loop if having 127*8 table names with identical 3 first consonants.\n }\n }\n return rv;\n}\nlet time = 0;\n/**\n *\n * @param prefix A unique 3-letter short-name of the table.\n * @param shardKey 3 last letters from another ID if colocation is requested. Verified on server on inserts - guarantees unique IDs across shards.\n * The shardKey part of the key represent the shardId where it was first created. An object with this\n * primary key can later on be moved to another shard without being altered. The reason for having\n * the origin shardKey as part of the key, is that the server will not need to check uniqueness constraint\n * across all shards on every insert. Updates / moves across shards are already controlled by the server\n * in the sense that the objects needs to be there already - we only need this part for inserts.\n * @returns\n */\nexport function generateKey(prefix: string, shardKey?: string) {\n const a = new Uint8Array(18);\n const timePart = new Uint8Array(a.buffer, 0, 6);\n const now = Date.now(); // Will fit into 6 bytes until year 10 895.\n if (time >= now) {\n // User is bulk-creating objects the same millisecond.\n // Increment the time part by one millisecond for each item.\n // If bulk-creating 1,000,000 rows client-side in 10 seconds,\n // the last time-stamp will be 990 seconds in future, which is no biggie at all.\n // The point is to create a nice order of the generated IDs instead of\n // using random ids.\n ++time;\n } else {\n time = now;\n }\n timePart[0] = time / 1099511627776; // Normal division (no bitwise operator) --> works with >= 32 bits.\n timePart[1] = time / 4294967296;\n timePart[2] = time / 16777216;\n timePart[3] = time / 65536;\n timePart[4] = time / 256;\n timePart[5] = time;\n const randomPart = new Uint8Array(a.buffer, 6);\n crypto.getRandomValues(randomPart);\n const id = new Uint8Array(a.buffer);\n return prefix + b64LexEncode(id) + (shardKey || '');\n}\n" }, { "path": "addons/dexie-cloud/src/middlewares/blobResolveMiddleware.ts", "content": "/**\n * DBCore Middleware for resolving BlobRefs on read\n * \n * This middleware intercepts read operations and resolves any BlobRefs\n * found in objects marked with _hasBlobRefs.\n * \n * Important: Avoids async/await to preserve Dexie's Promise.PSD context.\n * Uses Dexie.waitFor() only for explicit rw transactions to keep them alive.\n * For readonly or implicit transactions, resolves directly (no waitFor needed).\n * \n * Resolved blobs are queued for saving via BlobSavingQueue, which uses\n * setTimeout(fn, 0) to completely isolate from Dexie's transaction context.\n * Each blob is saved atomically using Table.update() with its keyPath to\n * avoid race conditions with other property changes.\n * \n * Blob downloads use Authorization header (same as sync) via the server\n * proxy endpoint: GET /blob/{ref}\n */\n\nimport Dexie, { \n DBCore, \n DBCoreGetManyRequest, \n DBCoreGetRequest, \n DBCoreQueryRequest, \n DBCoreOpenCursorRequest,\n DBCoreCursor,\n DBCoreTable, \n DBCoreTransaction, \n Middleware\n} from 'dexie';\nimport { DexieCloudDB } from '../db/DexieCloudDB';\nimport { hasUnresolvedBlobRefs, resolveAllBlobRefs, ResolvedBlob } from '../sync/blobResolve';\nimport { BlobSavingQueue } from '../sync/BlobSavingQueue';\nimport { TXExpandos } from '../types/TXExpandos';\nimport { UserLogin } from '../dexie-cloud-client';\n\nexport function createBlobResolveMiddleware(db: DexieCloudDB): Middleware {\n return {\n stack: 'dbcore' as const,\n name: 'blobResolve',\n level: 2, // Run above cache (0) and other middlewares (1) to resolve BlobRefs from cached data\n create(downlevelDatabase: DBCore): DBCore {\n // Create a single queue instance for this database\n const blobSavingQueue = new BlobSavingQueue(db);\n\n return {\n ...downlevelDatabase,\n table(tableName: string): DBCoreTable {\n if (!db.cloud) {\n // db.cloud not yet initialized - skip blob resolution\n // Fall through to downlevel table to avoid crash\n return downlevelDatabase.table(tableName);\n }\n const dbUrl = db.cloud.options?.databaseUrl;\n const downlevelTable = downlevelDatabase.table(tableName);\n \n // Skip internal tables\n if (tableName.startsWith('$')) {\n return downlevelTable;\n }\n\n return {\n ...downlevelTable,\n\n get(req: DBCoreGetRequest) {\n if ((req.trans as DBCoreTransaction & TXExpandos)?.disableBlobResolve) {\n return downlevelTable.get(req);\n }\n return downlevelTable.get(req).then(result => {\n if (result && hasUnresolvedBlobRefs(result)) {\n return resolveAndSave(downlevelTable, req.trans, req.key, result, blobSavingQueue, db);\n }\n return result;\n });\n },\n\n getMany(req: DBCoreGetManyRequest) {\n if ((req.trans as DBCoreTransaction & TXExpandos)?.disableBlobResolve) {\n return downlevelTable.getMany(req);\n }\n return downlevelTable.getMany(req).then(results => {\n // Check if any results need resolution\n const needsResolution = results.some(r => r && hasUnresolvedBlobRefs(r));\n if (!needsResolution) return results;\n \n return Dexie.Promise.all(\n results.map((result, index) => {\n if (result && hasUnresolvedBlobRefs(result)) {\n return resolveAndSave(downlevelTable, req.trans, req.keys[index], result, blobSavingQueue, db);\n }\n return result;\n })\n );\n });\n },\n\n query(req: DBCoreQueryRequest) {\n if ((req.trans as DBCoreTransaction & TXExpandos)?.disableBlobResolve) {\n return downlevelTable.query(req);\n }\n return downlevelTable.query(req).then(result => {\n if (!result.result || !Array.isArray(result.result)) return result;\n \n // Check if any results need resolution\n const needsResolution = result.result.some(r => r && hasUnresolvedBlobRefs(r));\n if (!needsResolution) return result;\n \n return Dexie.Promise.all(\n result.result.map(item => {\n if (item && hasUnresolvedBlobRefs(item)) {\n return resolveAndSave(downlevelTable, req.trans, undefined, item, blobSavingQueue, db);\n }\n return item;\n })\n ).then(resolved => ({ ...result, result: resolved }));\n });\n },\n\n openCursor(req: DBCoreOpenCursorRequest) {\n if ((req.trans as DBCoreTransaction & TXExpandos)?.disableBlobResolve) {\n return downlevelTable.openCursor(req);\n }\n return downlevelTable.openCursor(req).then(cursor => {\n if (!cursor) return cursor; // No results, so no resolution needed\n if (!req.values) return cursor; // No values requested, so no resolution needed\n if (!dbUrl) return cursor; // No database URL configured, can't resolve blobs\n return createBlobResolvingCursor(cursor, downlevelTable, blobSavingQueue, db);\n });\n },\n };\n },\n };\n },\n };\n}\n\n/**\n * Create a cursor wrapper that resolves BlobRefs in values synchronously.\n * \n * Uses Object.create() to inherit all cursor methods, only overriding:\n * - start(): Resolves BlobRefs before calling the callback\n * - value: Getter that returns the resolved value\n * \n * Returns the cursor synchronously. Resolution happens in start() before\n * each onNext callback, ensuring cursor.value is always available.\n */\nfunction createBlobResolvingCursor(\n cursor: DBCoreCursor,\n table: DBCoreTable,\n blobSavingQueue: BlobSavingQueue,\n db: DexieCloudDB\n): DBCoreCursor {\n // Create wrapped cursor using Object.create() - inherits everything\n const wrappedCursor = Object.create(cursor, {\n value: {\n value: cursor.value,\n enumerable: true,\n writable: true\n },\n start: {\n value(onNext: () => void): Promise {\n // Override start to resolve BlobRefs before each callback\n return cursor.start(() => {\n const rawValue = cursor.value;\n if (!rawValue || !hasUnresolvedBlobRefs(rawValue)) {\n onNext();\n return;\n }\n resolveAndSave(table, cursor.trans, cursor.primaryKey, rawValue, blobSavingQueue, db, true).then(resolved => {\n wrappedCursor.value = resolved;\n onNext();\n }, err => {\n console.error('Failed to resolve BlobRefs for cursor value:', err);\n onNext();\n });\n });\n }\n }\n });\n\n return wrappedCursor;\n}\n\n\n/**\n * Resolve BlobRefs in an object and queue each blob for atomic saving.\n * \n * Uses Dexie.waitFor() only when needed:\n * - Skip waitFor for readonly ('r') transactions\n * - Skip waitFor for implicit transactions (most common in liveQuery)\n * - Use waitFor only for explicit rw transactions that need to stay alive\n * \n * Each resolved blob is queued individually with its keyPath for atomic\n * update using downCore transaction with the specific keyPath - this avoids race conditions.\n * \n * Returns Dexie.Promise to preserve PSD context.\n */\nfunction resolveAndSave(\n table: DBCoreTable,\n trans: DBCoreTransaction,\n pKey: any | undefined, // optional. If missing, tries to extract from object using primary key path\n obj: any,\n blobSavingQueue: BlobSavingQueue,\n db: DexieCloudDB,\n isCursorValue: boolean = false // Flag to indicate if we're resolving a cursor value (which may not have a primary key)\n): Promise {\n try {\n // Determine if we need waitFor:\n // Skip waitFor ONLY if BOTH conditions are met:\n // 1. readonly transaction\n // 2. implicit (non-explicit) transaction\n //\n // Transaction.explicit is true when user called db.transaction() explicitly.\n // For implicit transactions (auto-created for single operations),\n // Dexie handles async automatically so no waitFor needed.\n const currentTx = Dexie.currentTransaction;\n const isReadonly = currentTx?.mode === 'readonly';\n const isExplicit = currentTx?.explicit === true;\n\n // Skip waitFor only for implicit readonly (most common case: liveQuery)\n const skipWaitFor = isReadonly && !isExplicit && !isCursorValue;\n const needsWaitFor = currentTx && !skipWaitFor;\n const dbUrl = db.cloud.options?.databaseUrl || '';\n\n // Collect resolved blobs with their keyPaths\n const resolvedBlobs: ResolvedBlob[] = [];\n\n // Create the resolution promise with auth info\n const resolutionPromise = resolveAllBlobRefs(obj, dbUrl, resolvedBlobs, '', new WeakMap(), db.blobDownloadTracker)\n\n // Wrap with waitFor to keep transaction alive during fetch\n const resolvePromise = needsWaitFor\n ? Dexie.waitFor(resolutionPromise)\n : Dexie.Promise.resolve(resolutionPromise);\n\n return resolvePromise.then(resolved => {\n // Get primary key from the object\n const primaryKey = table.schema.primaryKey;\n const key = pKey !== undefined ? pKey : primaryKey.keyPath\n ? Dexie.getByKeyPath(obj, primaryKey.keyPath as string)\n : undefined;\n\n if (key !== undefined) {\n // Queue each resolved blob individually for atomic update\n // This uses setTimeout(fn, 0) to completely isolate from\n // Dexie's transaction context (avoids inheriting PSD)\n if (isReadonly) {\n blobSavingQueue.saveBlobs(table.name, key, resolvedBlobs);\n } else {\n // For rw transactions, we can save directly without queueing\n // since we're still in the same transaction context\n table.mutate({ type: 'put', keys: [key], values: [resolved], trans }).catch(err => {\n console.error(`Failed to save resolved blob on ${table.name}:${key}:`, err);\n });\n }\n }\n\n return resolved;\n }).catch(err => {\n console.error(`[dexie-cloud:blobResolve] Failed to resolve BlobRefs on ${table.name}:`, err);\n return obj; // Return original object on error - never block the read pipeline\n });\n } catch (err) {\n console.error(`[dexie-cloud:blobResolve] Sync error in resolveAndSave on ${table.name}:`, err);\n return Dexie.Promise.resolve(obj); // Never block reads\n }\n}\n" }, { "path": "addons/dexie-cloud/src/middlewares/createIdGenerationMiddleware.ts", "content": "import Dexie, {\n DBCore,\n DBCoreAddRequest,\n DBCoreMutateRequest,\n DBCorePutRequest,\n DBCoreTransaction,\n Middleware,\n} from 'dexie';\nimport { isValidSyncableID } from 'dexie-cloud-common';\nimport { DexieCloudDB } from '../db/DexieCloudDB';\nimport {\n getEffectiveKeys,\n generateKey,\n toStringTag,\n} from '../middleware-helpers/idGenerationHelpers';\nimport { TXExpandos } from '../types/TXExpandos';\n\nexport function createIdGenerationMiddleware(\n db: DexieCloudDB\n): Middleware {\n return {\n stack: 'dbcore',\n name: 'idGenerationMiddleware',\n level: 1,\n create: (core) => {\n return {\n ...core,\n table: (tableName) => {\n const table = core.table(tableName);\n\n function generateOrVerifyAtKeys(\n req: DBCoreAddRequest | DBCorePutRequest,\n idPrefix: string\n ) {\n let valueClones: null | object[] = null;\n const keys = getEffectiveKeys(table.schema.primaryKey, req);\n keys.forEach((key, idx) => {\n if (key === undefined) {\n // Generate the key\n const colocatedId =\n req.values[idx].realmId || db.cloud.currentUserId;\n const shardKey = colocatedId.substr(colocatedId.length - 3);\n keys[idx] = generateKey(idPrefix, shardKey);\n if (!table.schema.primaryKey.outbound) {\n if (!valueClones) valueClones = req.values.slice();\n valueClones[idx] = Dexie.deepClone(valueClones[idx]);\n Dexie.setByKeyPath(\n valueClones[idx],\n table.schema.primaryKey.keyPath!,\n keys[idx]\n );\n }\n } else if (\n typeof key !== 'string' ||\n (!key.startsWith(idPrefix) && !key.startsWith('#' + idPrefix))\n ) {\n // Key was specified by caller. Verify it complies with id prefix.\n throw new Dexie.ConstraintError(\n `The ID \"${key}\" is not valid for table \"${tableName}\". ` +\n `Primary '@' keys requires the key to be prefixed with \"${idPrefix}\" (or \"#${idPrefix}).\\n` +\n `If you want to generate IDs programmatically, remove '@' from the schema to get rid of this constraint. Dexie Cloud supports custom IDs as long as they are random and globally unique.`\n );\n }\n });\n return table.mutate({\n ...req,\n keys,\n values: valueClones || req.values,\n });\n }\n\n return {\n ...table,\n mutate: (req) => {\n const idbtrans = req.trans as DBCoreTransaction & IDBTransaction & TXExpandos;\n if (idbtrans.mode === 'versionchange') {\n // Tell all the other middlewares to skip bothering. We're in versionchange mode.\n // dexie-cloud is not initialized yet.\n idbtrans.disableChangeTracking = true;\n idbtrans.disableAccessControl = true;\n }\n if (idbtrans.disableChangeTracking) {\n // Disable ID policy checks and ID generation\n return table.mutate(req);\n }\n if (req.type === 'add' || req.type === 'put') {\n const cloudTableSchema = db.cloud.schema?.[tableName];\n if (!cloudTableSchema?.generatedGlobalId) {\n if (cloudTableSchema?.markedForSync) {\n // Just make sure primary key is of a supported type:\n const keys = getEffectiveKeys(table.schema.primaryKey, req);\n keys.forEach((key, idx) => {\n if (!isValidSyncableID(key)) {\n const type = Array.isArray(key)\n ? key.map(toStringTag).join(',')\n : toStringTag(key);\n throw new Dexie.ConstraintError(\n `Invalid primary key type ${type} for table ${tableName}. Tables marked for sync has primary keys of type string or Array of string (and optional numbers)`\n );\n }\n });\n }\n } else {\n if (db.cloud.options?.databaseUrl && !db.initiallySynced) {\n // A database URL is configured but no initial sync has been performed.\n const keys = getEffectiveKeys(table.schema.primaryKey, req);\n // Check if the operation would yield any INSERT. If so, complain! We never want wrong ID prefixes stored.\n return table\n .getMany({ keys, trans: req.trans, cache: 'immutable' })\n .then((results) => {\n if (results.length < keys.length) {\n // At least one of the given objects would be created. Complain since\n // the generated ID would be based on a locally computed ID prefix only - we wouldn't\n // know if the server would give the same ID prefix until an initial sync has been\n // performed.\n throw new Error(\n `Unable to create new objects without an initial sync having been performed.`\n );\n }\n return table.mutate(req);\n });\n }\n return generateOrVerifyAtKeys(\n req,\n cloudTableSchema.idPrefix!\n );\n }\n }\n return table.mutate(req);\n },\n };\n },\n };\n },\n };\n}\n" }, { "path": "addons/dexie-cloud/src/middlewares/createImplicitPropSetterMiddleware.ts", "content": "import Dexie, { DBCore, DBCoreTransaction, Middleware } from 'dexie';\nimport { DexieCloudDB } from '../db/DexieCloudDB';\nimport { TXExpandos } from '../types/TXExpandos';\nimport { UNAUTHORIZED_USER } from '../authentication/UNAUTHORIZED_USER';\n\nexport function createImplicitPropSetterMiddleware(\n db: DexieCloudDB\n): Middleware {\n return {\n stack: 'dbcore',\n name: 'implicitPropSetterMiddleware',\n level: 1,\n create: (core) => {\n return {\n ...core,\n table: (tableName) => {\n const table = core.table(tableName);\n return {\n ...table,\n mutate: (req) => {\n const trans = req.trans as DBCoreTransaction & TXExpandos & IDBTransaction;\n\n if (trans.disableChangeTracking) {\n return table.mutate(req);\n }\n\n const currentUserId = trans.currentUser?.userId ?? UNAUTHORIZED_USER.userId;\n\n if (db.cloud.schema?.[tableName]?.markedForSync) {\n if (req.type === 'add' || req.type === 'put') {\n if (tableName === 'members') {\n for (const member of req.values) {\n if (typeof member.email === 'string') {\n // Resolve https://github.com/dexie/dexie-cloud/issues/4\n // If adding a member, make sure email is lowercase and trimmed.\n // This is to avoid issues where the APP does not check this\n // and just allows the user to enter an email address that might\n // have been pasted by the user from a source that had a trailing\n // space or was in uppercase. We want to avoid that the user\n // creates a new member with a different email address than\n // the one he/she intended to create.\n member.email = member.email.trim().toLowerCase();\n }\n }\n }\n // No matter if user is logged in or not, make sure \"owner\" and \"realmId\" props are set properly.\n // If not logged in, this will be changed upon syncification of the tables (next sync after login),\n // however, application code will work better if we can always rely on that the properties realmId\n // and owner are set. Application code may index them and query them based on db.cloud.currentUserId,\n // and expect them to be returned. That scenario must work also when db.cloud.currentUserId === 'unauthorized'.\n for (const obj of req.values) {\n if (!obj.owner) {\n obj.owner = currentUserId;\n }\n if (!obj.realmId) {\n obj.realmId = currentUserId;\n }\n const key = table.schema.primaryKey.extractKey?.(obj);\n if (typeof key === 'string' && key[0] === '#') {\n // Add $ts prop for put operations and\n // disable update operations as well as consistent\n // modify operations. Reason: Server may not have\n // the object. Object should be created on server only\n // if is being updated. An update operation won't create it\n // so we must delete req.changeSpec to degrade operation to\n // an upsert operation with timestamp so that it will be created.\n // We must also degrade from consistent modify operations for the\n // same reason - object might be there on server. Must but put up instead.\n\n // FUTURE: This clumpsy behavior of private IDs could be refined later.\n // Suggestion is to in future, treat private IDs as we treat all objects \n // and sync operations normally. Only that deletions should become soft deletes\n // for them - so that server knows when a private ID has been deleted on server\n // not accept insert/upserts on them.\n if (req.type === 'put') {\n delete req.criteria;\n delete req.changeSpec;\n if (!req.upsert) delete req.updates;\n obj.$ts = Date.now();\n }\n }\n }\n }\n }\n return table.mutate(req);\n },\n };\n },\n };\n },\n };\n}\n" }, { "path": "addons/dexie-cloud/src/middlewares/createMutationTrackingMiddleware.ts", "content": "import {\n DBCore,\n DBCoreAddRequest,\n DBCoreDeleteRequest,\n DBCoreMutateResponse,\n DBCorePutRequest,\n DBCoreTable,\n DBCoreTransaction,\n Middleware,\n RangeSet,\n} from 'dexie';\nimport { DBOperation, DBUpdateOperation } from 'dexie-cloud-common';\nimport { BehaviorSubject } from 'rxjs';\nimport { DexieCloudDB } from '../db/DexieCloudDB';\nimport { UserLogin } from '../db/entities/UserLogin';\nimport { getMutationTable } from '../helpers/getMutationTable';\nimport { randomString } from '../helpers/randomString';\nimport { throwVersionIncrementNeeded } from '../helpers/throwVersionIncrementNeeded';\nimport { guardedTable } from '../middleware-helpers/guardedTable';\nimport { registerSyncEvent } from '../sync/registerSyncEvent';\nimport { TXExpandos } from '../types/TXExpandos';\nimport { outstandingTransactions } from './outstandingTransaction';\nimport { isEagerSyncDisabled } from '../isEagerSyncDisabled';\nimport { triggerSync } from '../sync/triggerSync';\n\nexport interface MutationTrackingMiddlewareArgs {\n currentUserObservable: BehaviorSubject;\n db: DexieCloudDB;\n}\n\n/** Tracks all mutations in the same transaction as the mutations -\n * so it is guaranteed that no mutation goes untracked - and if transaction\n * aborts, the mutations won't be tracked.\n *\n * The sync job will use the tracked mutations as the source of truth when pushing\n * changes to server and cleanup the tracked mutations once the server has\n * ackowledged that it got them.\n */\nexport function createMutationTrackingMiddleware({\n currentUserObservable,\n db,\n}: MutationTrackingMiddlewareArgs): Middleware {\n return {\n stack: 'dbcore',\n name: 'MutationTrackingMiddleware',\n level: 1,\n create: (core) => {\n const allTableNames = new Set(core.schema.tables.map((t) => t.name));\n const ordinaryTables = core.schema.tables.filter(\n (t) => !/^\\$/.test(t.name)\n );\n const mutTableMap = new Map();\n for (const tbl of ordinaryTables) {\n const mutationTableName = `$${tbl.name}_mutations`;\n if (allTableNames.has(mutationTableName)) {\n mutTableMap.set(tbl.name, core.table(mutationTableName));\n }\n }\n\n return {\n ...core,\n transaction: (tables, mode) => {\n let tx: DBCoreTransaction & IDBTransaction & TXExpandos;\n if (mode === 'readwrite') {\n const mutationTables = tables\n .filter((tbl) => db.cloud.schema?.[tbl]?.markedForSync)\n .map((tbl) => getMutationTable(tbl));\n tx = core.transaction(\n [...tables, ...mutationTables],\n mode\n ) as DBCoreTransaction & IDBTransaction & TXExpandos;\n } else {\n tx = core.transaction(tables, mode) as DBCoreTransaction &\n IDBTransaction &\n TXExpandos;\n }\n\n if (mode === 'readwrite') {\n // Give each transaction a globally unique id.\n tx.txid = randomString(16);\n tx.opCount = 0;\n // Introduce the concept of current user that lasts through the entire transaction.\n // This is important because the tracked mutations must be connected to the user.\n tx.currentUser = currentUserObservable.value;\n outstandingTransactions.value.add(tx);\n outstandingTransactions.next(outstandingTransactions.value);\n const removeTransaction = () => {\n tx.removeEventListener('complete', txComplete);\n tx.removeEventListener('error', removeTransaction);\n tx.removeEventListener('abort', removeTransaction);\n outstandingTransactions.value.delete(tx);\n outstandingTransactions.next(outstandingTransactions.value);\n };\n const txComplete = () => {\n if (tx.mutationsAdded && !isEagerSyncDisabled(db)) {\n triggerSync(db, 'push');\n }\n removeTransaction();\n };\n tx.addEventListener('complete', txComplete);\n tx.addEventListener('error', removeTransaction);\n tx.addEventListener('abort', removeTransaction);\n }\n return tx;\n },\n table: (tableName) => {\n const table = core.table(tableName);\n if (/^\\$/.test(tableName)) {\n if (tableName.endsWith('_mutations')) {\n // In case application code adds items to ..._mutations tables,\n // make sure to set the mutationsAdded flag on transaction.\n // This is also done in mutateAndLog() as that function talks to a\n // lower level DBCore and wouldn't be catched by this code.\n return {\n ...table,\n mutate: (req) => {\n if (req.type === 'add' || req.type === 'put') {\n (\n req.trans as DBCoreTransaction & TXExpandos\n ).mutationsAdded = true;\n }\n return table.mutate(req);\n },\n };\n } else if (tableName === '$logins') {\n return {\n ...table,\n mutate: (req) => {\n //console.debug('Mutating $logins table', req);\n return table\n .mutate(req)\n .then((res) => {\n //console.debug('Mutating $logins');\n (\n req.trans as DBCoreTransaction & TXExpandos\n ).mutationsAdded = true;\n //console.debug('$logins mutated');\n return res;\n })\n .catch((err) => {\n console.debug('Failed mutation $logins', err);\n return Promise.reject(err);\n });\n },\n };\n } else {\n return table;\n }\n }\n const { schema } = table;\n const mutsTable = mutTableMap.get(tableName)!;\n if (!mutsTable) {\n // We cannot track mutations on this table because there is no mutations table for it.\n // This might happen in upgraders that executes before cloud schema is applied.\n return table; \n }\n return guardedTable({\n ...table,\n mutate: (req) => {\n const trans = req.trans as DBCoreTransaction & TXExpandos;\n if (!trans.txid) return table.mutate(req); // Upgrade transactions not guarded by us.\n if (trans.disableChangeTracking) return table.mutate(req);\n if (!db.cloud.schema?.[tableName]?.markedForSync)\n return table.mutate(req);\n if (!trans.currentUser?.isLoggedIn) {\n // Unauthorized user should not log mutations.\n // Instead, after login all local data should be logged at once.\n return table.mutate(req);\n }\n\n return req.type === 'deleteRange'\n ? table\n // Query the actual keys (needed for server sending correct rollback to us)\n .query({\n query: { range: req.range, index: schema.primaryKey },\n trans: req.trans,\n values: false,\n })\n // Do a delete request instead, but keep the criteria info for the server to execute\n .then((res) => {\n return mutateAndLog({\n type: 'delete',\n keys: res.result,\n trans: req.trans,\n criteria: { index: null, range: req.range },\n });\n })\n : mutateAndLog(req);\n },\n });\n\n function mutateAndLog(\n req: DBCoreDeleteRequest | DBCoreAddRequest | DBCorePutRequest\n ): Promise {\n const trans = req.trans as DBCoreTransaction & TXExpandos;\n const unsyncedProps =\n db.cloud.options?.unsyncedProperties?.[tableName];\n const {\n txid,\n currentUser: { userId },\n } = trans;\n const { type } = req;\n const opNo = ++trans.opCount;\n\n function stripChangeSpec(changeSpec: { [keyPath: string]: any }) {\n if (!unsyncedProps) return changeSpec;\n let rv = changeSpec;\n for (const keyPath of Object.keys(changeSpec)) {\n if (\n unsyncedProps.some(\n (p) => keyPath === p || keyPath.startsWith(p + '.')\n )\n ) {\n if (rv === changeSpec) rv = { ...changeSpec }; // clone on demand\n delete rv[keyPath];\n }\n }\n return rv;\n }\n\n return table.mutate(req).then((res) => {\n const { numFailures: hasFailures, failures } = res;\n let keys = type === 'delete' ? req.keys! : res.results!;\n let values = 'values' in req ? req.values : [];\n let changeSpec = 'changeSpec' in req ? req.changeSpec : undefined;\n let updates = 'updates' in req ? req.updates : undefined;\n let upsert = updates && 'upsert' in req ? req.upsert : false;\n\n if (hasFailures) {\n keys = keys.filter((_, idx) => !failures[idx]);\n values = values.filter((_, idx) => !failures[idx]);\n }\n if (unsyncedProps) {\n // Filter out unsynced properties\n values = values.map((value) => {\n const newValue = { ...value };\n for (const prop of unsyncedProps) {\n delete newValue[prop];\n }\n return newValue;\n });\n if (changeSpec) {\n // modify operation with criteria and changeSpec.\n // We must strip out unsynced properties from changeSpec.\n // We deal with criteria later.\n changeSpec = stripChangeSpec(changeSpec);\n if (Object.keys(changeSpec).length === 0) {\n // Nothing to change on server\n return res;\n }\n }\n if (updates) {\n let strippedChangeSpecs =\n updates.changeSpecs.map(stripChangeSpec);\n let newUpdates: DBCorePutRequest['updates'] = {\n keys: [],\n changeSpecs: [],\n };\n const validKeys = new RangeSet();\n let anyChangeSpecBecameEmpty = false;\n if (!upsert) {\n for (let i = 0, l = strippedChangeSpecs.length; i < l; ++i) {\n if (Object.keys(strippedChangeSpecs[i]).length > 0) {\n newUpdates.keys.push(updates.keys[i]);\n newUpdates.changeSpecs.push(strippedChangeSpecs[i]);\n validKeys.addKey(updates.keys[i]);\n } else {\n anyChangeSpecBecameEmpty = true;\n }\n }\n updates = newUpdates;\n if (anyChangeSpecBecameEmpty) {\n // Some keys were stripped. We must also strip them from keys and values\n // unless this is an upsert operation in which case we want to send them all.\n let newKeys: any[] = [];\n let newValues: any[] = [];\n for (let i = 0, l = keys.length; i < l; ++i) {\n if (validKeys.hasKey(keys[i])) {\n newKeys.push(keys[i]);\n newValues.push(values[i]);\n }\n }\n keys = newKeys;\n values = newValues;\n }\n }\n }\n }\n const ts = Date.now();\n // Canonicalize req.criteria.index to null if it's on the primary key.\n let criteria =\n 'criteria' in req && req.criteria\n ? {\n ...req.criteria,\n index:\n req.criteria.index === schema.primaryKey.keyPath // Use null to inform server that criteria is on primary key\n ? null // This will disable the server from trying to log consistent operations where it shouldnt.\n : req.criteria.index,\n }\n : undefined;\n if (unsyncedProps && criteria?.index) {\n const keyPaths = schema.indexes.find(\n (idx) => idx.name === criteria!.index\n )?.keyPath;\n const involvedProps = keyPaths\n ? typeof keyPaths === 'string'\n ? [keyPaths]\n : keyPaths\n : [];\n if (involvedProps.some((p) => unsyncedProps?.includes(p))) {\n // Don't log criteria on unsynced properties as the server could not test them.\n criteria = undefined;\n }\n }\n\n const mut: DBOperation =\n req.type === 'delete'\n ? {\n type: 'delete',\n ts,\n opNo,\n keys,\n criteria,\n txid,\n userId,\n }\n : req.type === 'add'\n ? {\n type: 'insert',\n ts,\n opNo,\n keys,\n txid,\n userId,\n values,\n }\n : upsert && updates ? {\n type: 'upsert',\n ts,\n opNo,\n keys,\n values,\n changeSpecs: updates.changeSpecs.filter((_, idx) => !failures[idx]),\n txid,\n userId,\n }\n : criteria && changeSpec\n ? {\n // Common changeSpec for all keys\n type: 'modify',\n ts,\n opNo,\n keys,\n criteria,\n changeSpec,\n txid,\n userId,\n }\n : changeSpec\n ? {\n // In case criteria involved an unsynced property, we go for keys instead.\n type: 'update',\n ts,\n opNo,\n keys,\n changeSpecs: keys.map(() => changeSpec!),\n txid,\n userId,\n }\n : updates\n ? {\n // One changeSpec per key\n type: 'update',\n ts,\n opNo,\n keys: updates.keys,\n changeSpecs: updates.changeSpecs,\n txid,\n userId,\n }\n : {\n type: 'upsert',\n ts,\n opNo,\n keys,\n values,\n txid,\n userId,\n };\n\n if ('isAdditionalChunk' in req && req.isAdditionalChunk) {\n mut.isAdditionalChunk = true;\n }\n return keys.length > 0 || criteria\n ? mutsTable\n .mutate({ type: 'add', trans, values: [mut] }) // Log entry\n .then(() => {\n trans.mutationsAdded = true; // Mark transaction as having added mutations to trigger eager sync\n return res; // Return original response\n })\n : res;\n });\n }\n },\n };\n },\n };\n}\n" }, { "path": "addons/dexie-cloud/src/middlewares/outstandingTransaction.ts", "content": "import { DBCoreTransaction } from 'dexie';\nimport { BehaviorSubject } from 'rxjs';\nimport { TXExpandos } from '../types/TXExpandos';\n\nexport const outstandingTransactions = new BehaviorSubject>(new Set());\n" }, { "path": "addons/dexie-cloud/src/overrideParseStoresSpec.ts", "content": "import Dexie, { DbSchema } from 'dexie';\nimport { DEXIE_CLOUD_SCHEMA } from './db/DexieCloudDB';\nimport { generateTablePrefix } from './middleware-helpers/idGenerationHelpers';\n\nexport function overrideParseStoresSpec(origFunc: Function, dexie: Dexie) {\n return function(stores: {[tableName: string]: string}, dbSchema: DbSchema) {\n const storesClone = {\n ...DEXIE_CLOUD_SCHEMA,\n ...stores,\n };\n // Merge indexes of DEXIE_CLOUD_SCHEMA with stores\n Object.keys(DEXIE_CLOUD_SCHEMA).forEach((tableName: keyof typeof DEXIE_CLOUD_SCHEMA) => {\n const schemaSrc = storesClone[tableName];\n // Verify that they don't try to delete a table that is needed for access control of Dexie Cloud\n if (schemaSrc == null) {\n // They try to delete one of the built-in schema tables.\n throw new Error(`Cannot delete table ${tableName} as it is needed for access control of Dexie Cloud`);\n }\n // If not trying to override a built-in table, then we can skip this and continue to next table.\n if (!stores[tableName]) {\n // They haven't tried to declare this table. No need to merge indexes.\n return; // Continue\n }\n\n // They have declared this table. Merge indexes in case they didn't declare all indexes we need.\n const requestedIndexes = schemaSrc.split(',').map(spec => spec.trim());\n const builtInIndexes = DEXIE_CLOUD_SCHEMA[tableName].split(',').map(spec => spec.trim());\n const requestedIndexSet = new Set(requestedIndexes.map(index => index.replace(/([&*]|\\+\\+)/g, \"\")));\n // Verify that primary key is unchanged\n if (requestedIndexes[0] !== builtInIndexes[0]) {\n // Primary key must match exactly\n throw new Error(`Cannot override primary key of table ${tableName}. Please declare it as {${\n tableName}: ${\n JSON.stringify(DEXIE_CLOUD_SCHEMA[tableName])\n }`);\n }\n // Merge indexes\n for (let i=1; i();\n Object.keys(storesClone).forEach(tableName => {\n const schemaSrc = storesClone[tableName]?.trim(); \n const cloudTableSchema = cloudSchema[tableName] || (cloudSchema[tableName] = {});\n if (schemaSrc != null) {\n if (/^\\@/.test(schemaSrc)) {\n storesClone[tableName] = storesClone[tableName].substr(1);\n cloudTableSchema.generatedGlobalId = true;\n cloudTableSchema.idPrefix = generateTablePrefix(tableName, allPrefixes);\n allPrefixes.add(cloudTableSchema.idPrefix);\n }\n if (!/^\\$/.test(tableName)) {\n storesClone[`$${tableName}_mutations`] = '++rev';\n cloudTableSchema.markedForSync = true;\n \n // Add sparse index for _hasBlobRefs (for BlobRef resolution tracking)\n // IndexedDB sparse indexes have zero overhead when the property doesn't exist\n if (!storesClone[tableName].includes('_hasBlobRefs')) {\n storesClone[tableName] += ',_hasBlobRefs';\n }\n }\n if (cloudTableSchema.deleted) {\n cloudTableSchema.deleted = false;\n }\n } else {\n cloudTableSchema.deleted = true;\n cloudTableSchema.markedForSync = false;\n storesClone[`$${tableName}_mutations`] = null;\n }\n });\n const rv = origFunc.call(this, storesClone, dbSchema);\n for (const [tableName, spec] of Object.entries(dbSchema)) {\n if (spec.yProps?.length) {\n const cloudTableSchema = cloudSchema[tableName];\n if (cloudTableSchema) {\n cloudTableSchema.yProps = spec.yProps.map((yProp) => yProp.prop);\n }\n }\n }\n return rv;\n }\n}\n" }, { "path": "addons/dexie-cloud/src/performInitialSync.ts", "content": "import { DexieCloudSchema } from 'dexie-cloud-common';\nimport { DexieCloudDB } from './db/DexieCloudDB';\nimport { DexieCloudOptions } from './DexieCloudOptions';\nimport { CURRENT_SYNC_WORKER, sync } from './sync/sync';\nimport { performGuardedJob } from './sync/performGuardedJob';\n\nexport async function performInitialSync(\n db: DexieCloudDB,\n cloudOptions: DexieCloudOptions,\n cloudSchema: DexieCloudSchema\n) {\n console.debug('Performing initial sync'); \n await performGuardedJob(\n db,\n CURRENT_SYNC_WORKER,\n () => sync(db, cloudOptions, cloudSchema, { isInitialSync: true })\n );\n console.debug('Done initial sync');\n}\n" }, { "path": "addons/dexie-cloud/src/permissions.ts", "content": "import Dexie, { liveQuery } from 'dexie';\nimport { DBRealmMember } from 'dexie-cloud-common';\nimport { from, Observable } from 'rxjs';\nimport { map, startWith } from 'rxjs/operators';\nimport { mergePermissions } from './mergePermissions';\nimport {\n getPermissionsLookupObservable,\n PermissionsLookup,\n} from './getPermissionsLookupObservable';\nimport { PermissionChecker } from './PermissionChecker';\nimport './extend-dexie-interface';\n\nexport function permissions(\n dexie: Dexie,\n obj: { owner?: string; realmId?: string; table?: () => string },\n tableName?: string\n): Observable> {\n if (!obj)\n throw new TypeError(\n `Cannot check permissions of undefined or null. A Dexie Cloud object with realmId and owner expected.`\n );\n const { owner, realmId } = obj;\n if (!tableName) {\n if (typeof obj.table !== 'function') {\n throw new TypeError(\n `Missing 'table' argument to permissions and table could not be extracted from entity`\n );\n }\n tableName = obj.table();\n }\n const source = getPermissionsLookupObservable(dexie);\n const mapper = (permissionsLookup: PermissionsLookup) => {\n // If realmId is undefined, it can be due to that the object is not yet syncified - it exists\n // locally only as the user might not yet be authenticated. This is ok and we shall treat it\n // as if the realmId is dexie.cloud.currentUserId (which is \"unauthorized\" by the way)\n const realm = permissionsLookup[realmId || dexie.cloud.currentUserId];\n if (!realm)\n return new PermissionChecker(\n {},\n tableName!,\n !owner || owner === dexie.cloud.currentUserId\n );\n return new PermissionChecker(\n realm.permissions,\n tableName!,\n realmId === undefined || realmId === dexie.cloud.currentUserId || owner === dexie.cloud.currentUserId\n );\n };\n const o = source.pipe(map(mapper)) as Observable> & {\n getValue: () => PermissionChecker;\n };\n o.getValue = () => mapper(source.getValue());\n return o;\n}\n" }, { "path": "addons/dexie-cloud/src/prodLog.ts", "content": "/** A way to log to console in production without terser stripping out\n * it from the release bundle.\n * This should be used very rarely and only in places where it's\n * absolutely necessary to log something in production.\n * \n * @param level \n * @param args \n */\nexport function prodLog(level: 'log' | 'warn' | 'error' | 'debug', ...args: any[]) {\n globalThis[\"con\"+\"sole\"][level](...args);\n}\n" }, { "path": "addons/dexie-cloud/src/service-worker.ts", "content": "import Dexie from 'dexie';\nimport { DexieCloudDB } from './db/DexieCloudDB';\nimport dexieCloud from './dexie-cloud-client';\nimport { DISABLE_SERVICEWORKER_STRATEGY } from './DISABLE_SERVICEWORKER_STRATEGY';\nimport { isSafari, safariVersion } from './isSafari';\nimport { syncIfPossible } from './sync/syncIfPossible';\nimport { SWMessageEvent } from './types/SWMessageEvent';\nimport { SyncEvent } from './types/SWSyncEvent';\n\n// In case the SW lives for a while, let it reuse already opened connections:\nconst managedDBs = new Map();\n\nfunction getDbNameFromTag(tag: string) {\n return tag.startsWith('dexie-cloud:') && tag.split(':')[1];\n}\n\nconst syncDBSemaphore = new Map>();\n\nfunction syncDB(dbName: string, purpose: 'push' | 'pull') {\n // We're taking hight for being double-signalled both\n // via message event and sync event.\n // Which one comes first doesnt matter, just\n // that we return the existing promise if there is\n // an ongoing sync.\n let promise = syncDBSemaphore.get(dbName + '/' + purpose);\n if (!promise) {\n promise = _syncDB(dbName, purpose)\n .then(() => {\n // When legacy enough across browsers, use .finally() instead of then() and catch():\n syncDBSemaphore.delete(dbName + '/' + purpose);\n })\n .catch((error) => {\n syncDBSemaphore.delete(dbName + '/' + purpose);\n return Promise.reject(error);\n });\n syncDBSemaphore.set(dbName + '/' + purpose, promise!);\n }\n return promise!;\n\n async function _syncDB(dbName: string, purpose: 'push' | 'pull') {\n let db = managedDBs.get(dbName);\n\n if (!db) {\n console.debug('Dexie Cloud SW: Creating new Dexie instance for', dbName);\n const dexie = new Dexie(dbName, { addons: [dexieCloud] });\n db = DexieCloudDB(dexie);\n db.cloud.isServiceWorkerDB = true;\n dexie.on('versionchange', stopManagingDB);\n await db.dx.open(); // Makes sure db.cloud.options and db.cloud.schema are read from db,\n if (managedDBs.get(dbName)) {\n // Avoid race conditions.\n db.close();\n return await _syncDB(dbName, purpose);\n }\n managedDBs.set(dbName, db);\n }\n if (!db.cloud.options?.databaseUrl) {\n console.error(`Dexie Cloud: No databaseUrl configured`);\n return; // Nothing to sync.\n }\n if (!db.cloud.schema) {\n console.error(`Dexie Cloud: No schema persisted`);\n return; // Nothing to sync.\n }\n\n function stopManagingDB() {\n db!.dx.on.versionchange.unsubscribe(stopManagingDB);\n if (managedDBs.get(db!.name) === db) {\n // Avoid race conditions.\n managedDBs.delete(db!.name);\n }\n console.debug(`Dexie Cloud SW: Closing Dexie instance for ${dbName}`);\n db!.dx.close();\n return false;\n }\n\n try {\n console.debug('Dexie Cloud SW: Syncing');\n await syncIfPossible(db, db.cloud.options, db.cloud.schema, {\n retryImmediatelyOnFetchError: true,\n purpose,\n });\n console.debug('Dexie Cloud SW: Done Syncing');\n } catch (e) {\n console.error(`Dexie Cloud SW Error`, e);\n // Error occured. Stop managing this DB until we wake up again by a sync event,\n // which will open a new Dexie and start trying to sync it.\n stopManagingDB();\n if (e.name !== Dexie.errnames.NoSuchDatabase) {\n // Unless the error was that DB doesn't exist, rethrow to trigger sync retry.\n throw e; // Throw e to make syncEvent.waitUntil() receive a rejected promis, so it will retry.\n }\n }\n }\n}\n\n// Avoid taking care of events if browser bugs out by using dexie cloud from a service worker.\nif (!DISABLE_SERVICEWORKER_STRATEGY) {\n self.addEventListener('sync', (event: SyncEvent) => {\n console.debug('SW \"sync\" Event', event.tag);\n const dbName = getDbNameFromTag(event.tag);\n if (dbName) {\n event.waitUntil(syncDB(dbName, \"push\")); // The purpose of sync events are \"push\"\n }\n });\n\n self.addEventListener('periodicsync', (event: SyncEvent) => {\n console.debug('SW \"periodicsync\" Event', event.tag);\n const dbName = getDbNameFromTag(event.tag);\n if (dbName) {\n event.waitUntil(syncDB(dbName, \"pull\")); // The purpose of periodic sync events are \"pull\"\n }\n });\n\n self.addEventListener('message', (event: SWMessageEvent) => {\n console.debug('SW \"message\" Event', event.data);\n if (event.data.type === 'dexie-cloud-sync') {\n const { dbName } = event.data;\n // Mimic background sync behavior - retry in X minutes on failure.\n // But lesser timeout and more number of times.\n const syncAndRetry = (num = 1) => {\n return syncDB(dbName, event.data.purpose || \"pull\").catch(async (e) => {\n if (num === 3) throw e;\n await sleep(60_000); // 1 minute\n syncAndRetry(num + 1);\n });\n };\n if ('waitUntil' in event) {\n event.waitUntil(syncAndRetry().catch(error => console.error(error)));\n } else {\n syncAndRetry().catch(error => console.error(error));\n }\n }\n });\n}\n\nfunction sleep(ms: number) {\n return new Promise((resolve) => setTimeout(resolve, ms));\n}\n" }, { "path": "addons/dexie-cloud/src/sync/BLOB_TODO.md", "content": "\n- [v] Bug: we're always resolving BlobRefs to Uint8Array but it could be a Blob, ArrayBuffer or other binary type. The exact type should have been stored in the TSON structure. Now it's $t: \"Blob\". Probably that is misleading and we should call it BlobRef for this.\n- Continue review the rest of the code\n\n# Beta Checklist\n\n- [x] ~~Remove `blobRefAwareTypeDefs` from TSON.ts~~ NOT NEEDED — these are required for lazy/eager blob resolution\n- [ ] Unskip lazy mode E2E test and verify it passes\n- [ ] Unskip blobProgress E2E test and verify it passes\n- [ ] David: review & merge PR #2255 (Dexie.js) + PR #75 (dexie-cloud)\n- [ ] Debug logging via `DEXIE_CLOUD_DEBUG` env var / `__DEBUG__` rollup guards (nice-to-have)\n\n# Reviewed files in the ongoing PR\n\n- [v] .github/workflows/publish-ci.yml\n- [v] addons/dexie-cloud/src/sync/BlobSavingQueue.ts\n- [v] addons/dexie-cloud/src/sync/blobResolve.ts\n- [v] addons/dexie-cloud/src/middlewares/blobResolveMiddleware.ts\n - [v] openCursor\n - [v] get\n - [v] getMany\n - [v] query\n- [v] addons/dexie-cloud/src/DexieCloudAPI.ts\n- [v] addons/dexie-cloud/src/DexieCloudOptions.ts\n- [v] addons/dexie-cloud/src/dexie-cloud-client.ts\n- [v] addons/dexie-cloud/src/overrideParseStoresSpec.ts\n- [v] addons/dexie-cloud/src/sync/eagerBlobDownloader.ts\n- [v] samples/dexie-cloud-todo-app/src/db/TodoDB.ts\n- [v] addons/dexie-cloud/src/sync/blobProgress.ts\n- [v] addons/dexie-cloud/src/sync/syncWithServer.ts ()\n- [v] addons/dexie-cloud/src/sync/applyServerChanges.ts (light)\n- [v] addons/dexie-cloud/src/sync/blobOffloading.ts (extensive)\n- [v] addons/dexie-cloud/src/sync/sync.ts (medium)\n- [v] docs/CI-PUBLISHING.md\n\n# Error handling\n- [ ] eagerBlobDownloader: see line 114 TODO. Depending on error, retry or stop trying. Maybe only retry N times over a time period of T. Right now, it will continue with next object and retry next time over and over.\n\n# Optimize middleware to skip intercepting when not necessary:\n\n- [ ] In applyServerChanges transaction, let syncState reflect which tables that have unresolved blobs, also let this momentarily be reflected in a memory set.\n- [ ] In the end of eager blob downloader, do a transaction that verifies all blobs are resolved and then remove the tables from the sync state. Within that same transaction, reset memory set.\n- [ ] in dexie-cloud-client, on-ready event, populate the memory set from sync state.\n- [ ] In middleware, skip doing the blob dance if the requested table isn't listed in the memory set.\n\n# Refactoring To-dos\n- [v] Rename `$unresolved` to `$hasBlobRefs` as it is more explanatory\n- [x] Rename `$t` → `_bt` and `$hasBlobRefs` → `_hasBlobRefs` (done 2026-03-09)\n- [x] Remove BlobRef-aware TSON type defs — TSON is transparent to BlobRefs (done 2026-03-09)\n- [ ] Move `BlobRef.ts` from `dexie-cloud-common/src/tson/types/` to `dexie-cloud-common/src/blob/` — it has nothing to do with TSON\n- [ ] Consolidate `isBlobRef` into one place in `dexie-cloud-common/src/blob/` — currently duplicated in client (`blobResolve.ts`), server (`BlobRefManager.ts`, `getObjectDiff.ts`, `expandBlobRefsForExport.ts`, `validateImportData.ts`) and E2E tests\n- [ ] Move Blob-offloading code in dexie-cloud-addon into its own sub directory to collect this feature into a single place\n- [ ] Review: `BlobRefContext`/`createBlobRefContext` in dexie-cloud-common — currently unused by server code, verify if still needed or can be removed\n- [ ] Review: `TSONRef` class in dexie-cloud-common — is it still used anywhere now that TSON doesn't revive BlobRefs? If not, remove.\n\n# Beware-ofs\n\n- If exception happens during blob uploading phase in sync.ts, the entire flow will be forgotten even if some blobs were uploaded. Could there be a risk of eternal loop if some object causes a failure and the client keeps uploading blobs over and over with new IDs? If so, can could handle partial failures specifically? For example, to catch each operation in the loop in offloadBlobsInOperations() and if that specific situation occurs only (some succeed and then failure), update the \"XXX_changes\" with the BlobRef entries uploaded so far. Next sync would then continue to retry with the failed ones only. Don't know if this could be a real problem or not. Probably the common case is network failure during upload and a re-upload eternal loop might not even be a problem unless we have a bug in the code triggered by certain data.\n\n" }, { "path": "addons/dexie-cloud/src/sync/BlobDownloadTracker.ts", "content": "import type { DexieCloudDB } from \"../db/DexieCloudDB\";\nimport { BlobRef } from \"./blobResolve\";\nimport { loadCachedAccessToken } from \"./loadCachedAccessToken\";\n\n/**\n * Deduplicates in-flight blob downloads.\n *\n * Both the blob-resolve middleware and the eager blob downloader may\n * try to fetch the same blob concurrently. This tracker ensures each\n * unique blob ref is only downloaded once — subsequent requests for\n * the same ref piggyback on the existing promise.\n *\n * Instantiate once per DexieCloudDB.\n */\nexport class BlobDownloadTracker {\n private inFlight = new Map>();\n private db: DexieCloudDB;\n\n constructor (db: DexieCloudDB) {\n this.db = db;\n }\n\n /**\n * Download a blob, deduplicating concurrent requests for the same ref.\n *\n * @param blobRef - The BlobRef to download\n * @param dbUrl - Base URL for the database (e.g., 'https://mydb.dexie.cloud')\n */\n download(blobRef: BlobRef, dbUrl: string): Promise {\n let promise = this.inFlight.get(blobRef.ref);\n if (!promise) {\n promise = loadCachedAccessToken(this.db).then(accessToken => {\n if (!accessToken) throw new Error(\"No access token available for blob download\");\n return downloadBlob(blobRef, dbUrl, accessToken);\n }).finally(() => this.inFlight.delete(blobRef.ref));\n // When the promise settles (either fulfilled or rejected), remove it from the in-flight map\n this.inFlight.set(blobRef.ref, promise);\n }\n return promise;\n }\n}\n/**\n * Download blob data from server via proxy endpoint.\n * Uses auth header for authentication (same as sync).\n *\n * @param blobRef - The BlobRef to download\n * @param dbUrl - Base URL for the database (e.g., 'https://mydb.dexie.cloud')\n * @param accessToken - Access token for authentication\n */\n\nexport async function downloadBlob(\n blobRef: BlobRef,\n dbUrl: string,\n accessToken: string\n): Promise {\n const downloadUrl = `${dbUrl}/blob/${blobRef.ref}`;\n const response = await fetch(downloadUrl, {\n headers: {\n 'Authorization': `Bearer ${accessToken}`\n }\n });\n\n if (!response.ok) {\n throw new Error(`Failed to download blob ${blobRef.ref}: ${response.status} ${response.statusText}`);\n }\n\n const arrayBuffer = await response.arrayBuffer();\n return new Uint8Array(arrayBuffer);\n}\n\n" }, { "path": "addons/dexie-cloud/src/sync/BlobSavingQueue.ts", "content": "/**\n * BlobSavingQueue - Queues resolved blobs for saving back to IndexedDB\n * \n * Uses setTimeout(fn, 0) instead of queueMicrotask to completely isolate\n * from Dexie's Promise.PSD context. This prevents the save operation\n * from inheriting any ongoing transaction.\n * \n * Each blob is saved atomically using downCore transaction with the specific\n * keyPath to avoid race conditions with other property changes.\n */\n\nimport Dexie, { UpdateSpec } from 'dexie';\nimport { isBlobRef, ResolvedBlob } from './blobResolve';\nimport { DexieCloudDB } from '../db/DexieCloudDB';\nimport { TXExpandos } from '../types/TXExpandos';\n\ninterface QueuedBlob {\n tableName: string;\n primaryKey: any;\n resolvedBlobs: ResolvedBlob[];\n}\n\nexport class BlobSavingQueue {\n private queue: QueuedBlob[] = [];\n private isProcessing = false;\n private db: DexieCloudDB;\n\n constructor(db: DexieCloudDB) {\n this.db = db;\n }\n\n /**\n * Queue a resolved blob for saving.\n * Only the specific blob property will be updated atomically.\n */\n saveBlobs(tableName: string, primaryKey: any, resolvedBlobs: ResolvedBlob[]): void {\n this.queue.push({ tableName, primaryKey, resolvedBlobs });\n this.startConsumer();\n }\n\n /**\n * Start the consumer if not already processing.\n * Uses setTimeout(fn, 0) to completely break out of any\n * Dexie transaction context (Promise.PSD).\n */\n private startConsumer(): void {\n if (this.isProcessing) return;\n \n this.isProcessing = true;\n \n // Use setTimeout to completely isolate from Dexie's PSD context\n // queueMicrotask would risk inheriting the current transaction\n setTimeout(() => {\n this.processQueue();\n }, 0);\n }\n\n /**\n * Process all queued blobs.\n * Runs in a completely isolated context (no inherited transaction).\n * Uses atomic updates to avoid race conditions.\n */\n private processQueue(): void {\n const item = this.queue.shift();\n if (!item) {\n this.isProcessing = false;\n return;\n }\n\n // Atomic update of just the blob property\n this.db.transaction('rw', item.tableName, (tx) => {\n const trans = tx.idbtrans as IDBTransaction & TXExpandos;\n trans.disableChangeTracking = true; // Don't regard this as a change for sync purposes\n trans.disableAccessControl = true; // Bypass any access control checks since this is an internal operation\n trans.disableBlobResolve = true; // Custom flag to skip blob resolve middleware during this transaction\n const updateSpec: UpdateSpec = {};\n for (const blob of item.resolvedBlobs) {\n updateSpec[blob.keyPath] = blob.data;\n }\n tx.table(item.tableName).update(item.primaryKey, obj => {\n // Check that object still has the same unresolved blob refs before applying update (i.e. it hasn't been modified since we read it)\n for (const blob of item.resolvedBlobs) {\n // Verify atomicity - none of the blob properties has been modified since we read it. If any of them was modified, skip updating this item to avoid overwriting user changes.\n const currentValue = Dexie.getByKeyPath(obj, blob.keyPath);\n if (currentValue === undefined) {\n // Blob property was removed - skip updating this blob\n continue;\n }\n if (!isBlobRef(currentValue)) {\n // Blob property was modified to a non-blob-ref value - skip updating this blob\n continue;\n }\n if (currentValue.ref !== blob.ref) {\n // Blob property was modified - skip updating this blob\n return; // Stop. Another items has been queued to fully fix the object.\n }\n Dexie.setByKeyPath(obj, blob.keyPath, blob.data);\n }\n delete obj._hasBlobRefs; // Clear the _hasBlobRefs marker if all refs was resolved.\n });\n }).catch((error) => {\n console.error(`Error saving resolved blobs on ${item.tableName}:${item.primaryKey}:`, error);\n }).finally(() => {\n // Process next item in the queue\n return this.processQueue();\n });\n }\n}\n" }, { "path": "addons/dexie-cloud/src/sync/DEXIE_CLOUD_SYNCER_ID.ts", "content": "\nexport const DEXIE_CLOUD_SYNCER_ID = 'dexie-cloud-syncer';\n" }, { "path": "addons/dexie-cloud/src/sync/LocalSyncWorker.ts", "content": "import { Subscription } from 'rxjs';\nimport { syncIfPossible } from './syncIfPossible';\nimport { DexieCloudDB } from '../db/DexieCloudDB';\nimport { SECONDS } from '../helpers/date-constants';\nimport { DexieCloudOptions } from '../DexieCloudOptions';\nimport { DexieCloudSchema } from 'dexie-cloud-common';\n\nexport function LocalSyncWorker(\n db: DexieCloudDB,\n cloudOptions: DexieCloudOptions,\n cloudSchema: DexieCloudSchema\n) {\n let localSyncEventSubscription: Subscription | null = null;\n let cancelToken = { cancelled: false };\n let nextRetryTime = 0;\n let syncStartTime = 0;\n\n function syncAndRetry(retryNum = 1) {\n // Use setTimeout() to get onto a clean stack and\n // break free from possible active transaction:\n setTimeout(() => {\n const purpose = pullSignalled ? 'pull' : 'push';\n syncStartTime = Date.now();\n syncIfPossible(db, cloudOptions, cloudSchema, {\n cancelToken,\n retryImmediatelyOnFetchError: true, // workaround for \"net::ERR_NETWORK_CHANGED\" in chrome.\n purpose,\n }).then(()=>{\n if (cancelToken.cancelled) {\n stop();\n } else {\n if (pullSignalled || pushSignalled) {\n // If we have signalled for more sync, do it now.\n pullSignalled = false;\n pushSignalled = false;\n return syncAndRetry();\n }\n }\n ongoingSync = false;\n nextRetryTime = 0;\n syncStartTime = 0;\n }).catch((error: unknown) => {\n console.error('error in syncIfPossible()', error);\n if (cancelToken.cancelled) {\n stop();\n ongoingSync = false;\n nextRetryTime = 0;\n syncStartTime = 0;\n } else if (retryNum < 5) {\n // Mimic service worker sync event but a bit more eager: retry 4 times\n // * first retry after 20 seconds\n // * second retry 40 seconds later\n // * third retry 5 minutes later\n // * last retry 15 minutes later\n const retryIn = [0, 20, 40, 300, 900][retryNum] * SECONDS\n nextRetryTime = Date.now() + retryIn;\n syncStartTime = 0;\n setTimeout(\n () => syncAndRetry(retryNum + 1),\n retryIn\n );\n } else {\n ongoingSync = false;\n nextRetryTime = 0;\n syncStartTime = 0;\n }\n });\n }, 0);\n }\n\n let pullSignalled = false;\n let pushSignalled = false;\n let ongoingSync = false;\n const consumer = (purpose: 'pull' | 'push') =>{\n if (cancelToken.cancelled) return;\n if (purpose === 'pull') {\n pullSignalled = true;\n }\n if (purpose === 'push') {\n pushSignalled = true;\n }\n if (ongoingSync) {\n if (nextRetryTime) {\n console.debug(`Sync is paused until ${new Date(nextRetryTime).toISOString()} due to error in last sync attempt`);\n } else if (syncStartTime > 0 && Date.now() - syncStartTime > 20 * SECONDS) {\n console.debug(`An existing sync operation is taking more than 20 seconds. Will resync when done.`)\n }\n return;\n }\n ongoingSync = true;\n syncAndRetry();\n };\n\n const start = () => {\n // Sync eagerly whenever a change has happened (+ initially when there's no syncState yet)\n // This initial subscribe will also trigger an sync also now.\n console.debug('Starting LocalSyncWorker', db.localSyncEvent['id']);\n localSyncEventSubscription = db.localSyncEvent.subscribe(({ purpose }) => {\n consumer(purpose || 'pull');\n });\n };\n\n const stop = () => {\n console.debug('Stopping LocalSyncWorker');\n cancelToken.cancelled = true;\n if (localSyncEventSubscription) localSyncEventSubscription.unsubscribe();\n };\n\n return {\n start,\n stop,\n };\n}\n" }, { "path": "addons/dexie-cloud/src/sync/SyncRequiredError.ts", "content": "export class SyncRequiredError extends Error {\n name = \"SyncRequiredError\";\n}\n" }, { "path": "addons/dexie-cloud/src/sync/applyServerChanges.ts", "content": "import { DexieCloudDB } from '../db/DexieCloudDB';\nimport Dexie from 'dexie';\nimport { bulkUpdate } from '../helpers/bulkUpdate';\nimport { DBOperationsSet } from 'dexie-cloud-common';\nimport { hasBlobRefs } from './blobResolve';\n\n/**\n * If the incoming value contains BlobRefs (e.g. offloaded strings or binaries),\n * mark it with _hasBlobRefs = 1 so the blobResolveMiddleware will resolve them\n * on the next read.\n */\nfunction markIfHasBlobRefs(obj: unknown): void {\n if (\n obj !== null &&\n typeof obj === 'object' &&\n (obj as any).constructor === Object &&\n hasBlobRefs(obj)\n ) {\n (obj as any)._hasBlobRefs = 1;\n }\n}\n\n\nexport async function applyServerChanges(\n changes: DBOperationsSet,\n db: DexieCloudDB\n) {\n console.debug('Applying server changes', changes, Dexie.currentTransaction);\n for (const { table: tableName, muts } of changes) {\n if (!db.dx._allTables[tableName]) {\n console.debug(\n `Server sent changes for table ${tableName} that we don't have. Ignoring.`\n );\n continue;\n }\n const table = db.table(tableName);\n const { primaryKey } = table.core.schema;\n const keyDecoder = (key: string) => {\n switch (key[0]) {\n case '[':\n // Decode JSON array\n if (key.endsWith(']'))\n try {\n // On server, array keys are transformed to JSON string representation\n return JSON.parse(key);\n } catch {}\n return key;\n case '#':\n // Decode private ID (do the opposite from what's done in encodeIdsForServer())\n if (key.endsWith(':' + db.cloud.currentUserId)) {\n return key.substr(\n 0,\n key.length - db.cloud.currentUserId.length - 1\n );\n }\n return key;\n default:\n return key;\n }\n };\n for (const mut of muts) {\n const keys = mut.keys.map(keyDecoder);\n switch (mut.type) {\n case 'insert':\n mut.values.forEach(markIfHasBlobRefs);\n if (primaryKey.outbound) {\n await table.bulkAdd(mut.values, keys);\n } else {\n keys.forEach((key, i) => {\n // Make sure inbound keys are consistent\n Dexie.setByKeyPath(mut.values[i], primaryKey.keyPath!, key);\n });\n await table.bulkAdd(mut.values);\n }\n break;\n case 'upsert':\n mut.values.forEach(markIfHasBlobRefs);\n if (primaryKey.outbound) {\n await table.bulkPut(mut.values, keys);\n } else {\n keys.forEach((key, i) => {\n // Make sure inbound keys are consistent\n Dexie.setByKeyPath(mut.values[i], primaryKey.keyPath!, key);\n });\n await table.bulkPut(mut.values);\n }\n break;\n case 'modify':\n if (keys.length === 1) {\n await table.update(keys[0], mut.changeSpec);\n } else {\n await table.where(':id').anyOf(keys).modify(mut.changeSpec);\n }\n break;\n case 'update':\n await bulkUpdate(table, keys, mut.changeSpecs);\n break;\n case 'delete':\n await table.bulkDelete(keys);\n break;\n }\n }\n }\n}\n" }, { "path": "addons/dexie-cloud/src/sync/blobOffloading.test.ts", "content": "// Unit test for shouldOffloadBlob behavior\n// Verifies: Blob/File always offloaded; ArrayBuffer/TypedArray use 4KB threshold\n\nimport { shouldOffloadBlob } from '../../src/sync/blobOffloading';\n\nfunction assert(cond: boolean, msg: string) {\n if (!cond) throw new Error('FAIL: ' + msg);\n console.log('OK: ' + msg);\n}\n\n// Blob - always offloaded regardless of size\nassert(shouldOffloadBlob(new Blob([])), 'empty Blob (0 bytes) is offloaded');\nassert(shouldOffloadBlob(new Blob(['x'])), '1-byte Blob is offloaded');\nassert(shouldOffloadBlob(new Blob([new Uint8Array(1024)])), '1KB Blob is offloaded');\nassert(shouldOffloadBlob(new Blob([new Uint8Array(8192)])), '8KB Blob is offloaded');\n\n// File - always offloaded\nassert(shouldOffloadBlob(new File(['x'], 'test.txt')), '1-byte File is offloaded');\n\n// ArrayBuffer - threshold at 4096\nassert(!shouldOffloadBlob(new ArrayBuffer(1)), '1-byte ArrayBuffer is NOT offloaded');\nassert(!shouldOffloadBlob(new ArrayBuffer(4095)), '4095-byte ArrayBuffer is NOT offloaded');\nassert(shouldOffloadBlob(new ArrayBuffer(4096)), '4096-byte ArrayBuffer IS offloaded');\nassert(shouldOffloadBlob(new ArrayBuffer(8192)), '8KB ArrayBuffer IS offloaded');\n\n// Uint8Array - threshold at 4096\nassert(!shouldOffloadBlob(new Uint8Array(1)), '1-byte Uint8Array is NOT offloaded');\nassert(shouldOffloadBlob(new Uint8Array(4096)), '4096-byte Uint8Array IS offloaded');\n\n// Primitives - never offloaded\nassert(!shouldOffloadBlob(null), 'null is not offloaded');\nassert(!shouldOffloadBlob('string'), 'string is not offloaded');\nassert(!shouldOffloadBlob(42), 'number is not offloaded');\nassert(!shouldOffloadBlob({}), 'plain object is not offloaded');\n\nconsole.log('\\nAll tests passed!');\n" }, { "path": "addons/dexie-cloud/src/sync/blobOffloading.ts", "content": "/**\n * Blob Offloading for Dexie Cloud\n * \n * Handles uploading large blobs to blob storage before sync,\n * and resolving BlobRefs when reading from the database.\n */\n\nimport { newId, DBOperationsSet, DBOperation } from 'dexie-cloud-common';\nimport { BlobRef, BlobRefOrigType, isBlobRef as isBlobRefFromResolve } from './blobResolve';\n\n// Blobs >= 4KB are offloaded to blob storage\nconst BLOB_OFFLOAD_THRESHOLD = 4096;\n\n// Default max string length before offloading (32KB characters)\nexport const DEFAULT_MAX_STRING_LENGTH = 32768;\n\n// Cache: once we know the server doesn't support blob storage, skip future uploads.\n// Maps databaseUrl → boolean (true = supported, false = not supported).\nconst blobEndpointSupported = new Map();\n\n// Re-export BlobRef type\nexport type { BlobRef, BlobRefOrigType };\n\n// Re-export isBlobRef from blobResolve\nexport const isBlobRef = isBlobRefFromResolve;\n\n/**\n * Cross-realm type detection helpers (performance-optimized)\n * \n * When code runs in different JavaScript realms (e.g., Service Worker context),\n * `instanceof` checks can fail because each realm has its own global constructors.\n * We use Object.prototype.toString which works reliably across realms.\n * \n * Performance considerations (this is a hot path - every property is checked):\n * - Early return for primitives via typeof\n * - Static Set for O(1) TypedArray tag lookup\n * - Single typeTag call per check\n */\n\n// TypedArray/DataView tags for size check\nconst ARRAYBUFFER_VIEW_TAGS = new Set([\n 'Int8Array', 'Uint8Array', 'Uint8ClampedArray',\n 'Int16Array', 'Uint16Array', 'Int32Array', 'Uint32Array',\n 'Float32Array', 'Float64Array', 'BigInt64Array', 'BigUint64Array',\n 'DataView'\n]);\n\n// Static Set for O(1) lookup of binary type tags\nconst BINARY_TYPE_TAGS = new Set([\n 'Blob',\n 'File',\n 'ArrayBuffer',\n ...ARRAYBUFFER_VIEW_TAGS,\n]);\n\n/**\n * Get the [[Class]] internal property via Object.prototype.toString\n */\nfunction getTypeTag(value: unknown): string {\n return Object.prototype.toString.call(value).slice(8, -1);\n}\n\n/**\n * Get the original type name for a value\n */\nfunction getOrigType(value: Blob | ArrayBuffer | ArrayBufferView): BlobRefOrigType {\n const tag = getTypeTag(value);\n if (tag === 'Blob' || tag === 'File') return 'Blob';\n if (tag === 'ArrayBuffer') return 'ArrayBuffer';\n return tag as BlobRefOrigType;\n}\n\n/**\n * Check if a value should be offloaded to blob storage\n * Performance-optimized for hot path traversal.\n */\nexport function shouldOffloadBlob(value: unknown): value is Blob | ArrayBuffer | ArrayBufferView {\n // Fast path: primitives (most common case)\n // typeof returns: \"string\", \"number\", \"boolean\", \"undefined\", \"symbol\", \"bigint\", \"function\", \"object\"\n const t = typeof value;\n if (t !== 'object' || value === null) return false;\n \n // Get type tag once (cross-realm safe)\n const tag = getTypeTag(value);\n \n // Quick check: is this even a binary type?\n if (!BINARY_TYPE_TAGS.has(tag)) return false;\n \n // Blob/File: always offload regardless of size.\n // This ensures blobs are never stored inline in IndexedDB, which avoids\n // issues with synchronous blob reading (e.g. in service workers where\n // XMLHttpRequest is unavailable — see #2182).\n if (tag === 'Blob' || tag === 'File') {\n return true;\n }\n // ArrayBuffer/TypedArray/DataView: only offload above threshold\n if (tag === 'ArrayBuffer') {\n return (value as ArrayBuffer).byteLength >= BLOB_OFFLOAD_THRESHOLD;\n }\n // TypedArray or DataView\n return (value as ArrayBufferView).byteLength >= BLOB_OFFLOAD_THRESHOLD;\n}\n\n/**\n * Upload a blob to the blob storage endpoint\n */\nexport async function uploadBlob(\n databaseUrl: string,\n getCachedAccessToken: () => Promise,\n blob: Blob | ArrayBuffer | ArrayBufferView\n): Promise {\n const accessToken = await getCachedAccessToken();\n if (!accessToken) {\n throw new Error('Failed to load access token for blob upload');\n }\n\n const blobId = newId();\n // URL format: {databaseUrl}/blob/{blobId}\n const url = `${databaseUrl}/blob/${blobId}`;\n \n let body: Blob | ArrayBuffer;\n let contentType: string;\n let size: number;\n const origType = getOrigType(blob);\n \n // Use type tag for cross-realm compatible checks\n const tag = getTypeTag(blob);\n if (tag === 'Blob' || tag === 'File') {\n body = blob as Blob;\n contentType = (blob as Blob).type || 'application/octet-stream';\n size = (blob as Blob).size;\n } else if (tag === 'ArrayBuffer') {\n body = blob as ArrayBuffer;\n contentType = 'application/octet-stream';\n size = (blob as ArrayBuffer).byteLength;\n } else if (ARRAYBUFFER_VIEW_TAGS.has(tag)) {\n // ArrayBufferView (TypedArray or DataView) - create a proper ArrayBuffer copy\n const view = blob as ArrayBufferView;\n const arrayBuffer = new ArrayBuffer(view.byteLength);\n new Uint8Array(arrayBuffer).set(new Uint8Array(view.buffer, view.byteOffset, view.byteLength));\n body = arrayBuffer;\n contentType = 'application/octet-stream';\n size = view.byteLength;\n } else {\n throw new Error(`Unsupported blob type: ${tag}`);\n }\n \n // Add content type as query param for the server to store\n const uploadUrl = `${url}?ct=${encodeURIComponent(contentType)}`;\n \n const response = await fetch(uploadUrl, {\n method: 'PUT',\n headers: {\n 'Authorization': `Bearer ${accessToken}`,\n 'Content-Type': contentType,\n },\n body,\n });\n \n if (!response.ok) {\n if (response.status === 404 || response.status === 405) {\n // Server doesn't support blob storage endpoint — fall back to inline storage.\n // This happens when a new client connects to an older server (pre-3.0).\n return null;\n }\n throw new Error(`Failed to upload blob: ${response.status} ${response.statusText}`);\n }\n \n // The server returns the ref with version prefix (e.g., \"1:blobId\")\n const result = await response.json();\n \n // Return BlobRef with server's ref (includes version) and original type preserved in _bt\n return {\n _bt: origType,\n ref: result.ref,\n size: size,\n ...(origType === 'Blob' ? { ct: contentType } : {}) // Only include content type for Blobs\n };\n}\n\nexport async function offloadBlobsAndMarkDirty(\n obj: unknown,\n databaseUrl: string,\n getCachedAccessToken: () => Promise,\n maxStringLength = DEFAULT_MAX_STRING_LENGTH\n): Promise {\n const dirtyFlag = { dirty: false };\n const result = await offloadBlobs(obj, databaseUrl, getCachedAccessToken, maxStringLength, dirtyFlag); \n // Mark the object as dirty for sync if any blobs were offloaded\n if (dirtyFlag.dirty && typeof result === 'object' && result !== null && result.constructor === Object) {\n (result as any)._hasBlobRefs = 1;\n }\n \n return result;\n}\n\n/**\n * Recursively scan an object for large blobs and upload them\n * Returns a new object with blobs replaced by BlobRefs\n */\nexport async function offloadBlobs(\n obj: unknown,\n databaseUrl: string,\n getCachedAccessToken: () => Promise,\n maxStringLength = DEFAULT_MAX_STRING_LENGTH,\n dirtyFlag = { dirty: false },\n visited = new WeakSet()\n): Promise {\n if (obj === null || obj === undefined) {\n return obj;\n }\n \n // Check if this is a long string that should be offloaded\n if (typeof obj === 'string' && obj.length > maxStringLength && maxStringLength !== Infinity) {\n if (blobEndpointSupported.get(databaseUrl) === false) {\n return obj;\n }\n const blob = new Blob([obj], { type: 'text/plain;charset=utf-8' });\n const blobRef = await uploadBlob(databaseUrl, getCachedAccessToken, blob);\n if (blobRef === null) {\n blobEndpointSupported.set(databaseUrl, false);\n return obj;\n }\n blobEndpointSupported.set(databaseUrl, true);\n dirtyFlag.dirty = true;\n // Mark as string type so it's resolved back to string, not Blob\n return {\n ...blobRef,\n _bt: 'string',\n };\n }\n\n // Check if this is a blob that should be offloaded\n if (shouldOffloadBlob(obj)) {\n if (blobEndpointSupported.get(databaseUrl) === false) {\n // Server known to not support blob storage — keep inline\n return obj;\n }\n const blobRef = await uploadBlob(databaseUrl, getCachedAccessToken, obj);\n if (blobRef === null) {\n // Server doesn't support blob storage — keep original inline\n blobEndpointSupported.set(databaseUrl, false);\n return obj;\n }\n blobEndpointSupported.set(databaseUrl, true);\n dirtyFlag.dirty = true;\n return blobRef;\n }\n \n if (typeof obj !== 'object') {\n return obj;\n }\n \n // Avoid circular references - check BEFORE processing\n if (visited.has(obj)) {\n return obj;\n }\n visited.add(obj);\n \n // Handle arrays\n if (Array.isArray(obj)) {\n const result: unknown[] = [];\n for (const item of obj) {\n result.push(await offloadBlobs(item, databaseUrl, getCachedAccessToken, maxStringLength, dirtyFlag, visited));\n }\n return result;\n }\n \n // Traverse plain objects (POJO-like) - use prototype check since IndexedDB\n // may return objects where constructor !== Object\n const proto = Object.getPrototypeOf(obj);\n if (proto !== Object.prototype && proto !== null) {\n return obj;\n }\n \n const result: Record = {};\n for (const [key, value] of Object.entries(obj)) {\n result[key] = await offloadBlobs(value, databaseUrl, getCachedAccessToken, maxStringLength, dirtyFlag, visited);\n }\n return result;\n}\n\n/**\n * Process a DBOperationsSet and offload any large blobs\n * Returns a new DBOperationsSet with blobs replaced by BlobRefs\n */\nexport async function offloadBlobsInOperations(\n operations: DBOperationsSet,\n databaseUrl: string,\n getCachedAccessToken: () => Promise,\n maxStringLength = DEFAULT_MAX_STRING_LENGTH\n): Promise {\n const result: DBOperationsSet = [];\n \n for (const tableOps of operations) {\n const processedMuts: DBOperation[] = [];\n \n for (const mut of tableOps.muts) {\n const processedMut = await offloadBlobsInOperation(mut, databaseUrl, getCachedAccessToken, maxStringLength);\n processedMuts.push(processedMut);\n }\n \n result.push({\n table: tableOps.table,\n muts: processedMuts,\n });\n }\n \n return result;\n}\n\nasync function offloadBlobsInOperation(\n op: DBOperation,\n databaseUrl: string,\n getCachedAccessToken: ()=> Promise,\n maxStringLength = DEFAULT_MAX_STRING_LENGTH\n): Promise {\n switch (op.type) {\n case 'insert':\n case 'upsert': {\n const processedValues = await Promise.all(\n op.values.map(value => offloadBlobsAndMarkDirty(value, databaseUrl, getCachedAccessToken, maxStringLength))\n );\n return {\n ...op,\n values: processedValues,\n };\n }\n \n case 'update': {\n const processedChangeSpecs = await Promise.all(\n op.changeSpecs.map(spec => offloadBlobsAndMarkDirty(spec, databaseUrl, getCachedAccessToken, maxStringLength))\n );\n return {\n ...op,\n changeSpecs: processedChangeSpecs as { [keyPath: string]: any }[],\n };\n }\n \n case 'modify': {\n const processedChangeSpec = await offloadBlobsAndMarkDirty(op.changeSpec, databaseUrl, getCachedAccessToken, maxStringLength);\n return {\n ...op,\n changeSpec: processedChangeSpec as { [keyPath: string]: any },\n };\n }\n \n case 'delete':\n // No blobs in delete operations\n return op;\n \n default:\n return op;\n }\n}\n\n/**\n * Check if there are any large blobs in the operations that need offloading\n * This is a quick check to avoid unnecessary processing\n */\nexport function hasLargeBlobsInOperations(operations: DBOperationsSet, maxStringLength = DEFAULT_MAX_STRING_LENGTH): boolean {\n for (const tableOps of operations) {\n for (const mut of tableOps.muts) {\n if (hasLargeBlobsInOperation(mut, maxStringLength)) {\n return true;\n }\n }\n }\n return false;\n}\n\nfunction hasLargeBlobsInOperation(op: DBOperation, maxStringLength: number): boolean {\n switch (op.type) {\n case 'insert':\n case 'upsert':\n return op.values.some(value => hasLargeBlobs(value, maxStringLength));\n case 'update':\n return op.changeSpecs.some(spec => hasLargeBlobs(spec, maxStringLength));\n case 'modify':\n return hasLargeBlobs(op.changeSpec, maxStringLength);\n default:\n return false;\n }\n}\n\nfunction hasLargeBlobs(obj: unknown, maxStringLength: number, visited = new WeakSet()): boolean {\n if (obj === null || obj === undefined) {\n return false;\n }\n \n // Check long strings\n if (typeof obj === 'string' && obj.length > maxStringLength && maxStringLength !== Infinity) {\n return true;\n }\n \n if (shouldOffloadBlob(obj)) {\n return true;\n }\n \n if (typeof obj !== 'object') {\n return false;\n }\n \n // Avoid circular references - check BEFORE processing\n if (visited.has(obj)) {\n return false;\n }\n visited.add(obj);\n \n if (Array.isArray(obj)) {\n return obj.some(item => hasLargeBlobs(item, maxStringLength, visited));\n }\n \n // Traverse plain objects (POJO-like) - use duck typing since IndexedDB\n // may return objects where constructor !== Object\n const proto = Object.getPrototypeOf(obj);\n if (proto === Object.prototype || proto === null) {\n return Object.values(obj).some(value => hasLargeBlobs(value, maxStringLength, visited));\n }\n \n return false;\n}\n" }, { "path": "addons/dexie-cloud/src/sync/blobProgress.ts", "content": "/**\n * Blob Progress Tracking\n *\n * Uses liveQuery to reactively track unresolved blob refs.\n * Any change to _hasBlobRefs in any syncable table automatically\n * triggers a re-scan — no manual updateBlobProgress() needed.\n */\n\nimport { BehaviorSubject, Observable, combineLatest, from, timer } from 'rxjs';\nimport { map, share } from 'rxjs/operators';\nimport { liveQuery } from 'dexie';\nimport { BlobProgress } from '../DexieCloudAPI';\nimport { isBlobRef, isSerializedTSONRef } from './blobResolve';\nimport { getSyncableTables } from '../helpers/getSyncableTables';\nimport { DexieCloudDB } from '../db/DexieCloudDB';\nimport { TSONRef } from 'dexie-cloud-common';\n\n/**\n * Unified reference info for both BlobRef and TSONRef\n */\ninterface RefInfo {\n ref: string;\n size: number;\n}\n\n/**\n * BehaviorSubject for the isDownloading flag, controlled by eagerBlobDownloader.\n */\nexport function createDownloadingState(): BehaviorSubject {\n return new BehaviorSubject(false);\n}\n\n/**\n * Set downloading state.\n */\nexport function setDownloadingState(\n downloading$: BehaviorSubject,\n isDownloading: boolean\n): void {\n if (downloading$.value !== isDownloading) {\n downloading$.next(isDownloading);\n }\n}\n\n/**\n * Create a liveQuery-based Observable.\n *\n * Combines a liveQuery (blobsRemaining, bytesRemaining) with an external\n * isDownloading flag controlled by the eager downloader.\n */\nexport function observeBlobProgress(\n db: DexieCloudDB,\n downloading$: BehaviorSubject\n): Observable {\n const blobStats$ = from(liveQuery(async () => {\n let blobsRemaining = 0;\n let bytesRemaining = 0;\n\n const syncedTables = getSyncableTables(db);\n\n await db.dx.transaction('r', syncedTables, async (tx) => {\n (tx.idbtrans as any).disableBlobResolve = true;\n\n for (const table of syncedTables) {\n const hasIndex = !!table.schema.idxByName['_hasBlobRefs'];\n if (!hasIndex) continue;\n\n const unresolvedObjects = await table\n .where('_hasBlobRefs')\n .equals(1)\n .toArray();\n\n for (const obj of unresolvedObjects) {\n const blobs = findBlobRefs(obj);\n blobsRemaining += blobs.length;\n bytesRemaining += blobs.reduce(\n (sum, blob) => sum + (blob.size || 0),\n 0\n );\n }\n }\n });\n\n return { blobsRemaining, bytesRemaining };\n }));\n\n return combineLatest([blobStats$, downloading$]).pipe(\n map(([stats, isDownloading]) => ({\n isDownloading: isDownloading && stats.blobsRemaining > 0,\n blobsRemaining: stats.blobsRemaining,\n bytesRemaining: stats.bytesRemaining,\n })),\n share({ resetOnRefCountZero: () => timer(2000) }) // Keep alive for 2s after last unsubscription to avoid rapid re-subscriptions during UI updates \n );\n}\n\n/**\n * Find all unresolved refs (BlobRef or TSONRef) in an object (recursive).\n * Handles both live TSONRef instances and serialized TSONRefs (after IndexedDB).\n */\nfunction findBlobRefs(obj: unknown): RefInfo[] {\n const refs: RefInfo[] = [];\n\n function scan(value: unknown): void {\n if (value === null || value === undefined) return;\n if (typeof value !== 'object') return;\n\n if (TSONRef.isTSONRef(value)) {\n refs.push({ ref: value.ref, size: value.size });\n return;\n }\n\n if (isSerializedTSONRef(value)) {\n const obj = value as { type: string; ref: string; size: number };\n refs.push({ ref: obj.ref, size: obj.size });\n return;\n }\n\n if (isBlobRef(value)) {\n refs.push({ ref: value.ref, size: value.size || 0 });\n return;\n }\n\n if (Array.isArray(value)) {\n value.forEach(scan);\n } else if (value.constructor === Object) {\n Object.values(value).forEach(scan);\n }\n }\n\n scan(obj);\n return refs;\n}\n" }, { "path": "addons/dexie-cloud/src/sync/blobResolve.ts", "content": "import { BlobDownloadTracker } from './BlobDownloadTracker';\n\n/**\n * BlobRef Resolution for Dexie Cloud\n * \n * Handles lazy resolution of BlobRefs when reading from the database.\n * BlobRefs are symbolic references to blobs stored in blob storage.\n * They get resolved on-demand when the object is read.\n * \n * The server sends offloaded binary data in the format:\n * { _bt: 'Uint8Array', ref: '1:blobId', size: 1234 }\n * { _bt: 'Blob', ref: '1:blobId', size: 1234, ct: 'image/png' }\n * \n * The _bt field preserves the original JavaScript type.\n * The ref format is '{version}:{blobId}' where version identifies\n * the storage backend configuration.\n */\n\n\n/**\n * Original type that was offloaded to blob storage.\n * Matches the TSON type names.\n */\nexport type BlobRefOrigType = \n | 'Blob'\n | 'ArrayBuffer'\n | 'Uint8Array'\n | 'Int8Array'\n | 'Uint8ClampedArray'\n | 'Int16Array'\n | 'Uint16Array'\n | 'Int32Array'\n | 'Uint32Array'\n | 'Float32Array'\n | 'Float64Array'\n | 'BigInt64Array'\n | 'BigUint64Array'\n | 'DataView'\n | 'string';\n\n/**\n * BlobRef represents a reference to binary data stored in blob storage.\n * The _bt field contains the original JavaScript type (Uint8Array, Blob, etc.)\n * The presence of 'ref' instead of 'v' indicates this is an offloaded blob.\n */\nexport interface BlobRef {\n _bt: BlobRefOrigType;\n ref: string; // Versioned ref: '{version}:{blobId}'\n size: number; // Size in bytes\n ct?: string; // Content-type (only for Blob type)\n}\n\n/**\n * Resolved blob with its keyPath for queueing\n */\nexport interface ResolvedBlob {\n keyPath: string;\n data: Blob | ArrayBuffer | ArrayBufferView | string;\n ref: string;\n}\n\n/**\n * Check if a value is a BlobRef (offloaded binary data)\n * A BlobRef has _bt (type), ref (blob ID), but no v (inline data)\n */\nexport function isBlobRef(value: unknown): value is BlobRef {\n if (typeof value !== 'object' || value === null) return false;\n const obj = value as any;\n return (\n typeof obj._bt === 'string' &&\n typeof obj.ref === 'string' &&\n obj.v === undefined // No inline data = it's a reference\n );\n}\n\n/**\n * Serialized TSONRef shape (after IndexedDB structured clone).\n * The Symbol is lost but properties remain.\n */\nexport interface SerializedTSONRef {\n type: string; // 'Uint8Array', 'Blob', etc.\n ref: string; // '1:blobId'\n size: number;\n contentType?: string;\n}\n\n/**\n * Check if a value is a serialized TSONRef (after IndexedDB storage)\n * Has 'type' instead of '$t', and no Symbol marker\n */\nexport function isSerializedTSONRef(value: unknown): value is SerializedTSONRef {\n if (typeof value !== 'object' || value === null) return false;\n const obj = value as any;\n return (\n typeof obj.type === 'string' &&\n typeof obj.ref === 'string' &&\n typeof obj.size === 'number' &&\n obj._bt === undefined // Not a raw BlobRef\n );\n}\n\n/**\n * Recursively check if an object contains any BlobRefs\n */\nexport function hasBlobRefs(obj: unknown, visited = new WeakSet()): boolean {\n if (obj === null || obj === undefined) {\n return false;\n }\n\n if (isBlobRef(obj)) {\n return true;\n }\n\n if (typeof obj !== 'object') {\n return false;\n }\n\n // Avoid circular references - check BEFORE processing\n if (visited.has(obj)) {\n return false;\n }\n visited.add(obj);\n\n // Skip special objects that can't contain BlobRefs\n if (obj instanceof Date || obj instanceof RegExp || obj instanceof Blob) {\n return false;\n }\n if (obj instanceof ArrayBuffer || ArrayBuffer.isView(obj)) {\n return false;\n }\n\n if (Array.isArray(obj)) {\n return obj.some(item => hasBlobRefs(item, visited));\n }\n\n // Only traverse POJOs\n if (obj.constructor === Object) {\n return Object.values(obj).some(value => hasBlobRefs(value, visited));\n }\n\n return false;\n}\n\n/**\n * Convert downloaded Uint8Array to the original type specified in BlobRef\n */\nexport function convertToOriginalType(\n data: Uint8Array, \n ref: BlobRef\n): Blob | ArrayBuffer | ArrayBufferView | string {\n // String type: decode UTF-8 back to string\n if (ref._bt === 'string') {\n return new TextDecoder().decode(data);\n }\n\n // Get the underlying ArrayBuffer (handle shared buffer case)\n const buffer = data.buffer.byteLength === data.byteLength\n ? data.buffer as ArrayBuffer\n : data.buffer.slice(data.byteOffset, data.byteOffset + data.byteLength) as ArrayBuffer;\n \n switch (ref._bt) {\n case 'Blob':\n return new Blob([new Uint8Array(buffer)], { type: ref.ct || '' });\n case 'ArrayBuffer':\n return buffer;\n case 'Uint8Array':\n return data;\n case 'Int8Array':\n return new Int8Array(buffer);\n case 'Uint8ClampedArray':\n return new Uint8ClampedArray(buffer);\n case 'Int16Array':\n return new Int16Array(buffer);\n case 'Uint16Array':\n return new Uint16Array(buffer);\n case 'Int32Array':\n return new Int32Array(buffer);\n case 'Uint32Array':\n return new Uint32Array(buffer);\n case 'Float32Array':\n return new Float32Array(buffer);\n case 'Float64Array':\n return new Float64Array(buffer);\n case 'BigInt64Array':\n return new BigInt64Array(buffer);\n case 'BigUint64Array':\n return new BigUint64Array(buffer);\n case 'DataView':\n return new DataView(buffer);\n default:\n // Fallback to Uint8Array for unknown types\n return data;\n }\n}\n\n/**\n * Recursively resolve all BlobRefs in an object and collect them for queueing.\n * Returns a new object with BlobRefs replaced by their original type data,\n * and populates the resolvedBlobs array with keyPath info for each blob.\n * \n * @param obj - Object to resolve\n * @param dbUrl - Base URL for the database\n * @param accessToken - Access token for blob downloads\n * @param resolvedBlobs - Array to collect resolved blob info\n * @param currentPath - Current property path (for tracking)\n * @param visited - WeakMap for circular reference detection\n */\nexport async function resolveAllBlobRefs(\n obj: unknown,\n dbUrl: string,\n resolvedBlobs: ResolvedBlob[] = [],\n currentPath: string = '',\n visited = new WeakMap(),\n tracker: BlobDownloadTracker\n): Promise {\n if (obj == null) { // null or undefined\n return obj;\n }\n\n // Check if this is a BlobRef - resolve it and track it\n if (isBlobRef(obj)) {\n const rawData = await tracker.download(obj, dbUrl);\n const data = convertToOriginalType(rawData, obj);\n resolvedBlobs.push({ keyPath: currentPath, data, ref: obj.ref });\n return data;\n }\n\n // Handle arrays\n if (Array.isArray(obj)) {\n // Avoid circular references - check and set BEFORE iterating\n if (visited.has(obj)) {\n return visited.get(obj);\n }\n const result: unknown[] = [];\n visited.set(obj, result); // Set before iterating to handle self-references\n for (let i = 0; i < obj.length; i++) {\n const itemPath = currentPath ? `${currentPath}.${i}` : `${i}`;\n result.push(await resolveAllBlobRefs(obj[i], dbUrl, resolvedBlobs, itemPath, visited, tracker));\n }\n return result;\n }\n\n // Handle POJO objects only (not Date, RegExp, Blob, ArrayBuffer, etc.)\n if (typeof obj === 'object' && obj.constructor === Object) {\n // Avoid circular references\n if (visited.has(obj)) {\n return visited.get(obj);\n }\n\n const result: Record = {};\n visited.set(obj, result);\n\n for (const [propName, value] of Object.entries(obj)) {\n // Skip the _hasBlobRefs marker itself\n if (propName === '_hasBlobRefs') {\n continue;\n }\n const propPath = currentPath ? `${currentPath}.${propName}` : propName;\n result[propName] = await resolveAllBlobRefs(value, dbUrl, resolvedBlobs, propPath, visited, tracker);\n }\n\n return result;\n }\n\n return obj;\n}\n\n/**\n * Check if an object has unresolved BlobRefs\n */\nexport function hasUnresolvedBlobRefs(obj: unknown): boolean {\n return (\n typeof obj === 'object' &&\n obj !== null &&\n (obj as any)._hasBlobRefs === 1\n );\n}\n\n\n" }, { "path": "addons/dexie-cloud/src/sync/connectWebSocket.ts", "content": "import { BehaviorSubject, firstValueFrom, from, Observable, of, throwError, merge } from 'rxjs';\nimport {\n catchError,\n combineLatestAll,\n debounceTime,\n delay,\n distinctUntilChanged,\n filter,\n map,\n mergeMap,\n switchMap,\n take,\n tap,\n} from 'rxjs/operators';\nimport { refreshAccessToken } from '../authentication/authenticate';\nimport { DexieCloudDB } from '../db/DexieCloudDB';\nimport { PersistedSyncState } from '../db/entities/PersistedSyncState';\nimport { computeRealmSetHash } from '../helpers/computeRealmSetHash';\nimport {\n userDoesSomething,\n userIsActive,\n userIsReallyActive,\n} from '../userIsActive';\nimport {\n ReadyForChangesMessage,\n WSConnectionMsg,\n WSObservable,\n} from '../WSObservable';\nimport { InvalidLicenseError } from '../InvalidLicenseError';\nimport { read } from 'fs';\n\nfunction sleep(ms: number) {\n return new Promise((resolve) => setTimeout(resolve, ms));\n}\n\nasync function waitAndReconnectWhenUserDoesSomething(error: Error) {\n console.error(\n `WebSocket observable: error but revive when user does some active thing...`,\n error\n );\n // Sleep some seconds...\n await sleep(3000);\n // Wait til user does something (move mouse, tap, scroll, click etc)\n console.debug('waiting for someone to do something');\n await firstValueFrom(userDoesSomething);\n console.debug('someone did something!');\n}\n\nexport function connectWebSocket(db: DexieCloudDB) {\n if (!db.cloud.options?.databaseUrl) {\n throw new Error(`No database URL to connect WebSocket to`);\n }\n\n const readyForChangesMessage = db.messageConsumer.readyToServe.pipe(\n filter((isReady) => isReady), // When consumer is ready for new messages, produce such a message to inform server about it\n switchMap(() => db.getPersistedSyncState()), // We need the info on which server revision we are at:\n filter((syncState) => syncState && syncState.serverRevision), // We wont send anything to server before inital sync has taken place\n switchMap>(async (syncState) => ({\n // Produce the message to trigger server to send us new messages to consume:\n type: 'ready',\n rev: syncState.serverRevision,\n realmSetHash: await computeRealmSetHash(syncState)\n } satisfies ReadyForChangesMessage))\n );\n\n const messageProducer = merge(\n readyForChangesMessage,\n db.messageProducer\n );\n\n function createObservable(): Observable {\n return db.cloud.persistedSyncState.pipe(\n filter((syncState) => syncState?.serverRevision), // Don't connect before there's no initial sync performed.\n take(1), // Don't continue waking up whenever syncState change\n switchMap((syncState) =>\n db.cloud.currentUser.pipe(\n map((userLogin) => [userLogin, syncState] as const)\n )\n ),\n switchMap(([userLogin, syncState]) => {\n /*if (userLogin.license?.status && userLogin.license.status !== 'ok') {\n throw new InvalidLicenseError();\n }*/\n return userIsReallyActive.pipe(\n map((isActive) => [isActive ? userLogin : null, syncState] as const)\n );\n }),\n switchMap(([userLogin, syncState]) => {\n if (userLogin?.isLoggedIn && !syncState?.realms.includes(userLogin.userId!)) {\n // We're in an in-between state when user is logged in but the user's realms are not yet synced.\n // Don't make this change reconnect the websocket just yet. Wait till syncState is updated\n // to iclude the user's realm.\n return db.cloud.persistedSyncState.pipe(\n filter((syncState) => syncState?.realms.includes(userLogin!.userId!) || false),\n take(1),\n map((syncState) => [userLogin, syncState] as const)\n );\n }\n return new BehaviorSubject([userLogin, syncState] as const);\n }),\n switchMap(\n async ([userLogin, syncState]) =>\n [userLogin, await computeRealmSetHash(syncState!)] as const\n ),\n distinctUntilChanged(([prevUser, prevHash], [currUser, currHash]) => prevUser === currUser && prevHash === currHash ),\n switchMap(([userLogin, realmSetHash]) => {\n if (!db.cloud.persistedSyncState?.value) {\n // Restart the flow if persistedSyncState is not yet available.\n return createObservable();\n }\n // Let server end query changes from last entry of same client-ID and forward.\n // If no new entries, server won't bother the client. If new entries, server sends only those\n // and the baseRev of the last from same client-ID.\n if (userLogin) {\n return new WSObservable(\n db,\n db.cloud.persistedSyncState!.value!.serverRevision,\n db.cloud.persistedSyncState!.value!.yServerRevision,\n realmSetHash,\n db.cloud.persistedSyncState!.value!.clientIdentity,\n messageProducer,\n db.cloud.webSocketStatus,\n userLogin\n );\n } else {\n return from([] as WSConnectionMsg[]);\n }}),\n catchError((error) => {\n if (error?.name === 'TokenExpiredError') {\n console.debug(\n 'WebSocket observable: Token expired. Refreshing token...'\n );\n return of(true).pipe(\n switchMap(async () => {\n // Refresh access token\n const user = await db.getCurrentUser();\n const refreshedLogin = await refreshAccessToken(\n db.cloud.options!.databaseUrl,\n user\n );\n // Persist updated access token\n await db.table('$logins').update(user.userId, {\n accessToken: refreshedLogin.accessToken,\n accessTokenExpiration: refreshedLogin.accessTokenExpiration,\n claims: refreshedLogin.claims,\n license: refreshedLogin.license,\n data: refreshedLogin.data\n });\n }),\n switchMap(() => createObservable())\n );\n } else {\n return throwError(()=>error);\n }\n }),\n catchError((error) => {\n db.cloud.webSocketStatus.next(\"error\");\n if (error instanceof InvalidLicenseError) {\n // Don't retry. Just throw and don't try connect again.\n return throwError(() => error);\n }\n return from(waitAndReconnectWhenUserDoesSomething(error)).pipe(\n switchMap(() => createObservable())\n );\n })\n ) as Observable;\n }\n\n return createObservable().subscribe({\n next: (msg) => {\n if (msg) {\n console.debug('WS got message', msg);\n db.messageConsumer.enqueue(msg);\n }\n },\n error: (error) => {\n console.error('WS got error', error);\n },\n complete: () => {\n console.debug('WS observable completed');\n },\n });\n}\n" }, { "path": "addons/dexie-cloud/src/sync/eagerBlobDownloader.ts", "content": "/**\n * Eager Blob Downloader\n * \n * Downloads unresolved blobs in the background when blobMode='eager'.\n * Called after sync completes to prefetch blobs for offline access.\n * \n * Progress is tracked automatically via liveQuery in blobProgress.ts —\n * no manual progress reporting needed here.\n */\n\nimport Dexie, { UpdateSpec } from 'dexie';\nimport { BehaviorSubject } from 'rxjs';\nimport { TSONRef, hasTSONRefs } from 'dexie-cloud-common';\nimport {\n BlobRef,\n isBlobRef,\n hasBlobRefs,\n hasUnresolvedBlobRefs,\n isSerializedTSONRef,\n resolveAllBlobRefs,\n ResolvedBlob,\n} from './blobResolve';\nimport { loadCachedAccessToken } from './loadCachedAccessToken';\nimport { setDownloadingState } from './blobProgress';\nimport { DexieCloudDB } from '../db/DexieCloudDB';\nimport { getSyncableTables } from '../helpers/getSyncableTables';\n\n/**\n * Download all unresolved blobs in the background.\n * \n * This is called when blobMode='eager' (default) after sync completes.\n * BlobRef URLs are signed (SAS tokens) so no auth header needed.\n * \n * Each blob is saved atomically using Table.update() to avoid race conditions.\n */\nexport async function downloadUnresolvedBlobs(\n db: DexieCloudDB,\n downloading$: BehaviorSubject,\n signal?: AbortSignal\n): Promise {\n const debugLog = (msg: string) => console.debug(`[dexie-cloud] ${msg}`);\n \n debugLog('Eager download: Starting...');\n\n // Scan for unresolved blobs\n const syncedTables = getSyncableTables(db);\n let hasWork = false;\n\n for (const table of syncedTables) {\n try {\n const hasIndex = !!table.schema.idxByName['_hasBlobRefs'];\n if (!hasIndex) continue;\n const count = await table.where('_hasBlobRefs').equals(1).count();\n if (count > 0) {\n hasWork = true;\n break;\n }\n } catch {\n // skip\n }\n }\n\n if (!hasWork) {\n debugLog('Eager download: No blobs remaining, exiting');\n return;\n }\n\n setDownloadingState(downloading$, true);\n\n try {\n debugLog(`Eager download: Found ${syncedTables.length} syncable tables: ${syncedTables.map(t => t.name).join(', ')}`);\n \n for (const table of syncedTables) {\n if (signal?.aborted) break;\n\n try {\n // Check if table has _hasBlobRefs index\n const hasIndex = table.schema.indexes.some(idx => idx.name === '_hasBlobRefs');\n if (!hasIndex) continue;\n\n // Query objects with _hasBlobRefs marker\n const unresolvedObjects = await table\n .where('_hasBlobRefs')\n .equals(1)\n .toArray();\n\n debugLog(`Eager download: Table ${table.name} has ${unresolvedObjects.length} unresolved objects`);\n\n const databaseUrl = db.cloud.options?.databaseUrl;\n if (!databaseUrl) throw new Error('Database URL is required to download blobs');\n\n // Download up to MAX_CONCURRENT blobs in parallel\n const MAX_CONCURRENT = 6;\n const primaryKey = table.schema.primKey;\n\n // Filter to actionable objects first\n const pending = unresolvedObjects.filter(obj => {\n if (!hasUnresolvedBlobRefs(obj)) return false;\n const key = primaryKey.keyPath\n ? Dexie.getByKeyPath(obj, primaryKey.keyPath as string)\n : undefined;\n return key !== undefined;\n });\n\n // Process in parallel with concurrency limit\n let i = 0;\n const runNext = async (): Promise => {\n while (i < pending.length) {\n if (signal?.aborted) return;\n const obj = pending[i++];\n const key = Dexie.getByKeyPath(obj, primaryKey.keyPath as string);\n\n try {\n // Refresh token per object — cheap (returns cached) but ensures\n // we pick up renewed tokens during long download sessions.\n const resolvedBlobs: ResolvedBlob[] = [];\n await resolveAllBlobRefs(obj, databaseUrl, resolvedBlobs, '', new WeakMap(), db.blobDownloadTracker);\n\n const updateSpec: UpdateSpec = {\n _hasBlobRefs: undefined,\n };\n for (const blob of resolvedBlobs) {\n updateSpec[blob.keyPath] = blob.data;\n }\n\n debugLog(`Eager download: Updating ${table.name}:${key} with ${resolvedBlobs.length} blobs`);\n await table.update(key, updateSpec);\n // liveQuery in blobProgress.ts auto-detects this change\n } catch (err) {\n console.error(`Failed to download blobs for ${table.name}:${key}:`, err);\n }\n }\n };\n\n // Launch up to MAX_CONCURRENT workers\n const workers: Promise[] = [];\n for (let w = 0; w < Math.min(MAX_CONCURRENT, pending.length); w++) {\n workers.push(runNext());\n }\n await Promise.all(workers);\n } catch (err) {\n // Table might not have _hasBlobRefs index or other issues - skip silently\n }\n }\n } finally {\n setDownloadingState(downloading$, false);\n }\n}\n" }, { "path": "addons/dexie-cloud/src/sync/encodeIdsForServer.ts", "content": "import Dexie, { DBCoreSchema } from 'dexie';\nimport {\n DBInsertOperation,\n DBOperation,\n DBOperationsSet,\n DBOpPrimaryKey,\n} from 'dexie-cloud-common';\nimport { UserLogin } from '../db/entities/UserLogin';\n\nexport function encodeIdsForServer(\n schema: DBCoreSchema,\n currentUser: UserLogin,\n changes: DBOperationsSet\n): DBOperationsSet {\n const rv: DBOperationsSet = [];\n for (let change of changes) {\n const { table, muts } = change;\n const tableSchema = schema.tables.find((t) => t.name === table);\n if (!tableSchema)\n throw new Error(\n `Internal error: table ${table} not found in DBCore schema`\n );\n const { primaryKey } = tableSchema;\n let changeClone = change;\n muts.forEach((mut, mutIndex) => {\n const rewriteValues =\n !primaryKey.outbound &&\n (mut.type === 'upsert' || mut.type === 'insert');\n mut.keys.forEach((key, keyIndex) => {\n if (Array.isArray(key)) {\n // Server only support string keys. Dexie Cloud client support strings or array of strings.\n if (changeClone === change)\n changeClone = cloneChange(change, rewriteValues);\n const mutClone = changeClone.muts[mutIndex];\n const rewrittenKey = JSON.stringify(key);\n mutClone.keys[keyIndex] = rewrittenKey;\n /* Bug (#1777)\n We should not rewrite values. It will fail because the key is array and the value is string.\n Only the keys should be rewritten and it's already done on the server.\n We should take another round of revieweing how key transformations are being done between\n client and server and let the server do the key transformations entirely instead now that\n we have the primary key schema on the server making it possible to do so.\n if (rewriteValues) {\n Dexie.setByKeyPath(\n (mutClone as DBInsertOperation).values[keyIndex],\n primaryKey.keyPath!,\n rewrittenKey\n );\n }*/\n } else if (key[0] === '#') {\n // Private ID - translate!\n if (changeClone === change)\n changeClone = cloneChange(change, rewriteValues);\n const mutClone = changeClone.muts[mutIndex];\n if (!currentUser.isLoggedIn)\n throw new Error(\n `Internal error: Cannot sync private IDs before authenticated`\n );\n const rewrittenKey = `${key}:${currentUser.userId}`;\n mutClone.keys[keyIndex] = rewrittenKey;\n if (rewriteValues) {\n Dexie.setByKeyPath(\n (mutClone as DBInsertOperation).values[keyIndex],\n primaryKey.keyPath!,\n rewrittenKey\n );\n }\n }\n });\n });\n rv.push(changeClone);\n }\n return rv;\n}\n\nfunction cloneChange(change: DBOperationsSet[number], rewriteValues: boolean) {\n // clone on demand:\n return {\n ...change,\n muts: rewriteValues\n ? change.muts.map((m) => {\n return (m.type === 'insert' || m.type === 'upsert') && m.values\n ? {\n ...m,\n keys: m.keys.slice(),\n values: m.values.slice(),\n }\n : {\n ...m,\n keys: m.keys.slice(),\n };\n })\n : change.muts.map((m) => ({ ...m, keys: m.keys.slice() })),\n };\n}\n" }, { "path": "addons/dexie-cloud/src/sync/extractRealm.ts", "content": "import { EntityCommon } from \"../db/entities/EntityCommon\";\n\nexport function extractRealm(obj: EntityCommon) {\n return obj?.realmId;\n}\n" }, { "path": "addons/dexie-cloud/src/sync/getLatestRevisionsPerTable.ts", "content": "import { DBOperationsSet } from 'dexie-cloud-common';\n\nexport function getLatestRevisionsPerTable(\n clientChangeSet: DBOperationsSet,\n lastRevisions = {} as { [table: string]: number; }) {\n for (const { table, muts } of clientChangeSet) {\n const lastRev = muts.length > 0 ? muts[muts.length - 1].rev : null;\n lastRevisions[table] = lastRev || lastRevisions[table] || 0;\n }\n return lastRevisions;\n}\n" }, { "path": "addons/dexie-cloud/src/sync/getTablesToSyncify.ts", "content": "import { getSyncableTables } from \"../helpers/getSyncableTables\";\nimport { DexieCloudDB } from \"../db/DexieCloudDB\";\nimport { PersistedSyncState } from \"../db/entities/PersistedSyncState\";\n\nexport function getTablesToSyncify(db: DexieCloudDB, syncState: PersistedSyncState | undefined) {\n const syncedTables = syncState?.syncedTables || [];\n const syncableTables = getSyncableTables(db);\n const tablesToSyncify = syncableTables.filter(\n (tbl) => !syncedTables.includes(tbl.name)\n );\n return tablesToSyncify;\n}\n" }, { "path": "addons/dexie-cloud/src/sync/isOnline.ts", "content": "/* Need this because navigator.onLine seems to say \"false\" when it is actually online.\n This function relies initially on navigator.onLine but then uses online and offline events\n which seem to be more reliable.\n*/\nexport let isOnline = false;\nif (typeof self !== 'undefined' && typeof navigator !== 'undefined') {\n isOnline = navigator.onLine;\n self.addEventListener('online', ()=>isOnline = true);\n self.addEventListener('offline', ()=>isOnline = false);\n}\n" }, { "path": "addons/dexie-cloud/src/sync/isSyncNeeded.ts", "content": "import { DexieCloudDB } from \"../db/DexieCloudDB\";\nimport { sync } from \"./sync\";\n\nexport async function isSyncNeeded(db: DexieCloudDB) {\n return db.cloud.options?.databaseUrl && db.cloud.schema\n ? await sync(db, db.cloud.options, db.cloud.schema, {justCheckIfNeeded: true})\n : false;\n}\n" }, { "path": "addons/dexie-cloud/src/sync/listClientChanges.ts", "content": "import { PropModification, Table, UpdateSpec } from 'dexie';\nimport { getTableFromMutationTable } from '../helpers/getTableFromMutationTable';\nimport { DexieCloudDB } from '../db/DexieCloudDB';\nimport { DBOperation, DBOperationsSet, DBUpdateOperation } from 'dexie-cloud-common';\nimport { flatten } from '../helpers/flatten';\n\nexport async function listClientChanges(\n mutationTables: Table[],\n db: DexieCloudDB,\n { since = {} as { [table: string]: number }, limit = Infinity } = {}\n): Promise {\n const allMutsOnTables = await Promise.all(\n mutationTables.map(async (mutationTable) => {\n const tableName = getTableFromMutationTable(mutationTable.name);\n const lastRevision = since[tableName];\n\n let query = lastRevision\n ? mutationTable.where('rev').above(lastRevision)\n : mutationTable;\n\n if (limit < Infinity) query = query.limit(limit);\n\n let muts: DBOperation[] = await query.toArray();\n\n muts = canonicalizeToUpdateOps(muts);\n\n muts = removeRedundantUpdateOps(muts);\n\n const rv = muts.map((mut) => ({\n table: tableName,\n mut,\n }));\n\n return rv;\n })\n );\n\n // Sort by time to get a true order of the operations (between tables)\n const sorted = flatten(allMutsOnTables).sort((a, b) => a.mut.txid === b.mut.txid\n ? a.mut.opNo! - b.mut.opNo! // Within same transaction, sort by opNo\n : a.mut.ts! - b.mut.ts! // Different transactions - sort by timestamp when mutation resolved\n );\n const result: DBOperationsSet = [];\n let currentEntry: {\n table: string;\n muts: DBOperation[];\n } | null = null;\n let currentTxid: string | null = null;\n for (const { table, mut } of sorted) {\n if (\n currentEntry &&\n currentEntry.table === table &&\n currentTxid === mut.txid\n ) {\n currentEntry.muts.push(mut);\n } else {\n currentEntry = {\n table,\n muts: [mut],\n };\n currentTxid = mut.txid!;\n result.push(currentEntry);\n }\n }\n\n // Filter out those tables that doesn't have any mutations:\n return result;\n}\n\n\nfunction removeRedundantUpdateOps(muts: DBOperation[]) {\n const updateCoverage = new Map; }>>();\n for (const mut of muts) {\n if (mut.type === 'update') {\n if (mut.keys.length !== 1 || mut.changeSpecs.length !== 1) {\n continue; // Don't optimize multi-key updates\n }\n const strKey = '' + mut.keys[0];\n const changeSpecs = mut.changeSpecs[0];\n if (Object.values(changeSpecs).some(v => typeof v === \"object\" && v && \"@@propmod\" in v)) {\n continue; // Cannot optimize if any PropModification is present\n }\n let keyCoverage = updateCoverage.get(strKey);\n if (keyCoverage) {\n keyCoverage.push({ txid: mut.txid!, updateSpec: changeSpecs });\n } else {\n updateCoverage.set(strKey, [{ txid: mut.txid!, updateSpec: changeSpecs }]);\n }\n }\n }\n muts = muts.filter(mut => {\n // Only apply optimization to update mutations that are single-key\n if (mut.type !== 'update') return true;\n if (mut.keys.length !== 1 || mut.changeSpecs.length !== 1) return true;\n \n // Check if this has PropModifications - if so, skip optimization\n const changeSpecs = mut.changeSpecs[0];\n if (Object.values(changeSpecs).some(v => typeof v === \"object\" && v && \"@@propmod\" in v)) {\n return true; // Cannot optimize if any PropModification is present\n }\n \n // Keep track of properties that aren't overlapped by later transactions\n const unoverlappedProps = new Set(Object.keys(mut.changeSpecs[0]));\n const strKey = '' + mut.keys[0];\n const keyCoverage = updateCoverage.get(strKey);\n if (!keyCoverage) return true; // No coverage info - cannot optimize\n\n for (let i = keyCoverage.length - 1; i >= 0; --i) {\n const { txid, updateSpec } = keyCoverage[i];\n if (txid === mut.txid) break; // Stop when reaching own txid\n\n\n // If all changes in updateSpec are covered by all props on all mut.changeSpecs then\n // txid is redundant and can be removed.\n for (const keyPath of Object.keys(updateSpec)) {\n unoverlappedProps.delete(keyPath);\n }\n }\n if (unoverlappedProps.size === 0) {\n // This operation is completely overlapped by later operations. It can be removed.\n return false;\n }\n return true;\n });\n return muts;\n}\n\nfunction canonicalizeToUpdateOps(muts: DBOperation[]) {\n muts = muts.map(mut => {\n if (mut.type === 'modify' && mut.criteria.index === null) {\n // The criteria is on primary key. Convert to an update operation instead.\n // It is simpler for the server to handle and also more efficient.\n const updateMut = {\n ...mut,\n criteria: undefined,\n changeSpec: undefined,\n type: 'update',\n keys: mut.keys,\n changeSpecs: [mut.changeSpec],\n };\n delete updateMut.criteria;\n delete updateMut.changeSpec;\n return updateMut as DBUpdateOperation;\n }\n\n return mut;\n });\n return muts;\n}\n\n" }, { "path": "addons/dexie-cloud/src/sync/listSyncifiedChanges.ts", "content": "import { UserLogin } from '../db/entities/UserLogin';\nimport { randomString } from '../helpers/randomString';\nimport { EntityCommon } from '../db/entities/EntityCommon';\nimport { Table } from 'dexie';\nimport {\n DBOperationsSet,\n DBUpsertOperation,\n DexieCloudSchema,\n isValidAtID,\n isValidSyncableID,\n} from 'dexie-cloud-common';\n\nexport async function listSyncifiedChanges(\n tablesToSyncify: Table[],\n currentUser: UserLogin,\n schema: DexieCloudSchema,\n alreadySyncedRealms?: string[]\n): Promise {\n const txid = `upload-${randomString(8)}`;\n if (currentUser.isLoggedIn) {\n if (tablesToSyncify.length > 0) {\n const ignoredRealms = new Set(alreadySyncedRealms || []);\n const upserts = await Promise.all(\n tablesToSyncify.map(async (table) => {\n const { extractKey } = table.core.schema.primaryKey;\n if (!extractKey) return { table: table.name, muts: [] }; // Outbound tables are not synced.\n\n const dexieCloudTableSchema = schema[table.name];\n const query = dexieCloudTableSchema?.generatedGlobalId\n ? table.filter((item) => {\n const id = extractKey(item);\n return (\n !ignoredRealms.has(item.realmId || '') &&\n //(id[0] !== '#' || !!item.$ts) && // Private obj need no sync if not changed\n isValidAtID(extractKey(item), dexieCloudTableSchema?.idPrefix)\n );\n })\n : table.filter((item) => {\n const id = extractKey(item);\n\n return (\n !ignoredRealms.has(item.realmId || '') &&\n //(id[0] !== '#' || !!item.$ts) && // Private obj need no sync if not changed\n isValidSyncableID(id)\n );\n });\n const unsyncedObjects = await query.toArray();\n if (unsyncedObjects.length > 0) {\n const mut: DBUpsertOperation = {\n type: 'upsert',\n values: unsyncedObjects,\n keys: unsyncedObjects.map(extractKey),\n userId: currentUser.userId,\n txid,\n };\n return {\n table: table.name,\n muts: [mut],\n };\n } else {\n return {\n table: table.name,\n muts: [],\n };\n }\n })\n );\n return upserts.filter((op) => op.muts.length > 0);\n }\n }\n return [];\n}\n" }, { "path": "addons/dexie-cloud/src/sync/loadCachedAccessToken.ts", "content": "import Dexie from 'dexie';\nimport { loadAccessToken } from '../authentication/authenticate';\nimport { DexieCloudDB } from '../db/DexieCloudDB';\nimport { MINUTES } from '../helpers/date-constants';\n\nconst wm = new WeakMap();\nexport function loadCachedAccessToken(db: DexieCloudDB): Promise {\n let cached = wm.get(db);\n if (cached && cached.expiration > Date.now() + 5 * MINUTES) {\n return Promise.resolve(cached.accessToken);\n }\n const currentUser = db.cloud.currentUser.value;\n if (currentUser && currentUser.accessToken && (currentUser.accessTokenExpiration?.getTime() ?? Infinity) > Date.now() + 5 * MINUTES) {\n wm.set(db, {\n accessToken: currentUser.accessToken,\n expiration: currentUser.accessTokenExpiration?.getTime() ?? Infinity\n });\n return Promise.resolve(currentUser.accessToken);\n }\n return Dexie.ignoreTransaction(() => loadAccessToken(db).then(user => {\n if (user?.accessToken) {\n wm.set(db, {\n accessToken: user.accessToken,\n expiration: user.accessTokenExpiration?.getTime() ?? Infinity\n });\n }\n return user?.accessToken || null;\n }));\n}\n" }, { "path": "addons/dexie-cloud/src/sync/messageConsumerIsReady.ts", "content": "import { BehaviorSubject } from \"rxjs\";\n\nexport const messageConsumerIsReady = new BehaviorSubject(false);\n" }, { "path": "addons/dexie-cloud/src/sync/messagesFromServerQueue.ts", "content": "import { BehaviorSubject, firstValueFrom } from 'rxjs';\nimport { filter, take } from 'rxjs/operators';\nimport { DexieCloudDB } from '../db/DexieCloudDB';\nimport { WSConnectionMsg } from '../WSObservable';\nimport { triggerSync } from './triggerSync';\nimport Dexie from 'dexie';\nimport { computeRealmSetHash } from '../helpers/computeRealmSetHash';\nimport { DBOperationsSet } from 'dexie-cloud-common';\nimport { getSyncableTables } from '../helpers/getSyncableTables';\nimport { getMutationTable } from '../helpers/getMutationTable';\nimport { listClientChanges } from './listClientChanges';\nimport { filterServerChangesThroughAddedClientChanges } from './sync';\nimport { applyServerChanges } from './applyServerChanges';\nimport { updateBaseRevs } from './updateBaseRevs';\nimport { getLatestRevisionsPerTable } from './getLatestRevisionsPerTable';\nimport { refreshAccessToken } from '../authentication/authenticate';\n\nconst LIMIT_NUM_MESSAGES_PER_TIME = 10; // Allow a maximum of 10 messages per...\nconst TIME_WINDOW = 10_000; // ...10 seconds.\nconst PAUSE_PERIOD = 1_000; // Pause for 1 second if reached\n\nexport type MessagesFromServerConsumer = ReturnType<\n typeof MessagesFromServerConsumer\n>;\n\nexport function MessagesFromServerConsumer(db: DexieCloudDB) {\n const queue: WSConnectionMsg[] = [];\n const readyToServe = new BehaviorSubject(true);\n const event = new BehaviorSubject(null);\n let isWorking = false;\n\n let loopDetection = new Array(LIMIT_NUM_MESSAGES_PER_TIME).fill(0);\n\n event.subscribe(async () => {\n if (isWorking) return;\n if (queue.length > 0) {\n isWorking = true;\n loopDetection.shift();\n loopDetection.push(Date.now());\n readyToServe.next(false);\n try {\n await consumeQueue();\n } finally {\n if (\n loopDetection[loopDetection.length - 1] - loopDetection[0] <\n TIME_WINDOW\n ) {\n // Ten loops within 10 seconds. Slow down!\n // This is a one-time event. Just pause 10 seconds.\n console.warn(`Slowing down websocket loop for ${PAUSE_PERIOD} milliseconds`);\n await new Promise((resolve) => setTimeout(resolve, PAUSE_PERIOD));\n }\n isWorking = false;\n readyToServe.next(true);\n }\n }\n });\n\n function enqueue(msg: WSConnectionMsg) {\n queue.push(msg);\n event.next(null);\n }\n\n async function consumeQueue() {\n while (queue.length > 0) {\n const msg = queue.shift();\n try {\n // If the sync worker or service worker is syncing, wait 'til thei're done.\n // It's no need to have two channels at the same time - even though it wouldnt\n // be a problem - this is an optimization.\n await firstValueFrom(\n db.cloud.syncState.pipe(\n filter(({ phase }) => phase === 'in-sync' || phase === 'error')\n )\n );\n console.debug('processing msg', msg);\n const persistedSyncState = db.cloud.persistedSyncState.value;\n //syncState.\n if (!msg) continue;\n switch (msg.type) {\n case 'token-expired':\n console.debug(\n 'WebSocket observable: Token expired. Refreshing token...'\n );\n const user = db.cloud.currentUser.value;\n // Refresh access token\n const refreshedLogin = await refreshAccessToken(\n db.cloud.options!.databaseUrl,\n user\n );\n // Persist updated access token\n await db.table('$logins').update(user.userId, {\n accessToken: refreshedLogin.accessToken,\n accessTokenExpiration: refreshedLogin.accessTokenExpiration,\n claims: refreshedLogin.claims,\n license: refreshedLogin.license,\n data: refreshedLogin.data,\n });\n // Updating $logins will trigger emission of db.cloud.currentUser observable, which\n // in turn will lead to that connectWebSocket.ts will reconnect the socket with the\n // new token. So we don't need to do anything more here.\n break;\n case 'realm-added':\n if (\n !persistedSyncState?.realms?.includes(msg.realm) &&\n !persistedSyncState?.inviteRealms?.includes(msg.realm)\n ) {\n await db.cloud.sync({ purpose: 'pull', wait: true });\n //triggerSync(db, 'pull');\n }\n break;\n case 'realm-accepted':\n if (!persistedSyncState?.realms?.includes(msg.realm)) {\n await db.cloud.sync({ purpose: 'pull', wait: true });\n //triggerSync(db, 'pull');\n }\n break;\n case 'realm-removed':\n if (\n persistedSyncState?.realms?.includes(msg.realm) ||\n persistedSyncState?.inviteRealms?.includes(msg.realm)\n ) {\n await db.cloud.sync({ purpose: 'pull', wait: true });\n //triggerSync(db, 'pull');\n }\n break;\n case 'realms-changed':\n //triggerSync(db, 'pull');\n await db.cloud.sync({ purpose: 'pull', wait: true });\n break;\n case 'changes': {\n console.debug('changes');\n if (db.cloud.syncState.value?.phase === 'error') {\n triggerSync(db, 'pull');\n break;\n }\n const didApplyChanges = await db.transaction('rw', db.dx.tables, async (tx) => {\n // @ts-ignore\n tx.idbtrans.disableChangeTracking = true;\n // @ts-ignore\n tx.idbtrans.disableAccessControl = true;\n const [schema, syncState, currentUser] = await Promise.all([\n db.getSchema(),\n db.getPersistedSyncState(),\n db.getCurrentUser(),\n ]);\n console.debug('ws message queue: in transaction');\n if (!syncState || !schema || !currentUser) {\n console.debug('required vars not present', {\n syncState,\n schema,\n currentUser,\n });\n return false; // Initial sync must have taken place - otherwise, ignore this.\n }\n // Verify again in ACID tx that we're on same server revision.\n if (msg.baseRev !== syncState.serverRevision) {\n console.debug(\n `baseRev (${msg.baseRev}) differs from our serverRevision in syncState (${syncState.serverRevision})`\n );\n // Should we trigger a sync now? No. This is a normal case\n // when another local peer (such as the SW or a websocket channel on other tab) has\n // updated syncState from new server information but we are not aware yet. It would\n // be unnescessary to do a sync in that case. Instead, the caller of this consumeQueue()\n // function will do readyToServe.next(true) right after this return, which will lead\n // to a \"ready\" message being sent to server with the new accurate serverRev we have,\n // so that the next message indeed will be correct.\n if (\n typeof msg.baseRev === 'string' && // v2 format\n (typeof syncState.serverRevision === 'bigint' || // v1 format\n typeof syncState.serverRevision === 'object') // v1 format old browser\n ) {\n // The reason for the diff seems to be that server has migrated the revision format.\n // Do a full sync to update revision format.\n // If we don't do a sync request now, we could stuck in an endless loop.\n triggerSync(db, 'pull');\n }\n return false; // Ignore message\n }\n // Verify also that the message is based on the exact same set of realms\n const ourRealmSetHash = await Dexie.waitFor(\n // Keep TX in non-IDB work\n computeRealmSetHash(syncState)\n );\n console.debug('ourRealmSetHash', ourRealmSetHash);\n if (ourRealmSetHash !== msg.realmSetHash) {\n console.debug('not same realmSetHash', msg.realmSetHash);\n triggerSync(db, 'pull');\n // The message isn't based on the same realms.\n // Trigger a sync instead to resolve all things up.\n return false;\n }\n\n // Get clientChanges\n let clientChanges: DBOperationsSet = [];\n if (currentUser.isLoggedIn) {\n const mutationTables = getSyncableTables(db).map((tbl) =>\n db.table(getMutationTable(tbl.name))\n );\n clientChanges = await listClientChanges(mutationTables, db);\n console.debug('msg queue: client changes', clientChanges);\n }\n if (msg.changes.length > 0) {\n const filteredChanges =\n filterServerChangesThroughAddedClientChanges(\n msg.changes,\n clientChanges\n );\n\n //\n // apply server changes\n //\n console.debug(\n 'applying filtered server changes',\n filteredChanges\n );\n await applyServerChanges(filteredChanges, db);\n }\n\n // Update latest revisions per table in case there are unsynced changes\n // This can be a real case in future when we allow non-eagery sync.\n // And it can actually be realistic now also, but very rare.\n syncState.latestRevisions = getLatestRevisionsPerTable(\n clientChanges,\n syncState.latestRevisions\n );\n\n syncState.serverRevision = msg.newRev;\n\n // Update base revs\n console.debug('Updating baseRefs', syncState.latestRevisions);\n await updateBaseRevs(\n db,\n schema!,\n syncState.latestRevisions,\n msg.newRev\n );\n\n //\n // Update syncState\n //\n console.debug('Updating syncState', syncState);\n await db.$syncState.put(syncState, 'syncState');\n return true;\n });\n console.debug('msg queue: done with rw transaction');\n // Trigger eager blob download for any BlobRefs received via WebSocket.\n // This mirrors the behavior after normal HTTP sync (syncCompleteEvent).\n // Only emit if changes were actually applied (not on early returns).\n if (didApplyChanges && msg.changes.length > 0) {\n db.syncCompleteEvent.next();\n }\n break;\n }\n }\n } catch (error) {\n console.error(`Error in msg queue`, error);\n }\n }\n }\n\n return {\n enqueue,\n readyToServe,\n };\n}\n" }, { "path": "addons/dexie-cloud/src/sync/modifyLocalObjectsWithNewUserId.ts", "content": "import { Table } from \"dexie\";\nimport { EntityCommon } from \"../db/entities/EntityCommon\";\nimport { UserLogin } from \"../db/entities/UserLogin\";\nimport { Member } from \"../db/entities/Member\";\nimport { UNAUTHORIZED_USER } from \"../authentication/UNAUTHORIZED_USER\";\nimport { Realm } from \"../db/entities/Realm\";\n\nexport async function modifyLocalObjectsWithNewUserId(\n syncifiedTables: Table[],\n currentUser: UserLogin,\n alreadySyncedRealms?: string[]) {\n const ignoredRealms = new Set(alreadySyncedRealms || []);\n for (const table of syncifiedTables) {\n if (table.name === \"members\") {\n // members\n await table.toCollection().modify((member: Member) => {\n if (!ignoredRealms.has(member.realmId) && (!member.userId || member.userId === UNAUTHORIZED_USER.userId)) {\n member.userId = currentUser.userId;\n }\n });\n } else if (table.name === \"roles\") {\n // roles\n // No changes needed.\n } else if (table.name === \"realms\") {\n // realms\n await table.toCollection().modify((realm: Realm) => {\n if (!ignoredRealms.has(realm.realmId) && (realm.owner === undefined || realm.owner === UNAUTHORIZED_USER.userId)) {\n realm.owner = currentUser.userId;\n }\n });\n } else {\n // application entities\n await table.toCollection().modify((obj) => {\n if (!obj.realmId || !ignoredRealms.has(obj.realmId)) {\n if (!obj.owner || obj.owner === UNAUTHORIZED_USER.userId)\n obj.owner = currentUser.userId;\n if (!obj.realmId || obj.realmId === UNAUTHORIZED_USER.userId) {\n obj.realmId = currentUser.userId;\n }\n }\n });\n }\n }\n}\n" }, { "path": "addons/dexie-cloud/src/sync/myId.ts", "content": "import { randomString } from \"../helpers/randomString\";\n\nexport const myId = randomString(16);\n" }, { "path": "addons/dexie-cloud/src/sync/numUnsyncedMutations.ts", "content": "import Dexie, { liveQuery } from \"dexie\";\nimport { getMutationTable } from \"../helpers/getMutationTable\";\nimport { getSyncableTables } from \"../helpers/getSyncableTables\";\nimport { combineLatest, forkJoin, from } from \"rxjs\";\nimport { distinctUntilChanged, filter, map } from \"rxjs/operators\";\nimport { DexieCloudDB } from \"../db/DexieCloudDB\";\n\nexport function getNumUnsyncedMutationsObservable(db: DexieCloudDB) {\n const syncableTables = getSyncableTables(db);\n const mutationTables = syncableTables.map((table) =>\n db.table(getMutationTable(table.name))\n );\n const queries = mutationTables.map((mt) => from(liveQuery(() => mt.count())));\n return forkJoin(queries).pipe(\n // Compute the sum of all tables' unsynced changes:\n map((counts) => counts.reduce((x, y) => x + y)),\n // Swallow false positives - when the number was the same as before:\n distinctUntilChanged()\n );\n}\n" }, { "path": "addons/dexie-cloud/src/sync/old_startSyncingClientChanges.ts", "content": "\n /** TODO:\n * 1. Convert these unsynced changes into sync mutations by resolving values from ordinaryTables.\n * 2. Append a convertion of mutReqs[table].muts into sync mutations.\n * 3. Send all this using fetch\n * 4. if successful response, delete muts from mutTables by\n * 1. a new rw-transaction where we start by finding revs above those we generated.\n * 2. for tables where none such found, clear the table. if some of those found, deleteRange on the table.\n * \n * Tankar att följa upp:\n * * Varje DOM environmnet får en MutationSyncer\n * * Håller koll på huruvida den tror att en sync redan pågår eller inte.\n * * Bro\n * \n * Leader election\n * * IDB persisted value: leaderId\n * * Varje browsing-env får en nodeId (random string).\n * * db.open: Kolla om det finns en leader. Om inte, sätt dig själv som leader.\n * * Leaders: Ha sync consumer uppe.\n * * Service worker: Ta ledarskap. Spara även en prop som säger att detta är service worker (för att workaround BroadCastChannel props)\n * * Om det finns en non-service worker ledare, försök kontakta den (via BroadCastChannel)\n * * Om ledaren inte svarar inom 1 sekund, ta ledarskap.\n * * Ledare: Lyssna på ändring av ledarskap och sluta vara ledare i så fall.\n * * Följare: Lyssna på ändring av ledarskap så att du alltid kontaktar rätt ledare.\n * * När man postar något till non-SW ledaren så ska den ACKa inom 1 sek. Annars, ta ledarskapet.\n * \n * \n * Enklare:\n * * Vi har en som leker service worker per window. Två aktiva flikar:\n * * Båda vaknar upp och låser tabellen X för skrivning, om ingen annan tagit jobbet, skriver timestamp till X och\n * börjar sedan synka. Under tiden för sync, uppdaterar den timestamp kontinuerligt för att signallera att den\n * jobbar. När klar, clearar ut timestampen och avslutar jobbet.\n * - Om det inte fanns nåt att göra så clearas timestamp ut och man schedulerar inget mer uppvaknande.\n * * Den som kom sist ser att annan tagit jobbet inom rimlig timestamp och väljer då att polla igen ifall timestampet\n * skulle timat ut.\n * * Om jobbaren verkar tajma ut: gör nytt försök från början. Kan leda till att du blir ledare denna gång.\n * * Om jobbaren clearar ut timestampen pga avslutat jobb så kan väntaren ädnå för säkerhets-skull göra om'et från början.\n * \n * \n */\n" }, { "path": "addons/dexie-cloud/src/sync/performGuardedJob.ts", "content": "import { DexieCloudDB } from \"../db/DexieCloudDB\";\n\nexport function performGuardedJob(\n db: DexieCloudDB,\n jobName: string,\n job: () => Promise\n): Promise {\n if (typeof navigator === 'undefined' || !navigator.locks) {\n // No support for guarding jobs. IE11, node.js, etc.\n return job();\n }\n // @ts-expect-error - LockManager callback type inference issue with generics\n return navigator.locks.request(db.name + '|' + jobName, job);\n}\n" }, { "path": "addons/dexie-cloud/src/sync/ratelimit.ts", "content": "import { DexieCloudDB } from '../db/DexieCloudDB';\n\n// If we get Ratelimit-Limit and Ratelimit-Remaining where Ratelimit-Remaining is below\n// (Ratelimit-Limit / 2), we should delay the next sync by (Ratelimit-Reset / Ratelimit-Remaining)\n// seconds (given that there is a Ratelimit-Reset header).\n\nlet syncRatelimitDelays = new WeakMap();\n\nexport async function checkSyncRateLimitDelay(db: DexieCloudDB) {\n const delatMilliseconds = (syncRatelimitDelays.get(db)?.getTime() ?? 0) - Date.now();\n if (delatMilliseconds > 0) {\n console.debug(`Stalling sync request ${delatMilliseconds} ms to spare ratelimits`);\n await new Promise(resolve => setTimeout(resolve, delatMilliseconds));\n }\n}\n\nexport function updateSyncRateLimitDelays(db: DexieCloudDB, res: Response) {\n const limit = res.headers.get('Ratelimit-Limit');\n const remaining = res.headers.get('Ratelimit-Remaining');\n const reset = res.headers.get('Ratelimit-Reset');\n if (limit && remaining && reset) {\n const limitNum = Number(limit);\n const remainingNum = Math.max(0, Number(remaining));\n const willResetInSeconds = Number(reset);\n if (remainingNum < limitNum / 2) {\n const delay = Math.ceil(willResetInSeconds / (remainingNum + 1));\n syncRatelimitDelays.set(db, new Date(Date.now() + delay * 1000));\n console.debug(`Sync ratelimit delay set to ${delay} seconds`);\n } else {\n syncRatelimitDelays.delete(db);\n console.debug(`Sync ratelimit delay cleared`);\n }\n }\n}\n" }, { "path": "addons/dexie-cloud/src/sync/registerSyncEvent.ts", "content": "import { DexieCloudDB } from '../db/DexieCloudDB';\n\n//const hasSW = 'serviceWorker' in navigator;\nlet hasComplainedAboutSyncEvent = false;\n\nexport async function registerSyncEvent(db: DexieCloudDB, purpose: \"push\" | \"pull\") {\n try {\n // Send sync event to SW:\n const sw: ServiceWorkerRegistration & {sync?: any} = await navigator.serviceWorker.ready;\n if (purpose === \"push\" && sw.sync) {\n await sw.sync.register(`dexie-cloud:${db.name}`);\n }\n if (sw.active) {\n // Use postMessage for pull syncs and for browsers not supporting sync event (Firefox, Safari).\n // Also chromium based browsers with sw.sync as a fallback for sleepy sync events not taking action for a while.\n sw.active.postMessage({\n type: 'dexie-cloud-sync',\n dbName: db.name,\n purpose\n });\n } else {\n throw new Error(`Failed to trigger sync - there's no active service worker`);\n }\n return;\n } catch (e) {\n if (!hasComplainedAboutSyncEvent) {\n console.debug(`Dexie Cloud: Could not register sync event`, e);\n hasComplainedAboutSyncEvent = true;\n }\n }\n}\n\nexport async function registerPeriodicSyncEvent(db: DexieCloudDB) {\n try {\n // Register periodicSync event to SW:\n // @ts-ignore\n const { periodicSync } = await navigator.serviceWorker.ready;\n if (periodicSync) {\n try {\n await periodicSync.register(\n `dexie-cloud:${db.name}`,\n db.cloud.options?.periodicSync\n );\n console.debug(\n `Dexie Cloud: Successfully registered periodicsync event for ${db.name}`\n );\n } catch (e) {\n console.debug(`Dexie Cloud: Failed to register periodic sync. Your PWA must be installed to allow background sync.`, e);\n }\n } else {\n console.debug(`Dexie Cloud: periodicSync not supported.`);\n }\n } catch (e) {\n console.debug(\n `Dexie Cloud: Could not register periodicSync for ${db.name}`,\n e\n );\n }\n}\n" }, { "path": "addons/dexie-cloud/src/sync/sync.ts", "content": "import { getMutationTable } from '../helpers/getMutationTable';\nimport { getSyncableTables } from '../helpers/getSyncableTables';\nimport { DexieCloudDB } from '../db/DexieCloudDB';\nimport { listSyncifiedChanges } from './listSyncifiedChanges';\nimport { getTablesToSyncify } from './getTablesToSyncify';\nimport { listClientChanges } from './listClientChanges';\nimport { syncWithServer } from './syncWithServer';\nimport { modifyLocalObjectsWithNewUserId } from './modifyLocalObjectsWithNewUserId';\nimport { throwIfCancelled } from '../helpers/CancelToken';\nimport { DexieCloudOptions } from '../DexieCloudOptions';\nimport { BaseRevisionMapEntry } from '../db/entities/BaseRevisionMapEntry';\nimport { getTableFromMutationTable } from '../helpers/getTableFromMutationTable';\nimport {\n applyOperations,\n DBKeyMutationSet,\n DBOperationsSet,\n DexieCloudSchema,\n randomString,\n subtractChanges,\n SyncResponse,\n toDBOperationSet,\n} from 'dexie-cloud-common';\nimport { PersistedSyncState } from '../db/entities/PersistedSyncState';\nimport { isOnline } from './isOnline';\nimport { updateBaseRevs } from './updateBaseRevs';\nimport { getLatestRevisionsPerTable } from './getLatestRevisionsPerTable';\nimport { applyServerChanges } from './applyServerChanges';\nimport { checkSyncRateLimitDelay } from './ratelimit';\nimport { listYClientMessagesAndStateVector } from '../yjs/listYClientMessagesAndStateVector';\nimport { applyYServerMessages } from '../yjs/applyYMessages';\nimport { hasLargeBlobsInOperations, offloadBlobsInOperations } from './blobOffloading';\nimport { updateYSyncStates } from '../yjs/updateYSyncStates';\nimport { downloadYDocsFromServer } from '../yjs/downloadYDocsFromServer';\nimport { UpdateSpec } from 'dexie';\nimport { loadCachedAccessToken } from './loadCachedAccessToken';\n\nexport const CURRENT_SYNC_WORKER = 'currentSyncWorker';\n\nexport interface SyncOptions {\n isInitialSync?: boolean;\n cancelToken?: { cancelled: boolean };\n justCheckIfNeeded?: boolean;\n retryImmediatelyOnFetchError?: boolean;\n purpose?: 'pull' | 'push';\n}\n\nexport function sync(\n db: DexieCloudDB,\n options: DexieCloudOptions,\n schema: DexieCloudSchema,\n syncOptions?: SyncOptions\n): Promise {\n return _sync(db, options, schema, syncOptions)\n .then((result) => {\n if (!syncOptions?.justCheckIfNeeded) { // && syncOptions?.purpose !== 'push') {\n db.syncStateChangedEvent.next({\n phase: 'in-sync',\n });\n }\n return result;\n })\n .catch(async (error: any) => {\n if (syncOptions?.justCheckIfNeeded) return Promise.reject(error); // Just rethrow.\n console.debug('Error from _sync', {\n isOnline,\n syncOptions,\n error,\n });\n if (\n isOnline &&\n syncOptions?.retryImmediatelyOnFetchError &&\n error?.name === 'TypeError' &&\n /fetch/.test(error?.message)\n ) {\n db.syncStateChangedEvent.next({\n phase: 'error',\n error,\n });\n // Retry again in 500 ms but if it fails again, don't retry.\n await new Promise((resolve) => setTimeout(resolve, 500));\n return await sync(db, options, schema, {\n ...syncOptions,\n retryImmediatelyOnFetchError: false,\n });\n }\n // Make sure that no matter whether sync() explodes or not,\n // always update the timestamp. Also store the error.\n await db.$syncState.update('syncState', {\n timestamp: new Date(),\n error: '' + error,\n });\n db.syncStateChangedEvent.next({\n phase: isOnline ? 'error' : 'offline',\n error: new Error('' + error?.message || error),\n });\n return Promise.reject(error);\n });\n}\n\nasync function _sync(\n db: DexieCloudDB,\n options: DexieCloudOptions,\n schema: DexieCloudSchema,\n { isInitialSync, cancelToken, justCheckIfNeeded, purpose }: SyncOptions = {\n isInitialSync: false,\n }\n): Promise {\n if (!justCheckIfNeeded) {\n console.debug('SYNC STARTED', { isInitialSync, purpose });\n }\n if (!db.cloud.options?.databaseUrl)\n throw new Error(\n `Internal error: sync must not be called when no databaseUrl is configured`\n );\n const { databaseUrl } = options;\n const currentUser = await db.getCurrentUser(); // Keep same value across entire sync flow:\n const tablesToSync = currentUser.isLoggedIn ? getSyncableTables(db) : [];\n\n const mutationTables = tablesToSync.map((tbl) =>\n db.table(getMutationTable(tbl.name))\n );\n\n // If this is not the initial sync,\n // go through tables that were previously not synced but should now be according to\n // logged in state and the sync table whitelist in db.cloud.options.\n //\n // Prepare for syncification by modifying locally unauthorized objects:\n //\n const persistedSyncState = await db.getPersistedSyncState();\n const readyForSyncification = currentUser.isLoggedIn;\n const tablesToSyncify = readyForSyncification\n ? getTablesToSyncify(db, persistedSyncState)\n : [];\n throwIfCancelled(cancelToken);\n const doSyncify = tablesToSyncify.length > 0;\n\n if (doSyncify) {\n if (justCheckIfNeeded) return true;\n //console.debug('sync doSyncify is true');\n await db.transaction('rw', tablesToSyncify, async (tx) => {\n // @ts-ignore\n tx.idbtrans.disableChangeTracking = true;\n // @ts-ignore\n tx.idbtrans.disableAccessControl = true; // TODO: Take care of this flag in access control middleware!\n await modifyLocalObjectsWithNewUserId(\n tablesToSyncify,\n currentUser,\n persistedSyncState?.realms\n );\n });\n throwIfCancelled(cancelToken);\n }\n //\n // List changes to sync\n //\n const [clientChangeSet, syncState, baseRevs, {yMessages, lastUpdateIds}] = await db.transaction(\n 'r',\n db.tables,\n async () => {\n const syncState = await db.getPersistedSyncState();\n let baseRevs = await db.$baseRevs.toArray();\n \n // Resolve #2168\n baseRevs = baseRevs.filter(br => tablesToSync.some(tbl => tbl.name === br.tableName));\n\n let clientChanges = await listClientChanges(mutationTables, db);\n const yResults = await listYClientMessagesAndStateVector(db, tablesToSync);\n throwIfCancelled(cancelToken);\n if (doSyncify) {\n const alreadySyncedRealms = [\n ...(persistedSyncState?.realms || []),\n ...(persistedSyncState?.inviteRealms || []),\n ];\n const syncificationInserts = await listSyncifiedChanges(\n tablesToSyncify,\n currentUser,\n schema!,\n alreadySyncedRealms\n );\n throwIfCancelled(cancelToken);\n clientChanges = clientChanges.concat(syncificationInserts);\n return [clientChanges, syncState, baseRevs, yResults];\n }\n return [clientChanges, syncState, baseRevs, yResults];\n }\n );\n\n const pushSyncIsNeeded = clientChangeSet.some((set) =>\n set.muts.some((mut) => mut.keys.length > 0)\n ) || yMessages.some(m => m.type === 'u-c');\n if (justCheckIfNeeded) {\n console.debug('Sync is needed:', pushSyncIsNeeded);\n return pushSyncIsNeeded;\n }\n if (purpose === 'push' && !pushSyncIsNeeded) {\n // The purpose of this request was to push changes\n return false;\n }\n\n const latestRevisions = getLatestRevisionsPerTable(\n clientChangeSet,\n syncState?.latestRevisions\n );\n\n const clientIdentity = syncState?.clientIdentity || randomString(16);\n\n //\n // Offload large blobs to blob storage before sync\n //\n let processedChangeSet = clientChangeSet;\n const maxStringLength = db.cloud.options?.maxStringLength ?? 32768;\n const hasLargeBlobs = hasLargeBlobsInOperations(clientChangeSet, maxStringLength);\n if (hasLargeBlobs) {\n processedChangeSet = await offloadBlobsInOperations(\n clientChangeSet,\n databaseUrl,\n () => loadCachedAccessToken(db),\n maxStringLength\n );\n }\n\n //\n // Push changes to server\n //\n throwIfCancelled(cancelToken);\n const res = await syncWithServer(\n processedChangeSet,\n yMessages,\n syncState,\n baseRevs,\n db,\n databaseUrl,\n schema,\n clientIdentity,\n currentUser\n );\n console.debug('Sync response', res);\n\n //\n // Apply changes locally and clear old change entries:\n //\n const {done, newSyncState} = await db.transaction('rw', db.tables, async (tx) => {\n // @ts-ignore\n tx.idbtrans.disableChangeTracking = true;\n // @ts-ignore\n tx.idbtrans.disableAccessControl = true; // TODO: Take care of this flag in access control middleware!\n\n // Update db.cloud.schema from server response.\n // Local schema MAY include a subset of tables, so do not force all tables into local schema.\n for (const tableName of Object.keys(schema)) {\n if (res.schema[tableName]) {\n // Write directly into configured schema. This code can only be executed alone.\n schema[tableName] = res.schema[tableName];\n }\n }\n await db.$syncState.put(schema, 'schema');\n\n // List mutations that happened during our exchange with the server:\n const addedClientChanges = await listClientChanges(mutationTables, db, {\n since: latestRevisions,\n });\n\n //\n // Delete changes now as server has return success\n // (but keep changes that haven't reached server yet)\n //\n for (const mutTable of mutationTables) {\n const tableName = getTableFromMutationTable(mutTable.name);\n if (\n !addedClientChanges.some(\n (ch) => ch.table === tableName && ch.muts.length > 0\n )\n ) {\n // No added mutations for this table during the time we sent changes\n // to the server.\n // It is therefore safe to clear all changes (which is faster than\n // deleting a range)\n await Promise.all([\n mutTable.clear(),\n db.$baseRevs.where({ tableName }).delete(),\n ]);\n } else if (latestRevisions[tableName]) {\n const latestRev = latestRevisions[tableName] || 0;\n await Promise.all([\n mutTable.where('rev').belowOrEqual(latestRev).delete(),\n db.$baseRevs\n .where(':id')\n .between(\n [tableName, -Infinity],\n [tableName, latestRev + 1],\n true,\n true\n )\n .reverse()\n .offset(1) // Keep one entry (the one mapping muts that came during fetch --> previous server revision)\n .delete(),\n ]);\n } else {\n // In this case, the mutation table only contains added items after sending empty changeset to server.\n // We should not clear out anything now.\n }\n }\n\n // Update latestRevisions object according to additional changes:\n getLatestRevisionsPerTable(addedClientChanges, latestRevisions);\n\n // Update/add new entries into baseRevs map.\n // * On tables without mutations since last serverRevision,\n // this will update existing entry.\n // * On tables where mutations have been recorded since last\n // serverRevision, this will create a new entry.\n // The purpose of this operation is to mark a start revision (per table)\n // so that all client-mutations that come after this, will be mapped to current\n // server revision.\n await updateBaseRevs(db, schema, latestRevisions, res.serverRevision);\n\n const syncState = await db.getPersistedSyncState();\n\n //\n // Delete objects from removed realms\n //\n await deleteObjectsFromRemovedRealms(db, res, syncState);\n\n //\n // Update syncState\n //\n const newSyncState: PersistedSyncState = syncState || {\n syncedTables: [],\n latestRevisions: {},\n realms: [],\n inviteRealms: [],\n clientIdentity,\n };\n if (readyForSyncification) {\n newSyncState.syncedTables = tablesToSync\n .map((tbl) => tbl.name)\n .concat(tablesToSyncify.map((tbl) => tbl.name));\n }\n newSyncState.latestRevisions = latestRevisions;\n newSyncState.remoteDbId = res.dbId;\n newSyncState.initiallySynced = true;\n newSyncState.realms = res.realms;\n newSyncState.inviteRealms = res.inviteRealms;\n newSyncState.serverRevision = res.serverRevision;\n newSyncState.yServerRevision = res.serverRevision;\n newSyncState.timestamp = new Date();\n delete newSyncState.error;\n\n const filteredChanges = filterServerChangesThroughAddedClientChanges(\n res.changes,\n addedClientChanges\n );\n\n //\n // apply server changes\n //\n await applyServerChanges(filteredChanges, db);\n\n if (res.yMessages) {\n //\n // apply yMessages\n //\n const {receivedUntils, resyncNeeded, yServerRevision} = await applyYServerMessages(res.yMessages, db);\n if (yServerRevision) {\n newSyncState.yServerRevision = yServerRevision;\n }\n\n //\n // update Y SyncStates\n //\n await updateYSyncStates(lastUpdateIds, receivedUntils, db);\n\n if (resyncNeeded) {\n newSyncState.yDownloadedRealms = {}; // Will trigger a full download of Y-documents below...\n }\n }\n\n //\n // Update regular syncState\n //\n db.$syncState.put(newSyncState, 'syncState');\n\n return {\n done: addedClientChanges.length === 0,\n newSyncState\n };\n });\n if (!done) {\n console.debug('MORE SYNC NEEDED. Go for it again!');\n await checkSyncRateLimitDelay(db);\n return await _sync(db, options, schema, { isInitialSync, cancelToken });\n }\n const usingYProps = Object.values(schema).some(tbl => tbl.yProps?.length);\n const serverSupportsYprops = !!res.yMessages;\n if (usingYProps && serverSupportsYprops) {\n try {\n await downloadYDocsFromServer(db, databaseUrl, newSyncState);\n } catch (error) {\n console.error('Failed to download Yjs documents from server', error);\n }\n }\n console.debug('SYNC DONE', { isInitialSync });\n db.syncCompleteEvent.next();\n return false; // Not needed anymore\n}\n\nasync function deleteObjectsFromRemovedRealms(\n db: DexieCloudDB,\n res: SyncResponse,\n syncState: PersistedSyncState | undefined\n) {\n const deletedRealms = new Set();\n const rejectedRealms = new Set();\n const previousRealmSet = syncState ? syncState.realms : [];\n const previousInviteRealmSet = syncState ? syncState.inviteRealms : [];\n const updatedRealmSet = new Set(res.realms);\n const updatedTotalRealmSet = new Set(res.realms.concat(res.inviteRealms));\n for (const realmId of previousRealmSet) {\n if (!updatedRealmSet.has(realmId)) {\n rejectedRealms.add(realmId);\n if (!updatedTotalRealmSet.has(realmId)) {\n deletedRealms.add(realmId);\n }\n }\n }\n for (const realmId of previousInviteRealmSet.concat(previousRealmSet)) {\n if (!updatedTotalRealmSet.has(realmId)) {\n deletedRealms.add(realmId);\n }\n }\n if (deletedRealms.size > 0 || rejectedRealms.size > 0) {\n const tables = getSyncableTables(db);\n for (const table of tables) {\n let realmsToDelete = ['realms', 'members', 'roles'].includes(table.name)\n ? deletedRealms // These tables should spare rejected ones.\n : rejectedRealms; // All other tables shoudl delete rejected+deleted ones\n if (realmsToDelete.size === 0) continue;\n if (\n table.schema.indexes.some(\n (idx) =>\n idx.keyPath === 'realmId' ||\n (Array.isArray(idx.keyPath) && idx.keyPath[0] === 'realmId')\n )\n ) {\n // There's an index to use:\n //console.debug(`REMOVAL: deleting all ${table.name} where realmId anyOf `, JSON.stringify([...realmsToDelete]));\n await table\n .where('realmId')\n .anyOf([...realmsToDelete])\n .delete();\n } else {\n // No index to use:\n //console.debug(`REMOVAL: deleting all ${table.name} where realmId is any of `, JSON.stringify([...realmsToDelete]), realmsToDelete.size);\n await table\n .filter((obj) => !!obj?.realmId && realmsToDelete.has(obj.realmId))\n .delete();\n }\n }\n }\n if (rejectedRealms.size > 0 && syncState?.yDownloadedRealms) {\n // Remove rejected/deleted realms from yDownloadedRealms because of the following use case:\n // 1. User becomes added to the realm\n // 2. User syncs and all documents of the realm is downloaded (downloadYDocsFromServer.ts)\n // 3. User leaves the realm and all docs are deleted locally (built-in-trigger of deleting their rows in this file)\n // 4. User is yet again added to the realm. At this point, we must make sure the docs are not considered already downloaded.\n const updateSpec: UpdateSpec = {};\n for (const realmId of rejectedRealms) {\n delete syncState.yDownloadedRealms[realmId];\n } \n }\n}\n\nexport function filterServerChangesThroughAddedClientChanges(\n serverChanges: DBOperationsSet,\n addedClientChanges: DBOperationsSet\n): DBOperationsSet {\n const changes: DBKeyMutationSet = {};\n applyOperations(changes, serverChanges);\n const localPostChanges: DBKeyMutationSet = {};\n applyOperations(localPostChanges, addedClientChanges);\n subtractChanges(changes, localPostChanges);\n return toDBOperationSet(changes);\n}\n" }, { "path": "addons/dexie-cloud/src/sync/syncIfPossible.ts", "content": "import { IS_SERVICE_WORKER } from '../helpers/IS_SERVICE_WORKER';\nimport { performGuardedJob } from './performGuardedJob';\nimport { DexieCloudDB } from '../db/DexieCloudDB';\nimport { sync, CURRENT_SYNC_WORKER, SyncOptions } from './sync';\nimport { DexieCloudOptions } from '../DexieCloudOptions';\nimport { assert, DexieCloudSchema } from 'dexie-cloud-common';\nimport { checkSyncRateLimitDelay } from './ratelimit';\n\nconst ongoingSyncs = new WeakMap<\n DexieCloudDB,\n { promise: Promise; pull: boolean }\n>();\n\nexport function syncIfPossible(\n db: DexieCloudDB,\n cloudOptions: DexieCloudOptions,\n cloudSchema: DexieCloudSchema,\n options?: SyncOptions\n) {\n const ongoing = ongoingSyncs.get(db);\n if (ongoing) {\n if (ongoing.pull || options?.purpose === 'push') {\n console.debug('syncIfPossible(): returning the ongoing sync promise.');\n return ongoing.promise;\n } else {\n // Ongoing sync may never do anything in case there are no outstanding changes\n // to sync (because its purpose was \"push\" not \"pull\")\n // Now, however, we are asked to do a sync with the purpose of \"pull\"\n // We want to optimize here. We must wait for the ongoing to complete\n // and then, if the ongoing sync never resulted in a sync request,\n // we must redo the sync.\n\n // To inspect what is happening in the ongoing request, let's subscribe\n // to db.cloud.syncState and look for if it is doing any \"pulling\" phase:\n let hasPullTakenPlace = false;\n const subscription = db.cloud.syncState.subscribe((syncState) => {\n if (syncState.phase === 'pulling') {\n hasPullTakenPlace = true;\n }\n });\n // Ok, so now we are watching. At the same time, wait for the ongoing to complete\n // and when it has completed, check if we're all set or if we need to redo\n // the call:\n return (\n ongoing.promise\n // This is a finally block but we are still running tests on\n // browsers that don't support it, so need to do it like this:\n .then(() => {\n subscription.unsubscribe();\n })\n .catch((error) => {\n subscription.unsubscribe();\n return Promise.reject(error);\n })\n .then(() => {\n if (!hasPullTakenPlace) {\n // No pull took place in the ongoing sync but the caller had \"pull\" as\n // an explicit purpose of this call - so we need to redo the call!\n return syncIfPossible(db, cloudOptions, cloudSchema, options);\n }\n })\n );\n }\n }\n\n const promise = _syncIfPossible();\n ongoingSyncs.set(db, { promise, pull: options?.purpose !== 'push' });\n return promise;\n\n async function _syncIfPossible() {\n try {\n // Check if should delay sync due to ratelimit:\n await checkSyncRateLimitDelay(db); \n await performGuardedJob(db, CURRENT_SYNC_WORKER, () =>\n sync(db, cloudOptions, cloudSchema, options)\n );\n ongoingSyncs.delete(db);\n } catch (error) {\n ongoingSyncs.delete(db);\n console.error(`Failed to sync client changes`, error);\n throw error; // Make sure we rethrow error so that sync event is retried.\n // I don't think we should setTimout or so here.\n // Unless server tells us to in some response.\n // Then we could follow that advice but not by waiting here but by registering\n // Something that triggers an event listened to in startPushWorker()\n }\n }\n}\n" }, { "path": "addons/dexie-cloud/src/sync/syncWithServer.ts", "content": "import { DexieCloudDB } from '../db/DexieCloudDB';\nimport { PersistedSyncState } from '../db/entities/PersistedSyncState';\nimport { loadAccessToken } from '../authentication/authenticate';\nimport { TSON } from '../TSON';\nimport { getSyncableTables } from '../helpers/getSyncableTables';\nimport { BaseRevisionMapEntry } from '../db/entities/BaseRevisionMapEntry';\nimport { HttpError } from '../errors/HttpError';\nimport {\n DBOperationsSet,\n DexieCloudSchema,\n SyncRequest,\n SyncResponse,\n YClientMessage,\n} from 'dexie-cloud-common';\nimport { encodeIdsForServer } from './encodeIdsForServer';\nimport { UserLogin } from '../db/entities/UserLogin';\nimport { updateSyncRateLimitDelays } from './ratelimit';\n//import {BisonWebStreamReader} from \"dreambase-library/dist/typeson-simplified/BisonWebStreamReader\";\n\nexport async function syncWithServer(\n changes: DBOperationsSet,\n y: YClientMessage[],\n syncState: PersistedSyncState | undefined,\n baseRevs: BaseRevisionMapEntry[],\n db: DexieCloudDB,\n databaseUrl: string,\n schema: DexieCloudSchema | null,\n clientIdentity: string,\n currentUser: UserLogin\n): Promise {\n //\n // Push changes to server using fetch\n //\n const headers: HeadersInit = {\n Accept: 'application/json',\n 'Content-Type': 'application/tson',\n };\n const updatedUser = await loadAccessToken(db);\n /*\n if (updatedUser?.license && changes.length > 0) {\n if (updatedUser.license.status === 'expired') {\n throw new Error(`License has expired`);\n }\n if (updatedUser.license.status === 'deactivated') {\n throw new Error(`License deactivated`);\n }\n }\n */\n const accessToken = updatedUser?.accessToken;\n if (accessToken) {\n headers.Authorization = `Bearer ${accessToken}`;\n }\n\n const syncRequest: SyncRequest = {\n v: 3, // v3 = supports BlobRef\n dbID: syncState?.remoteDbId,\n clientIdentity,\n schema: schema || {},\n lastPull: syncState\n ? {\n serverRevision: syncState.serverRevision!,\n yServerRevision: syncState.yServerRevision,\n realms: syncState.realms,\n inviteRealms: syncState.inviteRealms,\n }\n : undefined,\n baseRevs,\n changes: encodeIdsForServer(db.dx.core.schema, currentUser, changes),\n y,\n dxcv: db.cloud.version\n };\n console.debug('Sync request', syncRequest);\n db.syncStateChangedEvent.next({\n phase: 'pushing',\n });\n const body = TSON.stringify(syncRequest);\n const res = await fetch(`${databaseUrl}/sync`, {\n method: 'post',\n headers,\n credentials: 'include', // For Arr Affinity cookie only, for better Rate-Limit counting only.\n body,\n });\n //const contentLength = Number(res.headers.get('content-length'));\n db.syncStateChangedEvent.next({\n phase: 'pulling',\n });\n\n updateSyncRateLimitDelays(db, res);\n\n if (!res.ok) {\n throw new HttpError(res);\n }\n\n switch (res.headers.get('content-type')) {\n case 'application/x-bison':\n case 'application/x-bison-stream':\n // BISON format deprecated - throw error if server sends it\n throw new Error('BISON format no longer supported. Server should send application/json.');\n default:\n case 'application/json': {\n const text = await res.text();\n const syncRes = TSON.parse(text);\n return syncRes;\n }\n }\n}\n" }, { "path": "addons/dexie-cloud/src/sync/triggerSync.ts", "content": "import { DexieCloudDB } from \"../db/DexieCloudDB\";\nimport { registerSyncEvent } from \"./registerSyncEvent\";\n\nexport function triggerSync(db: DexieCloudDB, purpose: \"push\" | \"pull\") {\n if (db.cloud.usingServiceWorker) {\n console.debug('registering sync event');\n registerSyncEvent(db, purpose);\n } else {\n db.localSyncEvent.next({purpose});\n }\n}" }, { "path": "addons/dexie-cloud/src/sync/updateBaseRevs.ts", "content": "import { DexieCloudDB } from '../db/DexieCloudDB';\nimport { DexieCloudSchema, SyncResponse } from 'dexie-cloud-common';\n\nexport async function updateBaseRevs(db: DexieCloudDB, schema: DexieCloudSchema, latestRevisions: { [table: string]: number; }, serverRev: any) {\n await db.$baseRevs.bulkPut(\n Object.keys(schema)\n .filter((table) => schema[table].markedForSync)\n .map((tableName) => {\n const lastClientRevOnPreviousServerRev = latestRevisions[tableName] || 0;\n return {\n tableName,\n clientRev: lastClientRevOnPreviousServerRev + 1,\n serverRev,\n };\n })\n );\n // Clean up baseRevs for tables that do not exist anymore or are no longer marked for sync\n // Resolve #2168 by also cleaning up baseRevs for tables that are not marked for sync\n await db.$baseRevs.where('tableName').noneOf(\n Object.keys(schema).filter((table) => schema[table].markedForSync)\n ).delete();\n}\n" }, { "path": "addons/dexie-cloud/src/tsconfig.json", "content": "{\n \"compilerOptions\": {\n \"module\": \"es2015\",\n \"target\": \"es2020\",\n \"declaration\": true,\n \"importHelpers\": true,\n \"strictNullChecks\": true,\n \"noImplicitAny\": false,\n \"noImplicitReturns\": true,\n \"moduleResolution\": \"node\",\n \"lib\": [\"ES2020\", \"DOM\"],\n \"forceConsistentCasingInFileNames\": true,\n \"sourceMap\": true,\n \"rootDir\": \".\",\n \"jsx\": \"react\",\n \"jsxFactory\": \"h\",\n \"jsxFragmentFactory\": \"Fragment\",\n \"downlevelIteration\": true\n },\n \"include\": [\"**/*.ts\"],\n \"references\": [{ \"path\": \"../../../libs/dexie-cloud-common\" }]\n}\n" }, { "path": "addons/dexie-cloud/src/types/DXCAlert.ts", "content": "\nexport type DXCAlert = DXCErrorAlert | DXCWarningAlert | DXCInfoAlert;\n\nexport interface DXCErrorAlert {\n type: 'error';\n messageCode: 'INVALID_OTP' | 'INVALID_EMAIL' | 'LICENSE_LIMIT_REACHED' | 'GENERIC_ERROR';\n message: string;\n messageParams: { [paramName: string]: string; };\n /** Optional text that users can copy to clipboard (e.g. a CLI command) */\n copyText?: string;\n}\n\nexport interface DXCWarningAlert {\n type: 'warning';\n messageCode: 'GENERIC_WARNING' | 'LOGOUT_CONFIRMATION';\n message: string;\n messageParams: { [paramName: string]: string; };\n /** Optional text that users can copy to clipboard (e.g. a CLI command) */\n copyText?: string;\n}\n\nexport interface DXCInfoAlert {\n type: 'info';\n messageCode: 'GENERIC_INFO' | 'OTP_SENT';\n message: string;\n messageParams: { [paramName: string]: string; };\n /** Optional text that users can copy to clipboard (e.g. a CLI command) */\n copyText?: string;\n}\n" }, { "path": "addons/dexie-cloud/src/types/DXCInputField.ts", "content": "\nexport type DXCInputField = DXCTextField | DXCPasswordField;\n\nexport interface DXCTextField {\n type: 'text' | 'email' | 'otp';\n label?: string;\n placeholder?: string;\n}\n\nexport interface DXCPasswordField {\n type: 'password';\n label?: string;\n placeholder?: string;\n}\n" }, { "path": "addons/dexie-cloud/src/types/DXCUserInteraction.ts", "content": "import { DXCAlert } from './DXCAlert';\nimport { DXCInputField } from './DXCInputField';\n\nexport type DXCUserInteraction =\n | DXCGenericUserInteraction\n | DXCEmailPrompt\n | DXCOTPPrompt\n | DXCMessageAlert\n | DXCLogoutConfirmation;\n\n/** A selectable option that can appear in any user interaction.\n * \n * Similar to an HTML `