@beecode/msh-util 1.2.0 → 1.2.1

package/lib/array-util.d.ts

@@ -5,7 +5,7 @@ export declare const arrayUtil: {
      * @param {T | null | undefined} value
      * @return {value is T}
      * @example
-     * const notEmptyArray = [0, 1, 2, null, undefined, ''].filter(arrayUtil.notEmpty))
+     * const notEmptyArray = [0, 1, 2, null, undefined, ''].filter(arrayUtil.notEmpty)
      * console.log(notEmptyArray)// [0, 1, 2, '']
      */
     notEmpty: <T>(value: T | null | undefined) => value is T;
@@ -15,7 +15,7 @@ export declare const arrayUtil: {
      * @param {T | null | undefined} value
      * @return {value is T}
      * @example
-     * const notFalsyArray = [0, 1, 2, null, undefined, ''].filter(arrayUtil.notFalsy))
+     * const notFalsyArray = [0, 1, 2, null, undefined, ''].filter(arrayUtil.notFalsy)
      * console.log(notFalsyArray)// [1, 2]
      */
     notFalsy: <T_1>(value: T_1 | null | undefined) => value is T_1;

package/lib/array-util.js

@@ -8,7 +8,7 @@ exports.arrayUtil = {
      * @param {T | null | undefined} value
      * @return {value is T}
      * @example
-     * const notEmptyArray = [0, 1, 2, null, undefined, ''].filter(arrayUtil.notEmpty))
+     * const notEmptyArray = [0, 1, 2, null, undefined, ''].filter(arrayUtil.notEmpty)
      * console.log(notEmptyArray)// [0, 1, 2, '']
      */
     notEmpty: (value) => {
@@ -20,7 +20,7 @@ exports.arrayUtil = {
      * @param {T | null | undefined} value
      * @return {value is T}
      * @example
-     * const notFalsyArray = [0, 1, 2, null, undefined, ''].filter(arrayUtil.notFalsy))
+     * const notFalsyArray = [0, 1, 2, null, undefined, ''].filter(arrayUtil.notFalsy)
      * console.log(notFalsyArray)// [1, 2]
      */
     notFalsy: (value) => {

package/package.json

@@ -1,129 +1,136 @@
 {
-	"_moduleAliases": {
-		"src": "./lib"
-	},
-	"author": "Milos Bugarinovic <milos.bugarinovic@gmail.com>",
-	"bugs": {
-		"url": "https://github.com/beecode-rs/msh-util/issues"
-	},
-	"commitlint": {
-		"extends": [
-			"@commitlint/config-conventional"
-		]
-	},
-	"config": {
-		"commitizen": {
-			"path": "node_modules/cz-conventional-changelog"
-		}
-	},
-	"dependencies": {
-		"date-fns": "2.29.3",
-		"joi": "17.9.1",
-		"lodash.clonedeep": "4.5.0",
-		"rxjs": "7.8.0"
-	},
-	"description": "",
-	"devDependencies": {
-		"@commitlint/cli": "17.5.1",
-		"@commitlint/config-conventional": "17.4.4",
-		"@commitlint/prompt": "17.5.0",
-		"@semantic-release/changelog": "6.0.3",
-		"@semantic-release/commit-analyzer": "9.0.2",
-		"@semantic-release/exec": "6.0.3",
-		"@semantic-release/git": "10.0.1",
-		"@semantic-release/github": "8.0.7",
-		"@semantic-release/release-notes-generator": "10.0.3",
-		"@types/jest": "29.5.0",
-		"@types/lodash.clonedeep": "4.5.7",
-		"@types/node": "18.15.11",
-		"@typescript-eslint/eslint-plugin": "5.57.1",
-		"@typescript-eslint/parser": "5.57.1",
-		"commitizen": "4.3.0",
-		"eslint": "8.37.0",
-		"eslint-config-prettier": "8.8.0",
-		"eslint-plugin-import": "2.27.5",
-		"eslint-plugin-jest": "27.2.1",
-		"eslint-plugin-no-loops": "0.3.0",
-		"eslint-plugin-no-only-tests": "3.1.0",
-		"eslint-plugin-prettier": "4.2.1",
-		"eslint-plugin-sort-keys-fix": "1.1.2",
-		"husky": "8.0.3",
-		"jest": "29.5.0",
-		"jest-extended": "3.2.4",
-		"lint-staged": "13.2.0",
-		"markdown-toc": "1.2.0",
-		"prettier": "2.8.7",
-		"rimraf": "4.4.1",
-		"semantic-release": "21.0.1",
-		"source-map-support": "0.5.21",
-		"ts-jest": "29.1.0",
-		"ts-node": "10.9.1",
-		"tsc-alias": "1.8.5",
-		"tsc-watch": "6.0.0",
-		"typedoc": "0.23.28",
-		"typedoc-plugin-markdown": "3.14.0",
-		"typescript": "4.9.5"
-	},
-	"engines": {
-		"node": "=18.15.0",
-		"npm": "=9.6.1"
-	},
-	"files": [
-		"lib",
-		"package-lock.json"
-	],
-	"homepage": "https://github.com/beecode-rs/msh-util#readme",
-	"keywords": [],
-	"license": "mit",
-	"lint-staged": {
-		"src/**/*.{ts,tsx,js,jsx}": "eslint"
-	},
-	"main": "lib/index.js",
-	"name": "@beecode/msh-util",
-	"repository": {
-		"type": "git",
-		"url": "https://github.com/beecode-rs/msh-util.git"
-	},
-	"scripts": {
-		"audit:fix": "npx --yes npm-force-resolutions",
-		"build": "npm run clean && npm run tsc && npm run tsc:alias",
-		"build:on-success": "npm run tsc:alias",
-		"build:watch": "npm run tsc:watch --preserveWatchOutput --onSuccess 'npm run tsc:cleaner' --onCompilationComplete 'npm run build:on-success'",
-		"bump-version": "npm --no-git-tag-version version",
-		"clean": "rimraf ./lib/*",
-		"commit": "git-cz",
-		"doc:api": "npx typedoc",
-		"doc:toc": "npx markdown-toc -i README.md",
-		"docker:build": "docker build -f .docker/Dockerfile -t bc-msh-util .",
-		"docker:exec": "docker run --rm bc-msh-util",
-		"docker:exec:sh": "docker run --rm -it bc-msh-util sh",
-		"docker:rmi": "docker rmi bc-msh-util",
-		"eslint": "eslint . --quiet",
-		"eslint:fix": "npm run eslint --fix",
-		"initial-setup": "npm run initial-setup:husky && npm run initial-setup:git-config",
-		"initial-setup:git-config": "git config include.path ../.git-config",
-		"initial-setup:husky": "npx husky install",
-		"lint": "npm run prettier && npm run eslint",
-		"lint:fix": "npm run prettier:fix && npm run eslint:fix",
-		"pack": "npm pack --pack-destination=./packages",
-		"prettier": "prettier --check {**/*,*}.{js,json,jsx,ts,tsx}",
-		"prettier:fix": "prettier --write {**/*,*}.{js,json,jsx,ts,tsx}",
-		"semantic-release": "semantic-release",
-		"semantic-release:check": "npm run semantic-release --dry-run --no-ci",
-		"test": "npm run test:unit && npm run test:int ",
-		"test:int": "# TZ=utc jest --config=./jest-int.config.js",
-		"test:unit": "TZ=utc jest --config=./jest-unit.config.js",
-		"test:unit:coverage": "npm run test:unit --coverage",
-		"test:unit:coverage:publish": "codecov",
-		"tsc": "tsc -p ./tsconfig-build.json",
-		"tsc:alias": "tsc-alias",
-		"tsc:check": "npm run tsc --noEmit",
-		"tsc:check:list-files": "npm run tsc:check --listFiles",
-		"tsc:cleaner": "ts-cleaner --dist lib",
-		"tsc:cleaner:watch": "npm run tsc:cleaner --watch",
-		"tsc:time": "npm run tsc --diagnostics",
-		"tsc:watch": "tsc-watch -p tsconfig-build.json"
-	},
-	"types": "lib/index.d.ts",
-	"version": "1.2.0"
+  "name": "@beecode/msh-util",
+  "version": "1.2.1",
+  "description": "",
+  "keywords": [],
+  "homepage": "https://github.com/beecode-rs/msh-util#readme",
+  "bugs": {
+    "url": "https://github.com/beecode-rs/msh-util/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/beecode-rs/msh-util.git"
+  },
+  "license": "mit",
+  "author": "Milos Bugarinovic <milos.bugarinovic@gmail.com>",
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
+  "files": [
+    "./lib",
+    "./src",
+    "./package-lock.json"
+  ],
+  "scripts": {
+    "build": "npm run clean && npm run tsc && npm run tsc:alias",
+    "build:on-success": "npm run tsc:cleaner && npm run tsc:alias",
+    "build:watch": "npm run clean && npm run tsc:watch -- --onCompilationComplete 'npm run build:on-success'",
+    "bump-version": "npm --no-git-tag-version version",
+    "clean": "rimraf ./lib/*",
+    "doc:api": "npx typedoc",
+    "doc:toc": "npx markdown-toc -i ./README.md",
+    "docker:build": "docker build -f ./.docker/Dockerfile -t bc-msh-util ./",
+    "docker:exec": "docker run --rm bc-msh-util",
+    "docker:exec:sh": "docker run --rm -it bc-msh-util sh",
+    "docker:rmi": "docker rmi bc-msh-util",
+    "eslint": "eslint ./ --quiet",
+    "eslint:fix": "npm run eslint -- --fix",
+    "initial-setup": "npm run initial-setup:husky && npm run initial-setup:git-config",
+    "initial-setup:git-config": "git config include.path ./.git-config",
+    "initial-setup:husky": "npx husky install",
+    "jsonlint": "npm run jsonlint:fix -- -c",
+    "jsonlint:fix": "jsonsort * '!./test/node_modules' '!./resource' '!**/.env*'",
+    "lint": "npm run prettier && npm run eslint && npm run jsonlint",
+    "lint:fix": "npm run prettier:fix && npm run eslint:fix && npm run jsonlint:fix",
+    "pack": "npm pack --pack-destination=./packages",
+    "prettier": "prettier --check {**/*,*}.{js,jsx,ts,tsx}",
+    "prettier:fix": "prettier --write {**/*,*}.{js,jsx,ts,tsx}",
+    "semantic-release": "semantic-release",
+    "semantic-release:check": "npm run semantic-release -- --dry-run --no-ci",
+    "test": "npm run test:unit #&& npm run test:int",
+    "test:e2e": "TZ=utc jest --config=./test/jest.config.js",
+    "test:int": "TZ=utc jest --config=./jest-int.config.js",
+    "test:unit": "TZ=utc jest --config=./jest-unit.config.js",
+    "test:unit:coverage": "npm run test:unit -- --coverage",
+    "test:unit:coverage:publish": "codecov",
+    "tsc": "tsc -p ./tsconfig-build.json",
+    "tsc:alias": "tsc-alias -p ./tsconfig-build.json",
+    "tsc:check": "npm run tsc -- --noEmit",
+    "tsc:check:list-files": "npm run tsc:check -- --listFiles",
+    "tsc:cleaner": "ts-cleaner --dist ./lib",
+    "tsc:cleaner:watch": "npm run tsc:cleaner -- --watch",
+    "tsc:time": "npm run tsc -- --diagnostics",
+    "tsc:watch": "tsc-watch -p ./tsconfig-build.json --preserveWatchOutput"
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
+  "lint-staged": {
+    "**.*.json": [
+      "npm run jsonlint"
+    ],
+    "**/*.{ts,tsx,js,jsx}": [
+      "eslint",
+      "prettier --check"
+    ]
+  },
+  "config": {
+    "commitizen": {
+      "path": "node_modules/cz-conventional-changelog"
+    }
+  },
+  "dependencies": {
+    "date-fns": "2.30.0",
+    "joi": "17.9.2",
+    "lodash.clonedeep": "4.5.0",
+    "rxjs": "7.8.1"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "17.6.3",
+    "@commitlint/config-conventional": "17.6.3",
+    "@commitlint/prompt": "17.6.3",
+    "@semantic-release/changelog": "6.0.3",
+    "@semantic-release/commit-analyzer": "9.0.2",
+    "@semantic-release/exec": "6.0.3",
+    "@semantic-release/git": "10.0.1",
+    "@semantic-release/github": "8.0.7",
+    "@semantic-release/release-notes-generator": "11.0.1",
+    "@types/jest": "29.5.1",
+    "@types/lodash.clonedeep": "4.5.7",
+    "@types/node": "20.2.1",
+    "@typescript-eslint/eslint-plugin": "5.59.6",
+    "@typescript-eslint/parser": "5.59.6",
+    "commitizen": "4.3.0",
+    "eslint": "8.41.0",
+    "eslint-config-prettier": "8.8.0",
+    "eslint-plugin-import": "2.27.5",
+    "eslint-plugin-jest": "27.2.1",
+    "eslint-plugin-no-loops": "0.3.0",
+    "eslint-plugin-no-only-tests": "3.1.0",
+    "eslint-plugin-prettier": "4.2.1",
+    "eslint-plugin-sort-keys-fix": "1.1.2",
+    "husky": "8.0.3",
+    "jest": "29.5.0",
+    "jest-extended": "3.2.4",
+    "json-sort-cli": "3.1.3",
+    "lint-staged": "13.2.2",
+    "markdown-toc": "1.2.0",
+    "prettier": "2.8.8",
+    "rimraf": "5.0.1",
+    "semantic-release": "21.0.2",
+    "source-map-support": "0.5.21",
+    "ts-cleaner": "1.0.5",
+    "ts-jest": "29.1.0",
+    "ts-node": "10.9.1",
+    "tsc-alias": "1.8.6",
+    "tsc-watch": "6.0.4",
+    "typedoc": "0.24.7",
+    "typedoc-plugin-markdown": "3.15.3",
+    "typescript": "4.9.5"
+  },
+  "engines": {
+    "node": ">=14",
+    "npm": ">=6"
+  }
 }

package/src/array-util.test.ts

@@ -0,0 +1,50 @@
+import { arrayUtil } from 'src/array-util'
+
+describe('arrayUtil', () => {
+	describe('notEmpty', () => {
+		it.each([
+			[
+				[1, 2, undefined, 4, null, 5],
+				[1, 2, 4, 5],
+			],
+			[
+				['', 0],
+				['', 0],
+			],
+			[[undefined, null], []],
+			[[undefined, 4, null], [4]],
+			[
+				[[1], [2], [undefined], [4], [null], [5]],
+				[[1], [2], [undefined], [4], [null], [5]],
+			],
+			[
+				[{ a: 1 }, { a: 2 }, { a: undefined }, { a: 4 }, { a: null }, { a: 5 }],
+				[{ a: 1 }, { a: 2 }, { a: undefined }, { a: 4 }, { a: null }, { a: 5 }],
+			],
+		])('%#. should filter not empty values from array %s to be %s', (arr: any, expected) => {
+			expect(arr.filter(arrayUtil.notEmpty)).toEqual(expected)
+		})
+	})
+
+	describe('notFalsy', () => {
+		it.each([
+			[
+				[1, 2, undefined, 4, null, 5],
+				[1, 2, 4, 5],
+			],
+			[['', 0], []],
+			[[undefined, null], []],
+			[[undefined, 4, null], [4]],
+			[
+				[[1], [2], [undefined], [4], [null], [5]],
+				[[1], [2], [undefined], [4], [null], [5]],
+			],
+			[
+				[{ a: 1 }, { a: 2 }, { a: undefined }, { a: 4 }, { a: null }, { a: 5 }],
+				[{ a: 1 }, { a: 2 }, { a: undefined }, { a: 4 }, { a: null }, { a: 5 }],
+			],
+		])('%#. should filter not empty values from array %s to be %s', (arr: any, expected) => {
+			expect(arr.filter(arrayUtil.notFalsy)).toEqual(expected)
+		})
+	})
+})

package/src/array-util.ts

@@ -0,0 +1,26 @@
+export const arrayUtil = {
+	/**
+	 * Check if array element is not empty
+	 * @template T
+	 * @param {T | null | undefined} value
+	 * @return {value is T}
+	 * @example
+	 * const notEmptyArray = [0, 1, 2, null, undefined, ''].filter(arrayUtil.notEmpty)
+	 * console.log(notEmptyArray)// [0, 1, 2, '']
+	 */
+	notEmpty: <T>(value: T | null | undefined): value is T => {
+		return value !== null && value !== undefined
+	},
+	/**
+	 * Check if array element is not falsy
+	 * @template T
+	 * @param {T | null | undefined} value
+	 * @return {value is T}
+	 * @example
+	 * const notFalsyArray = [0, 1, 2, null, undefined, ''].filter(arrayUtil.notFalsy)
+	 * console.log(notFalsyArray)// [1, 2]
+	 */
+	notFalsy: <T>(value: T | null | undefined): value is T => {
+		return !!value
+	},
+}

package/src/class-factory-pattern.test.ts

@@ -0,0 +1,39 @@
+import { classFactoryPattern } from 'src/class-factory-pattern'
+
+describe('factoryPattern', () => {
+	const fakeClassMock = jest.fn()
+
+	beforeEach(() => {
+		fakeClassMock.mockImplementation((a: string) => {
+			return { a }
+		})
+	})
+
+	afterEach(() => jest.resetAllMocks())
+
+	it('should return result from factory function', () => {
+		const expectedAValue = 'test'
+		const factoryPatternImplementation = classFactoryPattern(fakeClassMock)
+		expect(fakeClassMock).not.toHaveBeenCalled()
+		const result = factoryPatternImplementation(expectedAValue)
+		expect(fakeClassMock).toHaveBeenCalledTimes(1)
+		expect(result.a).toEqual(expectedAValue)
+	})
+
+	it('should call factory function every time the factory implementation is called', () => {
+		const expectedAValue = 'test'
+		const factoryPatternImplementation = classFactoryPattern(fakeClassMock)
+		expect(fakeClassMock).not.toHaveBeenCalled()
+		const result1 = factoryPatternImplementation(expectedAValue)
+		expect(fakeClassMock).toHaveBeenCalledTimes(1)
+		expect(result1.a).toEqual(expectedAValue)
+
+		const result2 = factoryPatternImplementation(expectedAValue)
+		expect(fakeClassMock).toHaveBeenCalledTimes(2)
+		expect(result2.a).toEqual(expectedAValue)
+
+		const result3 = factoryPatternImplementation(expectedAValue)
+		expect(fakeClassMock).toHaveBeenCalledTimes(3)
+		expect(result3.a).toEqual(expectedAValue)
+	})
+})

package/src/class-factory-pattern.ts

@@ -0,0 +1,29 @@
+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 const classFactoryPattern = <C extends ClassType>(
+	classType: C
+): ((...args: ConstructorParameters<C>) => InstanceType<C>) => {
+	return (...args: ConstructorParameters<C>): InstanceType<C> => {
+		return new classType(...args) as InstanceType<C>
+	}
+}

package/src/express/error-handler.test.ts

@@ -0,0 +1,44 @@
+import { expressErrorHandler } from 'src/express/error-handler'
+
+describe('expressErrorHandler', () => {
+	const fake_fn = jest.fn()
+	const fake_req = jest.fn()
+	const fake_res = jest.fn()
+	const fake_next = jest.fn()
+
+	class FakeExpressController {
+		@expressErrorHandler
+		async login(_req: any, _res: any, _next: any): Promise<any> {
+			return await fake_fn()
+		}
+	}
+	const fakeExpressControllerInstance = new FakeExpressController()
+
+	afterEach(() => jest.resetAllMocks())
+
+	it('should call next with error if async function throws error', async () => {
+		const error = new Error()
+		fake_fn.mockRejectedValue(error)
+
+		await fakeExpressControllerInstance.login(fake_req, fake_res, fake_next)
+
+		expect(fake_fn).toHaveBeenCalledTimes(1)
+		expect(fake_req).not.toHaveBeenCalled()
+		expect(fake_res).not.toHaveBeenCalled()
+		expect(fake_next).toHaveBeenCalledTimes(1)
+		expect(fake_next).toHaveBeenCalledOnceWith(error)
+	})
+
+	it('should work as usual if async function resolves promise', async () => {
+		const expected = { successful: true }
+		fake_fn.mockResolvedValue(expected)
+
+		const result = await fakeExpressControllerInstance.login(fake_req, fake_res, fake_next)
+
+		expect(fake_fn).toHaveBeenCalledTimes(1)
+		expect(fake_req).not.toHaveBeenCalled()
+		expect(fake_res).not.toHaveBeenCalled()
+		expect(fake_next).not.toHaveBeenCalled()
+		expect(result).toBe(expected)
+	})
+})

package/src/express/error-handler.ts

@@ -0,0 +1,25 @@
+/**
+ * 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 const expressErrorHandler = (_target: any, _key: string, descriptor: TypedPropertyDescriptor<any>): any => {
+	const originalMethod = descriptor.value
+	descriptor.value = function (): any {
+		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
+}

package/src/index.ts

@@ -0,0 +1,25 @@
+export * from 'src/express/error-handler'
+
+export * from 'src/singleton/async'
+
+export * from 'src/singleton/pattern'
+
+export * from 'src/class-factory-pattern'
+
+export * from 'src/joi-util'
+
+export * from 'src/memoize-factory'
+
+export * from 'src/object-util'
+
+export * from 'src/regex-util'
+
+export * from 'src/single-threshold-promise'
+
+export * from 'src/string-util'
+
+export * from 'src/time-util'
+
+export * from 'src/timeout'
+
+export * from 'src/type-util'