tinybase 3.1.0-beta.5 → 3.1.0

package/lib/types/checkpoints.d.ts

@@ -178,6 +178,7 @@ export type CheckpointsListenerStats = {
  * @category Checkpoints
  */
 export interface Checkpoints {
+  //
   /**
    * The setSize method lets you specify how many checkpoints the Checkpoints
    * object will store.
@@ -922,6 +923,7 @@ export interface Checkpoints {
    * @category Development
    */
   getListenerStats(): CheckpointsListenerStats;
+  //
 }
 
 /**

package/lib/types/indexes.d.ts

@@ -196,6 +196,7 @@ export type IndexesListenerStats = {
  * @category Indexes
  */
 export interface Indexes {
+  //
   /**
    * The setIndexDefinition method lets you set the definition of an Index.
    *
@@ -929,6 +930,7 @@ export interface Indexes {
    * @category Development
    */
   getListenerStats(): IndexesListenerStats;
+  //
 }
 
 /**

package/lib/types/metrics.d.ts

@@ -246,6 +246,7 @@ export type MetricsListenerStats = {
  * @category Metrics
  */
 export interface Metrics {
+  //
   /**
    * The setMetricDefinition method lets you set the definition of a Metric.
    *
@@ -789,6 +790,7 @@ export interface Metrics {
    * @category Development
    */
   getListenerStats(): MetricsListenerStats;
+  //
 }
 
 /**

package/lib/types/persisters.d.ts

@@ -146,6 +146,7 @@ export type PersisterStats = {
  * @category Persister
  */
 export interface Persister {
+  //
   /**
    * The load method gets persisted data from storage, and loads it into the
    * Store with which the Persister is associated, once.
@@ -516,6 +517,7 @@ export interface Persister {
    * @category Development
    */
   getStats(): PersisterStats;
+  //
 }
 
 /**

package/lib/types/queries.d.ts

@@ -1592,6 +1592,7 @@ export type Having = {
  * @since v2.0.0
  */
 export interface Queries {
+  //
   /**
    * The setQueryDefinition method lets you set the definition of a query.
    *
@@ -3153,6 +3154,7 @@ export interface Queries {
    * @since v2.0.0
    */
   getListenerStats(): QueriesListenerStats;
+  //
 }
 
 /**

package/lib/types/relationships.d.ts

@@ -248,6 +248,7 @@ export type RelationshipsListenerStats = {
  * @category Relationships
  */
 export interface Relationships {
+  //
   /**
    * The setRelationshipDefinition method lets you set the definition of a
    * Relationship.
@@ -1164,6 +1165,7 @@ export interface Relationships {
    * @category Development
    */
   getListenerStats(): RelationshipsListenerStats;
+  //
 }
 
 /**

package/lib/types/store.d.ts

@@ -118,6 +118,54 @@ export type ValueSchema =
   | {type: 'number'; default?: number}
   | {type: 'boolean'; default?: boolean};
 
+/**
+ * The NoTablesSchema type is a TablesSchema-like type for when one has not been
+ * provided.
+ *
+ * @category Schema
+ */
+export type NoTablesSchema = {[tableId: Id]: {[cellId: Id]: {type: 'any'}}};
+
+/**
+ * The NoValuesSchema type is a ValuesSchema-like type for when one has not been
+ * provided.
+ *
+ * @category Schema
+ */
+export type NoValuesSchema = {[valueId: Id]: {type: 'any'}};
+
+/**
+ * The OptionalTablesSchema type is used by generic types that can optionally
+ * take a TablesSchema.
+ *
+ * @category Schema
+ */
+export type OptionalTablesSchema = TablesSchema | NoTablesSchema;
+
+/**
+ * The OptionalValuesSchema type is used by generic types that can optionally
+ * take a ValuesSchema.
+ *
+ * @category Schema
+ */
+export type OptionalValuesSchema = ValuesSchema | NoValuesSchema;
+
+/**
+ * The OptionalSchemas type is used by generic types that can optionally take
+ * either or both of a TablesSchema and ValuesSchema.
+ *
+ * @category Schema
+ */
+export type OptionalSchemas = [OptionalTablesSchema, OptionalValuesSchema];
+
+/**
+ * The NoSchemas type is used as a default by generic types that can optionally
+ * take either or both of a TablesSchema and ValuesSchema.
+ *
+ * @category Schema
+ */
+export type NoSchemas = [NoTablesSchema, NoValuesSchema];
+
 /**
  * The Tables type is the data structure representing all of the data in a
  * Store.
@@ -1171,6 +1219,7 @@ export type StoreListenerStats = {
  * @category Store
  */
 export interface Store {
+  //
   /**
    * The getTables method returns a Tables object containing the entire data of
    * the Store.
@@ -5188,6 +5237,7 @@ export interface Store {
    * @category Development
    */
   getListenerStats(): StoreListenerStats;
+  //
 }
 
 /**

package/lib/types/tools.d.ts

@@ -113,6 +113,7 @@ export type StoreStatsRowDetail = {
  * @since v2.2.0
  */
 export interface Tools {
+  //
   /* eslint-disable max-len */
   /**
    * The getStoreStats method provides a set of statistics about the Store, and
@@ -171,6 +172,7 @@ export interface Tools {
    * @since v2.2.0
    */
   getStoreStats(detail?: boolean): StoreStats;
+
   /* eslint-enable max-len */
 
   /**
@@ -481,6 +483,7 @@ export interface Tools {
    * @since v3.0.0
    */
   getStore(): Store;
+  //
 }
 
 /* eslint-disable max-len */
@@ -528,4 +531,6 @@ export interface Tools {
  * @since v2.2.0
  */
 export function createTools(store: Store): Tools;
+//
+
 /* eslint-enable max-len */

package/lib/types/with-schemas/checkpoints.d.ts

@@ -51,6 +51,12 @@ export type CheckpointCallback = (checkpointId: Id, label?: string) => void;
  * The CheckpointIdsListener type describes a function that is used to listen to
  * changes to the checkpoint Ids in a Checkpoints object.
  *
+ * This has schema-based typing. The following is a simplified representation:
+ *
+ * ```ts override
+ * (checkpoints: Checkpoints) => void;
+ * ```
+ *
  * A CheckpointIdsListener is provided when using the addCheckpointIdsListener
  * method. See that method for specific examples.
  *
@@ -68,6 +74,15 @@ export type CheckpointIdsListener<Schemas extends OptionalSchemas> = (
  * The CheckpointListener type describes a function that is used to listen to
  * changes to a checkpoint's label in a Checkpoints object.
  *
+ * This has schema-based typing. The following is a simplified representation:
+ *
+ * ```ts override
+ * (
+ *   checkpoints: Checkpoints,
+ *   checkpointId: Id,
+ * ) => void;
+ * ```
+ *
  * A CheckpointListener is provided when using the addCheckpointListener method.
  * See that method for specific examples.
  *
@@ -184,6 +199,12 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
    * The setSize method lets you specify how many checkpoints the Checkpoints
    * object will store.
    *
+   * This has schema-based typing. The following is a simplified representation:
+   *
+   * ```ts override
+   * setSize(size: number): Checkpoints;
+   * ```
+   *
    * If you set more checkpoints than this size, the oldest checkpoints will be
    * pruned to make room for more recent ones.
    *
@@ -273,6 +294,12 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
    * The setCheckpoint method updates the label for a checkpoint in the
    * Checkpoints object after it has been created
    *
+   * This has schema-based typing. The following is a simplified representation:
+   *
+   * ```ts override
+   * setCheckpoint(checkpointId: Id, label: string): Checkpoints;
+   * ```
+   *
    * The `label` parameter can be used to describe the actions that changed the
    * Store before the given checkpoint. This can be useful for interfaces that
    * let users 'Undo [last action]'.
@@ -328,6 +355,12 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
    * The getStore method returns a reference to the underlying Store that is
    * backing this Checkpoints object.
    *
+   * This has schema-based typing. The following is a simplified representation:
+   *
+   * ```ts override
+   * getStore(): Store;
+   * ```
+   *
    * @returns A reference to the Store.
    * @example
    * This example creates a Checkpoints object against a newly-created Store
@@ -493,6 +526,12 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
    * Checkpoints object that will be called whenever its set of checkpoints
    * changes.
    *
+   * This has schema-based typing. The following is a simplified representation:
+   *
+   * ```ts override
+   * addCheckpointIdsListener(listener: CheckpointIdsListener): Id;
+   * ```
+   *
    * The provided listener is a CheckpointIdsListener function, and will be
    * called with a reference to the Checkpoints object.
    *
@@ -543,6 +582,15 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
    * Checkpoints object that will be called whenever the label of a checkpoint
    * changes.
    *
+   * This has schema-based typing. The following is a simplified representation:
+   *
+   * ```ts override
+   * addCheckpointListener(
+   *   checkpointId: IdOrNull,
+   *   listener: CheckpointListener,
+   * ): Id;
+   * ```
+   *
    * You can either listen to a single checkpoint label (by specifying the
    * checkpoint Id as the method's first parameter), or changes to any
    * checkpoint label (by providing a `null` wildcard).
@@ -605,6 +653,12 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
    * The delListener method removes a listener that was previously added to the
    * Checkpoints object.
    *
+   * This has schema-based typing. The following is a simplified representation:
+   *
+   * ```ts override
+   * delListener(listenerId: Id): Checkpoints;
+   * ```
+   *
    * Use the Id returned by the addCheckpointIdsListener method. Note that the
    * Checkpoints object may re-use this Id for future listeners added to it.
    *
@@ -645,6 +699,12 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
    * The goBackward method moves the state of the underlying Store back to the
    * previous checkpoint, effectively performing an 'undo' on the Store data.
    *
+   * This has schema-based typing. The following is a simplified representation:
+   *
+   * ```ts override
+   * goBackward(): Checkpoints;
+   * ```
+   *
    * If there is no previous checkpoint to return to, this method has no effect.
    *
    * @returns A reference to the Checkpoints object.
@@ -678,6 +738,12 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
    * The goForward method moves the state of the underlying Store forwards to a
    * future checkpoint, effectively performing an 'redo' on the Store data.
    *
+   * This has schema-based typing. The following is a simplified representation:
+   *
+   * ```ts override
+   * goForward(): Checkpoints;
+   * ```
+   *
    * If there is no future checkpoint to return to, this method has no effect.
    *
    * Note that if you have previously used the goBackward method to undo
@@ -758,6 +824,12 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
    * The goTo method moves the state of the underlying Store backwards or
    * forwards to a specified checkpoint.
    *
+   * This has schema-based typing. The following is a simplified representation:
+   *
+   * ```ts override
+   * goTo(checkpointId: Id): Checkpoints;
+   * ```
+   *
    * If there is no checkpoint with the Id specified, this method has no effect.
    *
    * @param checkpointId The Id of the checkpoint to move to.
@@ -808,6 +880,12 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
    * The clear method resets this Checkpoints object to its initial state,
    * removing all the checkpoints it has been managing.
    *
+   * This has schema-based typing. The following is a simplified representation:
+   *
+   * ```ts override
+   * clear(): Checkpoints;
+   * ```
+   *
    * Obviously this method should be used with caution as it destroys the
    * ability to undo recent changes to the Store (though of course the Store
    * itself is not reset by this method).
@@ -930,6 +1008,12 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
  * The createCheckpoints function creates a Checkpoints object, and is the main
  * entry point into the checkpoints module.
  *
+ * This has schema-based typing. The following is a simplified representation:
+ *
+ * ```ts override
+ * createCheckpoints(store: Store): Checkpoints;
+ * ```
+ *
  * 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/types/with-schemas/indexes.d.ts

@@ -54,6 +54,15 @@ export type Slice = Ids;
  * The IndexCallback type describes a function that takes an Index's Id and a
  * callback to loop over each Slice within it.
  *
+ * This has schema-based typing. The following is a simplified representation:
+ *
+ * ```ts override
+ * (
+ *   indexId: Id,
+ *   forEachSlice: (sliceCallback: SliceCallback) => void,
+ * ) => void;
+ * ```
+ *
  * A IndexCallback is provided when using the forEachIndex method, so that you
  * can do something based on every Index in the Indexes object. See that method
  * for specific examples.
@@ -72,6 +81,15 @@ export type IndexCallback<Schema extends OptionalTablesSchema> = (
  * The SliceCallback type describes a function that takes a Slice's Id and a
  * callback to loop over each Row within it.
  *
+ * This has schema-based typing. The following is a simplified representation:
+ *
+ * ```ts override
+ * (
+ *   sliceId: Id,
+ *   forEachRow: (rowCallback: RowCallback) => void,
+ * ) => void;
+ * ```
+ *
  * A SliceCallback is provided when using the forEachSlice method, so that you
  * can do something based on every Slice in an Index. See that method for
  * specific examples.
@@ -90,6 +108,12 @@ export type SliceCallback<Schema extends OptionalTablesSchema> = (
  * The SliceIdsListener type describes a function that is used to listen to
  * changes to the Slice Ids in an Index.
  *
+ * This has schema-based typing. The following is a simplified representation:
+ *
+ * ```ts override
+ * (indexes: Indexes, indexId: Id) => void;
+ * ```
+ *
  * A SliceIdsListener is provided when using the addSliceIdsListener method. See
  * that method for specific examples.
  *
@@ -109,6 +133,16 @@ export type SliceIdsListener<Schemas extends OptionalSchemas> = (
  * The SliceRowIdsListener type describes a function that is used to listen to
  * changes to the Row Ids in a Slice.
  *
+ * This has schema-based typing. The following is a simplified representation:
+ *
+ * ```ts override
+ * (
+ *   indexes: Indexes,
+ *   indexId: Id,
+ *   sliceId: Id,
+ * ) => void;
+ * ```
+ *
  * A SliceRowIdsListener is provided when using the addSliceRowIdsListener
  * method. See that method for specific examples.
  *
@@ -209,6 +243,19 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
   /**
    * The setIndexDefinition method lets you set the definition of an Index.
    *
+   * This has schema-based typing. The following is a simplified representation:
+   *
+   * ```ts override
+   * setIndexDefinition(
+   *   indexId: Id,
+   *   tableId: Id,
+   *   getSliceIdOrIds?: Id | ((getCell: GetCell, rowId: Id) => Id | Ids),
+   *   getSortKey?: Id | ((getCell: GetCell, rowId: Id) => SortKey),
+   *   sliceIdSorter?: (sliceId1: Id, sliceId2: Id) => number,
+   *   rowIdSorter?: (sortKey1: SortKey, sortKey2: SortKey, sliceId: Id) => number,
+   * ): Indexes;
+   * ```
+   *
    * Every Index definition is identified by a unique Id, and if you re-use an
    * existing Id with this method, the previous definition is overwritten.
    *
@@ -374,6 +421,12 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
   /**
    * The delIndexDefinition method removes an existing Index definition.
    *
+   * This has schema-based typing. The following is a simplified representation:
+   *
+   * ```ts override
+   * delIndexDefinition(indexId: Id): Indexes;
+   * ```
+   *
    * @param indexId The Id of the Index to remove.
    * @returns A reference to the Indexes object.
    * @example
@@ -404,6 +457,12 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
    * The getStore method returns a reference to the underlying Store that is
    * backing this Indexes object.
    *
+   * This has schema-based typing. The following is a simplified representation:
+   *
+   * ```ts override
+   * getStore(): Store;
+   * ```
+   *
    * @returns A reference to the Store.
    * @example
    * This example creates an Indexes object against a newly-created Store and
@@ -445,6 +504,12 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
    * The forEachIndex method takes a function that it will then call for each
    * Index in a specified Indexes object.
    *
+   * This has schema-based typing. The following is a simplified representation:
+   *
+   * ```ts override
+   * forEachIndex(indexCallback: IndexCallback): void;
+   * ```
+   *
    * This method is useful for iterating over the structure of the Indexes
    * object in a functional style. The `indexCallback` parameter is a
    * IndexCallback function that will be called with the Id of each Index, and
@@ -485,6 +550,12 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
    * The forEachSlice method takes a function that it will then call for each
    * Slice in a specified Index.
    *
+   * This has schema-based typing. The following is a simplified representation:
+   *
+   * ```ts override
+   * forEachSlice(indexId: Id, sliceCallback: SliceCallback): void;
+   * ```
+   *
    * This method is useful for iterating over the Slice structure of the Index
    * in a functional style. The `rowCallback` parameter is a RowCallback
    * function that will be called with the Id and value of each Row in the
@@ -570,6 +641,12 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
    * The getTableId method returns the Id of the underlying Table that is
    * backing an Index.
    *
+   * This has schema-based typing. The following is a simplified representation:
+   *
+   * ```ts override
+   * getTableId(indexId: Id): Id | undefined;
+   * ```
+   *
    * If the Index Id is invalid, the method returns `undefined`.
    *
    * @param indexId The Id of an Index.
@@ -666,6 +743,12 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
    * Indexes object that will be called whenever the Slice Ids in an Index
    * change.
    *
+   * This has schema-based typing. The following is a simplified representation:
+   *
+   * ```ts override
+   * addSliceIdsListener(indexId: IdOrNull, listener: SliceIdsListener): Id;
+   * ```
+   *
    * You can either listen to a single Index (by specifying the Index Id as the
    * method's first parameter), or changes to any Index (by providing a `null`
    * wildcard).
@@ -748,6 +831,16 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
    * The addSliceRowIdsListener method registers a listener function with the
    * Indexes object that will be called whenever the Row Ids in a Slice change.
    *
+   * This has schema-based typing. The following is a simplified representation:
+   *
+   * ```ts override
+   * addSliceRowIdsListener(
+   *   indexId: IdOrNull,
+   *   sliceId: IdOrNull,
+   *   listener: SliceRowIdsListener,
+   * ): Id;
+   * ```
+   *
    * You can either listen to a single Slice (by specifying the Index Id and
    * Slice Id as the method's first two parameters), or changes to any Slice (by
    * providing `null` wildcards).
@@ -841,6 +934,12 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
    * The delListener method removes a listener that was previously added to the
    * Indexes object.
    *
+   * This has schema-based typing. The following is a simplified representation:
+   *
+   * ```ts override
+   * delListener(listenerId: Id): Indexes;
+   * ```
+   *
    * Use the Id returned by whichever method was used to add the listener. Note
    * that the Indexes object may re-use this Id for future listeners added to
    * it.
@@ -954,6 +1053,12 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
  * The createIndexes function creates an Indexes object, and is the main entry
  * point into the indexes module.
  *
+ * This has schema-based typing. The following is a simplified representation:
+ *
+ * ```ts override
+ * createIndexes(store: Store): Indexes;
+ * ```
+ *
  * 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/types/with-schemas/metrics.d.ts

@@ -152,6 +152,17 @@ export type MetricAggregateReplace = (
  * The MetricListener type describes a function that is used to listen to
  * changes to a Metric.
  *
+ * This has schema-based typing. The following is a simplified representation:
+ *
+ * ```ts override
+ * (
+ *   metrics: Metrics,
+ *   metricId: Id,
+ *   newMetric: Metric | undefined,
+ *   oldMetric: Metric | undefined,
+ * ) => void;
+ * ```
+ *
  * A MetricListener is provided when using the addMetricListener method. See
  * that method for specific examples.
  *
@@ -250,6 +261,20 @@ export interface Metrics<in out Schemas extends OptionalSchemas> {
   /**
    * The setMetricDefinition method lets you set the definition of a Metric.
    *
+   * This has schema-based typing. The following is a simplified representation:
+   *
+   * ```ts override
+   * setMetricDefinition(
+   *   metricId: Id,
+   *   tableId: Id,
+   *   aggregate?: 'sum' | 'avg' | 'min' | 'max' | MetricAggregate,
+   *   getNumber?: Id | ((getCell: GetCell, rowId: Id) => number),
+   *   aggregateAdd?: MetricAggregateAdd,
+   *   aggregateRemove?: MetricAggregateRemove,
+   *   aggregateReplace?: MetricAggregateReplace,
+   * ): Metrics;
+   * ```
+   *
    * Every Metric definition is identified by a unique Id, and if you re-use an
    * existing Id with this method, the previous definition is overwritten.
    *
@@ -427,6 +452,12 @@ export interface Metrics<in out Schemas extends OptionalSchemas> {
   /**
    * The delMetricDefinition method removes an existing Metric definition.
    *
+   * This has schema-based typing. The following is a simplified representation:
+   *
+   * ```ts override
+   * delMetricDefinition(metricId: Id): Metrics;
+   * ```
+   *
    * @param metricId The Id of the Metric to remove.
    * @returns A reference to the Metrics object.
    * @example
@@ -457,6 +488,12 @@ export interface Metrics<in out Schemas extends OptionalSchemas> {
    * The getStore method returns a reference to the underlying Store that is
    * backing this Metrics object.
    *
+   * This has schema-based typing. The following is a simplified representation:
+   *
+   * ```ts override
+   * getStore(): Store;
+   * ```
+   *
    * @returns A reference to the Store.
    * @example
    * This example creates a Metrics object against a newly-created Store and
@@ -556,6 +593,12 @@ export interface Metrics<in out Schemas extends OptionalSchemas> {
    * The getTableId method returns the Id of the underlying Table that is
    * backing a Metric.
    *
+   * This has schema-based typing. The following is a simplified representation:
+   *
+   * ```ts override
+   * getTableId(metricId: Id): Id | undefined;
+   * ```
+   *
    * If the Metric Id is invalid, the method returns `undefined`.
    *
    * @param metricId The Id of a Metric.
@@ -617,6 +660,12 @@ export interface Metrics<in out Schemas extends OptionalSchemas> {
    * object that will be called whenever the value of a specified Metric
    * changes.
    *
+   * This has schema-based typing. The following is a simplified representation:
+   *
+   * ```ts override
+   * addMetricListener(metricId: IdOrNull, listener: MetricListener): Id;
+   * ```
+   *
    * You can either listen to a single Metric (by specifying the Metric Id as
    * the method's first parameter), or changes to any Metric (by providing a
    * `null` wildcard).
@@ -696,6 +745,12 @@ export interface Metrics<in out Schemas extends OptionalSchemas> {
    * The delListener method removes a listener that was previously added to the
    * Metrics object.
    *
+   * This has schema-based typing. The following is a simplified representation:
+   *
+   * ```ts override
+   * delListener(listenerId: Id): Metrics;
+   * ```
+   *
    * Use the Id returned by the addMetricListener method. Note that the Metrics
    * object may re-use this Id for future listeners added to it.
    *
@@ -800,6 +855,12 @@ export interface Metrics<in out Schemas extends OptionalSchemas> {
  * The createMetrics function creates a Metrics object, and is the main entry
  * point into the metrics module.
  *
+ * This has schema-based typing. The following is a simplified representation:
+ *
+ * ```ts override
+ * createMetrics(store: Store): Metrics;
+ * ```
+ *
  * 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.