@vortenixinnovations/flagra-common-module 1.0.54 → 1.0.58

package/build/util/index.d.ts

@@ -1,4 +1 @@
-export * from "./logger/index.js";
-export * from "./error/index.js";
 export * from "./global/index.js";
-export * from "./validator.js";

package/build/util/index.js

@@ -1,4 +1 @@
-export * from "./logger/index.js";
-export * from "./error/index.js";
 export * from "./global/index.js";
-export * from "./validator.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vortenixinnovations/flagra-common-module",
-  "version": "1.0.54",
+  "version": "1.0.58",
   "description": "common module of flagra",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",
@@ -22,7 +22,7 @@
   "scripts": {
     "clean": "del-cli ./build/*",
     "build": "npm run clean && tsc",
-    "publish": "npm version patch && npm run build && npm publish"
+    "release": "npm version patch && npm run build && npm publish"
   },
   "dependencies": {
     "@sinclair/typebox": "^0.34.41",
@@ -33,7 +33,8 @@
     "dotenv": "^17.2.3",
     "express": "^5.1.0",
     "pino": "^10.0.0",
-    "pino-http": "^11.0.0"
+    "pino-http": "^11.0.0",
+    "pino-pretty": "^13.0.0"
   },
   "devDependencies": {
     "@types/express": "^5.0.3",

package/build/util/error/errors.d.ts

@@ -1,19 +0,0 @@
-declare class BaseError extends Error {
-    readonly name: string;
-    readonly status: number;
-    readonly message: string;
-    constructor(name: string, status: number, description: string);
-}
-export declare class APIError extends BaseError {
-    constructor(description?: string);
-}
-export declare class ValidationError extends BaseError {
-    constructor(description?: string);
-}
-export declare class AuthorizeError extends BaseError {
-    constructor(description?: string);
-}
-export declare class NotFoundError extends BaseError {
-    constructor(description?: string);
-}
-export {};

package/build/util/error/errors.js

@@ -1,38 +0,0 @@
-import { STATUS_CODES } from "./status-codes.js";
-class BaseError extends Error {
-    name;
-    status;
-    message;
-    constructor(name, status, description) {
-        super(description);
-        this.name = name;
-        this.status = status;
-        this.message = description;
-        Object.setPrototypeOf(this, new.target.prototype);
-        Error.captureStackTrace(this);
-    }
-}
-// 500 Internal Error
-export class APIError extends BaseError {
-    constructor(description = "api error") {
-        super("api internal server error", STATUS_CODES.INTERNAL_ERROR, description);
-    }
-}
-// 400 Validation Error
-export class ValidationError extends BaseError {
-    constructor(description = "bad request") {
-        super("bad request", STATUS_CODES.BAD_REQUEST, description);
-    }
-}
-// 403 Authorize error
-export class AuthorizeError extends BaseError {
-    constructor(description = "access denied") {
-        super("access denied", STATUS_CODES.UN_AUTHORISED, description);
-    }
-}
-// 404 Not Found
-export class NotFoundError extends BaseError {
-    constructor(description = "not found") {
-        super(description, STATUS_CODES.NOT_FOUND, description);
-    }
-}

package/build/util/error/handler.d.ts

@@ -1,3 +0,0 @@
-import type { Request, Response, NextFunction } from "express";
-export declare const HandleErrorWithLogger: (error: any, req: Request, res: Response, next: NextFunction) => void;
-export declare const HandleUnCaughtException: (error: Error) => Promise<never>;

package/build/util/error/handler.js

@@ -1,33 +0,0 @@
-import { AuthorizeError, NotFoundError, ValidationError } from "./errors.js";
-import { logger } from "../logger/index.js";
-export const HandleErrorWithLogger = (error, req, res, next) => {
-    let reportError = true;
-    let status = 500;
-    let data = error.message;
-    // convert express-jwt UnauthorizedError to your AuthorizeError
-    if (error.name === "UnauthorizedError") {
-        error = new AuthorizeError(error.message);
-    }
-    // skip known errors
-    [NotFoundError, ValidationError, AuthorizeError].forEach((typeOfError) => {
-        if (error instanceof typeOfError) {
-            reportError = false;
-            status = error.status || 400;
-            data = error.message;
-        }
-    });
-    if (reportError) {
-        logger.error(error);
-    }
-    else {
-        // future use third party error reporting tools
-        logger.warn(error);
-    }
-    res.status(status).json({ error: data });
-};
-export const HandleUnCaughtException = async (error) => {
-    // error report / monitoring tools
-    logger.error(error);
-    // recover
-    process.exit(1);
-};

package/build/util/error/index.d.ts

@@ -1,3 +0,0 @@
-export * from "./errors.js";
-export * from "./status-codes.js";
-export * from "./handler.js";

package/build/util/error/index.js

@@ -1,3 +0,0 @@
-export * from "./errors.js";
-export * from "./status-codes.js";
-export * from "./handler.js";

package/build/util/error/status-codes.d.ts

@@ -1,7 +0,0 @@
-export declare const STATUS_CODES: {
-    OK: number;
-    BAD_REQUEST: number;
-    UN_AUTHORISED: number;
-    NOT_FOUND: number;
-    INTERNAL_ERROR: number;
-};

package/build/util/error/status-codes.js

@@ -1,7 +0,0 @@
-export const STATUS_CODES = {
-    OK: 200,
-    BAD_REQUEST: 400,
-    UN_AUTHORISED: 403,
-    NOT_FOUND: 404,
-    INTERNAL_ERROR: 500,
-};

package/build/util/error/validator.d.ts

@@ -1 +0,0 @@
-export declare const ValidateError: (input: any) => Promise<Record<string, any> | false>;

package/build/util/error/validator.js

@@ -1,14 +0,0 @@
-import { validate } from "class-validator";
-export const ValidateError = async (input) => {
-    const error = await validate(input, {
-        ValidationError: { target: true, property: true },
-    });
-    if (error.length) {
-        return error.map((err) => ({
-            field: err.property,
-            message: (err.constraints && Object.values(err.constraints)[0]) ||
-                "please provide input for this field",
-        }));
-    }
-    return false;
-};

package/build/util/logger/index.d.ts

@@ -1,3 +0,0 @@
-import pino from "pino";
-export declare const logger: pino.Logger<never, boolean>;
-export declare const httpLogger: import("pino-http").HttpLogger<import("http").IncomingMessage, import("http").ServerResponse<import("http").IncomingMessage>, never>;

package/build/util/logger/index.js

@@ -1,39 +0,0 @@
-import pino from "pino";
-import { pinoHttp } from "pino-http";
-import fs from "fs";
-import path from "path";
-import { fileURLToPath } from 'url';
-import dotenv from "dotenv";
-dotenv.config();
-const isProd = process.env.APP_ENV == "production";
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-// Ensure logs directory exists
-const logDir = path.resolve(__dirname, "../logs");
-if (isProd && !fs.existsSync(logDir)) {
-    fs.mkdirSync(logDir, { recursive: true });
-}
-const destination = isProd
-    ? pino.destination({ dest: path.join(logDir, "app.log"), sync: false }) // non-blocking file write
-    : undefined;
-export const logger = pino({
-    level: "info",
-    timestamp: () => `,"time":"${new Date().toISOString()}"`,
-    ...(isProd
-        ? {} // No transport for production — raw JSON
-        : {
-            transport: {
-                target: "pino-pretty",
-                options: {
-                    colorize: true,
-                    translateTime: "SYS:standard",
-                    ignore: "pid,hostname",
-                },
-            },
-        }),
-}, destination // Only used in production
-);
-// HTTP request logger for Express
-export const httpLogger = pinoHttp({
-    logger,
-});

package/build/util/validator.d.ts

@@ -1,9 +0,0 @@
-import type { Static, TSchema } from "@sinclair/typebox";
-export declare function sanitizeStrings<T>(input: T): T;
-export declare function ValidateRequest<T extends TSchema>(data: unknown, schema: T): {
-    valid: true;
-    data: Static<T>;
-} | {
-    valid: false;
-    error: string;
-};

package/build/util/validator.js

@@ -1,43 +0,0 @@
-import Ajv from "ajv";
-import ajvErrors from "ajv-errors";
-import addFormats from "ajv-formats";
-const ajv = new Ajv({ allErrors: true, strict: false, coerceTypes: true });
-ajvErrors(ajv);
-addFormats(ajv);
-export function sanitizeStrings(input) {
-    if (input === null || input === undefined) {
-        return input;
-    }
-    if (typeof input === "string") {
-        return input.trim();
-    }
-    // Handle arrays recursively
-    if (Array.isArray(input)) {
-        return input.map((item) => sanitizeStrings(item));
-    }
-    // Handle objects recursively
-    if (typeof input === "object") {
-        const result = {};
-        for (const key in input) {
-            if (Object.prototype.hasOwnProperty.call(input, key)) {
-                result[key] = sanitizeStrings(input[key]);
-            }
-        }
-        return result;
-    }
-    // Return non-string primitive values as-is
-    return input;
-}
-// Generic validator function using TypeBox schemas
-export function ValidateRequest(data, schema) {
-    const sanitizedData = sanitizeStrings(data);
-    const validate = ajv.compile(schema);
-    const isValid = validate(sanitizedData);
-    if (isValid)
-        return { valid: true, data: sanitizedData };
-    const errorMessages = validate.errors?.map((e) => e.message).filter(Boolean);
-    return {
-        valid: false,
-        error: errorMessages?.[0] || "Validation failed",
-    };
-}