@degenerate/generic 0.0.9 → 0.0.10

package/dist/crypto/index.d.ts

@@ -7,4 +7,7 @@ export * from './private-public-keys/generation/generate-key-pair';
 export * from './private-public-keys/generation/get-private-public-key-from-keypair';
 export * from './private-public-keys/create-key-pair-from-private-key';
 export * from './private-public-keys/create-key-pair-from-mnemonic';
+export * from './signature/create-crypto-signature';
+export * from './signature/verify-crypto-signature-by-data';
+export * from './signature/verify-crypto-signature-by-hash';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/crypto/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,2BAA2B,CAAC;AAK1C,cAAc,uEAAuE,CAAC;AACtF,cAAc,sEAAsE,CAAC;AACrF,cAAc,gEAAgE,CAAC;AAC/E,cAAc,oDAAoD,CAAC;AACnE,cAAc,sEAAsE,CAAC;AAGrF,cAAc,wDAAwD,CAAC;AACvE,cAAc,qDAAqD,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/crypto/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,2BAA2B,CAAC;AAK1C,cAAc,uEAAuE,CAAC;AACtF,cAAc,sEAAsE,CAAC;AACrF,cAAc,gEAAgE,CAAC;AAC/E,cAAc,oDAAoD,CAAC;AACnE,cAAc,sEAAsE,CAAC;AAGrF,cAAc,wDAAwD,CAAC;AACvE,cAAc,qDAAqD,CAAC;AAMpE,cAAc,qCAAqC,CAAC;AACpD,cAAc,6CAA6C,CAAC;AAC5D,cAAc,6CAA6C,CAAC"}

package/dist/crypto/index.js

@@ -27,3 +27,8 @@ __exportStar(require("./private-public-keys/generation/get-private-public-key-fr
 __exportStar(require("./private-public-keys/create-key-pair-from-private-key"), exports);
 __exportStar(require("./private-public-keys/create-key-pair-from-mnemonic"), exports);
 //#endregion folder private-public-keys
+//#region folder signature
+__exportStar(require("./signature/create-crypto-signature"), exports);
+__exportStar(require("./signature/verify-crypto-signature-by-data"), exports);
+__exportStar(require("./signature/verify-crypto-signature-by-hash"), exports);
+//#endregion folder signature

package/dist/crypto/signature/create-crypto-signature.d.ts

@@ -0,0 +1,9 @@
+import * as Elliptic from 'elliptic';
+/**
+ * This function creates a signature for a hash using an elliptical curve.
+ * @param keyPair the key pair to use for signing.
+ * @param hashToSign the hash to sign.
+ */
+declare const createEllipticalCurveSignature: (keyPair: Elliptic.ec.KeyPair, hashToSign: string) => string;
+export { createEllipticalCurveSignature };
+//# sourceMappingURL=create-crypto-signature.d.ts.map

package/dist/crypto/signature/create-crypto-signature.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-crypto-signature.d.ts","sourceRoot":"","sources":["../../../src/crypto/signature/create-crypto-signature.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,QAAQ,MAAM,UAAU,CAAC;AAErC;;;;GAIG;AACH,QAAA,MAAM,8BAA8B,YAAa,QAAQ,CAAC,EAAE,CAAC,OAAO,cAAc,MAAM,KAAG,MAG1F,CAAC;AAEF,OAAO,EAAE,8BAA8B,EAAE,CAAC"}

package/dist/crypto/signature/create-crypto-signature.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createEllipticalCurveSignature = void 0;
+/**
+ * This function creates a signature for a hash using an elliptical curve.
+ * @param keyPair the key pair to use for signing.
+ * @param hashToSign the hash to sign.
+ */
+const createEllipticalCurveSignature = (keyPair, hashToSign) => {
+    const signature = keyPair.sign(hashToSign).toDER('hex');
+    return signature;
+};
+exports.createEllipticalCurveSignature = createEllipticalCurveSignature;

package/dist/crypto/signature/verify-crypto-signature-by-data.d.ts

@@ -0,0 +1,13 @@
+import { EllipticalCurvesSigning, EllipticalCurvesEncryption } from '../../_settings/cryptography-settings';
+/**
+ * This function verifies the signature of the data using the public key
+ *
+ * @param curve the curve used for the signature
+ * @param data the data to verify
+ * @param signature the signature to verify
+ * @param publicKey the public key to verify the signature
+ * @returns
+ */
+declare const verifyCryptoSignatureByData: (curve: EllipticalCurvesSigning | EllipticalCurvesEncryption, data: any, signature: string, publicKey: string) => Promise<boolean>;
+export { verifyCryptoSignatureByData };
+//# sourceMappingURL=verify-crypto-signature-by-data.d.ts.map

package/dist/crypto/signature/verify-crypto-signature-by-data.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"verify-crypto-signature-by-data.d.ts","sourceRoot":"","sources":["../../../src/crypto/signature/verify-crypto-signature-by-data.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,uBAAuB,EAAE,0BAA0B,EAAE,MAAM,uCAAuC,CAAC;AAE5G;;;;;;;;GAQG;AACH,QAAA,MAAM,2BAA2B,UAAiB,uBAAuB,GAAG,0BAA0B,QAAQ,GAAG,aAAa,MAAM,aACrH,MAAM,KAAG,OAAO,CAAC,OAAO,CAMtC,CAAC;AAEF,OAAO,EAAE,2BAA2B,EAAE,CAAC"}

package/dist/crypto/signature/verify-crypto-signature-by-data.js

@@ -0,0 +1,45 @@
+"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.verifyCryptoSignatureByData = void 0;
+/* eslint-disable @typescript-eslint/no-explicit-any */
+const elliptic = __importStar(require("elliptic"));
+/**
+ * This function verifies the signature of the data using the public key
+ *
+ * @param curve the curve used for the signature
+ * @param data the data to verify
+ * @param signature the signature to verify
+ * @param publicKey the public key to verify the signature
+ * @returns
+ */
+const verifyCryptoSignatureByData = async (curve, data, signature, publicKey) => {
+    // convert data to a string.
+    const hash = JSON.stringify(data);
+    // eslint-disable-next-line new-cap
+    const key = new elliptic.ec(curve).keyFromPublic(publicKey, 'hex');
+    return key.verify(hash, signature);
+};
+exports.verifyCryptoSignatureByData = verifyCryptoSignatureByData;

package/dist/crypto/signature/verify-crypto-signature-by-hash.d.ts

@@ -0,0 +1,13 @@
+import { EllipticalCurvesSigning, EllipticalCurvesEncryption } from '../../_settings/cryptography-settings';
+/**
+ * This function verifies the signature of the data using the public key
+ *
+ * @param curve the curve used for the signature
+ * @param hash the hash to verify
+ * @param signature the signature to verify
+ * @param publicKey the public key to verify the signature
+ * @returns
+ */
+declare const verifyCryptoSignatureByHash: (curve: EllipticalCurvesSigning | EllipticalCurvesEncryption, hash: string, signature: string, publicKey: string) => Promise<boolean>;
+export { verifyCryptoSignatureByHash };
+//# sourceMappingURL=verify-crypto-signature-by-hash.d.ts.map

package/dist/crypto/signature/verify-crypto-signature-by-hash.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"verify-crypto-signature-by-hash.d.ts","sourceRoot":"","sources":["../../../src/crypto/signature/verify-crypto-signature-by-hash.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,uBAAuB,EAAE,0BAA0B,EAAE,MAAM,uCAAuC,CAAC;AAE5G;;;;;;;;GAQG;AACH,QAAA,MAAM,2BAA2B,UAAiB,uBAAuB,GAAG,0BAA0B,QAAQ,MAAM,aAAa,MAAM,aACxH,MAAM,KAAG,OAAO,CAAC,OAAO,CAItC,CAAC;AAEF,OAAO,EAAE,2BAA2B,EAAE,CAAC"}

package/dist/{errors/__tests__/index-test.js → crypto/signature/verify-crypto-signature-by-hash.js}

@@ -23,12 +23,20 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const index = __importStar(require("../index"));
-describe('index module', () => {
-    it('should export BaseError', () => {
-        expect(index.BaseError).toBe(index.BaseError);
-    });
-    it('should export TaskNotFoundError', () => {
-        expect(index.TaskNotFoundError).toBe(index.TaskNotFoundError);
-    });
-});
+exports.verifyCryptoSignatureByHash = void 0;
+const elliptic = __importStar(require("elliptic"));
+/**
+ * This function verifies the signature of the data using the public key
+ *
+ * @param curve the curve used for the signature
+ * @param hash the hash to verify
+ * @param signature the signature to verify
+ * @param publicKey the public key to verify the signature
+ * @returns
+ */
+const verifyCryptoSignatureByHash = async (curve, hash, signature, publicKey) => {
+    // eslint-disable-next-line new-cap
+    const key = new elliptic.ec(curve).keyFromPublic(publicKey, 'hex');
+    return key.verify(hash, signature);
+};
+exports.verifyCryptoSignatureByHash = verifyCryptoSignatureByHash;

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

@@ -0,0 +1,35 @@
+import { BaseError } from '../base-error';
+/**
+ * This file contains all the errors that are more generic in nature.
+ */
+/**
+ * This is used for when function data was not received.
+ */
+export declare class FunctionDataNotReceivedError extends BaseError {
+    /**
+     * This is used for when function data was not received.
+     */
+    constructor();
+}
+/**
+ * This is used for when an item can not have a searchable index created for it.
+ */
+export declare class UnableToCreateSearchableIndexError extends BaseError {
+    /**
+     * This is used for when an item can not have a searchable index created for it.
+     *
+     * @param item
+     */
+    constructor(item: any);
+}
+/**
+ * This is used for when a function is not implemented.
+ */
+export declare class NotImplementedError extends BaseError {
+    /**
+     * This is used for when a function is not implemented.
+     *
+     */
+    constructor();
+}
+//# sourceMappingURL=generic-errors.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"generic-errors.d.ts","sourceRoot":"","sources":["../../../src/errors/generic/generic-errors.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE1C;;GAEG;AAEH;;GAEG;AACH,qBAAa,4BAA6B,SAAQ,SAAS;IACvD;;OAEG;;CAIN;AAED;;GAEG;AACH,qBAAa,kCAAmC,SAAQ,SAAS;IAC7D;;;;OAIG;gBACS,IAAI,EAAE,GAAG;CAGxB;AAED;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,SAAS;IAC9C;;;OAGG;;CAIN"}

package/dist/errors/generic/generic-errors.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotImplementedError = exports.UnableToCreateSearchableIndexError = exports.FunctionDataNotReceivedError = void 0;
+/* eslint-disable @typescript-eslint/no-explicit-any */
+const base_error_1 = require("../base-error");
+/**
+ * This file contains all the errors that are more generic in nature.
+ */
+/**
+ * This is used for when function data was not received.
+ */
+class FunctionDataNotReceivedError extends base_error_1.BaseError {
+    /**
+     * This is used for when function data was not received.
+     */
+    constructor() {
+        super('Data required for the functions to run was not received.');
+    }
+}
+exports.FunctionDataNotReceivedError = FunctionDataNotReceivedError;
+/**
+ * This is used for when an item can not have a searchable index created for it.
+ */
+class UnableToCreateSearchableIndexError extends base_error_1.BaseError {
+    /**
+     * This is used for when an item can not have a searchable index created for it.
+     *
+     * @param item
+     */
+    constructor(item) {
+        super(`The item ${item} can not have a searchable index created for it.`);
+    }
+}
+exports.UnableToCreateSearchableIndexError = UnableToCreateSearchableIndexError;
+/**
+ * This is used for when a function is not implemented.
+ */
+class NotImplementedError extends base_error_1.BaseError {
+    /**
+     * This is used for when a function is not implemented.
+     *
+     */
+    constructor() {
+        super('This function / feature is not implemented.');
+    }
+}
+exports.NotImplementedError = NotImplementedError;

package/dist/errors/index.d.ts

@@ -1,3 +1,6 @@
 export * from './base-error';
+export * from './generic/generic-errors';
+export * from './request/request-errors';
 export * from './scheduler/scheduler-errors';
+export * from './share-data/share-data-errors';
 //# 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,cAAc,CAAC;AAC7B,cAAc,8BAA8B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/errors/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC;AACzC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,gCAAgC,CAAC"}

package/dist/errors/index.js

@@ -15,4 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./base-error"), exports);
+__exportStar(require("./generic/generic-errors"), exports);
+__exportStar(require("./request/request-errors"), exports);
 __exportStar(require("./scheduler/scheduler-errors"), exports);
+__exportStar(require("./share-data/share-data-errors"), exports);

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

@@ -0,0 +1,89 @@
+import { BaseError } from '../base-error';
+/**
+ * This is thrown when the request object is not valid.
+ */
+export declare class RequestObjectValidationFailedError extends BaseError {
+    /**
+     * This is thrown when the request object is not valid.
+     * @param objectToValidate the object that is not valid
+     * @param validationType the type of validation that failed
+     */
+    constructor(objectToValidate: any, validationObject: string, validationType: string);
+}
+/**
+ * This is throw when the request object has too many properties.
+ */
+export declare class RequestObjectTooManyPropertiesError extends BaseError {
+    /**
+     * This is throw when the request object has too many properties.
+     * @param objectToValidate the object that is not valid
+     * @param validationOject the object property text that is being validated
+     * @param totalProperties the total properties on the object
+     * @param maxProperties the max properties allowed on the object
+     */
+    constructor(objectToValidate: any, validationOject: string, totalProperties: number, maxProperties: number);
+}
+/**
+ * This is thrown when the request object has too few properties.
+ */
+export declare class RequestObjectTooFewPropertiesError extends BaseError {
+    /**
+     * This is thrown when the request object has too few properties.
+     * @param objectToValidate the object that is not valid
+     * @param validationOject the object property text that is being validated
+     * @param totalProperties the total properties on the object
+     * @param minProperties the min properties allowed on the object
+     */
+    constructor(objectToValidate: any, validationOject: string, totalProperties: number, minProperties: number);
+}
+/**
+ * This is thrown when the request object should only have a certain number of properties.
+ */
+export declare class RequestObjectShouldOnlyHaveXPropertiesError extends BaseError {
+    /**
+     * This is thrown when the request object should only have a certain number of properties.
+     * @param objectToValidate the object that is not valid
+     * @param validationOject the object property text that is being validated
+     * @param totalProperties the total properties on the object
+     * @param expectedProperties the expected properties on the object
+     */
+    constructor(objectToValidate: any, validationOject: string, totalProperties: number, expectedProperties: number);
+}
+/**
+ * This is throw when the request object has a property that does not match the param property.
+ */
+export declare class RequestObjectPropertyNotMatchingParamProperty extends BaseError {
+    /**
+     * This is thrown when the request object doesnot match the param property.
+     * @param requestPropertyName the property in the request object
+     * @param requestPropertyValue the value of the property in the request object
+     * @param paramPropertyName the property in the param object
+     * @param paramPropertyValue the value of the property in the param object
+     */
+    constructor(requestPropertyName: string, requestPropertyValue: any, paramPropertyName: string, paramPropertyValue: any);
+}
+/**
+ * This is thrown when the query object is not valid.
+ */
+export declare class RequestQueryNotValidError extends BaseError {
+    /**
+     * This is thrown when the query object is not valid.
+     * @param queryObjectName the name of the query object
+     * @param queryValue the value of the query object
+     * @param expectedType the expected type of the query object
+     */
+    constructor(queryObjectName: string, queryValue: any, expectedType: string);
+}
+/**
+ * This is thrown when the param object is not valid.
+ */
+export declare class RequestParamNotValidError extends BaseError {
+    /**
+     * This is thrown when the param object is not valid.
+     * @param paramName the name of the param object
+     * @param paramValue the value of the param object
+     * @param expectedType the expected type of the param object
+     */
+    constructor(paramName: string, paramValue: any, expectedType: string, allParams: any);
+}
+//# sourceMappingURL=request-errors.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"request-errors.d.ts","sourceRoot":"","sources":["../../../src/errors/request/request-errors.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAI1C;;GAEG;AACH,qBAAa,kCAAmC,SAAQ,SAAS;IAC7D;;;;OAIG;gBACS,gBAAgB,EAAE,GAAG,EAAE,gBAAgB,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM;CAGtF;AAED;;GAEG;AACH,qBAAa,mCAAoC,SAAQ,SAAS;IAC9D;;;;;;OAMG;gBACS,gBAAgB,EAAE,GAAG,EAAE,eAAe,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM;CAG7G;AAED;;GAEG;AACH,qBAAa,kCAAmC,SAAQ,SAAS;IAC7D;;;;;;OAMG;gBACS,gBAAgB,EAAE,GAAG,EAAE,eAAe,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM;CAG7G;AAED;;GAEG;AACH,qBAAa,2CAA4C,SAAQ,SAAS;IACtE;;;;;;OAMG;gBACS,gBAAgB,EAAE,GAAG,EAAE,eAAe,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM;CAGlH;AAED;;GAEG;AACH,qBAAa,6CAA8C,SAAQ,SAAS;IACxE;;;;;;OAMG;gBACS,mBAAmB,EAAE,MAAM,EAAE,oBAAoB,EAAE,GAAG,EAAE,iBAAiB,EAAE,MAAM,EAAE,kBAAkB,EAAE,GAAG;CAGzH;AAMD;;GAEG;AACH,qBAAa,yBAA0B,SAAQ,SAAS;IACpD;;;;;OAKG;gBACS,eAAe,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,EAAE,YAAY,EAAE,MAAM;CAG7E;AAMD;;GAEG;AACH,qBAAa,yBAA0B,SAAQ,SAAS;IACpD;;;;;OAKG;gBACS,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,EAAE,YAAY,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG;CAGvF"}

package/dist/errors/request/request-errors.js

@@ -0,0 +1,120 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RequestParamNotValidError = exports.RequestQueryNotValidError = exports.RequestObjectPropertyNotMatchingParamProperty = exports.RequestObjectShouldOnlyHaveXPropertiesError = exports.RequestObjectTooFewPropertiesError = exports.RequestObjectTooManyPropertiesError = exports.RequestObjectValidationFailedError = void 0;
+/* eslint-disable @typescript-eslint/no-explicit-any */
+// This file contains the errors that are thrown when the request object is not valid.
+const base_error_1 = require("../base-error");
+//#region Request Body Errors
+/**
+ * This is thrown when the request object is not valid.
+ */
+class RequestObjectValidationFailedError extends base_error_1.BaseError {
+    /**
+     * This is thrown when the request object is not valid.
+     * @param objectToValidate the object that is not valid
+     * @param validationType the type of validation that failed
+     */
+    constructor(objectToValidate, validationObject, validationType) {
+        super(`The object ${objectToValidate} in the node ${validationObject} is not a valid ${validationType}`);
+    }
+}
+exports.RequestObjectValidationFailedError = RequestObjectValidationFailedError;
+/**
+ * This is throw when the request object has too many properties.
+ */
+class RequestObjectTooManyPropertiesError extends base_error_1.BaseError {
+    /**
+     * This is throw when the request object has too many properties.
+     * @param objectToValidate the object that is not valid
+     * @param validationOject the object property text that is being validated
+     * @param totalProperties the total properties on the object
+     * @param maxProperties the max properties allowed on the object
+     */
+    constructor(objectToValidate, validationOject, totalProperties, maxProperties) {
+        super(`The object ${objectToValidate} which is property ${validationOject} has too many properties. It has ${totalProperties} and the max is ${maxProperties}`);
+    }
+}
+exports.RequestObjectTooManyPropertiesError = RequestObjectTooManyPropertiesError;
+/**
+ * This is thrown when the request object has too few properties.
+ */
+class RequestObjectTooFewPropertiesError extends base_error_1.BaseError {
+    /**
+     * This is thrown when the request object has too few properties.
+     * @param objectToValidate the object that is not valid
+     * @param validationOject the object property text that is being validated
+     * @param totalProperties the total properties on the object
+     * @param minProperties the min properties allowed on the object
+     */
+    constructor(objectToValidate, validationOject, totalProperties, minProperties) {
+        super(`The object ${objectToValidate} which is property ${validationOject} has too few properties. It has ${totalProperties} and the min is ${minProperties}`);
+    }
+}
+exports.RequestObjectTooFewPropertiesError = RequestObjectTooFewPropertiesError;
+/**
+ * This is thrown when the request object should only have a certain number of properties.
+ */
+class RequestObjectShouldOnlyHaveXPropertiesError extends base_error_1.BaseError {
+    /**
+     * This is thrown when the request object should only have a certain number of properties.
+     * @param objectToValidate the object that is not valid
+     * @param validationOject the object property text that is being validated
+     * @param totalProperties the total properties on the object
+     * @param expectedProperties the expected properties on the object
+     */
+    constructor(objectToValidate, validationOject, totalProperties, expectedProperties) {
+        super(`The object ${objectToValidate} which is property ${validationOject} should only have ${expectedProperties} properties. It has ${totalProperties}`);
+    }
+}
+exports.RequestObjectShouldOnlyHaveXPropertiesError = RequestObjectShouldOnlyHaveXPropertiesError;
+/**
+ * This is throw when the request object has a property that does not match the param property.
+ */
+class RequestObjectPropertyNotMatchingParamProperty extends base_error_1.BaseError {
+    /**
+     * This is thrown when the request object doesnot match the param property.
+     * @param requestPropertyName the property in the request object
+     * @param requestPropertyValue the value of the property in the request object
+     * @param paramPropertyName the property in the param object
+     * @param paramPropertyValue the value of the property in the param object
+     */
+    constructor(requestPropertyName, requestPropertyValue, paramPropertyName, paramPropertyValue) {
+        super(`The request object property ${requestPropertyName} with value ${requestPropertyValue} does not match the param property ${paramPropertyName} with value ${paramPropertyValue}`);
+    }
+}
+exports.RequestObjectPropertyNotMatchingParamProperty = RequestObjectPropertyNotMatchingParamProperty;
+//#endregion Request Body Errors
+//#region Request Query Errors
+/**
+ * This is thrown when the query object is not valid.
+ */
+class RequestQueryNotValidError extends base_error_1.BaseError {
+    /**
+     * This is thrown when the query object is not valid.
+     * @param queryObjectName the name of the query object
+     * @param queryValue the value of the query object
+     * @param expectedType the expected type of the query object
+     */
+    constructor(queryObjectName, queryValue, expectedType) {
+        super(`The query object ${queryObjectName} with value ${queryValue} is not a valid ${expectedType}`);
+    }
+}
+exports.RequestQueryNotValidError = RequestQueryNotValidError;
+//#endregion Request Query Errors
+//#region Request Param Errors
+/**
+ * This is thrown when the param object is not valid.
+ */
+class RequestParamNotValidError extends base_error_1.BaseError {
+    /**
+     * This is thrown when the param object is not valid.
+     * @param paramName the name of the param object
+     * @param paramValue the value of the param object
+     * @param expectedType the expected type of the param object
+     */
+    constructor(paramName, paramValue, expectedType, allParams) {
+        super(`The param object ${paramName} with value ${paramValue} is not a valid ${expectedType}. All params: ${JSON.stringify(allParams)}`);
+    }
+}
+exports.RequestParamNotValidError = RequestParamNotValidError;
+//#endregion Request Param Errors

package/dist/errors/share-data/share-data-errors.d.ts

@@ -0,0 +1,49 @@
+import { BaseError } from '../base-error';
+import { ShareDataTypes } from '../../models/share-data/share-data';
+import { IShareDataFunction } from '../../models/functions/share-data-function-models';
+/**
+ * This error is thrown when a function is tried to be applied to the share data thats state is locked.
+ */
+export declare class ShareDataIsLockedError extends BaseError {
+    /**
+     * This error is thrown when a function is tried to be applied to the share data thats state is locked.
+     */
+    constructor(shareDataId: string, shareDataType: ShareDataTypes);
+}
+/**
+ * This error is thrown when a data proposal matches the current data in the rules evaluation service.
+ */
+export declare class ShareDataCurrentAndProposalDataMatchesError extends BaseError {
+    /**
+     * This error is thrown when a data proposal matches the current data in the rules evaluation service.
+     */
+    constructor(shareDataId: string);
+}
+/**
+ * This error is thrown when the share data integrity check fails.
+ */
+export declare class ShareDataIntegrityError extends BaseError {
+    /**
+     * This error is thrown when the share data integrity check fails.
+     */
+    constructor(shareDataId: string);
+}
+/**
+ * This error is thrown when the attemping to be applied function does not exist on the share data.
+ */
+export declare class ShareDataFunctionBeingAppliedDoesNotExistOnShareDataError extends BaseError {
+    /**
+     * This error is thrown when the attemping to be applied function does not exist on the share data.
+     */
+    constructor(shareDataId: string, functionName: string, functionId: string);
+}
+/**
+ * This error is thrown when the function hash is not valid.
+ */
+export declare class ShareDataFunctionHashNotValid extends BaseError {
+    /**
+     * This error is thrown when the function hash is not valid.
+     */
+    constructor(shareDataId: string, shareDataFunction: IShareDataFunction, calculatedHash: string);
+}
+//# sourceMappingURL=share-data-errors.d.ts.map

package/dist/errors/share-data/share-data-errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"share-data-errors.d.ts","sourceRoot":"","sources":["../../../src/errors/share-data/share-data-errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AACpE,OAAO,EAAE,kBAAkB,EAAE,MAAM,mDAAmD,CAAC;AAEvF;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,SAAS;IACjD;;OAEG;gBACS,WAAW,EAAE,MAAM,EAAE,aAAa,EAAE,cAAc;CAGjE;AAED;;GAEG;AACH,qBAAa,2CAA4C,SAAQ,SAAS;IACtE;;OAEG;gBACS,WAAW,EAAE,MAAM;CAGlC;AAED;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,SAAS;IAClD;;OAEG;gBACS,WAAW,EAAE,MAAM;CAGlC;AAED;;GAEG;AACH,qBAAa,yDAA0D,SAAQ,SAAS;IACpF;;OAEG;gBACS,WAAW,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM;CAI5E;AAGD;;GAEG;AACH,qBAAa,6BAA8B,SAAQ,SAAS;IACxD;;OAEG;gBACS,WAAW,EAAE,MAAM,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,cAAc,EAAE,MAAM;CAIjG"}

package/dist/errors/share-data/share-data-errors.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ShareDataFunctionHashNotValid = exports.ShareDataFunctionBeingAppliedDoesNotExistOnShareDataError = exports.ShareDataIntegrityError = exports.ShareDataCurrentAndProposalDataMatchesError = exports.ShareDataIsLockedError = void 0;
+const base_error_1 = require("../base-error");
+/**
+ * This error is thrown when a function is tried to be applied to the share data thats state is locked.
+ */
+class ShareDataIsLockedError extends base_error_1.BaseError {
+    /**
+     * This error is thrown when a function is tried to be applied to the share data thats state is locked.
+     */
+    constructor(shareDataId, shareDataType) {
+        super(`Share data with id ${shareDataId} and type ${shareDataType} is locked and cannot be modified.`);
+    }
+}
+exports.ShareDataIsLockedError = ShareDataIsLockedError;
+/**
+ * This error is thrown when a data proposal matches the current data in the rules evaluation service.
+ */
+class ShareDataCurrentAndProposalDataMatchesError extends base_error_1.BaseError {
+    /**
+     * This error is thrown when a data proposal matches the current data in the rules evaluation service.
+     */
+    constructor(shareDataId) {
+        super(`Share data with id ${shareDataId} current and proposal data matches.`);
+    }
+}
+exports.ShareDataCurrentAndProposalDataMatchesError = ShareDataCurrentAndProposalDataMatchesError;
+/**
+ * This error is thrown when the share data integrity check fails.
+ */
+class ShareDataIntegrityError extends base_error_1.BaseError {
+    /**
+     * This error is thrown when the share data integrity check fails.
+     */
+    constructor(shareDataId) {
+        super(`Share data with id ${shareDataId} failed the integrity check.`);
+    }
+}
+exports.ShareDataIntegrityError = ShareDataIntegrityError;
+/**
+ * This error is thrown when the attemping to be applied function does not exist on the share data.
+ */
+class ShareDataFunctionBeingAppliedDoesNotExistOnShareDataError extends base_error_1.BaseError {
+    /**
+     * This error is thrown when the attemping to be applied function does not exist on the share data.
+     */
+    constructor(shareDataId, functionName, functionId) {
+        super(`On share data with id ${shareDataId} the function with id: ${functionId} & name: ${functionName} that is trying to be executed, ` +
+            'but does not exist in the authorized functions for the share data.');
+    }
+}
+exports.ShareDataFunctionBeingAppliedDoesNotExistOnShareDataError = ShareDataFunctionBeingAppliedDoesNotExistOnShareDataError;
+/**
+ * This error is thrown when the function hash is not valid.
+ */
+class ShareDataFunctionHashNotValid extends base_error_1.BaseError {
+    /**
+     * This error is thrown when the function hash is not valid.
+     */
+    constructor(shareDataId, shareDataFunction, calculatedHash) {
+        super(`On share data with id ${shareDataId} the function with current hash: ${shareDataFunction.currentHash} & previous hase: ${shareDataFunction.previousHash}` +
+            ` that is trying to be executed does not meet the generated hash ${calculatedHash}. This makes it an authorized function execution.`);
+    }
+}
+exports.ShareDataFunctionHashNotValid = ShareDataFunctionHashNotValid;

package/dist/helpers/array/array-helpers.d.ts

@@ -0,0 +1,8 @@
+/**
+ * this gets a random item from an array.
+ *
+ * @param incomingArray the incoming array to get a random item from.
+ */
+declare const getRandomItemFromArray: <T>(incomingArray: T[]) => T;
+export { getRandomItemFromArray };
+//# sourceMappingURL=array-helpers.d.ts.map

package/dist/helpers/array/array-helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"array-helpers.d.ts","sourceRoot":"","sources":["../../../src/helpers/array/array-helpers.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,QAAA,MAAM,sBAAsB,GAAI,CAAC,iBAAiB,CAAC,EAAE,KAAG,CAGvD,CAAC;AAEF,OAAO,EAAE,sBAAsB,EAAE,CAAC"}

package/dist/helpers/array/array-helpers.js

@@ -0,0 +1,14 @@
+"use strict";
+// This file contains the helper functions for arrays.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRandomItemFromArray = void 0;
+/**
+ * this gets a random item from an array.
+ *
+ * @param incomingArray the incoming array to get a random item from.
+ */
+const getRandomItemFromArray = (incomingArray) => {
+    const randomIndex = Math.floor(Math.random() * incomingArray.length);
+    return incomingArray[randomIndex];
+};
+exports.getRandomItemFromArray = getRandomItemFromArray;