@degenerate/generic 0.1.9 → 0.1.11

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

@@ -1,84 +1,400 @@
-import { CollectionReference, DocumentReference } from 'firebase-admin/firestore';
 import * as admin from 'firebase-admin';
-import { IAdditionalApplicationAuditLogIds, ApplicationAuditLogSubType, IApplicationAuditLog } from '../audit-log/application-audit-log-models';
+import { z } from 'zod';
+/**
+ * This contains the additional information audit logs.
+ */
+export declare const IDatabaseAuditLogUpdatesSchema: z.ZodObject<{
+    alai: z.ZodArray<z.ZodObject<{
+        referencePath: z.ZodString;
+        referenceId: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        referencePath: string;
+        referenceId: string;
+    }, {
+        referencePath: string;
+        referenceId: string;
+    }>, "many">;
+    auditLogSubType: z.ZodUnion<[z.ZodEnum<["administrator"]>, z.ZodEnum<["multiplePathALAI"]>, z.ZodEnum<["userRelatedProfile"]>, z.ZodEnum<["profile"]>]>;
+}, "strip", z.ZodTypeAny, {
+    alai: {
+        referencePath: string;
+        referenceId: string;
+    }[];
+    auditLogSubType: "administrator" | "multiplePathALAI" | "userRelatedProfile" | "profile";
+}, {
+    alai: {
+        referencePath: string;
+        referenceId: string;
+    }[];
+    auditLogSubType: "administrator" | "multiplePathALAI" | "userRelatedProfile" | "profile";
+}>;
+export type IDatabaseAuditLogUpdates = z.infer<typeof IDatabaseAuditLogUpdatesSchema>;
 /**
  * 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;
-}
+export declare const IDatabaseChangeInformationSchema: z.ZodObject<{
+    alai: z.ZodArray<z.ZodObject<{
+        referencePath: z.ZodString;
+        referenceId: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        referencePath: string;
+        referenceId: string;
+    }, {
+        referencePath: string;
+        referenceId: string;
+    }>, "many">;
+    auditLogSubType: z.ZodUnion<[z.ZodEnum<["administrator"]>, z.ZodEnum<["multiplePathALAI"]>, z.ZodEnum<["userRelatedProfile"]>, z.ZodEnum<["profile"]>]>;
+    item: z.ZodUnknown;
+    itemDocRef: z.ZodType<admin.firestore.DocumentReference<admin.firestore.DocumentData, admin.firestore.DocumentData>, z.ZodTypeDef, admin.firestore.DocumentReference<admin.firestore.DocumentData, admin.firestore.DocumentData>>;
+}, "strip", z.ZodTypeAny, {
+    alai: {
+        referencePath: string;
+        referenceId: string;
+    }[];
+    auditLogSubType: "administrator" | "multiplePathALAI" | "userRelatedProfile" | "profile";
+    itemDocRef: admin.firestore.DocumentReference<admin.firestore.DocumentData, admin.firestore.DocumentData>;
+    item?: unknown;
+}, {
+    alai: {
+        referencePath: string;
+        referenceId: string;
+    }[];
+    auditLogSubType: "administrator" | "multiplePathALAI" | "userRelatedProfile" | "profile";
+    itemDocRef: admin.firestore.DocumentReference<admin.firestore.DocumentData, admin.firestore.DocumentData>;
+    item?: unknown;
+}>;
+export type IDatabaseChangeInformation = z.infer<typeof IDatabaseChangeInformationSchema>;
 /**
  * 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;
-}
+export declare const IDatabasePropertyChangeInformationSchema: z.ZodObject<{
+    alai: z.ZodArray<z.ZodObject<{
+        referencePath: z.ZodString;
+        referenceId: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        referencePath: string;
+        referenceId: string;
+    }, {
+        referencePath: string;
+        referenceId: string;
+    }>, "many">;
+    auditLogSubType: z.ZodUnion<[z.ZodEnum<["administrator"]>, z.ZodEnum<["multiplePathALAI"]>, z.ZodEnum<["userRelatedProfile"]>, z.ZodEnum<["profile"]>]>;
+    partialObjectUpdate: z.ZodAny;
+    itemDocRef: z.ZodType<admin.firestore.DocumentReference<admin.firestore.DocumentData, admin.firestore.DocumentData>, z.ZodTypeDef, admin.firestore.DocumentReference<admin.firestore.DocumentData, admin.firestore.DocumentData>>;
+}, "strip", z.ZodTypeAny, {
+    alai: {
+        referencePath: string;
+        referenceId: string;
+    }[];
+    auditLogSubType: "administrator" | "multiplePathALAI" | "userRelatedProfile" | "profile";
+    itemDocRef: admin.firestore.DocumentReference<admin.firestore.DocumentData, admin.firestore.DocumentData>;
+    partialObjectUpdate?: any;
+}, {
+    alai: {
+        referencePath: string;
+        referenceId: string;
+    }[];
+    auditLogSubType: "administrator" | "multiplePathALAI" | "userRelatedProfile" | "profile";
+    itemDocRef: admin.firestore.DocumentReference<admin.firestore.DocumentData, admin.firestore.DocumentData>;
+    partialObjectUpdate?: any;
+}>;
+export type IDatabasePropertyChangeInformation = z.infer<typeof IDatabasePropertyChangeInformationSchema>;
 /**
- * This contains the information records and audit logs for database changes
+ * This contains the information for a record and its reference
  */
-export interface IDatabaseUpdates {
-    recordsandRefs: IDatabaseRecordAndRef[];
-    auditLogInfo: IApplicationAuditLog;
-}
+export declare const IDatabaseRecordAndRefSchema: z.ZodObject<{
+    record: z.ZodUnknown;
+    recordDocRef: z.ZodType<admin.firestore.DocumentReference<admin.firestore.DocumentData, admin.firestore.DocumentData>, z.ZodTypeDef, admin.firestore.DocumentReference<admin.firestore.DocumentData, admin.firestore.DocumentData>>;
+}, "strip", z.ZodTypeAny, {
+    recordDocRef: admin.firestore.DocumentReference<admin.firestore.DocumentData, admin.firestore.DocumentData>;
+    record?: unknown;
+}, {
+    recordDocRef: admin.firestore.DocumentReference<admin.firestore.DocumentData, admin.firestore.DocumentData>;
+    record?: unknown;
+}>;
+export type IDatabaseRecordAndRef = z.infer<typeof IDatabaseRecordAndRefSchema>;
 /**
- * This contains the database record and document reference to update.
+ * This contains the information records and audit logs for database changes
  */
-export interface IDatabaseRecordAndRef {
-    record: unknown;
-    recordDocRef: DocumentReference;
-}
+export declare const IDatabaseUpdatesSchema: z.ZodObject<{
+    recordsandRefs: z.ZodArray<z.ZodObject<{
+        record: z.ZodUnknown;
+        recordDocRef: z.ZodType<admin.firestore.DocumentReference<admin.firestore.DocumentData, admin.firestore.DocumentData>, z.ZodTypeDef, admin.firestore.DocumentReference<admin.firestore.DocumentData, admin.firestore.DocumentData>>;
+    }, "strip", z.ZodTypeAny, {
+        recordDocRef: admin.firestore.DocumentReference<admin.firestore.DocumentData, admin.firestore.DocumentData>;
+        record?: unknown;
+    }, {
+        recordDocRef: admin.firestore.DocumentReference<admin.firestore.DocumentData, admin.firestore.DocumentData>;
+        record?: unknown;
+    }>, "many">;
+    auditLogInfo: z.ZodObject<{
+        additionalAuditLogIds: z.ZodArray<z.ZodObject<{
+            referencePath: z.ZodString;
+            referenceId: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            referencePath: string;
+            referenceId: string;
+        }, {
+            referencePath: string;
+            referenceId: string;
+        }>, "many">;
+        applicationAuditLogAction: z.ZodEnum<["create", "update", "delete", "read", "list", "file"]>;
+        applicationAuditLogType: z.ZodEnum<["authorizedAuthority", "global"]>;
+        applicationAuditLogSubType: z.ZodUnion<[z.ZodEnum<["administrator"]>, z.ZodEnum<["multiplePathALAI"]>, z.ZodEnum<["userRelatedProfile"]>, z.ZodEnum<["profile"]>]>;
+        createdAt: z.ZodNumber;
+        createdBy: z.ZodString;
+        currentData: z.ZodOptional<z.ZodAny>;
+        previousData: z.ZodOptional<z.ZodAny>;
+    }, "strip", z.ZodTypeAny, {
+        additionalAuditLogIds: {
+            referencePath: string;
+            referenceId: string;
+        }[];
+        applicationAuditLogAction: "create" | "update" | "delete" | "read" | "list" | "file";
+        applicationAuditLogType: "authorizedAuthority" | "global";
+        applicationAuditLogSubType: "administrator" | "multiplePathALAI" | "userRelatedProfile" | "profile";
+        createdAt: number;
+        createdBy: string;
+        currentData?: any;
+        previousData?: any;
+    }, {
+        additionalAuditLogIds: {
+            referencePath: string;
+            referenceId: string;
+        }[];
+        applicationAuditLogAction: "create" | "update" | "delete" | "read" | "list" | "file";
+        applicationAuditLogType: "authorizedAuthority" | "global";
+        applicationAuditLogSubType: "administrator" | "multiplePathALAI" | "userRelatedProfile" | "profile";
+        createdAt: number;
+        createdBy: string;
+        currentData?: any;
+        previousData?: any;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    recordsandRefs: {
+        recordDocRef: admin.firestore.DocumentReference<admin.firestore.DocumentData, admin.firestore.DocumentData>;
+        record?: unknown;
+    }[];
+    auditLogInfo: {
+        additionalAuditLogIds: {
+            referencePath: string;
+            referenceId: string;
+        }[];
+        applicationAuditLogAction: "create" | "update" | "delete" | "read" | "list" | "file";
+        applicationAuditLogType: "authorizedAuthority" | "global";
+        applicationAuditLogSubType: "administrator" | "multiplePathALAI" | "userRelatedProfile" | "profile";
+        createdAt: number;
+        createdBy: string;
+        currentData?: any;
+        previousData?: any;
+    };
+}, {
+    recordsandRefs: {
+        recordDocRef: admin.firestore.DocumentReference<admin.firestore.DocumentData, admin.firestore.DocumentData>;
+        record?: unknown;
+    }[];
+    auditLogInfo: {
+        additionalAuditLogIds: {
+            referencePath: string;
+            referenceId: string;
+        }[];
+        applicationAuditLogAction: "create" | "update" | "delete" | "read" | "list" | "file";
+        applicationAuditLogType: "authorizedAuthority" | "global";
+        applicationAuditLogSubType: "administrator" | "multiplePathALAI" | "userRelatedProfile" | "profile";
+        createdAt: number;
+        createdBy: string;
+        currentData?: any;
+        previousData?: any;
+    };
+}>;
+export type IDatabaseUpdates = z.infer<typeof IDatabaseUpdatesSchema>;
+export declare const OrderByDirectionSchema: z.ZodEnum<["desc", "asc"]>;
+export type OrderByDirection = z.infer<typeof OrderByDirectionSchema>;
+export declare const WhereFilterOpSchema: z.ZodEnum<["<", "<=", "==", "!=", ">=", ">", "array-contains", "in", "not-in", "array-contains-any"]>;
+export type WhereFilterOp = z.infer<typeof WhereFilterOpSchema>;
 /**
  * This contains the information to get a single item from the database.
  */
-export interface IDatabaseGetItem extends IDatabaseAuditLogUpdates {
-    itemDocRef: DocumentReference;
+export declare const IDatabaseGetItemSchema: z.ZodObject<z.objectUtil.extendShape<{
+    alai: z.ZodArray<z.ZodObject<{
+        referencePath: z.ZodString;
+        referenceId: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        referencePath: string;
+        referenceId: string;
+    }, {
+        referencePath: string;
+        referenceId: string;
+    }>, "many">;
+    auditLogSubType: z.ZodUnion<[z.ZodEnum<["administrator"]>, z.ZodEnum<["multiplePathALAI"]>, z.ZodEnum<["userRelatedProfile"]>, z.ZodEnum<["profile"]>]>;
+}, {
+    itemDocRef: z.ZodType<admin.firestore.DocumentReference<admin.firestore.DocumentData, admin.firestore.DocumentData>, z.ZodTypeDef, admin.firestore.DocumentReference<admin.firestore.DocumentData, admin.firestore.DocumentData>>;
+    throwErrorOnNotFound: z.ZodBoolean;
+}>, "strip", z.ZodTypeAny, {
+    alai: {
+        referencePath: string;
+        referenceId: string;
+    }[];
+    auditLogSubType: "administrator" | "multiplePathALAI" | "userRelatedProfile" | "profile";
+    itemDocRef: admin.firestore.DocumentReference<admin.firestore.DocumentData, admin.firestore.DocumentData>;
     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;
-}
+}, {
+    alai: {
+        referencePath: string;
+        referenceId: string;
+    }[];
+    auditLogSubType: "administrator" | "multiplePathALAI" | "userRelatedProfile" | "profile";
+    itemDocRef: admin.firestore.DocumentReference<admin.firestore.DocumentData, admin.firestore.DocumentData>;
+    throwErrorOnNotFound: boolean;
+}>;
+export type IDatabaseGetItem = z.infer<typeof IDatabaseGetItemSchema>;
 /**
  * This contains the information that is needed to get information from the database.
  */
-export interface IDatabaseOrderBy {
+export declare const IDatabaseOrderBySchema: z.ZodObject<{
+    fieldPath: z.ZodUnion<[z.ZodString, z.ZodType<admin.firestore.FieldPath, z.ZodTypeDef, admin.firestore.FieldPath>]>;
+    direction: z.ZodEnum<["desc", "asc"]>;
+}, "strip", z.ZodTypeAny, {
+    fieldPath: string | admin.firestore.FieldPath;
+    direction: "desc" | "asc";
+}, {
     fieldPath: string | admin.firestore.FieldPath;
-    direction: admin.firestore.OrderByDirection;
-}
+    direction: "desc" | "asc";
+}>;
+export type IDatabaseOrderBy = z.infer<typeof IDatabaseOrderBySchema>;
 /**
  * This contains the query information for the database if it is required
  */
-export interface IDatabaseQueryFields {
+export declare const IDatabaseQueryFieldsSchema: z.ZodObject<{
+    fieldPath: z.ZodUnion<[z.ZodString, z.ZodType<admin.firestore.FieldPath, z.ZodTypeDef, admin.firestore.FieldPath>]>;
+    opStr: z.ZodEnum<["<", "<=", "==", "!=", ">=", ">", "array-contains", "in", "not-in", "array-contains-any"]>;
+    value: z.ZodAny;
+}, "strip", z.ZodTypeAny, {
     fieldPath: string | admin.firestore.FieldPath;
-    opStr: admin.firestore.WhereFilterOp;
-    value: any;
-}
+    opStr: "<" | "<=" | "==" | "!=" | ">=" | ">" | "array-contains" | "in" | "not-in" | "array-contains-any";
+    value?: any;
+}, {
+    fieldPath: string | admin.firestore.FieldPath;
+    opStr: "<" | "<=" | "==" | "!=" | ">=" | ">" | "array-contains" | "in" | "not-in" | "array-contains-any";
+    value?: any;
+}>;
+export type IDatabaseQueryFields = z.infer<typeof IDatabaseQueryFieldsSchema>;
 /**
- * This contains the information to delete a single item from the database.
+ * This contains the information that is needed to get multiple items from the database.
  */
-export interface IDatabaseDeleteItem extends IDatabaseAuditLogUpdates {
-    itemDocRef: DocumentReference;
-    throwErrorOnNotFound: boolean;
-}
+export declare const IDatabaseGetInformationSchema: z.ZodObject<z.objectUtil.extendShape<{
+    alai: z.ZodArray<z.ZodObject<{
+        referencePath: z.ZodString;
+        referenceId: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        referencePath: string;
+        referenceId: string;
+    }, {
+        referencePath: string;
+        referenceId: string;
+    }>, "many">;
+    auditLogSubType: z.ZodUnion<[z.ZodEnum<["administrator"]>, z.ZodEnum<["multiplePathALAI"]>, z.ZodEnum<["userRelatedProfile"]>, z.ZodEnum<["profile"]>]>;
+}, {
+    itemColRef: z.ZodType<admin.firestore.CollectionReference<admin.firestore.DocumentData, admin.firestore.DocumentData>, z.ZodTypeDef, admin.firestore.CollectionReference<admin.firestore.DocumentData, admin.firestore.DocumentData>>;
+    lastId: z.ZodString;
+    orderBy: z.ZodOptional<z.ZodObject<{
+        fieldPath: z.ZodUnion<[z.ZodString, z.ZodType<admin.firestore.FieldPath, z.ZodTypeDef, admin.firestore.FieldPath>]>;
+        direction: z.ZodEnum<["desc", "asc"]>;
+    }, "strip", z.ZodTypeAny, {
+        fieldPath: string | admin.firestore.FieldPath;
+        direction: "desc" | "asc";
+    }, {
+        fieldPath: string | admin.firestore.FieldPath;
+        direction: "desc" | "asc";
+    }>>;
+    queryFields: z.ZodArray<z.ZodObject<{
+        fieldPath: z.ZodUnion<[z.ZodString, z.ZodType<admin.firestore.FieldPath, z.ZodTypeDef, admin.firestore.FieldPath>]>;
+        opStr: z.ZodEnum<["<", "<=", "==", "!=", ">=", ">", "array-contains", "in", "not-in", "array-contains-any"]>;
+        value: z.ZodAny;
+    }, "strip", z.ZodTypeAny, {
+        fieldPath: string | admin.firestore.FieldPath;
+        opStr: "<" | "<=" | "==" | "!=" | ">=" | ">" | "array-contains" | "in" | "not-in" | "array-contains-any";
+        value?: any;
+    }, {
+        fieldPath: string | admin.firestore.FieldPath;
+        opStr: "<" | "<=" | "==" | "!=" | ">=" | ">" | "array-contains" | "in" | "not-in" | "array-contains-any";
+        value?: any;
+    }>, "many">;
+    isMaxSizeDocumentSet: z.ZodOptional<z.ZodBoolean>;
+}>, "strip", z.ZodTypeAny, {
+    alai: {
+        referencePath: string;
+        referenceId: string;
+    }[];
+    auditLogSubType: "administrator" | "multiplePathALAI" | "userRelatedProfile" | "profile";
+    itemColRef: admin.firestore.CollectionReference<admin.firestore.DocumentData, admin.firestore.DocumentData>;
+    lastId: string;
+    queryFields: {
+        fieldPath: string | admin.firestore.FieldPath;
+        opStr: "<" | "<=" | "==" | "!=" | ">=" | ">" | "array-contains" | "in" | "not-in" | "array-contains-any";
+        value?: any;
+    }[];
+    orderBy?: {
+        fieldPath: string | admin.firestore.FieldPath;
+        direction: "desc" | "asc";
+    } | undefined;
+    isMaxSizeDocumentSet?: boolean | undefined;
+}, {
+    alai: {
+        referencePath: string;
+        referenceId: string;
+    }[];
+    auditLogSubType: "administrator" | "multiplePathALAI" | "userRelatedProfile" | "profile";
+    itemColRef: admin.firestore.CollectionReference<admin.firestore.DocumentData, admin.firestore.DocumentData>;
+    lastId: string;
+    queryFields: {
+        fieldPath: string | admin.firestore.FieldPath;
+        opStr: "<" | "<=" | "==" | "!=" | ">=" | ">" | "array-contains" | "in" | "not-in" | "array-contains-any";
+        value?: any;
+    }[];
+    orderBy?: {
+        fieldPath: string | admin.firestore.FieldPath;
+        direction: "desc" | "asc";
+    } | undefined;
+    isMaxSizeDocumentSet?: boolean | undefined;
+}>;
+export type IDatabaseGetInformation = z.infer<typeof IDatabaseGetInformationSchema>;
 /**
- * This contains the additional information audit logs.
+ * This contains the information to delete a single item from the database.
  */
-export interface IDatabaseAuditLogUpdates {
-    alai: IAdditionalApplicationAuditLogIds[];
-    auditLogSubType: ApplicationAuditLogSubType;
-}
+export declare const IDatabaseDeleteItemSchema: z.ZodObject<z.objectUtil.extendShape<{
+    alai: z.ZodArray<z.ZodObject<{
+        referencePath: z.ZodString;
+        referenceId: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        referencePath: string;
+        referenceId: string;
+    }, {
+        referencePath: string;
+        referenceId: string;
+    }>, "many">;
+    auditLogSubType: z.ZodUnion<[z.ZodEnum<["administrator"]>, z.ZodEnum<["multiplePathALAI"]>, z.ZodEnum<["userRelatedProfile"]>, z.ZodEnum<["profile"]>]>;
+}, {
+    itemDocRef: z.ZodType<admin.firestore.DocumentReference<admin.firestore.DocumentData, admin.firestore.DocumentData>, z.ZodTypeDef, admin.firestore.DocumentReference<admin.firestore.DocumentData, admin.firestore.DocumentData>>;
+    throwErrorOnNotFound: z.ZodBoolean;
+}>, "strip", z.ZodTypeAny, {
+    alai: {
+        referencePath: string;
+        referenceId: string;
+    }[];
+    auditLogSubType: "administrator" | "multiplePathALAI" | "userRelatedProfile" | "profile";
+    itemDocRef: admin.firestore.DocumentReference<admin.firestore.DocumentData, admin.firestore.DocumentData>;
+    throwErrorOnNotFound: boolean;
+}, {
+    alai: {
+        referencePath: string;
+        referenceId: string;
+    }[];
+    auditLogSubType: "administrator" | "multiplePathALAI" | "userRelatedProfile" | "profile";
+    itemDocRef: admin.firestore.DocumentReference<admin.firestore.DocumentData, admin.firestore.DocumentData>;
+    throwErrorOnNotFound: boolean;
+}>;
+export type IDatabaseDeleteItem = z.infer<typeof IDatabaseDeleteItemSchema>;
 //# sourceMappingURL=firestore-models.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"firestore-models.d.ts","sourceRoot":"","sources":["../../../../src/models/application/database/firestore-models.ts"],"names":[],"mappings":"AAAA,OAAO,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"}
+{"version":3,"file":"firestore-models.d.ts","sourceRoot":"","sources":["../../../../src/models/application/database/firestore-models.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,gBAAgB,CAAC;AACxC,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAWxB;;GAEG;AAEH,eAAO,MAAM,8BAA8B;;;;;;;;;;;;;;;;;;;;;;;;EAGzC,CAAC;AAEH,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,CAAC;AAMtF;;GAEG;AACH,eAAO,MAAM,gCAAgC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAK3C,CAAC;AAEH,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gCAAgC,CAAC,CAAC;AAE1F;;;;GAIG;AACH,eAAO,MAAM,wCAAwC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAKnD,CAAC;AAEH,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wCAAwC,CAAC,CAAC;AAE1G;;GAEG;AACH,eAAO,MAAM,2BAA2B;;;;;;;;;EAGtC,CAAC;AAEH,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAEhF;;GAEG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAGjC,CAAC;AAEH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAQtE,eAAO,MAAM,sBAAsB,4BAA0B,CAAC;AAG9D,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAGtE,eAAO,MAAM,mBAAmB,uGAA8G,CAAA;AAC9I,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEhE;;GAEG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAGjC,CAAC;AAEH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAEtE;;GAEG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;EAGjC,CAAC;AAGH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AACtE;;GAEG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;EAIrC,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAG9E;;GAEG;AACH,eAAO,MAAM,6BAA6B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAMxC,CAAC;AAGH,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,6BAA6B,CAAC,CAAC;AAOpF;;GAEG;AACH,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAGpC,CAAC;AAEH,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC"}

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

@@ -1,4 +1,122 @@
 "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.IDatabaseDeleteItemSchema = exports.IDatabaseGetInformationSchema = exports.IDatabaseQueryFieldsSchema = exports.IDatabaseOrderBySchema = exports.IDatabaseGetItemSchema = exports.WhereFilterOpSchema = exports.OrderByDirectionSchema = exports.IDatabaseUpdatesSchema = exports.IDatabaseRecordAndRefSchema = exports.IDatabasePropertyChangeInformationSchema = exports.IDatabaseChangeInformationSchema = exports.IDatabaseAuditLogUpdatesSchema = void 0;
+const admin = __importStar(require("firebase-admin"));
+const zod_1 = require("zod");
+const firestore_1 = require("firebase-admin/firestore");
+const application_audit_log_models_1 = require("../audit-log/application-audit-log-models");
+//#region Backend Data Models
+//#region Audit Log Information
+/**
+ * This contains the additional information audit logs.
+ */
+exports.IDatabaseAuditLogUpdatesSchema = zod_1.z.object({
+    alai: zod_1.z.array(application_audit_log_models_1.AdditionalApplicationAuditLogIdsSchema), // the additional application audit log ids
+    auditLogSubType: application_audit_log_models_1.ApplicationAuditLogSubTypeSchema, // the audit log sub type
+});
 //#endregion Audit Log Information
-//#endregion Backend Data Models
+//#region Database Change Information
+/**
+ * This contains the information that is needed to pass a change to the generic database functions.
+ */
+exports.IDatabaseChangeInformationSchema = zod_1.z.object({
+    alai: zod_1.z.array(application_audit_log_models_1.AdditionalApplicationAuditLogIdsSchema), // the additional application audit log ids
+    auditLogSubType: application_audit_log_models_1.ApplicationAuditLogSubTypeSchema, // the audit log sub type
+    item: zod_1.z.unknown(), // the item to add to the database
+    itemDocRef: zod_1.z.custom(arg => arg instanceof firestore_1.DocumentReference), // the item document reference (where to add the item to the database)
+});
+/**
+ * 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.
+ */
+exports.IDatabasePropertyChangeInformationSchema = zod_1.z.object({
+    alai: zod_1.z.array(application_audit_log_models_1.AdditionalApplicationAuditLogIdsSchema), // the additional application audit log ids
+    auditLogSubType: application_audit_log_models_1.ApplicationAuditLogSubTypeSchema, // the audit log sub type
+    partialObjectUpdate: zod_1.z.any(), // the partial object to update
+    itemDocRef: zod_1.z.custom(arg => arg instanceof firestore_1.DocumentReference), // the item document reference (where to add the item to the database)
+});
+/**
+ * This contains the information for a record and its reference
+ */
+exports.IDatabaseRecordAndRefSchema = zod_1.z.object({
+    record: zod_1.z.unknown(), // the record to update
+    recordDocRef: zod_1.z.custom(arg => arg instanceof firestore_1.DocumentReference), // the record document reference
+});
+/**
+ * This contains the information records and audit logs for database changes
+ */
+exports.IDatabaseUpdatesSchema = zod_1.z.object({
+    recordsandRefs: zod_1.z.array(exports.IDatabaseRecordAndRefSchema), // the record to update
+    auditLogInfo: application_audit_log_models_1.IApplicationAuditLogSchema, // the audit logs to add
+});
+//#endregion Database Change Information
+//#region Database Get Information
+// Define the OrderByDirection schema
+exports.OrderByDirectionSchema = zod_1.z.enum(['desc', 'asc']);
+// Define the WhereFilterOpSchema schema
+exports.WhereFilterOpSchema = zod_1.z.enum(['<', '<=', '==', '!=', '>=', '>', 'array-contains', 'in', 'not-in', 'array-contains-any']);
+/**
+ * This contains the information to get a single item from the database.
+ */
+exports.IDatabaseGetItemSchema = exports.IDatabaseAuditLogUpdatesSchema.extend({
+    itemDocRef: zod_1.z.custom(arg => arg instanceof firestore_1.DocumentReference), // the document reference to get the item from
+    throwErrorOnNotFound: zod_1.z.boolean(), // if true, then throw an error if the item is not found.
+});
+/**
+ * This contains the information that is needed to get information from the database.
+ */
+exports.IDatabaseOrderBySchema = zod_1.z.object({
+    fieldPath: zod_1.z.union([zod_1.z.string(), zod_1.z.instanceof(admin.firestore.FieldPath)]), // the field to order by
+    direction: exports.OrderByDirectionSchema, // the direction to order by
+});
+/**
+ * This contains the query information for the database if it is required
+ */
+exports.IDatabaseQueryFieldsSchema = zod_1.z.object({
+    fieldPath: zod_1.z.union([zod_1.z.string(), zod_1.z.instanceof(admin.firestore.FieldPath)]),
+    opStr: exports.WhereFilterOpSchema,
+    value: zod_1.z.any(),
+});
+/**
+ * This contains the information that is needed to get multiple items from the database.
+ */
+exports.IDatabaseGetInformationSchema = exports.IDatabaseAuditLogUpdatesSchema.extend({
+    itemColRef: zod_1.z.custom(arg => arg instanceof firestore_1.CollectionReference), // the collection reference to get the items from
+    lastId: zod_1.z.string(), // the last id to get the next set of items.
+    orderBy: exports.IDatabaseOrderBySchema.optional(), // how to order the items
+    queryFields: zod_1.z.array(exports.IDatabaseQueryFieldsSchema), // the fields to query
+    isMaxSizeDocumentSet: zod_1.z.boolean().optional(), // if true, then the max size document the max number of docs to return
+});
+//#endregion Database Get Information
+//#region Database Delete Information
+/**
+ * This contains the information to delete a single item from the database.
+ */
+exports.IDatabaseDeleteItemSchema = exports.IDatabaseAuditLogUpdatesSchema.extend({
+    itemDocRef: zod_1.z.custom(arg => arg instanceof firestore_1.DocumentReference), // the document reference to get the item to delete
+    throwErrorOnNotFound: zod_1.z.boolean(), // if true, then throw an error if the item is not found.
+});