@car-parts/common 1.0.1

package/README.md

@@ -0,0 +1,50 @@
+# Common Module for Microservices
+
+A shared npm package containing reusable logic, classes, and middlewares used across multiple microservices in a Node.js-based microservices architecture.
+
+## 📦 What’s Included
+
+This module centralizes and exports the following utilities:
+
+### 🧠 Middlewares
+
+- **`validateRequest`** – Validates the request body using `express-validator`.
+- **`errorHandler`** – Custom Express error handler.
+- **`currentUser`** – Middleware to decode and attach the current user from JWT token.
+- **`requireAuth`** – Middleware to restrict access to authenticated users only.
+- **`NotFoundError` / `BadRequestError` / `NotAuthorizedError` / `RequestValidationError`** – Custom error classes.
+
+### 📣 Events & Base Classes
+
+- **`Publisher`** and **`Listener`** – Base classes built around NATS streaming server.
+- **`Subjects`** – Enum defining event subjects.
+- **Events** – Interfaces for event contracts (e.g., `TicketCreatedEvent`, `OrderCancelledEvent`).
+
+## 🚀 Getting Started
+
+### Install
+
+```bash
+# install module
+npm install @car-parts/common
+```
+
+---
+
+## Usage Example
+
+```ts
+import {
+  requireAuth,
+  validateRequest,
+  BadRequestError,
+} from '@abtickets-app/common';
+
+app.post('/api/resource', requireAuth, validateRequest, (req, res) => {
+  if (!req.body.title) {
+    throw new BadRequestError('Title is required');
+  }
+
+  res.status(201).send({ success: true });
+});
+```

package/build/errors/bad-request-error.d.ts

@@ -0,0 +1,9 @@
+import { CustomError } from './custom-error';
+export declare class BadRequestError extends CustomError {
+    message: string;
+    statusCode: number;
+    constructor(message: string);
+    serializeErrors(): {
+        message: string;
+    }[];
+}

package/build/errors/bad-request-error.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BadRequestError = void 0;
+const custom_error_1 = require("./custom-error");
+class BadRequestError extends custom_error_1.CustomError {
+    constructor(message) {
+        super(message);
+        this.message = message;
+        this.statusCode = 400;
+        Object.setPrototypeOf(this, BadRequestError.prototype);
+    }
+    serializeErrors() {
+        return [{ message: this.message }];
+    }
+}
+exports.BadRequestError = BadRequestError;

package/build/errors/custom-error.d.ts

@@ -0,0 +1,8 @@
+export declare abstract class CustomError extends Error {
+    abstract statusCode: number;
+    constructor(message: string);
+    abstract serializeErrors(): {
+        message: string;
+        field?: string;
+    }[];
+}

package/build/errors/custom-error.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomError = void 0;
+class CustomError extends Error {
+    constructor(message) {
+        super(message);
+        // only when extending a built-in class
+        Object.setPrototypeOf(this, CustomError.prototype);
+    }
+}
+exports.CustomError = CustomError;

package/build/errors/database-connection-error.d.ts

@@ -0,0 +1,9 @@
+import { CustomError } from './custom-error';
+export declare class DatabaseConnectionError extends CustomError {
+    statusCode: number;
+    reason: string;
+    constructor();
+    serializeErrors(): {
+        message: string;
+    }[];
+}

package/build/errors/database-connection-error.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DatabaseConnectionError = void 0;
+const custom_error_1 = require("./custom-error");
+class DatabaseConnectionError extends custom_error_1.CustomError {
+    constructor() {
+        super('Error connecting to database');
+        this.statusCode = 500;
+        this.reason = 'Error connecting to database';
+        // only when extending a built-in class
+        Object.setPrototypeOf(this, DatabaseConnectionError.prototype);
+    }
+    serializeErrors() {
+        return [{ message: this.reason }];
+    }
+}
+exports.DatabaseConnectionError = DatabaseConnectionError;

package/build/errors/not-authorized-error.d.ts

@@ -0,0 +1,8 @@
+import { CustomError } from './custom-error';
+export declare class NotAuthorizedError extends CustomError {
+    statusCode: number;
+    constructor();
+    serializeErrors(): {
+        message: string;
+    }[];
+}

package/build/errors/not-authorized-error.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotAuthorizedError = void 0;
+const custom_error_1 = require("./custom-error");
+class NotAuthorizedError extends custom_error_1.CustomError {
+    constructor() {
+        super('Not authorized');
+        this.statusCode = 401;
+        // Only because we are extending a built-in class
+        Object.setPrototypeOf(this, NotAuthorizedError.prototype);
+    }
+    serializeErrors() {
+        return [
+            {
+                message: 'Not authorized',
+            },
+        ];
+    }
+}
+exports.NotAuthorizedError = NotAuthorizedError;

package/build/errors/not-found-error.d.ts

@@ -0,0 +1,8 @@
+import { CustomError } from './custom-error';
+export declare class NotFoundError extends CustomError {
+    statusCode: number;
+    constructor();
+    serializeErrors(): {
+        message: string;
+    }[];
+}

package/build/errors/not-found-error.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotFoundError = void 0;
+const custom_error_1 = require("./custom-error");
+class NotFoundError extends custom_error_1.CustomError {
+    constructor() {
+        super('Route not found');
+        this.statusCode = 404;
+        // only when extending a built-in class
+        Object.setPrototypeOf(this, NotFoundError.prototype);
+    }
+    serializeErrors() {
+        return [{ message: 'Not Found' }];
+    }
+}
+exports.NotFoundError = NotFoundError;

package/build/errors/request-validation-error.d.ts

@@ -0,0 +1,14 @@
+import { ValidationError } from 'express-validator';
+import { CustomError } from './custom-error';
+export declare class RequestValidationError extends CustomError {
+    errors: ValidationError[];
+    statusCode: number;
+    constructor(errors: ValidationError[]);
+    serializeErrors(): ({
+        message: any;
+        field: string;
+    } | {
+        message: any;
+        field?: undefined;
+    })[];
+}

package/build/errors/request-validation-error.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RequestValidationError = void 0;
+const custom_error_1 = require("./custom-error");
+class RequestValidationError extends custom_error_1.CustomError {
+    constructor(errors) {
+        super('Invalid request parameters');
+        this.errors = errors;
+        this.statusCode = 400;
+        // only when extending a built-in class
+        Object.setPrototypeOf(this, RequestValidationError.prototype);
+    }
+    serializeErrors() {
+        return this.errors.map((error) => {
+            if (error.type === 'field') {
+                return { message: error.msg, field: error.path };
+            }
+            return { message: error.msg };
+        });
+    }
+}
+exports.RequestValidationError = RequestValidationError;

package/build/index.d.ts

@@ -0,0 +1,10 @@
+export * from './errors/bad-request-error';
+export * from './errors/custom-error';
+export * from './errors/database-connection-error';
+export * from './errors/not-authorized-error';
+export * from './errors/not-found-error';
+export * from './errors/request-validation-error';
+export * from './middlewares/current-user';
+export * from './middlewares/error-handler';
+export * from './middlewares/require-auth';
+export * from './middlewares/validate-request';

package/build/index.js

@@ -0,0 +1,26 @@
+"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("./errors/bad-request-error"), exports);
+__exportStar(require("./errors/custom-error"), exports);
+__exportStar(require("./errors/database-connection-error"), exports);
+__exportStar(require("./errors/not-authorized-error"), exports);
+__exportStar(require("./errors/not-found-error"), exports);
+__exportStar(require("./errors/request-validation-error"), exports);
+__exportStar(require("./middlewares/current-user"), exports);
+__exportStar(require("./middlewares/error-handler"), exports);
+__exportStar(require("./middlewares/require-auth"), exports);
+__exportStar(require("./middlewares/validate-request"), exports);

package/build/middlewares/current-user.d.ts

@@ -0,0 +1,14 @@
+import { Request, Response, NextFunction } from 'express';
+interface UserPayload {
+    id: string;
+    email: string;
+}
+declare global {
+    namespace Express {
+        interface Request {
+            currentUser?: UserPayload;
+        }
+    }
+}
+export declare const currentUser: (req: Request, res: Response, next: NextFunction) => void;
+export {};

package/build/middlewares/current-user.js

@@ -0,0 +1,21 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.currentUser = void 0;
+const jsonwebtoken_1 = __importDefault(require("jsonwebtoken"));
+const currentUser = (req, res, next) => {
+    var _a;
+    if (!((_a = req.session) === null || _a === void 0 ? void 0 : _a.jwt)) {
+        next();
+        return;
+    }
+    try {
+        const payload = jsonwebtoken_1.default.verify(req.session.jwt, process.env.JWT_KEY); // Type assertion for payload
+        req.currentUser = payload; // Assigning the payload to currentUser
+    }
+    catch (error) { }
+    next();
+};
+exports.currentUser = currentUser;

package/build/middlewares/error-handler.d.ts

@@ -0,0 +1,3 @@
+import { NextFunction, Request, Response } from 'express';
+declare const errorHandler: (err: Error, req: Request, res: Response, next: NextFunction) => void;
+export { errorHandler };

package/build/middlewares/error-handler.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.errorHandler = void 0;
+const custom_error_1 = require("../errors/custom-error");
+const errorHandler = (err, req, res, next) => {
+    if (err instanceof custom_error_1.CustomError) {
+        res.status(err.statusCode).json({
+            errors: err.serializeErrors(),
+        });
+        return;
+    }
+    console.error(err);
+    res.status(400).json({
+        errors: [{ message: err.message || 'Something went wrong' }],
+    });
+};
+exports.errorHandler = errorHandler;

package/build/middlewares/require-auth.d.ts

@@ -0,0 +1,2 @@
+import { Request, Response, NextFunction } from 'express';
+export declare const requireAuth: (req: Request, res: Response, next: NextFunction) => void;

package/build/middlewares/require-auth.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.requireAuth = void 0;
+const not_authorized_error_1 = require("../errors/not-authorized-error");
+const requireAuth = (req, res, next) => {
+    if (!req.currentUser) {
+        throw new not_authorized_error_1.NotAuthorizedError();
+    }
+    next();
+};
+exports.requireAuth = requireAuth;

package/build/middlewares/validate-request.d.ts

@@ -0,0 +1,2 @@
+import { Request, Response, NextFunction } from 'express';
+export declare const validateRequest: (req: Request, res: Response, next: NextFunction) => void;

package/build/middlewares/validate-request.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateRequest = void 0;
+const express_validator_1 = require("express-validator");
+const request_validation_error_1 = require("../errors/request-validation-error");
+const validateRequest = (req, res, next) => {
+    const errors = (0, express_validator_1.validationResult)(req);
+    if (!errors.isEmpty()) {
+        throw new request_validation_error_1.RequestValidationError(errors.array());
+    }
+    next();
+};
+exports.validateRequest = validateRequest;

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@car-parts/common",
+  "version": "1.0.1",
+  "main": "./build/index.js",
+  "types": "./build/index.d.ts",
+  "files": [
+    "build/**/*"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "clean": "del-cli ./build/*",
+    "pub": "tsc && git add . && git commit -m \"updates\" && npm version patch && npm publish"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "description": "",
+  "devDependencies": {
+    "del-cli": "^6.0.0",
+    "typescript": "^5.8.3"
+  },
+  "dependencies": {
+    "@types/cookie-session": "^2.0.49",
+    "@types/express": "^5.0.3",
+    "@types/jsonwebtoken": "^9.0.10",
+    "cookie-session": "^2.1.0",
+    "express": "^5.1.0",
+    "express-validator": "^7.2.1",
+    "jsonwebtoken": "^9.0.2",
+    "node-nats-streaming": "^0.3.2"
+  }
+}