tinybase 3.1.0-beta.4 → 3.1.0-beta.5

package/lib/{cjs → types/with-schemas}/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,8 @@
  * @module metrics
  */
 
-import {GetCell, NoSchemas, OptionalSchemas, Store} from './store.d';
+import {CellIdFromSchema, TableIdFromSchema} from './internal/store';
+import {GetCell, OptionalSchemas, Store} from './store.d';
 import {Id, IdOrNull, Ids} from './common.d';
 
 /**
@@ -37,8 +38,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 +51,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 +66,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 +77,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 +99,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 +110,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 +127,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 +141,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,
@@ -168,8 +168,8 @@ export type AggregateReplace = (
  * @param oldMetric The old value of the Metric that changed.
  * @category Listener
  */
-export type MetricListener = (
-  metrics: Metrics,
+export type MetricListener<Schemas extends OptionalSchemas> = (
+  metrics: Metrics<Schemas>,
   metricId: Id,
   newMetric: Metric | undefined,
   oldMetric: Metric | undefined,
@@ -246,7 +246,7 @@ export type MetricsListenerStats = {
  * @see Todo App demos
  * @category Metrics
  */
-export interface Metrics<Schemas extends OptionalSchemas = NoSchemas> {
+export interface Metrics<in out Schemas extends OptionalSchemas> {
   /**
    * 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
@@ -412,14 +412,16 @@ export interface Metrics<Schemas extends OptionalSchemas = NoSchemas> {
    * ```
    * @category Configuration
    */
-  setMetricDefinition(
+  setMetricDefinition<TableId extends TableIdFromSchema<Schemas[0]>>(
     metricId: Id,
-    tableId: Id,
-    aggregate?: 'sum' | 'avg' | 'min' | 'max' | Aggregate,
-    getNumber?: Id | ((getCell: GetCell, rowId: Id) => number),
-    aggregateAdd?: AggregateAdd,
-    aggregateRemove?: AggregateRemove,
-    aggregateReplace?: AggregateReplace,
+    tableId: TableId,
+    aggregate?: 'sum' | 'avg' | 'min' | 'max' | MetricAggregate,
+    getNumber?:
+      | CellIdFromSchema<Schemas[0], TableId>
+      | ((getCell: GetCell<Schemas[0], TableId>, rowId: Id) => number),
+    aggregateAdd?: MetricAggregateAdd,
+    aggregateRemove?: MetricAggregateRemove,
+    aggregateReplace?: MetricAggregateReplace,
   ): Metrics<Schemas>;
 
   /**
@@ -573,7 +575,9 @@ export interface Metrics<Schemas extends OptionalSchemas = NoSchemas> {
    * ```
    * @category Getter
    */
-  getTableId(metricId: Id): Id | undefined;
+  getTableId<TableId extends TableIdFromSchema<Schemas[0]>>(
+    metricId: Id,
+  ): TableId | undefined;
 
   /**
    * The getMetric method gets the current value of a Metric.
@@ -686,7 +690,7 @@ export interface Metrics<Schemas extends OptionalSchemas = NoSchemas> {
    * ```
    * @category Listener
    */
-  addMetricListener(metricId: IdOrNull, listener: MetricListener): Id;
+  addMetricListener(metricId: IdOrNull, listener: MetricListener<Schemas>): Id;
 
   /**
    * The delListener method removes a listener that was previously added to the

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

@@ -27,7 +27,7 @@
  * @module persisters
  */
 
-import {NoSchemas, OptionalSchemas, Store, Tables, Values} from './store.d';
+import {OptionalSchemas, Store, Tables, Values} from './store.d';
 import {Callback} from './common.d';
 
 /**
@@ -145,7 +145,7 @@ export type PersisterStats = {
  * ```
  * @category Persister
  */
-export interface Persister<Schemas extends OptionalSchemas = NoSchemas> {
+export interface Persister<in out Schemas extends OptionalSchemas> {
   /**
    * The load method gets persisted data from storage, and loads it into the
    * Store with which the Persister is associated, once.
@@ -208,7 +208,7 @@ export interface Persister<Schemas extends OptionalSchemas = NoSchemas> {
    */
   load(
     initialTables?: Tables<Schemas[0], true>,
-    initialValues?: Values,
+    initialValues?: Values<Schemas[1], true>,
   ): Promise<Persister<Schemas>>;
 
   /**
@@ -267,7 +267,7 @@ export interface Persister<Schemas extends OptionalSchemas = NoSchemas> {
    */
   startAutoLoad(
     initialTables?: Tables<Schemas[0], true>,
-    initialValues?: Values,
+    initialValues?: Values<Schemas[1], true>,
   ): Promise<Persister<Schemas>>;
 
   /**