tinybase 1.3.0 → 1.3.3

package/lib/debug/store.d.ts

@@ -1802,9 +1802,10 @@ export interface Store {
   ): Return;
 
   /**
-   * The startTransaction allows you to explicitly start a transaction that will
-   * make multiple mutations to the Store, buffering all calls to the relevant
-   * listeners until it completes when you call the finishTransaction method.
+   * The startTransaction method allows you to explicitly start a transaction
+   * that will make multiple mutations to the Store, buffering all calls to the
+   * relevant listeners until it completes when you call the finishTransaction
+   * method.
    *
    * Transactions are useful for making bulk changes to the data in a Store, and
    * when you don't want listeners to be called as you make each change. Changes
@@ -1849,8 +1850,8 @@ export interface Store {
   startTransaction(): Store;
 
   /**
-   * The finishTransaction allows you to explicitly finish a transaction that
-   * has made multiple mutations to the Store, triggering all calls to the
+   * The finishTransaction method allows you to explicitly finish a transaction
+   * that has made multiple mutations to the Store, triggering all calls to the
    * relevant listeners.
    *
    * Transactions are useful for making bulk changes to the data in a Store, and

package/lib/store.d.ts

@@ -1802,9 +1802,10 @@ export interface Store {
   ): Return;
 
   /**
-   * The startTransaction allows you to explicitly start a transaction that will
-   * make multiple mutations to the Store, buffering all calls to the relevant
-   * listeners until it completes when you call the finishTransaction method.
+   * The startTransaction method allows you to explicitly start a transaction
+   * that will make multiple mutations to the Store, buffering all calls to the
+   * relevant listeners until it completes when you call the finishTransaction
+   * method.
    *
    * Transactions are useful for making bulk changes to the data in a Store, and
    * when you don't want listeners to be called as you make each change. Changes
@@ -1849,8 +1850,8 @@ export interface Store {
   startTransaction(): Store;
 
   /**
-   * The finishTransaction allows you to explicitly finish a transaction that
-   * has made multiple mutations to the Store, triggering all calls to the
+   * The finishTransaction method allows you to explicitly finish a transaction
+   * that has made multiple mutations to the Store, triggering all calls to the
    * relevant listeners.
    *
    * Transactions are useful for making bulk changes to the data in a Store, and

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tinybase",
-  "version": "1.3.0",
+  "version": "1.3.3",
   "author": "jamesgpearce",
   "repository": "github:tinyplex/tinybase",
   "license": "MIT",
@@ -19,8 +19,10 @@
   ],
   "exports": {
     ".": "./lib/tinybase.js",
+    "./package.json": "./package.json",
     "./*": "./lib/*.js"
   },
+  "react-native": "./lib/tinybase.js",
   "typesVersions": {
     "*": {
       "*": [
@@ -56,66 +58,67 @@
     "publishPackage": "gulp publishPackage"
   },
   "devDependencies": {
-    "@babel/cli": "^7.17.6",
-    "@babel/core": "^7.17.8",
-    "@babel/preset-env": "^7.16.11",
+    "@babel/cli": "^7.17.10",
+    "@babel/core": "^7.17.10",
+    "@babel/preset-env": "^7.17.10",
     "@babel/preset-react": "^7.16.7",
     "@babel/preset-typescript": "^7.16.7",
     "@rollup/plugin-replace": "^4.0.0",
     "@types/asciichart": "^1.5.6",
     "@types/expect-puppeteer": "^4.4.7",
     "@types/http-server": "^0.12.1",
-    "@types/jest": "^27.4.1",
-    "@types/jest-environment-puppeteer": "^5.0.0",
+    "@types/jest": "^27.5.0",
+    "@types/jest-environment-puppeteer": "^5.0.2",
     "@types/less": "^3.0.3",
-    "@types/puppeteer": "^5.4.5",
+    "@types/puppeteer": "^5.4.6",
     "@types/react": "^17.0.41",
     "@types/react-dom": "^17.0.14",
     "@types/react-test-renderer": "^17.0.1",
     "@types/tmp": "^0.2.3",
-    "@typescript-eslint/eslint-plugin": "^5.15.0",
-    "@typescript-eslint/parser": "^5.15.0",
+    "@typescript-eslint/eslint-plugin": "^5.22.0",
+    "@typescript-eslint/parser": "^5.22.0",
     "asciichart": "^1.5.25",
     "babel-eslint": "^10.1.0",
-    "babel-jest": "^27.5.1",
-    "babel-preset-minify": "^0.5.1",
+    "babel-jest": "^28.1.0",
+    "babel-preset-minify": "^0.5.2",
     "country-flag-emoji-json": "^2.0.0",
-    "cspell": "^5.19.2",
-    "esbuild": "^0.14.27",
-    "eslint": "^8.11.0",
+    "cspell": "^5.20.0",
+    "esbuild": "^0.14.38",
+    "eslint": "^8.15.0",
     "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-jest": "^26.1.1",
-    "eslint-plugin-jsdoc": "^38.0.6",
+    "eslint-plugin-jest": "^26.1.5",
+    "eslint-plugin-jsdoc": "^39.2.9",
     "eslint-plugin-react": "^7.29.4",
-    "eslint-plugin-react-hooks": "^4.3.0",
+    "eslint-plugin-react-hooks": "^4.5.0",
     "gulp": "^4.0.2",
     "gulp-gzip": "^1.4.2",
     "http-server": "^14.1.0",
-    "jest": "^27.5.1",
+    "jest": "^28.1.0",
+    "jest-environment-jsdom": "^28.1.0",
     "jest-fetch-mock": "^3.0.3",
     "jest-puppeteer": "^6.1.0",
     "less": "^4.1.2",
-    "prettier": "^2.6.0",
-    "puppeteer": "^13.5.1",
+    "prettier": "^2.6.2",
+    "puppeteer": "^13.7.0",
     "react": "^17.0.2",
     "react-dom": "^17.0.2",
     "react-test-renderer": "^17.0.2",
-    "rollup": "^2.70.1",
-    "rollup-plugin-esbuild": "^4.8.2",
-    "rollup-plugin-gzip": "^3.0.0",
+    "rollup": "^2.72.1",
+    "rollup-plugin-esbuild": "^4.9.1",
+    "rollup-plugin-gzip": "^3.0.1",
     "rollup-plugin-prettier": "^2.2.2",
     "rollup-plugin-terser": "^7.0.2",
-    "tinydocs": "^0.1.11",
+    "tinydocs": "^0.1.12",
     "tmp": "^0.2.1",
     "ts-unused-exports": "^8.0.0",
-    "typescript": "4.6.2"
+    "typescript": "4.6.4"
   },
   "peerDependencies": {
-    "react": "^17.0.2"
+    "react": "^17.0.0"
   },
   "peerDependenciesMeta": {
     "react": {
       "optional": true
     }
   }
-}
+}

package/readme.md

@@ -192,4 +192,4 @@ console.log(store.getCell('pets', 'felix', 'sold'));
 // -> false
 ```
 
-<section><h2 id="did-we-say-tiny">Did we say tiny?</h2><p>If you use the basic <a href="https://tinybase.org/api/store"><code>store</code></a> module alone, you&#x27;ll only add a gzipped <em>3.0kB</em> to your app. You can incrementally add the other modules as you need more functionality, or get it all for <em>6.0kB</em>. The <code>ui-react</code> adaptor is just another <em>2.6kB</em>, and everything is fast.</p><p>Life&#x27;s easy when you have zero dependencies.</p><p>Read more about how TinyBase is structured in the <a href="https://tinybase.org/guides/how-tinybase-is-built/architecture">Architecture</a> guide.</p></section><div class="table"><table class="fixed"><tbody><tr><th width="30%"> </th><th>.js.gz</th><th>.js</th><th>debug.js</th><th>.d.ts</th></tr><tr><th class="right"><a href="https://tinybase.org/api/store">store</a></th><td>3.0kB</td><td>6.7kB</td><td>28.4kB</td><td>114.5kB</td></tr><tr><th class="right"><a href="https://tinybase.org/api/indexes">indexes</a></th><td>1.6kB</td><td>3.2kB</td><td>14.1kB</td><td>32.9kB</td></tr><tr><th class="right"><a href="https://tinybase.org/api/metrics">metrics</a></th><td>1.5kB</td><td>3.1kB</td><td>12.6kB</td><td>29.1kB</td></tr><tr><th class="right"><a href="https://tinybase.org/api/relationships">relationships</a></th><td>1.6kB</td><td>3.2kB</td><td>14.8kB</td><td>42.1kB</td></tr><tr><th class="right"><a href="https://tinybase.org/api/checkpoints">checkpoints</a></th><td>1.3kB</td><td>2.5kB</td><td>10.3kB</td><td>33.0kB</td></tr><tr><th class="right"><a href="https://tinybase.org/api/persisters">persisters</a></th><td>0.8kB</td><td>1.6kB</td><td>4.9kB</td><td>26.7kB</td></tr><tr><th class="right"><a href="https://tinybase.org/api/common">common</a></th><td>0.1kB</td><td>0.1kB</td><td>0.1kB</td><td>3.5kB</td></tr><tr><th class="right"><a href="https://tinybase.org/api/tinybase">tinybase</a></th><td>6.0kB</td><td>14.2kB</td><td>60.0kB</td><td>0.3kB</td></tr></tbody></table></div><section><h2 id="well-tested-and-documented">Well tested and documented.</h2><p>TinyBase has <em>100.0%</em> test coverage, including the code throughout the documentation - even on this page! The guides, demos, and API examples are designed to make it as easy as possible to get up and running.</p><p>Read more about how TinyBase is tested in the Unit <a href="https://tinybase.org/guides/how-tinybase-is-built/testing">Testing</a> guide.</p></section><div class="table"><table class="fixed"><tbody><tr><th width="30%"> </th><th>Total</th><th>Tested</th><th>Coverage</th></tr><tr><th class="right">Lines</th><td>1,004</td><td>1,004</td><td>100.0%</td></tr><tr><th class="right">Statements</th><td>1,094</td><td>1,094</td><td>100.0%</td></tr><tr><th class="right">Functions</th><td>417</td><td>417</td><td>100.0%</td></tr><tr><th class="right">Branches</th><td>363</td><td>363</td><td>100.0%</td></tr><tr><th class="right">Tests</th><td colspan="3">1,794</td></tr><tr><th class="right">Assertions</th><td colspan="3">8,956</td></tr></tbody></table></div><hr><p><a id="start" href="https://tinybase.org/guides/the-basics/getting-started">Get started</a></p><p><a href="https://tinybase.org/demos">Try the demos</a></p><p><a href="https://tinybase.org/api/store/interfaces/store/store/">Read the docs</a></p><hr><section><h2 id="follow">Follow</h2><ul><li>News and updates on <a href="https://twitter.com/tinybasejs">Twitter</a> and <a href="https://facebook.com/tinybasejs">Facebook</a>.</li><li><a href="https://github.com/tinyplex/tinybase/issues">Issues</a> and <a href="https://github.com/tinyplex/tinybase/releases">release notes</a> on <a href="https://github.com/tinyplex/tinybase">GitHub</a></li><li>Packages on <a href="https://www.npmjs.com/package/tinybase/v/1.3.0">NPM</a>.</li></ul></section><section><h2 id="about">About</h2><p>Building TinyBase was an interesting exercise in API design, minification, and documentation. It&#x27;s not <a href="https://www.linkedin.com/in/jamespearce">my day job</a>, but I do intend to maintain it, so please provide feedback. I could not have done this without these great <a href="https://tinybase.org/guides/how-tinybase-is-built/credits/#giants">projects</a> and <a href="https://tinybase.org/guides/how-tinybase-is-built/credits/#and-friends">friends</a>, and I hope you enjoy using it!</p></section>
+<section><h2 id="did-we-say-tiny">Did we say tiny?</h2><p>If you use the basic <a href="https://tinybase.org/api/store"><code>store</code></a> module alone, you&#x27;ll only add a gzipped <em>3.0kB</em> to your app. You can incrementally add the other modules as you need more functionality, or get it all for <em>6.0kB</em>. The <code>ui-react</code> adaptor is just another <em>2.6kB</em>, and everything is fast.</p><p>Life&#x27;s easy when you have zero dependencies.</p><p>Read more about how TinyBase is structured in the <a href="https://tinybase.org/guides/how-tinybase-is-built/architecture">Architecture</a> guide.</p></section><div class="table"><table class="fixed"><tbody><tr><th width="30%"> </th><th>.js.gz</th><th>.js</th><th>debug.js</th><th>.d.ts</th></tr><tr><th class="right"><a href="https://tinybase.org/api/store">store</a></th><td>3.0kB</td><td>6.7kB</td><td>28.4kB</td><td>114.5kB</td></tr><tr><th class="right"><a href="https://tinybase.org/api/indexes">indexes</a></th><td>1.6kB</td><td>3.2kB</td><td>14.1kB</td><td>32.9kB</td></tr><tr><th class="right"><a href="https://tinybase.org/api/metrics">metrics</a></th><td>1.5kB</td><td>3.1kB</td><td>12.6kB</td><td>29.1kB</td></tr><tr><th class="right"><a href="https://tinybase.org/api/relationships">relationships</a></th><td>1.6kB</td><td>3.2kB</td><td>14.8kB</td><td>42.1kB</td></tr><tr><th class="right"><a href="https://tinybase.org/api/checkpoints">checkpoints</a></th><td>1.3kB</td><td>2.5kB</td><td>10.3kB</td><td>33.0kB</td></tr><tr><th class="right"><a href="https://tinybase.org/api/persisters">persisters</a></th><td>0.8kB</td><td>1.6kB</td><td>4.9kB</td><td>26.7kB</td></tr><tr><th class="right"><a href="https://tinybase.org/api/common">common</a></th><td>0.1kB</td><td>0.1kB</td><td>0.1kB</td><td>3.5kB</td></tr><tr><th class="right"><a href="https://tinybase.org/api/tinybase">tinybase</a></th><td>6.0kB</td><td>14.2kB</td><td>60.0kB</td><td>0.3kB</td></tr></tbody></table></div><section><h2 id="well-tested-and-documented">Well tested and documented.</h2><p>TinyBase has <em>100.0%</em> test coverage, including the code throughout the documentation - even on this page! The guides, demos, and API examples are designed to make it as easy as possible to get up and running.</p><p>Read more about how TinyBase is tested in the Unit <a href="https://tinybase.org/guides/how-tinybase-is-built/testing">Testing</a> guide.</p></section><div class="table"><table class="fixed"><tbody><tr><th width="30%"> </th><th>Total</th><th>Tested</th><th>Coverage</th></tr><tr><th class="right">Lines</th><td>1,004</td><td>1,004</td><td>100.0%</td></tr><tr><th class="right">Statements</th><td>1,094</td><td>1,094</td><td>100.0%</td></tr><tr><th class="right">Functions</th><td>417</td><td>417</td><td>100.0%</td></tr><tr><th class="right">Branches</th><td>363</td><td>363</td><td>100.0%</td></tr><tr><th class="right">Tests</th><td colspan="3">1,795</td></tr><tr><th class="right">Assertions</th><td colspan="3">8,961</td></tr></tbody></table></div><hr><p><a id="start" href="https://tinybase.org/guides/the-basics/getting-started">Get started</a></p><p><a href="https://tinybase.org/demos">Try the demos</a></p><p><a href="https://tinybase.org/api/store/interfaces/store/store/">Read the docs</a></p><hr><section><h2 id="follow">Follow</h2><ul><li>News and updates on <a href="https://twitter.com/tinybasejs">Twitter</a> and <a href="https://facebook.com/tinybasejs">Facebook</a>.</li><li><a href="https://tinybase.org/guides/releases/">Release notes</a> for each minor version.</li><li>Packages on <a href="https://www.npmjs.com/package/tinybase/v/1.3.3">NPM</a>.</li><li><a href="https://github.com/tinyplex/tinybase/issues">Issues</a> on <a href="https://github.com/tinyplex/tinybase">GitHub</a>.</li></ul></section><section><h2 id="about">About</h2><p>Building TinyBase was an interesting exercise in API design, minification, and documentation. It&#x27;s not <a href="https://www.linkedin.com/in/jamespearce">my day job</a>, but I do intend to maintain it, so please provide feedback. I could not have done this without these great <a href="https://tinybase.org/guides/how-tinybase-is-built/credits/#giants">projects</a> and <a href="https://tinybase.org/guides/how-tinybase-is-built/credits/#and-friends">friends</a>, and I hope you enjoy using it!</p></section>