@degenerate/generic 0.7.1 → 0.9.1

package/LICENSE.md

@@ -1,63 +1,15 @@
-# LICENSE
+ISC License
 
-## Open-Source License: Apache License 2.0
+Copyright (c) 2024-2026 Degenerate Inc.
 
-Copyright (c) [2024], [Degenerateiinc.ca]
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
 
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at:
-
-[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-
-## Additional Terms for Proprietary Extensions and Features
-
-The SAFE Platform includes features and functionalities that may extend beyond the open-source scope of this license, including but not limited to:
-
-1. **Advanced Enterprise Features**:
-   - Modules and tools tailored for enterprise-level scalability, security, and analytics.
-   - Customizable AI-driven extensions designed for high-volume data processing and decision-making.
-   - Separate licensing agreements are required for accessing these features.
-
-2. **Marketplace Components**:
-   - Extensions, plugins, and templates available through the SAFE Marketplace may include specific licensing terms.
-   - Revenue-sharing agreements apply for developers contributing paid components to the Marketplace.
-   - Use of these components may require additional payments or subscription plans.
-
-3. **Partnered Integrations**:
-   - SAFE Platform offers pre-integrated solutions with third-party platforms such as CRM systems, payment gateways, or cloud services.
-   - These integrations may require accepting additional terms from the third-party providers.
-   - Usage is governed by both this License and the third-party terms where applicable.
-
-4. **Subscription-Based Analytics**:
-   - Advanced analytics features, including real-time data insights, AI model performance metrics, and user behavior analysis.
-   - These are provided through subscription services managed under proprietary agreements.
-   - Subscriptions may include tiered pricing based on data volume, number of users, or access levels.
-
-5. **Industry-Specific Solutions**:
-   - SAFE Platform provides pre-configured templates and rules tailored for industries such as finance, healthcare, and logistics.
-   - These solutions include proprietary intellectual property that is not covered by the open-source license.
-   - Licensing agreements specify terms for usage and redistribution of these industry-specific components.
-
-By using the SAFE Platform, you agree to abide by these additional terms where applicable. For more details, contact [Your Organization's Contact Information].
-
-## Contribution and Use
-
-1. **Community Contributions**:
-   - Contributions to the SAFE Platform's open-source repository are governed by the Apache License 2.0.
-   - By submitting a contribution, you agree that your work will be licensed under this license.
-   - Contributions must adhere to the project's coding standards and submission guidelines.
-
-2. **Proprietary Extensions**:
-   - Contributions extending into proprietary areas require pre-approval by the administrators in the .
-   - These contributions may be subject to separate agreements defining revenue sharing, ownership rights, and maintenance responsibilities.
-
-## Notices
-
-This license file is intended to reflect a hybrid open-source and proprietary model for the SAFE Platform. It provides clarity for both community contributors and commercial users. For specific questions or legal inquiries, contact [Your Organization's Contact Information].
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -18,3 +18,18 @@ To install the `@degenerate/generic` package, use the following command:
 npm install @degenerate/generic
 ```
 
+`firebase-admin` (13.9+ or 14; 14.4+ recommended, because earlier releases pull in a `uuid`
+with a moderate advisory, GHSA-w5hq-g745-h8pq) is an **optional peer dependency**: the package uses your app's copy
+rather than bundling its own, so it works with the Firebase app you initialize. Install it yourself if
+you use the Firestore models (`IDatabase*`); package managers don't add an optional peer for you. The
+package loads without it: the Firestore classes are only loaded when one of those schemas checks a
+value, and without firebase-admin that check fails. Only the modular entry points are used
+(`firebase-admin/firestore`), which both majors ship, and nothing opens Firestore while the package
+loads.
+
+That's at runtime. The type declarations still import Firestore's types from
+`firebase-admin/firestore`, so a TypeScript project that compiles against this package needs
+firebase-admin installed, at least as a dev dependency. Without it, `tsc` reports TS2307 (Cannot
+find module 'firebase-admin/firestore') under `skipLibCheck: false`. Under `skipLibCheck: true` it
+compiles, but the Firestore-typed fields of the `IDatabase*` models become `any`.
+

package/dist/_settings/application-settings.d.ts

@@ -8,6 +8,7 @@ export declare const ApplicationSettings: {
         MaxSnapshotSizeLargeDocSet: number;
         MaxStorageRecordsPerDoc: number;
         MaxDocumentsToDeleteInBatch: number;
+        MaxPageCursorLength: number;
     };
     SystemUser: string;
 };

package/dist/_settings/application-settings.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"application-settings.d.ts","sourceRoot":"","sources":["../../src/_settings/application-settings.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;CAS/B,CAAC"}
+{"version":3,"file":"application-settings.d.ts","sourceRoot":"","sources":["../../src/_settings/application-settings.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;;CAc/B,CAAC"}

package/dist/_settings/application-settings.js

@@ -11,6 +11,11 @@ exports.ApplicationSettings = {
         MaxSnapshotSizeLargeDocSet: 5, // the maximum number of snapshots to execute aka, store or retrieve in one request for a large document set.
         MaxStorageRecordsPerDoc: 20, // the maximum number of records to store on a document.
         MaxDocumentsToDeleteInBatch: 100, // the maximum number of documents to delete in a batch.
+        // the longest page cursor token accepted. Enough for most ordered values (a 1 MiB string,
+        // even JSON-escaped, fits), but not all: values Firestore stores small and that encode large
+        // (millions of empty Bytes), or overlapping orderings (a and a.b), can exceed it, and the
+        // list then refuses that page with DatabaseQueryNotSupportedError.
+        MaxPageCursorLength: 16 * 1024 * 1024,
     },
     SystemUser: 'System', // the system user
 };

package/dist/_settings/authorization-settings.d.ts

@@ -3,8 +3,8 @@
  */
 export declare const AuthorizationSettings: {
     JWT: {
-        Algorithm: string;
-        ExpiresInDefault: string;
+        Algorithm: "ES512";
+        ExpiresInDefault: "1h";
         NotBeforeDefault: number;
         EncodingDefault: string;
         MutatePayload: boolean;

package/dist/application/database/firestore/generics/add-items-to-database.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"add-items-to-database.d.ts","sourceRoot":"","sources":["../../../../../src/application/database/firestore/generics/add-items-to-database.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,0BAA0B,EAAE,MAAM,0DAA0D,CAAC;AAEtG,OAAO,EAAmC,uBAAuB,EAAiC,MAAM,uEAAuE,CAAC;AAEhL;;;;;;;GAOG;AACH,QAAA,MAAM,kBAAkB,GACpB,2BAA2B,0BAA0B,EAAE,EACvD,QAAQ,MAAM,EACd,0BAAyB,uBAAmE,KAC7F,OAAO,CAAC,IAAI,CAed,CAAC;AAEF,OAAO,EAAE,kBAAkB,EAAE,CAAC"}
+{"version":3,"file":"add-items-to-database.d.ts","sourceRoot":"","sources":["../../../../../src/application/database/firestore/generics/add-items-to-database.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,0BAA0B,EAAE,MAAM,0DAA0D,CAAC;AAEtG,OAAO,EAAmC,uBAAuB,EAAiC,MAAM,uEAAuE,CAAC;AAChL;;;;;;;GAOG;AACH,QAAA,MAAM,kBAAkB,GACpB,2BAA2B,0BAA0B,EAAE,EACvD,QAAQ,MAAM,EACd,0BAAyB,uBAAmE,KAC7F,OAAO,CAAC,IAAI,CAed,CAAC;AAEF,OAAO,EAAE,kBAAkB,EAAE,CAAC"}

package/dist/application/database/firestore/generics/add-items-to-database.js

@@ -1,44 +1,10 @@
 "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.addItemsToDatabase = void 0;
-const admin = __importStar(require("firebase-admin"));
+const firestore_1 = require("firebase-admin/firestore");
 const create_audit_log_col_ref_1 = require("../path-references/audit-log/create-audit-log-col-ref");
 const create_application_audit_log_1 = require("../../../audit-log/create-application-audit-log");
 const application_audit_log_models_1 = require("../../../../models/application/audit-log/application-audit-log-models");
-const db = admin.firestore();
 /**
  * this function adds an item to the database.
  *
@@ -50,7 +16,7 @@ const db = admin.firestore();
 const addItemsToDatabase = async (databaseChangeInformation, userId, applicationAuditLogType = application_audit_log_models_1.ApplicationAuditLogTypeSchema.enum.global) => {
     const auditLogColRef = (0, create_audit_log_col_ref_1.createAuditLogColRef)(); // create the audit log collection reference
     // create the new records in the database
-    await db.runTransaction(async (t) => {
+    await (0, firestore_1.getFirestore)().runTransaction(async (t) => {
         for (const changeRecords of databaseChangeInformation) {
             // create the audit log
             const auditLog = (0, create_application_audit_log_1.createApplicationAuditLog)(application_audit_log_models_1.ApplicationAuditLogActionSchema.enum.create, changeRecords.auditLogSubType, userId, applicationAuditLogType, changeRecords.alai, changeRecords.item, undefined);

package/dist/application/database/firestore/generics/add-or-update-items-to-database.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"add-or-update-items-to-database.d.ts","sourceRoot":"","sources":["../../../../../src/application/database/firestore/generics/add-or-update-items-to-database.ts"],"names":[],"mappings":"AACA,OAAO,EAEH,uBAAuB,EAG1B,MAAM,uEAAuE,CAAC;AAG/E,OAAO,EAAE,0BAA0B,EAAE,MAAM,0DAA0D,CAAC;AAGtG;;;;;;;GAOG;AACH,QAAA,MAAM,0BAA0B,GAAU,CAAC,EACvC,uBAAuB,0BAA0B,EAAE,EACnD,QAAQ,MAAM,EACd,0BAAyB,uBAAmE,KAC7F,OAAO,CAAC,IAAI,CAoCd,CAAC;AAEF,OAAO,EAAE,0BAA0B,EAAE,CAAC"}
+{"version":3,"file":"add-or-update-items-to-database.d.ts","sourceRoot":"","sources":["../../../../../src/application/database/firestore/generics/add-or-update-items-to-database.ts"],"names":[],"mappings":"AACA,OAAO,EAEH,uBAAuB,EAG1B,MAAM,uEAAuE,CAAC;AAG/E,OAAO,EAAE,0BAA0B,EAAE,MAAM,0DAA0D,CAAC;AACtG;;;;;;;GAOG;AACH,QAAA,MAAM,0BAA0B,GAAU,CAAC,EACvC,uBAAuB,0BAA0B,EAAE,EACnD,QAAQ,MAAM,EACd,0BAAyB,uBAAmE,KAC7F,OAAO,CAAC,IAAI,CAoCd,CAAC;AAEF,OAAO,EAAE,0BAA0B,EAAE,CAAC"}

package/dist/application/database/firestore/generics/add-or-update-items-to-database.js

@@ -1,44 +1,10 @@
 "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.addOrUpdateItemsToDatabase = void 0;
-const admin = __importStar(require("firebase-admin"));
+const firestore_1 = require("firebase-admin/firestore");
 const application_audit_log_models_1 = require("../../../../models/application/audit-log/application-audit-log-models");
 const create_audit_log_col_ref_1 = require("../path-references/audit-log/create-audit-log-col-ref");
 const create_application_audit_log_1 = require("../../../audit-log/create-application-audit-log");
-const db = admin.firestore();
 /**
  * This adds the items to the database if they do not exist, if they do exist then it updates the items.
  *
@@ -49,7 +15,7 @@ const db = admin.firestore();
  */
 const addOrUpdateItemsToDatabase = async (databaseChangeRecords, userId, applicationAuditLogType = application_audit_log_models_1.ApplicationAuditLogTypeSchema.enum.global) => {
     // loop the transaction and update the database
-    await db.runTransaction(async (t) => {
+    await (0, firestore_1.getFirestore)().runTransaction(async (t) => {
         const auditLogUpdates = []; // create an array of audit log updates
         const updatedRecord = []; // create an array of updated records
         // get the existing records from the database

package/dist/application/database/firestore/generics/delete-items-on-database.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"delete-items-on-database.d.ts","sourceRoot":"","sources":["../../../../../src/application/database/firestore/generics/delete-items-on-database.ts"],"names":[],"mappings":"AAEA,OAAO,EAEH,uBAAuB,EAE1B,MAAM,uEAAuE,CAAC;AAC/E,OAAO,EAAE,mBAAmB,EAAE,MAAM,0DAA0D,CAAC;AAM/F;;;;;;;GAOG;AACH,QAAA,MAAM,qBAAqB,GACvB,qBAAqB,mBAAmB,EAAE,EAC1C,QAAQ,MAAM,EACd,0BAAyB,uBAAmE,KAC7F,OAAO,CAAC,IAAI,CA2Bd,CAAC;AAEF,OAAO,EAAE,qBAAqB,EAAE,CAAC"}
+{"version":3,"file":"delete-items-on-database.d.ts","sourceRoot":"","sources":["../../../../../src/application/database/firestore/generics/delete-items-on-database.ts"],"names":[],"mappings":"AAEA,OAAO,EAEH,uBAAuB,EAE1B,MAAM,uEAAuE,CAAC;AAC/E,OAAO,EAAE,mBAAmB,EAAE,MAAM,0DAA0D,CAAC;AAI/F;;;;;;;GAOG;AACH,QAAA,MAAM,qBAAqB,GACvB,qBAAqB,mBAAmB,EAAE,EAC1C,QAAQ,MAAM,EACd,0BAAyB,uBAAmE,KAC7F,OAAO,CAAC,IAAI,CA2Bd,CAAC;AAEF,OAAO,EAAE,qBAAqB,EAAE,CAAC"}

package/dist/application/database/firestore/generics/delete-items-on-database.js

@@ -1,45 +1,11 @@
 "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.deleteItemsOnDatabase = void 0;
-const admin = __importStar(require("firebase-admin"));
+const firestore_1 = require("firebase-admin/firestore");
 const create_audit_log_col_ref_1 = require("../path-references/audit-log/create-audit-log-col-ref");
 const application_audit_log_models_1 = require("../../../../models/application/audit-log/application-audit-log-models");
 const create_application_audit_log_1 = require("../../../audit-log/create-application-audit-log");
 const database_errors_1 = require("../../../../errors/database/database-errors");
-const db = admin.firestore();
 /**
  * This deletes the items on the database.
  *
@@ -51,7 +17,7 @@ const db = admin.firestore();
 const deleteItemsOnDatabase = async (databaseDeleteItems, userId, applicationAuditLogType = application_audit_log_models_1.ApplicationAuditLogTypeSchema.enum.global) => {
     const auditLogColRef = (0, create_audit_log_col_ref_1.createAuditLogColRef)(); // create the audit log collection reference
     // create the new records in the database
-    await db.runTransaction(async (t) => {
+    await (0, firestore_1.getFirestore)().runTransaction(async (t) => {
         const existingRecords = []; // the existing records in the database, get these for the audit logs and throw error on not foudn checks
         for (const changeRecords of databaseDeleteItems) {
             const existingRecordSnap = await t.get(changeRecords.itemDocRef);

package/dist/application/database/firestore/generics/get-item-from-database.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"get-item-from-database.d.ts","sourceRoot":"","sources":["../../../../../src/application/database/firestore/generics/get-item-from-database.ts"],"names":[],"mappings":"AAGA,OAAO,EAEH,uBAAuB,EAE1B,MAAM,uEAAuE,CAAC;AAC/E,OAAO,EAAE,gBAAgB,EAAE,MAAM,0DAA0D,CAAC;AAG5F;;;;;;;GAOG;AACH,QAAA,MAAM,mBAAmB,GAAU,CAAC,EAChC,SAAS,gBAAgB,EACzB,QAAQ,MAAM,EACd,0BAAyB,uBAAmE,KAC7F,OAAO,CAAC,CAAC,GAAG,SAAS,CAgBvB,CAAC;AAEF,OAAO,EAAE,mBAAmB,EAAE,CAAC"}
+{"version":3,"file":"get-item-from-database.d.ts","sourceRoot":"","sources":["../../../../../src/application/database/firestore/generics/get-item-from-database.ts"],"names":[],"mappings":"AAGA,OAAO,EAEH,uBAAuB,EAE1B,MAAM,uEAAuE,CAAC;AAC/E,OAAO,EAAE,gBAAgB,EAAE,MAAM,0DAA0D,CAAC;AAE5F;;;;;;;GAOG;AACH,QAAA,MAAM,mBAAmB,GAAU,CAAC,EAChC,SAAS,gBAAgB,EACzB,QAAQ,MAAM,EACd,0BAAyB,uBAAmE,KAC7F,OAAO,CAAC,CAAC,GAAG,SAAS,CAgBvB,CAAC;AAEF,OAAO,EAAE,mBAAmB,EAAE,CAAC"}

package/dist/application/database/firestore/generics/get-item-from-database.js

@@ -1,45 +1,11 @@
 "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.getItemFromDatabase = void 0;
-const admin = __importStar(require("firebase-admin"));
+const firestore_1 = require("firebase-admin/firestore");
 const create_audit_log_col_ref_1 = require("../path-references/audit-log/create-audit-log-col-ref");
 const database_errors_1 = require("../../../../errors/database/database-errors");
 const application_audit_log_models_1 = require("../../../../models/application/audit-log/application-audit-log-models");
 const create_application_audit_log_1 = require("../../../audit-log/create-application-audit-log");
-const db = admin.firestore();
 /**
  * This gets a single item from the database
  *
@@ -52,7 +18,7 @@ const getItemFromDatabase = async (getItem, userId, applicationAuditLogType = ap
     const auditLogRef = (0, create_audit_log_col_ref_1.createAuditLogColRef)(); // create the audit log reference
     // create the audit log information
     const auditLog = (0, create_application_audit_log_1.createApplicationAuditLog)(application_audit_log_models_1.ApplicationAuditLogActionSchema.enum.read, getItem.auditLogSubType, userId, applicationAuditLogType, getItem.alai, undefined, undefined);
-    const itemData = await db.runTransaction(async (t) => {
+    const itemData = await (0, firestore_1.getFirestore)().runTransaction(async (t) => {
         const connectedSnap = await t.get(getItem.itemDocRef); // get the connected snap
         t.create(auditLogRef.doc(), auditLog); // add the audit log to the database.
         return connectedSnap.data();

package/dist/application/database/firestore/generics/get-items-different-path-on-database.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"get-items-different-path-on-database.d.ts","sourceRoot":"","sources":["../../../../../src/application/database/firestore/generics/get-items-different-path-on-database.ts"],"names":[],"mappings":"AAEA,OAAO,EAEH,uBAAuB,EAG1B,MAAM,uEAAuE,CAAC;AAI/E;;;;;;;GAOG;AACH,QAAA,MAAM,gCAAgC,GAAU,CAAC,EAC7C,eAAe,MAAM,EAAE,EACvB,QAAQ,MAAM,EACd,0BAAyB,uBAAmE,KAC7F,OAAO,CAAC,CAAC,EAAE,CA2Bb,CAAC;AAEF,OAAO,EAAE,gCAAgC,EAAE,CAAC"}
+{"version":3,"file":"get-items-different-path-on-database.d.ts","sourceRoot":"","sources":["../../../../../src/application/database/firestore/generics/get-items-different-path-on-database.ts"],"names":[],"mappings":"AAEA,OAAO,EAEH,uBAAuB,EAG1B,MAAM,uEAAuE,CAAC;AAG/E;;;;;;;GAOG;AACH,QAAA,MAAM,gCAAgC,GAAU,CAAC,EAC7C,eAAe,MAAM,EAAE,EACvB,QAAQ,MAAM,EACd,0BAAyB,uBAAmE,KAC7F,OAAO,CAAC,CAAC,EAAE,CA2Bb,CAAC;AAEF,OAAO,EAAE,gCAAgC,EAAE,CAAC"}

package/dist/application/database/firestore/generics/get-items-different-path-on-database.js

@@ -1,45 +1,11 @@
 "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.getItemsDifferentPathsOnDatabase = void 0;
-const admin = __importStar(require("firebase-admin"));
+const firestore_1 = require("firebase-admin/firestore");
 const create_audit_log_col_ref_1 = require("../path-references/audit-log/create-audit-log-col-ref");
 const application_audit_log_models_1 = require("../../../../models/application/audit-log/application-audit-log-models");
 const create_multiple_path_alai_1 = require("../../../audit-log/additional-ids/create-multiple-path-alai");
 const create_application_audit_log_1 = require("../../../audit-log/create-application-audit-log");
-const db = admin.firestore();
 /**
  * This function gets the items from different paths on the database.
  *
@@ -53,7 +19,7 @@ const getItemsDifferentPathsOnDatabase = async (documentPaths, userId, applicati
     // create the promisees for the documents.
     const documentPromises = [];
     for (const documentPath of documentPaths) {
-        documentPromises.push(db.doc(documentPath).get());
+        documentPromises.push((0, firestore_1.getFirestore)().doc(documentPath).get());
     }
     // create the audit log additional ids information
     const alai = (0, create_multiple_path_alai_1.createMultiplePathALAI)(documentPaths);

package/dist/application/database/firestore/generics/get-items-from-database.d.ts

@@ -1,14 +1,19 @@
 import { ApplicationAuditLogType } from '../../../../models/application/audit-log/application-audit-log-models';
-import { IDatabaseGetInformation } from '../../../../models/application/database/firestore-models';
+import { IDatabaseGetInformation, IDatabasePage } from '../../../../models/application/database/firestore-models';
 /**
- * This function queries the database and returns the items or an empty array.
+ * This function queries the database and returns a page of items, and the cursor for the next page.
  *
  * @param getInformation the get information (instructions for this function)
  * @param userId the user ID performing the action
  * @param applicationAuditLogType the type of audit log to create
  * @param <T> the type of the items to return
- * @returns
+ * @returns the page's items, and nextCursor when more items follow
+ * @throws {DatabaseQueryNotSupportedError} when the list's filters and order can't be run (a bad
+ *     field path, or a filter value the SDK refuses while building the query, such as undefined),
+ *     or the last item's ordered values can't be held in a page cursor. A value the SDK only
+ *     refuses when it serializes the request (a function, say) surfaces as the SDK's own error.
+ * @throws {DatabaseCursorInvalidError} when the cursor is malformed or came from another list.
  */
-declare const getItemsFromDatabase: <T>(userId: string, getInformation: IDatabaseGetInformation, applicationAuditLogType?: ApplicationAuditLogType) => Promise<T[]>;
+declare const getItemsFromDatabase: <T>(userId: string, getInformation: IDatabaseGetInformation, applicationAuditLogType?: ApplicationAuditLogType) => Promise<IDatabasePage<T>>;
 export { getItemsFromDatabase };
 //# sourceMappingURL=get-items-from-database.d.ts.map

package/dist/application/database/firestore/generics/get-items-from-database.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"get-items-from-database.d.ts","sourceRoot":"","sources":["../../../../../src/application/database/firestore/generics/get-items-from-database.ts"],"names":[],"mappings":"AAEA,OAAO,EAAmC,uBAAuB,EAAiC,MAAM,uEAAuE,CAAC;AAChL,OAAO,EAAE,uBAAuB,EAAE,MAAM,0DAA0D,CAAC;AAKnG;;;;;;;;GAQG;AACH,QAAA,MAAM,oBAAoB,GAAU,CAAC,EACjC,QAAQ,MAAM,EACd,gBAAgB,uBAAuB,EACvC,0BAAyB,uBAAmE,KAC7F,OAAO,CAAC,CAAC,EAAE,CAuCb,CAAC;AAEF,OAAO,EAAE,oBAAoB,EAAE,CAAC"}
+{"version":3,"file":"get-items-from-database.d.ts","sourceRoot":"","sources":["../../../../../src/application/database/firestore/generics/get-items-from-database.ts"],"names":[],"mappings":"AAGA,OAAO,EAEH,uBAAuB,EAE1B,MAAM,uEAAuE,CAAC;AAC/E,OAAO,EACH,uBAAuB,EACvB,aAAa,EAGhB,MAAM,0DAA0D,CAAC;AA6HlE;;;;;;;;;;;;;GAaG;AACH,QAAA,MAAM,oBAAoB,GAAU,CAAC,EACjC,QAAQ,MAAM,EACd,gBAAgB,uBAAuB,EACvC,0BAAyB,uBAAmE,KAC7F,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAgF1B,CAAC;AAEF,OAAO,EAAE,oBAAoB,EAAE,CAAC"}