@eqxjs/nest-common 0.1.0

package/CHANGELOG

@@ -0,0 +1,17 @@
+# 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))

package/README.md

@@ -0,0 +1,21 @@
+# 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

package/dist/constants.d.ts

@@ -0,0 +1 @@
+export declare const HEADER_X_SESSION_ID = "X-Session-Id";

package/dist/constants.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HEADER_X_SESSION_ID = void 0;
+exports.HEADER_X_SESSION_ID = 'X-Session-Id';
+//# sourceMappingURL=constants.js.map

package/dist/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,mBAAmB,GAAG,cAAc,CAAC"}

package/dist/enums.d.ts

@@ -0,0 +1,12 @@
+/**
+ * An enum representing different environment keys.
+ * These keys are used to identify the environment in which the application is running.
+ */
+export declare enum EnvironmentKey {
+    DEV = "dev",
+    PROD = "prod",
+    PRD = "prd",
+    SIT = "sit",
+    UAT = "uat",
+    STG = "stg"
+}

package/dist/enums.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EnvironmentKey = void 0;
+/**
+ * An enum representing different environment keys.
+ * These keys are used to identify the environment in which the application is running.
+ */
+var EnvironmentKey;
+(function (EnvironmentKey) {
+    EnvironmentKey["DEV"] = "dev";
+    EnvironmentKey["PROD"] = "prod";
+    EnvironmentKey["PRD"] = "prd";
+    EnvironmentKey["SIT"] = "sit";
+    EnvironmentKey["UAT"] = "uat";
+    EnvironmentKey["STG"] = "stg";
+})(EnvironmentKey || (exports.EnvironmentKey = EnvironmentKey = {}));
+//# sourceMappingURL=enums.js.map

package/dist/enums.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"enums.js","sourceRoot":"","sources":["../src/enums.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,IAAY,cAOX;AAPD,WAAY,cAAc;IACxB,6BAAW,CAAA;IACX,+BAAa,CAAA;IACb,6BAAW,CAAA;IACX,6BAAW,CAAA;IACX,6BAAW,CAAA;IACX,6BAAW,CAAA;AACb,CAAC,EAPW,cAAc,8BAAd,cAAc,QAOzB"}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from './enums';
+export * from './result';
+export * from './constants';

package/dist/index.js

@@ -0,0 +1,20 @@
+"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("./enums"), exports);
+__exportStar(require("./result"), exports);
+__exportStar(require("./constants"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

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

package/dist/result.d.ts

@@ -0,0 +1,106 @@
+/**
+ * An enum defines various error types that can occur in operations.
+ * It is used to categorize errors based on their nature and context.
+ * This enum is used in the ReturnResult type to provide detailed error information.
+ */
+export declare enum ResultErrorType {
+    Failure = "failure",
+    Unexpected = "unexpected",
+    Validation = "validation",
+    Conflict = "conflict",
+    NotFound = "not_found",
+    Unauthorized = "unauthorized",
+    Forbidden = "forbidden"
+}
+/**
+ * An interface defines the structure of a return result.
+ * It is a base interface that indicates whether the operation was successful or resulted in an error.
+ */
+interface IReturnResult {
+    /**
+     * Indicates whether the operation resulted in an error.
+     * If true, the operation failed and an error object will be present.
+     * If false, the operation was successful and data will be present.
+     */
+    isError: boolean;
+}
+/**
+ * An interface defines the structure of an error return result.
+ * It includes the type of error, a description, and optional details about the error.
+ * This interface is used to provide detailed information about errors that occur during operations.
+ *
+ * @template T - Optional type for additional error details, defaulting to an empty object.
+ */
+export interface IResultError<T = Record<string, unknown>> {
+    /**
+     * type indicates the type of error that occurred.
+     * It is a value from the {@link ResultErrorType} enum, providing context about the nature of the error.
+     */
+    type: ResultErrorType;
+    /**
+     * Description provides a human-readable explanation of the error.
+     * It is a string that describes what went wrong during the operation.
+     */
+    description: string;
+    /**
+     * Details provides additional information about the error.
+     * It is an optional field that can include any relevant data that helps to understand the error better.
+     * This can be useful for debugging or logging purposes.
+     *
+     * @template T - The type of additional error details, defaulting to an Record<string, unknown> object.
+     */
+    details?: T;
+}
+/**
+ * A type defines the structure of a successful return result.
+ * It extends IReturnResult and includes the data returned from the operation.
+ * It indicates that the operation was successful and contains the result data.
+ *
+ * @template T - The type of data returned from the operation.
+ */
+export type SuccessReturnResult<T> = IReturnResult & {
+    /**
+     * Indicates that the operation was successful and no error occurred.
+     * This field is always false for a SuccessReturnResult.
+     */
+    isError: false;
+    /**
+     * The data returned from the operation.
+     * This field contains the result of the successful operation.
+     *
+     * @template T - The type of data returned, which can be any type.
+     */
+    data: T;
+};
+/**
+ * A type defines the structure of an error return result.
+ * It extends IReturnResult and includes an error object that conforms to IErrorReturnResult.
+ * It indicates that the operation resulted in an error and provides details about the error.
+ *
+ * @template TErrorDetails - The type of additional error details, defaulting to an empty object.
+ * @template TError - The type of error returned, extending IResultError.
+ */
+export type ErrorReturnResult<TErrorDetails = Record<string, unknown>, TError extends IResultError<TErrorDetails> = IResultError<TErrorDetails>> = IReturnResult & {
+    /**
+     * Indicates that the operation resulted in an error.
+     * This field is always true for an ErrorReturnResult.
+     */
+    isError: true;
+    /**
+     * The error object that contains details about the error that occurred.
+     * This field provides information about the type of error, a description, and optional details.
+     *
+     * @template TError - The type of error returned, which extends IResultError.
+     */
+    error: TError;
+};
+/**
+ * An union type defines the structure of a return result that can either be a success or an error.
+ * It is a union type that can be either a SuccessReturnResult or an ErrorReturnResult
+ * and is used to represent the outcome of operations in a consistent manner.
+ *
+ * @template T - The type of data returned from the operation, defaulting to unknown.
+ * @template TError - The type of error returned, defaulting to an object with unknown properties.
+ */
+export type ReturnResult<T = unknown, TError = Record<string, unknown>> = SuccessReturnResult<T> | ErrorReturnResult<TError>;
+export {};

package/dist/result.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResultErrorType = void 0;
+/**
+ * An enum defines various error types that can occur in operations.
+ * It is used to categorize errors based on their nature and context.
+ * This enum is used in the ReturnResult type to provide detailed error information.
+ */
+var ResultErrorType;
+(function (ResultErrorType) {
+    ResultErrorType["Failure"] = "failure";
+    ResultErrorType["Unexpected"] = "unexpected";
+    ResultErrorType["Validation"] = "validation";
+    ResultErrorType["Conflict"] = "conflict";
+    ResultErrorType["NotFound"] = "not_found";
+    ResultErrorType["Unauthorized"] = "unauthorized";
+    ResultErrorType["Forbidden"] = "forbidden";
+})(ResultErrorType || (exports.ResultErrorType = ResultErrorType = {}));
+//# sourceMappingURL=result.js.map

package/dist/result.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"result.js","sourceRoot":"","sources":["../src/result.ts"],"names":[],"mappings":";;;AAAA;;;;GAIG;AACH,IAAY,eAQX;AARD,WAAY,eAAe;IACzB,sCAAmB,CAAA;IACnB,4CAAyB,CAAA;IACzB,4CAAyB,CAAA;IACzB,wCAAqB,CAAA;IACrB,yCAAsB,CAAA;IACtB,gDAA6B,CAAA;IAC7B,0CAAuB,CAAA;AACzB,CAAC,EARW,eAAe,+BAAf,eAAe,QAQ1B"}

package/package.json

@@ -0,0 +1,102 @@
+{
+  "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/"
+    ]
+  }
+}