@degenerate/generic 0.0.24 → 0.1.1

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

@@ -0,0 +1,18 @@
+export declare const DatabaseSettingsFirestore: {
+    AuditLogs: {
+        Collection: string;
+    };
+    Events: {
+        Collection: string;
+    };
+    Functions: {
+        Collection: string;
+    };
+    Rules: {
+        Collection: string;
+    };
+    ShareData: {
+        Collection: string;
+    };
+};
+//# sourceMappingURL=database-settings.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"database-settings.d.ts","sourceRoot":"","sources":["../../src/_settings/database-settings.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;CAgBrC,CAAA"}

package/dist/_settings/database-settings.js

@@ -0,0 +1,23 @@
+"use strict";
+// This file contains the settings for different databases.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DatabaseSettingsFirestore = void 0;
+//#region Firestore
+exports.DatabaseSettingsFirestore = {
+    AuditLogs: {
+        Collection: 'AuditLogs', // /{default}/AuditLogs
+    },
+    Events: {
+        Collection: 'Events', // /{default}/Events
+    },
+    Functions: {
+        Collection: 'Functions', // /{default}/Functions
+    },
+    Rules: {
+        Collection: 'Rules', // /{default}/Rules
+    },
+    ShareData: {
+        Collection: 'ShareData', // /{default}/ShareData
+    },
+};
+//#endregion Firestore

package/dist/application/audit-log/additional-ids/{create-mulitple-path-alai.d.ts → create-multiple-path-alai.d.ts}

@@ -7,4 +7,4 @@ import { IAdditionalApplicationAuditLogIds } from '../../../models/application/a
  */
 declare const createMultiplePathALAI: (referencePaths: string[]) => IAdditionalApplicationAuditLogIds[];
 export { createMultiplePathALAI };
-//# sourceMappingURL=create-mulitple-path-alai.d.ts.map
+//# sourceMappingURL=create-multiple-path-alai.d.ts.map

package/dist/application/audit-log/additional-ids/{create-mulitple-path-alai.d.ts.map → create-multiple-path-alai.d.ts.map}

@@ -1 +1 @@
-{"version":3,"file":"create-mulitple-path-alai.d.ts","sourceRoot":"","sources":["../../../../src/application/audit-log/additional-ids/create-mulitple-path-alai.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iCAAiC,EAAE,MAAM,oEAAoE,CAAC;AAEvH;;;;;GAKG;AACH,QAAA,MAAM,sBAAsB,mBAAoB,MAAM,EAAE,KAAG,iCAAiC,EAQ3F,CAAC;AAEF,OAAO,EAAE,sBAAsB,EAAE,CAAC"}
+{"version":3,"file":"create-multiple-path-alai.d.ts","sourceRoot":"","sources":["../../../../src/application/audit-log/additional-ids/create-multiple-path-alai.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iCAAiC,EAAE,MAAM,oEAAoE,CAAC;AAEvH;;;;;GAKG;AACH,QAAA,MAAM,sBAAsB,mBAAoB,MAAM,EAAE,KAAG,iCAAiC,EAQ3F,CAAC;AAEF,OAAO,EAAE,sBAAsB,EAAE,CAAC"}

package/dist/application/audit-log/create-application-audit-log.d.ts

@@ -11,6 +11,6 @@ import { ApplicationAuditLogAction, ApplicationAuditLogSubType, ApplicationAudit
  * @param championsNetworkId the champions network Id.
  * @param organizationId the organization Id.
  */
-declare const createApplicationLog: (applicationAuditLogAction: ApplicationAuditLogAction, applicationAuditLogSubType: ApplicationAuditLogSubType, createdBy: string, applicationAuditLogType?: ApplicationAuditLogType, alai?: IAdditionalApplicationAuditLogIds[], currentData?: any, previousData?: any) => IApplicationAuditLog;
-export { createApplicationLog };
+declare const createApplicationAuditLog: (applicationAuditLogAction: ApplicationAuditLogAction, applicationAuditLogSubType: ApplicationAuditLogSubType, createdBy: string, applicationAuditLogType?: ApplicationAuditLogType, alai?: IAdditionalApplicationAuditLogIds[], currentData?: any, previousData?: any) => IApplicationAuditLog;
+export { createApplicationAuditLog };
 //# sourceMappingURL=create-application-audit-log.d.ts.map

package/dist/application/audit-log/create-application-audit-log.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"create-application-audit-log.d.ts","sourceRoot":"","sources":["../../../src/application/audit-log/create-application-audit-log.ts"],"names":[],"mappings":"AAEA,OAAO,EACH,yBAAyB,EACzB,0BAA0B,EAC1B,uBAAuB,EACvB,iCAAiC,EACjC,oBAAoB,EACvB,MAAM,iEAAiE,CAAC;AAEzE;;;;;;;;;;;GAWG;AACH,QAAA,MAAM,oBAAoB,8BACK,yBAAyB,8BACxB,0BAA0B,aAC3C,MAAM,4BACQ,uBAAuB,SAC1C,iCAAiC,EAAE,gBAC3B,GAAG,iBACF,GAAG,KACnB,oBAaF,CAAC;AAEF,OAAO,EAAE,oBAAoB,EAAE,CAAC"}
+{"version":3,"file":"create-application-audit-log.d.ts","sourceRoot":"","sources":["../../../src/application/audit-log/create-application-audit-log.ts"],"names":[],"mappings":"AAEA,OAAO,EACH,yBAAyB,EACzB,0BAA0B,EAC1B,uBAAuB,EACvB,iCAAiC,EACjC,oBAAoB,EACvB,MAAM,iEAAiE,CAAC;AAEzE;;;;;;;;;;;GAWG;AACH,QAAA,MAAM,yBAAyB,8BACA,yBAAyB,8BACxB,0BAA0B,aAC3C,MAAM,4BACQ,uBAAuB,SAC1C,iCAAiC,EAAE,gBAC3B,GAAG,iBACF,GAAG,KACnB,oBAaF,CAAC;AAEF,OAAO,EAAE,yBAAyB,EAAE,CAAC"}

package/dist/application/audit-log/create-application-audit-log.js

@@ -1,7 +1,7 @@
 "use strict";
 /* eslint-disable @typescript-eslint/no-explicit-any */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createApplicationLog = void 0;
+exports.createApplicationAuditLog = void 0;
 const application_audit_log_models_1 = require("../../models/application/audit-log/application-audit-log-models");
 /**
  * This creates the application audit log.
@@ -15,7 +15,7 @@ const application_audit_log_models_1 = require("../../models/application/audit-l
  * @param championsNetworkId the champions network Id.
  * @param organizationId the organization Id.
  */
-const createApplicationLog = (applicationAuditLogAction, applicationAuditLogSubType, createdBy, applicationAuditLogType = application_audit_log_models_1.ApplicationAuditLogType.global, alai = [], currentData, previousData) => {
+const createApplicationAuditLog = (applicationAuditLogAction, applicationAuditLogSubType, createdBy, applicationAuditLogType = application_audit_log_models_1.ApplicationAuditLogType.global, alai = [], currentData, previousData) => {
     const auditLog = {
         additionalAuditLogIds: alai,
         applicationAuditLogAction,
@@ -30,4 +30,4 @@ const createApplicationLog = (applicationAuditLogAction, applicationAuditLogSubT
         auditLog.previousData = previousData;
     return auditLog;
 };
-exports.createApplicationLog = createApplicationLog;
+exports.createApplicationAuditLog = createApplicationAuditLog;

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

@@ -0,0 +1,13 @@
+import { IDatabaseChangeInformation } from '../../../../models/application/database/firestore-models';
+import { ApplicationAuditLogType } from '../../../../models/application/audit-log/application-audit-log-models';
+/**
+ * this function adds an item to the database.
+ *
+ * @param databaseChangeInformation the database change information
+ * @param userId the user id that is adding the item to the database
+ * @param applicationAuditLogType the type of audit log to create
+ * @returns
+ */
+declare const addItemsToDatabase: (databaseChangeInformation: IDatabaseChangeInformation[], userId: string, applicationAuditLogType?: ApplicationAuditLogType) => Promise<void>;
+export { addItemsToDatabase };
+//# sourceMappingURL=add-items-to-database.d.ts.map

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

@@ -0,0 +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,EAA6B,uBAAuB,EAAE,MAAM,uEAAuE,CAAC;AAE3I;;;;;;;GAOG;AACH,QAAA,MAAM,kBAAkB,8BACO,0BAA0B,EAAE,UAC/C,MAAM,4BACW,uBAAuB,KACjD,OAAO,CAAC,IAAI,CAed,CAAC;AAEF,OAAO,EAAE,kBAAkB,EAAE,CAAC"}

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

@@ -0,0 +1,54 @@
+"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 (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addItemsToDatabase = void 0;
+const admin = __importStar(require("firebase-admin"));
+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.
+ *
+ * @param databaseChangeInformation the database change information
+ * @param userId the user id that is adding the item to the database
+ * @param applicationAuditLogType the type of audit log to create
+ * @returns
+ */
+const addItemsToDatabase = async (databaseChangeInformation, userId, applicationAuditLogType = application_audit_log_models_1.ApplicationAuditLogType.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) => {
+        for (const changeRecords of databaseChangeInformation) {
+            // create the audit log
+            const auditLog = (0, create_application_audit_log_1.createApplicationAuditLog)(application_audit_log_models_1.ApplicationAuditLogAction.create, changeRecords.auditLogSubType, userId, applicationAuditLogType, changeRecords.alai, changeRecords.item, undefined);
+            t.create(changeRecords.itemDocRef, JSON.parse(JSON.stringify(changeRecords.item))); // add the item to the database.
+            t.create(auditLogColRef.doc(), auditLog); // add the audit log to the database.
+        }
+        return;
+    });
+    return;
+};
+exports.addItemsToDatabase = addItemsToDatabase;

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

@@ -0,0 +1,13 @@
+import { ApplicationAuditLogType } from '../../../../models/application/audit-log/application-audit-log-models';
+import { IDatabaseChangeInformation } from '../../../../models/application/database/firestore-models';
+/**
+ * This adds the items to the database if they do not exist, if they do exist then it updates the items.
+ *
+ * @param databaseChangeRecords the database change records
+ * @param userId the user id that this change is recorded under.
+ * @param applicationAuditLogType the type of audit log to create
+ * @returns
+ */
+declare const addOrUpdateItemsToDatabase: <T>(databaseChangeRecords: IDatabaseChangeInformation[], userId: string, applicationAuditLogType?: ApplicationAuditLogType) => Promise<void>;
+export { addOrUpdateItemsToDatabase };
+//# sourceMappingURL=add-or-update-items-to-database.d.ts.map

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

@@ -0,0 +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,EAA6B,uBAAuB,EAAwB,MAAM,uEAAuE,CAAC;AAGjK,OAAO,EAAE,0BAA0B,EAAE,MAAM,0DAA0D,CAAC;AAGtG;;;;;;;GAOG;AACH,QAAA,MAAM,0BAA0B,GAAU,CAAC,yBAChB,0BAA0B,EAAE,UAC3C,MAAM,4BACW,uBAAuB,KACjD,OAAO,CAAC,IAAI,CAoCd,CAAC;AAEF,OAAO,EAAE,0BAA0B,EAAE,CAAC"}

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

@@ -0,0 +1,74 @@
+"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 (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addOrUpdateItemsToDatabase = void 0;
+const admin = __importStar(require("firebase-admin"));
+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.
+ *
+ * @param databaseChangeRecords the database change records
+ * @param userId the user id that this change is recorded under.
+ * @param applicationAuditLogType the type of audit log to create
+ * @returns
+ */
+const addOrUpdateItemsToDatabase = async (databaseChangeRecords, userId, applicationAuditLogType = application_audit_log_models_1.ApplicationAuditLogType.global) => {
+    // loop the transaction and update the database
+    await db.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
+        for (const changeRecord of databaseChangeRecords) {
+            const newRecord = JSON.parse(JSON.stringify(changeRecord.item));
+            const existingRecordSnap = await t.get(changeRecord.itemDocRef);
+            // check if the record exists, if it does not exist then don't add it to the audit log.
+            if (existingRecordSnap.exists) {
+                const existingRecord = existingRecordSnap.data();
+                // create the audit log for the update stringify and parse to ensure the deep properties are copied.
+                const updatedData = { ...JSON.parse(JSON.stringify(existingRecord)), ...newRecord };
+                // create the audit log
+                const auditLog = (0, create_application_audit_log_1.createApplicationAuditLog)(application_audit_log_models_1.ApplicationAuditLogAction.update, changeRecord.auditLogSubType, userId, applicationAuditLogType, changeRecord.alai, updatedData, existingRecord);
+                auditLogUpdates.push(auditLog);
+                updatedRecord.push(updatedData);
+            }
+            else {
+                // create the audit log
+                const auditLog = (0, create_application_audit_log_1.createApplicationAuditLog)(application_audit_log_models_1.ApplicationAuditLogAction.create, changeRecord.auditLogSubType, userId, applicationAuditLogType, changeRecord.alai, newRecord, undefined);
+                auditLogUpdates.push(auditLog);
+                updatedRecord.push(newRecord);
+            }
+        }
+        // update the database.
+        for (let i = 0; i < databaseChangeRecords.length; i++) {
+            const changeRecord = databaseChangeRecords[i];
+            t.set(changeRecord.itemDocRef, updatedRecord[i]); // no merge requeired at this was done in the function.
+            t.create((0, create_audit_log_col_ref_1.createAuditLogColRef)().doc(), auditLogUpdates[i]);
+        }
+    });
+};
+exports.addOrUpdateItemsToDatabase = addOrUpdateItemsToDatabase;

package/dist/application/database/firestore/generics/create-database-change-information.d.ts

@@ -0,0 +1,15 @@
+import { DocumentReference } from 'firebase-admin/firestore';
+import { IAdditionalApplicationAuditLogIds, ApplicationAuditLogSubType } from '../../../../models/application/audit-log/application-audit-log-models';
+import { IDatabaseChangeInformation } from '../../../../models/application/database/firestore-models';
+/**
+ * this function creates the database change information.
+ *
+ * @param alai the additional application audit log ids
+ * @param auditLogSubType the audit log sub type
+ * @param item the item to add to the database
+ * @param itemDocRef the item document reference (where to add the item to the database)
+ * @returns
+ */
+declare const createDatabaseChangeInformation: (alai: IAdditionalApplicationAuditLogIds[], auditLogSubType: ApplicationAuditLogSubType, item: unknown, itemDocRef: DocumentReference) => IDatabaseChangeInformation;
+export { createDatabaseChangeInformation };
+//# sourceMappingURL=create-database-change-information.d.ts.map

package/dist/application/database/firestore/generics/create-database-change-information.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-database-change-information.d.ts","sourceRoot":"","sources":["../../../../../src/application/database/firestore/generics/create-database-change-information.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EAAE,iCAAiC,EAAE,0BAA0B,EAAE,MAAM,uEAAuE,CAAC;AACtJ,OAAO,EAAE,0BAA0B,EAAE,MAAM,0DAA0D,CAAC;AAEtG;;;;;;;;GAQG;AACH,QAAA,MAAM,+BAA+B,SAC3B,iCAAiC,EAAE,mBACxB,0BAA0B,QACrC,OAAO,cACD,iBAAiB,KAC9B,0BAOF,CAAC;AAEF,OAAO,EAAE,+BAA+B,EAAE,CAAC"}

package/dist/application/database/firestore/generics/create-database-change-information.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createDatabaseChangeInformation = void 0;
+/**
+ * this function creates the database change information.
+ *
+ * @param alai the additional application audit log ids
+ * @param auditLogSubType the audit log sub type
+ * @param item the item to add to the database
+ * @param itemDocRef the item document reference (where to add the item to the database)
+ * @returns
+ */
+const createDatabaseChangeInformation = (alai, auditLogSubType, item, itemDocRef) => {
+    return {
+        alai,
+        auditLogSubType,
+        item,
+        itemDocRef,
+    };
+};
+exports.createDatabaseChangeInformation = createDatabaseChangeInformation;

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

@@ -0,0 +1,13 @@
+import { ApplicationAuditLogType } from '../../../../models/application/audit-log/application-audit-log-models';
+import { IDatabaseDeleteItem } from '../../../../models/application/database/firestore-models';
+/**
+ * This deletes the items on the database.
+ *
+ * @param databaseDeleteItems the database delete items
+ * @param userId the user id that is updating the database
+ * @param applicationAuditLogType the type of audit log to create
+ * @returns
+ */
+declare const deleteItemsOnDatabase: (databaseDeleteItems: IDatabaseDeleteItem[], userId: string, applicationAuditLogType?: ApplicationAuditLogType) => Promise<void>;
+export { deleteItemsOnDatabase };
+//# sourceMappingURL=delete-items-on-database.d.ts.map

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

@@ -0,0 +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,EAA6B,uBAAuB,EAAE,MAAM,uEAAuE,CAAC;AAC3I,OAAO,EAAE,mBAAmB,EAAE,MAAM,0DAA0D,CAAC;AAM/F;;;;;;;GAOG;AACH,QAAA,MAAM,qBAAqB,wBACF,mBAAmB,EAAE,UAClC,MAAM,4BACW,uBAAuB,KACjD,OAAO,CAAC,IAAI,CA2Bd,CAAC;AAEF,OAAO,EAAE,qBAAqB,EAAE,CAAC"}

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

@@ -0,0 +1,66 @@
+"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 (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deleteItemsOnDatabase = void 0;
+const admin = __importStar(require("firebase-admin"));
+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.
+ *
+ * @param databaseDeleteItems the database delete items
+ * @param userId the user id that is updating the database
+ * @param applicationAuditLogType the type of audit log to create
+ * @returns
+ */
+const deleteItemsOnDatabase = async (databaseDeleteItems, userId, applicationAuditLogType = application_audit_log_models_1.ApplicationAuditLogType.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) => {
+        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);
+            // check if the record exists
+            if (!existingRecordSnap.exists && changeRecords.throwErrorOnNotFound) {
+                throw new database_errors_1.DatabaseRecordNotFoundError(changeRecords.itemDocRef.path);
+            }
+            existingRecords.push(existingRecordSnap.data());
+        }
+        // loop the records and delete them from the database
+        for (let i = 0; i < existingRecords.length; i++) {
+            const existingRecord = existingRecords[i]; // the existing record
+            const deleteRecord = databaseDeleteItems[i]; // the delete record
+            // create the audit log
+            const auditLog = (0, create_application_audit_log_1.createApplicationAuditLog)(application_audit_log_models_1.ApplicationAuditLogAction.delete, deleteRecord.auditLogSubType, userId, applicationAuditLogType, deleteRecord.alai, undefined, existingRecord);
+            t.delete(deleteRecord.itemDocRef); // delete the item from the database.
+            t.create(auditLogColRef.doc(), auditLog); // add the audit log to the database.
+        }
+        return;
+    });
+};
+exports.deleteItemsOnDatabase = deleteItemsOnDatabase;

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

@@ -0,0 +1,13 @@
+import { ApplicationAuditLogType } from '../../../../models/application/audit-log/application-audit-log-models';
+import { IDatabaseGetItem } from '../../../../models/application/database/firestore-models';
+/**
+ * This gets a single item from the database
+ *
+ * @param getItem the instructions for this function
+ * @param userId the user ID performing the action
+ * @param applicationAuditLogType the type of audit log to create
+ * @returns
+ */
+declare const getItemFromDatabase: <T>(getItem: IDatabaseGetItem, userId: string, applicationAuditLogType?: ApplicationAuditLogType) => Promise<T | undefined>;
+export { getItemFromDatabase };
+//# sourceMappingURL=get-item-from-database.d.ts.map

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

@@ -0,0 +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,EAA6B,uBAAuB,EAAE,MAAM,uEAAuE,CAAC;AAC3I,OAAO,EAAE,gBAAgB,EAAE,MAAM,0DAA0D,CAAC;AAG5F;;;;;;;GAOG;AACH,QAAA,MAAM,mBAAmB,GAAU,CAAC,WACvB,gBAAgB,UACjB,MAAM,4BACW,uBAAuB,KACjD,OAAO,CAAC,CAAC,GAAG,SAAS,CAgBvB,CAAC;AAEF,OAAO,EAAE,mBAAmB,EAAE,CAAC"}

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

@@ -0,0 +1,55 @@
+"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 (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getItemFromDatabase = void 0;
+const admin = __importStar(require("firebase-admin"));
+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
+ *
+ * @param getItem the instructions for this function
+ * @param userId the user ID performing the action
+ * @param applicationAuditLogType the type of audit log to create
+ * @returns
+ */
+const getItemFromDatabase = async (getItem, userId, applicationAuditLogType = application_audit_log_models_1.ApplicationAuditLogType.global) => {
+    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.ApplicationAuditLogAction.read, getItem.auditLogSubType, userId, applicationAuditLogType, getItem.alai, undefined, undefined);
+    const itemData = await db.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();
+    });
+    if (getItem.throwErrorOnNotFound && !itemData) {
+        throw new database_errors_1.DatabaseRecordNotFoundError(getItem.itemDocRef.path);
+    }
+    return itemData;
+};
+exports.getItemFromDatabase = getItemFromDatabase;

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

@@ -0,0 +1,12 @@
+import { ApplicationAuditLogType } from '../../../../models/application/audit-log/application-audit-log-models';
+/**
+ * This function gets the items from different paths on the database.
+ *
+ * @param documentPaths the paths of the documents to get
+ * @param userId the user ID performing the action
+ * @param applicationAuditLogType the type of audit log to create
+ * @returns
+ */
+declare const getItemsDifferentPathsOnDatabase: <T>(documentPaths: string[], userId: string, applicationAuditLogType?: ApplicationAuditLogType) => Promise<T[]>;
+export { getItemsDifferentPathsOnDatabase };
+//# sourceMappingURL=get-items-different-path-on-database.d.ts.map

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

@@ -0,0 +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,EAA6B,uBAAuB,EAA+B,MAAM,uEAAuE,CAAC;AAIxK;;;;;;;GAOG;AACH,QAAA,MAAM,gCAAgC,GAAU,CAAC,iBAC9B,MAAM,EAAE,UACf,MAAM,4BACW,uBAAuB,KACjD,OAAO,CAAC,CAAC,EAAE,CAwBb,CAAC;AAEF,OAAO,EAAE,gCAAgC,EAAE,CAAC"}

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

@@ -0,0 +1,63 @@
+"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 (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getItemsDifferentPathsOnDatabase = void 0;
+const admin = __importStar(require("firebase-admin"));
+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.
+ *
+ * @param documentPaths the paths of the documents to get
+ * @param userId the user ID performing the action
+ * @param applicationAuditLogType the type of audit log to create
+ * @returns
+ */
+const getItemsDifferentPathsOnDatabase = async (documentPaths, userId, applicationAuditLogType = application_audit_log_models_1.ApplicationAuditLogType.global) => {
+    const auditLogColRef = (0, create_audit_log_col_ref_1.createAuditLogColRef)(); // create the audit log collection reference
+    // create the promisees for the documents.
+    const documentPromises = [];
+    for (const documentPath of documentPaths) {
+        documentPromises.push(db.doc(documentPath).get());
+    }
+    // create the audit log additional ids information
+    const alai = (0, create_multiple_path_alai_1.createMultiplePathALAI)(documentPaths);
+    // create the audit log information
+    const auditLog = (0, create_application_audit_log_1.createApplicationAuditLog)(application_audit_log_models_1.ApplicationAuditLogAction.list, application_audit_log_models_1.MultiplePathAuditLogSubType.multiplePathALAI, userId, applicationAuditLogType, alai, undefined, undefined);
+    // add in the audit log
+    await auditLogColRef.add(auditLog);
+    const allDocuments = await Promise.all(documentPromises);
+    const allDocumentsData = [];
+    for (const document of allDocuments) {
+        if (document.exists) {
+            allDocumentsData.push(document.data());
+        }
+    }
+    return allDocumentsData;
+};
+exports.getItemsDifferentPathsOnDatabase = getItemsDifferentPathsOnDatabase;

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

@@ -0,0 +1,14 @@
+import { ApplicationAuditLogType } from '../../../../models/application/audit-log/application-audit-log-models';
+import { IDatabaseGetInformation } from '../../../../models/application/database/firestore-models';
+/**
+ * This function queries the database and returns the items or an empty array.
+ *
+ * @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
+ */
+declare const getItemsFromDatabase: <T>(userId: string, getInformation: IDatabaseGetInformation, applicationAuditLogType?: ApplicationAuditLogType) => Promise<T[]>;
+export { getItemsFromDatabase };
+//# sourceMappingURL=get-items-from-database.d.ts.map

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

@@ -0,0 +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,EAA6B,uBAAuB,EAAE,MAAM,uEAAuE,CAAC;AAC3I,OAAO,EAAE,uBAAuB,EAAE,MAAM,0DAA0D,CAAC;AAKnG;;;;;;;;GAQG;AACH,QAAA,MAAM,oBAAoB,GAAU,CAAC,UACzB,MAAM,kBACE,uBAAuB,4BACd,uBAAuB,KACjD,OAAO,CAAC,CAAC,EAAE,CA0Cb,CAAC;AAEF,OAAO,EAAE,oBAAoB,EAAE,CAAC"}

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

@@ -0,0 +1,80 @@
+"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 (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getItemsFromDatabase = void 0;
+const firebase = __importStar(require("firebase-admin"));
+const application_settings_1 = require("../../../../_settings/application-settings");
+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 = firebase.firestore();
+/**
+ * This function queries the database and returns the items or an empty array.
+ *
+ * @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
+ */
+const getItemsFromDatabase = async (userId, getInformation, applicationAuditLogType = application_audit_log_models_1.ApplicationAuditLogType.global) => {
+    const maxResults = application_settings_1.ApplicationSettings.SystemValues.MaxSnapshotSize; // the maximum number of results to return.
+    const auditLogColRef = (0, create_audit_log_col_ref_1.createAuditLogColRef)(); // create the audit log collection reference
+    // get the items from the database.
+    const itemsToReturn = await db.runTransaction(async (t) => {
+        const databaseItems = [];
+        const itemQuery = getInformation.itemColRef;
+        console.log('itemQuery', itemQuery);
+        // add in the query fields if they are set.
+        for (const queryField of getInformation.queryFields) {
+            itemQuery.where(queryField.fieldPath, queryField.opStr, queryField.value);
+        }
+        // If order by is set, then order the items.
+        if (getInformation.orderBy) {
+            itemQuery.orderBy(getInformation.orderBy.fieldPath, getInformation.orderBy.direction);
+        }
+        // add in the query for the pagination.
+        if (typeof getInformation.lastId !== 'undefined' && getInformation.lastId.length > 0) {
+            const lastElement = await t.get(itemQuery.doc(getInformation.lastId));
+            itemQuery.startAfter(lastElement);
+        }
+        // set the limit and query the database.
+        itemQuery.limit(maxResults);
+        console.log('itemQueryAfter', itemQuery.limit);
+        const itemSnapshot = await t.get(itemQuery);
+        console.log('itemSnapshot', itemSnapshot);
+        // get the items from the database.
+        for (const docSnap of itemSnapshot.docs) {
+            const item = docSnap.data();
+            databaseItems.push(item);
+        }
+        // create the audit log information
+        const auditLog = (0, create_application_audit_log_1.createApplicationAuditLog)(application_audit_log_models_1.ApplicationAuditLogAction.list, getInformation.auditLogSubType, userId, applicationAuditLogType, getInformation.alai, undefined, undefined);
+        t.create(auditLogColRef.doc(), auditLog); // add the audit log to the database.
+        return databaseItems;
+    });
+    return itemsToReturn;
+};
+exports.getItemsFromDatabase = getItemsFromDatabase;

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

@@ -0,0 +1,13 @@
+import { ApplicationAuditLogType } from '../../../../models/application/audit-log/application-audit-log-models';
+import { IDatabaseChangeInformation } from '../../../../models/application/database/firestore-models';
+/**
+ * This updates the items on the database.
+ *
+ * @param databaseChangeInformation the database change information
+ * @param userId the user id that is updating the database
+ * @param applicationAuditLogType the type of audit log to create
+ * @returns
+ */
+declare const updateItemsOnDatabase: <T>(databaseChangeInformation: IDatabaseChangeInformation[], userId: string, applicationAuditLogType?: ApplicationAuditLogType) => Promise<void>;
+export { updateItemsOnDatabase };
+//# sourceMappingURL=update-items-on-database.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"update-items-on-database.d.ts","sourceRoot":"","sources":["../../../../../src/application/database/firestore/generics/update-items-on-database.ts"],"names":[],"mappings":"AACA,OAAO,EAA6B,uBAAuB,EAAE,MAAM,uEAAuE,CAAC;AAC3I,OAAO,EAAE,0BAA0B,EAAE,MAAM,0DAA0D,CAAC;AAMtG;;;;;;;GAOG;AACH,QAAA,MAAM,qBAAqB,GAAU,CAAC,6BACP,0BAA0B,EAAE,UAC/C,MAAM,4BACW,uBAAuB,KACjD,OAAO,CAAC,IAAI,CA0Bd,CAAC;AAEF,OAAO,EAAE,qBAAqB,EAAE,CAAC"}

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

@@ -0,0 +1,67 @@
+"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 (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateItemsOnDatabase = void 0;
+const admin = __importStar(require("firebase-admin"));
+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 database_errors_1 = require("../../../../errors/database/database-errors");
+const db = admin.firestore();
+/**
+ * This updates the items on the database.
+ *
+ * @param databaseChangeInformation the database change information
+ * @param userId the user id that is updating the database
+ * @param applicationAuditLogType the type of audit log to create
+ * @returns
+ */
+const updateItemsOnDatabase = async (databaseChangeInformation, userId, applicationAuditLogType = application_audit_log_models_1.ApplicationAuditLogType.global) => {
+    // loop the transaction and update the database
+    await db.runTransaction(async (t) => {
+        // get the existing records from the database
+        const existingRecords = [];
+        for (const changeRecords of databaseChangeInformation) {
+            const existingRecordSnap = await t.get(changeRecords.itemDocRef);
+            // check if the record exists
+            if (!existingRecordSnap.exists)
+                throw new database_errors_1.DatabaseRecordNotFoundError(changeRecords.itemDocRef.path);
+            existingRecords.push(existingRecordSnap.data());
+        }
+        // create the updates and the audit logs.
+        for (let i = 0; i < existingRecords.length; i++) {
+            // get the change record and the existing record
+            const changeRecord = databaseChangeInformation[i];
+            const existingRecord = existingRecords[i];
+            // create the audit log
+            const auditLog = (0, create_application_audit_log_1.createApplicationAuditLog)(application_audit_log_models_1.ApplicationAuditLogAction.update, changeRecord.auditLogSubType, userId, applicationAuditLogType, changeRecord.alai, changeRecord.item, existingRecord);
+            const updatedRecord = { ...existingRecord, ...changeRecord.item };
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            t.update(changeRecord.itemDocRef, updatedRecord);
+            t.create((0, create_audit_log_col_ref_1.createAuditLogColRef)().doc(), auditLog);
+        }
+    });
+};
+exports.updateItemsOnDatabase = updateItemsOnDatabase;

package/dist/application/database/firestore/generics/update-items-properties-on-database.d.ts

@@ -0,0 +1,14 @@
+import { ApplicationAuditLogType } from '../../../../models/application/audit-log/application-audit-log-models';
+import { IDatabasePropertyChangeInformation } from '../../../../models/application/database/firestore-models';
+/**
+ * This takes a partial object to update and updates the properties on the database. This function is used to update
+ * the properties of an object on the database.
+ *
+ * @param databaseChangeRecords the database change records (the reference and properties to update)
+ * @param userId the user ID that is updating the database
+ * @param applicationAuditLogType the type of audit log to create
+ * @returns
+ */
+declare const updateItemsPropertiesOnDatabase: <T>(databaseChangeRecords: IDatabasePropertyChangeInformation[], userId: string, applicationAuditLogType?: ApplicationAuditLogType) => Promise<void>;
+export { updateItemsPropertiesOnDatabase };
+//# sourceMappingURL=update-items-properties-on-database.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"update-items-properties-on-database.d.ts","sourceRoot":"","sources":["../../../../../src/application/database/firestore/generics/update-items-properties-on-database.ts"],"names":[],"mappings":"AAEA,OAAO,EAGH,uBAAuB,EAC1B,MAAM,uEAAuE,CAAC;AAC/E,OAAO,EAAE,kCAAkC,EAAE,MAAM,0DAA0D,CAAC;AAI9G;;;;;;;;GAQG;AACH,QAAA,MAAM,+BAA+B,GAAU,CAAC,yBACrB,kCAAkC,EAAE,UACnD,MAAM,4BACW,uBAAuB,KACjD,OAAO,CAAC,IAAI,CA6Bd,CAAC;AAEF,OAAO,EAAE,+BAA+B,EAAE,CAAC"}

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

@@ -0,0 +1,70 @@
+"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 (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateItemsPropertiesOnDatabase = void 0;
+const admin = __importStar(require("firebase-admin"));
+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_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 takes a partial object to update and updates the properties on the database. This function is used to update
+ * the properties of an object on the database.
+ *
+ * @param databaseChangeRecords the database change records (the reference and properties to update)
+ * @param userId the user ID that is updating the database
+ * @param applicationAuditLogType the type of audit log to create
+ * @returns
+ */
+const updateItemsPropertiesOnDatabase = async (databaseChangeRecords, userId, applicationAuditLogType = application_audit_log_models_1.ApplicationAuditLogType.global) => {
+    // loop the transaction and update the database
+    await db.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
+        for (const changeRecord of databaseChangeRecords) {
+            const existingRecordSnap = await t.get(changeRecord.itemDocRef);
+            // check if the record exists
+            if (!existingRecordSnap.exists)
+                throw new database_errors_1.DatabaseRecordNotFoundError(changeRecord.itemDocRef.path);
+            const existingRecord = existingRecordSnap.data();
+            // create the audit log for the update stringify and parse to ensure the deep properties are copied.
+            const recordExisting = JSON.parse(JSON.stringify(existingRecord));
+            const updatedData = { recordExisting, ...changeRecord.partialObjectUpdate };
+            // create the audit log
+            const auditLog = (0, create_application_audit_log_1.createApplicationAuditLog)(application_audit_log_models_1.ApplicationAuditLogAction.update, changeRecord.auditLogSubType, userId, applicationAuditLogType, changeRecord.alai, updatedData, existingRecord);
+            auditLogUpdates.push(auditLog);
+            updatedRecord.push(updatedData);
+        }
+        // update the database.
+        for (let i = 0; i < databaseChangeRecords.length; i++) {
+            const changeRecord = databaseChangeRecords[i];
+            t.update(changeRecord.itemDocRef, updatedRecord[i]);
+            t.create((0, create_audit_log_col_ref_1.createAuditLogColRef)().doc(), auditLogUpdates[i]);
+        }
+    });
+};
+exports.updateItemsPropertiesOnDatabase = updateItemsPropertiesOnDatabase;

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

@@ -0,0 +1,9 @@
+import { CollectionReference } from 'firebase-admin/firestore';
+/**
+ * This creates the audit log collection reference.
+ *
+ * @returns the collection reference.
+ */
+declare const createAuditLogColRef: () => CollectionReference;
+export { createAuditLogColRef };
+//# sourceMappingURL=create-audit-log-col-ref.d.ts.map

package/dist/application/database/firestore/path-references/audit-log/create-audit-log-col-ref.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-audit-log-col-ref.d.ts","sourceRoot":"","sources":["../../../../../../src/application/database/firestore/path-references/audit-log/create-audit-log-col-ref.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAI/D;;;;GAIG;AACH,QAAA,MAAM,oBAAoB,QAAO,mBAEhC,CAAC;AAEF,OAAO,EAAE,oBAAoB,EAAE,CAAC"}

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

@@ -0,0 +1,38 @@
+"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 (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createAuditLogColRef = void 0;
+const admin = __importStar(require("firebase-admin"));
+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);
+};
+exports.createAuditLogColRef = createAuditLogColRef;

package/dist/application/index.d.ts

@@ -1,5 +1,15 @@
 export * from './audit-log/additional-ids/create-audit-log-additional-ids-with-query';
-export * from './audit-log/additional-ids/create-mulitple-path-alai';
+export * from './audit-log/additional-ids/create-multiple-path-alai';
 export * from './audit-log/additional-ids/create-query-audit-log-for-alai';
 export * from './audit-log/create-application-audit-log';
+export * from './database/firestore/generics/add-items-to-database';
+export * from './database/firestore/generics/add-or-update-items-to-database';
+export * from './database/firestore/generics/create-database-change-information';
+export * from './database/firestore/generics/delete-items-on-database';
+export * from './database/firestore/generics/get-item-from-database';
+export * from './database/firestore/generics/get-items-different-path-on-database';
+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/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"}
+{"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"}

package/dist/application/index.js

@@ -18,9 +18,25 @@ Object.defineProperty(exports, "__esModule", { value: true });
 //#region Audit Log
 //#region Additional Ids
 __exportStar(require("./audit-log/additional-ids/create-audit-log-additional-ids-with-query"), exports);
-__exportStar(require("./audit-log/additional-ids/create-mulitple-path-alai"), exports);
+__exportStar(require("./audit-log/additional-ids/create-multiple-path-alai"), exports);
 __exportStar(require("./audit-log/additional-ids/create-query-audit-log-for-alai"), exports);
 //#endregion Additional Ids
 __exportStar(require("./audit-log/create-application-audit-log"), exports);
 //#endregion Audit Log
+//#region Database
+//#region Firestore
+//#region Generics
+__exportStar(require("./database/firestore/generics/add-items-to-database"), exports);
+__exportStar(require("./database/firestore/generics/add-or-update-items-to-database"), exports);
+__exportStar(require("./database/firestore/generics/create-database-change-information"), exports);
+__exportStar(require("./database/firestore/generics/delete-items-on-database"), exports);
+__exportStar(require("./database/firestore/generics/get-item-from-database"), exports);
+__exportStar(require("./database/firestore/generics/get-items-different-path-on-database"), exports);
+__exportStar(require("./database/firestore/generics/get-items-from-database"), exports);
+__exportStar(require("./database/firestore/generics/update-items-on-database"), exports);
+__exportStar(require("./database/firestore/generics/update-items-properties-on-database"), exports);
+//#endregion Generics
+//#region Path References
+__exportStar(require("./database/firestore/path-references/audit-log/create-audit-log-col-ref"), exports);
+//#endregion Path References
 //#endregion Application

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

@@ -0,0 +1,24 @@
+import { BaseError } from '../base-error';
+/**
+ * This is throw when a database records is not found.
+ */
+export declare class DatabaseRecordNotFoundError extends BaseError {
+    /**
+     * This is thrown when a database record is not found.
+     *
+     * @param databasePath the path to the database record.
+     */
+    constructor(databasePath: string);
+}
+/**
+ * This is throw when too many database records are found.
+ */
+export declare class DatabaseTooManyRecordsError extends BaseError {
+    /**
+     * This is thrown when too many database records are found.
+     *
+     * @param databasePath the path to the database record.
+     */
+    constructor(databasePath: string);
+}
+//# sourceMappingURL=database-errors.d.ts.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DatabaseTooManyRecordsError = exports.DatabaseRecordNotFoundError = void 0;
+// This file contains all the errors that are related to database records.
+const base_error_1 = require("../base-error");
+/**
+ * This is throw when a database records is not found.
+ */
+class DatabaseRecordNotFoundError extends base_error_1.BaseError {
+    /**
+     * This is thrown when a database record is not found.
+     *
+     * @param databasePath the path to the database record.
+     */
+    constructor(databasePath) {
+        super(`The database record at ${databasePath} was not found`);
+    }
+}
+exports.DatabaseRecordNotFoundError = DatabaseRecordNotFoundError;
+/**
+ * This is throw when too many database records are found.
+ */
+class DatabaseTooManyRecordsError extends base_error_1.BaseError {
+    /**
+     * This is thrown when too many database records are found.
+     *
+     * @param databasePath the path to the database record.
+     */
+    constructor(databasePath) {
+        super(`Too many records found at ${databasePath}`);
+    }
+}
+exports.DatabaseTooManyRecordsError = DatabaseTooManyRecordsError;

package/dist/errors/index.d.ts

@@ -1,8 +1,9 @@
 export * from './audit-log/audit-log-errors';
-export * from './base-error';
+export * from './database/database-errors';
 export * from './generic/generic-errors';
 export * from './request/request-errors';
 export * from './safe/safe-rules-errors';
 export * from './scheduler/scheduler-errors';
 export * from './share-data/share-data-errors';
+export * from './base-error';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/errors/index.ts"],"names":[],"mappings":"AAAA,cAAc,8BAA8B,CAAC;AAC7C,cAAc,cAAc,CAAC;AAC7B,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC;AACzC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,gCAAgC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/errors/index.ts"],"names":[],"mappings":"AAAA,cAAc,8BAA8B,CAAC;AAC7C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC;AACzC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,gCAAgC,CAAC;AAG/C,cAAc,cAAc,CAAC"}

package/dist/errors/index.js

@@ -15,9 +15,11 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./audit-log/audit-log-errors"), exports);
-__exportStar(require("./base-error"), exports);
+__exportStar(require("./database/database-errors"), exports);
 __exportStar(require("./generic/generic-errors"), exports);
 __exportStar(require("./request/request-errors"), exports);
 __exportStar(require("./safe/safe-rules-errors"), exports);
 __exportStar(require("./scheduler/scheduler-errors"), exports);
 __exportStar(require("./share-data/share-data-errors"), exports);
+// Base error
+__exportStar(require("./base-error"), exports);

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

@@ -0,0 +1,84 @@
+import { CollectionReference, DocumentReference } from 'firebase-admin/firestore';
+import * as admin from 'firebase-admin';
+import { IAdditionalApplicationAuditLogIds, ApplicationAuditLogSubType, IApplicationAuditLog } from '../audit-log/application-audit-log-models';
+/**
+ * This contains the information that is needed to pass a change to the generic database functions.
+ */
+export interface IDatabaseChangeInformation {
+    alai: IAdditionalApplicationAuditLogIds[];
+    auditLogSubType: ApplicationAuditLogSubType;
+    item: unknown;
+    itemDocRef: DocumentReference;
+}
+/**
+ * This contains the information that is needed to pass a change to the generic database functions.
+ * It allows for a property of an object to be retrieved and updated without needing the original
+ * object when called.
+ */
+export interface IDatabasePropertyChangeInformation {
+    alai: IAdditionalApplicationAuditLogIds[];
+    auditLogSubType: ApplicationAuditLogSubType;
+    partialObjectUpdate: any;
+    itemDocRef: DocumentReference;
+}
+/**
+ * This contains the information records and audit logs for database changes
+ */
+export interface IDatabaseUpdates {
+    recordsandRefs: IDatabaseRecordAndRef[];
+    auditLogInfo: IApplicationAuditLog;
+}
+/**
+ * This contains the database record and document reference to update.
+ */
+export interface IDatabaseRecordAndRef {
+    record: unknown;
+    recordDocRef: DocumentReference;
+}
+/**
+ * This contains the information to get a single item from the database.
+ */
+export interface IDatabaseGetItem extends IDatabaseAuditLogUpdates {
+    itemDocRef: DocumentReference;
+    throwErrorOnNotFound: boolean;
+}
+/**
+ * This contains the information that is needed to get multiple items from the database.
+ */
+export interface IDatabaseGetInformation extends IDatabaseAuditLogUpdates {
+    itemColRef: CollectionReference;
+    lastId: string;
+    orderBy?: IDatabaseOrderBy;
+    queryFields: IDatabaseQueryFields[];
+    isMaxSizeDocumentSet?: boolean;
+}
+/**
+ * This contains the information that is needed to get information from the database.
+ */
+export interface IDatabaseOrderBy {
+    fieldPath: string | admin.firestore.FieldPath;
+    direction: admin.firestore.OrderByDirection;
+}
+/**
+ * This contains the query information for the database if it is required
+ */
+export interface IDatabaseQueryFields {
+    fieldPath: string | admin.firestore.FieldPath;
+    opStr: admin.firestore.WhereFilterOp;
+    value: any;
+}
+/**
+ * This contains the information to delete a single item from the database.
+ */
+export interface IDatabaseDeleteItem extends IDatabaseAuditLogUpdates {
+    itemDocRef: DocumentReference;
+    throwErrorOnNotFound: boolean;
+}
+/**
+ * This contains the additional information audit logs.
+ */
+export interface IDatabaseAuditLogUpdates {
+    alai: IAdditionalApplicationAuditLogIds[];
+    auditLogSubType: ApplicationAuditLogSubType;
+}
+//# sourceMappingURL=firestore-models.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"firestore-models.d.ts","sourceRoot":"","sources":["../../../../src/models/application/database/firestore-models.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAClF,OAAO,KAAK,KAAK,MAAM,gBAAgB,CAAC;AACxC,OAAO,EACH,iCAAiC,EACjC,0BAA0B,EAC1B,oBAAoB,EACvB,MAAM,2CAA2C,CAAC;AAMnD;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACvC,IAAI,EAAE,iCAAiC,EAAE,CAAC;IAC1C,eAAe,EAAE,0BAA0B,CAAC;IAC5C,IAAI,EAAE,OAAO,CAAC;IACd,UAAU,EAAE,iBAAiB,CAAC;CACjC;AAED;;;;GAIG;AACH,MAAM,WAAW,kCAAkC;IAC/C,IAAI,EAAE,iCAAiC,EAAE,CAAC;IAC1C,eAAe,EAAE,0BAA0B,CAAC;IAE5C,mBAAmB,EAAE,GAAG,CAAC;IACzB,UAAU,EAAE,iBAAiB,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B,cAAc,EAAE,qBAAqB,EAAE,CAAC;IACxC,YAAY,EAAE,oBAAoB,CAAC;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAClC,MAAM,EAAE,OAAO,CAAC;IAChB,YAAY,EAAE,iBAAiB,CAAC;CACnC;AAMD;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,wBAAwB;IAC9D,UAAU,EAAE,iBAAiB,CAAC;IAC9B,oBAAoB,EAAE,OAAO,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,wBAAwB;IACrE,UAAU,EAAE,mBAAmB,CAAC;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,gBAAgB,CAAC;IAC3B,WAAW,EAAE,oBAAoB,EAAE,CAAC;IACpC,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B,SAAS,EAAE,MAAM,GAAG,KAAK,CAAC,SAAS,CAAC,SAAS,CAAC;IAC9C,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC,gBAAgB,CAAC;CAC/C;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACjC,SAAS,EAAE,MAAM,GAAG,KAAK,CAAC,SAAS,CAAC,SAAS,CAAC;IAC9C,KAAK,EAAE,KAAK,CAAC,SAAS,CAAC,aAAa,CAAC;IAErC,KAAK,EAAE,GAAG,CAAC;CACd;AAMD;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,wBAAwB;IACjE,UAAU,EAAE,iBAAiB,CAAC;IAC9B,oBAAoB,EAAE,OAAO,CAAC;CACjC;AAMD;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACrC,IAAI,EAAE,iCAAiC,EAAE,CAAC;IAC1C,eAAe,EAAE,0BAA0B,CAAC;CAC/C"}

package/dist/models/application/database/firestore-models.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//#endregion Audit Log Information
+//#endregion Backend Data Models

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@degenerate/generic",
-  "version": "0.0.24",
+  "version": "0.1.1",
   "description": "This contains the generic information needed for the ShareData Adaptive Framework Ecosystem (SAFE) network",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -48,7 +48,9 @@
   },
   "dependencies": {
     "bip39": "^3.1.0",
-    "elliptic": "^6.5.7"
+    "elliptic": "^6.5.7",
+    "firebase-admin": "^12.7.0",
+    "firebase-functions": "^6.1.0"
   },
-  "gitHead": "0e8f76c14364f6d23ab66cdb9547d4e486fad9a4"
+  "gitHead": "1c0ecfa12a0ed23296006ca29a22e77b28d183ed"
 }