@degenerate/generic 0.7.1 → 0.9.1

package/dist/application/database/firestore/path-references/audit-log/create-audit-log-col-ref.js

@@ -1,48 +1,14 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createAuditLogColRef = void 0;
-const admin = __importStar(require("firebase-admin"));
+const firestore_1 = require("firebase-admin/firestore");
 const database_settings_1 = require("../../../../../_settings/database-settings");
-const db = admin.firestore();
 /**
  * This creates the audit log collection reference.
  *
  * @returns the collection reference.
  */
 const createAuditLogColRef = () => {
-    return db.collection(database_settings_1.DatabaseSettingsFirestore.AuditLogs.Collection);
+    return (0, firestore_1.getFirestore)().collection(database_settings_1.DatabaseSettingsFirestore.AuditLogs.Collection);
 };
 exports.createAuditLogColRef = createAuditLogColRef;

package/dist/application/database/index.d.ts

@@ -7,5 +7,6 @@ export * from './firestore/generics/get-items-different-path-on-database';
 export * from './firestore/generics/get-items-from-database';
 export * from './firestore/generics/update-items-on-database';
 export * from './firestore/generics/update-items-properties-on-database';
+export * from './firestore/page-cursor/page-cursor';
 export * from './firestore/path-references/audit-log/create-audit-log-col-ref';
 //# sourceMappingURL=index.d.ts.map

package/dist/application/database/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/application/database/index.ts"],"names":[],"mappings":"AACA,cAAc,4CAA4C,CAAC;AAC3D,cAAc,sDAAsD,CAAC;AACrE,cAAc,yDAAyD,CAAC;AACxE,cAAc,+CAA+C,CAAC;AAC9D,cAAc,6CAA6C,CAAC;AAC5D,cAAc,2DAA2D,CAAC;AAC1E,cAAc,8CAA8C,CAAC;AAC7D,cAAc,+CAA+C,CAAC;AAC9D,cAAc,0DAA0D,CAAC;AAGzE,cAAc,gEAAgE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/application/database/index.ts"],"names":[],"mappings":"AACA,cAAc,4CAA4C,CAAC;AAC3D,cAAc,sDAAsD,CAAC;AACrE,cAAc,yDAAyD,CAAC;AACxE,cAAc,+CAA+C,CAAC;AAC9D,cAAc,6CAA6C,CAAC;AAC5D,cAAc,2DAA2D,CAAC;AAC1E,cAAc,8CAA8C,CAAC;AAC7D,cAAc,+CAA+C,CAAC;AAC9D,cAAc,0DAA0D,CAAC;AAGzE,cAAc,qCAAqC,CAAC;AAGpD,cAAc,gEAAgE,CAAC"}

package/dist/application/database/index.js

@@ -25,6 +25,9 @@ __exportStar(require("./firestore/generics/get-items-from-database"), exports);
 __exportStar(require("./firestore/generics/update-items-on-database"), exports);
 __exportStar(require("./firestore/generics/update-items-properties-on-database"), exports);
 //#endregion firestore generics
+//#region page cursor
+__exportStar(require("./firestore/page-cursor/page-cursor"), exports);
+//#endregion page cursor
 //#region path references
 __exportStar(require("./firestore/path-references/audit-log/create-audit-log-col-ref"), exports);
 //#endregion path references

package/dist/application/index.d.ts

@@ -11,5 +11,6 @@ export * from './database/firestore/generics/get-items-different-path-on-databas
 export * from './database/firestore/generics/get-items-from-database';
 export * from './database/firestore/generics/update-items-on-database';
 export * from './database/firestore/generics/update-items-properties-on-database';
+export * from './database/firestore/page-cursor/page-cursor';
 export * from './database/firestore/path-references/audit-log/create-audit-log-col-ref';
 //# sourceMappingURL=index.d.ts.map

package/dist/application/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/application/index.ts"],"names":[],"mappings":"AAKA,cAAc,uEAAuE,CAAC;AACtF,cAAc,sDAAsD,CAAC;AACrE,cAAc,4DAA4D,CAAC;AAG3E,cAAc,0CAA0C,CAAC;AAUzD,cAAc,qDAAqD,CAAC;AACpE,cAAc,+DAA+D,CAAC;AAC9E,cAAc,kEAAkE,CAAC;AACjF,cAAc,wDAAwD,CAAC;AACvE,cAAc,sDAAsD,CAAC;AACrE,cAAc,oEAAoE,CAAC;AACnF,cAAc,uDAAuD,CAAC;AACtE,cAAc,wDAAwD,CAAC;AACvE,cAAc,mEAAmE,CAAC;AAMlF,cAAc,yEAAyE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/application/index.ts"],"names":[],"mappings":"AAKA,cAAc,uEAAuE,CAAC;AACtF,cAAc,sDAAsD,CAAC;AACrE,cAAc,4DAA4D,CAAC;AAG3E,cAAc,0CAA0C,CAAC;AAUzD,cAAc,qDAAqD,CAAC;AACpE,cAAc,+DAA+D,CAAC;AAC9E,cAAc,kEAAkE,CAAC;AACjF,cAAc,wDAAwD,CAAC;AACvE,cAAc,sDAAsD,CAAC;AACrE,cAAc,oEAAoE,CAAC;AACnF,cAAc,uDAAuD,CAAC;AACtE,cAAc,wDAAwD,CAAC;AACvE,cAAc,mEAAmE,CAAC;AAMlF,cAAc,8CAA8C,CAAC;AAM7D,cAAc,yEAAyE,CAAC"}

package/dist/application/index.js

@@ -36,6 +36,9 @@ __exportStar(require("./database/firestore/generics/get-items-from-database"), e
 __exportStar(require("./database/firestore/generics/update-items-on-database"), exports);
 __exportStar(require("./database/firestore/generics/update-items-properties-on-database"), exports);
 //#endregion Generics
+//#region Page Cursor
+__exportStar(require("./database/firestore/page-cursor/page-cursor"), exports);
+//#endregion Page Cursor
 //#region Path References
 __exportStar(require("./database/firestore/path-references/audit-log/create-audit-log-col-ref"), exports);
 //#endregion Path References

package/dist/authorization/jwt/sign/create-jwt-options.d.ts

@@ -15,8 +15,8 @@ import { AuthorizationAudience, AuthorizationSubject } from '../../../models/aut
 declare const createJwtOptions: (subject: AuthorizationSubject, // the subject of the token
 audience?: AuthorizationAudience | AuthorizationAudience[], // audience
 algorithm?: jwt.Algorithm, // ECDSA using P-521 curve and SHA-512 hash algorithm
-expiresIn?: string | number, // Default expiration time
-notBefore?: string | number, // Default not before time
+expiresIn?: jwt.SignOptions["expiresIn"], // Default expiration time
+notBefore?: jwt.SignOptions["notBefore"], // Default not before time
 keyid?: string, // A unique identifier for the key used to sign the token. This can be used to prevent replay attacks.
 header?: jwt.JwtHeader) => jwt.SignOptions;
 export { createJwtOptions };

package/dist/authorization/jwt/sign/create-jwt-options.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"create-jwt-options.d.ts","sourceRoot":"","sources":["../../../../src/authorization/jwt/sign/create-jwt-options.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,cAAc,CAAC;AAC/B,OAAO,EAAE,qBAAqB,EAAE,oBAAoB,EAAE,MAAM,oDAAoD,CAAC;AAGjH;;;;;;;;;;;GAWG;AACH,QAAA,MAAM,gBAAgB,GAClB,SAAS,oBAAoB,EAAE,2BAA2B;AAC1D,WAAU,qBAAqB,GAAG,qBAAqB,EAAoC,EAAE,WAAW;AACxG,YAAW,GAAG,CAAC,SAAgE,EAAE,qDAAqD;AACtI,YAAW,MAAM,GAAG,MAAmD,EAAE,0BAA0B;AACnG,YAAW,MAAM,GAAG,MAAmD,EAAE,0BAA0B;AACnG,QAAQ,MAAM,EAAE,sGAAsG;AACtH,SAAS,GAAG,CAAC,SAAS,KACvB,GAAG,CAAC,WAkBN,CAAC;AAEF,OAAO,EAAE,gBAAgB,EAAE,CAAC"}
+{"version":3,"file":"create-jwt-options.d.ts","sourceRoot":"","sources":["../../../../src/authorization/jwt/sign/create-jwt-options.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,cAAc,CAAC;AAC/B,OAAO,EAAE,qBAAqB,EAAE,oBAAoB,EAAE,MAAM,oDAAoD,CAAC;AAGjH;;;;;;;;;;;GAWG;AACH,QAAA,MAAM,gBAAgB,GAClB,SAAS,oBAAoB,EAAE,2BAA2B;AAC1D,WAAU,qBAAqB,GAAG,qBAAqB,EAAoC,EAAE,WAAW;AACxG,YAAW,GAAG,CAAC,SAA+C,EAAE,qDAAqD;AACrH,YAAW,GAAG,CAAC,WAAW,CAAC,WAAW,CAA8C,EAAE,0BAA0B;AAChH,YAAW,GAAG,CAAC,WAAW,CAAC,WAAW,CAA8C,EAAE,0BAA0B;AAChH,QAAQ,MAAM,EAAE,sGAAsG;AACtH,SAAS,GAAG,CAAC,SAAS,KACvB,GAAG,CAAC,WAkBN,CAAC;AAEF,OAAO,EAAE,gBAAgB,EAAE,CAAC"}

package/dist/errors/base-error.d.ts

@@ -3,13 +3,15 @@
  */
 export declare class BaseError extends Error {
     errorCode?: number;
+    cause?: unknown;
     /**
      * This is the base error type for the application.
      *
      * @param message the message to include.
      * @param errorCode the error code if we want to include one.
+     * @param cause the error that led to this one, if any.
      */
-    constructor(message: string, errorCode?: number);
+    constructor(message: string, errorCode?: number, cause?: unknown);
     /**
      * This function returns the error as a JSON object.
      */

package/dist/errors/base-error.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"base-error.d.ts","sourceRoot":"","sources":["../../src/errors/base-error.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,qBAAa,SAAU,SAAQ,KAAK;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;IAE1B;;;;;OAKG;gBACS,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM;IAU/C;;OAEG;IACI,MAAM;;;;;;CAQhB"}
+{"version":3,"file":"base-error.d.ts","sourceRoot":"","sources":["../../src/errors/base-error.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,qBAAa,SAAU,SAAQ,KAAK;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,OAAO,CAAC;IAEvB;;;;;;OAMG;gBACS,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,OAAO;IAahE;;OAEG;IACI,MAAM;;;;;;CAQhB"}

package/dist/errors/base-error.js

@@ -10,11 +10,15 @@ class BaseError extends Error {
      *
      * @param message the message to include.
      * @param errorCode the error code if we want to include one.
+     * @param cause the error that led to this one, if any.
      */
-    constructor(message, errorCode) {
+    constructor(message, errorCode, cause) {
         super(message); // Pass the message to the Error constructor
         this.name = this.constructor.name; // Set the name of the error
         this.errorCode = errorCode; // Set the error code
+        if (cause !== undefined) {
+            this.cause = cause; // set here, since the ES2020 lib has no Error options
+        }
         // This line is needed to restore the correct prototype chain.
         // (see note below)
         Object.setPrototypeOf(this, new.target.prototype);

package/dist/errors/database/database-errors.d.ts

@@ -10,6 +10,34 @@ export declare class DatabaseRecordNotFoundError extends BaseError {
      */
     constructor(databasePath: string);
 }
+/**
+ * This is thrown when a page cursor doesn't fit the list being paged.
+ */
+export declare class DatabaseCursorInvalidError extends BaseError {
+    /**
+     * This is thrown when a page cursor doesn't fit the list being paged: the token is malformed,
+     * came from a list with different orderings, doesn't hold one value for each ordering, its
+     * document id isn't a single id, or Firestore can't use one of its values.
+     *
+     * @param collectionPath the path to the collection being listed.
+     * @param cause the error Firestore raised for the cursor, if any.
+     */
+    constructor(collectionPath: string, cause?: unknown);
+}
+/**
+ * This is thrown when a list's filters and order are a combination Firestore can't run.
+ */
+export declare class DatabaseQueryNotSupportedError extends BaseError {
+    /**
+     * This is thrown when a list's filters and order are a combination Firestore can't run, so it
+     * is refused before any read.
+     *
+     * @param collectionPath the path to the collection being listed.
+     * @param reason what makes the combination unsupported.
+     * @param cause the error that led to this one, if any.
+     */
+    constructor(collectionPath: string, reason: string, cause?: unknown);
+}
 /**
  * This is throw when too many database records are found.
  */

package/dist/errors/database/database-errors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"database-errors.d.ts","sourceRoot":"","sources":["../../../src/errors/database/database-errors.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE1C;;GAEG;AACH,qBAAa,2BAA4B,SAAQ,SAAS;IACtD;;;;OAIG;gBACS,YAAY,EAAE,MAAM;CAGnC;AAED;;GAEG;AACH,qBAAa,2BAA4B,SAAQ,SAAS;IACtD;;;;OAIG;gBACS,YAAY,EAAE,MAAM;CAGnC"}
+{"version":3,"file":"database-errors.d.ts","sourceRoot":"","sources":["../../../src/errors/database/database-errors.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE1C;;GAEG;AACH,qBAAa,2BAA4B,SAAQ,SAAS;IACtD;;;;OAIG;gBACS,YAAY,EAAE,MAAM;CAGnC;AAED;;GAEG;AACH,qBAAa,0BAA2B,SAAQ,SAAS;IACrD;;;;;;;OAOG;gBACS,cAAc,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,OAAO;CAGtD;AAED;;GAEG;AACH,qBAAa,8BAA+B,SAAQ,SAAS;IACzD;;;;;;;OAOG;gBACS,cAAc,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,OAAO;CAGtE;AAED;;GAEG;AACH,qBAAa,2BAA4B,SAAQ,SAAS;IACtD;;;;OAIG;gBACS,YAAY,EAAE,MAAM;CAGnC"}

package/dist/errors/database/database-errors.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DatabaseTooManyRecordsError = exports.DatabaseRecordNotFoundError = void 0;
+exports.DatabaseTooManyRecordsError = exports.DatabaseQueryNotSupportedError = exports.DatabaseCursorInvalidError = exports.DatabaseRecordNotFoundError = void 0;
 // This file contains all the errors that are related to database records.
 const base_error_1 = require("../base-error");
 /**
@@ -17,6 +17,40 @@ class DatabaseRecordNotFoundError extends base_error_1.BaseError {
     }
 }
 exports.DatabaseRecordNotFoundError = DatabaseRecordNotFoundError;
+/**
+ * This is thrown when a page cursor doesn't fit the list being paged.
+ */
+class DatabaseCursorInvalidError extends base_error_1.BaseError {
+    /**
+     * This is thrown when a page cursor doesn't fit the list being paged: the token is malformed,
+     * came from a list with different orderings, doesn't hold one value for each ordering, its
+     * document id isn't a single id, or Firestore can't use one of its values.
+     *
+     * @param collectionPath the path to the collection being listed.
+     * @param cause the error Firestore raised for the cursor, if any.
+     */
+    constructor(collectionPath, cause) {
+        super(`The page cursor doesn't fit the list at ${collectionPath}`, undefined, cause);
+    }
+}
+exports.DatabaseCursorInvalidError = DatabaseCursorInvalidError;
+/**
+ * This is thrown when a list's filters and order are a combination Firestore can't run.
+ */
+class DatabaseQueryNotSupportedError extends base_error_1.BaseError {
+    /**
+     * This is thrown when a list's filters and order are a combination Firestore can't run, so it
+     * is refused before any read.
+     *
+     * @param collectionPath the path to the collection being listed.
+     * @param reason what makes the combination unsupported.
+     * @param cause the error that led to this one, if any.
+     */
+    constructor(collectionPath, reason, cause) {
+        super(`The list at ${collectionPath} can't be queried: ${reason}`, undefined, cause);
+    }
+}
+exports.DatabaseQueryNotSupportedError = DatabaseQueryNotSupportedError;
 /**
  * This is throw when too many database records are found.
  */

package/dist/helpers/firestore/firestore-id-helpers.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Whether text is well-formed UTF-16, with no lone surrogate.
+ *
+ * @param text the text to check.
+ * @returns true when every surrogate is part of a pair.
+ */
+declare const isWellFormedText: (text: string) => boolean;
+/**
+ * Whether a field name or id is one Firestore reserves (`__x__`).
+ *
+ * @param name the name to check.
+ * @returns true when Firestore reserves the name.
+ */
+declare const isReservedFirestoreName: (name: string) => boolean;
+/**
+ * Whether a value is one document or collection id Firestore accepts: a well-formed string, not
+ * empty, no '/', not '.', '..' or reserved (`__x__`), and at most 1,500 UTF-8 bytes. Anything else
+ * would be refused by Firestore, or (a lone surrogate) silently name a different document.
+ *
+ * @param value the value to check.
+ * @returns true when the value is a usable Firestore id.
+ */
+declare const isFirestoreDocumentId: (value: unknown) => value is string;
+export { isFirestoreDocumentId, isReservedFirestoreName, isWellFormedText };
+//# sourceMappingURL=firestore-id-helpers.d.ts.map

package/dist/helpers/firestore/firestore-id-helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"firestore-id-helpers.d.ts","sourceRoot":"","sources":["../../../src/helpers/firestore/firestore-id-helpers.ts"],"names":[],"mappings":"AAaA;;;;;GAKG;AACH,QAAA,MAAM,gBAAgB,GAAI,MAAM,MAAM,KAAG,OAAqC,CAAC;AAE/E;;;;;GAKG;AACH,QAAA,MAAM,uBAAuB,GAAI,MAAM,MAAM,KAAG,OAAmC,CAAC;AAEpF;;;;;;;GAOG;AACH,QAAA,MAAM,qBAAqB,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,MAE4D,CAAC;AAEtH,OAAO,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,gBAAgB,EAAE,CAAC"}

package/dist/helpers/firestore/firestore-id-helpers.js

@@ -0,0 +1,39 @@
+"use strict";
+// This file contains the helper functions for Firestore names and document ids.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isWellFormedText = exports.isReservedFirestoreName = exports.isFirestoreDocumentId = void 0;
+// A lone UTF-16 surrogate. JSON can carry one, but no stored string holds one: Firestore replaces it
+// with U+FFFD, so an id holding one names a different document, and a request holding one can fail
+// with an error a transaction retries.
+const LONE_SURROGATE = /[\uD800-\uDBFF](?![\uDC00-\uDFFF])|(?<![\uD800-\uDBFF])[\uDC00-\uDFFF]/;
+// A name Firestore reserves (`__name__`, `__proto__`, ...). [\s\S], not '.', so one with a line
+// terminator inside (`__a\nb__`) is still caught.
+const RESERVED_NAME = /^__[\s\S]*__$/;
+const MAX_ID_BYTES = 1500; // Firestore's limit on a document or collection id
+/**
+ * Whether text is well-formed UTF-16, with no lone surrogate.
+ *
+ * @param text the text to check.
+ * @returns true when every surrogate is part of a pair.
+ */
+const isWellFormedText = (text) => !LONE_SURROGATE.test(text);
+exports.isWellFormedText = isWellFormedText;
+/**
+ * Whether a field name or id is one Firestore reserves (`__x__`).
+ *
+ * @param name the name to check.
+ * @returns true when Firestore reserves the name.
+ */
+const isReservedFirestoreName = (name) => RESERVED_NAME.test(name);
+exports.isReservedFirestoreName = isReservedFirestoreName;
+/**
+ * Whether a value is one document or collection id Firestore accepts: a well-formed string, not
+ * empty, no '/', not '.', '..' or reserved (`__x__`), and at most 1,500 UTF-8 bytes. Anything else
+ * would be refused by Firestore, or (a lone surrogate) silently name a different document.
+ *
+ * @param value the value to check.
+ * @returns true when the value is a usable Firestore id.
+ */
+const isFirestoreDocumentId = (value) => typeof value === 'string' && value !== '' && value !== '.' && value !== '..' && !value.includes('/')
+    && !isReservedFirestoreName(value) && isWellFormedText(value) && Buffer.byteLength(value, 'utf8') <= MAX_ID_BYTES;
+exports.isFirestoreDocumentId = isFirestoreDocumentId;

package/dist/helpers/index.d.ts

@@ -9,5 +9,6 @@ export * from './array/array-helpers';
 export * from './crypto/cryptography-helpers';
 export * from './data/data-helpers';
 export * from './file/file-helpers';
+export * from './firestore/firestore-id-helpers';
 export * from './lodash/lodash-helpers';
 //# sourceMappingURL=index.d.ts.map

package/dist/helpers/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/helpers/index.ts"],"names":[],"mappings":"AACA,cAAc,cAAc,CAAC;AAC7B,cAAc,kBAAkB,CAAC;AACjC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,wBAAwB,CAAC;AAMvC,cAAc,iCAAiC,CAAC;AAChD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,kCAAkC,CAAC;AAKjD,cAAc,uBAAuB,CAAC;AACtC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/helpers/index.ts"],"names":[],"mappings":"AACA,cAAc,cAAc,CAAC;AAC7B,cAAc,kBAAkB,CAAC;AACjC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,wBAAwB,CAAC;AAMvC,cAAc,iCAAiC,CAAC;AAChD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,kCAAkC,CAAC;AAKjD,cAAc,uBAAuB,CAAC;AACtC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,kCAAkC,CAAC;AACjD,cAAc,yBAAyB,CAAC"}

package/dist/helpers/index.js

@@ -30,4 +30,5 @@ __exportStar(require("./array/array-helpers"), exports);
 __exportStar(require("./crypto/cryptography-helpers"), exports);
 __exportStar(require("./data/data-helpers"), exports);
 __exportStar(require("./file/file-helpers"), exports);
+__exportStar(require("./firestore/firestore-id-helpers"), exports);
 __exportStar(require("./lodash/lodash-helpers"), exports);

package/dist/models/application/database/firestore-models.d.ts

@@ -1,5 +1,5 @@
-import * as admin from 'firebase-admin';
 import { z } from 'zod';
+import type { CollectionReference, DocumentReference, FieldPath } from 'firebase-admin/firestore';
 /**
  * This contains the additional information audit logs.
  */
@@ -37,7 +37,7 @@ export declare const IDatabaseChangeInformationSchema: z.ZodObject<{
         profile: "profile";
     }>]>;
     item: z.ZodUnknown;
-    itemDocRef: z.ZodCustom<admin.firestore.DocumentReference<admin.firestore.DocumentData, admin.firestore.DocumentData>, admin.firestore.DocumentReference<admin.firestore.DocumentData, admin.firestore.DocumentData>>;
+    itemDocRef: z.ZodCustom<DocumentReference<FirebaseFirestore.DocumentData, FirebaseFirestore.DocumentData>, DocumentReference<FirebaseFirestore.DocumentData, FirebaseFirestore.DocumentData>>;
 }, z.core.$strip>;
 export type IDatabaseChangeInformation = z.infer<typeof IDatabaseChangeInformationSchema>;
 /**
@@ -60,7 +60,7 @@ export declare const IDatabasePropertyChangeInformationSchema: z.ZodObject<{
         profile: "profile";
     }>]>;
     partialObjectUpdate: z.ZodAny;
-    itemDocRef: z.ZodCustom<admin.firestore.DocumentReference<admin.firestore.DocumentData, admin.firestore.DocumentData>, admin.firestore.DocumentReference<admin.firestore.DocumentData, admin.firestore.DocumentData>>;
+    itemDocRef: z.ZodCustom<DocumentReference<FirebaseFirestore.DocumentData, FirebaseFirestore.DocumentData>, DocumentReference<FirebaseFirestore.DocumentData, FirebaseFirestore.DocumentData>>;
 }, z.core.$strip>;
 export type IDatabasePropertyChangeInformation = z.infer<typeof IDatabasePropertyChangeInformationSchema>;
 /**
@@ -68,7 +68,7 @@ export type IDatabasePropertyChangeInformation = z.infer<typeof IDatabasePropert
  */
 export declare const IDatabaseRecordAndRefSchema: z.ZodObject<{
     record: z.ZodUnknown;
-    recordDocRef: z.ZodCustom<admin.firestore.DocumentReference<admin.firestore.DocumentData, admin.firestore.DocumentData>, admin.firestore.DocumentReference<admin.firestore.DocumentData, admin.firestore.DocumentData>>;
+    recordDocRef: z.ZodCustom<DocumentReference<FirebaseFirestore.DocumentData, FirebaseFirestore.DocumentData>, DocumentReference<FirebaseFirestore.DocumentData, FirebaseFirestore.DocumentData>>;
 }, z.core.$strip>;
 export type IDatabaseRecordAndRef = z.infer<typeof IDatabaseRecordAndRefSchema>;
 /**
@@ -77,7 +77,7 @@ export type IDatabaseRecordAndRef = z.infer<typeof IDatabaseRecordAndRefSchema>;
 export declare const IDatabaseUpdatesSchema: z.ZodObject<{
     recordsandRefs: z.ZodArray<z.ZodObject<{
         record: z.ZodUnknown;
-        recordDocRef: z.ZodCustom<admin.firestore.DocumentReference<admin.firestore.DocumentData, admin.firestore.DocumentData>, admin.firestore.DocumentReference<admin.firestore.DocumentData, admin.firestore.DocumentData>>;
+        recordDocRef: z.ZodCustom<DocumentReference<FirebaseFirestore.DocumentData, FirebaseFirestore.DocumentData>, DocumentReference<FirebaseFirestore.DocumentData, FirebaseFirestore.DocumentData>>;
     }, z.core.$strip>>;
     auditLogInfo: z.ZodObject<{
         additionalAuditLogIds: z.ZodArray<z.ZodObject<{
@@ -147,7 +147,7 @@ export declare const IDatabaseGetItemSchema: z.ZodObject<{
     }>, z.ZodEnum<{
         profile: "profile";
     }>]>;
-    itemDocRef: z.ZodCustom<admin.firestore.DocumentReference<admin.firestore.DocumentData, admin.firestore.DocumentData>, admin.firestore.DocumentReference<admin.firestore.DocumentData, admin.firestore.DocumentData>>;
+    itemDocRef: z.ZodCustom<DocumentReference<FirebaseFirestore.DocumentData, FirebaseFirestore.DocumentData>, DocumentReference<FirebaseFirestore.DocumentData, FirebaseFirestore.DocumentData>>;
     throwErrorOnNotFound: z.ZodBoolean;
 }, z.core.$strip>;
 export type IDatabaseGetItem = z.infer<typeof IDatabaseGetItemSchema>;
@@ -155,7 +155,7 @@ export type IDatabaseGetItem = z.infer<typeof IDatabaseGetItemSchema>;
  * This contains the information that is needed to get information from the database.
  */
 export declare const IDatabaseOrderBySchema: z.ZodObject<{
-    fieldPath: z.ZodUnion<readonly [z.ZodString, z.ZodCustom<admin.firestore.FieldPath, admin.firestore.FieldPath>]>;
+    fieldPath: z.ZodUnion<readonly [z.ZodString, z.ZodCustom<FieldPath, FieldPath>]>;
     direction: z.ZodEnum<{
         desc: "desc";
         asc: "asc";
@@ -166,7 +166,7 @@ export type IDatabaseOrderBy = z.infer<typeof IDatabaseOrderBySchema>;
  * This contains the query information for the database if it is required
  */
 export declare const IDatabaseQueryFieldsSchema: z.ZodObject<{
-    fieldPath: z.ZodUnion<readonly [z.ZodString, z.ZodCustom<admin.firestore.FieldPath, admin.firestore.FieldPath>]>;
+    fieldPath: z.ZodUnion<readonly [z.ZodString, z.ZodCustom<FieldPath, FieldPath>]>;
     opStr: z.ZodEnum<{
         "<": "<";
         "<=": "<=";
@@ -182,6 +182,20 @@ export declare const IDatabaseQueryFieldsSchema: z.ZodObject<{
     value: z.ZodAny;
 }, z.core.$strip>;
 export type IDatabaseQueryFields = z.infer<typeof IDatabaseQueryFieldsSchema>;
+/**
+ * A page cursor: an opaque token that getItemsFromDatabase returns as a page's nextCursor. Pass it
+ * back unchanged, with the same filters and orderBy, for the next page. It is a plain string of
+ * URL-safe characters, about 4/3 the size of the last item's ordered values as tagged JSON plus the
+ * list's field paths, and inside it those values keep their Firestore types. A small cursor fits
+ * a URL or JSON body; a large one may not (a default express.json() body takes about 100 KB, a URL
+ * or header about 16 KiB), so size the transport for the ordered fields in use.
+ *
+ * Opaque is not secret: the token is encoded, not encrypted. It holds the last item's value for
+ * every field the list is ordered by (its orderBy and every inequality filter's field), and those
+ * fields' names. Only hand a cursor to someone who may see those values for that item.
+ */
+export declare const IDatabasePageCursorSchema: z.ZodString;
+export type IDatabasePageCursor = z.infer<typeof IDatabasePageCursorSchema>;
 /**
  * This contains the information that is needed to get multiple items from the database.
  */
@@ -199,17 +213,17 @@ export declare const IDatabaseGetInformationSchema: z.ZodObject<{
     }>, z.ZodEnum<{
         profile: "profile";
     }>]>;
-    itemColRef: z.ZodCustom<admin.firestore.CollectionReference<admin.firestore.DocumentData, admin.firestore.DocumentData>, admin.firestore.CollectionReference<admin.firestore.DocumentData, admin.firestore.DocumentData>>;
-    lastId: z.ZodString;
+    itemColRef: z.ZodCustom<CollectionReference<FirebaseFirestore.DocumentData, FirebaseFirestore.DocumentData>, CollectionReference<FirebaseFirestore.DocumentData, FirebaseFirestore.DocumentData>>;
+    cursor: z.ZodOptional<z.ZodString>;
     orderBy: z.ZodOptional<z.ZodObject<{
-        fieldPath: z.ZodUnion<readonly [z.ZodString, z.ZodCustom<admin.firestore.FieldPath, admin.firestore.FieldPath>]>;
+        fieldPath: z.ZodUnion<readonly [z.ZodString, z.ZodCustom<FieldPath, FieldPath>]>;
         direction: z.ZodEnum<{
             desc: "desc";
             asc: "asc";
         }>;
     }, z.core.$strip>>;
     queryFields: z.ZodArray<z.ZodObject<{
-        fieldPath: z.ZodUnion<readonly [z.ZodString, z.ZodCustom<admin.firestore.FieldPath, admin.firestore.FieldPath>]>;
+        fieldPath: z.ZodUnion<readonly [z.ZodString, z.ZodCustom<FieldPath, FieldPath>]>;
         opStr: z.ZodEnum<{
             "<": "<";
             "<=": "<=";
@@ -225,8 +239,15 @@ export declare const IDatabaseGetInformationSchema: z.ZodObject<{
         value: z.ZodAny;
     }, z.core.$strip>>;
     isMaxSizeDocumentSet: z.ZodOptional<z.ZodBoolean>;
-}, z.core.$strip>;
+}, z.core.$strict>;
 export type IDatabaseGetInformation = z.infer<typeof IDatabaseGetInformationSchema>;
+/**
+ * A page of items from the database, and the cursor that starts the next page.
+ */
+export interface IDatabasePage<T> {
+    items: T[];
+    nextCursor?: IDatabasePageCursor;
+}
 /**
  * This contains the information to delete a single item from the database.
  */
@@ -244,7 +265,7 @@ export declare const IDatabaseDeleteItemSchema: z.ZodObject<{
     }>, z.ZodEnum<{
         profile: "profile";
     }>]>;
-    itemDocRef: z.ZodCustom<admin.firestore.DocumentReference<admin.firestore.DocumentData, admin.firestore.DocumentData>, admin.firestore.DocumentReference<admin.firestore.DocumentData, admin.firestore.DocumentData>>;
+    itemDocRef: z.ZodCustom<DocumentReference<FirebaseFirestore.DocumentData, FirebaseFirestore.DocumentData>, DocumentReference<FirebaseFirestore.DocumentData, FirebaseFirestore.DocumentData>>;
     throwErrorOnNotFound: z.ZodBoolean;
 }, z.core.$strip>;
 export type IDatabaseDeleteItem = z.infer<typeof IDatabaseDeleteItemSchema>;

package/dist/models/application/database/firestore-models.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"firestore-models.d.ts","sourceRoot":"","sources":["../../../../src/models/application/database/firestore-models.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,gBAAgB,CAAC;AACxC,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAWxB;;GAEG;AAEH,eAAO,MAAM,8BAA8B;;;;;;;;;;;;;;iBAGzC,CAAC;AAEH,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,CAAC;AAMtF;;GAEG;AACH,eAAO,MAAM,gCAAgC;;;;;;;;;;;;;;;;iBAK3C,CAAC;AAEH,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gCAAgC,CAAC,CAAC;AAE1F;;;;GAIG;AACH,eAAO,MAAM,wCAAwC;;;;;;;;;;;;;;;;iBAKnD,CAAC;AAEH,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wCAAwC,CAAC,CAAC;AAE1G;;GAEG;AACH,eAAO,MAAM,2BAA2B;;;iBAGtC,CAAC;AAEH,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAEhF;;GAEG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAGjC,CAAC;AAEH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAQtE,eAAO,MAAM,sBAAsB;;;EAA0B,CAAC;AAG9D,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAGtE,eAAO,MAAM,mBAAmB;;;;;;;;;;;EAA8G,CAAA;AAC9I,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEhE;;GAEG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;iBAGjC,CAAC;AAEH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAEtE;;GAEG;AACH,eAAO,MAAM,sBAAsB;;;;;;iBAGjC,CAAC;AAGH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AACtE;;GAEG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;iBAIrC,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAG9E;;GAEG;AACH,eAAO,MAAM,6BAA6B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAMxC,CAAC;AAGH,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,6BAA6B,CAAC,CAAC;AAOpF;;GAEG;AACH,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;iBAGpC,CAAC;AAEH,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC"}
+{"version":3,"file":"firestore-models.d.ts","sourceRoot":"","sources":["../../../../src/models/application/database/firestore-models.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,KAAK,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AA8DlG;;GAEG;AAEH,eAAO,MAAM,8BAA8B;;;;;;;;;;;;;;iBAGzC,CAAC;AAEH,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,CAAC;AAMtF;;GAEG;AACH,eAAO,MAAM,gCAAgC;;;;;;;;;;;;;;;;iBAK3C,CAAC;AAEH,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gCAAgC,CAAC,CAAC;AAE1F;;;;GAIG;AACH,eAAO,MAAM,wCAAwC;;;;;;;;;;;;;;;;iBAKnD,CAAC;AAEH,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wCAAwC,CAAC,CAAC;AAE1G;;GAEG;AACH,eAAO,MAAM,2BAA2B;;;iBAGtC,CAAC;AAEH,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAEhF;;GAEG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAGjC,CAAC;AAEH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAQtE,eAAO,MAAM,sBAAsB;;;EAA0B,CAAC;AAG9D,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAGtE,eAAO,MAAM,mBAAmB;;;;;;;;;;;EAA8G,CAAA;AAC9I,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEhE;;GAEG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;iBAGjC,CAAC;AAEH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAEtE;;GAEG;AACH,eAAO,MAAM,sBAAsB;;;;;;iBAGjC,CAAC;AAGH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AACtE;;GAEG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;iBAIrC,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAG9E;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,yBAAyB,aAA8E,CAAC;AAErH,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAE5E;;GAEG;AACH,eAAO,MAAM,6BAA6B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAM/B,CAAC;AAGZ,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,6BAA6B,CAAC,CAAC;AAEpF;;GAEG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC;IAC5B,KAAK,EAAE,CAAC,EAAE,CAAC;IACX,UAAU,CAAC,EAAE,mBAAmB,CAAC;CACpC;AAOD;;GAEG;AACH,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;iBAGpC,CAAC;AAEH,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC"}