@beecode/msh-util 1.0.1-alpha

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Beecode
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,25 @@
+[![Build Status](https://beecode.semaphoreci.com/badges/msh-util/branches/main.svg?style=shields)](https://beecode.semaphoreci.com/projects/msh-util)
+[![codecov](https://codecov.io/gh/beecode-rs/msh-util/branch/main/graph/badge.svg?token=fHc0YaxEiB)](https://codecov.io/gh/beecode-rs/msh-util)
+[![GitHub license](https://img.shields.io/github/license/beecode-rs/msh-util)](https://github.com/beecode-rs/msh-util/blob/main/LICENSE)  
+[![NPM](https://nodei.co/npm/@beecode/msh-util.png)](https://nodei.co/npm/@beecode/msh-util)
+
+# msh-util
+
+Micro-service helper: node error
+
+This project is intended to be used in typescript project.
+
+<!-- toc -->
+
+- [Install](#install)
+- [Diagram](#diagram)
+
+<!-- tocstop -->
+
+## Install
+
+`npm i @beecode/msh-util`
+
+## Diagram
+
+![vision-diagram](resource/doc/vision/vision.svg)

package/lib/class-factory-pattern.d.ts

@@ -0,0 +1,25 @@
+export type ClassType<T = object> = new (...args: T extends {
+    new (...args: infer P): any;
+} ? P : never[]) => T;
+/**
+ * This is a wrapper that easily converts class constructor call (`new className(..constructorParams)`) into function call (`classNameFactory(..constructorParams)`)
+ * @param {C} classType
+ * @template C
+ * @return {(...args: ConstructorParameters<C>) => InstanceType<C>}
+ * @example
+ * export class SomeClass {
+ *   protected _a: string
+ *
+ *   constructor(params: { a: string }) {
+ *     const { a } = params
+ *     this._a = a
+ *   }
+ * }
+ *
+ * export const someClassFactory = classFactoryPattern(SomeClass)
+ *
+ * // using
+ * const someClassInstance = someClassFactory({ a: 'test' })
+ */
+export declare const classFactoryPattern: <C extends ClassType<object>>(classType: C) => (...args: ConstructorParameters<C>) => InstanceType<C>;
+//# sourceMappingURL=class-factory-pattern.d.ts.map

package/lib/class-factory-pattern.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"class-factory-pattern.d.ts","sourceRoot":"","sources":["../src/class-factory-pattern.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,SAAS,CAAC,CAAC,GAAG,MAAM,IAAI,KAAK,GAAG,IAAI,EAAE,CAAC,SAAS;IAAE,KAAK,GAAG,IAAI,EAAE,MAAM,CAAC,GAAG,GAAG,CAAA;CAAE,GAAG,CAAC,GAAG,KAAK,EAAE,KAAK,CAAC,CAAA;AAE/G;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,mBAAmB,uGAM/B,CAAA"}

package/lib/class-factory-pattern.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.classFactoryPattern = void 0;
+/**
+ * This is a wrapper that easily converts class constructor call (`new className(..constructorParams)`) into function call (`classNameFactory(..constructorParams)`)
+ * @param {C} classType
+ * @template C
+ * @return {(...args: ConstructorParameters<C>) => InstanceType<C>}
+ * @example
+ * export class SomeClass {
+ *   protected _a: string
+ *
+ *   constructor(params: { a: string }) {
+ *     const { a } = params
+ *     this._a = a
+ *   }
+ * }
+ *
+ * export const someClassFactory = classFactoryPattern(SomeClass)
+ *
+ * // using
+ * const someClassInstance = someClassFactory({ a: 'test' })
+ */
+const classFactoryPattern = (classType) => {
+    return (...args) => {
+        return new classType(...args);
+    };
+};
+exports.classFactoryPattern = classFactoryPattern;
+//# sourceMappingURL=class-factory-pattern.js.map

package/lib/class-factory-pattern.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"class-factory-pattern.js","sourceRoot":"","sources":["../src/class-factory-pattern.ts"],"names":[],"mappings":";;;AAEA;;;;;;;;;;;;;;;;;;;GAmBG;AACI,MAAM,mBAAmB,GAAG,CACjC,SAAY,EAC8C,EAAE;IAC5D,OAAO,CAAC,GAAG,IAA8B,EAAmB,EAAE;QAC5D,OAAO,IAAI,SAAS,CAAC,GAAG,IAAI,CAAoB,CAAA;IAClD,CAAC,CAAA;AACH,CAAC,CAAA;AANY,QAAA,mBAAmB,uBAM/B"}

package/lib/express/error-handler.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Wrap async express http request end return promise or call next on catch
+ * @param _target
+ * @param _key
+ * @param descriptor
+ * @example
+ * export class RootController {
+ *  /@expressErrorHandler
+ *   async login(req: Request, res: Response): Promise<void> {
+ *     const { username, password } = validationUtil().sanitize(req.body, postLoginBodySchema)
+ *     const result = await authorizationUseCase.login({ username, password })
+ *     res.json(result)
+ *   }
+ * }
+ */
+export declare const expressErrorHandler: (_target: any, _key: string, descriptor: TypedPropertyDescriptor<any>) => any;
+//# sourceMappingURL=error-handler.d.ts.map

package/lib/express/error-handler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"error-handler.d.ts","sourceRoot":"","sources":["../../src/express/error-handler.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,mBAAmB,YAAa,GAAG,QAAQ,MAAM,cAAc,wBAAwB,GAAG,CAAC,KAAG,GAS1G,CAAA"}

package/lib/express/error-handler.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.expressErrorHandler = void 0;
+/**
+ * Wrap async express http request end return promise or call next on catch
+ * @param _target
+ * @param _key
+ * @param descriptor
+ * @example
+ * export class RootController {
+ *  /@expressErrorHandler
+ *   async login(req: Request, res: Response): Promise<void> {
+ *     const { username, password } = validationUtil().sanitize(req.body, postLoginBodySchema)
+ *     const result = await authorizationUseCase.login({ username, password })
+ *     res.json(result)
+ *   }
+ * }
+ */
+const expressErrorHandler = (_target, _key, descriptor) => {
+    const originalMethod = descriptor.value;
+    descriptor.value = function () {
+        const next = arguments[2]; // eslint-disable-line prefer-rest-params
+        return Promise.resolve(originalMethod.apply(this, arguments)).catch(next); // eslint-disable-line prefer-rest-params
+    };
+    return descriptor;
+};
+exports.expressErrorHandler = expressErrorHandler;
+//# sourceMappingURL=error-handler.js.map

package/lib/express/error-handler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error-handler.js","sourceRoot":"","sources":["../../src/express/error-handler.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;;;GAcG;AACI,MAAM,mBAAmB,GAAG,CAAC,OAAY,EAAE,IAAY,EAAE,UAAwC,EAAO,EAAE;IAC/G,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAA;IACvC,UAAU,CAAC,KAAK,GAAG;QACjB,MAAM,IAAI,GAAG,SAAS,CAAC,CAAC,CAAC,CAAA,CAAC,yCAAyC;QAEnE,OAAO,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA,CAAC,yCAAyC;IACrH,CAAC,CAAA;IAED,OAAO,UAAU,CAAA;AACnB,CAAC,CAAA;AATY,QAAA,mBAAmB,uBAS/B"}

package/lib/index.d.ts

@@ -0,0 +1,14 @@
+export * from './express/error-handler';
+export * from './singleton/async';
+export * from './singleton/pattern';
+export * from './class-factory-pattern';
+export * from './joi-util';
+export * from './memoize-factory';
+export * from './object-util';
+export * from './regex-util';
+export * from './single-threshold-promise';
+export * from './string-util';
+export * from './time-util';
+export * from './timeout';
+export * from './type-util';
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,2BAA2B,CAAA;AAEzC,cAAc,qBAAqB,CAAA;AAEnC,cAAc,uBAAuB,CAAA;AAErC,cAAc,2BAA2B,CAAA;AAEzC,cAAc,cAAc,CAAA;AAE5B,cAAc,qBAAqB,CAAA;AAEnC,cAAc,iBAAiB,CAAA;AAE/B,cAAc,gBAAgB,CAAA;AAE9B,cAAc,8BAA8B,CAAA;AAE5C,cAAc,iBAAiB,CAAA;AAE/B,cAAc,eAAe,CAAA;AAE7B,cAAc,aAAa,CAAA;AAE3B,cAAc,eAAe,CAAA"}

package/lib/index.js

@@ -0,0 +1,30 @@
+"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 });
+__exportStar(require("./express/error-handler"), exports);
+__exportStar(require("./singleton/async"), exports);
+__exportStar(require("./singleton/pattern"), exports);
+__exportStar(require("./class-factory-pattern"), exports);
+__exportStar(require("./joi-util"), exports);
+__exportStar(require("./memoize-factory"), exports);
+__exportStar(require("./object-util"), exports);
+__exportStar(require("./regex-util"), exports);
+__exportStar(require("./single-threshold-promise"), exports);
+__exportStar(require("./string-util"), exports);
+__exportStar(require("./time-util"), exports);
+__exportStar(require("./timeout"), exports);
+__exportStar(require("./type-util"), exports);
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4DAAyC;AAEzC,sDAAmC;AAEnC,wDAAqC;AAErC,4DAAyC;AAEzC,+CAA4B;AAE5B,sDAAmC;AAEnC,kDAA+B;AAE/B,iDAA8B;AAE9B,+DAA4C;AAE5C,kDAA+B;AAE/B,gDAA6B;AAE7B,8CAA2B;AAE3B,gDAA6B"}

package/lib/joi-util.d.ts

@@ -0,0 +1,47 @@
+import { ObjectSchema, Schema, ValidationOptions } from 'joi';
+export declare class ErrorWithPayload<T> extends Error {
+    payload: T;
+    constructor(message: string, payload: T);
+}
+/**
+ * This is a simple wrapper around Joi validation with two functions exposed validate and sanitize. If object is not valid function throws an error.
+ * @example
+ * type SomeType = {
+ *   a: string
+ *   b: number
+ * }
+ * const someSchema = Joi.object<SomeType>().keys({
+ *   a: Joi.string().required(),
+ *   b: Joi.number().required(),
+ * }).required()
+ *
+ * const joiUtil = new JoiUtil()
+ *
+ * // using
+ * const invalidObject = joiUtil.validate({}, someSchema) // validate throws an error
+ * const validObject = joiUtil.validate({ a: 'a', b: 1 }, someSchema)
+ */
+export declare class JoiUtil {
+    /**
+     * Validate and clean object
+     * @template T
+     * @template Joi
+     * @param {any} objectToValidate
+     * @param {Joi.Schema | Joi.ObjectSchema<T>} schema
+     * @param {validationOptions} [validationOptions]
+     * @returns {T} expected object after validation
+     */
+    sanitize<T>(objectToValidate: any, schema: Schema | ObjectSchema<T>, validationOptions?: ValidationOptions): T;
+    /**
+     * Only validate properties specified in validation schema
+     * @template T
+     * @template Joi
+     * @param {any} objectToValidate
+     * @param {Joi.Schema | Joi.ObjectSchema<T>} schema
+     * @param {validationOptions} [validationOptions]
+     * @returns {T} expected object after validation
+     */
+    validate<T>(objectToValidate: any, schema: Schema | ObjectSchema<T>, validationOptions?: ValidationOptions): T;
+    protected _validate<T>(objectToValidate: any, schema: Schema | ObjectSchema<T>, validationOptions?: ValidationOptions): T;
+}
+//# sourceMappingURL=joi-util.d.ts.map

package/lib/joi-util.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"joi-util.d.ts","sourceRoot":"","sources":["../src/joi-util.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,KAAK,CAAA;AAE7D,qBAAa,gBAAgB,CAAC,CAAC,CAAE,SAAQ,KAAK;IAC5C,OAAO,EAAE,CAAC,CAAA;gBAEE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;CAIxC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,qBAAa,OAAO;IAClB;;;;;;;;OAQG;IACH,QAAQ,CAAC,CAAC,EAAE,gBAAgB,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,GAAG,YAAY,CAAC,CAAC,CAAC,EAAE,iBAAiB,CAAC,EAAE,iBAAiB,GAAG,CAAC;IAI9G;;;;;;;;OAQG;IACH,QAAQ,CAAC,CAAC,EAAE,gBAAgB,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,GAAG,YAAY,CAAC,CAAC,CAAC,EAAE,iBAAiB,CAAC,EAAE,iBAAiB,GAAG,CAAC;IAI9G,SAAS,CAAC,SAAS,CAAC,CAAC,EAAE,gBAAgB,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,GAAG,YAAY,CAAC,CAAC,CAAC,EAAE,iBAAiB,CAAC,EAAE,iBAAiB,GAAG,CAAC;CAQ1H"}

package/lib/joi-util.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JoiUtil = exports.ErrorWithPayload = void 0;
+class ErrorWithPayload extends Error {
+    constructor(message, payload) {
+        super(message);
+        this.payload = payload;
+    }
+}
+exports.ErrorWithPayload = ErrorWithPayload;
+/**
+ * This is a simple wrapper around Joi validation with two functions exposed validate and sanitize. If object is not valid function throws an error.
+ * @example
+ * type SomeType = {
+ *   a: string
+ *   b: number
+ * }
+ * const someSchema = Joi.object<SomeType>().keys({
+ *   a: Joi.string().required(),
+ *   b: Joi.number().required(),
+ * }).required()
+ *
+ * const joiUtil = new JoiUtil()
+ *
+ * // using
+ * const invalidObject = joiUtil.validate({}, someSchema) // validate throws an error
+ * const validObject = joiUtil.validate({ a: 'a', b: 1 }, someSchema)
+ */
+class JoiUtil {
+    /**
+     * Validate and clean object
+     * @template T
+     * @template Joi
+     * @param {any} objectToValidate
+     * @param {Joi.Schema | Joi.ObjectSchema<T>} schema
+     * @param {validationOptions} [validationOptions]
+     * @returns {T} expected object after validation
+     */
+    sanitize(objectToValidate, schema, validationOptions) {
+        return this._validate(objectToValidate, schema, Object.assign(Object.assign({}, validationOptions), { stripUnknown: true }));
+    }
+    /**
+     * Only validate properties specified in validation schema
+     * @template T
+     * @template Joi
+     * @param {any} objectToValidate
+     * @param {Joi.Schema | Joi.ObjectSchema<T>} schema
+     * @param {validationOptions} [validationOptions]
+     * @returns {T} expected object after validation
+     */
+    validate(objectToValidate, schema, validationOptions) {
+        return this._validate(objectToValidate, schema, validationOptions);
+    }
+    _validate(objectToValidate, schema, validationOptions) {
+        const { error: validationError, value } = schema.validate(objectToValidate, validationOptions);
+        if (validationError) {
+            throw new ErrorWithPayload(validationError.message.split('"').join("'"), validationError);
+        }
+        return value;
+    }
+}
+exports.JoiUtil = JoiUtil;
+//# sourceMappingURL=joi-util.js.map

package/lib/joi-util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"joi-util.js","sourceRoot":"","sources":["../src/joi-util.ts"],"names":[],"mappings":";;;AAEA,MAAa,gBAAoB,SAAQ,KAAK;IAG5C,YAAY,OAAe,EAAE,OAAU;QACrC,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;IACxB,CAAC;CACF;AAPD,4CAOC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAa,OAAO;IAClB;;;;;;;;OAQG;IACH,QAAQ,CAAI,gBAAqB,EAAE,MAAgC,EAAE,iBAAqC;QACxG,OAAO,IAAI,CAAC,SAAS,CAAI,gBAAgB,EAAE,MAAM,kCAAO,iBAAiB,KAAE,YAAY,EAAE,IAAI,IAAG,CAAA;IAClG,CAAC;IAED;;;;;;;;OAQG;IACH,QAAQ,CAAI,gBAAqB,EAAE,MAAgC,EAAE,iBAAqC;QACxG,OAAO,IAAI,CAAC,SAAS,CAAI,gBAAgB,EAAE,MAAM,EAAE,iBAAiB,CAAC,CAAA;IACvE,CAAC;IAES,SAAS,CAAI,gBAAqB,EAAE,MAAgC,EAAE,iBAAqC;QACnH,MAAM,EAAE,KAAK,EAAE,eAAe,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC,QAAQ,CAAC,gBAAgB,EAAE,iBAAiB,CAAC,CAAA;QAC9F,IAAI,eAAe,EAAE;YACnB,MAAM,IAAI,gBAAgB,CAAC,eAAe,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,eAAe,CAAC,CAAA;SAC1F;QAED,OAAO,KAAU,CAAA;IACnB,CAAC;CACF;AAnCD,0BAmCC"}

package/lib/memoize-factory.d.ts

@@ -0,0 +1,16 @@
+import { AnyFunction } from './types/any-function';
+/**
+ * This is a simple implementation of memoize function that caches result against the parameter passed that are passed to the
+ * function so it never runs the same calculation twice.
+ * @template F
+ * @template R
+ * @param {F} factoryFn
+ * @return {F: AnyFunction<R>}
+ * @example
+ * export const sumTwoNumbersMemoize = memoizeFactory((a:number, b:number): number => a + b)
+ *
+ * // using
+ * sumTwoNumbersMemoize(5 + 10) // 15
+ */
+export declare const memoizeFactory: <F extends AnyFunction<R>, R>(factoryFn: F) => F;
+//# sourceMappingURL=memoize-factory.d.ts.map

package/lib/memoize-factory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"memoize-factory.d.ts","sourceRoot":"","sources":["../src/memoize-factory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AAEpD;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,cAAc,kDAW1B,CAAA"}

package/lib/memoize-factory.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.memoizeFactory = void 0;
+/**
+ * This is a simple implementation of memoize function that caches result against the parameter passed that are passed to the
+ * function so it never runs the same calculation twice.
+ * @template F
+ * @template R
+ * @param {F} factoryFn
+ * @return {F: AnyFunction<R>}
+ * @example
+ * export const sumTwoNumbersMemoize = memoizeFactory((a:number, b:number): number => a + b)
+ *
+ * // using
+ * sumTwoNumbersMemoize(5 + 10) // 15
+ */
+const memoizeFactory = (factoryFn) => {
+    const cache = {};
+    return ((...args) => {
+        const key = JSON.stringify(args);
+        if (key in cache) {
+            return cache[key];
+        }
+        return (cache[key] = factoryFn(...args));
+    });
+};
+exports.memoizeFactory = memoizeFactory;
+//# sourceMappingURL=memoize-factory.js.map

package/lib/memoize-factory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"memoize-factory.js","sourceRoot":"","sources":["../src/memoize-factory.ts"],"names":[],"mappings":";;;AAEA;;;;;;;;;;;;GAYG;AACI,MAAM,cAAc,GAAG,CAA8B,SAAY,EAAK,EAAE;IAC7E,MAAM,KAAK,GAAuB,EAAE,CAAA;IAEpC,OAAO,CAAC,CAAC,GAAG,IAAmB,EAAK,EAAE;QACpC,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;QAChC,IAAI,GAAG,IAAI,KAAK,EAAE;YAChB,OAAO,KAAK,CAAC,GAAG,CAAC,CAAA;SAClB;QAED,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC,CAAA;IAC1C,CAAC,CAAM,CAAA;AACT,CAAC,CAAA;AAXY,QAAA,cAAc,kBAW1B"}

package/lib/object-util.d.ts

@@ -0,0 +1,70 @@
+export type ObjectType = {
+    [k: string]: any;
+};
+export declare class ObjectUtil {
+    /**
+     * Deep clone object. Returned object will have no references to the object passed through params
+     * @template T
+     * @param {T} objectToClone
+     * @return {T}
+     */
+    deepClone<T extends ObjectType>(objectToClone: T): T;
+    /**
+     * Pick only properties from the property list. It is only allowed to pick properties from the first level
+     * @template T
+     * @template L
+     * @param {T} obj
+     * @param {L[]} keyList
+     * @return {Pick<T, L>}
+     */
+    pickByList<T extends object, L extends keyof T>(obj: T, keyList: (L | string)[]): Pick<T, L>;
+    /**
+     * Pick objects properties using keys from the second object.
+     * @template T
+     * @template L
+     * @param {T} obj
+     * @param {Partial<T>} objWithPickKeys
+     * @return {Pick<T, L>}
+     */
+    pickByObjectKeys<T extends object, L extends keyof T>(obj: T, objWithPickKeys: Partial<T> | ObjectType): Pick<T, L>;
+    /**
+     * This function will do stringify deeper that JSON.stringify.
+     * @param {any} entity - entity thant needs to be stringify
+     * @param {object} [options] - available options
+     * @param {boolean} [options.isSortable=false] - if object property should be sorted
+     * @param {boolean} [options.isPrettyPrinted=false] - if object and array properties should be printed in a new row
+     * @param {number} [options.prettyPrintCompactLevel=0] - if pretty print is on define the level of deepest children that are not
+     * going to be pretty. It doesn't matter if the siblings doesn't have the same depth.
+     * @return {string} - strung result
+     * @example
+     * console.log(new ObjectUtil().deepStringify(null)) // 'null'
+     * console.log(new ObjectUtil().deepStringify(undefined)) // 'undefined'
+     * console.log(new ObjectUtil().deepStringify({ a: 1 })) // '{\n\ta: 1\n}'
+     * // `{
+     * //   a:1
+     * // }`
+     * console.log(new ObjectUtil().deepStringify({ b: 1, a: 2 }, {isSorted:true, compact: true})) // { a: 2, b: 1 }
+     */
+    deepStringify(entity: any, options?: {
+        isSorted?: boolean;
+        isPrettyPrinted?: boolean;
+        prettyPrintCompactLevel?: number;
+    }): string;
+    /**
+     * We are converting objects to string (or null or undefined) and comparing if the result is equal
+     * @param a
+     * @param b
+     * @return {boolean}
+     */
+    deepEqual(a: any, b: any): boolean;
+    /**
+     * This function is going to convert any null to undefined in the object that is passed to it.
+     * @template T
+     * @param {T} objectWithNulls
+     * @return {T}
+     * @example
+     * console.log(new ObjectUtil().deepNullToUndefined({ a: null, b: { c: null } })) // { a: undefined, b: { c: undefined } }
+     */
+    deepNullToUndefined<T extends ObjectType>(objectWithNulls: T): T;
+}
+//# sourceMappingURL=object-util.d.ts.map

package/lib/object-util.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"object-util.d.ts","sourceRoot":"","sources":["../src/object-util.ts"],"names":[],"mappings":"AAGA,MAAM,MAAM,UAAU,GAAG;IAAE,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,CAAA;AAE7C,qBAAa,UAAU;IACrB;;;;;OAKG;IACH,SAAS,CAAC,CAAC,SAAS,UAAU,EAAE,aAAa,EAAE,CAAC,GAAG,CAAC;IAIpD;;;;;;;OAOG;IACH,UAAU,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC;IAa5F;;;;;;;OAOG;IACH,gBAAgB,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,eAAe,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,UAAU,GAAG,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC;IAMnH;;;;;;;;;;;;;;;;;OAiBG;IACH,aAAa,CACX,MAAM,EAAE,GAAG,EACX,OAAO,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,OAAO,CAAC;QAAC,eAAe,CAAC,EAAE,OAAO,CAAC;QAAC,uBAAuB,CAAC,EAAE,MAAM,CAAA;KAAE,GAC5F,MAAM;IAeT;;;;;OAKG;IACH,SAAS,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,GAAG,OAAO;IAIlC;;;;;;;OAOG;IACH,mBAAmB,CAAC,CAAC,SAAS,UAAU,EAAE,eAAe,EAAE,CAAC,GAAG,CAAC;CAcjE"}

package/lib/object-util.js

@@ -0,0 +1,114 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ObjectUtil = void 0;
+const lodash_clonedeep_1 = __importDefault(require("lodash.clonedeep"));
+const util_1 = __importDefault(require("util"));
+class ObjectUtil {
+    /**
+     * Deep clone object. Returned object will have no references to the object passed through params
+     * @template T
+     * @param {T} objectToClone
+     * @return {T}
+     */
+    deepClone(objectToClone) {
+        return (0, lodash_clonedeep_1.default)(objectToClone);
+    }
+    /**
+     * Pick only properties from the property list. It is only allowed to pick properties from the first level
+     * @template T
+     * @template L
+     * @param {T} obj
+     * @param {L[]} keyList
+     * @return {Pick<T, L>}
+     */
+    pickByList(obj, keyList) {
+        return keyList.reduce((pickedObj, key) => {
+            // eslint-disable-next-line
+            if (obj && obj.hasOwnProperty(key)) {
+                // eslint-disable-next-line
+                // @ts-ignore
+                pickedObj[key] = obj[key];
+            }
+            return pickedObj;
+        }, {});
+    }
+    /**
+     * Pick objects properties using keys from the second object.
+     * @template T
+     * @template L
+     * @param {T} obj
+     * @param {Partial<T>} objWithPickKeys
+     * @return {Pick<T, L>}
+     */
+    pickByObjectKeys(obj, objWithPickKeys) {
+        const keys = Object.keys(objWithPickKeys);
+        return this.pickByList(obj, keys);
+    }
+    /**
+     * This function will do stringify deeper that JSON.stringify.
+     * @param {any} entity - entity thant needs to be stringify
+     * @param {object} [options] - available options
+     * @param {boolean} [options.isSortable=false] - if object property should be sorted
+     * @param {boolean} [options.isPrettyPrinted=false] - if object and array properties should be printed in a new row
+     * @param {number} [options.prettyPrintCompactLevel=0] - if pretty print is on define the level of deepest children that are not
+     * going to be pretty. It doesn't matter if the siblings doesn't have the same depth.
+     * @return {string} - strung result
+     * @example
+     * console.log(new ObjectUtil().deepStringify(null)) // 'null'
+     * console.log(new ObjectUtil().deepStringify(undefined)) // 'undefined'
+     * console.log(new ObjectUtil().deepStringify({ a: 1 })) // '{\n\ta: 1\n}'
+     * // `{
+     * //   a:1
+     * // }`
+     * console.log(new ObjectUtil().deepStringify({ b: 1, a: 2 }, {isSorted:true, compact: true})) // { a: 2, b: 1 }
+     */
+    deepStringify(entity, options) {
+        const { isSorted = false, isPrettyPrinted = false, prettyPrintCompactLevel = 0 } = options !== null && options !== void 0 ? options : {};
+        const compact = isPrettyPrinted ? prettyPrintCompactLevel : true;
+        return util_1.default.inspect(entity, {
+            depth: Infinity,
+            sorted: isSorted,
+            maxArrayLength: Infinity,
+            maxStringLength: Infinity,
+            compact,
+            breakLength: Infinity,
+        });
+    }
+    /**
+     * We are converting objects to string (or null or undefined) and comparing if the result is equal
+     * @param a
+     * @param b
+     * @return {boolean}
+     */
+    deepEqual(a, b) {
+        return this.deepStringify(a, { isSorted: true }) === this.deepStringify(b, { isSorted: true });
+    }
+    /**
+     * This function is going to convert any null to undefined in the object that is passed to it.
+     * @template T
+     * @param {T} objectWithNulls
+     * @return {T}
+     * @example
+     * console.log(new ObjectUtil().deepNullToUndefined({ a: null, b: { c: null } })) // { a: undefined, b: { c: undefined } }
+     */
+    deepNullToUndefined(objectWithNulls) {
+        return Object.entries(objectWithNulls).reduce((acc, cur) => {
+            const [key, value] = cur;
+            if (value === null) {
+                acc[key] = undefined;
+            }
+            else if (typeof value === 'object' && !(value instanceof Date)) {
+                acc[key] = this.deepNullToUndefined(value);
+            }
+            else {
+                acc[key] = value;
+            }
+            return acc;
+        }, {});
+    }
+}
+exports.ObjectUtil = ObjectUtil;
+//# sourceMappingURL=object-util.js.map

package/lib/object-util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"object-util.js","sourceRoot":"","sources":["../src/object-util.ts"],"names":[],"mappings":";;;;;;AAAA,wEAAwC;AACxC,gDAAuB;AAIvB,MAAa,UAAU;IACrB;;;;;OAKG;IACH,SAAS,CAAuB,aAAgB;QAC9C,OAAO,IAAA,0BAAS,EAAC,aAAa,CAAC,CAAA;IACjC,CAAC;IAED;;;;;;;OAOG;IACH,UAAU,CAAsC,GAAM,EAAE,OAAuB;QAC7E,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,SAAS,EAAE,GAAG,EAAE,EAAE;YACvC,2BAA2B;YAC3B,IAAI,GAAG,IAAI,GAAG,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE;gBAClC,2BAA2B;gBAC3B,aAAa;gBACb,SAAS,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,CAAA;aAC1B;YAED,OAAO,SAAS,CAAA;QAClB,CAAC,EAAE,EAAgB,CAAC,CAAA;IACtB,CAAC;IAED;;;;;;;OAOG;IACH,gBAAgB,CAAsC,GAAM,EAAE,eAAwC;QACpG,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,eAAe,CAAQ,CAAA;QAEhD,OAAO,IAAI,CAAC,UAAU,CAAO,GAAG,EAAE,IAAI,CAAC,CAAA;IACzC,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,aAAa,CACX,MAAW,EACX,OAA6F;QAE7F,MAAM,EAAE,QAAQ,GAAG,KAAK,EAAE,eAAe,GAAG,KAAK,EAAE,uBAAuB,GAAG,CAAC,EAAE,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,CAAA;QAEhG,MAAM,OAAO,GAAG,eAAe,CAAC,CAAC,CAAC,uBAAuB,CAAC,CAAC,CAAC,IAAI,CAAA;QAEhE,OAAO,cAAI,CAAC,OAAO,CAAC,MAAM,EAAE;YAC1B,KAAK,EAAE,QAAQ;YACf,MAAM,EAAE,QAAQ;YAChB,cAAc,EAAE,QAAQ;YACxB,eAAe,EAAE,QAAQ;YACzB,OAAO;YACP,WAAW,EAAE,QAAQ;SACtB,CAAC,CAAA;IACJ,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAAC,CAAM,EAAE,CAAM;QACtB,OAAO,IAAI,CAAC,aAAa,CAAC,CAAC,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,KAAK,IAAI,CAAC,aAAa,CAAC,CAAC,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAA;IAChG,CAAC;IAED;;;;;;;OAOG;IACH,mBAAmB,CAAuB,eAAkB;QAC1D,OAAO,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;YACzD,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,GAAG,CAAA;YACxB,IAAI,KAAK,KAAK,IAAI,EAAE;gBAClB,GAAG,CAAC,GAAG,CAAC,GAAG,SAAS,CAAA;aACrB;iBAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,CAAC,KAAK,YAAY,IAAI,CAAC,EAAE;gBAChE,GAAG,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAA;aAC3C;iBAAM;gBACL,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;aACjB;YAED,OAAO,GAAG,CAAA;QACZ,CAAC,EAAE,EAAS,CAAC,CAAA;IACf,CAAC;CACF;AAlHD,gCAkHC"}

package/lib/regex-util.d.ts

@@ -0,0 +1,12 @@
+export declare const regexUtil: {
+    /**
+     * This is a UUID regex expression. This is usually used in express router to constrict the values passed as a path parameter (if you are using UUID as your identifier).
+     * @return {string}
+     * @example
+     * const { uuid } = regexUtil
+     * router.route(`/users/:userId(${uuid})`).get(getUsersById)
+     * //...
+     */
+    uuid: "\\b[0-9a-f]{8}\\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\\b[0-9a-f]{12}\\b";
+};
+//# sourceMappingURL=regex-util.d.ts.map

package/lib/regex-util.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"regex-util.d.ts","sourceRoot":"","sources":["../src/regex-util.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,SAAS;IACpB;;;;;;;OAOG;;CAEJ,CAAA"}

package/lib/regex-util.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.regexUtil = void 0;
+exports.regexUtil = {
+    /**
+     * This is a UUID regex expression. This is usually used in express router to constrict the values passed as a path parameter (if you are using UUID as your identifier).
+     * @return {string}
+     * @example
+     * const { uuid } = regexUtil
+     * router.route(`/users/:userId(${uuid})`).get(getUsersById)
+     * //...
+     */
+    uuid: `\\b[0-9a-f]{8}\\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\\b[0-9a-f]{12}\\b`,
+};
+//# sourceMappingURL=regex-util.js.map

package/lib/regex-util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"regex-util.js","sourceRoot":"","sources":["../src/regex-util.ts"],"names":[],"mappings":";;;AAAa,QAAA,SAAS,GAAG;IACvB;;;;;;;OAOG;IACH,IAAI,EAAE,0EAAmF;CAC1F,CAAA"}