shelving 1.33.0 → 1.34.0

package/package.json

@@ -11,7 +11,7 @@
 		"state-management",
 		"query-builder"
 	],
-	"version": "1.33.0",
+	"version": "1.34.0",
 	"repository": "https://github.com/dhoulb/shelving",
 	"author": "Dave Houlbrooke <dave@shax.com>",
 	"license": "0BSD",
@@ -63,20 +63,20 @@
 		"@types/jest": "^27.0.3",
 		"@types/react": "^17.0.37",
 		"@types/react-dom": "^17.0.11",
-		"@typescript-eslint/eslint-plugin": "^5.6.0",
-		"@typescript-eslint/parser": "^5.6.0",
-		"eslint": "^8.4.1",
+		"@typescript-eslint/eslint-plugin": "^5.7.0",
+		"@typescript-eslint/parser": "^5.7.0",
+		"eslint": "^8.5.0",
 		"eslint-config-prettier": "^8.3.0",
 		"eslint-plugin-import": "^2.25.3",
 		"eslint-plugin-prettier": "^4.0.0",
 		"firebase": "^9.6.1",
-		"jest": "^27.4.4",
+		"jest": "^27.4.5",
 		"jest-ts-webcompat-resolver": "^1.0.0",
 		"prettier": "^2.5.1",
 		"react": "^17.0.2",
 		"react-dom": "^17.0.2",
-		"ts-jest": "^27.1.1",
-		"typescript": "^4.5.3"
+		"ts-jest": "^27.1.2",
+		"typescript": "^4.5.4"
 	},
 	"peerDependencies": {
 		"@google-cloud/firestore": ">=4.0.0",

package/query/Filters.d.ts

@@ -13,5 +13,6 @@ export declare class Filters<T extends Data> extends Rules<T, Filter<T>> impleme
     gt<K extends QueryKey<T>>(key: K, value: K extends "id" ? string : T[K]): this;
     gte<K extends QueryKey<T>>(key: K, value: K extends "id" ? string : T[K]): this;
     match(entry: Entry<T>): boolean;
+    get unfiltered(): this;
     transform(iterable: Results<T>): Results<T>;
 }

package/query/Filters.js

@@ -3,6 +3,7 @@ import { ArrayContainsFilter, EqualFilter, GreaterThanEqualFilter, GreaterThanFi
 import { Rules } from "./Rules.js";
 /** A set of filters. */
 export class Filters extends Rules {
+    // Implement `Filterable`
     is(key, value) {
         return { __proto__: Object.getPrototypeOf(this), ...this, _rules: [...this._rules, new EqualFilter(key, value)] };
     }
@@ -33,6 +34,10 @@ export class Filters extends Rules {
                 return false;
         return true;
     }
+    get unfiltered() {
+        return { __proto__: Object.getPrototypeOf(this), ...this, _rules: [] };
+    }
+    // Implement `Rule`
     transform(iterable) {
         return this._rules.length ? yieldFiltered(iterable, this) : iterable;
     }

package/query/Query.d.ts

@@ -17,9 +17,11 @@ export declare class Query<T extends Data> extends Rule<T> implements Queryable<
     lte<K extends QueryKey<T>>(key: K, value: K extends "id" ? string : T[K]): this;
     gt<K extends QueryKey<T>>(key: K, value: K extends "id" ? string : T[K]): this;
     gte<K extends QueryKey<T>>(key: K, value: K extends "id" ? string : T[K]): this;
+    get unfiltered(): this;
     match(entry: Entry<T>): boolean;
-    asc(key?: QueryKey<T>): this;
-    desc(key?: QueryKey<T>): this;
+    asc(key: QueryKey<T>): this;
+    desc(key: QueryKey<T>): this;
+    get unsorted(): this;
     rank(left: Entry<T>, right: Entry<T>): number;
     /** Return a new instance of this class with a limit defined. */
     max(limit: number | null): this;

package/query/Query.js

@@ -40,16 +40,22 @@ export class Query extends Rule {
     gte(key, value) {
         return { __proto__: Object.getPrototypeOf(this), ...this, filters: this.filters.gte(key, value) };
     }
+    get unfiltered() {
+        return { __proto__: Object.getPrototypeOf(this), ...this, filters: this.filters.unfiltered };
+    }
     match(entry) {
         return this.filters.match(entry);
     }
     // Implement `Sortable`
-    asc(key = "id") {
+    asc(key) {
         return { __proto__: Object.getPrototypeOf(this), ...this, sorts: this.sorts.asc(key) };
     }
-    desc(key = "id") {
+    desc(key) {
         return { __proto__: Object.getPrototypeOf(this), ...this, sorts: this.sorts.desc(key) };
     }
+    get unsorted() {
+        return { __proto__: Object.getPrototypeOf(this), ...this, sorts: this.sorts.unsorted };
+    }
     rank(left, right) {
         return this.sorts.rank(left, right);
     }

package/query/Sorts.d.ts

@@ -6,6 +6,7 @@ import { Rules } from "./Rules.js";
 export declare class Sorts<T extends Data> extends Rules<T, Sort<T>> implements Sortable<T> {
     asc(key: QueryKey<T>): this;
     desc(key: QueryKey<T>): this;
+    get unsorted(): this;
     rank(left: Entry<T>, right: Entry<T>): number;
     transform(iterable: Results<T>): Results<T>;
 }

package/query/Sorts.js

@@ -3,20 +3,25 @@ import { AscendingSort, DescendingSort } from "./Sort.js";
 import { Rules } from "./Rules.js";
 /** A set of sorts. */
 export class Sorts extends Rules {
+    // Implement `Sortable`
     asc(key) {
         return { __proto__: Object.getPrototypeOf(this), ...this, _rules: [...this._rules, new AscendingSort(key)] };
     }
     desc(key) {
         return { __proto__: Object.getPrototypeOf(this), ...this, _rules: [...this._rules, new DescendingSort(key)] };
     }
+    get unsorted() {
+        return { __proto__: Object.getPrototypeOf(this), ...this, _rules: [] };
+    }
     rank(left, right) {
-        for (const rule of this) {
+        for (const rule of this._rules) {
             const l = rule.rank(left, right);
             if (l !== 0)
                 return l;
         }
         return 0;
     }
+    // Implement `Rule`
     transform(iterable) {
         return this._rules.length ? sortItems(iterable, this) : iterable;
     }

package/query/types.d.ts

@@ -16,6 +16,9 @@ export interface Filterable<T extends Data> extends Matchable<Entry<T>, void> {
     lte<K extends QueryKey<T>>(key: K, value: K extends "id" ? string : T[K]): this;
     gt<K extends QueryKey<T>>(key: K, value: K extends "id" ? string : T[K]): this;
     gte<K extends QueryKey<T>>(key: K, value: K extends "id" ? string : T[K]): this;
+    /** Return a new instance of this class with no sorts specified. */
+    unfiltered: this;
+    /** Match an entry against the filters specified for this object. */
     match(entry: Entry<T>): boolean;
 }
 /**
@@ -24,9 +27,11 @@ export interface Filterable<T extends Data> extends Matchable<Entry<T>, void> {
  */
 export interface Sortable<T extends Data> extends Rankable<Entry<T>> {
     /** Return a new instance of this class with an ascending order sort defined. */
-    asc(key?: QueryKey<T>): this;
+    asc(key: QueryKey<T>): this;
     /** Return a new instance of this class with a descending order sort defined. */
-    desc(key?: QueryKey<T>): this;
+    desc(key: QueryKey<T>): this;
+    /** Return a new instance of this class with no sorts specified. */
+    unsorted: this;
 }
 /** Possible operator references. */
 export declare type SortDirection = "ASC" | "DESC";