shelving 1.37.0 → 1.38.0

package/db/Database.d.ts

@@ -51,9 +51,14 @@ export declare class DataQuery<T extends Data = Data> extends Query<T> implement
     get resultsMap(): ResultsMap<T> | PromiseLike<ResultsMap<T>>;
     /**
      * Count the number of results of this set of documents.
-     * @return Number of documents in the collection (possibly promised).
+     * @return Number of documents matching the query (possibly promised).
      */
     get count(): number | PromiseLike<number>;
+    /**
+     * Does at least one document exist for this query?
+     * @return `true` if a document exists or `false` otherwise (possibly promised).
+     */
+    get exists(): boolean | PromiseLike<boolean>;
     /**
      * Get an entry for the first document matched by this query or `undefined` if this query has no results.
      *
@@ -124,13 +129,11 @@ export declare class DataDocument<T extends Data = Data> implements Observable<R
     get optional(): DataQuery<T>;
     /**
      * Does this document exist?
-     *
-     * @return Document's data, or `undefined` if the document doesn't exist (possibly promised).
+     * @return `true` if a document exists or `false` otherwise (possibly promised).
      */
     get exists(): boolean | PromiseLike<boolean>;
     /**
      * Get the result of this document.
-     *
      * @return Document's data, or `undefined` if the document doesn't exist (possibly promised).
      */
     get result(): Result<T> | PromiseLike<Result<T>>;

package/db/Database.js

@@ -1,4 +1,4 @@
-import { callAsync, getFirstItem, throwAsync, validate, toMap, countItems, TransformObserver, NOT_NULLISH, } from "../util/index.js";
+import { callAsync, getFirstItem, throwAsync, validate, toMap, countItems, TransformObserver, NOT_NULLISH, hasItems, } from "../util/index.js";
 import { DataUpdate, Update } from "../update/index.js";
 import { Feedback, InvalidFeedback } from "../feedback/index.js";
 import { Filters, Query, EqualFilter } from "../query/index.js";
@@ -74,11 +74,18 @@ export class DataQuery extends Query {
     }
     /**
      * Count the number of results of this set of documents.
-     * @return Number of documents in the collection (possibly promised).
+     * @return Number of documents matching the query (possibly promised).
      */
     get count() {
         return callAsync(countItems, this.results);
     }
+    /**
+     * Does at least one document exist for this query?
+     * @return `true` if a document exists or `false` otherwise (possibly promised).
+     */
+    get exists() {
+        return callAsync(hasItems, this.max(1).results);
+    }
     /**
      * Get an entry for the first document matched by this query or `undefined` if this query has no results.
      *
@@ -194,15 +201,13 @@ export class DataDocument {
     }
     /**
      * Does this document exist?
-     *
-     * @return Document's data, or `undefined` if the document doesn't exist (possibly promised).
+     * @return `true` if a document exists or `false` otherwise (possibly promised).
      */
     get exists() {
         return callAsync(Boolean, this.provider.get(this));
     }
     /**
      * Get the result of this document.
-     *
      * @return Document's data, or `undefined` if the document doesn't exist (possibly promised).
      */
     get result() {

package/package.json

@@ -11,7 +11,7 @@
 		"state-management",
 		"query-builder"
 	],
-	"version": "1.37.0",
+	"version": "1.38.0",
 	"repository": "https://github.com/dhoulb/shelving",
 	"author": "Dave Houlbrooke <dave@shax.com>",
 	"license": "0BSD",
@@ -60,12 +60,12 @@
 	},
 	"devDependencies": {
 		"@google-cloud/firestore": "^4.15.1",
-		"@types/jest": "^27.0.3",
-		"@types/react": "^17.0.37",
+		"@types/jest": "^27.4.0",
+		"@types/react": "^17.0.38",
 		"@types/react-dom": "^17.0.11",
-		"@typescript-eslint/eslint-plugin": "^5.7.0",
-		"@typescript-eslint/parser": "^5.7.0",
-		"eslint": "^8.5.0",
+		"@typescript-eslint/eslint-plugin": "^5.8.1",
+		"@typescript-eslint/parser": "^5.8.1",
+		"eslint": "^8.6.0",
 		"eslint-config-prettier": "^8.3.0",
 		"eslint-plugin-import": "^2.25.3",
 		"eslint-plugin-prettier": "^4.0.0",

package/util/iterate.d.ts

@@ -32,6 +32,16 @@ export declare function countItems(items: Iterable<unknown>): number;
  * - Note: this consumes the iterable so you won't be able to use it again.
  */
 export declare function countIterations(items: Iterable<unknown>): number;
+/**
+ * Does an iterable have one or more items.
+ * - Checks `items.size` or `items.length` first, or consumes the iterable and counts its iterations.
+ */
+export declare function hasItems(items: Iterable<unknown>): boolean;
+/**
+ * Does an iterable have one or more items.
+ * - Checks `items.size` or `items.length` first, or consumes the iterable and counts its iterations.
+ */
+export declare function hasIterations(items: Iterable<unknown>): boolean;
 /**
  * Yield a range of numbers from `start` to `end`
  * - Yields in descending order if `end` is lower than `start`

package/util/iterate.js

@@ -32,6 +32,23 @@ export function countIterations(items) {
         count++; // eslint-disable-line @typescript-eslint/no-unused-vars
     return count;
 }
+/**
+ * Does an iterable have one or more items.
+ * - Checks `items.size` or `items.length` first, or consumes the iterable and counts its iterations.
+ */
+export function hasItems(items) {
+    var _a;
+    return !!((_a = getKnownSize(items)) !== null && _a !== void 0 ? _a : hasIterations(items));
+}
+/**
+ * Does an iterable have one or more items.
+ * - Checks `items.size` or `items.length` first, or consumes the iterable and counts its iterations.
+ */
+export function hasIterations(items) {
+    for (const unused of items)
+        return true; // eslint-disable-line @typescript-eslint/no-unused-vars
+    return false;
+}
 /**
  * Yield a range of numbers from `start` to `end`
  * - Yields in descending order if `end` is lower than `start`