@carecard/common-util 1.0.1 → 2.0.2

package/index.js

@@ -0,0 +1,5 @@
+module.exports = {
+    util: require( './lib/untilityFunctions' ),
+    error: require( './lib/appErrorHandlers' ),
+    resCode: require( './lib/responseStatus' )
+}

package/lib/appErrorHandlers.js

@@ -0,0 +1,297 @@
+'use strict';
+/**
+ * These are application level error handlers. All error responses should be send using these functions.
+ * These should be use in app.js file, not in controller files.
+ */
+module.exports = {
+    throwAccountSuspendedError,
+    throwAccountBlockedError,
+    throwAccountInactiveError,
+    notFound404,
+    appErrorHandler,
+    throwValidationFailureError,
+    throwRecordExistError,
+    throwWrongCredentialsError,
+    throwLoginRequiredError,
+    throwRecordNotFoundError,
+    throwRecordNotSavedError,
+    throwUpdateFailedError,
+    throwTransactionFailedError,
+    throwUsedTokenError,
+    throwBadVisitorTokenError: throwVisitorTokenError,
+    throwFileFormatNotSupportedError,
+    throwNotAuthorizedError,
+    throwBadInputError,
+    throwInputNotUuidError,
+    throwFileTooLargeError,
+    throwInvalidTimeValueError
+}
+
+
+function notFound404(req, res, next) {
+    res.status(404);
+    const response = {
+        error:
+            {
+                code: 'NOT_FOUND',
+                message: 'Not found',
+                details: null
+            }
+    }
+
+    res.send(response)
+}
+
+function appErrorHandler(err, req, res, next) {
+    const response =
+        {
+            error:
+                {
+                    code: err.code ?? null,
+                    message: err.userMessage ?? null,
+                    details: err.details ?? null
+                }
+        };
+
+    switch (err?.message) {
+
+        case "Account_Suspended":
+        case "Account_Blocked":
+        case "Account_Inactive":
+            res.status(403);
+            res.send(response)
+            break;
+
+        case "Validation_Failure":
+            res.status(401);
+            res.send(response)
+            break;
+
+        case "Used_Token":
+        case "Wrong_Credentials":
+            res.status(401);
+            res.send(response)
+            break;
+
+        case "Bad_Visitor_Token":
+            res.status(401);
+            res.send(response)
+            break;
+
+        case "Record_NotSaved":
+            res.status(400);
+            res.send(response)
+            break;
+
+        case "Record_Exist":
+            res.status(409);
+            res.send(response)
+            break;
+
+        case "Record_NotFound":
+            res.status(404);
+            res.send(response)
+            break;
+
+        case "Update_Failed":
+            res.status(400);
+            res.send(response)
+            break;
+
+        case "Login_Required":
+            res.status(401);
+            res.send(response)
+            break;
+
+        case "Transaction_Failed":
+            res.status(400);
+            res.send(response)
+            break;
+
+        case "File_Format_Not_Supported":
+            res.status(415);
+            res.send(response)
+            break;
+
+        case "Not_Authorized":
+            res.status(401);
+            res.send(response)
+            break;
+
+        case "Bad_Input":
+            res.status(400);
+            res.send(response);
+            break;
+
+        case  "Input_Not_Uuid" :
+            res.status(400);
+            res.send(response)
+            break;
+
+        case "File too large":
+            res.status(413);
+            res.send(response)
+            break;
+
+        case "Invalid time value":
+            res.status(403);
+            res.send(response)
+            break;
+
+        default:
+            res.status(500);
+            res.send(response)
+    }
+}
+
+function throwAccountSuspendedError(params = {}) {
+    const error = new Error("Account_Suspended");
+    error.code = "ACCOUNT_SUSPENDED";
+    error.userMessage = params.userMessage ?? null;
+    error.details = params.details ?? null;
+    throw error;
+}
+
+function throwAccountBlockedError(params = {}) {
+    const error = new Error("Account_Blocked");
+    error.code = "ACCOUNT_BLOCKED";
+    error.userMessage = params.userMessage ?? null;
+    error.details = params.details ?? null;
+    throw error;
+}
+
+function throwAccountInactiveError(params = {}) {
+    const error = new Error("Account_Inactive");
+    error.code = "ACCOUNT_INACTIVE";
+    error.userMessage = params.userMessage ?? null;
+    error.details = params.details ?? null;
+    throw error;
+}
+
+function throwValidationFailureError(params = {}) {
+    const error = new Error("Validation_Failure");
+    error.code = "VALIDATION_FAILURE";
+    error.userMessage = params.userMessage ?? null;
+    error.details = params.details ?? null;
+    throw error;
+}
+
+function throwWrongCredentialsError(params = {}) {
+    const error = new Error("Wrong_Credentials");
+    error.code = "WRONG_CREDENTIALS";
+    error.userMessage = params.userMessage ?? null;
+    error.details = params.details ?? null;
+    throw error;
+}
+
+function throwRecordExistError(params = {}) {
+    const error = new Error("Record_Exist");
+    error.code = "RECORD_EXIST";
+    error.userMessage = params.userMessage ?? null;
+    error.details = params.details ?? null;
+    throw error;
+}
+
+function throwRecordNotFoundError(params = {}) {
+    const error = new Error("Record_NotFound");
+    error.code = "RECORD_NOT_FOUND";
+    error.userMessage = params.userMessage ?? null;
+    error.details = params.details ?? null;
+    throw error;
+}
+
+function throwRecordNotSavedError(params = {}) {
+    const error = new Error("Record_NotSaved");
+    error.code = "RECORD_NOT_SAVED";
+    error.userMessage = params.userMessage ?? null;
+    error.details = params.details ?? null;
+    throw error;
+}
+
+function throwLoginRequiredError(params = {}) {
+    const error = new Error("Login_Required");
+    error.code = "LOGIN_REQUIRED";
+    error.userMessage = params.userMessage ?? null;
+    error.details = params.details ?? null;
+    throw error;
+}
+
+function throwUpdateFailedError(params = {}) {
+    const error = new Error("Update_Failed");
+    error.code = "UPDATE_FAILED";
+    error.userMessage = params.userMessage ?? null;
+    error.details = params.details ?? null;
+    throw error;
+}
+
+function throwTransactionFailedError(params = {}) {
+    const error = new Error("Transaction_Failed");
+    error.code = "TRANSACTION_FAILED";
+    error.userMessage = params.userMessage ?? null;
+    error.details = params.details ?? null;
+    throw error;
+}
+
+function throwUsedTokenError(params = {}) {
+    const error = new Error("Used_Token");
+    error.code = "USED_TOKEN";
+    error.userMessage = params.userMessage ?? null;
+    error.details = params.details ?? null;
+    throw error;
+}
+
+function throwVisitorTokenError(params = {}) {
+    const error = new Error("Bad_Visitor_Token");
+    error.code = "BAD_VISITOR_TOKEN";
+    error.userMessage = params.userMessage ?? null;
+    error.details = params.details ?? null;
+    throw error;
+}
+
+function throwFileFormatNotSupportedError(params = {}) {
+    const error = new Error("File_Format_Not_Supported");
+    error.code = "FILE_FORMAT_NOT_SUPPORTED";
+    error.userMessage = params.userMessage ?? null;
+    error.details = params.details ?? null;
+    throw error;
+}
+
+function throwNotAuthorizedError(params = {}) {
+    const error = new Error("Not_Authorized");
+    error.code = "NOT_AUTHORIZED";
+    error.userMessage = params.userMessage ?? null;
+    error.details = params.details ?? null;
+    throw error;
+}
+
+function throwBadInputError(params = {}) {
+    const error = new Error("Bad_Input");
+    error.code = "BAD_INPUT";
+    error.userMessage = params.userMessage ?? null;
+    error.details = params.details ?? null;
+    throw error;
+}
+
+function throwInputNotUuidError(params = {}) {
+    const error = new Error("Input_Not_Uuid");
+    error.code = "INPUT_NOT_UUID";
+    error.userMessage = params.userMessage ?? null;
+    error.details = params.details ?? null;
+    throw error;
+}
+
+function throwFileTooLargeError(params = {}) {
+    const error = new Error("File too large");
+    error.code = "FILE_TOO_LARGE";
+    error.userMessage = params.userMessage ?? null;
+    error.details = params.details ?? null;
+    throw error;
+}
+
+function throwInvalidTimeValueError(params = {}) {
+    const error = new Error("Invalid time value");
+    error.code = "INVALID_TIME_VALUE";
+    error.userMessage = params.userMessage ?? null;
+    error.details = params.details ?? null;
+    throw error;
+}

package/{dist/esm → lib}/responseStatus.js

@@ -26,11 +26,14 @@
  * @param ETag
  * @returns {*}
  */
-export function setOk200(res, ETag) {
-    res.set({ ETag: ETag });
-    res.status(200);
+function setOk200( res, ETag ) {
+
+    res.set( { ETag: ETag } );
+    res.status( 200 );
+
     return res;
 }
+
 /**
  *    The 201 (Created) status code indicates that the request has been
  *    fulfilled and has resulted in one or more new resources being
@@ -47,10 +50,11 @@ export function setOk200(res, ETag) {
  * @param res
  * @returns {*}
  */
-export function setCreated201(res) {
-    res.status(201);
+function setCreated201( res ) {
+    res.status( 201 );
     return res;
 }
+
 /**
  *    The 400 (Bad Request) status code indicates that the server cannot or
  *    will not process the request due to something that is perceived to be
@@ -60,7 +64,14 @@ export function setCreated201(res) {
  * @param res
  * @returns {*}
  */
-export function setBadRequest400ClientError(res) {
-    res.status(400);
+function setBadRequest400ClientError( res ) {
+    res.status( 400 );
     return res;
 }
+
+module.exports = {
+    setOk200,
+    setCreated201,
+    setBadRequest400ClientError
+};
+

package/lib/untilityFunctions.js

@@ -0,0 +1,18 @@
+// Create new object only with properties given in array.
+function extractObjectWithProperties( obj, arrayOfProperties ) {
+    let returnObj = {};
+
+    arrayOfProperties.forEach( nameOfProperty => {
+        if ( obj?.[ nameOfProperty ] ) {
+            returnObj[ nameOfProperty ] = obj?.[ nameOfProperty ];
+        }
+    } );
+
+    return returnObj;
+}
+
+
+
+module.exports = {
+    extractObjectWithProperties
+};

package/package.json

@@ -1,55 +1,23 @@
 {
   "name": "@carecard/common-util",
-  "version": "1.0.1",
-  "private": false,
+  "version": "2.0.2",
+  "repository": "https://github.com/CareCard-ca/pkg-common-util",
   "description": "Common utility for MVC framework",
-  "license": "ISC",
-  "author": "PK Singh",
-  "repository": {
-    "type": "git",
-    "url": "git+https:github.com/CareCard-ca/pkg-common-util.git"
-  },
-  "type": "module",
-  "publishConfig": {
-    "access": "public"
-  },
-  "main": "./dist/cjs/index.cjs",
-  "module": "./dist/esm/index.js",
-  "types": "./dist/esm/index.d.ts",
-  "exports": {
-    ".": {
-      "import": "./dist/esm/index.js",
-      "require": "./dist/cjs/index.cjs",
-      "types": "./dist/esm/index.d.ts"
-    }
-  },
-  "files": [
-    "dist"
-  ],
+  "main": "index.js",
   "scripts": {
-    "build": "npm run build:esm && npm run build:cjs",
-    "build:esm": "tsc -p tsconfig.esm.json",
-    "build:cjs": "tsc -p tsconfig.cjs.json && node ./scripts/rename-cjs.js",
-    "test": "NODE_NO_WARNINGS=1 jest --coverage",
-    "format": "prettier --write .",
-    "format:check": "prettier --check .",
-    "lint": "eslint",
-    "prepare": "husky"
+    "test": "export NODE_ENV=test && mocha --watch --recursive"
   },
+  "keywords": [
+    "validate",
+    "data"
+  ],
+  "author": "CareCard team",
+  "license": "ISC",
   "devDependencies": {
-    "@types/express": "5.0.6",
-    "@types/jest": "30.0.0",
-    "@types/supertest": "^6.0.3",
-    "eslint": "9.39.2",
-    "husky": "9.1.7",
-    "jest": "30.2.0",
-    "prettier": "3.7.4",
-    "supertest": "7.1.4",
-    "ts-jest": "29.4.6",
-    "typescript": "5.9.3",
-    "typescript-eslint": "8.50.1"
+    "mocha": "11.7.5",
+    "supertest": "7.1.4"
   },
   "dependencies": {
-    "express": "5.2.1"
+    "express": "5.1.0"
   }
 }

package/readme.md

@@ -1,3 +1,7 @@
-# pkg-common-util
+#Common Utility
+### Functions
 
-These are common utility functions for express application.
+Extract specific attributes from an object
+```js
+extractObjectWithProperties( obj, arrayOfProperties )
+```

package/dist/cjs/appErrorHandlers.cjs

@@ -1,179 +0,0 @@
-"use strict";
-/* appErrors.ts */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.throwInvalidTimeValueError = exports.throwFileTooLargeError = exports.throwInputNotUuidError = exports.throwBadInputError = exports.throwNotAuthorizedError = exports.throwFileFormatNotSupportedError = exports.throwBadVisitorTokenError = exports.throwUsedTokenError = exports.throwTransactionFailedError = exports.throwUpdateFailedError = exports.throwLoginRequiredError = exports.throwRecordNotSavedError = exports.throwRecordNotFoundError = exports.throwRecordExistError = exports.throwWrongCredentialsError = exports.throwValidationFailureError = exports.ERROR_TYPES = exports.AppError = void 0;
-exports.throwAppError = throwAppError;
-exports.notFound404 = notFound404;
-exports.appErrorHandler = appErrorHandler;
-/* --------------------------------------------------
- * Base Error Class
- * -------------------------------------------------- */
-class AppError extends Error {
-    constructor(message, code, params = {}) {
-        super(message);
-        this.name = 'AppError';
-        this.code = code;
-        this.userMessage = params.userMessage ?? null;
-        this.details = params.details ?? null;
-    }
-}
-exports.AppError = AppError;
-/* --------------------------------------------------
- * Error Registry (single source of truth)
- * -------------------------------------------------- */
-exports.ERROR_TYPES = {
-    VALIDATION_FAILURE: {
-        message: 'Validation_Failure',
-        code: 'VALIDATION_FAILURE',
-        status: 401,
-    },
-    WRONG_CREDENTIALS: {
-        message: 'Wrong_Credentials',
-        code: 'WRONG_CREDENTIALS',
-        status: 401,
-    },
-    USED_TOKEN: {
-        message: 'Used_Token',
-        code: 'USED_TOKEN',
-        status: 401,
-    },
-    BAD_VISITOR_TOKEN: {
-        message: 'Bad_Visitor_Token',
-        code: 'BAD_VISITOR_TOKEN',
-        status: 401,
-    },
-    LOGIN_REQUIRED: {
-        message: 'Login_Required',
-        code: 'LOGIN_REQUIRED',
-        status: 401,
-    },
-    NOT_AUTHORIZED: {
-        message: 'Not_Authorized',
-        code: 'NOT_AUTHORIZED',
-        status: 401,
-    },
-    BAD_INPUT: {
-        message: 'Bad_Input',
-        code: 'BAD_INPUT',
-        status: 400,
-    },
-    INPUT_NOT_UUID: {
-        message: 'Input_Not_Uuid',
-        code: 'INPUT_NOT_UUID',
-        status: 400,
-    },
-    RECORD_NOT_SAVED: {
-        message: 'Record_NotSaved',
-        code: 'RECORD_NOT_SAVED',
-        status: 400,
-    },
-    UPDATE_FAILED: {
-        message: 'Update_Failed',
-        code: 'UPDATE_FAILED',
-        status: 400,
-    },
-    TRANSACTION_FAILED: {
-        message: 'Transaction_Failed',
-        code: 'TRANSACTION_FAILED',
-        status: 400,
-    },
-    RECORD_EXIST: {
-        message: 'Record_Exist',
-        code: 'RECORD_EXIST',
-        status: 409,
-    },
-    RECORD_NOT_FOUND: {
-        message: 'Record_NotFound',
-        code: 'RECORD_NOT_FOUND',
-        status: 404,
-    },
-    FILE_FORMAT_NOT_SUPPORTED: {
-        message: 'File_Format_Not_Supported',
-        code: 'FILE_FORMAT_NOT_SUPPORTED',
-        status: 415,
-    },
-    FILE_TOO_LARGE: {
-        message: 'File too large',
-        code: 'FILE_TOO_LARGE',
-        status: 413,
-    },
-    INVALID_TIME_VALUE: {
-        message: 'Invalid time value',
-        code: 'INVALID_TIME_VALUE',
-        status: 403,
-    },
-};
-/* --------------------------------------------------
- * Generic throw helper
- * -------------------------------------------------- */
-function throwAppError(type, params = {}) {
-    const { message, code } = exports.ERROR_TYPES[type];
-    throw new AppError(message, code, params);
-}
-/* --------------------------------------------------
- * Backward-compatible helpers (optional)
- * -------------------------------------------------- */
-const throwValidationFailureError = (p = {}) => throwAppError('VALIDATION_FAILURE', p);
-exports.throwValidationFailureError = throwValidationFailureError;
-const throwWrongCredentialsError = (p = {}) => throwAppError('WRONG_CREDENTIALS', p);
-exports.throwWrongCredentialsError = throwWrongCredentialsError;
-const throwRecordExistError = (p = {}) => throwAppError('RECORD_EXIST', p);
-exports.throwRecordExistError = throwRecordExistError;
-const throwRecordNotFoundError = (p = {}) => throwAppError('RECORD_NOT_FOUND', p);
-exports.throwRecordNotFoundError = throwRecordNotFoundError;
-const throwRecordNotSavedError = (p = {}) => throwAppError('RECORD_NOT_SAVED', p);
-exports.throwRecordNotSavedError = throwRecordNotSavedError;
-const throwLoginRequiredError = (p = {}) => throwAppError('LOGIN_REQUIRED', p);
-exports.throwLoginRequiredError = throwLoginRequiredError;
-const throwUpdateFailedError = (p = {}) => throwAppError('UPDATE_FAILED', p);
-exports.throwUpdateFailedError = throwUpdateFailedError;
-const throwTransactionFailedError = (p = {}) => throwAppError('TRANSACTION_FAILED', p);
-exports.throwTransactionFailedError = throwTransactionFailedError;
-const throwUsedTokenError = (p = {}) => throwAppError('USED_TOKEN', p);
-exports.throwUsedTokenError = throwUsedTokenError;
-const throwBadVisitorTokenError = (p = {}) => throwAppError('BAD_VISITOR_TOKEN', p);
-exports.throwBadVisitorTokenError = throwBadVisitorTokenError;
-const throwFileFormatNotSupportedError = (p = {}) => throwAppError('FILE_FORMAT_NOT_SUPPORTED', p);
-exports.throwFileFormatNotSupportedError = throwFileFormatNotSupportedError;
-const throwNotAuthorizedError = (p = {}) => throwAppError('NOT_AUTHORIZED', p);
-exports.throwNotAuthorizedError = throwNotAuthorizedError;
-const throwBadInputError = (p = {}) => throwAppError('BAD_INPUT', p);
-exports.throwBadInputError = throwBadInputError;
-const throwInputNotUuidError = (p = {}) => throwAppError('INPUT_NOT_UUID', p);
-exports.throwInputNotUuidError = throwInputNotUuidError;
-const throwFileTooLargeError = (p = {}) => throwAppError('FILE_TOO_LARGE', p);
-exports.throwFileTooLargeError = throwFileTooLargeError;
-const throwInvalidTimeValueError = (p = {}) => throwAppError('INVALID_TIME_VALUE', p);
-exports.throwInvalidTimeValueError = throwInvalidTimeValueError;
-/* --------------------------------------------------
- * Express middleware
- * -------------------------------------------------- */
-function notFound404(req, res, _next) {
-    res.status(404).send({
-        error: {
-            code: 'NOT_FOUND',
-            message: 'Not found',
-            details: null,
-        },
-    });
-}
-function appErrorHandler(err, _req, res, _next) {
-    // Iteration without `.find` or `Object.values` for maximum compatibility
-    let errorType = undefined;
-    const keys = Object.keys(exports.ERROR_TYPES);
-    for (const key of keys) {
-        const candidate = exports.ERROR_TYPES[key];
-        if (candidate.message === err?.message) {
-            errorType = candidate;
-            break;
-        }
-    }
-    const status = errorType?.status ?? 500;
-    res.status(status).send({
-        error: {
-            code: err?.code ?? errorType?.code ?? null,
-            message: err?.userMessage ?? errorType?.message ?? null,
-            details: err?.details ?? null,
-        },
-    });
-}