shelving 1.76.2 → 1.77.0

package/constraint/Constraints.d.ts

@@ -2,7 +2,7 @@ import type { Data } from "../util/data.js";
 import { ImmutableArray } from "../util/array.js";
 import { Constraint } from "./Constraint.js";
 /** Type of Rule that is powered by several sub-constraints (e.g. `Filters` and `Sorts` and `Query` itself extend this). */
-export declare abstract class Constraints<T extends Data, C extends Constraint<T>> extends Constraint<T> implements Iterable<C> {
+export declare abstract class Constraints<T extends Data, C extends Constraint<Partial<T>>> extends Constraint<T> implements Iterable<C> {
     protected readonly _constraints: ImmutableArray<C>;
     /** Get the first constraint. */
     get first(): C | undefined;

package/constraint/FilterConstraint.d.ts

@@ -1,8 +1,8 @@
-import { ArrayType, ImmutableArray } from "../util/array.js";
-import { Data, Key } from "../util/data.js";
+import type { Data, Key } from "../util/data.js";
+import type { Nullish } from "../util/null.js";
+import { ImmutableArray } from "../util/array.js";
 import { Matchable } from "../util/match.js";
-import { NotString } from "../util/string.js";
-import { Constraint } from "./Constraint.js";
+import type { Constraint } from "./Constraint.js";
 /** Possible operator references. */
 export declare type FilterOperator = "IS" | "NOT" | "IN" | "OUT" | "CONTAINS" | "LT" | "LTE" | "GT" | "GTE";
 /** Format that allows filters to be specified as a string, e.g. `!name` means `name is not` and `age>` means `age is more than` and `tags[]` means `tags array contains` */
@@ -11,12 +11,12 @@ export declare type FilterKey<T extends Data> = Key<T> | `${Key<T>}` | `!${Key<T
 export declare type FilterProps<T extends Data> = {
     [K in Key<T> as `${K}` | `!${K}`]?: T[K] | ImmutableArray<T[K]>;
 } & {
-    [K in Key<T> as `${K}[]`]?: T[K] extends ImmutableArray ? ArrayType<T[K]> : never;
+    [K in Key<T> as `${K}[]`]?: Required<T>[K] extends ReadonlyArray<infer X> ? X : never;
 } & {
     [K in Key<T> as `${K}<` | `${K}<=` | `${K}>` | `${K}>=`]?: T[K];
 };
 /** List of filters in a flexible format. */
-export declare type FilterList<T extends Data> = FilterProps<T> | FilterConstraint<T> | Iterable<FilterList<T> & NotString>;
+export declare type FilterList<T extends Data> = Nullish<FilterProps<T> | FilterConstraint<T>> | Iterable<FilterList<T>>;
 /**
  * Filter: filters a list of data.
  *

package/constraint/FilterConstraint.js

@@ -89,7 +89,7 @@ export function* getFilters(filters) {
         for (const filter of filters)
             yield* getFilters(filter);
     }
-    else {
+    else if (filters) {
         for (const [key, value] of Object.entries(filters))
             yield new FilterConstraint(key, value);
     }

package/constraint/FilterConstraints.d.ts

@@ -1,6 +1,6 @@
 import type { Data } from "../util/data.js";
 import type { Matchable } from "../util/match.js";
-import { FilterList, FilterProps, FilterConstraint } from "./FilterConstraint.js";
+import { FilterList, FilterConstraint } from "./FilterConstraint.js";
 import { Constraints } from "./Constraints.js";
 /**
  * Interface to make sure an object implements all matchers.
@@ -8,14 +8,14 @@ import { Constraints } from "./Constraints.js";
  */
 export interface Filterable<T extends Data> extends Matchable<T, void> {
     /** Add a filter to this filterable. */
-    filter(props: FilterProps<T>): this;
+    filter(...filters: FilterList<Partial<T>>[]): this;
     /** Match an item against the filters specified for this object. */
     match(item: T): boolean;
 }
 /** A set of filters. */
-export declare class FilterConstraints<T extends Data = Data> extends Constraints<T, FilterConstraint<T>> implements Filterable<T> {
-    constructor(...filters: FilterList<T>[]);
-    filter(...filters: FilterList<T>[]): this;
+export declare class FilterConstraints<T extends Data = Data> extends Constraints<T, FilterConstraint<Partial<T>>> implements Filterable<T> {
+    constructor(...filters: FilterList<Partial<T>>[]);
+    filter(...filters: FilterList<Partial<T>>[]): this;
     match(item: T): boolean;
     transform(items: Iterable<T>): Iterable<T>;
     toString(): string;

package/constraint/QueryConstraints.d.ts

@@ -3,7 +3,7 @@ import { Filterable, FilterConstraints } from "./FilterConstraints.js";
 import { Sortable, SortConstraints } from "./SortConstraints.js";
 import { Constraint } from "./Constraint.js";
 import { FilterList } from "./FilterConstraint.js";
-import { SortKeys, SortList } from "./SortConstraint.js";
+import { SortList } from "./SortConstraint.js";
 /** Interface that combines Filterable, Sortable, Sliceable. */
 export interface Queryable<T extends Data> extends Filterable<T>, Sortable<T> {
     /**
@@ -31,11 +31,11 @@ export declare class QueryConstraints<T extends Data = Data> extends Constraint<
     readonly filters: FilterConstraints<T>;
     readonly sorts: SortConstraints<T>;
     readonly limit: number | null;
-    constructor(filters?: FilterList<T>, sorts?: SortList<T>, limit?: number | null);
-    filter(...filters: FilterList<T>[]): this;
+    constructor(filters?: FilterList<Partial<T>>, sorts?: SortList<Partial<T>>, limit?: number | null);
+    filter(...filters: FilterList<Partial<T>>[]): this;
     get unfilter(): this;
     match(item: T): boolean;
-    sort(...keys: SortKeys<T>[]): this;
+    sort(...sorts: SortList<Partial<T>>[]): this;
     get unsort(): this;
     rank(left: T, right: T): number;
     after(item: T): this;

package/constraint/QueryConstraints.js

@@ -37,11 +37,11 @@ export class QueryConstraints extends Constraint {
         return this.filters.match(item);
     }
     // Implement `Sortable`
-    sort(...keys) {
+    sort(...sorts) {
         return {
             __proto__: Object.getPrototypeOf(this),
             ...this,
-            sorts: this.sorts.sort(...keys),
+            sorts: this.sorts.sort(...sorts),
         };
     }
     get unsort() {

package/constraint/SortConstraint.d.ts

@@ -1,7 +1,8 @@
 import type { ImmutableArray } from "../util/array.js";
-import { Data, Key } from "../util/data.js";
+import type { Data, Key } from "../util/data.js";
+import type { Nullish } from "../util/null.js";
 import { Rankable } from "../util/sort.js";
-import { Constraint } from "./Constraint.js";
+import type { Constraint } from "./Constraint.js";
 /** Format that allows sorts to be set as a plain string, e.g. `name` sorts by name in ascending order and `!date` sorts by date in descending order. */
 export declare type SortKey<T extends Data> = Key<T> | `${Key<T>}` | `!${Key<T>}`;
 /** One or more sort keys. */
@@ -9,7 +10,7 @@ export declare type SortKeys<T extends Data> = SortKey<T> | ImmutableArray<SortK
 /** Possible operator references. */
 export declare type SortDirection = "ASC" | "DESC";
 /** List of sorts in a flexible format. */
-export declare type SortList<T extends Data> = SortKeys<T> | SortConstraint<T> | Iterable<SortList<T>>;
+export declare type SortList<T extends Data> = Nullish<SortKeys<T> | SortConstraint<T> | Iterable<SortList<T>>>;
 /** Sort a list of values. */
 export declare class SortConstraint<T extends Data = Data> implements Constraint<T>, Rankable<T> {
     readonly key: string;

package/constraint/SortConstraint.js

@@ -1,4 +1,3 @@
-import { getProp } from "../util/data.js";
 import { rank, rankAsc, rankDesc, sortItems } from "../util/sort.js";
 /** Sort a list of values. */
 export class SortConstraint {
@@ -16,7 +15,7 @@ export class SortConstraint {
         return `"${this.direction === "DESC" ? "!" : ""}${this.key}"`;
     }
     rank(left, right) {
-        return rank(getProp(left, this.key), this.direction === "ASC" ? rankAsc : rankDesc, getProp(right, this.key));
+        return rank(left[this.key], this.direction === "ASC" ? rankAsc : rankDesc, right[this.key]);
     }
     transform(items) {
         return sortItems(items, this);
@@ -33,7 +32,7 @@ export function* getSorts(sorts) {
     else if (sorts instanceof SortConstraint) {
         yield sorts;
     }
-    else {
+    else if (sorts) {
         for (const sort of sorts)
             yield* getSorts(sort);
     }

package/constraint/SortConstraints.d.ts

@@ -1,19 +1,19 @@
 import type { Data } from "../util/data.js";
 import { Rankable } from "../util/sort.js";
 import { Constraints } from "./Constraints.js";
-import { SortConstraint, SortKeys, SortList } from "./SortConstraint.js";
+import { SortConstraint, SortList } from "./SortConstraint.js";
 /**
  * Interface to make sure an object implements all directions.
  * - Extends `Rankable` so this object itself can be directly be used with `filterItems()` and `filterEntries()`
  */
 export interface Sortable<T extends Data> extends Rankable<T> {
     /** Add one or more sorts to this sortable. */
-    sort(...keys: SortKeys<T>[]): this;
+    sort(...keys: SortList<Partial<T>>[]): this;
 }
 /** A set of sorts. */
-export declare class SortConstraints<T extends Data = Data> extends Constraints<T, SortConstraint<T>> implements Sortable<T> {
-    constructor(...sorts: SortList<T>[]);
-    sort(...sorts: SortList<T>[]): this;
+export declare class SortConstraints<T extends Data = Data> extends Constraints<T, SortConstraint<Partial<T>>> implements Sortable<T> {
+    constructor(...sorts: SortList<Partial<T>>[]);
+    sort(...sorts: SortList<Partial<T>>[]): this;
     rank(left: T, right: T): number;
     transform(items: Iterable<T>): Iterable<T>;
     toString(): string;

package/db/Change.d.ts

@@ -1,4 +1,4 @@
-import type { Data, Datas, Key, Value } from "../util/data.js";
+import type { Data, Datas, Key } from "../util/data.js";
 import type { ImmutableArray } from "../util/array.js";
 import type { Provider, AsyncProvider } from "../provider/Provider.js";
 import { DataUpdate } from "../update/DataUpdate.js";
@@ -27,7 +27,7 @@ export interface UpdateChange<T extends Datas, K extends Key<T> = Key<T>> extend
     readonly action: "UPDATE";
     readonly collection: K;
     readonly id: string;
-    readonly update: DataUpdate<Value<T>>;
+    readonly update: DataUpdate<T[K]>;
 }
 /** Delete change on an item. */
 export interface DeleteChange<T extends Datas, K extends Key<T> = Key<T>> extends Change<T> {

package/db/Collection.d.ts

@@ -12,7 +12,7 @@ declare abstract class BaseCollection<T extends Datas = Datas, K extends Key<T>
     abstract readonly db: Database<T> | AsyncDatabase<T>;
     abstract readonly collection: K;
     /** Create a query on this item's collection. */
-    abstract query(filters?: FilterList<ItemData<T[K]>>, sorts?: SortList<ItemData<T[K]>>, limit?: number | null): Query<T, K> | AsyncQuery<T, K>;
+    abstract query(filters?: FilterList<Partial<ItemData<T[K]>>>, sorts?: SortList<Partial<ItemData<T[K]>>>, limit?: number | null): Query<T, K> | AsyncQuery<T, K>;
     /** Create a query on this item's collection. */
     abstract item(id: string): Item<T, K> | AsyncItem<T, K>;
     /** Add an item to this collection. */
@@ -28,7 +28,7 @@ export declare class Collection<T extends Datas = Datas, K extends Key<T> = Key<
     readonly db: Database<T>;
     readonly collection: K;
     constructor(db: Database<T>, collection: K);
-    query(filters?: FilterList<ItemData<T[K]>>, sorts?: SortList<ItemData<T[K]>>, limit?: number | null): Query<T, K>;
+    query(filters?: FilterList<Partial<ItemData<T[K]>>>, sorts?: SortList<Partial<ItemData<T[K]>>>, limit?: number | null): Query<T, K>;
     item(id: string): Item<T, K>;
     add(data: T[K]): string;
     change(...changes: DeepIterable<Nullish<WriteChange<T, K>>>[]): ItemChanges<T, K>;
@@ -38,7 +38,7 @@ export declare class AsyncCollection<T extends Datas = Datas, K extends Key<T> =
     readonly db: AsyncDatabase<T>;
     readonly collection: K;
     constructor(db: AsyncDatabase<T>, collection: K);
-    query(filters?: FilterList<ItemData<T[K]>>, sorts?: SortList<ItemData<T[K]>>, limit?: number | null): AsyncQuery<T, K>;
+    query(filters?: FilterList<Partial<ItemData<T[K]>>>, sorts?: SortList<Partial<ItemData<T[K]>>>, limit?: number | null): AsyncQuery<T, K>;
     item(id: string): AsyncItem<T, K>;
     add(data: T[K]): Promise<string>;
     change(...changes: DeepIterable<Nullish<WriteChange<T, K>>>[]): Promise<ItemChanges<T, K>>;

package/db/Database.d.ts

@@ -15,7 +15,7 @@ declare abstract class BaseDatabase<T extends Datas> {
     /** Create a query on a collection in this database. */
     abstract collection<K extends Key<T>>(collection: K): Collection<T, K> | AsyncCollection<T, K>;
     /** Create a query on a collection in this database. */
-    abstract query<K extends Key<T>>(collection: K, filters?: FilterList<ItemData<T[K]>>, sorts?: SortList<ItemData<T[K]>>, limit?: number | null): Query<T, K> | AsyncQuery<T, K>;
+    abstract query<K extends Key<T>>(collection: K, filters?: FilterList<Partial<ItemData<T[K]>>>, sorts?: SortList<Partial<ItemData<T[K]>>>, limit?: number | null): Query<T, K> | AsyncQuery<T, K>;
     /** Reference an item in a collection in this database. */
     abstract item<K extends Key<T>>(collection: K, id: string): Item<T, K> | AsyncItem<T, K>;
     /** Run a set of changes on this database. */
@@ -26,7 +26,7 @@ export declare class Database<T extends Datas = Datas> implements BaseDatabase<T
     readonly provider: Provider<T>;
     constructor(provider: Provider<T>);
     collection<K extends Key<T>>(collection: K): Collection<T, K>;
-    query<K extends Key<T>>(collection: K, filters?: FilterList<ItemData<T[K]>>, sorts?: SortList<ItemData<T[K]>>, limit?: number | null): Query<T, K>;
+    query<K extends Key<T>>(collection: K, filters?: FilterList<Partial<ItemData<T[K]>>>, sorts?: SortList<Partial<ItemData<T[K]>>>, limit?: number | null): Query<T, K>;
     item<K extends Key<T>>(collection: K, id: string): Item<T, K>;
     change<K extends Key<T>>(...changes: DeepIterable<Nullish<WriteChange<T, K>>>[]): ItemChanges<T, K>;
 }
@@ -35,7 +35,7 @@ export declare class AsyncDatabase<T extends Datas = Datas> implements BaseDatab
     readonly provider: AsyncProvider<T>;
     constructor(provider: AsyncProvider<T>);
     collection<K extends Key<T>>(collection: K): AsyncCollection<T, K>;
-    query<K extends Key<T>>(collection: K, filters?: FilterList<ItemData<T[K]>>, sorts?: SortList<ItemData<T[K]>>, limit?: number | null): AsyncQuery<T, K>;
+    query<K extends Key<T>>(collection: K, filters?: FilterList<Partial<ItemData<T[K]>>>, sorts?: SortList<Partial<ItemData<T[K]>>>, limit?: number | null): AsyncQuery<T, K>;
     item<K extends Key<T>>(collection: K, id: string): AsyncItem<T, K>;
     change<K extends Key<T>>(...changes: DeepIterable<Nullish<WriteChange<T, K>>>[]): Promise<ItemChanges<T, K>>;
 }

package/db/Query.d.ts

@@ -80,7 +80,7 @@ declare abstract class BaseQuery<T extends Datas = Datas, K extends Key<T> = Key
 export declare class Query<T extends Datas = Datas, K extends Key<T> = Key<T>> extends BaseQuery<T, K> implements BaseQuery<T, K> {
     readonly db: Database<T>;
     readonly collection: K;
-    constructor(db: Database<T>, collection: K, filters?: FilterList<ItemData<T[K]>>, sorts?: SortList<ItemData<T[K]>>, limit?: number | null);
+    constructor(db: Database<T>, collection: K, filters?: FilterList<Partial<ItemData<T[K]>>>, sorts?: SortList<Partial<ItemData<T[K]>>>, limit?: number | null);
     get value(): ItemArray<T[K]>;
     get count(): number;
     get exists(): boolean;
@@ -96,7 +96,7 @@ export declare class Query<T extends Datas = Datas, K extends Key<T> = Key<T>> e
 export declare class AsyncQuery<T extends Datas = Datas, K extends Key<T> = Key<T>> extends BaseQuery<T, K> implements BaseQuery<T, K> {
     readonly db: AsyncDatabase<T>;
     readonly collection: K;
-    constructor(db: AsyncDatabase<T>, collection: K, filters?: FilterList<ItemData<T[K]>>, sorts?: SortList<ItemData<T[K]>>, limit?: number | null);
+    constructor(db: AsyncDatabase<T>, collection: K, filters?: FilterList<Partial<ItemData<T[K]>>>, sorts?: SortList<Partial<ItemData<T[K]>>>, limit?: number | null);
     get value(): Promise<ItemArray<T[K]>>;
     get count(): Promise<number>;
     get exists(): Promise<boolean>;

package/package.json

@@ -11,7 +11,7 @@
 		"state-management",
 		"query-builder"
 	],
-	"version": "1.76.2",
+	"version": "1.77.0",
 	"repository": "https://github.com/dhoulb/shelving",
 	"author": "Dave Houlbrooke <dave@shax.com>",
 	"license": "0BSD",

package/react/useItem.d.ts

@@ -1,17 +1,17 @@
 import type { Unsubscribe } from "../observe/Observable.js";
-import { Datas, Value } from "../util/data.js";
+import { Datas, Key } from "../util/data.js";
 import { ItemValue, ItemData, AsyncItem, Item } from "../db/Item.js";
 import { State } from "../state/State.js";
 import { BooleanState } from "../state/BooleanState.js";
 /** Hold the current state of a item. */
-export declare class ItemState<T extends Datas> extends State<ItemValue<Value<T>>> {
-    readonly ref: Item<T> | AsyncItem<T>;
+export declare class ItemState<T extends Datas, K extends Key<T> = Key<T>> extends State<ItemValue<T[K]>> {
+    readonly ref: Item<T, K> | AsyncItem<T, K>;
     readonly busy: BooleanState;
     /** Get the data of the item (throws `RequiredError` if item doesn't exist). */
-    get data(): ItemData<Value<T>>;
+    get data(): ItemData<T[K]>;
     /** Does the item exist (i.e. its value isn't `null`)? */
     get exists(): boolean;
-    constructor(ref: Item<T> | AsyncItem<T>);
+    constructor(ref: Item<T, K> | AsyncItem<T, K>);
     /** Refresh this state from the source provider. */
     readonly refresh: () => void;
     _refresh(): Promise<void>;
@@ -28,5 +28,5 @@ export declare class ItemState<T extends Datas> extends State<ItemValue<Value<T>
  * Use an item in a React component.
  * - Uses the default cache, so will error if not used inside `<Cache>`
  */
-export declare function useItem<T extends Datas>(ref: Item<T> | AsyncItem<T>): ItemState<T>;
-export declare function useItem<T extends Datas>(ref?: Item<T> | AsyncItem<T>): ItemState<T> | undefined;
+export declare function useItem<T extends Datas, K extends Key<T>>(ref: Item<T, K> | AsyncItem<T, K>): ItemState<T, K>;
+export declare function useItem<T extends Datas, K extends Key<T>>(ref?: Item<T, K> | AsyncItem<T, K>): ItemState<T, K> | undefined;

package/react/useQuery.d.ts

@@ -1,30 +1,30 @@
 import type { Unsubscribe } from "../observe/Observable.js";
-import type { Datas, Value } from "../util/data.js";
+import type { Datas, Key } from "../util/data.js";
 import type { ItemArray, ItemValue, ItemData } from "../db/Item.js";
 import { AsyncQuery, Query } from "../db/Query.js";
 import { State } from "../state/State.js";
 import { BooleanState } from "../state/BooleanState.js";
 /** Hold the current state of a query. */
-export declare class QueryState<T extends Datas> extends State<ItemArray<Value<T>>> {
-    readonly ref: Query<T> | AsyncQuery<T>;
+export declare class QueryState<T extends Datas, K extends Key<T> = Key<T>> extends State<ItemArray<T[K]>> {
+    readonly ref: Query<T, K> | AsyncQuery<T, K>;
     readonly busy: BooleanState;
     readonly limit: number;
     /** Can more items be loaded after the current result. */
     get hasMore(): boolean;
     private _hasMore;
     /** Get the first document matched by this query or `null` if this query has no items. */
-    get firstValue(): ItemValue<Value<T>>;
+    get firstValue(): ItemValue<T[K]>;
     /** Get the first document matched by this query. */
-    get firstData(): ItemData<Value<T>>;
+    get firstData(): ItemData<T[K]>;
     /** Get the last document matched by this query or `null` if this query has no items. */
-    get lastValue(): ItemValue<Value<T>>;
+    get lastValue(): ItemValue<T[K]>;
     /** Get the last document matched by this query. */
-    get lastData(): ItemData<Value<T>>;
+    get lastData(): ItemData<T[K]>;
     /** Does the document have at least one result. */
     get exists(): boolean;
     /** Get the number of items matching this query. */
     get count(): number;
-    constructor(ref: Query<T> | AsyncQuery<T>);
+    constructor(ref: Query<T, K> | AsyncQuery<T, K>);
     /** Refresh this state from the source provider. */
     readonly refresh: () => void;
     _refresh(): Promise<void>;
@@ -47,5 +47,5 @@ export declare class QueryState<T extends Datas> extends State<ItemArray<Value<T
  * Use a query in a React component.
  * - Uses the default cache, so will error if not used inside `<Cache>`
  */
-export declare function useQuery<T extends Datas>(ref: Query<T> | AsyncQuery<T>): QueryState<T>;
-export declare function useQuery<T extends Datas>(ref?: Query<T> | AsyncQuery<T>): QueryState<T> | undefined;
+export declare function useQuery<T extends Datas, K extends Key<T>>(ref: Query<T, K> | AsyncQuery<T, K>): QueryState<T, K>;
+export declare function useQuery<T extends Datas, K extends Key<T>>(ref?: Query<T, K> | AsyncQuery<T, K>): QueryState<T, K> | undefined;