tinybase 3.1.0-beta.3 → 3.1.0-beta.4

package/bin/cli.js

@@ -1,2 +1,2 @@
 #! /usr/bin/env node
-import{resolve as e,dirname as t}from"path";import{readFileSync as r,writeFileSync as i}from"fs";import{createStore as a}from"tinybase";import{createTools as s}from"tinybase/tools";import{fileURLToPath as n}from"url";const o=JSON.parse,m=Object,c="provide a valid schemaFile, storeName, and outputDir",p=(...e)=>{return t=e=>process.stdout.write(e+"\n"),e.forEach(t);var t},f=e=>process.stderr.write(`ERROR: ${e}\n`),d=e=>o(r(e,"utf8")),l=(t,r,a,s)=>{const n=e(t,r);p(s.padStart(23)+": "+n),i(n,a,"utf8")},u=e=>{const t=d(e);return s(a().setSchema(...(r=t,Array.isArray(r)?t:[t])));var r},h=()=>{var e,t;p("","tinybase <command>","","Usage:",""),e=y,t=([,e,t],r)=>p(` tinybase ${r} ${e}`," - "+t,""),((e,t)=>{e.map(t)})(m.entries(e),(([e,r])=>t(r,e))),p("See also http://tinybase.org/guides/developer-tools/command-line/","")},y={help:[h,"","print this message"],version:[()=>p(d(e(t(n(import.meta.url)),"../package.json")).version),"","get the current TinyBase version"],getStoreApi:[async(e,t,r)=>{try{const[i,a,s,n]=await u(e).getPrettyStoreApi(t);l(r,t+".d.ts",i,"Definition"),l(r,t+".ts",a,"Implementation"),l(r,t+"-ui-react.d.ts",s,"UI React definition"),l(r,t+"-ui-react.tsx",n,"UI React implementation")}catch{f(c)}},"<schemaFile> <storeName> <outputDir>","generate .d.ts, .ts, and .tsx API files from a schema file"],getStoreRefinement:[async(e,t,r)=>{try{const[i,a]=await u(e).getPrettyStoreRefinement(t);l(r,t+"-refinement.d.ts",i,"Definition"),l(r,t+"-ui-react-refinement.d.ts",a,"UI React definition")}catch{f(c)}},"<schemaFile> <storeName> <outputDir>","generate .d.ts refinement files from a schema file"]};(()=>{const[,,e,...t]=process.argv;(y[e]?.[0]??h)(...t)})();
+import{resolve as t,dirname as e}from"path";import{readFileSync as r,writeFileSync as s}from"fs";import{createStore as a}from"tinybase";import{createTools as o}from"tinybase/tools";import{fileURLToPath as i}from"url";const n=JSON.parse,m=Object,c=(...t)=>{return e=t=>process.stdout.write(t+"\n"),t.forEach(e);var e},p=t=>n(r(t,"utf8")),d=(e,r,a,o)=>{const i=t(e,r);c(o.padStart(23)+": "+i),s(i,a,"utf8")},l=()=>{var t,e;c("","tinybase <command>","","Usage:",""),t=u,e=([,t,e],r)=>c(` tinybase ${r} ${t}`," - "+e,""),((t,e)=>{t.map(e)})(m.entries(t),(([t,r])=>e(r,t))),c("See also http://tinybase.org/guides/developer-tools/command-line/","")},u={help:[l,"","print this message"],version:[()=>c(p(t(e(i(import.meta.url)),"../package.json")).version),"","get the current TinyBase version"],getStoreApi:[async(t,e,r)=>{try{const[s,i,n,m]=await(t=>{const e=p(t);return o(a().setSchema(...(r=e,Array.isArray(r)?e:[e])));var r})(t).getPrettyStoreApi(e);d(r,e+".d.ts",s,"Definition"),d(r,e+".ts",i,"Implementation"),d(r,e+"-ui-react.d.ts",n,"UI React definition"),d(r,e+"-ui-react.tsx",m,"UI React implementation")}catch{process.stderr.write("ERROR: provide a valid schemaFile, storeName, and outputDir\n")}},"<schemaFile> <storeName> <outputDir>","generate .d.ts, .ts, and .tsx API files from a schema file"]};(()=>{const[,,t,...e]=process.argv;(u[t]?.[0]??l)(...e)})();

package/lib/checkpoints.d.ts

@@ -12,7 +12,7 @@
  */
 
 import {Id, IdOrNull, Ids} from './common.d';
-import {Store} from './store.d';
+import {NoSchemas, OptionalSchemas, Store} from './store.d';
 
 /**
  * The CheckpointIds type is a representation of the list of checkpoint Ids
@@ -177,7 +177,7 @@ export type CheckpointsListenerStats = {
  * @see Drawing demo
  * @category Checkpoints
  */
-export interface Checkpoints {
+export interface Checkpoints<Schemas extends OptionalSchemas = NoSchemas> {
   /**
    * The setSize method lets you specify how many checkpoints the Checkpoints
    * object will store.
@@ -220,7 +220,7 @@ export interface Checkpoints {
    * ```
    * @category Configuration
    */
-  setSize(size: number): Checkpoints;
+  setSize(size: number): Checkpoints<Schemas>;
 
   /**
    * The addCheckpoint method records a checkpoint of the Store into the
@@ -320,7 +320,7 @@ export interface Checkpoints {
    * ```
    * @category Setter
    */
-  setCheckpoint(checkpointId: Id, label: string): Checkpoints;
+  setCheckpoint(checkpointId: Id, label: string): Checkpoints<Schemas>;
 
   /**
    * The getStore method returns a reference to the underlying Store that is
@@ -341,7 +341,7 @@ export interface Checkpoints {
    * ```
    * @category Getter
    */
-  getStore(): Store;
+  getStore(): Store<Schemas>;
 
   /**
    * The getCheckpointIds method returns an array of the checkpoint Ids being
@@ -637,7 +637,7 @@ export interface Checkpoints {
    * ```
    * @category Listener
    */
-  delListener(listenerId: Id): Checkpoints;
+  delListener(listenerId: Id): Checkpoints<Schemas>;
 
   /**
    * The goBackward method moves the state of the underlying Store back to the
@@ -670,7 +670,7 @@ export interface Checkpoints {
    * ```
    * @category Movement
    */
-  goBackward(): Checkpoints;
+  goBackward(): Checkpoints<Schemas>;
 
   /**
    * The goForward method moves the state of the underlying Store forwards to a
@@ -750,7 +750,7 @@ export interface Checkpoints {
    * ```
    * @category Movement
    */
-  goForward(): Checkpoints;
+  goForward(): Checkpoints<Schemas>;
 
   /**
    * The goTo method moves the state of the underlying Store backwards or
@@ -800,7 +800,7 @@ export interface Checkpoints {
    * ```
    * @category Movement
    */
-  goTo(checkpointId: Id): Checkpoints;
+  goTo(checkpointId: Id): Checkpoints<Schemas>;
 
   /**
    * The clear method resets this Checkpoints object to its initial state,
@@ -858,7 +858,7 @@ export interface Checkpoints {
    * ```
    * @category Lifecycle
    */
-  clear(): Checkpoints;
+  clear(): Checkpoints<Schemas>;
 
   /**
    * The destroy method should be called when this Checkpoints object is no
@@ -956,4 +956,6 @@ export interface Checkpoints {
  * ```
  * @category Creation
  */
-export function createCheckpoints(store: Store): Checkpoints;
+export function createCheckpoints<Schemas extends OptionalSchemas>(
+  store: Store<Schemas>,
+): Checkpoints<Schemas>;

package/lib/cjs/checkpoints.d.ts

@@ -12,7 +12,7 @@
  */
 
 import {Id, IdOrNull, Ids} from './common.d';
-import {Store} from './store.d';
+import {NoSchemas, OptionalSchemas, Store} from './store.d';
 
 /**
  * The CheckpointIds type is a representation of the list of checkpoint Ids
@@ -177,7 +177,7 @@ export type CheckpointsListenerStats = {
  * @see Drawing demo
  * @category Checkpoints
  */
-export interface Checkpoints {
+export interface Checkpoints<Schemas extends OptionalSchemas = NoSchemas> {
   /**
    * The setSize method lets you specify how many checkpoints the Checkpoints
    * object will store.
@@ -220,7 +220,7 @@ export interface Checkpoints {
    * ```
    * @category Configuration
    */
-  setSize(size: number): Checkpoints;
+  setSize(size: number): Checkpoints<Schemas>;
 
   /**
    * The addCheckpoint method records a checkpoint of the Store into the
@@ -320,7 +320,7 @@ export interface Checkpoints {
    * ```
    * @category Setter
    */
-  setCheckpoint(checkpointId: Id, label: string): Checkpoints;
+  setCheckpoint(checkpointId: Id, label: string): Checkpoints<Schemas>;
 
   /**
    * The getStore method returns a reference to the underlying Store that is
@@ -341,7 +341,7 @@ export interface Checkpoints {
    * ```
    * @category Getter
    */
-  getStore(): Store;
+  getStore(): Store<Schemas>;
 
   /**
    * The getCheckpointIds method returns an array of the checkpoint Ids being
@@ -637,7 +637,7 @@ export interface Checkpoints {
    * ```
    * @category Listener
    */
-  delListener(listenerId: Id): Checkpoints;
+  delListener(listenerId: Id): Checkpoints<Schemas>;
 
   /**
    * The goBackward method moves the state of the underlying Store back to the
@@ -670,7 +670,7 @@ export interface Checkpoints {
    * ```
    * @category Movement
    */
-  goBackward(): Checkpoints;
+  goBackward(): Checkpoints<Schemas>;
 
   /**
    * The goForward method moves the state of the underlying Store forwards to a
@@ -750,7 +750,7 @@ export interface Checkpoints {
    * ```
    * @category Movement
    */
-  goForward(): Checkpoints;
+  goForward(): Checkpoints<Schemas>;
 
   /**
    * The goTo method moves the state of the underlying Store backwards or
@@ -800,7 +800,7 @@ export interface Checkpoints {
    * ```
    * @category Movement
    */
-  goTo(checkpointId: Id): Checkpoints;
+  goTo(checkpointId: Id): Checkpoints<Schemas>;
 
   /**
    * The clear method resets this Checkpoints object to its initial state,
@@ -858,7 +858,7 @@ export interface Checkpoints {
    * ```
    * @category Lifecycle
    */
-  clear(): Checkpoints;
+  clear(): Checkpoints<Schemas>;
 
   /**
    * The destroy method should be called when this Checkpoints object is no
@@ -956,4 +956,6 @@ export interface Checkpoints {
  * ```
  * @category Creation
  */
-export function createCheckpoints(store: Store): Checkpoints;
+export function createCheckpoints<Schemas extends OptionalSchemas>(
+  store: Store<Schemas>,
+): Checkpoints<Schemas>;

package/lib/cjs/indexes.d.ts

@@ -11,7 +11,13 @@
  * @module indexes
  */
 
-import {GetCell, RowCallback, Store} from './store.d';
+import {
+  GetCell,
+  NoSchemas,
+  OptionalSchemas,
+  RowCallback,
+  Store,
+} from './store.d';
 import {Id, IdOrNull, Ids, SortKey} from './common.d';
 
 /**
@@ -195,7 +201,7 @@ export type IndexesListenerStats = {
  * @see Word Frequencies demo
  * @category Indexes
  */
-export interface Indexes {
+export interface Indexes<Schemas extends OptionalSchemas = NoSchemas> {
   /**
    * The setIndexDefinition method lets you set the definition of an Index.
    *
@@ -355,7 +361,7 @@ export interface Indexes {
     getSortKey?: Id | ((getCell: GetCell, rowId: Id) => SortKey),
     sliceIdSorter?: (sliceId1: Id, sliceId2: Id) => number,
     rowIdSorter?: (sortKey1: SortKey, sortKey2: SortKey, sliceId: Id) => number,
-  ): Indexes;
+  ): Indexes<Schemas>;
 
   /**
    * The delIndexDefinition method removes an existing Index definition.
@@ -384,7 +390,7 @@ export interface Indexes {
    * ```
    * @category Configuration
    */
-  delIndexDefinition(indexId: Id): Indexes;
+  delIndexDefinition(indexId: Id): Indexes<Schemas>;
 
   /**
    * The getStore method returns a reference to the underlying Store that is
@@ -404,7 +410,7 @@ export interface Indexes {
    * ```
    * @category Getter
    */
-  getStore(): Store;
+  getStore(): Store<Schemas>;
 
   /**
    * The getIndexIds method returns an array of the Index Ids registered with
@@ -860,7 +866,7 @@ export interface Indexes {
    * ```
    * @category Listener
    */
-  delListener(listenerId: Id): Indexes;
+  delListener(listenerId: Id): Indexes<Schemas>;
 
   /**
    * The destroy method should be called when this Indexes object is no longer
@@ -963,4 +969,6 @@ export interface Indexes {
  * ```
  * @category Creation
  */
-export function createIndexes(store: Store): Indexes;
+export function createIndexes<Schemas extends OptionalSchemas>(
+  store: Store<Schemas>,
+): Indexes<Schemas>;

package/lib/cjs/metrics.d.ts

@@ -11,7 +11,7 @@
  * @module metrics
  */
 
-import {GetCell, Store} from './store.d';
+import {GetCell, NoSchemas, OptionalSchemas, Store} from './store.d';
 import {Id, IdOrNull, Ids} from './common.d';
 
 /**
@@ -246,7 +246,7 @@ export type MetricsListenerStats = {
  * @see Todo App demos
  * @category Metrics
  */
-export interface Metrics {
+export interface Metrics<Schemas extends OptionalSchemas = NoSchemas> {
   /**
    * The setMetricDefinition method lets you set the definition of a Metric.
    *
@@ -420,7 +420,7 @@ export interface Metrics {
     aggregateAdd?: AggregateAdd,
     aggregateRemove?: AggregateRemove,
     aggregateReplace?: AggregateReplace,
-  ): Metrics;
+  ): Metrics<Schemas>;
 
   /**
    * The delMetricDefinition method removes an existing Metric definition.
@@ -449,7 +449,7 @@ export interface Metrics {
    * ```
    * @category Configuration
    */
-  delMetricDefinition(metricId: Id): Metrics;
+  delMetricDefinition(metricId: Id): Metrics<Schemas>;
 
   /**
    * The getStore method returns a reference to the underlying Store that is
@@ -469,7 +469,7 @@ export interface Metrics {
    * ```
    * @category Getter
    */
-  getStore(): Store;
+  getStore(): Store<Schemas>;
 
   /**
    * The getMetricIds method returns an array of the Metric Ids registered with
@@ -729,7 +729,7 @@ export interface Metrics {
    * ```
    * @category Listener
    */
-  delListener(listenerId: Id): Metrics;
+  delListener(listenerId: Id): Metrics<Schemas>;
 
   /**
    * The destroy method should be called when this Metrics object is no longer
@@ -824,4 +824,6 @@ export interface Metrics {
  * ```
  * @category Creation
  */
-export function createMetrics(store: Store): Metrics;
+export function createMetrics<Schemas extends OptionalSchemas>(
+  store: Store<Schemas>,
+): Metrics<Schemas>;

package/lib/cjs/persisters.d.ts

@@ -27,7 +27,7 @@
  * @module persisters
  */
 
-import {Store, Tables, Values} from './store.d';
+import {NoSchemas, OptionalSchemas, Store, Tables, Values} from './store.d';
 import {Callback} from './common.d';
 
 /**
@@ -145,7 +145,7 @@ export type PersisterStats = {
  * ```
  * @category Persister
  */
-export interface Persister {
+export interface Persister<Schemas extends OptionalSchemas = NoSchemas> {
   /**
    * The load method gets persisted data from storage, and loads it into the
    * Store with which the Persister is associated, once.
@@ -206,7 +206,10 @@ export interface Persister {
    * ```
    * @category Load
    */
-  load(initialTables?: Tables, initialValues?: Values): Promise<Persister>;
+  load(
+    initialTables?: Tables<Schemas[0], true>,
+    initialValues?: Values,
+  ): Promise<Persister<Schemas>>;
 
   /**
    * The startAutoLoad method gets persisted data from storage, and loads it
@@ -263,9 +266,9 @@ export interface Persister {
    * @category Load
    */
   startAutoLoad(
-    initialTables?: Tables,
+    initialTables?: Tables<Schemas[0], true>,
     initialValues?: Values,
-  ): Promise<Persister>;
+  ): Promise<Persister<Schemas>>;
 
   /**
    * The stopAutoLoad method stops the automatic loading of data from storage
@@ -310,7 +313,7 @@ export interface Persister {
    * ```
    * @category Load
    */
-  stopAutoLoad(): Persister;
+  stopAutoLoad(): Persister<Schemas>;
 
   /**
    * The save method takes data from the Store with which the Persister is
@@ -339,7 +342,7 @@ export interface Persister {
    * ```
    * @category Save
    */
-  save(): Promise<Persister>;
+  save(): Promise<Persister<Schemas>>;
 
   /**
    * The save method takes data from the Store with which the Persister is
@@ -377,7 +380,7 @@ export interface Persister {
    * ```
    * @category Save
    */
-  startAutoSave(): Promise<Persister>;
+  startAutoSave(): Promise<Persister<Schemas>>;
 
   /**
    * The stopAutoSave method stops the automatic save of data to storage
@@ -415,7 +418,7 @@ export interface Persister {
    * ```
    * @category Save
    */
-  stopAutoSave(): Persister;
+  stopAutoSave(): Persister<Schemas>;
 
   /**
    * The getStore method returns a reference to the underlying Store that is
@@ -439,7 +442,7 @@ export interface Persister {
    * ```
    * @category Getter
    */
-  getStore(): Store;
+  getStore(): Store<Schemas>;
 
   /**
    * The destroy method should be called when this Persister object is no longer
@@ -470,7 +473,7 @@ export interface Persister {
    * ```
    * @category Lifecycle
    */
-  destroy(): Persister;
+  destroy(): Persister<Schemas>;
 
   /**
    * The getStats method provides a set of statistics about the Persister, and
@@ -546,10 +549,10 @@ export interface Persister {
  * ```
  * @category Creation
  */
-export function createSessionPersister(
-  store: Store,
+export function createSessionPersister<Schemas extends OptionalSchemas>(
+  store: Store<Schemas>,
   storageName: string,
-): Persister;
+): Persister<Schemas>;
 
 /**
  * The createLocalPersister function creates a Persister object that can
@@ -579,10 +582,10 @@ export function createSessionPersister(
  * ```
  * @category Creation
  */
-export function createLocalPersister(
-  store: Store,
+export function createLocalPersister<Schemas extends OptionalSchemas>(
+  store: Store<Schemas>,
   storageName: string,
-): Persister;
+): Persister<Schemas>;
 
 /**
  * The createRemotePersister function creates a Persister object that can
@@ -626,12 +629,12 @@ export function createLocalPersister(
  * ```
  * @category Creation
  */
-export function createRemotePersister(
-  store: Store,
+export function createRemotePersister<Schemas extends OptionalSchemas>(
+  store: Store<Schemas>,
   loadUrl: string,
   saveUrl: string,
   autoLoadIntervalSeconds: number,
-): Persister;
+): Persister<Schemas>;
 
 /**
  * The createFilePersister function creates a Persister object that can persist
@@ -661,7 +664,10 @@ export function createRemotePersister(
  * ```
  * @category Creation
  */
-export function createFilePersister(store: Store, filePath: string): Persister;
+export function createFilePersister<Schemas extends OptionalSchemas>(
+  store: Store<Schemas>,
+  filePath: string,
+): Persister<Schemas>;
 
 /**
  * The createCustomPersister function creates a Persister object that you can
@@ -718,10 +724,10 @@ export function createFilePersister(store: Store, filePath: string): Persister;
  * ```
  * @category Creation
  */
-export function createCustomPersister(
-  store: Store,
+export function createCustomPersister<Schemas extends OptionalSchemas>(
+  store: Store<Schemas>,
   getPersisted: () => Promise<string | null | undefined>,
   setPersisted: (json: string) => Promise<void>,
   startListeningToPersisted: (didChange: Callback) => void,
   stopListeningToPersisted: Callback,
-): Persister;
+): Persister<Schemas>;

package/lib/cjs/queries.d.ts

@@ -18,6 +18,8 @@ import {
   CellOrUndefined,
   GetCell,
   GetCellChange,
+  NoSchemas,
+  OptionalSchemas,
   Row,
   RowCallback,
   Store,
@@ -1427,7 +1429,7 @@ export type Having = {
  * @category Queries
  * @since v2.0.0
  */
-export interface Queries {
+export interface Queries<Schemas extends OptionalSchemas = NoSchemas> {
   /**
    * The setQueryDefinition method lets you set the definition of a query.
    *
@@ -1501,7 +1503,7 @@ export interface Queries {
       group: Group;
       having: Having;
     }) => void,
-  ): Queries;
+  ): Queries<Schemas>;
 
   /**
    * The delQueryDefinition method removes an existing query definition.
@@ -1534,7 +1536,7 @@ export interface Queries {
    * @category Configuration
    * @since v2.0.0
    */
-  delQueryDefinition(queryId: Id): Queries;
+  delQueryDefinition(queryId: Id): Queries<Schemas>;
 
   /**
    * The getStore method returns a reference to the underlying Store that is
@@ -1560,7 +1562,7 @@ export interface Queries {
    * @category Getter
    * @since v2.0.0
    */
-  getStore(): Store;
+  getStore(): Store<Schemas>;
 
   /**
    * The getQueryIds method returns an array of the query Ids registered with
@@ -2919,7 +2921,7 @@ export interface Queries {
    * @category Listener
    * @since v2.0.0
    */
-  delListener(listenerId: Id): Queries;
+  delListener(listenerId: Id): Queries<Schemas>;
 
   /**
    * The destroy method should be called when this Queries object is no longer
@@ -3021,4 +3023,6 @@ export interface Queries {
  * @category Creation
  * @since v2.0.0
  */
-export function createQueries(store: Store): Queries;
+export function createQueries<Schemas extends OptionalSchemas>(
+  store: Store<Schemas>,
+): Queries<Schemas>;

package/lib/cjs/relationships.d.ts

@@ -11,7 +11,13 @@
  * @module relationships
  */
 
-import {GetCell, RowCallback, Store} from './store.d';
+import {
+  GetCell,
+  NoSchemas,
+  OptionalSchemas,
+  RowCallback,
+  Store,
+} from './store.d';
 import {Id, IdOrNull, Ids} from './common.d';
 
 /**
@@ -247,7 +253,7 @@ export type RelationshipsListenerStats = {
  * @see Drawing demo
  * @category Relationships
  */
-export interface Relationships {
+export interface Relationships<Schemas extends OptionalSchemas = NoSchemas> {
   /**
    * The setRelationshipDefinition method lets you set the definition of a
    * Relationship.
@@ -339,7 +345,7 @@ export interface Relationships {
     localTableId: Id,
     remoteTableId: Id,
     getRemoteRowId: Id | ((getCell: GetCell, localRowId: Id) => Id),
-  ): Relationships;
+  ): Relationships<Schemas>;
 
   /**
    * The delRelationshipDefinition method removes an existing Relationship
@@ -379,7 +385,7 @@ export interface Relationships {
    * ```
    * @category Configuration
    */
-  delRelationshipDefinition(relationshipId: Id): Relationships;
+  delRelationshipDefinition(relationshipId: Id): Relationships<Schemas>;
 
   /**
    * The getStore method returns a reference to the underlying Store that is
@@ -404,7 +410,7 @@ export interface Relationships {
    * ```
    * @category Getter
    */
-  getStore(): Store;
+  getStore(): Store<Schemas>;
 
   /**
    * The getRelationshipIds method returns an array of the Relationship Ids
@@ -1081,7 +1087,7 @@ export interface Relationships {
    * ```
    * @category Listener
    */
-  delListener(listenerId: Id): Relationships;
+  delListener(listenerId: Id): Relationships<Schemas>;
 
   /**
    * The destroy method should be called when this Relationships object is no
@@ -1198,4 +1204,6 @@ export interface Relationships {
  * ```
  * @category Creation
  */
-export function createRelationships(store: Store): Relationships;
+export function createRelationships<Schemas extends OptionalSchemas>(
+  store: Store<Schemas>,
+): Relationships<Schemas>;