@carecard/common-util 1.0.0

package/dist/cjs/appErrorHandlers.cjs

@@ -0,0 +1,179 @@
+"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,
+        },
+    });
+}

package/dist/cjs/appErrorHandlers.d.ts

@@ -0,0 +1,128 @@
+/**
+ * Application-level error handling utilities.
+ * Use throwXxxError functions in services/controllers.
+ * Use appErrorHandler + notFound404 in app.js.
+ */
+import type { Request, Response, NextFunction } from 'express';
+export interface AppErrorParams {
+    userMessage?: string | null;
+    details?: unknown;
+}
+export type ErrorInfo = {
+    message: string;
+    code: string;
+    status: number;
+};
+export declare class AppError extends Error {
+    readonly code: string;
+    readonly userMessage: string | null;
+    readonly details: unknown;
+    constructor(message: string, code: string, params?: AppErrorParams);
+}
+export declare const ERROR_TYPES: {
+    readonly VALIDATION_FAILURE: {
+        readonly message: "Validation_Failure";
+        readonly code: "VALIDATION_FAILURE";
+        readonly status: 401;
+    };
+    readonly WRONG_CREDENTIALS: {
+        readonly message: "Wrong_Credentials";
+        readonly code: "WRONG_CREDENTIALS";
+        readonly status: 401;
+    };
+    readonly USED_TOKEN: {
+        readonly message: "Used_Token";
+        readonly code: "USED_TOKEN";
+        readonly status: 401;
+    };
+    readonly BAD_VISITOR_TOKEN: {
+        readonly message: "Bad_Visitor_Token";
+        readonly code: "BAD_VISITOR_TOKEN";
+        readonly status: 401;
+    };
+    readonly LOGIN_REQUIRED: {
+        readonly message: "Login_Required";
+        readonly code: "LOGIN_REQUIRED";
+        readonly status: 401;
+    };
+    readonly NOT_AUTHORIZED: {
+        readonly message: "Not_Authorized";
+        readonly code: "NOT_AUTHORIZED";
+        readonly status: 401;
+    };
+    readonly BAD_INPUT: {
+        readonly message: "Bad_Input";
+        readonly code: "BAD_INPUT";
+        readonly status: 400;
+    };
+    readonly INPUT_NOT_UUID: {
+        readonly message: "Input_Not_Uuid";
+        readonly code: "INPUT_NOT_UUID";
+        readonly status: 400;
+    };
+    readonly RECORD_NOT_SAVED: {
+        readonly message: "Record_NotSaved";
+        readonly code: "RECORD_NOT_SAVED";
+        readonly status: 400;
+    };
+    readonly UPDATE_FAILED: {
+        readonly message: "Update_Failed";
+        readonly code: "UPDATE_FAILED";
+        readonly status: 400;
+    };
+    readonly TRANSACTION_FAILED: {
+        readonly message: "Transaction_Failed";
+        readonly code: "TRANSACTION_FAILED";
+        readonly status: 400;
+    };
+    readonly RECORD_EXIST: {
+        readonly message: "Record_Exist";
+        readonly code: "RECORD_EXIST";
+        readonly status: 409;
+    };
+    readonly RECORD_NOT_FOUND: {
+        readonly message: "Record_NotFound";
+        readonly code: "RECORD_NOT_FOUND";
+        readonly status: 404;
+    };
+    readonly FILE_FORMAT_NOT_SUPPORTED: {
+        readonly message: "File_Format_Not_Supported";
+        readonly code: "FILE_FORMAT_NOT_SUPPORTED";
+        readonly status: 415;
+    };
+    readonly FILE_TOO_LARGE: {
+        readonly message: "File too large";
+        readonly code: "FILE_TOO_LARGE";
+        readonly status: 413;
+    };
+    readonly INVALID_TIME_VALUE: {
+        readonly message: "Invalid time value";
+        readonly code: "INVALID_TIME_VALUE";
+        readonly status: 403;
+    };
+};
+export type ErrorTypeKey = keyof typeof ERROR_TYPES;
+export declare function throwAppError(type: ErrorTypeKey, params?: AppErrorParams): never;
+export declare const throwValidationFailureError: (p?: AppErrorParams) => never;
+export declare const throwWrongCredentialsError: (p?: AppErrorParams) => never;
+export declare const throwRecordExistError: (p?: AppErrorParams) => never;
+export declare const throwRecordNotFoundError: (p?: AppErrorParams) => never;
+export declare const throwRecordNotSavedError: (p?: AppErrorParams) => never;
+export declare const throwLoginRequiredError: (p?: AppErrorParams) => never;
+export declare const throwUpdateFailedError: (p?: AppErrorParams) => never;
+export declare const throwTransactionFailedError: (p?: AppErrorParams) => never;
+export declare const throwUsedTokenError: (p?: AppErrorParams) => never;
+export declare const throwBadVisitorTokenError: (p?: AppErrorParams) => never;
+export declare const throwFileFormatNotSupportedError: (p?: AppErrorParams) => never;
+export declare const throwNotAuthorizedError: (p?: AppErrorParams) => never;
+export declare const throwBadInputError: (p?: AppErrorParams) => never;
+export declare const throwInputNotUuidError: (p?: AppErrorParams) => never;
+export declare const throwFileTooLargeError: (p?: AppErrorParams) => never;
+export declare const throwInvalidTimeValueError: (p?: AppErrorParams) => never;
+export declare function notFound404(req: Request, res: Response, _next: NextFunction): void;
+export declare function appErrorHandler(err: {
+    message?: string;
+    code?: string | number | null;
+    userMessage?: string | null;
+    details?: unknown;
+}, _req: Request, res: Response, _next: NextFunction): void;

package/dist/cjs/index.cjs

@@ -0,0 +1,19 @@
+"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("./appErrorHandlers"), exports);
+__exportStar(require("./responseStatus"), exports);
+__exportStar(require("./utilityFunctions"), exports);

package/dist/cjs/index.d.ts

@@ -0,0 +1,3 @@
+export * from './appErrorHandlers';
+export * from './responseStatus';
+export * from './utilityFunctions';

package/dist/cjs/responseStatus.cjs

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setOk200 = setOk200;
+exports.setCreated201 = setCreated201;
+exports.setBadRequest400ClientError = setBadRequest400ClientError;
+/**
+ *  The ETag (or entity tag) HTTP response header is an identifier for a specific version of a resource.
+ *  It lets caches be more efficient and save bandwidth, as a web server does not need to resend a full
+ *  response if the content was not changed. Additionally, etags help to prevent simultaneous updates of
+ *  a resource from overwriting each other ("mid-air collisions").
+ *
+ * If the resource at a given URL changes, a new Etag value must be generated. A comparison of them can
+ * determine whether two representations of a resource are the same. Etags are therefore similar to fingerprints, a
+ * nd might also be used for tracking purposes by some servers. They might also be set to persist indefinitely
+ * by a tracking server.
+ *
+ *  For example, when editing a wiki, the current wiki content may be hashed and put into an Etag header
+ *  in the response:
+ *
+ * ETag: "33a64df551425fcc55e4d42a148795d9f25f89d4"
+ *
+ * When saving changes to a wiki page (posting data), the POST request will contain the If-Match header containing
+ * the ETag values to check freshness against.
+ *
+ * If-Match: "33a64df551425fcc55e4d42a148795d9f25f89d4"
+ *
+ * If the hashes don't match, it means that the document has been edited in-between and a 412 Precondition Failed
+ * error is thrown.
+ *
+ * @param res
+ * @param ETag
+ * @returns {*}
+ */
+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
+ *    created.  The primary resource created by the request is identified
+ *    by either a Location header field in the response or, if no Location
+ *    field is received, by the effective request URI.
+ *
+ *    The 201 response payload typically describes and links to the
+ *    resource(s) created.  See
+ *    https://datatracker.ietf.org/doc/html/rfc7231#section-7.2
+ *    for a discussion of the meaning and purpose of validator header
+ *    fields, such as ETag and Last-Modified, in a 201 response.
+ *
+ * @param res
+ * @returns {*}
+ */
+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
+ *    a client error (e.g., malformed request syntax, invalid request
+ *    message framing, or deceptive request routing).
+ *
+ * @param res
+ * @returns {*}
+ */
+function setBadRequest400ClientError(res) {
+    res.status(400);
+    return res;
+}

package/dist/cjs/responseStatus.d.ts

@@ -0,0 +1,65 @@
+/**
+ *  The ETag (or entity tag) HTTP response header is an identifier for a specific version of a resource.
+ *  It lets caches be more efficient and save bandwidth, as a web server does not need to resend a full
+ *  response if the content was not changed. Additionally, etags help to prevent simultaneous updates of
+ *  a resource from overwriting each other ("mid-air collisions").
+ *
+ * If the resource at a given URL changes, a new Etag value must be generated. A comparison of them can
+ * determine whether two representations of a resource are the same. Etags are therefore similar to fingerprints, a
+ * nd might also be used for tracking purposes by some servers. They might also be set to persist indefinitely
+ * by a tracking server.
+ *
+ *  For example, when editing a wiki, the current wiki content may be hashed and put into an Etag header
+ *  in the response:
+ *
+ * ETag: "33a64df551425fcc55e4d42a148795d9f25f89d4"
+ *
+ * When saving changes to a wiki page (posting data), the POST request will contain the If-Match header containing
+ * the ETag values to check freshness against.
+ *
+ * If-Match: "33a64df551425fcc55e4d42a148795d9f25f89d4"
+ *
+ * If the hashes don't match, it means that the document has been edited in-between and a 412 Precondition Failed
+ * error is thrown.
+ *
+ * @param res
+ * @param ETag
+ * @returns {*}
+ */
+export declare function setOk200(res: {
+    set: (arg0: {
+        ETag: any;
+    }) => void;
+    status: (arg0: number) => void;
+}, ETag: any): any;
+/**
+ *    The 201 (Created) status code indicates that the request has been
+ *    fulfilled and has resulted in one or more new resources being
+ *    created.  The primary resource created by the request is identified
+ *    by either a Location header field in the response or, if no Location
+ *    field is received, by the effective request URI.
+ *
+ *    The 201 response payload typically describes and links to the
+ *    resource(s) created.  See
+ *    https://datatracker.ietf.org/doc/html/rfc7231#section-7.2
+ *    for a discussion of the meaning and purpose of validator header
+ *    fields, such as ETag and Last-Modified, in a 201 response.
+ *
+ * @param res
+ * @returns {*}
+ */
+export declare function setCreated201(res: {
+    status: (arg0: number) => void;
+}): any;
+/**
+ *    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
+ *    a client error (e.g., malformed request syntax, invalid request
+ *    message framing, or deceptive request routing).
+ *
+ * @param res
+ * @returns {*}
+ */
+export declare function setBadRequest400ClientError(res: {
+    status: (arg0: number) => void;
+}): any;

package/dist/cjs/utilityFunctions.cjs

@@ -0,0 +1,30 @@
+"use strict";
+// src/utilityFunctions.ts
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractObjectWithProperties = extractObjectWithProperties;
+/**
+ * Create a new object containing only the properties listed in `arrayOfProperties`.
+ * Keeps the original behavior: only copies properties whose values are truthy.
+ *
+ * Example:
+ *   extractObjectWithProperties({ a: 1, b: 0, c: 'x' }, ['a', 'b', 'c'])
+ *   -> { a: 1, c: 'x' }  // 'b' is omitted because 0 is falsy
+ */
+function extractObjectWithProperties(obj, arrayOfProperties) {
+    // Initialize with the correct type to avoid "element implicitly has an 'any' type"
+    const returnObj = {};
+    // If obj is null/undefined, return an empty object
+    if (!obj) {
+        return returnObj;
+    }
+    // Iterate using `for...of` to avoid lib/target issues with Array.prototype.find for older configs
+    for (const nameOfProperty of arrayOfProperties) {
+        const value = obj[nameOfProperty];
+        // Preserve original "truthy" filter: only copy if value is truthy
+        if (value) {
+            // Assign with proper typing
+            returnObj[nameOfProperty] = value;
+        }
+    }
+    return returnObj;
+}

package/dist/cjs/utilityFunctions.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Create a new object containing only the properties listed in `arrayOfProperties`.
+ * Keeps the original behavior: only copies properties whose values are truthy.
+ *
+ * Example:
+ *   extractObjectWithProperties({ a: 1, b: 0, c: 'x' }, ['a', 'b', 'c'])
+ *   -> { a: 1, c: 'x' }  // 'b' is omitted because 0 is falsy
+ */
+export declare function extractObjectWithProperties<T extends Record<string, unknown>, K extends keyof T>(obj: T | null | undefined, arrayOfProperties: ReadonlyArray<K>): Partial<Pick<T, K>>;

package/dist/esm/appErrorHandlers.d.ts

@@ -0,0 +1,128 @@
+/**
+ * Application-level error handling utilities.
+ * Use throwXxxError functions in services/controllers.
+ * Use appErrorHandler + notFound404 in app.js.
+ */
+import type { Request, Response, NextFunction } from 'express';
+export interface AppErrorParams {
+    userMessage?: string | null;
+    details?: unknown;
+}
+export type ErrorInfo = {
+    message: string;
+    code: string;
+    status: number;
+};
+export declare class AppError extends Error {
+    readonly code: string;
+    readonly userMessage: string | null;
+    readonly details: unknown;
+    constructor(message: string, code: string, params?: AppErrorParams);
+}
+export declare const ERROR_TYPES: {
+    readonly VALIDATION_FAILURE: {
+        readonly message: "Validation_Failure";
+        readonly code: "VALIDATION_FAILURE";
+        readonly status: 401;
+    };
+    readonly WRONG_CREDENTIALS: {
+        readonly message: "Wrong_Credentials";
+        readonly code: "WRONG_CREDENTIALS";
+        readonly status: 401;
+    };
+    readonly USED_TOKEN: {
+        readonly message: "Used_Token";
+        readonly code: "USED_TOKEN";
+        readonly status: 401;
+    };
+    readonly BAD_VISITOR_TOKEN: {
+        readonly message: "Bad_Visitor_Token";
+        readonly code: "BAD_VISITOR_TOKEN";
+        readonly status: 401;
+    };
+    readonly LOGIN_REQUIRED: {
+        readonly message: "Login_Required";
+        readonly code: "LOGIN_REQUIRED";
+        readonly status: 401;
+    };
+    readonly NOT_AUTHORIZED: {
+        readonly message: "Not_Authorized";
+        readonly code: "NOT_AUTHORIZED";
+        readonly status: 401;
+    };
+    readonly BAD_INPUT: {
+        readonly message: "Bad_Input";
+        readonly code: "BAD_INPUT";
+        readonly status: 400;
+    };
+    readonly INPUT_NOT_UUID: {
+        readonly message: "Input_Not_Uuid";
+        readonly code: "INPUT_NOT_UUID";
+        readonly status: 400;
+    };
+    readonly RECORD_NOT_SAVED: {
+        readonly message: "Record_NotSaved";
+        readonly code: "RECORD_NOT_SAVED";
+        readonly status: 400;
+    };
+    readonly UPDATE_FAILED: {
+        readonly message: "Update_Failed";
+        readonly code: "UPDATE_FAILED";
+        readonly status: 400;
+    };
+    readonly TRANSACTION_FAILED: {
+        readonly message: "Transaction_Failed";
+        readonly code: "TRANSACTION_FAILED";
+        readonly status: 400;
+    };
+    readonly RECORD_EXIST: {
+        readonly message: "Record_Exist";
+        readonly code: "RECORD_EXIST";
+        readonly status: 409;
+    };
+    readonly RECORD_NOT_FOUND: {
+        readonly message: "Record_NotFound";
+        readonly code: "RECORD_NOT_FOUND";
+        readonly status: 404;
+    };
+    readonly FILE_FORMAT_NOT_SUPPORTED: {
+        readonly message: "File_Format_Not_Supported";
+        readonly code: "FILE_FORMAT_NOT_SUPPORTED";
+        readonly status: 415;
+    };
+    readonly FILE_TOO_LARGE: {
+        readonly message: "File too large";
+        readonly code: "FILE_TOO_LARGE";
+        readonly status: 413;
+    };
+    readonly INVALID_TIME_VALUE: {
+        readonly message: "Invalid time value";
+        readonly code: "INVALID_TIME_VALUE";
+        readonly status: 403;
+    };
+};
+export type ErrorTypeKey = keyof typeof ERROR_TYPES;
+export declare function throwAppError(type: ErrorTypeKey, params?: AppErrorParams): never;
+export declare const throwValidationFailureError: (p?: AppErrorParams) => never;
+export declare const throwWrongCredentialsError: (p?: AppErrorParams) => never;
+export declare const throwRecordExistError: (p?: AppErrorParams) => never;
+export declare const throwRecordNotFoundError: (p?: AppErrorParams) => never;
+export declare const throwRecordNotSavedError: (p?: AppErrorParams) => never;
+export declare const throwLoginRequiredError: (p?: AppErrorParams) => never;
+export declare const throwUpdateFailedError: (p?: AppErrorParams) => never;
+export declare const throwTransactionFailedError: (p?: AppErrorParams) => never;
+export declare const throwUsedTokenError: (p?: AppErrorParams) => never;
+export declare const throwBadVisitorTokenError: (p?: AppErrorParams) => never;
+export declare const throwFileFormatNotSupportedError: (p?: AppErrorParams) => never;
+export declare const throwNotAuthorizedError: (p?: AppErrorParams) => never;
+export declare const throwBadInputError: (p?: AppErrorParams) => never;
+export declare const throwInputNotUuidError: (p?: AppErrorParams) => never;
+export declare const throwFileTooLargeError: (p?: AppErrorParams) => never;
+export declare const throwInvalidTimeValueError: (p?: AppErrorParams) => never;
+export declare function notFound404(req: Request, res: Response, _next: NextFunction): void;
+export declare function appErrorHandler(err: {
+    message?: string;
+    code?: string | number | null;
+    userMessage?: string | null;
+    details?: unknown;
+}, _req: Request, res: Response, _next: NextFunction): void;

package/dist/esm/appErrorHandlers.js

@@ -0,0 +1,156 @@
+/* appErrors.ts */
+/* --------------------------------------------------
+ * Base Error Class
+ * -------------------------------------------------- */
+export 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;
+    }
+}
+/* --------------------------------------------------
+ * Error Registry (single source of truth)
+ * -------------------------------------------------- */
+export const 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
+ * -------------------------------------------------- */
+export function throwAppError(type, params = {}) {
+    const { message, code } = ERROR_TYPES[type];
+    throw new AppError(message, code, params);
+}
+/* --------------------------------------------------
+ * Backward-compatible helpers (optional)
+ * -------------------------------------------------- */
+export const throwValidationFailureError = (p = {}) => throwAppError('VALIDATION_FAILURE', p);
+export const throwWrongCredentialsError = (p = {}) => throwAppError('WRONG_CREDENTIALS', p);
+export const throwRecordExistError = (p = {}) => throwAppError('RECORD_EXIST', p);
+export const throwRecordNotFoundError = (p = {}) => throwAppError('RECORD_NOT_FOUND', p);
+export const throwRecordNotSavedError = (p = {}) => throwAppError('RECORD_NOT_SAVED', p);
+export const throwLoginRequiredError = (p = {}) => throwAppError('LOGIN_REQUIRED', p);
+export const throwUpdateFailedError = (p = {}) => throwAppError('UPDATE_FAILED', p);
+export const throwTransactionFailedError = (p = {}) => throwAppError('TRANSACTION_FAILED', p);
+export const throwUsedTokenError = (p = {}) => throwAppError('USED_TOKEN', p);
+export const throwBadVisitorTokenError = (p = {}) => throwAppError('BAD_VISITOR_TOKEN', p);
+export const throwFileFormatNotSupportedError = (p = {}) => throwAppError('FILE_FORMAT_NOT_SUPPORTED', p);
+export const throwNotAuthorizedError = (p = {}) => throwAppError('NOT_AUTHORIZED', p);
+export const throwBadInputError = (p = {}) => throwAppError('BAD_INPUT', p);
+export const throwInputNotUuidError = (p = {}) => throwAppError('INPUT_NOT_UUID', p);
+export const throwFileTooLargeError = (p = {}) => throwAppError('FILE_TOO_LARGE', p);
+export const throwInvalidTimeValueError = (p = {}) => throwAppError('INVALID_TIME_VALUE', p);
+/* --------------------------------------------------
+ * Express middleware
+ * -------------------------------------------------- */
+export function notFound404(req, res, _next) {
+    res.status(404).send({
+        error: {
+            code: 'NOT_FOUND',
+            message: 'Not found',
+            details: null,
+        },
+    });
+}
+export function appErrorHandler(err, _req, res, _next) {
+    // Iteration without `.find` or `Object.values` for maximum compatibility
+    let errorType = undefined;
+    const keys = Object.keys(ERROR_TYPES);
+    for (const key of keys) {
+        const candidate = 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,
+        },
+    });
+}

package/dist/esm/index.d.ts

@@ -0,0 +1,3 @@
+export * from './appErrorHandlers';
+export * from './responseStatus';
+export * from './utilityFunctions';

package/dist/esm/index.js

@@ -0,0 +1,3 @@
+export * from './appErrorHandlers';
+export * from './responseStatus';
+export * from './utilityFunctions';

package/dist/esm/responseStatus.d.ts

@@ -0,0 +1,65 @@
+/**
+ *  The ETag (or entity tag) HTTP response header is an identifier for a specific version of a resource.
+ *  It lets caches be more efficient and save bandwidth, as a web server does not need to resend a full
+ *  response if the content was not changed. Additionally, etags help to prevent simultaneous updates of
+ *  a resource from overwriting each other ("mid-air collisions").
+ *
+ * If the resource at a given URL changes, a new Etag value must be generated. A comparison of them can
+ * determine whether two representations of a resource are the same. Etags are therefore similar to fingerprints, a
+ * nd might also be used for tracking purposes by some servers. They might also be set to persist indefinitely
+ * by a tracking server.
+ *
+ *  For example, when editing a wiki, the current wiki content may be hashed and put into an Etag header
+ *  in the response:
+ *
+ * ETag: "33a64df551425fcc55e4d42a148795d9f25f89d4"
+ *
+ * When saving changes to a wiki page (posting data), the POST request will contain the If-Match header containing
+ * the ETag values to check freshness against.
+ *
+ * If-Match: "33a64df551425fcc55e4d42a148795d9f25f89d4"
+ *
+ * If the hashes don't match, it means that the document has been edited in-between and a 412 Precondition Failed
+ * error is thrown.
+ *
+ * @param res
+ * @param ETag
+ * @returns {*}
+ */
+export declare function setOk200(res: {
+    set: (arg0: {
+        ETag: any;
+    }) => void;
+    status: (arg0: number) => void;
+}, ETag: any): any;
+/**
+ *    The 201 (Created) status code indicates that the request has been
+ *    fulfilled and has resulted in one or more new resources being
+ *    created.  The primary resource created by the request is identified
+ *    by either a Location header field in the response or, if no Location
+ *    field is received, by the effective request URI.
+ *
+ *    The 201 response payload typically describes and links to the
+ *    resource(s) created.  See
+ *    https://datatracker.ietf.org/doc/html/rfc7231#section-7.2
+ *    for a discussion of the meaning and purpose of validator header
+ *    fields, such as ETag and Last-Modified, in a 201 response.
+ *
+ * @param res
+ * @returns {*}
+ */
+export declare function setCreated201(res: {
+    status: (arg0: number) => void;
+}): any;
+/**
+ *    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
+ *    a client error (e.g., malformed request syntax, invalid request
+ *    message framing, or deceptive request routing).
+ *
+ * @param res
+ * @returns {*}
+ */
+export declare function setBadRequest400ClientError(res: {
+    status: (arg0: number) => void;
+}): any;

package/dist/esm/responseStatus.js

@@ -0,0 +1,66 @@
+/**
+ *  The ETag (or entity tag) HTTP response header is an identifier for a specific version of a resource.
+ *  It lets caches be more efficient and save bandwidth, as a web server does not need to resend a full
+ *  response if the content was not changed. Additionally, etags help to prevent simultaneous updates of
+ *  a resource from overwriting each other ("mid-air collisions").
+ *
+ * If the resource at a given URL changes, a new Etag value must be generated. A comparison of them can
+ * determine whether two representations of a resource are the same. Etags are therefore similar to fingerprints, a
+ * nd might also be used for tracking purposes by some servers. They might also be set to persist indefinitely
+ * by a tracking server.
+ *
+ *  For example, when editing a wiki, the current wiki content may be hashed and put into an Etag header
+ *  in the response:
+ *
+ * ETag: "33a64df551425fcc55e4d42a148795d9f25f89d4"
+ *
+ * When saving changes to a wiki page (posting data), the POST request will contain the If-Match header containing
+ * the ETag values to check freshness against.
+ *
+ * If-Match: "33a64df551425fcc55e4d42a148795d9f25f89d4"
+ *
+ * If the hashes don't match, it means that the document has been edited in-between and a 412 Precondition Failed
+ * error is thrown.
+ *
+ * @param res
+ * @param ETag
+ * @returns {*}
+ */
+export 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
+ *    created.  The primary resource created by the request is identified
+ *    by either a Location header field in the response or, if no Location
+ *    field is received, by the effective request URI.
+ *
+ *    The 201 response payload typically describes and links to the
+ *    resource(s) created.  See
+ *    https://datatracker.ietf.org/doc/html/rfc7231#section-7.2
+ *    for a discussion of the meaning and purpose of validator header
+ *    fields, such as ETag and Last-Modified, in a 201 response.
+ *
+ * @param res
+ * @returns {*}
+ */
+export 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
+ *    a client error (e.g., malformed request syntax, invalid request
+ *    message framing, or deceptive request routing).
+ *
+ * @param res
+ * @returns {*}
+ */
+export function setBadRequest400ClientError(res) {
+    res.status(400);
+    return res;
+}

package/dist/esm/utilityFunctions.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Create a new object containing only the properties listed in `arrayOfProperties`.
+ * Keeps the original behavior: only copies properties whose values are truthy.
+ *
+ * Example:
+ *   extractObjectWithProperties({ a: 1, b: 0, c: 'x' }, ['a', 'b', 'c'])
+ *   -> { a: 1, c: 'x' }  // 'b' is omitted because 0 is falsy
+ */
+export declare function extractObjectWithProperties<T extends Record<string, unknown>, K extends keyof T>(obj: T | null | undefined, arrayOfProperties: ReadonlyArray<K>): Partial<Pick<T, K>>;

package/dist/esm/utilityFunctions.js

@@ -0,0 +1,27 @@
+// src/utilityFunctions.ts
+/**
+ * Create a new object containing only the properties listed in `arrayOfProperties`.
+ * Keeps the original behavior: only copies properties whose values are truthy.
+ *
+ * Example:
+ *   extractObjectWithProperties({ a: 1, b: 0, c: 'x' }, ['a', 'b', 'c'])
+ *   -> { a: 1, c: 'x' }  // 'b' is omitted because 0 is falsy
+ */
+export function extractObjectWithProperties(obj, arrayOfProperties) {
+    // Initialize with the correct type to avoid "element implicitly has an 'any' type"
+    const returnObj = {};
+    // If obj is null/undefined, return an empty object
+    if (!obj) {
+        return returnObj;
+    }
+    // Iterate using `for...of` to avoid lib/target issues with Array.prototype.find for older configs
+    for (const nameOfProperty of arrayOfProperties) {
+        const value = obj[nameOfProperty];
+        // Preserve original "truthy" filter: only copy if value is truthy
+        if (value) {
+            // Assign with proper typing
+            returnObj[nameOfProperty] = value;
+        }
+    }
+    return returnObj;
+}

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@carecard/common-util",
+  "version": "1.0.0",
+  "private": false,
+  "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"
+  ],
+  "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"
+  },
+  "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"
+  },
+  "dependencies": {
+    "express": "5.2.1"
+  }
+}

package/readme.md

@@ -0,0 +1,6 @@
+# pkg-validate
+
+This is a template for any package.
+It works with js or ts and commonjs and esm.
+
+These are some validation functions.