tinybase 2.0.0 → 2.0.1

package/lib/common.js

@@ -1 +1 @@
-const o=(o,t)=>o<t?-1:1,t=o=>""+o;export{o as defaultSorter,t as id};
+const o=(o,t)=>o<t?-1:1;export{o as defaultSorter};

package/lib/debug/common.js

@@ -1,6 +1,3 @@
-const EMPTY_STRING = '';
-
 const defaultSorter = (sortKey1, sortKey2) => (sortKey1 < sortKey2 ? -1 : 1);
-const id = (key) => EMPTY_STRING + key;
 
-export {defaultSorter, id};
+export {defaultSorter};

package/lib/debug/metrics.d.ts

@@ -210,7 +210,7 @@ export type MetricsListenerStats = {
  *
  * @example
  * This example shows a very simple lifecycle of a Metrics object: from
- * creation, to adding a definition, getting an Metric, and then registering and
+ * creation, to adding a definition, getting a Metric, and then registering and
  * removing a listener for it.
  *
  * ```js

package/lib/debug/persisters.d.ts

@@ -509,7 +509,7 @@ export interface Persister {
 }
 
 /**
- * The createSessionPersister function creates an Persister object that can
+ * The createSessionPersister function creates a Persister object that can
  * persist the Store to the browser's session storage.
  *
  * As well as providing a reference to the Store to persist, you must provide a
@@ -542,7 +542,7 @@ export function createSessionPersister(
 ): Persister;
 
 /**
- * The createLocalPersister function creates an Persister object that can
+ * The createLocalPersister function creates a Persister object that can
  * persist the Store to the browser's local storage.
  *
  * As well as providing a reference to the Store to persist, you must provide a
@@ -575,7 +575,7 @@ export function createLocalPersister(
 ): Persister;
 
 /**
- * The createRemotePersister function creates an Persister object that can
+ * The createRemotePersister function creates a Persister object that can
  * persist the Store to a remote server.
  *
  * As well as providing a reference to the Store to persist, you must provide
@@ -624,7 +624,7 @@ export function createRemotePersister(
 ): Persister;
 
 /**
- * The createFilePersister function creates an Persister object that can persist
+ * The createFilePersister function creates a Persister object that can persist
  * the Store to a local file (in an appropriate environment).
  *
  * As well as providing a reference to the Store to persist, you must provide
@@ -654,7 +654,7 @@ export function createRemotePersister(
 export function createFilePersister(store: Store, filePath: string): Persister;
 
 /**
- * The createCustomPersister function creates an Persister object that you can
+ * The createCustomPersister function creates a Persister object that you can
  * configure to persist the Store in any way you wish.
  *
  * As well as providing a reference to the Store to persist, you must provide

package/lib/debug/relationships.d.ts

@@ -1091,7 +1091,7 @@ export interface Relationships {
    * the underlying Store are removed and it can be correctly garbage collected.
    *
    * @example
-   * This example creates a Store, adds an Relationships object with a
+   * This example creates a Store, adds a Relationships object with a
    * definition (that registers a RowListener with the underlying Store),
    * and then destroys it again, removing the listener.
    *
@@ -1167,7 +1167,7 @@ export interface Relationships {
 }
 
 /**
- * The createRelationships function creates an Relationships object, and is the
+ * The createRelationships function creates a Relationships object, and is the
  * main entry point into the relationships module.
  *
  * It is trivially simple.
@@ -1179,7 +1179,7 @@ export interface Relationships {
  * @param store The Store for which to register Relationships.
  * @returns A reference to the new Relationships object.
  * @example
- * This example creates an Relationships object.
+ * This example creates a Relationships object.
  *
  * ```js
  * const store = createStore();

package/lib/debug/store.js

@@ -16,6 +16,7 @@ const ROW_IDS = 'RowIds';
 const ROW = 'Row';
 const CELL_IDS = 'CellIds';
 const CELL = 'Cell';
+const id = (key) => EMPTY_STRING + key;
 
 const arrayHas = (array, value) => array.includes(value);
 const arrayEvery = (array, cb) => array.every(cb);
@@ -221,7 +222,6 @@ const setOrDelCell = (store, tableId, rowId, cellId, cell) =>
     : store.setCell(tableId, rowId, cellId, cell);
 
 const defaultSorter = (sortKey1, sortKey2) => (sortKey1 < sortKey2 ? -1 : 1);
-const id = (key) => EMPTY_STRING + key;
 
 const transformMap = (map, toBeLikeObject, setId, delId = mapSet) => {
   const idsToDelete = arrayFilter(

package/lib/debug/tinybase.js

@@ -26,6 +26,7 @@ const SORTED_ROW_IDS = 'SortedRowIds';
 const ROW = 'Row';
 const CELL_IDS = 'CellIds';
 const CELL = 'Cell';
+const id = (key) => EMPTY_STRING + key;
 
 const arrayHas = (array, value) => array.includes(value);
 const arrayEvery = (array, cb) => array.every(cb);
@@ -587,7 +588,6 @@ const createCheckpoints = getCreateFunction((store) => {
 });
 
 const defaultSorter = (sortKey1, sortKey2) => (sortKey1 < sortKey2 ? -1 : 1);
-const id = (key) => EMPTY_STRING + key;
 
 const createIndexes = getCreateFunction((store) => {
   const sliceIdsListeners = mapNew();
@@ -2546,5 +2546,4 @@ export {
   createSessionPersister,
   createStore,
   defaultSorter,
-  id,
 };

package/lib/debug/ui-react.d.ts

@@ -285,7 +285,7 @@ export function useCreateStore(
  * component.
  *
  * The useStore hook lets you either get a reference to the default Store (when
- * called without an parameter), or one of the Store objects that are named by
+ * called without a parameter), or one of the Store objects that are named by
  * Id (when called with an Id parameter).
  *
  * @param id An optional Id for accessing a Store that was named with an Id in
@@ -2551,7 +2551,7 @@ export function useCreateMetrics(
  * through every component.
  *
  * The useMetrics hook lets you either get a reference to the default Metrics
- * object (when called without an parameter), or one of the Metrics objects that
+ * object (when called without a parameter), or one of the Metrics objects that
  * are named by Id (when called with an Id parameter).
  *
  * @param id An optional Id for accessing a Metrics object that was named with
@@ -2903,7 +2903,7 @@ export function useCreateIndexes(
  * through every component.
  *
  * The useIndexes hook lets you either get a reference to the default Indexes
- * object (when called without an parameter), or one of the Indexes objects that
+ * object (when called without a parameter), or one of the Indexes objects that
  * are named by Id (when called with an Id parameter).
  *
  * @param id An optional Id for accessing an Indexes object that was named with
@@ -3463,7 +3463,7 @@ export function useCreateRelationships(
  * props through every component.
  *
  * The useRelationships hook lets you either get a reference to the default
- * Relationships object (when called without an parameter), or one of the
+ * Relationships object (when called without a parameter), or one of the
  * Relationships objects that are named by Id (when called with an Id
  * parameter).
  *
@@ -4257,7 +4257,7 @@ export function useCreateQueries(
  * through every component.
  *
  * The useQueries hook lets you either get a reference to the default Queries
- * object (when called without an parameter), or one of the Queries objects that
+ * object (when called without a parameter), or one of the Queries objects that
  * are named by Id (when called with an Id parameter).
  *
  * @param id An optional Id for accessing a Queries object that was named with
@@ -5695,7 +5695,7 @@ export function useCreateCheckpoints(
  * props through every component.
  *
  * The useCheckpoints hook lets you either get a reference to the default
- * Checkpoints object (when called without an parameter), or one of the
+ * Checkpoints object (when called without a parameter), or one of the
  * Checkpoints objects that are named by Id (when called with an Id parameter).
  *
  * @param id An optional Id for accessing a Checkpoints object that was named
@@ -6876,7 +6876,7 @@ export type SliceProps = {
 
 /**
  * RemoteRowProps props are used for components that refer to a single
- * Relationship in an Relationships object, and where you want to render a
+ * Relationship in a Relationships object, and where you want to render a
  * remote Row based on a local Row, such as in the RemoteRowView component.
  *
  * @category Props
@@ -6915,7 +6915,7 @@ export type RemoteRowProps = {
 
 /**
  * LocalRowsProps props are used for components that refer to a single
- * Relationship in an Relationships object, and where you want to render local
+ * Relationship in a Relationships object, and where you want to render local
  * Rows based on a remote Row, such as the LocalRowsView component.
  *
  * @category Props
@@ -6958,7 +6958,7 @@ export type LocalRowsProps = {
 
 /**
  * LinkedRowsProps props are used for components that refer to a single
- * Relationship in an Relationships object, and where you want to render a
+ * Relationship in a Relationships object, and where you want to render a
  * linked list of Rows starting from a first Row, such as the LinkedRowsView
  * component.
  *
@@ -7177,7 +7177,7 @@ export type ResultCellProps = {
 
 /**
  * CheckpointProps props are used for components that refer to a single
- * checkpoint in an Checkpoints object, such as the CheckpointView component.
+ * checkpoint in a Checkpoints object, such as the CheckpointView component.
  *
  * @category Props
  */
@@ -8406,7 +8406,7 @@ export function IndexView(props: IndexProps): ComponentReturnType;
  * @param props The props for this component.
  * @returns A rendering of the remote Row, or nothing, if not present.
  * @example
- * This example creates an Relationships object outside the application, which
+ * This example creates a Relationships object outside the application, which
  * is used in the RemoteRowView component by reference. A change to the Row Ids
  * re-renders the component.
  *
@@ -8538,7 +8538,7 @@ export function RemoteRowView(props: RemoteRowProps): ComponentReturnType;
  * @param props The props for this component.
  * @returns A rendering of the local Row objects, or nothing, if not present.
  * @example
- * This example creates an Relationships object outside the application, which
+ * This example creates a Relationships object outside the application, which
  * is used in the LocalRowsView component by reference. A change to the Row Ids
  * re-renders the component.
  *
@@ -8671,7 +8671,7 @@ export function LocalRowsView(props: LocalRowsProps): ComponentReturnType;
  * @param props The props for this component.
  * @returns A rendering of the local Row objects, or nothing, if not present.
  * @example
- * This example creates an Relationships object outside the application, which
+ * This example creates a Relationships object outside the application, which
  * is used in the LinkedRowsView component by reference. A change to the Row Ids
  * re-renders the component.
  *
@@ -9335,7 +9335,7 @@ export function ResultTableView(props: ResultTableProps): ComponentReturnType;
  * @param props The props for this component.
  * @returns A rendering of the checkpoint: its label if present, or Id.
  * @example
- * This example creates an Checkpoints object outside the application, which is
+ * This example creates a Checkpoints object outside the application, which is
  * used in the CheckpointView component by reference to render a checkpoint with
  * a label (with its Id for readability).
  *
@@ -9392,7 +9392,7 @@ export function CheckpointView(props: CheckpointProps): ComponentReturnType;
  * @param props The props for this component.
  * @returns A rendering of the previous checkpoints, if present.
  * @example
- * This example creates an Checkpoints object outside the application, which is
+ * This example creates a Checkpoints object outside the application, which is
  * used in the BackwardCheckpointsView component by reference to render a list
  * of previous checkpoints.
  *
@@ -9526,7 +9526,7 @@ export function BackwardCheckpointsView(
  * @param props The props for this component.
  * @returns A rendering of the current checkpoint, if present.
  * @example
- * This example creates an Checkpoints object outside the application, which is
+ * This example creates a Checkpoints object outside the application, which is
  * used in the CurrentCheckpointView component by reference to render the
  * current checkpoints.
  *
@@ -9662,7 +9662,7 @@ export function CurrentCheckpointView(
  * @param props The props for this component.
  * @returns A rendering of the future checkpoints, if present.
  * @example
- * This example creates an Checkpoints object outside the application, which is
+ * This example creates a Checkpoints object outside the application, which is
  * used in the ForwardCheckpointsView component by reference to render a list
  * of future checkpoints.
  *