tinybase 0.9.2 → 0.9.3

package/lib/debug/ui-react.js

@@ -1,4 +1,4 @@
-import React from 'react';
+import React, {useContext as useContext$1} from 'react';
 
 const getTypeOf = (thing) => typeof thing;
 const EMPTY_STRING = '';
@@ -735,22 +735,23 @@ const Provider = ({
   checkpoints,
   checkpointsById,
   children,
-}) =>
-  /* @__PURE__ */ createElement(
+}) => {
+  const thingsOrThingsId = useContext$1(Context);
+  return /* @__PURE__ */ createElement(
     Context.Provider,
     {
       value: useMemo(
         () => [
-          store,
-          storesById,
-          metrics,
-          metricsById,
-          indexes,
-          indexesById,
-          relationships,
-          relationshipsById,
-          checkpoints,
-          checkpointsById,
+          store ?? thingsOrThingsId[0],
+          {...thingsOrThingsId[1], ...storesById},
+          metrics ?? thingsOrThingsId[2],
+          {...thingsOrThingsId[3], ...metricsById},
+          indexes ?? thingsOrThingsId[4],
+          {...thingsOrThingsId[5], ...indexesById},
+          relationships ?? thingsOrThingsId[6],
+          {...thingsOrThingsId[7], ...relationshipsById},
+          checkpoints ?? thingsOrThingsId[8],
+          {...thingsOrThingsId[9], ...checkpointsById},
         ],
         [
           store,
@@ -763,11 +764,13 @@ const Provider = ({
           relationshipsById,
           checkpoints,
           checkpointsById,
+          thingsOrThingsId,
         ],
       ),
     },
     children,
   );
+};
 const wrap = (children, separator, encloseWithId, id) => {
   const separatedChildren =
     isUndefined(separator) || !Array.isArray(children)

package/lib/indexes.d.ts

@@ -60,6 +60,8 @@ export type SortKey = string | number | boolean;
  * When called, a SliceIdsListener is given a reference to the Indexes object,
  * and the Id of the Index that changed.
  *
+ * @param indexes A reference to the Indexes object that changed.
+ * @param indexId The Id of the Index that changed.
  * @category Listener
  */
 export type SliceIdsListener = (indexes: Indexes, indexId: Id) => void;
@@ -75,6 +77,9 @@ export type SliceIdsListener = (indexes: Indexes, indexId: Id) => void;
  * object, the Id of the Index that changed, and the Id of the Slice whose Row
  * Ids changed.
  *
+ * @param indexes A reference to the Indexes object that changed.
+ * @param indexId The Id of the Index that changed.
+ * @param sliceId The Id of the Slice that changed.
  * @category Listener
  */
 export type SliceRowIdsListener = (
@@ -93,7 +98,13 @@ export type SliceRowIdsListener = (
  * @category Development
  */
 export type IndexesListenerStats = {
+  /**
+   * The number of SlideIdsListeners registered with the Indexes object.
+   */
   sliceIds?: number;
+  /**
+   * The number of SliceRowIdsListeners registered with the Indexes object.
+   */
   sliceRowIds?: number;
 };
 
@@ -118,7 +129,7 @@ export type IndexesListenerStats = {
  * creation, to adding a definition, getting its contents, and then registering
  * and removing a listener for it.
  *
- * ```tsx
+ * ```js
  * const store = createStore().setTable('pets', {
  *   fido: {species: 'dog'},
  *   felix: {species: 'cat'},
@@ -146,6 +157,7 @@ export type IndexesListenerStats = {
  * indexes.delListener(listenerId);
  * indexes.destroy();
  * ```
+ * @category Indexes
  */
 export interface Indexes {
   /**
@@ -211,7 +223,7 @@ export interface Indexes {
    * This example creates a Store, creates an Indexes object, and defines a
    * simple Index based on the values in the `species` Cell.
    *
-   * ```tsx
+   * ```js
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog'},
    *   felix: {species: 'cat'},
@@ -230,7 +242,7 @@ export interface Indexes {
    * This example creates a Store, creates an Indexes object, and defines an
    * Index based on the first letter of the pets' names.
    *
-   * ```tsx
+   * ```js
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog'},
    *   felix: {species: 'cat'},
@@ -250,7 +262,7 @@ export interface Indexes {
    * Index based on the first letter of the pets' names. The Slice Ids (and Row
    * Ids within them) are alphabetically sorted.
    *
-   * ```tsx
+   * ```js
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog'},
    *   felix: {species: 'cat'},
@@ -292,7 +304,7 @@ export interface Indexes {
    * This example creates a Store, creates an Indexes object, defines a simple
    * Index, and then removes it.
    *
-   * ```tsx
+   * ```js
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog'},
    *   felix: {species: 'cat'},
@@ -321,7 +333,7 @@ export interface Indexes {
    * This example creates an Indexes object against a newly-created Store and
    * then gets its reference in order to update its data.
    *
-   * ```tsx
+   * ```js
    * const indexes = createIndexes(createStore());
    * indexes.setIndexDefinition('bySpecies', 'pets', 'species');
    * indexes.getStore().setCell('pets', 'fido', 'species', 'dog');
@@ -341,7 +353,7 @@ export interface Indexes {
    * This example creates an Indexes object with two definitions, and then gets
    * the Ids of the definitions.
    *
-   * ```tsx
+   * ```js
    * const indexes = createIndexes(createStore())
    *   .setIndexDefinition('bySpecies', 'pets', 'species')
    *   .setIndexDefinition('byColor', 'pets', 'color');
@@ -365,7 +377,7 @@ export interface Indexes {
    * This example creates an Indexes object, a single Index definition, and then
    * queries it (and a non-existent definition) to get the underlying Table Id.
    *
-   * ```tsx
+   * ```js
    * const indexes = createIndexes(createStore());
    * indexes.setIndexDefinition('bySpecies', 'pets', 'species');
    *
@@ -391,7 +403,7 @@ export interface Indexes {
    * simple Index. It then uses getSliceIds to see the available Slice Ids in
    * the Index (and also the Slice Ids in an Index that has not been defined).
    *
-   * ```tsx
+   * ```js
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog'},
    *   felix: {species: 'cat'},
@@ -425,7 +437,7 @@ export interface Indexes {
    * simple Index. It then uses getSliceRowIds to see the Row Ids in the Slice
    * (and also the Row Ids in Slices that do not exist).
    *
-   * ```tsx
+   * ```js
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog'},
    *   felix: {species: 'cat'},
@@ -467,7 +479,7 @@ export interface Indexes {
    * This example creates a Store, a Indexes object, and then registers a
    * listener that responds to any changes to a specific Index.
    *
-   * ```tsx
+   * ```js
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog'},
    *   felix: {species: 'cat'},
@@ -495,7 +507,7 @@ export interface Indexes {
    * This example creates a Store, a Indexes object, and then registers a
    * listener that responds to any changes to any Index.
    *
-   * ```tsx
+   * ```js
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', color: 'brown'},
    *   felix: {species: 'cat', color: 'black'},
@@ -552,7 +564,7 @@ export interface Indexes {
    * This example creates a Store, a Indexes object, and then registers a
    * listener that responds to any changes to a specific Slice.
    *
-   * ```tsx
+   * ```js
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog'},
    *   felix: {species: 'cat'},
@@ -581,7 +593,7 @@ export interface Indexes {
    * This example creates a Store, a Indexes object, and then registers a
    * listener that responds to any changes to any Slice.
    *
-   * ```tsx
+   * ```js
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', color: 'brown'},
    *   felix: {species: 'cat', color: 'black'},
@@ -633,7 +645,7 @@ export interface Indexes {
    * This example creates a Store, a Indexes object, registers a listener, and
    * then removes it.
    *
-   * ```tsx
+   * ```js
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog'},
    *   felix: {species: 'cat'},
@@ -675,7 +687,7 @@ export interface Indexes {
    * definition (that registers a RowListener with the underlying Store),
    * and then destroys it again, removing the listener.
    *
-   * ```tsx
+   * ```js
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog'},
    *   felix: {species: 'cat'},
@@ -714,7 +726,7 @@ export interface Indexes {
    * @example
    * This example gets the listener statistics of an Indexes object.
    *
-   * ```tsx
+   * ```js
    * const store = createStore();
    * const indexes = createIndexes(store);
    * indexes.addSliceIdsListener(null, () => {
@@ -747,7 +759,7 @@ export interface Indexes {
  * @example
  * This example creates an Indexes object.
  *
- * ```tsx
+ * ```js
  * const store = createStore();
  * const indexes = createIndexes(store);
  * console.log(indexes.getIndexIds());
@@ -757,13 +769,14 @@ export interface Indexes {
  * This example creates an Indexes object, and calls the method a second time
  * for the same Store to return the same object.
  *
- * ```tsx
+ * ```js
  * const store = createStore();
  * const indexes1 = createIndexes(store);
  * const indexes2 = createIndexes(store);
  * console.log(indexes1 === indexes2);
  * // -> true
  * ```
+ * @category Creation
  */
 export function createIndexes(store: Store): Indexes;
 
@@ -778,7 +791,7 @@ export function createIndexes(store: Store): Indexes;
  * @example
  * This example creates an Indexes object.
  *
- * ```tsx
+ * ```js
  * const store = createStore();
  * const indexes = createIndexes(store);
  * console.log(indexes.getIndexIds());
@@ -789,7 +802,7 @@ export function createIndexes(store: Store): Indexes;
  * Index based on the first letter of the pets' names. The Slice Ids (and Row
  * Ids within them) are alphabetically sorted using the defaultSorter function.
  *
- * ```tsx
+ * ```js
  * const store = createStore().setTable('pets', {
  *   fido: {species: 'dog'},
  *   felix: {species: 'cat'},
@@ -811,5 +824,6 @@ export function createIndexes(store: Store): Indexes;
  * console.log(indexes.getSliceRowIds('byFirst', 'f'));
  * // -> ['felix', 'fido']
  * ```
+ * @category Convenience
  */
 export function defaultSorter(sortKey1: SortKey, sortKey2: SortKey): number;

package/lib/metrics.d.ts

@@ -31,6 +31,9 @@ export type Metric = number;
  * use a more complex aggregation of your own devising. See the
  * setMetricDefinition method for more examples.
  *
+ * @param numbers The array of numbers in the Metric's aggregation.
+ * @param length The length of the array of numbers in the Metric's aggregation.
+ * @returns The value of the Metric.
  * @category Aggregators
  */
 export type Aggregate = (numbers: number[], length: number) => Metric;
@@ -53,6 +56,10 @@ export type Aggregate = (numbers: number[], length: number) => Metric;
  * 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.
+ * @param length The length of the array of numbers in the Metric's aggregation.
+ * @returns The new value of the Metric.
  * @category Aggregators
  */
 export type AggregateAdd = (
@@ -82,6 +89,10 @@ export type AggregateAdd = (
  * 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.
+ * @param length The length of the array of numbers in the Metric's aggregation.
+ * @returns The new value of the Metric.
  * @category Aggregators
  */
 export type AggregateRemove = (
@@ -109,6 +120,11 @@ export type AggregateRemove = (
  * 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.
+ * @param remove The number being removed from the Metric's aggregation.
+ * @param length The length of the array of numbers in the Metric's aggregation.
+ * @returns The new value of the Metric.
  * @category Aggregators
  */
 export type AggregateReplace = (
@@ -132,6 +148,10 @@ export type AggregateReplace = (
  * has gained its first row), the old value will be `undefined`. If a Metric now
  * no longer has a value, the new value will be `undefined`.
  *
+ * @param metrics A reference to the Metrics object that changed.
+ * @param metricId The Id of the Metric that changed.
+ * @param newMetric The new value of the Metric that changed.
+ * @param oldMetric The old value of the Metric that changed.
  * @category Listener
  */
 export type MetricListener = (
@@ -151,6 +171,9 @@ export type MetricListener = (
  * @category Development
  */
 export type MetricsListenerStats = {
+  /**
+   * The number of MetricListeners registered with the Metrics object.
+   */
   metric?: number;
 };
 
@@ -176,7 +199,7 @@ export type MetricsListenerStats = {
  * creation, to adding a definition, getting an Metric, and then registering and
  * removing a listener for it.
  *
- * ```tsx
+ * ```js
  * const store = createStore().setTable('species', {
  *   dog: {price: 5},
  *   cat: {price: 4},
@@ -203,6 +226,7 @@ export type MetricsListenerStats = {
  * metrics.delListener(listenerId);
  * metrics.destroy();
  * ```
+ * @category Metrics
  */
 export interface Metrics {
   /**
@@ -258,7 +282,7 @@ export interface Metrics {
    * This example creates a Store, creates a Metrics object, and defines a
    * simple Metric to count the Row objects in the Table.
    *
-   * ```tsx
+   * ```js
    * const store = createStore().setTable('species', {
    *   dog: {price: 5},
    *   cat: {price: 4},
@@ -276,7 +300,7 @@ export interface Metrics {
    * standard Metric to get the highest value of each `price` Cell in the Row
    * objects in the Table.
    *
-   * ```tsx
+   * ```js
    * const store = createStore().setTable('species', {
    *   dog: {price: 5},
    *   cat: {price: 4},
@@ -293,7 +317,7 @@ export interface Metrics {
    * This example creates a Store, creates a Metrics object, and defines a
    * custom Metric to get the lowest value of each `price` Cell, greater than 2.
    *
-   * ```tsx
+   * ```js
    * const store = createStore().setTable('species', {
    *   dog: {price: 5},
    *   cat: {price: 4},
@@ -317,7 +341,7 @@ export interface Metrics {
    * However, it also reduces algorithmic complexity with two shortcut
    * functions.
    *
-   * ```tsx
+   * ```js
    * const store = createStore().setTable('species', {
    *   dog: {price: 5},
    *   cat: {price: 4},
@@ -350,7 +374,7 @@ export interface Metrics {
    * This example creates a Store, creates a Metrics object, and defines a
    * custom Metric to get the average value of a discounted price.
    *
-   * ```tsx
+   * ```js
    * const store = createStore().setTable('species', {
    *   dog: {price: 5, discount: 0.3},
    *   cat: {price: 4, discount: 0.2},
@@ -389,7 +413,7 @@ export interface Metrics {
    * This example creates a Store, creates a Metrics object, defines a simple
    * Metric, and then removes it.
    *
-   * ```tsx
+   * ```js
    * const store = createStore().setTable('species', {
    *   dog: {price: 5},
    *   cat: {price: 4},
@@ -418,7 +442,7 @@ export interface Metrics {
    * This example creates a Metrics object against a newly-created Store and
    * then gets its reference in order to update its data.
    *
-   * ```tsx
+   * ```js
    * const metrics = createMetrics(createStore());
    * metrics.setMetricDefinition('speciesCount', 'species');
    * metrics.getStore().setCell('species', 'dog', 'price', 5);
@@ -438,7 +462,7 @@ export interface Metrics {
    * This example creates a Metrics object with two definitions, and then gets
    * the Ids of the definitions.
    *
-   * ```tsx
+   * ```js
    * const metrics = createMetrics(createStore())
    *   .setMetricDefinition('speciesCount', 'species')
    *   .setMetricDefinition('petsCount', 'pets');
@@ -462,7 +486,7 @@ export interface Metrics {
    * This example creates a Metrics object, a single Metric definition, and then
    * queries it (and a non-existent definition) to get the underlying Table Id.
    *
-   * ```tsx
+   * ```js
    * const metrics = createMetrics(createStore());
    * metrics.setMetricDefinition('speciesCount', 'species');
    *
@@ -489,7 +513,7 @@ export interface Metrics {
    * getMetric to access its value (and also the value of a Metric that has not
    * been defined).
    *
-   * ```tsx
+   * ```js
    * const store = createStore().setTable('species', {
    *   dog: {price: 5},
    *   cat: {price: 4},
@@ -529,7 +553,7 @@ export interface Metrics {
    * This example creates a Store, a Metrics object, and then registers a
    * listener that responds to any changes to a specific Metric.
    *
-   * ```tsx
+   * ```js
    * const store = createStore().setTable('species', {
    *   dog: {price: 5},
    *   cat: {price: 4},
@@ -557,7 +581,7 @@ export interface Metrics {
    * This example creates a Store, a Metrics object, and then registers a
    * listener that responds to any changes to any Metric.
    *
-   * ```tsx
+   * ```js
    * const store = createStore().setTable('species', {
    *   dog: {price: 5},
    *   cat: {price: 4},
@@ -601,7 +625,7 @@ export interface Metrics {
    * This example creates a Store, a Metrics object, registers a listener, and
    * then removes it.
    *
-   * ```tsx
+   * ```js
    * const store = createStore().setTable('species', {
    *   dog: {price: 5},
    *   cat: {price: 4},
@@ -643,7 +667,7 @@ export interface Metrics {
    * registers a RowListener with the underlying Store), and then destroys it
    * again, removing the listener.
    *
-   * ```tsx
+   * ```js
    * const store = createStore().setTable('species', {
    *   dog: {price: 5},
    *   cat: {price: 4},
@@ -679,7 +703,7 @@ export interface Metrics {
    * @example
    * This example gets the listener statistics of a Metrics object.
    *
-   * ```tsx
+   * ```js
    * const store = createStore();
    * const metrics = createMetrics(store);
    * metrics.addMetricListener(null, () => console.log('Metric changed'));
@@ -707,7 +731,7 @@ export interface Metrics {
  * @example
  * This example creates a Metrics object.
  *
- * ```tsx
+ * ```js
  * const store = createStore();
  * const metrics = createMetrics(store);
  * console.log(metrics.getMetricIds());
@@ -717,12 +741,13 @@ export interface Metrics {
  * This example creates a Metrics object, and calls the method a second time
  * for the same Store to return the same object.
  *
- * ```tsx
+ * ```js
  * const store = createStore();
  * const metrics1 = createMetrics(store);
  * const metrics2 = createMetrics(store);
  * console.log(metrics1 === metrics2);
  * // -> true
  * ```
+ * @category Creation
  */
 export function createMetrics(store: Store): Metrics;