tinybase 9.1.0-beta.0 → 9.1.0-beta.1

package/@types/common/index.d.ts

@@ -83,11 +83,26 @@ export type ParameterizedCallback<Parameter> = (parameter?: Parameter) => void;
 export type Callback = () => void;
 
 /**
- * The SortKey type represents a value that can be used by a sort function.
+ * The SortKey type represents a Cell value, or `undefined`, that can be used by
+ * a sort function.
  * @category Parameter
  * @since v1.0.0
  */
-export type SortKey = string | number | boolean | null;
+export type SortKey = CellOrUndefined;
+
+/**
+ * The Sorter type represents a function that compares two SortKey values.
+ *
+ * A Sorter is provided to methods that sort Row Ids when the default
+ * alphanumeric ordering is not appropriate. Return a positive or negative
+ * number to indicate which of the two SortKey values should be ordered first.
+ * @param sortKey1 The first item of the pair to compare.
+ * @param sortKey2 The second item of the pair to compare.
+ * @returns A number indicating how to sort the pair.
+ * @category Parameter
+ * @since v9.1.0
+ */
+export type Sorter = (sortKey1: SortKey, sortKey2: SortKey) => number;
 
 /**
  * The GetNow type is used to represent a function that returns the current time

package/@types/common/with-schemas/index.d.ts

@@ -95,11 +95,27 @@ export type ParameterizedCallback<Parameter> = (parameter?: Parameter) => void;
 export type Callback = () => void;
 
 /**
- * The SortKey type represents a value that can be used by a sort function.
+ * The SortKey type represents a Cell value, or `undefined`, that can be used by
+ * a sort function.
  * @category Parameter
  * @since v1.0.0
  */
-export type SortKey = string | number | boolean;
+export type SortKey =
+  string | number | boolean | null | AnyObject | AnyArray | undefined;
+
+/**
+ * The Sorter type represents a function that compares two SortKey values.
+ *
+ * A Sorter is provided to methods that sort Row Ids when the default
+ * alphanumeric ordering is not appropriate. Return a positive or negative
+ * number to indicate which of the two SortKey values should be ordered first.
+ * @param sortKey1 The first item of the pair to compare.
+ * @param sortKey2 The second item of the pair to compare.
+ * @returns A number indicating how to sort the pair.
+ * @category Parameter
+ * @since v9.1.0
+ */
+export type Sorter = (sortKey1: SortKey, sortKey2: SortKey) => number;
 
 /**
  * The GetNow type is used to represent a function that returns the current time

package/@types/store/index.d.ts

@@ -18,6 +18,7 @@ import type {
   IdOrNull,
   Ids,
   Json,
+  Sorter,
 } from '../common/index.d.ts';
 
 /**
@@ -625,7 +626,7 @@ export type DoRollback = (store: Store) => boolean;
  * the getSortedRowIds method.
  *
  * It's an object containing the Id of the Table in the Store, and optional
- * `cellId`, `descending`, `offset`, and `limit` parameters. See the
+ * `cellId`, `descending`, `offset`, `limit`, and `sorter` parameters. See the
  * getSortedRowIds method for specific examples.
  * @category Store
  * @since v6.1.0
@@ -662,6 +663,13 @@ export type SortedRowIdsArgs = {
    * @since v6.1.0
    */
   limit?: number;
+  /**
+   * A custom function for comparing the sorting values, defaulting to the
+   * defaultSorter function.
+   * @category Argument
+   * @since v9.1.0
+   */
+  sorter?: Sorter;
 };
 
 /**
@@ -2196,10 +2204,11 @@ export interface Store {
    * The getSortedRowIds method returns the Ids of every Row in a given Table,
    * sorted according to the values in a specified Cell.
    *
-   * The sorting of the rows is alphanumeric, and you can indicate whether it
-   * should be in descending order. The `offset` and `limit` parameters are used
-   * to paginate results, but default to `0` and `undefined` to return all
-   * available Row Ids if not specified.
+   * By default the sorting of the rows is alphanumeric, and you can indicate
+   * whether it should be in descending order. The `offset` and `limit`
+   * parameters are used to paginate results, but default to `0` and
+   * `undefined` to return all available Row Ids if not specified. The `sorter`
+   * parameter can provide a custom comparison function.
    *
    * Note that every call to this method will perform the sorting afresh - there
    * is no caching of the results - and so you are advised to memoize the
@@ -2216,6 +2225,8 @@ export interface Store {
    * any.
    * @param limit The maximum number of Row Ids to return, or `undefined` for
    * all.
+   * @param sorter A custom function for comparing the sorting values, or
+   * `undefined` to use the defaultSorter function.
    * @returns An array of the sorted Ids of appropriate Rows in the Table.
    * @example
    * This example retrieves sorted Row Ids in a Table.
@@ -2287,6 +2298,24 @@ export interface Store {
    * // -> ['cujo', 'felix', 'fido']
    * ```
    * @example
+   * This example retrieves Row Ids sorted numerically by their own value.
+   *
+   * ```js
+   * import {createStore} from 'tinybase';
+   *
+   * const store = createStore();
+   * ['1', '10', '2'].forEach((rowId) =>
+   *   store.setRow('pets', rowId, {sold: false}),
+   * );
+   * const numericSorter = (sortKey1, sortKey2) =>
+   *   Number(sortKey1) - Number(sortKey2);
+   *
+   * console.log(
+   *   store.getSortedRowIds({tableId: 'pets', sorter: numericSorter}),
+   * );
+   * // -> ['1', '2', '10']
+   * ```
+   * @example
    * This example retrieves the sorted Row Ids of a Table that does not exist,
    * returning an empty array.
    *
@@ -2306,13 +2335,14 @@ export interface Store {
     descending?: boolean,
     offset?: number,
     limit?: number,
+    sorter?: Sorter,
   ): Ids;
 
   /**
    * When called with one object argument, the getSortedRowIds method
    * destructures it to make it easier to skip optional parameters.
    * @param args A SortedRowIdsArgs object containing the Id of the Table in the
-   * Store, and optional `cellId`, `descending`, `offset`, and `limit`
+   * Store, and optional `cellId`, `descending`, `offset`, `limit`, and `sorter`
    * parameters.
    * @returns An array of the sorted Ids of appropriate Rows in the Table.
    * @example
@@ -5813,7 +5843,7 @@ export interface Store {
    * addSortedRowIdsListener method destructures it to make it easier to skip
    * optional parameters.
    * @param args A SortedRowIdsArgs object containing the Id of the Table in the
-   * Store, and optional `cellId`, `descending`, `offset`, and `limit`
+   * Store, and optional `cellId`, `descending`, `offset`, `limit`, and `sorter`
    * parameters.
    * @param listener The function that will be called whenever the sorted Row
    * Ids in the Table change.

package/@types/store/with-schemas/index.d.ts

@@ -29,6 +29,7 @@ import type {
   IdOrNull,
   Ids,
   Json,
+  Sorter,
 } from '../../common/with-schemas/index.d.ts';
 
 /**
@@ -947,7 +948,7 @@ export type DoRollback<Schemas extends OptionalSchemas> = (
  * the getSortedRowIds method.
  *
  * It's an object containing the Id of the Table in the Store, and optional
- * `cellId`, `descending`, `offset`, and `limit` parameters. See the
+ * `cellId`, `descending`, `offset`, `limit`, and `sorter` parameters. See the
  * getSortedRowIds method for specific examples.
  * @category Store
  * @since v6.1.0
@@ -989,6 +990,13 @@ export type SortedRowIdsArgs<
    * @since v6.1.0
    */
   limit?: number;
+  /**
+   * A custom function for comparing the sorting values, defaulting to the
+   * defaultSorter function.
+   * @category Argument
+   * @since v9.1.0
+   */
+  sorter?: Sorter;
 };
 
 /**
@@ -3216,13 +3224,15 @@ export interface Store<in out Schemas extends OptionalSchemas> {
    *   descending?: boolean,
    *   offset?: number,
    *   limit?: number,
+   *   sorter?: Sorter,
    * ): Ids;
    * ```
    *
-   * The sorting of the rows is alphanumeric, and you can indicate whether it
-   * should be in descending order. The `offset` and `limit` parameters are used
-   * to paginate results, but default to `0` and `undefined` to return all
-   * available Row Ids if not specified.
+   * By default the sorting of the rows is alphanumeric, and you can indicate
+   * whether it should be in descending order. The `offset` and `limit`
+   * parameters are used to paginate results, but default to `0` and
+   * `undefined` to return all available Row Ids if not specified. The `sorter`
+   * parameter can provide a custom comparison function.
    *
    * Note that every call to this method will perform the sorting afresh - there
    * is no caching of the results - and so you are advised to memoize the
@@ -3239,6 +3249,8 @@ export interface Store<in out Schemas extends OptionalSchemas> {
    * any.
    * @param limit The maximum number of Row Ids to return, or `undefined` for
    * all.
+   * @param sorter A custom function for comparing the sorting values, or
+   * `undefined` to use the defaultSorter function.
    * @returns An array of the sorted Ids of appropriate Rows in the Table.
    * @example
    * This example retrieves sorted Row Ids in a Table.
@@ -3310,6 +3322,24 @@ export interface Store<in out Schemas extends OptionalSchemas> {
    * // -> ['cujo', 'felix', 'fido']
    * ```
    * @example
+   * This example retrieves Row Ids sorted numerically by their own value.
+   *
+   * ```js
+   * import {createStore} from 'tinybase';
+   *
+   * const store = createStore();
+   * ['1', '10', '2'].forEach((rowId) =>
+   *   store.setRow('pets', rowId, {sold: false}),
+   * );
+   * const numericSorter = (sortKey1, sortKey2) =>
+   *   Number(sortKey1) - Number(sortKey2);
+   *
+   * console.log(
+   *   store.getSortedRowIds({tableId: 'pets', sorter: numericSorter}),
+   * );
+   * // -> ['1', '2', '10']
+   * ```
+   * @example
    * This example retrieves the sorted Row Ids of a Table that does not exist,
    * returning an empty array.
    *
@@ -3329,13 +3359,14 @@ export interface Store<in out Schemas extends OptionalSchemas> {
     descending?: boolean,
     offset?: number,
     limit?: number,
+    sorter?: Sorter,
   ): Ids;
 
   /**
    * When called with one object argument, the getSortedRowIds method
    * destructures it to make it easier to skip optional parameters.
    * @param args A SortedRowIdsArgs object containing the Id of the Table in the
-   * Store, and optional `cellId`, `descending`, `offset`, and `limit`
+   * Store, and optional `cellId`, `descending`, `offset`, `limit`, and `sorter`
    * parameters.
    * @returns An array of the sorted Ids of appropriate Rows in the Table.
    * @example
@@ -7295,7 +7326,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
    * addSortedRowIdsListener method destructures it to make it easier to skip
    * optional parameters.
    * @param args A SortedRowIdsArgs object containing the Id of the Table in the
-   * Store, and optional `cellId`, `descending`, `offset`, and `limit`
+   * Store, and optional `cellId`, `descending`, `offset`, `limit`, and `sorter`
    * parameters.
    * @param listener The function that will be called whenever the sorted Row
    * Ids in the Table change.

package/@types/ui-react/index.d.ts

@@ -36,6 +36,7 @@ import type {
   IdOrNull,
   Ids,
   ParameterizedCallback,
+  Sorter,
 } from '../common/index.d.ts';
 import type {
   Indexes,
@@ -1797,6 +1798,7 @@ export function useSortedRowIds(
   descending?: boolean,
   offset?: number,
   limit?: number,
+  sorterOrStoreOrStoreId?: Sorter | StoreOrStoreId,
   storeOrStoreId?: StoreOrStoreId,
 ): Ids;
 
@@ -1804,7 +1806,8 @@ export function useSortedRowIds(
  * When called with an object as the first argument, the useSortedRowIds method
  * destructures it to make it easier to skip optional parameters.
  * @param args A SortedRowIdsArgs object containing the Id of the Table in the
- * Store, and optional `cellId`, `descending`, `offset`, and `limit` parameters.
+ * Store, and optional `cellId`, `descending`, `offset`, `limit`, and `sorter`
+ * parameters.
  * @param storeOrStoreId The Store to be accessed: omit for the default context
  * Store, provide an Id for a named context Store, or provide an explicit
  * reference.
@@ -5178,7 +5181,8 @@ export function useSortedRowIdsListener(
  * When called with an object as the first argument, the useSortedRowIds method
  * destructures it to make it easier to skip optional parameters.
  * @param args A SortedRowIdsArgs object containing the Id of the Table in the
- * Store, and optional `cellId`, `descending`, `offset`, and `limit` parameters.
+ * Store, and optional `cellId`, `descending`, `offset`, `limit`, and `sorter`
+ * parameters.
  * @param listener The function that will be called whenever the sorted Row Ids
  * in the Table change.
  * @param listenerDeps An optional array of dependencies for the `listener`

package/@types/ui-react/with-schemas/index.d.ts

@@ -82,6 +82,7 @@ import type {
   IdOrNull,
   Ids,
   ParameterizedCallback,
+  Sorter,
 } from '../../common/with-schemas/index.d.ts';
 import type {
   Indexes,
@@ -1901,6 +1902,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  *   descending?: boolean,
  *   offset?: number,
  *   limit?: number,
+ *   sorterOrStoreOrStoreId?: Sorter | StoreOrStoreId,
  *   storeOrStoreId?: StoreOrStoreId,
  * ): Ids;
  * ```
@@ -2032,6 +2034,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
       descending?: boolean,
       offset?: number,
       limit?: number,
+      sorterOrStoreOrStoreId?: Sorter | StoreOrStoreId<Schemas>,
       storeOrStoreId?: StoreOrStoreId<Schemas>,
     ): Ids;
 
@@ -2039,7 +2042,8 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * When called with an object as the first argument, the useSortedRowIds method
  * destructures it to make it easier to skip optional parameters.
  * @param args A SortedRowIdsArgs object containing the Id of the Table in the
- * Store, and optional `cellId`, `descending`, `offset`, and `limit` parameters.
+ * Store, and optional `cellId`, `descending`, `offset`, `limit`, and `sorter`
+ * parameters.
  * @param storeOrStoreId The Store to be accessed: omit for the default context
  * Store, provide an Id for a named context Store, or provide an explicit
  * reference.
@@ -5957,7 +5961,8 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * When called with an object as the first argument, the useSortedRowIds method
  * destructures it to make it easier to skip optional parameters.
  * @param args A SortedRowIdsArgs object containing the Id of the Table in the
- * Store, and optional `cellId`, `descending`, `offset`, and `limit` parameters.
+ * Store, and optional `cellId`, `descending`, `offset`, `limit`, and `sorter`
+ * parameters.
  * @param listener The function that will be called whenever the sorted Row Ids
  * in the Table change.
  * @param listenerDeps An optional array of dependencies for the `listener`

package/@types/ui-solid/index.d.ts

@@ -38,6 +38,7 @@ import type {
   IdOrNull,
   Ids,
   ParameterizedCallback,
+  Sorter,
 } from '../common/index.d.ts';
 import type {
   Indexes,
@@ -1418,6 +1419,8 @@ export function useRowIds(
  * @param descending Whether the sorting should be in descending order.
  * @param offset The number of Row Ids to skip for pagination purposes, if any.
  * @param limit The maximum number of Row Ids to return, or `undefined` for all.
+ * @param sorter A custom function for comparing the sorting values, or
+ * `undefined` to use the default alphanumeric sorting.
  * @param storeOrStoreId The Store to be accessed: omit for the default context
  * Store, provide an Id for a named context Store, or provide an explicit
  * reference.
@@ -1441,6 +1444,7 @@ export function useRowIds(
  *     false,
  *     0,
  *     undefined,
+ *     undefined,
  *     store,
  *   );
  *   console.log(JSON.stringify(rowIds()));
@@ -1457,6 +1461,7 @@ export function useSortedRowIds(
   descending?: MaybeAccessor<boolean | undefined>,
   offset?: MaybeAccessor<number | undefined>,
   limit?: MaybeAccessor<number | undefined>,
+  sorter?: Sorter,
   storeOrStoreId?: MaybeAccessor<StoreOrStoreId | undefined>,
 ): Accessor<Ids>;
 
@@ -1464,7 +1469,8 @@ export function useSortedRowIds(
  * When called with an object as the first argument, the useSortedRowIds method
  * destructures it to make it easier to skip optional parameters.
  * @param args A SortedRowIdsArgs object containing the Id of the Table in the
- * Store, and optional `cellId`, `descending`, `offset`, and `limit` parameters.
+ * Store, and optional `cellId`, `descending`, `offset`, `limit`, and `sorter`
+ * parameters.
  * @param storeOrStoreId The Store to be accessed: omit for the default context
  * Store, provide an Id for a named context Store, or provide an explicit
  * reference.
@@ -4517,7 +4523,8 @@ export function useSortedRowIdsListener(
  * When called with an object as the first argument, the useSortedRowIds method
  * destructures it to make it easier to skip optional parameters.
  * @param args A SortedRowIdsArgs object containing the Id of the Table in the
- * Store, and optional `cellId`, `descending`, `offset`, and `limit` parameters.
+ * Store, and optional `cellId`, `descending`, `offset`, `limit`, and `sorter`
+ * parameters.
  * @param listener The function that will be called whenever the sorted Row Ids
  * in the Table change.
  * @param mutator An optional boolean that indicates that the listener mutates

package/@types/ui-solid/with-schemas/index.d.ts

@@ -84,6 +84,7 @@ import type {
   IdOrNull,
   Ids,
   ParameterizedCallback,
+  Sorter,
 } from '../../common/with-schemas/index.d.ts';
 import type {
   Indexes,
@@ -1635,6 +1636,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  *   descending?: MaybeAccessor<boolean | undefined>,
  *   offset?: MaybeAccessor<number | undefined>,
  *   limit?: MaybeAccessor<number | undefined>,
+ *   sorter?: Sorter,
  *   storeOrStoreId?: MaybeAccessor<StoreOrStoreId | undefined>,
  * ): Accessor<Ids>;
  * ```
@@ -1654,6 +1656,8 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * @param descending Whether the sorting should be in descending order.
  * @param offset The number of Row Ids to skip for pagination purposes, if any.
  * @param limit The maximum number of Row Ids to return, or `undefined` for all.
+ * @param sorter A custom function for comparing the sorting values, or
+ * `undefined` to use the default alphanumeric sorting.
  * @param storeOrStoreId The Store to be accessed: omit for the default context
  * Store, provide an Id for a named context Store, or provide an explicit
  * reference.
@@ -1677,6 +1681,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  *     false,
  *     0,
  *     undefined,
+ *     undefined,
  *     store,
  *   );
  *   console.log(JSON.stringify(rowIds()));
@@ -1697,6 +1702,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
       descending?: MaybeAccessor<boolean | undefined>,
       offset?: MaybeAccessor<number | undefined>,
       limit?: MaybeAccessor<number | undefined>,
+      sorter?: Sorter,
       storeOrStoreId?: MaybeAccessor<StoreOrStoreId<Schemas> | undefined>,
     ): Accessor<Ids>;
 
@@ -1704,7 +1710,8 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * When called with an object as the first argument, the useSortedRowIds method
  * destructures it to make it easier to skip optional parameters.
  * @param args A SortedRowIdsArgs object containing the Id of the Table in the
- * Store, and optional `cellId`, `descending`, `offset`, and `limit` parameters.
+ * Store, and optional `cellId`, `descending`, `offset`, `limit`, and `sorter`
+ * parameters.
  * @param storeOrStoreId The Store to be accessed: omit for the default context
  * Store, provide an Id for a named context Store, or provide an explicit
  * reference.
@@ -5274,7 +5281,8 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * When called with an object as the first argument, the useSortedRowIds method
  * destructures it to make it easier to skip optional parameters.
  * @param args A SortedRowIdsArgs object containing the Id of the Table in the
- * Store, and optional `cellId`, `descending`, `offset`, and `limit` parameters.
+ * Store, and optional `cellId`, `descending`, `offset`, `limit`, and `sorter`
+ * parameters.
  * @param listener The function that will be called whenever the sorted Row Ids
  * in the Table change.
  * @param mutator An optional boolean that indicates that the listener mutates

package/@types/ui-svelte/index.d.ts

@@ -35,7 +35,7 @@ import type {
   CheckpointListener,
   Checkpoints,
 } from '../checkpoints/index.d.ts';
-import type {Id, IdOrNull, Ids} from '../common/index.d.ts';
+import type {Id, IdOrNull, Ids, Sorter} from '../common/index.d.ts';
 import type {
   Indexes,
   SliceIdsListener,
@@ -82,6 +82,7 @@ import type {
   RowCountListener,
   RowIdsListener,
   RowListener,
+  SortedRowIdsArgs,
   SortedRowIdsListener,
   Store,
   Table,
@@ -2893,6 +2894,8 @@ export function getRowIds(
  * @param descending Whether to sort descending (or a getter returning it).
  * @param offset The starting Row offset (or a getter returning it).
  * @param limit The maximum number of Rows to return (or a getter returning it).
+ * @param sorter A custom function for comparing the sorting values, or
+ * `undefined` to use the default alphanumeric sorting.
  * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
  * @returns A reactive object with a `current` Ids property.
  * @example
@@ -2907,7 +2910,15 @@ export function getRowIds(
  *
  *   let {store} = $props();
  *
- *   const result = getSortedRowIds('pets', 'sold', false, 0, undefined, store);
+ *   const result = getSortedRowIds(
+ *     'pets',
+ *     'sold',
+ *     false,
+ *     0,
+ *     undefined,
+ *     undefined,
+ *     store,
+ *   );
  * </script>
  *
  * {JSON.stringify(result.current)}
@@ -2941,6 +2952,23 @@ export function getSortedRowIds(
   descending?: MaybeGetter<boolean>,
   offset?: MaybeGetter<number>,
   limit?: MaybeGetter<number | undefined>,
+  sorter?: Sorter,
+  storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
+): {readonly current: Ids};
+
+/**
+ * When called with an object as the first argument, the getSortedRowIds
+ * function destructures it to make it easier to skip optional parameters.
+ * @param args A SortedRowIdsArgs object containing the Id of the Table in the
+ * Store, and optional `cellId`, `descending`, `offset`, `limit`, and `sorter`
+ * parameters.
+ * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
+ * @returns A reactive object with a `current` Ids property.
+ * @category Getter
+ * @since v9.1.0
+ */
+export function getSortedRowIds(
+  args: SortedRowIdsArgs,
   storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
 ): {readonly current: Ids};
 
@@ -6936,6 +6964,26 @@ export function onSortedRowIds(
   storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
 ): void;
 
+/**
+ * When called with an object as the first argument, the onSortedRowIds function
+ * destructures it to make it easier to skip optional parameters.
+ * @param args A SortedRowIdsArgs object containing the Id of the Table in the
+ * Store, and optional `cellId`, `descending`, `offset`, `limit`, and `sorter`
+ * parameters.
+ * @param listener The function to call when sorted Row Ids change.
+ * @param mutator An optional boolean indicating the listener mutates Store
+ * data.
+ * @param storeOrStoreId The Store to use, or its Id.
+ * @category Listener
+ * @since v9.1.0
+ */
+export function onSortedRowIds(
+  args: SortedRowIdsArgs,
+  listener: SortedRowIdsListener,
+  mutator?: boolean,
+  storeOrStoreId?: MaybeGetter<StoreOrStoreId | undefined>,
+): void;
+
 /**
  * The onHasRow function registers a listener that is called whenever a
  * specified Row is added to or removed from a Table.