tinybase 0.9.4 → 1.0.3

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022-
+Copyright (c) James Pearce, 2021-
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/lib/checkpoints.d.ts

@@ -142,6 +142,9 @@ export type CheckpointsListenerStats = {
  * checkpoints.delListener(listenerId);
  * checkpoints.destroy();
  * ```
+ * @see Relationships And Checkpoints guides
+ * @see Todo App demos
+ * @see TinyDraw demo
  * @category Checkpoints
  */
 export interface Checkpoints {

package/lib/debug/checkpoints.d.ts

@@ -142,6 +142,9 @@ export type CheckpointsListenerStats = {
  * checkpoints.delListener(listenerId);
  * checkpoints.destroy();
  * ```
+ * @see Relationships And Checkpoints guides
+ * @see Todo App demos
+ * @see TinyDraw demo
  * @category Checkpoints
  */
 export interface Checkpoints {

package/lib/debug/indexes.d.ts

@@ -150,6 +150,10 @@ export type IndexesListenerStats = {
  * indexes.delListener(listenerId);
  * indexes.destroy();
  * ```
+ * @see Metrics And Indexes guides
+ * @see Rolling Dice demos
+ * @see Country demo
+ * @see Todo App demos
  * @category Indexes
  */
 export interface Indexes {

package/lib/debug/metrics.d.ts

@@ -226,6 +226,10 @@ export type MetricsListenerStats = {
  * metrics.delListener(listenerId);
  * metrics.destroy();
  * ```
+ * @see Metrics And Indexes guides
+ * @see Rolling Dice demos
+ * @see Country demo
+ * @see Todo App demos
  * @category Metrics
  */
 export interface Metrics {

package/lib/debug/persisters.d.ts

@@ -19,6 +19,10 @@
  * createCustomPersister function can also be used to easily create a fully
  * customized way to save and load Store data.
  *
+ * @see Persisting Data guide
+ * @see Countries demo
+ * @see Todo App demos
+ * @see TinyDraw demo
  * @packageDocumentation
  * @module persisters
  */

package/lib/debug/relationships.d.ts

@@ -222,6 +222,8 @@ export type RelationshipsListenerStats = {
  * relationships.delListener(listenerId2);
  * relationships.destroy();
  * ```
+ * @see Relationships And Checkpoints guides
+ * @see TinyDraw demo
  * @category Relationships
  */
 export interface Relationships {

package/lib/debug/store.d.ts

@@ -612,6 +612,10 @@ export type StoreListenerStats = {
  *
  * store.delListener(listenerId);
  * ```
+ * @see The Basics guides
+ * @see Using Schemas guides
+ * @see Hello World demos
+ * @see Todo App demos
  * @category Store
  */
 export interface Store {
@@ -2496,6 +2500,7 @@ export interface Store {
  * console.log(store.getTables());
  * // -> {pets: {fido: {species: 'dog', sold: false}}}
  * ```
+ * @see The Basics guides
  * @category Creation
  */
 export function createStore(): Store;

package/lib/debug/ui-react.d.ts

@@ -10,6 +10,14 @@
  * The components in this module provide a further abstraction over those hooks
  * to ease the composition of user interfaces that use TinyBase.
  *
+ * @see Building UIs guides
+ * @see Building UIs With Metrics guide
+ * @see Building UIs With Indexes guide
+ * @see Building UIs With Relationships guide
+ * @see Building UIs With Checkpoints guide
+ * @see Countries demo
+ * @see Todo App demos
+ * @see TinyDraw demo
  * @packageDocumentation
  * @module ui-react
  */

package/lib/indexes.d.ts

@@ -150,6 +150,10 @@ export type IndexesListenerStats = {
  * indexes.delListener(listenerId);
  * indexes.destroy();
  * ```
+ * @see Metrics And Indexes guides
+ * @see Rolling Dice demos
+ * @see Country demo
+ * @see Todo App demos
  * @category Indexes
  */
 export interface Indexes {

package/lib/metrics.d.ts

@@ -226,6 +226,10 @@ export type MetricsListenerStats = {
  * metrics.delListener(listenerId);
  * metrics.destroy();
  * ```
+ * @see Metrics And Indexes guides
+ * @see Rolling Dice demos
+ * @see Country demo
+ * @see Todo App demos
  * @category Metrics
  */
 export interface Metrics {

package/lib/persisters.d.ts

@@ -19,6 +19,10 @@
  * createCustomPersister function can also be used to easily create a fully
  * customized way to save and load Store data.
  *
+ * @see Persisting Data guide
+ * @see Countries demo
+ * @see Todo App demos
+ * @see TinyDraw demo
  * @packageDocumentation
  * @module persisters
  */

package/lib/relationships.d.ts

@@ -222,6 +222,8 @@ export type RelationshipsListenerStats = {
  * relationships.delListener(listenerId2);
  * relationships.destroy();
  * ```
+ * @see Relationships And Checkpoints guides
+ * @see TinyDraw demo
  * @category Relationships
  */
 export interface Relationships {

package/lib/store.d.ts

@@ -612,6 +612,10 @@ export type StoreListenerStats = {
  *
  * store.delListener(listenerId);
  * ```
+ * @see The Basics guides
+ * @see Using Schemas guides
+ * @see Hello World demos
+ * @see Todo App demos
  * @category Store
  */
 export interface Store {
@@ -2496,6 +2500,7 @@ export interface Store {
  * console.log(store.getTables());
  * // -> {pets: {fido: {species: 'dog', sold: false}}}
  * ```
+ * @see The Basics guides
  * @category Creation
  */
 export function createStore(): Store;

package/lib/ui-react.d.ts

@@ -10,6 +10,14 @@
  * The components in this module provide a further abstraction over those hooks
  * to ease the composition of user interfaces that use TinyBase.
  *
+ * @see Building UIs guides
+ * @see Building UIs With Metrics guide
+ * @see Building UIs With Indexes guide
+ * @see Building UIs With Relationships guide
+ * @see Building UIs With Checkpoints guide
+ * @see Countries demo
+ * @see Todo App demos
+ * @see TinyDraw demo
  * @packageDocumentation
  * @module ui-react
  */

package/package.json

@@ -1,11 +1,18 @@
 {
   "name": "tinybase",
-  "version": "0.9.4",
+  "version": "1.0.3",
   "author": "jamesgpearce",
   "repository": "github:tinyplex/tinybase",
   "license": "MIT",
   "homepage": "https://tinybase.org",
   "description": "A tiny, reactive JavaScript library for structured state and tabular data.",
+  "keywords": [
+    "tiny",
+    "reactive",
+    "state",
+    "data",
+    "react"
+  ],
   "type": "module",
   "files": [
     "lib/**"
@@ -14,6 +21,14 @@
     ".": "./lib/tinybase.js",
     "./*": "./lib/*.js"
   },
+  "typesVersions": {
+    "*": {
+      "*": [
+        "./lib/*.d.ts",
+        "./lib/tinybase.d.ts"
+      ]
+    }
+  },
   "browser": {
     "fs": false
   },
@@ -33,6 +48,7 @@
     "compileDocsPagesOnly": "gulp compileDocsPagesOnly",
     "compileDocsAssetsOnly": "gulp compileDocsAssetsOnly",
     "compileDocs": "gulp compileDocs",
+    "compileForProdAndDocs": "gulp compileForProdAndDocs",
     "serveDocs": "gulp serveDocs",
     "preCommit": "gulp preCommit",
     "prePublishPackage": "gulp prePublishPackage",
@@ -65,9 +81,9 @@
     "country-flag-emoji-json": "^2.0.0",
     "cspell": "^5.15.2",
     "esbuild": "^0.14.11",
-    "eslint": "^8.6.0",
+    "eslint": "^8.7.0",
     "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-jest": "^25.3.4",
+    "eslint-plugin-jest": "^25.7.0",
     "eslint-plugin-jsdoc": "^37.6.1",
     "eslint-plugin-react": "^7.28.0",
     "eslint-plugin-react-hooks": "^4.3.0",
@@ -83,7 +99,7 @@
     "react": "^17.0.2",
     "react-dom": "^17.0.2",
     "react-test-renderer": "^17.0.2",
-    "rollup": "^2.63.0",
+    "rollup": "^2.64.0",
     "rollup-plugin-esbuild": "^4.8.2",
     "rollup-plugin-gzip": "^3.0.0",
     "rollup-plugin-prettier": "^2.2.2",

package/readme.md

@@ -1,4 +1,4 @@
-<section id="hero"><h2 id="a-javascript-library-for-structured-state">A JavaScript library for <em>structured state</em>.</h2><p>Using plain old JavaScript objects to manage application state gets old very quickly. It&#x27;s error-prone, tricky to track changes efficiently, and easy to to mistakenly incur performance costs.</p><p><em>TinyBase is a smarter way to structure your data:</em></p><ul><li>Familiar concepts of <a href="#set-and-get-tables-rows-and-cells">tables, rows, and cells</a>, and <a href="#apply-schemas-to-tables">schematization</a> to model your data domain.</li><li><a href="#register-listeners-at-any-granularity">Flexibly reactive</a> to reconciled updates, so you only spend cycles on the data that changes.</li><li><a href="#create-indexes-for-fast-lookups">Indexing</a>, <a href="#define-metrics-and-aggregations">metrics</a>, <a href="#configure-relationships-between-tables">relationships</a> - and even an <a href="#use-checkpoints-for-an-easy-undo-stack">undo stack</a> for your app state! - out of the box.</li><li>Easily <a href="#persist-data-to-browser-file-or-server">sync your data</a> to local or remote storage, and use <a href="#call-react-hooks-to-bind-to-data">idiomatic bindings</a> to your React UI.</li></ul><p><em>Tiny by name, tiny by nature</em>, TinyBase only costs <a href="#did-we-say-tiny">2.6kB - 5.5kB</a> when compressed, and has zero dependencies. And of course it&#x27;s <a href="#well-tested-and-documented">well tested</a>, <a href="https://tinybase.org/guides/the-basics/getting-started">fully documented</a>, and <a href="https://github.com/tinyplex/tinybase">open source</a>.</p></section><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="set-and-get-tables-rows-and-cells">Set and get tables, rows, and cells.</h2><p>Creating a <a href="https://tinybase.org/api/store/interfaces/store/store"><code>Store</code></a> requires just a simple call to the <a href="https://tinybase.org/api/store/functions/creation/createstore"><code>createStore</code></a> function. Once you have one, you can easily set <a href="https://tinybase.org/api/store/type-aliases/store/table"><code>Table</code></a>, <a href="https://tinybase.org/api/store/type-aliases/store/row"><code>Row</code></a>, or <a href="https://tinybase.org/api/store/type-aliases/store/cell"><code>Cell</code></a> values by their <a href="https://tinybase.org/api/common/type-aliases/identity/id"><code>Id</code></a>. And of course you can easily get the values back out again.</p><p>Read more about setting and changing data in <a href="https://tinybase.org/guides/the-basics">The Basics</a> guide.</p></section>
+<section id="hero"><h2 id="a-javascript-library-for-structured-state">A JavaScript library for <em>structured state</em>.</h2><p>Using plain old JavaScript objects to manage data gets old very quickly. It&#x27;s error-prone, tricky to track changes efficiently, and easy to mistakenly incur performance costs.</p><p><em>TinyBase is a smarter way to structure your application state:</em></p><ul><li>Familiar concepts of <a href="#set-and-get-tables-rows-and-cells">tables, rows, and cells</a>, and <a href="#apply-schemas-to-tables">schematization</a> to model your data domain.</li><li><a href="#register-listeners-at-any-granularity">Flexibly reactive</a> to reconciled updates, so you only spend cycles on the data that changes.</li><li><a href="#create-indexes-for-fast-lookups">Indexing</a>, <a href="#define-metrics-and-aggregations">metrics</a>, <a href="#configure-relationships-between-tables">relationships</a> - and even an <a href="#use-checkpoints-for-an-easy-undo-stack">undo stack</a> for your app state! - out of the box.</li><li>Easily <a href="#persist-data-to-browser-file-or-server">sync your data</a> to local or remote storage, and use <a href="#call-react-hooks-to-bind-to-data">idiomatic bindings</a> to your React UI.</li></ul><p><em>Tiny by name, tiny by nature</em>, TinyBase only costs <a href="#did-we-say-tiny">2.6kB - 5.5kB</a> when compressed, and has zero dependencies. And of course it&#x27;s <a href="#well-tested-and-documented">well tested</a>, <a href="https://tinybase.org/guides/the-basics/getting-started">fully documented</a>, and <a href="https://github.com/tinyplex/tinybase">open source</a>. Other <a href="https://tinybase.org/guides/faq/">FAQs</a>?</p></section><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="set-and-get-tables-rows-and-cells">Set and get tables, rows, and cells.</h2><p>Creating a <a href="https://tinybase.org/api/store/interfaces/store/store"><code>Store</code></a> requires just a simple call to the <a href="https://tinybase.org/api/store/functions/creation/createstore"><code>createStore</code></a> function. Once you have one, you can easily set <a href="https://tinybase.org/api/store/type-aliases/store/table"><code>Table</code></a>, <a href="https://tinybase.org/api/store/type-aliases/store/row"><code>Row</code></a>, or <a href="https://tinybase.org/api/store/type-aliases/store/cell"><code>Cell</code></a> values by their <a href="https://tinybase.org/api/common/type-aliases/identity/id"><code>Id</code></a>. And of course you can easily get the values back out again.</p><p>Read more about setting and changing data in <a href="https://tinybase.org/guides/the-basics">The Basics</a> guide.</p></section>
 
 ```js
 const store = createStore()
@@ -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>2.6kB</em> to your app. You can incrementally add the other modules as you need more functionality, or get it all for <em>5.5kB</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>2.6kB</td><td>5.8kB</td><td>23.8kB</td><td>86.7kB</td></tr><tr><th class="right"><a href="https://tinybase.org/api/indexes">indexes</a></th><td>1.5kB</td><td>2.9kB</td><td>13.0kB</td><td>27.3kB</td></tr><tr><th class="right"><a href="https://tinybase.org/api/metrics">metrics</a></th><td>1.5kB</td><td>3.0kB</td><td>12.3kB</td><td>26.5kB</td></tr><tr><th class="right"><a href="https://tinybase.org/api/relationships">relationships</a></th><td>1.5kB</td><td>3.1kB</td><td>14.3kB</td><td>39.0kB</td></tr><tr><th class="right"><a href="https://tinybase.org/api/checkpoints">checkpoints</a></th><td>1.3kB</td><td>2.4kB</td><td>10.0kB</td><td>30.6kB</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.6kB</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>5.5kB</td><td>13.0kB</td><td>53.9kB</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 <a href="https://tinybase.org/guides/how-tinybase-is-built/unit-testing">Unit 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>933</td><td>933</td><td>100.0%</td></tr><tr><th class="right">Statements</th><td>1,018</td><td>1,018</td><td>100.0%</td></tr><tr><th class="right">Functions</th><td>366</td><td>366</td><td>100.0%</td></tr><tr><th class="right">Branches</th><td>341</td><td>341</td><td>100.0%</td></tr><tr><th class="right">Tests</th><td colspan="3">1,707</td></tr><tr><th class="right">Assertions</th><td colspan="3">7,922</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/0.9.4">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 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>2.6kB</em> to your app. You can incrementally add the other modules as you need more functionality, or get it all for <em>5.5kB</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>2.6kB</td><td>5.8kB</td><td>23.8kB</td><td>86.9kB</td></tr><tr><th class="right"><a href="https://tinybase.org/api/indexes">indexes</a></th><td>1.5kB</td><td>2.9kB</td><td>13.0kB</td><td>27.4kB</td></tr><tr><th class="right"><a href="https://tinybase.org/api/metrics">metrics</a></th><td>1.5kB</td><td>3.0kB</td><td>12.3kB</td><td>26.6kB</td></tr><tr><th class="right"><a href="https://tinybase.org/api/relationships">relationships</a></th><td>1.5kB</td><td>3.1kB</td><td>14.3kB</td><td>39.0kB</td></tr><tr><th class="right"><a href="https://tinybase.org/api/checkpoints">checkpoints</a></th><td>1.3kB</td><td>2.4kB</td><td>10.0kB</td><td>30.7kB</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>5.5kB</td><td>13.0kB</td><td>53.9kB</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>933</td><td>933</td><td>100.0%</td></tr><tr><th class="right">Statements</th><td>1,018</td><td>1,018</td><td>100.0%</td></tr><tr><th class="right">Functions</th><td>366</td><td>366</td><td>100.0%</td></tr><tr><th class="right">Branches</th><td>341</td><td>341</td><td>100.0%</td></tr><tr><th class="right">Tests</th><td colspan="3">1,712</td></tr><tr><th class="right">Assertions</th><td colspan="3">7,959</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.0.3">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>