@beecode/msh-util 1.0.1-alpha

package/lib/type-util.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.typeUtil = void 0;
+exports.typeUtil = {
+    /**
+     * In TypeScript, exhaustiveMessage is a technique that can be used with switch statements to ensure that all possible cases are handled.
+     *
+     * When using switch statements, it is common to have a default case that handles any unanticipated cases. However, sometimes it is important to ensure that all cases are explicitly handled to avoid potential errors or bugs in the code.
+     * @param {string} message
+     * @param {never} _
+     * @return {string}
+     * @example
+     * export type Animal = 'cat' | 'dog' | 'bird';
+     *
+     * export const makeSound = (animal: Animal): string => {
+     *   switch (animal) {
+     *     case 'cat':
+     *       return 'Meow'
+     *     case 'dog':
+     *       return 'Woof'
+     *     case 'bird':
+     *       return 'Tweet'
+     *     default:
+     *       console.error(new TypeUtil().exhaustiveMessage('Unknown animal [animal]', animal))
+     *       return 'unknown sound'
+     *   }
+     * }
+     */
+    exhaustiveMessage: (message, _) => {
+        return message;
+    },
+    /**
+     * This is the similar to exhaustiveMessage, but instead of message we are returning error so we can throw it
+     * @param {string} message
+     * @param {never} _
+     * @return {Error}
+     * @example
+     * export type Animal = 'cat' | 'dog' | 'bird';
+     *
+     * export const makeSound = (animal: Animal): string => {
+     *   switch (animal) {
+     *     case 'cat':
+     *       return 'Meow'
+     *     case 'dog':
+     *       return 'Woof'
+     *     case 'bird':
+     *       return 'Tweet'
+     *     default:
+     *       throw typeUtil.exhaustiveError('Unknown animal [animal]', animal)
+     *   }
+     * }
+     */
+    exhaustiveError: (message, _) => {
+        return new Error(message);
+    },
+};
+//# sourceMappingURL=type-util.js.map

package/lib/type-util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"type-util.js","sourceRoot":"","sources":["../src/type-util.ts"],"names":[],"mappings":";;;AAAa,QAAA,QAAQ,GAAG;IACtB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,iBAAiB,EAAE,CAAC,OAAe,EAAE,CAAQ,EAAU,EAAE;QACvD,OAAO,OAAO,CAAA;IAChB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,eAAe,EAAE,CAAC,OAAe,EAAE,CAAQ,EAAS,EAAE;QACpD,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,CAAA;IAC3B,CAAC;CACF,CAAA"}

package/lib/types/any-function/index.d.ts

@@ -0,0 +1,2 @@
+export type AnyFunction<T> = (...args: any[]) => T;
+//# sourceMappingURL=index.d.ts.map

package/lib/types/any-function/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/any-function/index.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,CAAA"}

package/lib/types/any-function/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/lib/types/any-function/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/any-function/index.ts"],"names":[],"mappings":""}

package/lib/types/any-function/no-params.d.ts

@@ -0,0 +1,2 @@
+export type AnyFunctionNoParams<T> = () => T;
+//# sourceMappingURL=no-params.d.ts.map

package/lib/types/any-function/no-params.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"no-params.d.ts","sourceRoot":"","sources":["../../../src/types/any-function/no-params.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,mBAAmB,CAAC,CAAC,IAAI,MAAM,CAAC,CAAA"}

package/lib/types/any-function/no-params.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=no-params.js.map

package/lib/types/any-function/no-params.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"no-params.js","sourceRoot":"","sources":["../../../src/types/any-function/no-params.ts"],"names":[],"mappings":""}

package/lib/types/any-function/promise-no-params.d.ts

@@ -0,0 +1,2 @@
+export type AnyFunctionPromiseNoParams<T> = () => Promise<T>;
+//# sourceMappingURL=promise-no-params.d.ts.map

package/lib/types/any-function/promise-no-params.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"promise-no-params.d.ts","sourceRoot":"","sources":["../../../src/types/any-function/promise-no-params.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,0BAA0B,CAAC,CAAC,IAAI,MAAM,OAAO,CAAC,CAAC,CAAC,CAAA"}

package/lib/types/any-function/promise-no-params.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=promise-no-params.js.map

package/lib/types/any-function/promise-no-params.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"promise-no-params.js","sourceRoot":"","sources":["../../../src/types/any-function/promise-no-params.ts"],"names":[],"mappings":""}

package/lib/types/any-function/promise.d.ts

@@ -0,0 +1,2 @@
+export type AnyFunctionPromise<T> = (...args: any[]) => Promise<T>;
+//# sourceMappingURL=promise.d.ts.map

package/lib/types/any-function/promise.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"promise.d.ts","sourceRoot":"","sources":["../../../src/types/any-function/promise.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,kBAAkB,CAAC,CAAC,IAAI,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,CAAC,CAAC,CAAA"}

package/lib/types/any-function/promise.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=promise.js.map

package/lib/types/any-function/promise.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"promise.js","sourceRoot":"","sources":["../../../src/types/any-function/promise.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,127 @@
+{
+  "_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.8.4",
+    "lodash.clonedeep": "4.5.0",
+    "rxjs": "7.8.0"
+  },
+  "description": "",
+  "devDependencies": {
+    "@commitlint/cli": "17.4.4",
+    "@commitlint/config-conventional": "17.4.4",
+    "@commitlint/prompt": "17.4.4",
+    "@semantic-release/changelog": "6.0.2",
+    "@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.4.4",
+    "@types/lodash.clonedeep": "4.5.7",
+    "@types/node": "18.15.3",
+    "@typescript-eslint/eslint-plugin": "5.55.0",
+    "@typescript-eslint/parser": "5.55.0",
+    "commitizen": "4.3.0",
+    "eslint": "8.36.0",
+    "eslint-config-prettier": "8.7.0",
+    "eslint-plugin-import": "2.27.5",
+    "eslint-plugin-no-loops": "0.3.0",
+    "eslint-plugin-no-only-tests": "3.1.0",
+    "eslint-plugin-prettier": "4.2.1",
+    "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.4",
+    "rimraf": "4.4.0",
+    "semantic-release": "20.1.1",
+    "source-map-support": "0.5.21",
+    "ts-jest": "29.0.5",
+    "ts-node": "10.9.1",
+    "tsc-alias": "1.8.3",
+    "tsc-watch": "6.0.0",
+    "typedoc": "0.23.27",
+    "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 . --ext .ts --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 eslint && npm run prettier",
+    "lint:fix": "npm run eslint:fix && npm run prettier:fix",
+    "pack": "npm pack --pack-destination=./packages",
+    "prettier": "prettier --check \"./src/**/*.{ts,json}\"",
+    "prettier:fix": "prettier --write \"./src/**/*.{ts,json}\"",
+    "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": "# jest --config=./test/jest.config.json",
+    "test:unit": "TZ=utc jest",
+    "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.0.1-alpha"
+}