@degenerate/generic 0.0.9 → 0.0.11

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;

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

@@ -0,0 +1,46 @@
+import { IGenericData, ISearchableIndex } from '../../models/data/data-models';
+/**
+ * This adds the generic data to the object.
+ *
+ * @param incomingObject the object to add the generic data to.
+ * @param userId the user ID to add the generic data to.
+ * @param versionNumber the version number to add to the generic data.
+ * @returns
+ */
+declare const addGenericDataToObject: <T>(incomingObject: any, userId: string, versionNumber?: number) => T;
+/**
+ * This creates the generic data record for the database
+ *
+ * @param userId the user ID to create the generic data for.
+ * @param versionNumber the version number to create the generic data for.
+ * @returns
+ */
+declare const createGenericData: (userId: string, versionNumber?: number) => IGenericData;
+/**
+ * This takes an incoming string and creates a searchable index object.
+ * @param itemForSearchableIndex the item for a searchable index to be created on
+ */
+declare const createSearchableIndex: (itemForSearchableIndex: string) => ISearchableIndex;
+/**
+ * This removed all the generic data from an object.
+ *
+ * @param data
+ */
+declare const deleteGenericDataOnObject: (data: any) => any;
+/**
+ * This function removes all whitespace from a string
+ *
+ * @param str the string to remove whitespace from
+ * @returns
+ */
+declare const removeWhitespaceFromObject: (str: string) => string;
+/**
+ * This function updates the generic data on an object.
+ * @param data the data to update the generic data on
+ * @param userId the user Id to update the object with
+ *
+ * @returns
+ */
+declare const updateGenericDataOnObject: <T>(data: T, userId: string) => any;
+export { addGenericDataToObject, createGenericData, createSearchableIndex, deleteGenericDataOnObject, removeWhitespaceFromObject, updateGenericDataOnObject, };
+//# sourceMappingURL=data-helpers.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"data-helpers.d.ts","sourceRoot":"","sources":["../../../src/helpers/data/data-helpers.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAE/E;;;;;;;GAOG;AACH,QAAA,MAAM,sBAAsB,GAAI,CAAC,kBAAkB,GAAG,UAAU,MAAM,6BAAsB,CAU3F,CAAC;AAGF;;;;;;GAMG;AACH,QAAA,MAAM,iBAAiB,WAAY,MAAM,6BAAsB,YAU9D,CAAC;AAEF;;;GAGG;AACH,QAAA,MAAM,qBAAqB,2BAA4B,MAAM,KAAG,gBAgB/D,CAAC;AAEF;;;;GAIG;AACH,QAAA,MAAM,yBAAyB,SAAU,GAAG,KAAG,GAQ9C,CAAC;AAEF;;;;;GAKG;AACH,QAAA,MAAM,0BAA0B,QAAS,MAAM,KAAG,MAEjD,CAAC;AAEF;;;;;;GAMG;AACH,QAAA,MAAM,yBAAyB,GAAI,CAAC,QAAQ,CAAC,UAAU,MAAM,KAAG,GAO/D,CAAC;AAEF,OAAO,EACH,sBAAsB,EACtB,iBAAiB,EACjB,qBAAqB,EACrB,yBAAyB,EACzB,0BAA0B,EAC1B,yBAAyB,GAC5B,CAAC"}

package/dist/helpers/data/data-helpers.js

@@ -0,0 +1,106 @@
+"use strict";
+/* eslint-disable @typescript-eslint/no-explicit-any */
+// This contains the interfaces for the data helpers.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateGenericDataOnObject = exports.removeWhitespaceFromObject = exports.deleteGenericDataOnObject = exports.createSearchableIndex = exports.createGenericData = exports.addGenericDataToObject = void 0;
+const errors_1 = require("../../errors");
+/**
+ * This adds the generic data to the object.
+ *
+ * @param incomingObject the object to add the generic data to.
+ * @param userId the user ID to add the generic data to.
+ * @param versionNumber the version number to add to the generic data.
+ * @returns
+ */
+const addGenericDataToObject = (incomingObject, userId, versionNumber = 1) => {
+    const timestamp = Date.now();
+    return {
+        ...incomingObject,
+        versionNumber,
+        createdAt: timestamp,
+        createdBy: userId,
+        updatedAt: timestamp,
+        updatedBy: userId,
+    };
+};
+exports.addGenericDataToObject = addGenericDataToObject;
+/**
+ * This creates the generic data record for the database
+ *
+ * @param userId the user ID to create the generic data for.
+ * @param versionNumber the version number to create the generic data for.
+ * @returns
+ */
+const createGenericData = (userId, versionNumber = 1) => {
+    const timestamp = Date.now();
+    return {
+        versionNumber,
+        createdAt: timestamp,
+        createdBy: userId,
+        updatedAt: timestamp,
+        updatedBy: userId,
+    };
+};
+exports.createGenericData = createGenericData;
+/**
+ * This takes an incoming string and creates a searchable index object.
+ * @param itemForSearchableIndex the item for a searchable index to be created on
+ */
+const createSearchableIndex = (itemForSearchableIndex) => {
+    if (typeof itemForSearchableIndex !== 'string' || itemForSearchableIndex.length === 0) {
+        throw new errors_1.UnableToCreateSearchableIndexError(itemForSearchableIndex);
+    }
+    const searchableIndex = {}; // the searchable index object.
+    const characters = itemForSearchableIndex.toLowerCase().split(''); // the words in the item, lowercase it and split it.
+    // this takes the characters and creates a searchable index.
+    // it includes all previous characters in the word.
+    // Handle the first character separately
+    characters.reduce((accumulator, current) => {
+        const updatedAccumulator = accumulator + current;
+        searchableIndex[updatedAccumulator] = true;
+        return updatedAccumulator;
+    }, '');
+    return searchableIndex;
+};
+exports.createSearchableIndex = createSearchableIndex;
+/**
+ * This removed all the generic data from an object.
+ *
+ * @param data
+ */
+const deleteGenericDataOnObject = (data) => {
+    if (data) {
+        delete data.createdAt; // the timestamp of when the user was created.
+        delete data.createdBy; // the user id of the user who created the item.
+        delete data.updatedAt; // when the user was last updated.
+        delete data.updatedBy; // the user id of the user who updated the item.
+    }
+    return data;
+};
+exports.deleteGenericDataOnObject = deleteGenericDataOnObject;
+/**
+ * This function removes all whitespace from a string
+ *
+ * @param str the string to remove whitespace from
+ * @returns
+ */
+const removeWhitespaceFromObject = (str) => {
+    return str.replace(/\s/g, '');
+};
+exports.removeWhitespaceFromObject = removeWhitespaceFromObject;
+/**
+ * This function updates the generic data on an object.
+ * @param data the data to update the generic data on
+ * @param userId the user Id to update the object with
+ *
+ * @returns
+ */
+const updateGenericDataOnObject = (data, userId) => {
+    const now = Date.now();
+    return {
+        ...data,
+        updatedAt: now,
+        updatedBy: userId,
+    };
+};
+exports.updateGenericDataOnObject = updateGenericDataOnObject;

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

@@ -0,0 +1,12 @@
+/**
+ * This gets all the files in a directory recursively.
+ *
+ * @param dirPath the directory path to get the files from.
+ * @param arrayOfFiles the array of files to add to.
+ * @param ignoreIndexFiles the flag to ignore index files.
+ * @param ignoreTestFiles the flag to ignore test files.
+ * @returns
+ */
+declare const getAllFiles: (dirPath: string, arrayOfFiles?: string[], ignoreIndexFiles?: boolean, ignoreTestFiles?: boolean) => string[];
+export { getAllFiles };
+//# sourceMappingURL=file-helpers.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"file-helpers.d.ts","sourceRoot":"","sources":["../../../src/helpers/file/file-helpers.ts"],"names":[],"mappings":"AAKA;;;;;;;;GAQG;AACH,QAAA,MAAM,WAAW,YAAa,MAAM,iBAAgB,MAAM,EAAE,4DAAyD,MAAM,EAmB1H,CAAA;AAED,OAAO,EAAE,WAAW,EAAE,CAAC"}

package/dist/helpers/file/file-helpers.js

@@ -0,0 +1,39 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAllFiles = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+// This contains all the functions for helping with files in the degenerate packages.
+/**
+ * This gets all the files in a directory recursively.
+ *
+ * @param dirPath the directory path to get the files from.
+ * @param arrayOfFiles the array of files to add to.
+ * @param ignoreIndexFiles the flag to ignore index files.
+ * @param ignoreTestFiles the flag to ignore test files.
+ * @returns
+ */
+const getAllFiles = (dirPath, arrayOfFiles = [], ignoreIndexFiles = true, ignoreTestFiles = true) => {
+    const files = fs_1.default.readdirSync(dirPath);
+    // loop through all the files in the directory.
+    files.forEach((file) => {
+        const filePath = path_1.default.join(dirPath, file);
+        if (fs_1.default.statSync(filePath).isDirectory()) {
+            getAllFiles(filePath, arrayOfFiles);
+        }
+        else {
+            if (ignoreTestFiles && file.endsWith('.test.ts')) {
+                return;
+            }
+            if (ignoreIndexFiles && file === 'index.ts') {
+                return;
+            }
+            arrayOfFiles.push(filePath);
+        }
+    });
+    return arrayOfFiles;
+};
+exports.getAllFiles = getAllFiles;

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

@@ -0,0 +1,8 @@
+/**
+ * This creates a random Id.
+ * @param length the length of the id to generate.
+ * @returns
+ */
+declare const createId: (length?: number) => string;
+export { createId };
+//# sourceMappingURL=id-helpers.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"id-helpers.d.ts","sourceRoot":"","sources":["../../src/helpers/id-helpers.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,QAAA,MAAM,QAAQ,uBAAkB,MAS/B,CAAC;AAEF,OAAO,EAAE,QAAQ,EAAE,CAAC"}

package/dist/helpers/id-helpers.js

@@ -0,0 +1,19 @@
+"use strict";
+// This file contains the helper functions for generating ids.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createId = void 0;
+/**
+ * This creates a random Id.
+ * @param length the length of the id to generate.
+ * @returns
+ */
+const createId = (length = 18) => {
+    let result = '';
+    const characters = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
+    const charactersLength = characters.length;
+    for (let i = 0; i < length; i++) {
+        result += characters.charAt(Math.floor(Math.random() * charactersLength));
+    }
+    return result;
+};
+exports.createId = createId;

package/dist/helpers/index.d.ts

@@ -0,0 +1,11 @@
+export * from './id-helpers';
+export * from './object-helpers';
+export * from './object-validation-helpers';
+export * from './request/params-object-helpers';
+export * from './request/query-object-helpers';
+export * from './request/request-object-helpers';
+export * from './array/array-helpers';
+export * from './data/data-helpers';
+export * from './file/file-helpers';
+export * from './lodash/lodash-helpers';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/helpers/index.ts"],"names":[],"mappings":"AACA,cAAc,cAAc,CAAC;AAC7B,cAAc,kBAAkB,CAAC;AACjC,cAAc,6BAA6B,CAAC;AAM5C,cAAc,iCAAiC,CAAC;AAChD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,kCAAkC,CAAC;AAKjD,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC"}

package/dist/helpers/index.js

@@ -0,0 +1,31 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+//#region main exports
+__exportStar(require("./id-helpers"), exports);
+__exportStar(require("./object-helpers"), exports);
+__exportStar(require("./object-validation-helpers"), exports);
+// #endregion main exports
+// #region request exports
+__exportStar(require("./request/params-object-helpers"), exports);
+__exportStar(require("./request/query-object-helpers"), exports);
+__exportStar(require("./request/request-object-helpers"), exports);
+//#endregion request exports
+// additional
+__exportStar(require("./array/array-helpers"), exports);
+__exportStar(require("./data/data-helpers"), exports);
+__exportStar(require("./file/file-helpers"), exports);
+__exportStar(require("./lodash/lodash-helpers"), exports);

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

@@ -0,0 +1,14 @@
+/***************************************************
+ * This contains a list of the lodash equivalent functions without the lodash bloat and vulnerabilites.
+ ****************************************************/
+/**
+ * This function is used to break an array into smaller arrays.
+ *
+ * @param arr the array to be broken into smaller arrays.
+ * @param amount the amount of items to be in each array.
+ * @param startAt start at a specific index of this array
+ * @returns
+ */
+declare const chunk: <T>(arr: Array<T>, amount?: number, startAt?: number) => T[][];
+export { chunk };
+//# sourceMappingURL=lodash-helpers.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"lodash-helpers.d.ts","sourceRoot":"","sources":["../../../src/helpers/lodash/lodash-helpers.ts"],"names":[],"mappings":"AACA;;sDAEsD;AAEtD;;;;;;;GAOG;AACH,QAAA,MAAM,KAAK,GAAI,CAAC,OAAO,KAAK,CAAC,CAAC,CAAC,wCAA8B,CAAC,EAAE,EAW/D,CAAC;AAEF,OAAO,EAAE,KAAK,EAAE,CAAC"}

package/dist/helpers/lodash/lodash-helpers.js

@@ -0,0 +1,28 @@
+"use strict";
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/***************************************************
+ * This contains a list of the lodash equivalent functions without the lodash bloat and vulnerabilites.
+ ****************************************************/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.chunk = void 0;
+/**
+ * This function is used to break an array into smaller arrays.
+ *
+ * @param arr the array to be broken into smaller arrays.
+ * @param amount the amount of items to be in each array.
+ * @param startAt start at a specific index of this array
+ * @returns
+ */
+const chunk = (arr, amount = 300, startAt = 0) => {
+    const result = []; // setup the result.
+    const len = arr.length; // get the length
+    let startAtInside = startAt;
+    while (startAtInside < len) {
+        const totalLength = startAtInside + amount;
+        const newArray = arr.slice(startAtInside, totalLength);
+        result.push(newArray);
+        startAtInside += amount;
+    }
+    return result;
+};
+exports.chunk = chunk;

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

@@ -0,0 +1,23 @@
+/**
+ * This takes a string and converts it to a string with spaces between each word and the first letter of each word capitalized.
+ * @param str the string to convert (e.g. "thisIsAString" or "This is a string")
+ * @returns the converted string (e.g. "This Is A String")
+ */
+declare const toCapitalizedWithSpaces: (str: string) => string;
+/**
+ * This takes an object and removes any undefined items off it and then returns a new object.
+ * if the type passed in is a primitive type other than the object, it returns the original object.
+ *
+ * @param item the incoming item.
+ * @returns a clean version of the object.
+ */
+declare const removeUndefined: <T>(item: T, recurseObject?: boolean) => T;
+/**
+ * This function removes all whitespace from a string
+ *
+ * @param str the string to remove whitespace from
+ * @returns
+ */
+declare const removeWhitespace: (str: string) => string;
+export { toCapitalizedWithSpaces, removeUndefined, removeWhitespace, };
+//# sourceMappingURL=object-helpers.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"object-helpers.d.ts","sourceRoot":"","sources":["../../src/helpers/object-helpers.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,QAAA,MAAM,uBAAuB,QAAS,MAAM,KAAG,MAK9C,CAAC;AAEF;;;;;;GAMG;AACH,QAAA,MAAM,eAAe,GAAI,CAAC,QAAQ,CAAC,8BAA0B,CAiB5D,CAAC;AAEF;;;;;GAKG;AACH,QAAA,MAAM,gBAAgB,QAAS,MAAM,KAAG,MAEvC,CAAC;AAEF,OAAO,EACH,uBAAuB,EACvB,eAAe,EACf,gBAAgB,GACnB,CAAC"}

package/dist/helpers/object-helpers.js

@@ -0,0 +1,54 @@
+"use strict";
+// This file contains helper functions for working with objects.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.removeWhitespace = exports.removeUndefined = exports.toCapitalizedWithSpaces = void 0;
+/**
+ * This takes a string and converts it to a string with spaces between each word and the first letter of each word capitalized.
+ * @param str the string to convert (e.g. "thisIsAString" or "This is a string")
+ * @returns the converted string (e.g. "This Is A String")
+ */
+const toCapitalizedWithSpaces = (str) => {
+    // Add a space before all uppercase letters (except the first one), then trim any leading/trailing spaces
+    const result = str.replace(/(?!^)([A-Z])/g, ' $1').trim();
+    // Capitalize the first letter of each word
+    return result.replace(/\b\w/g, (char) => char.toUpperCase());
+};
+exports.toCapitalizedWithSpaces = toCapitalizedWithSpaces;
+/**
+ * This takes an object and removes any undefined items off it and then returns a new object.
+ * if the type passed in is a primitive type other than the object, it returns the original object.
+ *
+ * @param item the incoming item.
+ * @returns a clean version of the object.
+ */
+const removeUndefined = (item, recurseObject = false) => {
+    if (Array.isArray(item)) {
+        return item
+            .filter((element) => element !== undefined)
+            .map((element) => (recurseObject && Array.isArray(element) ? removeUndefined(element, true) : element));
+    }
+    else if (typeof item === 'object' && item !== null) {
+        const returnObject = { ...item };
+        Object.keys(returnObject).forEach((key) => {
+            if (returnObject[key] === undefined) {
+                delete returnObject[key];
+            }
+            else if (recurseObject && (typeof returnObject[key] === 'object' || Array.isArray(returnObject[key]))) {
+                returnObject[key] = removeUndefined(returnObject[key], true);
+            }
+        });
+        return returnObject;
+    }
+    return item;
+};
+exports.removeUndefined = removeUndefined;
+/**
+ * This function removes all whitespace from a string
+ *
+ * @param str the string to remove whitespace from
+ * @returns
+ */
+const removeWhitespace = (str) => {
+    return str.replace(/\s/g, '');
+};
+exports.removeWhitespace = removeWhitespace;

package/dist/helpers/object-validation-helpers.d.ts

@@ -0,0 +1,59 @@
+/**
+ * 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.
+ */
+declare const validateArray: (incomingObject: unknown, minimumLength?: number, maximumLength?: number) => boolean;
+/**
+ * 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.
+ */
+declare const validateBoolean: (incomingObject: unknown, undefinedValid?: boolean) => boolean;
+/**
+ * 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
+ */
+declare const validateDate: (dateToValidate: unknown, undefinedValid?: boolean, allowFutureDated?: boolean, ensureAtLeast18YearsAgo?: boolean) => boolean;
+/**
+ * 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
+ */
+declare const validateNumber: (incomingObject: unknown, min?: number, max?: number) => boolean;
+/**
+ * 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.
+ */
+declare const validateString: (incomingObject: unknown, hasNoSpaces?: boolean, undefinedValid?: boolean, emptyStringValid?: boolean) => boolean;
+/**
+ * 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
+ */
+declare const validateUrl: (incomingUrl: unknown, undefinedValid?: boolean) => boolean;
+export { validateArray, validateBoolean, validateDate, validateNumber, validateString, validateUrl, };
+//# sourceMappingURL=object-validation-helpers.d.ts.map

package/dist/helpers/object-validation-helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"object-validation-helpers.d.ts","sourceRoot":"","sources":["../../src/helpers/object-validation-helpers.ts"],"names":[],"mappings":"AAEA;;;;;;;;GAQG;AACH,QAAA,MAAM,aAAa,mBAAoB,OAAO,0CAAqC,MAAM,KAAG,OAc3F,CAAC;AAEF;;;;;;;GAOG;AACH,QAAA,MAAM,eAAe,mBAAoB,OAAO,+BAA2B,OAS1E,CAAC;AAEF;;;;;;;;GAQG;AACH,QAAA,MAAM,YAAY,mBAAoB,OAAO,8FACP,OAoCrC,CAAC;AAEF;;;;;;;GAOG;AACH,QAAA,MAAM,cAAc,mBAAoB,OAAO,QAAQ,MAAM,QAAQ,MAAM,KAAG,OAU7E,CAAC;AAEF;;;;;;;;;GASG;AACH,QAAA,MAAM,cAAc,mBAAoB,OAAO,kFAA0E,OAiCxH,CAAC;AAEF;;;;;;GAMG;AACH,QAAA,MAAM,WAAW,gBAAiB,OAAO,+BAA2B,OAqBnE,CAAC;AA+CF,OAAO,EACH,aAAa,EACb,eAAe,EACf,YAAY,EACZ,cAAc,EACd,cAAc,EACd,WAAW,GACd,CAAC"}