@eqxjs/nest-common 0.1.0 → 0.2.0

package/CHANGELOG

@@ -1,17 +1,70 @@
-# Changelog
-
-All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
-
-## 0.1.0 (2025-07-01)
-
-
-### 🚀 Features
-
-* add CHANGELOG file ([42de96e](https://github.com/corp-ais/cronus-eqxjs-common-library-common/commit/42de96ee400ae523ac39199ac4be796fbc591df9))
-* add result, enums, and constants implementation ([015447c](https://github.com/corp-ais/cronus-eqxjs-common-library-common/commit/015447cb4f764f5df9ea32163afcacd8e12c8b04))
-* **setup:** initialize project ([0fbfaed](https://github.com/corp-ais/cronus-eqxjs-common-library-common/commit/0fbfaed58c91170da63973f9e1c27b3c1b0eba0d))
-
-
-### 🧼 Code Refactoring
-
-* cleanup code and its documentation ([00d6dee](https://github.com/corp-ais/cronus-eqxjs-common-library-common/commit/00d6dee5a4d8103e67247fbf1889ecd0b3941099))
+# Changelog
+
+All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+
+## [0.2.0](https://github.com/corp-ais/cronus-eqxjs-common-library-common/compare/v0.1.1...v0.2.0) (2025-11-21)
+
+
+### 🔁 CI/CD
+
+* cleanup github workflow script ([b37baf6](https://github.com/corp-ais/cronus-eqxjs-common-library-common/commit/b37baf65165f9cc423812e0deeb8e8e4bbdb80cb))
+* update github workflow test-n-coverage.yml ([535025d](https://github.com/corp-ais/cronus-eqxjs-common-library-common/commit/535025dc12d127b652e7566cb7aff8c3847aea73))
+* update secret key for sonar ([01b027a](https://github.com/corp-ais/cronus-eqxjs-common-library-common/commit/01b027a19abb52732b3c4027ee82927cf5dd777e))
+
+
+### 🧹 Miscellaneous Chores
+
+* **deps:** update dependencies ([a88c4ff](https://github.com/corp-ais/cronus-eqxjs-common-library-common/commit/a88c4ff7e7f5f19e1542ba202c85a7975ab493cd))
+* **deps:** update dependencies (2025-09-02) ([5f361bd](https://github.com/corp-ais/cronus-eqxjs-common-library-common/commit/5f361bd3a10124caad12c50ed055710900fd81ae))
+
+
+### 🧼 Code Refactoring
+
+* adjust Jest config to use tsconfig.spec.json ([cca6160](https://github.com/corp-ais/cronus-eqxjs-common-library-common/commit/cca616000cdf6ccc816070fb221b01809bd8bf4b))
+* **config:** resync vscode extension list from library-template ([ce23d82](https://github.com/corp-ais/cronus-eqxjs-common-library-common/commit/ce23d82facc02f39e1fbb8e064f5d056c6100252))
+* update ESLint configuration to use defineConfig and reorganize rules ([7748fc1](https://github.com/corp-ais/cronus-eqxjs-common-library-common/commit/7748fc1518a7b9e6e0eca240a707afde685d7b89))
+
+
+### 🚀 Features
+
+* add type definitions for TUndefined, TNull, and TNullUndefined ([3e77250](https://github.com/corp-ais/cronus-eqxjs-common-library-common/commit/3e7725053f9bc184eff7b48ec32c3ad4d6f37d85))
+
+
+### 🐞 Bug Fixes
+
+* update Node version requirement to >=24 in README ([e3949e3](https://github.com/corp-ais/cronus-eqxjs-common-library-common/commit/e3949e3c56138f96c2bbd45bd2dc28b9f62caf82))
+
+## [0.1.1](https://github.com/corp-ais/cronus-eqxjs-common-library-common/compare/v0.1.0...v0.1.1) (2025-09-01)
+
+
+### 🔁 CI/CD
+
+* add github workflow for test and coverage ([a47e4a8](https://github.com/corp-ais/cronus-eqxjs-common-library-common/commit/a47e4a8ba807b19a743db00936d5c5cd56a8d8fe))
+* rename workflow name ([3d52984](https://github.com/corp-ais/cronus-eqxjs-common-library-common/commit/3d52984046613feae6ffbfcf14f8285dfead4dc1))
+
+
+### 🧹 Miscellaneous Chores
+
+* **config:** update package.json to ignore index.ts file in testing with coverage ([e53b7ce](https://github.com/corp-ais/cronus-eqxjs-common-library-common/commit/e53b7ce5bd946ad439c468ab9ca61a76db635c85))
+* remove lock file out of git ignore file ([b8b33a4](https://github.com/corp-ais/cronus-eqxjs-common-library-common/commit/b8b33a4135bcefb88ce98ae1d2eb0a9bef56b02e))
+
+
+### 🧼 Code Refactoring
+
+* apply best practice path referencing for library ([ba1ee67](https://github.com/corp-ais/cronus-eqxjs-common-library-common/commit/ba1ee67a369f8b90210b4198fb5d7f9b937f0102))
+* reset all files ending to LF ([0bec5c5](https://github.com/corp-ais/cronus-eqxjs-common-library-common/commit/0bec5c5696933a5ccf05d035e2119e0372cf838e))
+* sync from library template (2025-08-21) ([e136490](https://github.com/corp-ais/cronus-eqxjs-common-library-common/commit/e136490635d00c5d3d03e98a97791c77a51f42ce))
+
+## 0.1.0 (2025-07-01)
+
+
+### 🚀 Features
+
+* add CHANGELOG file ([42de96e](https://github.com/corp-ais/cronus-eqxjs-common-library-common/commit/42de96ee400ae523ac39199ac4be796fbc591df9))
+* add result, enums, and constants implementation ([015447c](https://github.com/corp-ais/cronus-eqxjs-common-library-common/commit/015447cb4f764f5df9ea32163afcacd8e12c8b04))
+* **setup:** initialize project ([0fbfaed](https://github.com/corp-ais/cronus-eqxjs-common-library-common/commit/0fbfaed58c91170da63973f9e1c27b3c1b0eba0d))
+
+
+### 🧼 Code Refactoring
+
+* cleanup code and its documentation ([00d6dee](https://github.com/corp-ais/cronus-eqxjs-common-library-common/commit/00d6dee5a4d8103e67247fbf1889ecd0b3941099))

package/README.md

@@ -1,21 +1,27 @@
-# cronus-eqxjs-common-library-nest-common
-
-A common library use in `@eqxjs` ecosystem.
-
-Node: `>=22`
-
-## Installation
-
-```bash
-yarn add @eqxjs/nest-common
-```
-
-## Contributing
-
-Please see [contributing.md](CONTRIBUTING.md)
-
-## License
-
-Please see [LICENSE](LICENSE)
-
-## Remark
+# cronus-eqxjs-common-library-nest-common
+
+A common library use in `@eqxjs` ecosystem.
+
+Status: ``
+
+Node: `>=24`
+
+## Installation
+
+```bash
+yarn add @eqxjs/nest-common
+```
+
+## Development
+
+Please see [docs/README.md](docs/README.md)
+
+## Contributing
+
+Please see [contributing.md](CONTRIBUTING.md)
+
+## License
+
+Please see [LICENSE](LICENSE)
+
+## Remark

package/commitlint.config.mjs

@@ -0,0 +1,46 @@
+/** @type {import('@commitlint/types').UserConfig} */
+const Configuration = {
+  extends: ['@commitlint/config-conventional'],
+  parserPreset: 'conventional-changelog-atom',
+  formatter: '@commitlint/format',
+  rules: {
+    'type-enum': [
+      2,
+      'always',
+      [
+        'feat', // New feature
+        'fix', // Bug fix
+        'docs', // Documentation changes
+        'style', // Changes that do not affect the meaning of the code (white-space, formatting, etc.)
+        'refactor', // Code changes that neither fix a bug nor add a feature
+        'perf', // Performance improvement
+        'test', // Adding missing tests or correcting existing tests
+        'build', // Changes that affect the build system or external dependencies (example scopes: npm)
+        'ci', // Changes to CI configuration files and scripts
+        'chore', // Other changes that don't modify src or test files
+        'revert', // Reverts a previous commit
+      ],
+    ],
+    'scope-enum': [
+      2,
+      'always',
+      [
+        'setup', // Project setup
+        'config', // Configuration files
+        'deps', // Dependency updates
+        'feature', // Feature-specific changes
+        'bug', // Bug fixes
+        'docs', // Documentation
+        'style', // Code style/formatting
+        'refactor', // Code refactoring
+        'test', // Tests
+        'build', // Build scripts or configuration
+        'ci', // Continuous integration
+        'release', // Release related changes
+        'other', // Other changes
+      ],
+    ],
+  },
+};
+
+export default Configuration;

package/dist/index.d.ts

@@ -1,3 +1,5 @@
+import 'reflect-metadata';
 export * from './enums';
 export * from './result';
 export * from './constants';
+export * from './types';

package/dist/index.js

@@ -14,7 +14,9 @@ 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 });
+require("reflect-metadata");
 __exportStar(require("./enums"), exports);
 __exportStar(require("./result"), exports);
 __exportStar(require("./constants"), exports);
+__exportStar(require("./types"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAwB;AACxB,2CAAyB;AACzB,8CAA4B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4BAA0B;AAE1B,0CAAwB;AACxB,2CAAyB;AACzB,8CAA4B;AAC5B,0CAAwB"}

package/dist/types.d.ts

@@ -0,0 +1,3 @@
+export type TUndefined<T> = T | undefined;
+export type TNull<T> = T | null;
+export type TNullUndefined<T> = T | null | undefined;

package/dist/types.js

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

package/dist/types.js.map

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

package/jest.config.mjs

@@ -0,0 +1,24 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+export default {
+  preset: 'ts-jest/presets/default-esm',
+  extensionsToTreatAsEsm: ['.ts'],
+  moduleNameMapper: {
+    '^(\\.{1,2}/.*)\\.js$': '$1',
+  },
+  rootDir: '.',
+  testRegex: '.*\\.spec\\.ts$',
+  transform: {
+    '^.+\\.ts$': [
+      'ts-jest',
+      {
+        useESM: true,
+        tsconfig: 'tsconfig.spec.json',
+      },
+    ],
+  },
+  collectCoverageFrom: ['src/**/*.ts', '!src/**/index.ts'],
+  coverageDirectory: './coverage',
+  testEnvironment: 'node',
+  testPathIgnorePatterns: ['/node_modules/', '/dist/'],
+  setupFilesAfterEnv: ['<rootDir>/test/jest-setup.ts'],
+};

package/package.json

@@ -1,102 +1,84 @@
-{
-  "name": "@eqxjs/nest-common",
-  "version": "0.1.0",
-  "description": "Common library for eqxjs provides shared constants, enums, and utilities.",
-  "author": "ESBM Cronus",
-  "license": "ISC",
-  "private": false,
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "scripts": {
-    "prebuild": "yarn run clean",
-    "format": "prettier --check \"src/**/*.ts\" \"test/**/*.ts\"",
-    "format:fix": "prettier --write --list-different \"src/**/*.ts\" \"test/**/*.ts\"",
-    "prepare": "husky && yarn run prepare:commit-msg && yarn run prepare:pre-commit && yarn run prepare:prepare-commit-msg",
-    "prepare:commit-msg": "echo 'npx --no -- commitlint --edit $1' > .husky/commit-msg",
-    "prepare:pre-commit": "rm -f .husky/pre-commit && yarn run prepare:pre-commit:format-fix && yarn run prepare:pre-commit:lint && yarn run prepare:pre-commit:lint-staged",
-    "prepare:pre-commit:format-fix": "echo 'yarn run format:fix' >> .husky/pre-commit",
-    "prepare:pre-commit:lint": "echo 'yarn run lint' >> .husky/pre-commit",
-    "prepare:pre-commit:lint-staged": "echo 'yarn run lint-staged --concurrent false' >> .husky/pre-commit",
-    "prepare:prepare-commit-msg": "echo '#!/bin/sh\n\nscripts/prepare-commit-msg.sh \"$1\" \"$2\"' > .husky/prepare-commit-msg && chmod +x .husky/prepare-commit-msg",
-    "build": "tsc -b tsconfig.build.json -v",
-    "clean": "tsc -b tsconfig.build.json --clean",
-    "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
-    "lint-staged": "lint-staged",
-    "test": "jest",
-    "test:watch": "jest --watch",
-    "test:cov": "jest --coverage",
-    "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
-    "release": "standard-version --infile CHANGELOG",
-    "release:changelog": "standard-version --infile CHANGELOG --skip.tag --skip.commit",
-    "release:init": "standard-version --first-release --infile CHANGELOG",
-    "release:init:changelog": "standard-version --first-release --infile CHANGELOG --skip.tag --skip.commit"
-  },
-  "engines": {
-    "node": ">=20"
-  },
-  "dependencies": {
-    "reflect-metadata": "^0.2.2"
-  },
-  "devDependencies": {
-    "@commitlint/cli": "^19.8.1",
-    "@commitlint/config-conventional": "^19.8.1",
-    "@commitlint/types": "^19.5.0",
-    "@eslint/eslintrc": "^3.2.0",
-    "@eslint/js": "^9.18.0",
-    "@types/jest": "^30.0.0",
-    "@types/node": "^22",
-    "@types/supertest": "^6.0.2",
-    "commitizen": "^4.3.1",
-    "conventional-changelog-atom": "^5.0.0",
-    "conventional-changelog-cli": "^5.0.0",
-    "cz-conventional-changelog": "^3.3.0",
-    "eslint": "^9.18.0",
-    "eslint-config-prettier": "^10.0.1",
-    "eslint-plugin-jest": "~29.0.1",
-    "eslint-plugin-prettier": "^5.2.2",
-    "globals": "^16.0.0",
-    "husky": "^9.1.7",
-    "jest": "^29.7.0",
-    "jest-mock-extended": "^3",
-    "lint-staged": "~16.1.2",
-    "prettier": "^3.4.2",
-    "source-map-support": "^0.5.21",
-    "standard-version": "^9.5.0",
-    "supertest": "^7.0.0",
-    "ts-jest": "^29.2.5",
-    "ts-loader": "^9.5.2",
-    "ts-node": "^10.9.2",
-    "tsconfig-paths": "^4.2.0",
-    "typescript": "^5.7.3",
-    "typescript-eslint": "^8.20.0"
-  },
-  "jest": {
-    "moduleFileExtensions": [
-      "js",
-      "json",
-      "ts"
-    ],
-    "moduleNameMapper": {
-      "@/(.*)": "<rootDir>/src/$1"
-    },
-    "rootDir": ".",
-    "testRegex": ".*\\.spec\\.ts$",
-    "transform": {
-      "^.+\\.(t|j)s$": [
-        "ts-jest",
-        {
-          "tsconfig": "tsconfig.json"
-        }
-      ]
-    },
-    "collectCoverageFrom": [
-      "src/**/*.(t|j)s"
-    ],
-    "coverageDirectory": "../coverage",
-    "testEnvironment": "node",
-    "testPathIgnorePatterns": [
-      "/node_modules/",
-      "/dist/"
-    ]
-  }
-}
+{
+  "name": "@eqxjs/nest-common",
+  "version": "0.2.0",
+  "description": "Common library for eqxjs provides shared constants, enums, and utilities.",
+  "author": "ESBM Cronus",
+  "license": "ISC",
+  "private": false,
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "prebuild": "yarn clean && rm -rf dist",
+    "format": "prettier --check \"src/**/*.ts\" \"test/**/*.ts\"",
+    "format:fix": "prettier --write --list-different \"src/**/*.ts\" \"test/**/*.ts\"",
+    "install:dev": "yarn install && husky && yarn run install:dev:commit-msg && yarn run install:dev:pre-commit && yarn run install:dev:prepare-commit-msg",
+    "install:dev:commit-msg": "echo 'npx --no -- commitlint --edit $1' > .husky/commit-msg",
+    "install:dev:pre-commit": "rm -f .husky/pre-commit && yarn run install:dev:pre-commit:format-fix && yarn run install:dev:pre-commit:lint && yarn run install:dev:pre-commit:lint-staged",
+    "install:dev:pre-commit:format-fix": "echo 'yarn run format:fix' >> .husky/pre-commit",
+    "install:dev:pre-commit:lint": "echo 'yarn run lint' >> .husky/pre-commit",
+    "install:dev:pre-commit:lint-staged": "echo 'yarn run lint-staged --concurrent false' >> .husky/pre-commit",
+    "install:dev:prepare-commit-msg": "echo '#!/bin/sh\n\nscripts/prepare-commit-msg.sh \"$1\" \"$2\"' > .husky/prepare-commit-msg && chmod +x .husky/prepare-commit-msg",
+    "build": "tsc -b tsconfig.build.json -v",
+    "clean": "tsc -b tsconfig.build.json --clean",
+    "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
+    "lint-staged": "lint-staged",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:cov": "jest --coverage",
+    "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
+    "release": "standard-version --infile CHANGELOG",
+    "release:changelog": "standard-version --infile CHANGELOG --skip.tag --skip.commit",
+    "release:init": "standard-version --first-release --infile CHANGELOG",
+    "release:init:changelog": "standard-version --first-release --infile CHANGELOG --skip.tag --skip.commit",
+    "prepublishOnly": "yarn run build && yarn run test:cov"
+  },
+  "engines": {
+    "node": ">=24"
+  },
+  "dependencies": {},
+  "devDependencies": {
+    "@commitlint/cli": "^20.1.0",
+    "@commitlint/config-conventional": "^20.0.0",
+    "@commitlint/types": "^20.0.0",
+    "@eslint/eslintrc": "^3.3.1",
+    "@eslint/js": "^9.39.1",
+    "@types/jest": "^29.5.14",
+    "@types/node": "^24.10.1",
+    "@types/supertest": "^6.0.3",
+    "commitizen": "^4.3.1",
+    "conventional-changelog-atom": "^5.0.0",
+    "conventional-changelog-cli": "^5.0.0",
+    "cz-conventional-changelog": "^3.3.0",
+    "eslint": "^9.39.1",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-jest": "^29.2.0",
+    "eslint-plugin-prettier": "^5.5.4",
+    "globals": "^16.5.0",
+    "husky": "^9.1.7",
+    "jest": "^29.7.0",
+    "jest-mock-extended": "^3.0.7",
+    "lint-staged": "^16.2.7",
+    "prettier": "^3.6.2",
+    "reflect-metadata": "^0.2.2",
+    "source-map-support": "^0.5.21",
+    "standard-version": "^9.5.0",
+    "supertest": "^7.1.4",
+    "ts-jest": "^29.4.5",
+    "ts-loader": "^9.5.4",
+    "ts-node": "^10.9.2",
+    "tsconfig-paths": "^4.2.0",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.47.0",
+    "webpack": "^5.103.0"
+  },
+  "overrides": {
+    "@conventional-changelog/git-client": "^2.0.0",
+    "js-yaml": "^3.14.2",
+    "tmp": "^0.2.4"
+  },
+  "resolutions": {
+    "@conventional-changelog/git-client": "^2.0.0",
+    "js-yaml": "^3.14.2",
+    "tmp": "^0.2.4"
+  }
+}

package/tsconfig.spec.json

@@ -0,0 +1,6 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "isolatedModules": true
+  }
+}