tinybase 3.1.0-beta.4 → 3.1.0

package/lib/debug/ui-react.js

@@ -136,8 +136,8 @@ const useSetCallback = (
   return useCallback(
     (parameter) =>
       ifNotUndefined(store, (store2) =>
-        ifNotUndefined(get(parameter, store2), (value) =>
-          then(store2['set' + settable](...args, value), value),
+        ifNotUndefined(get(parameter, store2), (thing) =>
+          then(store2['set' + settable](...args, thing), thing),
         ),
       ),
     // eslint-disable-next-line react-hooks/exhaustive-deps

package/lib/{checkpoints.d.ts → types/checkpoints.d.ts}

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

package/lib/{debug → types}/indexes.d.ts

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

package/lib/{debug → types}/metrics.d.ts

@@ -1,6 +1,6 @@
 /**
- * The metrics module of the TinyBase project provides the ability to create
- * and track metrics and aggregates of the data in Store objects.
+ * The metrics module of the TinyBase project provides the ability to create and
+ * track metrics and aggregates of the data in Store objects.
  *
  * The main entry point to this module is the createMetrics function, which
  * returns a new Metrics object. From there, you can create new Metric
@@ -11,7 +11,7 @@
  * @module metrics
  */
 
-import {GetCell, NoSchemas, OptionalSchemas, Store} from './store.d';
+import {GetCell, Store} from './store.d';
 import {Id, IdOrNull, Ids} from './common.d';
 
 /**
@@ -37,8 +37,8 @@ export type Metric = number;
 export type MetricCallback = (metricId: Id, metric?: Metric) => void;
 
 /**
- * The Aggregate type describes a custom function that takes an array of numbers
- * and returns an aggregate that is used as a Metric.
+ * The MetricAggregate type describes a custom function that takes an array of
+ * numbers and returns an aggregate that is used as a Metric.
  *
  * There are a number of common predefined aggregators, such as for counting,
  * summing, and averaging values. This type is instead used for when you wish to
@@ -50,12 +50,12 @@ export type MetricCallback = (metricId: Id, metric?: Metric) => void;
  * @returns The value of the Metric.
  * @category Aggregators
  */
-export type Aggregate = (numbers: number[], length: number) => Metric;
+export type MetricAggregate = (numbers: number[], length: number) => Metric;
 
 /**
- * The AggregateAdd type describes a function that can be used to optimize a
- * custom Aggregate by providing a shortcut for when a single value is added to
- * the input values.
+ * The MetricAggregateAdd type describes a function that can be used to optimize
+ * a custom MetricAggregate by providing a shortcut for when a single value is
+ * added to the input values.
  *
  * Some aggregation functions do not need to recalculate the aggregation of the
  * whole set when one value changes. For example, when adding a new number to a
@@ -65,10 +65,10 @@ export type Aggregate = (numbers: number[], length: number) => Metric;
  * being added, return `undefined` and the Metric will be completely
  * recalculated.
  *
- * Where possible, if you are providing a custom Aggregate, seek an
- * implementation of an AggregateAdd function that can reduce the complexity
- * cost of growing the input data set. See the setMetricDefinition method for
- * more examples.
+ * Where possible, if you are providing a custom MetricAggregate, seek an
+ * implementation of an MetricAggregateAdd function that can reduce the
+ * complexity cost of growing the input data set. See the setMetricDefinition
+ * method for more examples.
  *
  * @param metric The current value of the Metric.
  * @param add The number being added to the Metric's aggregation.
@@ -76,16 +76,16 @@ export type Aggregate = (numbers: number[], length: number) => Metric;
  * @returns The new value of the Metric.
  * @category Aggregators
  */
-export type AggregateAdd = (
+export type MetricAggregateAdd = (
   metric: Metric,
   add: number,
   length: number,
 ) => Metric | undefined;
 
 /**
- * The AggregateRemove type describes a function that can be used to optimize a
- * custom Aggregate by providing a shortcut for when a single value is removed
- * from the input values.
+ * The MetricAggregateRemove type describes a function that can be used to
+ * optimize a custom MetricAggregate by providing a shortcut for when a single
+ * value is removed from the input values.
  *
  * Some aggregation functions do not need to recalculate the aggregation of the
  * whole set when one value changes. For example, when removing a number from a
@@ -98,10 +98,10 @@ export type AggregateAdd = (
  * values, and the previous minimum is being removed. The whole of the rest of
  * the list will need to be re-scanned to find a new minimum.
  *
- * Where possible, if you are providing a custom Aggregate, seek an
- * implementation of an AggregateRemove function that can reduce the complexity
- * cost of shrinking the input data set. See the setMetricDefinition method for
- * more examples.
+ * Where possible, if you are providing a custom MetricAggregate, seek an
+ * implementation of an MetricAggregateRemove function that can reduce the
+ * complexity cost of shrinking the input data set. See the setMetricDefinition
+ * method for more examples.
  *
  * @param metric The current value of the Metric.
  * @param remove The number being removed from the Metric's aggregation.
@@ -109,16 +109,16 @@ export type AggregateAdd = (
  * @returns The new value of the Metric.
  * @category Aggregators
  */
-export type AggregateRemove = (
+export type MetricAggregateRemove = (
   metric: Metric,
   remove: number,
   length: number,
 ) => Metric | undefined;
 
 /**
- * The AggregateReplace type describes a function that can be used to optimize a
- * custom Aggregate by providing a shortcut for when a single value in the input
- * values is replaced with another.
+ * The MetricAggregateReplace type describes a function that can be used to
+ * optimize a custom MetricAggregate by providing a shortcut for when a single
+ * value in the input values is replaced with another.
  *
  * Some aggregation functions do not need to recalculate the aggregation of the
  * whole set when one value changes. For example, when replacing a number in a
@@ -126,13 +126,12 @@ export type AggregateRemove = (
  * minus the old value.
  *
  * If it is not possible to shortcut the aggregation based on just one value
- * changing, return `undefined` and the Metric will be completely
- * recalculated.
+ * changing, return `undefined` and the Metric will be completely recalculated.
  *
- * Where possible, if you are providing a custom Aggregate, seek an
- * implementation of an AggregateReplace function that can reduce the complexity
- * cost of changing the input data set in place. See the setMetricDefinition
- * method for more examples.
+ * Where possible, if you are providing a custom MetricAggregate, seek an
+ * implementation of an MetricAggregateReplace function that can reduce the
+ * complexity cost of changing the input data set in place. See the
+ * setMetricDefinition method for more examples.
  *
  * @param metric The current value of the Metric.
  * @param add The number being added to the Metric's aggregation.
@@ -141,7 +140,7 @@ export type AggregateRemove = (
  * @returns The new value of the Metric.
  * @category Aggregators
  */
-export type AggregateReplace = (
+export type MetricAggregateReplace = (
   metric: Metric,
   add: number,
   remove: number,
@@ -246,7 +245,8 @@ export type MetricsListenerStats = {
  * @see Todo App demos
  * @category Metrics
  */
-export interface Metrics<Schemas extends OptionalSchemas = NoSchemas> {
+export interface Metrics {
+  //
   /**
    * The setMetricDefinition method lets you set the definition of a Metric.
    *
@@ -287,14 +287,14 @@ export interface Metrics<Schemas extends OptionalSchemas = NoSchemas> {
    * that if the `aggregate` and `getNumber` parameters are both omitted, the
    * Metric will simply be a count of the Row objects in the Table).
    * @param aggregateAdd A function that can be used to optimize a custom
-   * Aggregate by providing a shortcut for when a single value is added to the
-   * input values - for example, when a Row is added to the Table.
+   * MetricAggregate by providing a shortcut for when a single value is added to
+   * the input values - for example, when a Row is added to the Table.
    * @param aggregateRemove A function that can be used to optimize a custom
-   * Aggregate by providing a shortcut for when a single value is removed from
-   * the input values - for example ,when a Row is removed from the Table.
+   * MetricAggregate by providing a shortcut for when a single value is removed
+   * from the input values - for example ,when a Row is removed from the Table.
    * @param aggregateReplace A function that can be used to optimize a custom
-   * Aggregate by providing a shortcut for when a single value in the input
-   * values is replaced with another - for example, when a Row is updated.
+   * MetricAggregate by providing a shortcut for when a single value in the
+   * input values is replaced with another - for example, when a Row is updated.
    * @returns A reference to the Metrics object.
    * @example
    * This example creates a Store, creates a Metrics object, and defines a
@@ -415,12 +415,12 @@ export interface Metrics<Schemas extends OptionalSchemas = NoSchemas> {
   setMetricDefinition(
     metricId: Id,
     tableId: Id,
-    aggregate?: 'sum' | 'avg' | 'min' | 'max' | Aggregate,
+    aggregate?: 'sum' | 'avg' | 'min' | 'max' | MetricAggregate,
     getNumber?: Id | ((getCell: GetCell, rowId: Id) => number),
-    aggregateAdd?: AggregateAdd,
-    aggregateRemove?: AggregateRemove,
-    aggregateReplace?: AggregateReplace,
-  ): Metrics<Schemas>;
+    aggregateAdd?: MetricAggregateAdd,
+    aggregateRemove?: MetricAggregateRemove,
+    aggregateReplace?: MetricAggregateReplace,
+  ): Metrics;
 
   /**
    * The delMetricDefinition method removes an existing Metric definition.
@@ -449,7 +449,7 @@ export interface Metrics<Schemas extends OptionalSchemas = NoSchemas> {
    * ```
    * @category Configuration
    */
-  delMetricDefinition(metricId: Id): Metrics<Schemas>;
+  delMetricDefinition(metricId: Id): Metrics;
 
   /**
    * The getStore method returns a reference to the underlying Store that is
@@ -469,7 +469,7 @@ export interface Metrics<Schemas extends OptionalSchemas = NoSchemas> {
    * ```
    * @category Getter
    */
-  getStore(): Store<Schemas>;
+  getStore(): Store;
 
   /**
    * The getMetricIds method returns an array of the Metric Ids registered with
@@ -729,7 +729,7 @@ export interface Metrics<Schemas extends OptionalSchemas = NoSchemas> {
    * ```
    * @category Listener
    */
-  delListener(listenerId: Id): Metrics<Schemas>;
+  delListener(listenerId: Id): Metrics;
 
   /**
    * The destroy method should be called when this Metrics object is no longer
@@ -790,6 +790,7 @@ export interface Metrics<Schemas extends OptionalSchemas = NoSchemas> {
    * @category Development
    */
   getListenerStats(): MetricsListenerStats;
+  //
 }
 
 /**
@@ -824,6 +825,4 @@ export interface Metrics<Schemas extends OptionalSchemas = NoSchemas> {
  * ```
  * @category Creation
  */
-export function createMetrics<Schemas extends OptionalSchemas>(
-  store: Store<Schemas>,
-): Metrics<Schemas>;
+export function createMetrics(store: Store): Metrics;

package/lib/{debug → types}/persisters.d.ts

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