tinybase 2.1.0 → 2.2.0-beta.0

package/bin/cli.js

@@ -0,0 +1,2 @@
+#! /usr/bin/env node
+(()=>{const[,,o,...s]=process.argv;if("pwd"!==o)return console.dir(s),void console.log("Commands: [pwd]");console.log(process.cwd())})();

package/lib/checkpoints.d.ts

@@ -913,8 +913,6 @@ export interface Checkpoints {
  * The createCheckpoints function creates a Checkpoints object, and is the main
  * entry point into the checkpoints module.
  *
- * It is trivially simple.
- *
  * A given Store can only have one Checkpoints object associated with it. If you
  * call this function twice on the same Store, your second call will return a
  * reference to the Checkpoints object created by the first.

package/lib/checkpoints.js

@@ -1 +1 @@
-const e=(e,t)=>e.includes(t),t=(e,t)=>e.forEach(t),n=e=>e.length,r=e=>0==n(e),s=(e,...t)=>e.push(...t),o=e=>e.pop(),l=e=>e.shift(),c=e=>null==e,i=(e,t,n)=>c(e)?n?.():t(e),a=(e,t)=>e?.has(t)??!1,d=e=>c(e)||0==(e=>e.size)(e),u=(e,t)=>e?.forEach(t),h=(e,t)=>e?.delete(t),p=e=>new Map(e),C=(e,t)=>e?.get(t),g=(e,t,n)=>c(n)?(h(e,t),e):e?.set(t,n),k=(e,t,n)=>(a(e,t)||g(e,t,n()),C(e,t)),f=(e,t,r,s,o=0)=>i((r?k:C)(e,t[o],o>n(t)-2?r:p),(l=>{if(o>n(t)-2)return s?.(l)&&g(e,t[o]),l;const c=f(l,t,r,s,o+1);return d(l)&&g(e,t[o]),c})),v=e=>new Set(Array.isArray(e)||c(e)?e:[e]),L=/^\d+$/,w=e=>{let r;const[o,a]=(()=>{const e=[];let t=0;return[()=>l(e)??""+t++,t=>{L.test(t)&&n(e)<1e3&&s(e,t)}]})(),k=p();return[(t,n,s)=>{r??=e();const l=o();var c,i;return g(k,l,[t,n,s]),c=f(n,s??[""],v),i=l,c?.add(i),l},(e,o,...l)=>t(((e,r=[""])=>{const o=[],l=(e,c)=>c==n(r)?s(o,e):null===r[c]?u(e,(e=>l(e,c+1))):t([r[c],null],(t=>l(C(e,t),c+1)));return l(e,0),o})(e,o),(e=>u(e,(e=>C(k,e)[0](r,...o??[],...l))))),e=>i(C(k,e),(([,t,n])=>(f(t,n??[""],void 0,(t=>(h(t,e),d(t)?1:0))),g(k,e),a(e),n))),(e,s,o)=>i(C(k,e),(([e,,l=[]])=>{const i=(...a)=>{const d=n(a);d==n(l)?e(r,...a,...o(a)):c(l[d])?t(s[d](...a),(e=>i(...a,e))):i(...a,l[d])};i()}))]},S=Object.freeze,y=(e=>{const t=new WeakMap;return n=>(t.has(n)||t.set(n,e(n)),t.get(n))})((h=>{let f,v,L,y=100,z=p(),E=1;const A=p(),I=p(),[M,b,j]=w((()=>Q)),x=p(),B=p(),F=[],O=[],T=(e,t)=>{E=0,h.transaction((()=>u(C(x,t),((t,n)=>u(t,((t,r)=>u(t,((t,s)=>((e,t,n,r,s)=>c(s)?e.delCell(t,n,r,!0):e.setCell(t,n,r,s))(h,n,r,s,t[e]))))))))),E=1},W=e=>{g(x,e),g(B,e),b(I,[e])},$=(e,r)=>t(((e,t)=>e.splice(0,t))(e,r??n(e)),W),m=()=>$(F,n(F)-y),q=h.addCellListener(null,null,null,((e,t,n,r,l,c)=>{if(E){i(f,(()=>{s(F,f),m(),$(O),f=void 0,L=1}));const e=k(z,t,p),a=k(e,n,p),u=k(a,r,(()=>[c,void 0]));u[1]=l,u[0]===l&&d(g(a,r))&&d(g(e,n))&&d(g(z,t))&&(f=o(F),L=1),J()}})),D=(e="")=>(c(f)&&(f=""+v++,g(x,f,z),N(f,e),z=p(),L=1),f),G=()=>{r(F)||(O.unshift(D()),T(0,f),f=o(F),L=1)},H=()=>{r(O)||(s(F,f),f=l(O),T(1,f),L=1)},J=()=>{L&&(b(A),L=0)},K=e=>{const t=D(e);return J(),t},N=(e,t)=>(P(e)&&C(B,e)!==t&&(g(B,e,t),b(I,[e])),Q),P=e=>a(x,e),Q={setSize:e=>(y=e,m(),Q),addCheckpoint:K,setCheckpoint:N,getStore:()=>h,getCheckpointIds:()=>[[...F],f,[...O]],forEachCheckpoint:e=>{return t=e,u(B,((e,n)=>t(n,e)));var t},hasCheckpoint:P,getCheckpoint:e=>C(B,e),goBackward:()=>(G(),J(),Q),goForward:()=>(H(),J(),Q),goTo:t=>{const n=e(F,t)?G:e(O,t)?H:null;for(;!c(n)&&t!=f;)n();return J(),Q},addCheckpointIdsListener:e=>M(e,A),addCheckpointListener:(e,t)=>M(t,I,[e]),delListener:e=>(j(e),Q),clear:()=>($(F),$(O),c(f)||W(f),f=void 0,v=0,K(),Q),destroy:()=>{h.delListener(q)},getListenerStats:()=>({})};return S(Q.clear())}));export{y as createCheckpoints};
+const e=(e,t)=>e.includes(t),t=(e,t)=>e.forEach(t),n=e=>e.length,r=e=>0==n(e),s=(e,...t)=>e.push(...t),o=e=>e.pop(),l=e=>e.shift(),c=e=>null==e,i=(e,t,n)=>c(e)?n?.():t(e),a=(e,t)=>e?.has(t)??!1,d=e=>c(e)||0==(e=>e.size)(e),u=(e,t)=>e?.forEach(t),h=(e,t)=>e?.delete(t),p=e=>new Map(e),C=(e,t)=>e?.get(t),g=(e,t,n)=>c(n)?(h(e,t),e):e?.set(t,n),k=(e,t,n)=>(a(e,t)||g(e,t,n()),C(e,t)),f=(e,t,r,s,o=0)=>i((r?k:C)(e,t[o],o>n(t)-2?r:p),(l=>{if(o>n(t)-2)return s?.(l)&&g(e,t[o]),l;const c=f(l,t,r,s,o+1);return d(l)&&g(e,t[o]),c})),v=e=>new Set(Array.isArray(e)||c(e)?e:[e]),L=/^\d+$/,w=e=>{let r;const[o,a]=(()=>{const e=[];let t=0;return[()=>l(e)??""+t++,t=>{L.test(t)&&n(e)<1e3&&s(e,t)}]})(),k=p();return[(t,n,s)=>{r??=e();const l=o();var c,i;return g(k,l,[t,n,s]),c=f(n,s??[""],v),i=l,c?.add(i),l},(e,o,...l)=>t(((e,r=[""])=>{const o=[],l=(e,c)=>c==n(r)?s(o,e):null===r[c]?u(e,(e=>l(e,c+1))):t([r[c],null],(t=>l(C(e,t),c+1)));return l(e,0),o})(e,o),(e=>u(e,(e=>C(k,e)[0](r,...o??[],...l))))),e=>i(C(k,e),(([,t,n])=>(f(t,n??[""],void 0,(t=>(h(t,e),d(t)?1:0))),g(k,e),a(e),n))),(e,s,o)=>i(C(k,e),(([e,,l=[]])=>{const i=(...a)=>{const d=n(a);d==n(l)?e(r,...a,...o(a)):c(l[d])?t(s[d](...a),(e=>i(...a,e))):i(...a,l[d])};i()}))]},S=Object.freeze,y=(e=>{const t=new WeakMap;return n=>(t.has(n)||t.set(n,e(n)),t.get(n))})((h=>{let f,v,L,y=100,z=p(),E=1;const A=p(),I=p(),[M,b,j]=w((()=>Q)),x=p(),B=p(),F=[],O=[],T=(e,t)=>{E=0,h.transaction((()=>u(C(x,t),((t,n)=>u(t,((t,r)=>u(t,((t,s)=>((e,t,n,r,s)=>c(s)?e.delCell(t,n,r,!0):e.setCell(t,n,r,s))(h,n,r,s,t[e]))))))))),E=1},W=e=>{g(x,e),g(B,e),b(I,[e])},$=(e,r)=>t(((e,t)=>e.splice(0,t))(e,r??n(e)),W),m=()=>$(F,n(F)-y),q=h.addCellListener(null,null,null,((e,t,n,r,l,c)=>{if(E){i(f,(()=>{s(F,f),m(),$(O),f=void 0,L=1}));const e=k(z,t,p),a=k(e,n,p),u=k(a,r,(()=>[c,void 0]));u[1]=l,u[0]===l&&d(g(a,r))&&d(g(e,n))&&d(g(z,t))&&(f=o(F),L=1),J()}})),D=(e="")=>(c(f)&&(f=""+v++,g(x,f,z),N(f,e),z=p(),L=1),f),G=()=>{r(F)||(((e,...t)=>{e.unshift(...t)})(O,D()),T(0,f),f=o(F),L=1)},H=()=>{r(O)||(s(F,f),f=l(O),T(1,f),L=1)},J=()=>{L&&(b(A),L=0)},K=e=>{const t=D(e);return J(),t},N=(e,t)=>(P(e)&&C(B,e)!==t&&(g(B,e,t),b(I,[e])),Q),P=e=>a(x,e),Q={setSize:e=>(y=e,m(),Q),addCheckpoint:K,setCheckpoint:N,getStore:()=>h,getCheckpointIds:()=>[[...F],f,[...O]],forEachCheckpoint:e=>{return t=e,u(B,((e,n)=>t(n,e)));var t},hasCheckpoint:P,getCheckpoint:e=>C(B,e),goBackward:()=>(G(),J(),Q),goForward:()=>(H(),J(),Q),goTo:t=>{const n=e(F,t)?G:e(O,t)?H:null;for(;!c(n)&&t!=f;)n();return J(),Q},addCheckpointIdsListener:e=>M(e,A),addCheckpointListener:(e,t)=>M(t,I,[e]),delListener:e=>(j(e),Q),clear:()=>($(F),$(O),c(f)||W(f),f=void 0,v=0,K(),Q),destroy:()=>{h.delListener(q)},getListenerStats:()=>({})};return S(Q.clear())}));export{y as createCheckpoints};

package/lib/debug/checkpoints.d.ts

@@ -913,8 +913,6 @@ export interface Checkpoints {
  * The createCheckpoints function creates a Checkpoints object, and is the main
  * entry point into the checkpoints module.
  *
- * It is trivially simple.
- *
  * A given Store can only have one Checkpoints object associated with it. If you
  * call this function twice on the same Store, your second call will return a
  * reference to the Checkpoints object created by the first.

package/lib/debug/checkpoints.js

@@ -8,12 +8,14 @@ const arrayReduce = (array, cb, initial) => array.reduce(cb, initial);
 const arrayClear = (array, to) => array.splice(0, to);
 const arrayPush = (array, ...values) => array.push(...values);
 const arrayPop = (array) => array.pop();
+const arrayUnshift = (array, ...values) => array.unshift(...values);
 const arrayShift = (array) => array.shift();
 
 const isUndefined = (thing) => thing == void 0;
 const ifNotUndefined = (value, then, otherwise) =>
   isUndefined(value) ? otherwise?.() : then(value);
 const isArray = (thing) => Array.isArray(thing);
+const test = (regex, subject) => regex.test(subject);
 
 const collSizeN = (collSizer) => (coll) =>
   arrayReduce(collValues(coll), (total, coll2) => total + collSizer(coll2), 0);
@@ -84,7 +86,7 @@ const getPoolFunctions = () => {
   return [
     () => arrayShift(pool) ?? EMPTY_STRING + nextId++,
     (id) => {
-      if (INTEGER.test(id) && arrayLength(pool) < 1e3) {
+      if (test(INTEGER, id) && arrayLength(pool) < 1e3) {
         arrayPush(pool, id);
       }
     },
@@ -238,7 +240,7 @@ const createCheckpoints = getCreateFunction((store) => {
   };
   const goBackwardImpl = () => {
     if (!arrayIsEmpty(backwardIds)) {
-      forwardIds.unshift(addCheckpointImpl());
+      arrayUnshift(forwardIds, addCheckpointImpl());
       updateStore(0, currentId);
       currentId = arrayPop(backwardIds);
       checkpointsChanged = 1;

package/lib/debug/indexes.d.ts

@@ -935,8 +935,6 @@ export interface Indexes {
  * The createIndexes function creates an Indexes object, and is the main entry
  * point into the indexes module.
  *
- * It is trivially simple.
- *
  * A given Store can only have one Indexes object associated with it. If you
  * call this function twice on the same Store, your second call will return a
  * reference to the Indexes object created by the first.

package/lib/debug/indexes.js

@@ -26,6 +26,7 @@ const ifNotUndefined = (value, then, otherwise) =>
   isUndefined(value) ? otherwise?.() : then(value);
 const isString = (thing) => getTypeOf(thing) == STRING;
 const isArray = (thing) => Array.isArray(thing);
+const test = (regex, subject) => regex.test(subject);
 
 const collSizeN = (collSizer) => (coll) =>
   arrayReduce(collValues(coll), (total, coll2) => total + collSizer(coll2), 0);
@@ -249,7 +250,7 @@ const getPoolFunctions = () => {
   return [
     () => arrayShift(pool) ?? EMPTY_STRING + nextId++,
     (id) => {
-      if (INTEGER.test(id) && arrayLength(pool) < 1e3) {
+      if (test(INTEGER, id) && arrayLength(pool) < 1e3) {
         arrayPush(pool, id);
       }
     },

package/lib/debug/metrics.d.ts

@@ -796,8 +796,6 @@ export interface Metrics {
  * The createMetrics function creates a Metrics object, and is the main entry
  * point into the metrics module.
  *
- * It is trivially simple.
- *
  * A given Store can only have one Metrics object associated with it. If you
  * call this function twice on the same Store, your second call will return a
  * reference to the Metrics object created by the first.

package/lib/debug/metrics.js

@@ -28,6 +28,7 @@ const ifNotUndefined = (value, then, otherwise) =>
 const isString = (thing) => getTypeOf(thing) == STRING;
 const isFunction = (thing) => getTypeOf(thing) == FUNCTION;
 const isArray = (thing) => Array.isArray(thing);
+const test = (regex, subject) => regex.test(subject);
 const getUndefined = () => void 0;
 
 const collSizeN = (collSizer) => (coll) =>
@@ -318,7 +319,7 @@ const getPoolFunctions = () => {
   return [
     () => arrayShift(pool) ?? EMPTY_STRING + nextId++,
     (id) => {
-      if (INTEGER.test(id) && arrayLength(pool) < 1e3) {
+      if (test(INTEGER, id) && arrayLength(pool) < 1e3) {
         arrayPush(pool, id);
       }
     },

package/lib/debug/queries.d.ts

@@ -2992,8 +2992,6 @@ export interface Queries {
  * The createQueries function creates a Queries object, and is the main entry
  * point into the queries module.
  *
- * It is trivially simple.
- *
  * A given Store can only have one Queries object associated with it. If you
  * call this function twice on the same Store, your second call will return a
  * reference to the Queries object created by the first.

package/lib/debug/relationships.d.ts

@@ -1170,8 +1170,6 @@ export interface Relationships {
  * The createRelationships function creates a Relationships object, and is the
  * main entry point into the relationships module.
  *
- * It is trivially simple.
- *
  * A given Store can only have one Relationships object associated with it. If
  * you call this function twice on the same Store, your second call will return
  * a reference to the Relationships object created by the first.

package/lib/debug/relationships.js

@@ -18,6 +18,7 @@ const ifNotUndefined = (value, then, otherwise) =>
   isUndefined(value) ? otherwise?.() : then(value);
 const isString = (thing) => getTypeOf(thing) == STRING;
 const isArray = (thing) => Array.isArray(thing);
+const test = (regex, subject) => regex.test(subject);
 
 const collSizeN = (collSizer) => (coll) =>
   arrayReduce(collValues(coll), (total, coll2) => total + collSizer(coll2), 0);
@@ -239,7 +240,7 @@ const getPoolFunctions = () => {
   return [
     () => arrayShift(pool) ?? EMPTY_STRING + nextId++,
     (id) => {
-      if (INTEGER.test(id) && arrayLength(pool) < 1e3) {
+      if (test(INTEGER, id) && arrayLength(pool) < 1e3) {
         arrayPush(pool, id);
       }
     },

package/lib/debug/store.d.ts

@@ -1652,7 +1652,7 @@ export interface Store {
    * ```
    * @category Setter
    */
-  setSchema(tablesSchema: Schema): Store;
+  setSchema(schema: Schema): Store;
 
   /**
    * The delTables method lets you remove all of the data in a Store.

package/lib/debug/store.js

@@ -56,6 +56,7 @@ const ifNotUndefined = (value, then, otherwise) =>
 const isTypeStringOrBoolean = (type) => type == STRING || type == BOOLEAN;
 const isFunction = (thing) => getTypeOf(thing) == FUNCTION;
 const isArray = (thing) => Array.isArray(thing);
+const test = (regex, subject) => regex.test(subject);
 
 const collSizeN = (collSizer) => (coll) =>
   arrayReduce(collValues(coll), (total, coll2) => total + collSizer(coll2), 0);
@@ -75,6 +76,8 @@ const mapKeys = (map) => [...(map?.keys() ?? [])];
 const mapGet = (map, key) => map?.get(key);
 const mapForEach = (map, cb) =>
   collForEach(map, (value, key) => cb(key, value));
+const mapMap = (coll, cb) =>
+  arrayMap([...(coll?.entries() ?? [])], ([key, value]) => cb(value, key));
 const mapSet = (map, key, value) =>
   isUndefined(value) ? (collDel(map, key), map) : map?.set(key, value);
 const mapEnsure = (map, key, getDefaultValue) => {
@@ -150,7 +153,7 @@ const getPoolFunctions = () => {
   return [
     () => arrayShift(pool) ?? EMPTY_STRING + nextId++,
     (id) => {
-      if (INTEGER.test(id) && arrayLength(pool) < 1e3) {
+      if (test(INTEGER, id) && arrayLength(pool) < 1e3) {
         arrayPush(pool, id);
       }
     },
@@ -464,6 +467,7 @@ const createStore = () => {
       if (collIsEmpty(mapSet(table, rowId))) {
         tableIdsChanged(tableId, -1);
         mapSet(tablesMap, tableId);
+        mapSet(tablePoolFunctions, tableId);
       }
     }
   };
@@ -634,18 +638,14 @@ const createStore = () => {
   const getTable = (tableId) =>
     mapToObj(mapGet(tablesMap, id(tableId)), mapToObj);
   const getRowIds = (tableId) => mapKeys(mapGet(tablesMap, id(tableId)));
-  const getSortedRowIds = (tableId, cellId, descending, offset = 0, limit) => {
-    const cells = [];
-    mapForEach(mapGet(tablesMap, id(tableId)), (rowId, row) =>
-      arrayPush(cells, [
-        isUndefined(cellId) ? rowId : mapGet(row, id(cellId)),
-        rowId,
-      ]),
-    );
-    return arrayMap(
+  const getSortedRowIds = (tableId, cellId, descending, offset = 0, limit) =>
+    arrayMap(
       arraySlice(
         arraySort(
-          cells,
+          mapMap(mapGet(tablesMap, id(tableId)), (row, rowId) => [
+            isUndefined(cellId) ? rowId : mapGet(row, id(cellId)),
+            rowId,
+          ]),
           ([cell1], [cell2]) =>
             defaultSorter(cell1, cell2) * (descending ? -1 : 1),
         ),
@@ -654,7 +654,6 @@ const createStore = () => {
       ),
       ([, rowId]) => rowId,
     );
-  };
   const getRow = (tableId, rowId) =>
     mapToObj(mapGet(mapGet(tablesMap, id(tableId)), id(rowId)));
   const getCellIds = (tableId, rowId) =>
@@ -809,7 +808,7 @@ const createStore = () => {
       return;
     }
     startTransaction();
-    const result = actions?.();
+    const result = actions();
     finishTransaction(doRollback);
     return result;
   };

package/lib/debug/tinybase.js

@@ -50,6 +50,7 @@ const arraySlice = (array, start, end) => array.slice(start, end);
 const arrayClear = (array, to) => array.splice(0, to);
 const arrayPush = (array, ...values) => array.push(...values);
 const arrayPop = (array) => array.pop();
+const arrayUnshift = (array, ...values) => array.unshift(...values);
 const arrayShift = (array) => array.shift();
 
 const jsonString = (obj) =>
@@ -77,6 +78,7 @@ const isTypeStringOrBoolean = (type) => type == STRING || type == BOOLEAN;
 const isString = (thing) => getTypeOf(thing) == STRING;
 const isFunction = (thing) => getTypeOf(thing) == FUNCTION;
 const isArray = (thing) => Array.isArray(thing);
+const test = (regex, subject) => regex.test(subject);
 const getUndefined = () => void 0;
 
 const collSizeN = (collSizer) => (coll) =>
@@ -97,6 +99,8 @@ const mapKeys = (map) => [...(map?.keys() ?? [])];
 const mapGet = (map, key) => map?.get(key);
 const mapForEach = (map, cb) =>
   collForEach(map, (value, key) => cb(key, value));
+const mapMap = (coll, cb) =>
+  arrayMap([...(coll?.entries() ?? [])], ([key, value]) => cb(value, key));
 const mapSet = (map, key, value) =>
   isUndefined(value) ? (collDel(map, key), map) : map?.set(key, value);
 const mapEnsure = (map, key, getDefaultValue) => {
@@ -317,7 +321,7 @@ const getPoolFunctions = () => {
   return [
     () => arrayShift(pool) ?? EMPTY_STRING + nextId++,
     (id) => {
-      if (INTEGER.test(id) && arrayLength(pool) < 1e3) {
+      if (test(INTEGER, id) && arrayLength(pool) < 1e3) {
         arrayPush(pool, id);
       }
     },
@@ -487,7 +491,7 @@ const createCheckpoints = getCreateFunction((store) => {
   };
   const goBackwardImpl = () => {
     if (!arrayIsEmpty(backwardIds)) {
-      forwardIds.unshift(addCheckpointImpl());
+      arrayUnshift(forwardIds, addCheckpointImpl());
       updateStore(0, currentId);
       currentId = arrayPop(backwardIds);
       checkpointsChanged = 1;
@@ -1995,6 +1999,7 @@ const createStore = () => {
       if (collIsEmpty(mapSet(table, rowId))) {
         tableIdsChanged(tableId, -1);
         mapSet(tablesMap, tableId);
+        mapSet(tablePoolFunctions, tableId);
       }
     }
   };
@@ -2165,18 +2170,14 @@ const createStore = () => {
   const getTable = (tableId) =>
     mapToObj(mapGet(tablesMap, id(tableId)), mapToObj);
   const getRowIds = (tableId) => mapKeys(mapGet(tablesMap, id(tableId)));
-  const getSortedRowIds = (tableId, cellId, descending, offset = 0, limit) => {
-    const cells = [];
-    mapForEach(mapGet(tablesMap, id(tableId)), (rowId, row) =>
-      arrayPush(cells, [
-        isUndefined(cellId) ? rowId : mapGet(row, id(cellId)),
-        rowId,
-      ]),
-    );
-    return arrayMap(
+  const getSortedRowIds = (tableId, cellId, descending, offset = 0, limit) =>
+    arrayMap(
       arraySlice(
         arraySort(
-          cells,
+          mapMap(mapGet(tablesMap, id(tableId)), (row, rowId) => [
+            isUndefined(cellId) ? rowId : mapGet(row, id(cellId)),
+            rowId,
+          ]),
           ([cell1], [cell2]) =>
             defaultSorter(cell1, cell2) * (descending ? -1 : 1),
         ),
@@ -2185,7 +2186,6 @@ const createStore = () => {
       ),
       ([, rowId]) => rowId,
     );
-  };
   const getRow = (tableId, rowId) =>
     mapToObj(mapGet(mapGet(tablesMap, id(tableId)), id(rowId)));
   const getCellIds = (tableId, rowId) =>
@@ -2340,7 +2340,7 @@ const createStore = () => {
       return;
     }
     startTransaction();
-    const result = actions?.();
+    const result = actions();
     finishTransaction(doRollback);
     return result;
   };

package/lib/debug/tools.d.ts

@@ -0,0 +1,290 @@
+/**
+ * The tools module of the TinyBase project provides utilities for working with
+ * TinyBase during development.
+ *
+ * This module is not intended to be directly used at runtime in a production
+ * environment.
+ *
+ * @packageDocumentation
+ * @module tools
+ * @since v2.2.0
+ */
+
+import {Schema, Store} from './store.d';
+import {Id} from './common.d';
+
+/**
+ * The StoreStats type describes a set of statistics about the Store, and
+ * is used for debugging purposes.
+ *
+ * A StoreStats object is returned from the getStoreStats method.
+ *
+ * @category Statistics
+ * @since v2.2.0
+ */
+export type StoreStats = {
+  /**
+   * The number of Table objects in the Store.
+   */
+  totalTables: number;
+  /**
+   * The number of Row objects in the Store, across all Table objects.
+   */
+  totalRows: number;
+  /**
+   * The number of Cell objects in the Store, across all Row objects, across all
+   * Table objects.
+   */
+  totalCells: number;
+  /**
+   * The string length of the Store when serialized to JSON.
+   */
+  jsonLength: number;
+  /**
+   * Additional detailed statistics about the Store if the `detail` flag is
+   * specified in the getStoreStats method.
+   */
+  detail?: StoreStatsDetail;
+};
+
+/**
+ * The StoreStatsDetail type describes a more detailed set of statistics about
+ * the Store, and is used for debugging purposes.
+ *
+ * A StoreStatsDetail object is added to the StoreStats object (returned from
+ * the getStoreStats method) when the `detail` flag is specified.
+ *
+ * @category Statistics
+ * @since v2.2.0
+ */
+export type StoreStatsDetail = {
+  /**
+   * Information about each Table in the Store.
+   */
+  tables: {[tableId: Id]: StoreStatsTableDetail};
+};
+
+/**
+ * The StoreStatsTableDetail type describes a detailed set of statistics about a
+ * single Table in the Store, and is used for debugging purposes.
+ *
+ * @category Statistics
+ * @since v2.2.0
+ */
+export type StoreStatsTableDetail = {
+  /**
+   * The number of Row objects in the Table.
+   */
+  tableRows: number;
+  /**
+   * The number of Cell objects in the Table, across all Row objects.
+   */
+  tableCells: number;
+  rows: {[rowId: Id]: StoreStatsRowDetail};
+};
+
+/**
+ * The StoreStatsRowDetail type describes statistics about a single Row in the
+ * Store, and is used for debugging purposes.
+ *
+ * @category Statistics
+ * @since v2.2.0
+ */
+export type StoreStatsRowDetail = {
+  /**
+   * The number of Cell objects in the Row.
+   */
+  rowCells: number;
+};
+
+/**
+ * A Tools object lets you run various utilities on, and get certain information
+ * about, Store objects in development.
+ *
+ * @category Tools
+ * @since v2.2.0
+ */
+export interface Tools {
+  /**
+   * The getStoreStats method provides a set of statistics about the Store, and
+   * is used for debugging purposes.
+   *
+   * @param detail An optional boolean that indicates more detailed stats about
+   * the inner structure of the Store should be returned.
+   * @returns A StoreStats object containing statistics about the Store.
+   * @example
+   * This example creates a Tools object and gets basic statistics about it.
+   * ```js
+   * const store = createStore()
+   *   .setTable('pets', {
+   *     fido: {species: 'dog', color: 'brown'},
+   *     felix: {species: 'cat', color: 'black'},
+   *     cujo: {species: 'dog', color: 'black'},
+   *   })
+   *   .setTable('species', {
+   *     dog: {price: 5},
+   *     cat: {price: 4},
+   *   });
+   * const tools = createTools(store);
+   * console.log(tools.getStoreStats());
+   * // -> {totalTables: 2, totalRows: 5, totalCells: 8, jsonLength: 182}
+   * ```
+   * @example
+   * This example creates a Tools object and gets detailed statistics about it.
+   * ```js
+   * const store = createStore()
+   *   .setTable('pets', {
+   *     fido: {species: 'dog', color: 'brown'},
+   *     felix: {species: 'cat', color: 'black'},
+   *     cujo: {species: 'dog', color: 'black'},
+   *   })
+   *   .setTable('species', {
+   *     dog: {price: 5},
+   *     cat: {price: 4},
+   *   });
+   * const stats = createTools(store).getStoreStats(true);
+   *
+   * console.log(stats.totalTables);
+   * // -> 2
+   * console.log(stats.totalRows);
+   * // -> 5
+   * console.log(stats.totalCells);
+   * // -> 8
+   * console.log(stats.detail.tables.pets.tableRows);
+   * // -> 3
+   * console.log(stats.detail.tables.pets.tableCells);
+   * // -> 6
+   * console.log(stats.detail.tables.pets.rows);
+   * // -> {fido: {rowCells: 2}, felix: {rowCells: 2}, cujo: {rowCells: 2}}
+   * ```
+   * @category Statistics
+   * @since v2.2.0
+   */
+  getStoreStats(detail?: boolean): StoreStats;
+
+  /**
+   * The getStoreSchema method returns the Schema of the Store as an object.
+   *
+   * If the Store does not already have an explicit Schema associated with it,
+   * the data in the Store will be scanned to attempt to infer a new Schema.
+   *
+   * To be successful, this requires all the values of a given Cell across a
+   * Table object's  Row objects to have a consistent type. If a given Cell Id
+   * appears in every Row, then a `default` for that Cell is specified in the
+   * Schema, based on the most common value found.
+   *
+   * @returns A Schema object for the Store.
+   * @example
+   * This example creates a Tools object and gets basic statistics about a Store
+   * that already has a Schema.
+   * ```js
+   * const store = createStore().setSchema({
+   *   pets: {
+   *     species: {type: 'string'},
+   *     color: {type: 'string'},
+   *   },
+   *   species: {
+   *     price: {type: 'number'},
+   *   },
+   * });
+   * const schema = createTools(store).getStoreSchema();
+   * console.log(schema.pets);
+   * // -> {species: {type: 'string'}, color: {type: 'string'}}
+   * ```
+   * @example
+   * This example creates a Tools object and gets basic statistics about a Store
+   * that doesn't already have a Schema.
+   * ```js
+   * const store = createStore()
+   *   .setTable('pets', {
+   *     fido: {species: 'dog', color: 'brown'},
+   *     felix: {species: 'cat', color: 'black'},
+   *     cujo: {species: 'dog', color: 'black'},
+   *   })
+   *   .setTable('species', {
+   *     dog: {price: 5, barks: true},
+   *     cat: {price: 4, purrs: true},
+   *   });
+   * const schema = createTools(store).getStoreSchema();
+   * console.log(schema.pets.species);
+   * // -> {type: 'string', default: 'dog'}
+   * console.log(schema.pets.color);
+   * // -> {type: 'string', default: 'black'}
+   * console.log(schema.species.price);
+   * // -> {type: 'number', default: 5}
+   * console.log(schema.species.barks);
+   * // -> {type: 'boolean'}
+   * console.log(schema.species.purrs);
+   * // -> {type: 'boolean'}
+   * ```
+   * @category Modelling
+   * @since v2.2.0
+   */
+  getStoreSchema(): Schema;
+
+  /**
+   * The getStoreApi method returns a code-generated .d.ts file and a .ts file
+   * that wraps the schema of a Store.
+   *
+   * This is currently in development, and further documentation is to come.
+   *
+   * @category Modelling
+   * @since v2.2.0
+   */
+  getStoreApi(storeName: string): [string, string];
+
+  /**
+   * The getStoreApi method attempts to return a prettified code-generated .d.ts
+   * file and a .ts file that wraps the schema of a Store.
+   *
+   * This is currently in development, and further documentation is to come.
+   *
+   * @category Modelling
+   * @since v2.2.0
+   */
+  getPrettyStoreApi(storeName: string): Promise<[string, string]>;
+}
+
+/**
+ * The createTools function creates a Tools object, and is the main entry point
+ * into the tools module.
+ *
+ * A given Store can only have one Tools object associated with it. If you call
+ * this function twice on the same Store, your second call will return a
+ * reference to the Tools object created by the first.
+ *
+ * @param store The Store for which to register tools.
+ * @returns A reference to the new Tools object.
+ * @example
+ * This example creates a Tools object.
+ *
+ * ```js
+ * const store = createStore()
+ *   .setTable('pets', {
+ *     fido: {species: 'dog', color: 'brown'},
+ *     felix: {species: 'cat', color: 'black'},
+ *     cujo: {species: 'dog', color: 'black'},
+ *   })
+ *   .setTable('species', {
+ *     dog: {price: 5},
+ *     cat: {price: 4},
+ *   });
+ * const tools = createTools(store);
+ * console.log(tools.getStoreStats());
+ * // -> {totalTables: 2, totalRows: 5, totalCells: 8, jsonLength: 182}
+ * ```
+ * @example
+ * This example creates a Tools object, and calls the method a second time
+ * for the same Store to return the same object.
+ *
+ * ```js
+ * const store = createStore();
+ * const tools1 = createTools(store);
+ * const tools2 = createTools(store);
+ * console.log(tools1 === tools2);
+ * // -> true
+ * ```
+ * @category Creation
+ * @since v2.2.0
+ */
+export function createTools(store: Store): Tools;