@degenerate/endpoints 0.0.3 → 0.0.4

package/dist/generic/src/helpers/object-validation-helpers.js

@@ -0,0 +1,254 @@
+"use strict";
+// This file contains the validation functions for objects.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateUrl = exports.validateStringHex = exports.validateString = exports.validateNumber = exports.validateDate = exports.validateBoolean = exports.validateArray = void 0;
+/**
+ * Checks that an object is an array and that it has the minimum number of items.
+ *
+ * @param incomingObject the object to check
+ * @param minimumLength the minimum number of objects to match (zero by default)
+ * @param maximumLength the maximum number of objects to match will default to the array length if not provided
+ *
+ * @returns whether the criteria matches.
+ */
+const validateArray = (incomingObject, minimumLength = 0, maximumLength) => {
+    if (incomingObject && Array.isArray(incomingObject) && incomingObject.length >= minimumLength) {
+        if (!maximumLength) {
+            return true;
+        }
+        else {
+            if (incomingObject.length <= maximumLength) {
+                return true;
+            }
+            else {
+                return false;
+            }
+        }
+    }
+    else {
+        return false;
+    }
+};
+exports.validateArray = validateArray;
+/**
+ * This validates an incoming shape of a boolean type data.
+ *
+ * @param incomingObject an object to validate as a boolean.
+ * @param undefinedValid whether the item can be undefined or not (false by default)
+ *
+ * @returns whether the shape is valid.
+ */
+const validateBoolean = (incomingObject, undefinedValid = false) => {
+    if (undefinedValid && typeof incomingObject === 'undefined') { // if undefined is valid and it"s undefined
+        return true;
+    }
+    if (typeof incomingObject === 'boolean') {
+        return true;
+    }
+    else {
+        return false;
+    }
+};
+exports.validateBoolean = validateBoolean;
+/**
+ * This validates a date object or a string that can be converted to a date object.
+ * @param dateToValidate the date to validate
+ * @param undefinedValid whether the item can be undefined or not (false by default)
+ * @param allowFutureDated the date can be in the future (false by default)
+ * @param ensureAtLeast18YearsAgo whether the date is at least 18 years ago (true by default)
+ *
+ * @returns
+ */
+const validateDate = (dateToValidate, undefinedValid = false, allowFutureDated = false, ensureAtLeast18YearsAgo = false) => {
+    if (undefinedValid && (typeof dateToValidate === 'undefined' || dateToValidate === '' || dateToValidate === null)) {
+        return true;
+    }
+    let date; // a placeholder for the date object
+    if (typeof dateToValidate === 'string') {
+        date = new Date(dateToValidate); // try to parse the date
+        if (isNaN(date.getTime())) { // if it's not a valid date
+            return false; // return false
+        }
+        return true;
+    }
+    else {
+        if (!(typeof dateToValidate === 'object' && dateToValidate !== null)) {
+            return false; // the date isn't an object
+        }
+        if (Object.prototype.toString.call(dateToValidate) !== '[object Date]') {
+            return false; // the date isn't a date object
+        }
+        // Check if the date is in the future and this is not allowed
+        if (!allowFutureDated && dateToValidate > new Date()) {
+            return false;
+        }
+        // determine if the date is newer than 18 years in the past
+        if (ensureAtLeast18YearsAgo) {
+            const today = new Date();
+            const eighteenYearsAgo = new Date(today.getFullYear() - 18, today.getMonth(), today.getDate());
+            return dateToValidate <= eighteenYearsAgo;
+        }
+        // otherwise the date is valid.
+        return true;
+    }
+};
+exports.validateDate = validateDate;
+/**
+ * This validates that the incoming Object is a number and that it is in the range (if provided)
+ *
+ * @param incomingObject object to validate to a number
+ * @param min (optional) minimum number
+ * @param max (optional) maximum number
+ * @returns
+ */
+const validateNumber = (incomingObject, min, max) => {
+    if (typeof incomingObject === 'number') {
+        if (validateMin(incomingObject, min) && validateMax(incomingObject, max)) {
+            return true;
+        }
+        else {
+            return false;
+        }
+    }
+    else {
+        return false;
+    }
+};
+exports.validateNumber = validateNumber;
+/**
+ * This validates an incoming shape of a set of files links to the data.
+ *
+ * @param incomingObject an object to validate as a string.
+ * @param hasNoSpaces whether the item should have no spaces in it (false by default)
+ * @param undefinedValid whether the item can be undefined or not (false by default)
+ * @param emptyStringValid whether the item can be an empty string or not (false by default)
+ *
+ * @returns whether the shape is valid.
+ */
+const validateString = (incomingObject, hasNoSpaces = false, undefinedValid = false, emptyStringValid = false) => {
+    // if undefined is valid and check if it's undefined and if so, return true
+    if (undefinedValid) {
+        if (typeof incomingObject === 'undefined') { // if undefined is valid and it"s undefined
+            return true;
+        }
+        if (incomingObject === null) { // include null values.
+            return true;
+        }
+    }
+    // Check if the string is empty and if it's valid to be empty
+    if (emptyStringValid) {
+        if (typeof incomingObject === 'string' && incomingObject.length === 0) {
+            return true;
+        }
+    }
+    // if it's a string and it's not empty
+    if (typeof incomingObject === 'string') {
+        // check that it is a string and that it is not empty
+        if (incomingObject.length === 0) {
+            return false;
+        }
+        // check if it has no spaces
+        if (hasNoSpaces) {
+            return incomingObject.indexOf(' ') === -1;
+        }
+        // otherwise it's a valid string
+        return true;
+    }
+    else {
+        return false;
+    }
+};
+exports.validateString = validateString;
+/**
+ * This validates that an incoming object is a valid hex string without spaces.
+ *
+ * @param incomingObject the object to validate
+ * @returns
+ */
+const validateStringHex = (incomingObject) => {
+    // make sure its a string
+    const isStringWithoutSpaces = validateString(incomingObject, true, false, false);
+    // make sure its a valid hex string
+    if (!isStringWithoutSpaces) {
+        return false;
+    }
+    // check that it is a hex string
+    const hexStringRegexp = /^[0-9a-fA-F]+$/;
+    if (!hexStringRegexp.test(incomingObject)) {
+        return false;
+    }
+    return true;
+};
+exports.validateStringHex = validateStringHex;
+/**
+ * This validates that an incoming object is a valid URL.
+ *
+ * @param incomingUrl the URL to check
+ * @param undefinedValid whether the item can be undefined or not (false by default)
+ * @returns wether it is a valid URL or not
+ */
+const validateUrl = (incomingUrl, undefinedValid = false) => {
+    if (undefinedValid && (typeof incomingUrl === 'undefined' || incomingUrl === '')) { // if undefined is valid and it"s undefined
+        return true;
+    }
+    if (typeof incomingUrl !== 'string') {
+        return false;
+    }
+    if (incomingUrl.indexOf(' ') !== -1) {
+        return false;
+    }
+    //Is it recognized as a valid URL?
+    let givenURL;
+    try {
+        givenURL = new URL(incomingUrl);
+        //Is the domain name a valid one with TLD and using HTTP or HTTPS?
+        const validDomainRegexp = /^([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,}$/im;
+        return validDomainRegexp.test(givenURL.host) && (givenURL.protocol === 'http:' || givenURL.protocol === 'https:');
+    }
+    catch (error) {
+        return false;
+    }
+};
+exports.validateUrl = validateUrl;
+//#endregion Public Functions
+//#region Internal Functions
+/**
+ * validates that an incoming number is greater than the minimum if it was provided.
+ *
+ * @param incomingNumber the number to check
+ * @param min the minimum value.
+ * @returns
+ */
+const validateMin = (incomingNumber, min) => {
+    if (typeof min === 'number') {
+        if (incomingNumber >= min) {
+            return true;
+        }
+        else {
+            return false;
+        }
+    }
+    else {
+        return true;
+    }
+};
+/**
+ * validates that an incoming number is less than or equal to the mamimum if it was provided.
+ *
+ * @param incomingNumber the number to check
+ * @param max the maximum value.
+ * @returns
+ */
+const validateMax = (incomingNumber, max) => {
+    if (typeof max === 'number') {
+        if (incomingNumber <= max) {
+            return true;
+        }
+        else {
+            return false;
+        }
+    }
+    else {
+        return true;
+    }
+};

package/dist/generic/src/models/application/audit-log/application-audit-log-models.d.ts

@@ -0,0 +1,87 @@
+/**
+ * This contains interfaces for the audit logs that are generated in the system.
+ * This type of audit log is used to create and log application functions within a non structured database.
+ */
+export type IApplicationAuditLog = IApplicationAuditLogUnstructured;
+/**
+ * This is an application audit log.
+ */
+export interface IApplicationAuditLogUnstructured {
+    additionalAuditLogIds: IAdditionalApplicationAuditLogIds[];
+    applicationAuditLogAction: ApplicationAuditLogAction;
+    applicationAuditLogType: ApplicationAuditLogType;
+    applicationAuditLogSubType: ApplicationAuditLogSubType;
+    createdAt: number;
+    createdBy: string;
+    currentData?: any;
+    previousData?: any;
+}
+/**
+ * This contains the additional audit log Ids in order of the access in the application
+ * for database this would be the reference path and reference Id
+ * for User Financial data this would be
+ * [
+ *  { referencePath: 'Administrator', referenceId: '{{ administratorId }} ' }, // These are every path downstream from the root data
+ *  { referencePath: 'Accounts', referenceId: '{{ accountId }}' },
+ * ]
+ *
+ * These are available in the helper files based on the Application Audit Log Sub Types.
+ */
+export interface IAdditionalApplicationAuditLogIds {
+    referencePath: string;
+    referenceId: string;
+}
+/**
+ * This contains the enum for the audit log actions.
+ */
+export declare enum ApplicationAuditLogAction {
+    create = "create",
+    update = "update",
+    delete = "delete",
+    read = "read",
+    list = "list",
+    file = "file"
+}
+/**
+ * This contains the model for the audit logs that are generated in the system.
+ */
+export declare enum ApplicationAuditLogType {
+    authorizedAuthority = "authorizedAuthority",// the authorized authority audit log
+    global = "global"
+}
+/**
+ * This contains the enum for the audit log sub types for the multiple path classes.
+ */
+export declare enum MultiplePathAuditLogSubType {
+    multiplePathALAI = "multiplePathALAI"
+}
+/**
+ * This contains the interface for keeping the query audit log and value.
+ */
+export interface IQueryObjectAndValueForAuditLog {
+    queryObject: string;
+    queryValue: string | number | boolean;
+}
+/**
+ * This contains the enum for the audit log sub types.
+ */
+export type ApplicationAuditLogSubType = AdministrationAuditLogSubType | UserAuditLogSubType | PublicDataAuditLogSubType | MultiplePathAuditLogSubType;
+/**
+ * This contains the enum for the audit log sub types for the administrator classes.
+ */
+export declare enum AdministrationAuditLogSubType {
+    administrator = "administrator"
+}
+/**
+ * This contains the enum for the audit log sub types for the user classes.
+ */
+export declare enum UserAuditLogSubType {
+    profile = "profile"
+}
+/**
+ * This contains the enum for the audit log sub types for the public data classes.
+ */
+export declare enum PublicDataAuditLogSubType {
+    userRelatedProfile = "userRelatedProfile"
+}
+//# sourceMappingURL=application-audit-log-models.d.ts.map

package/dist/generic/src/models/application/audit-log/application-audit-log-models.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"application-audit-log-models.d.ts","sourceRoot":"","sources":["../../../../../../../generic/src/models/application/audit-log/application-audit-log-models.ts"],"names":[],"mappings":"AAEA;;;GAGG;AAIH,MAAM,MAAM,oBAAoB,GAAG,gCAAgC,CAAC;AACpE;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAC7C,qBAAqB,EAAE,iCAAiC,EAAE,CAAC;IAC3D,yBAAyB,EAAE,yBAAyB,CAAC;IACrD,uBAAuB,EAAE,uBAAuB,CAAC;IACjD,0BAA0B,EAAE,0BAA0B,CAAC;IACvD,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,GAAG,CAAC;IAClB,YAAY,CAAC,EAAE,GAAG,CAAC;CACtB;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,iCAAiC;IAC9C,aAAa,EAAE,MAAM,CAAC;IACtB,WAAW,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,oBAAY,yBAAyB;IACjC,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,IAAI,SAAS;IACb,IAAI,SAAS;IACb,IAAI,SAAS;CAChB;AAED;;GAEG;AACH,oBAAY,uBAAuB;IAC/B,mBAAmB,wBAAwB,CAAE,qCAAqC;IAClF,MAAM,WAAW;CACpB;AAKD;;GAEG;AACH,oBAAY,2BAA2B;IACnC,gBAAgB,qBAAqB;CACxC;AAMD;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC5C,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;CACzC;AAMD;;GAEG;AAEH,MAAM,MAAM,0BAA0B,GAAG,6BAA6B,GAAG,mBAAmB,GAAG,yBAAyB,GAClH,2BAA2B,CAAC;AAIlC;;GAEG;AACH,oBAAY,6BAA6B;IACrC,aAAa,kBAAkB;CAClC;AAMD;;GAEG;AACH,oBAAY,mBAAmB;IAC3B,OAAO,YAAY;CACtB;AAMD;;GAEG;AACH,oBAAY,yBAAyB;IACjC,kBAAkB,uBAAuB;CAC5C"}

package/dist/generic/src/models/application/audit-log/application-audit-log-models.js

@@ -0,0 +1,59 @@
+"use strict";
+/* eslint-disable @typescript-eslint/no-explicit-any */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PublicDataAuditLogSubType = exports.UserAuditLogSubType = exports.AdministrationAuditLogSubType = exports.MultiplePathAuditLogSubType = exports.ApplicationAuditLogType = exports.ApplicationAuditLogAction = void 0;
+/**
+ * This contains the enum for the audit log actions.
+ */
+var ApplicationAuditLogAction;
+(function (ApplicationAuditLogAction) {
+    ApplicationAuditLogAction["create"] = "create";
+    ApplicationAuditLogAction["update"] = "update";
+    ApplicationAuditLogAction["delete"] = "delete";
+    ApplicationAuditLogAction["read"] = "read";
+    ApplicationAuditLogAction["list"] = "list";
+    ApplicationAuditLogAction["file"] = "file";
+})(ApplicationAuditLogAction || (exports.ApplicationAuditLogAction = ApplicationAuditLogAction = {}));
+/**
+ * This contains the model for the audit logs that are generated in the system.
+ */
+var ApplicationAuditLogType;
+(function (ApplicationAuditLogType) {
+    ApplicationAuditLogType["authorizedAuthority"] = "authorizedAuthority";
+    ApplicationAuditLogType["global"] = "global";
+})(ApplicationAuditLogType || (exports.ApplicationAuditLogType = ApplicationAuditLogType = {}));
+//#region Multiple Path Audit Log Types
+/**
+ * This contains the enum for the audit log sub types for the multiple path classes.
+ */
+var MultiplePathAuditLogSubType;
+(function (MultiplePathAuditLogSubType) {
+    MultiplePathAuditLogSubType["multiplePathALAI"] = "multiplePathALAI";
+})(MultiplePathAuditLogSubType || (exports.MultiplePathAuditLogSubType = MultiplePathAuditLogSubType = {}));
+//#region Administration Audit Log Types
+/**
+ * This contains the enum for the audit log sub types for the administrator classes.
+ */
+var AdministrationAuditLogSubType;
+(function (AdministrationAuditLogSubType) {
+    AdministrationAuditLogSubType["administrator"] = "administrator";
+})(AdministrationAuditLogSubType || (exports.AdministrationAuditLogSubType = AdministrationAuditLogSubType = {}));
+// #endregion Administration Audit Log Types
+//#region User Audit Log Types
+/**
+ * This contains the enum for the audit log sub types for the user classes.
+ */
+var UserAuditLogSubType;
+(function (UserAuditLogSubType) {
+    UserAuditLogSubType["profile"] = "profile";
+})(UserAuditLogSubType || (exports.UserAuditLogSubType = UserAuditLogSubType = {}));
+//#endregion User Audit Log Types
+//#region Public Data audit log types
+/**
+ * This contains the enum for the audit log sub types for the public data classes.
+ */
+var PublicDataAuditLogSubType;
+(function (PublicDataAuditLogSubType) {
+    PublicDataAuditLogSubType["userRelatedProfile"] = "userRelatedProfile";
+})(PublicDataAuditLogSubType || (exports.PublicDataAuditLogSubType = PublicDataAuditLogSubType = {}));
+//#endregion Public Data audit log types

package/dist/generic/src/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/generic/src/models/application/database/firestore-models.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"firestore-models.d.ts","sourceRoot":"","sources":["../../../../../../../generic/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/generic/src/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/dist/generic/src/models/authorization/authorization-models.d.ts

@@ -0,0 +1,81 @@
+/**
+ * This is the authorities that can be validated with incoming requests.
+ * it is AuthorityName Declaration-with ending of the original hex version of the publickey, publickey for the authority
+ */
+export type IJWTAuthority = Map<IAuthorizationIssuer, string>;
+/**
+ * This contains the types of validation that can be done on the authority.
+ */
+export declare enum AuthorityValidationType {
+    JWT = "jwt"
+}
+/**
+ * This is the payload for the jwt.
+ */
+export interface IAuthorizationPayload {
+    [key: string]: any;
+}
+/**
+ * This is the header for the jwt.
+ */
+export interface IAuthorizationHeader {
+    alg: string;
+    typ: string;
+}
+/**
+ * This is the audience that the jwt is intended for.
+ */
+export declare enum AuthorizationAudience {
+    AUTHORITIES = "authorities",// the authorities in the SAFE Ecosystem
+    SHAREDATA = "sharedata",// the Share Data in the SAFE Ecosystem
+    FUNCTIONS = "functions",// the functions in the SAFE Ecosystem
+    RULES = "rules",// the rules in the SAFE Ecosystem
+    EVENTS = "events",// the events in the SAFE Ecosystem
+    ENDPOINTS = "endpoints"
+}
+/**
+ * This contains the start of the subject for the authorization subject
+ */
+export declare enum AuthorizationSubjectStart {
+    USER = "user",
+    SAFE_NETWORK = "safe-network"
+}
+/**
+ * This type represents the formatted authorization subject.
+ */
+export type IAuthorizationSubject = `${AuthorizationSubjectStart}:${string}`;
+/**
+ * This is the issuer of the token.
+ */
+export type IAuthorizationIssuer = `${string}-${string}`;
+/**
+ * Any custom network claims that are added to the token.
+ */
+export interface ICustomClaims {
+    [key: string]: any;
+}
+/**
+ * This interface represents the valid safe token payload (after deconstructing the jwt token).
+ */
+export interface IValidSafeTokenPayload {
+    [key: string]: any;
+    aud: AuthorizationAudience;
+    exp: number;
+    iat: number;
+    nbf: number;
+    sub: IAuthorizationSubject;
+    iss: IAuthorizationIssuer;
+}
+/**
+ * This is the decoded jwt token.
+ */
+export interface IDecodedJwtToken {
+    customClaims?: ICustomClaims;
+    aud: AuthorizationAudience;
+    exp: number;
+    iat: number;
+    nbf: number;
+    sub: IAuthorizationSubject;
+    iss: IAuthorizationIssuer;
+}
+//# sourceMappingURL=authorization-models.d.ts.map

package/dist/generic/src/models/authorization/authorization-models.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"authorization-models.d.ts","sourceRoot":"","sources":["../../../../../../generic/src/models/authorization/authorization-models.ts"],"names":[],"mappings":"AAIA;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,GAAG,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC;AAG9D;;GAEG;AACH,oBAAY,uBAAuB;IAC/B,GAAG,QAAQ;CACd;AAOD;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAClC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACjC,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,oBAAY,qBAAqB;IAC7B,WAAW,gBAAgB,CAAE,wCAAwC;IACrE,SAAS,cAAc,CAAE,uCAAuC;IAChE,SAAS,cAAc,CAAE,sCAAsC;IAC/D,KAAK,UAAU,CAAE,kCAAkC;IACnD,MAAM,WAAW,CAAE,mCAAmC;IACtD,SAAS,cAAc;CAC1B;AAED;;GAEG;AACH,oBAAY,yBAAyB;IACjC,IAAI,SAAS;IACb,YAAY,iBAAiB;CAChC;AAED;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,GAAG,yBAAyB,IAAI,MAAM,EAAE,CAAC;AAE7E;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,GAAG,MAAM,IAAI,MAAM,EAAE,CAAC;AAIzD;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACnC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;IACnB,GAAG,EAAE,qBAAqB,CAAC;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,qBAAqB,CAAC;IAC3B,GAAG,EAAE,oBAAoB,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B,YAAY,CAAC,EAAE,aAAa,CAAC;IAC7B,GAAG,EAAE,qBAAqB,CAAC;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,qBAAqB,CAAC;IAC3B,GAAG,EAAE,oBAAoB,CAAC;CAC7B"}

package/dist/generic/src/models/authorization/authorization-models.js

@@ -0,0 +1,33 @@
+"use strict";
+// This file contains the models for the authorization.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuthorizationSubjectStart = exports.AuthorizationAudience = exports.AuthorityValidationType = void 0;
+/**
+ * This contains the types of validation that can be done on the authority.
+ */
+var AuthorityValidationType;
+(function (AuthorityValidationType) {
+    AuthorityValidationType["JWT"] = "jwt";
+})(AuthorityValidationType || (exports.AuthorityValidationType = AuthorityValidationType = {}));
+/**
+ * This is the audience that the jwt is intended for.
+ */
+var AuthorizationAudience;
+(function (AuthorizationAudience) {
+    AuthorizationAudience["AUTHORITIES"] = "authorities";
+    AuthorizationAudience["SHAREDATA"] = "sharedata";
+    AuthorizationAudience["FUNCTIONS"] = "functions";
+    AuthorizationAudience["RULES"] = "rules";
+    AuthorizationAudience["EVENTS"] = "events";
+    AuthorizationAudience["ENDPOINTS"] = "endpoints";
+})(AuthorizationAudience || (exports.AuthorizationAudience = AuthorizationAudience = {}));
+/**
+ * This contains the start of the subject for the authorization subject
+ */
+var AuthorizationSubjectStart;
+(function (AuthorizationSubjectStart) {
+    AuthorizationSubjectStart["USER"] = "user";
+    AuthorizationSubjectStart["SAFE_NETWORK"] = "safe-network";
+})(AuthorizationSubjectStart || (exports.AuthorizationSubjectStart = AuthorizationSubjectStart = {}));
+//#region jwt header models
+//#endregion jwt models

package/dist/generic/src/models/crypto/crypto-models.d.ts

@@ -0,0 +1,5 @@
+export interface IPublicPrivateKeyDerPair {
+    privateKeyDer: string;
+    publicKeyDer: string;
+}
+//# sourceMappingURL=crypto-models.d.ts.map

package/dist/generic/src/models/crypto/crypto-models.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"crypto-models.d.ts","sourceRoot":"","sources":["../../../../../../generic/src/models/crypto/crypto-models.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,wBAAwB;IACrC,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;CACxB"}

package/dist/generic/src/models/crypto/crypto-models.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file contains the models use in the cryptography functions of this library.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/generic/src/models/data/data-models.d.ts

@@ -0,0 +1,24 @@
+/**
+ * This contains the minimum information that is needed on a data record.
+ */
+export interface IGenericData {
+    createdAt: number;
+    createdBy: string;
+    updatedAt: number;
+    updatedBy: string;
+    versionNumber: number;
+}
+/**
+ * This contains the data for an item with a searchable index.
+ * for the word 'found' this object would look like this:
+ * {
+ *  f: true,
+ *  fo: true,
+ *  fou: true,
+ *  foun: true,
+ *  found: true,
+ */
+export interface ISearchableIndex {
+    [key: string]: true;
+}
+//# sourceMappingURL=data-models.d.ts.map

package/dist/generic/src/models/data/data-models.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"data-models.d.ts","sourceRoot":"","sources":["../../../../../../generic/src/models/data/data-models.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,WAAW,YAAY;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;CACzB;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,gBAAgB;IAC7B,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB"}

package/dist/generic/src/models/data/data-models.js

@@ -0,0 +1,3 @@
+"use strict";
+/// This contains the models for data in the degenerate package
+Object.defineProperty(exports, "__esModule", { value: true });