@articketing2021/common 1.0.1 → 1.0.4

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

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

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

@@ -0,0 +1,21 @@
+"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, statusCode = 400) {
+        super(message);
+        this.message = message;
+        this.statusCode = statusCode;
+        this.statusCode = statusCode;
+        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;
+        fields?: string;
+    }[];
+}

package/build/errors/custom-error.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomError = void 0;
+class CustomError extends Error {
+    constructor(message) {
+        super(message);
+        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 {
+    reason: string;
+    statusCode: number;
+    constructor();
+    serializeErrors(): {
+        message: string;
+    }[];
+}

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

@@ -0,0 +1,20 @@
+"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 db');
+        this.reason = "Error connecting the database";
+        this.statusCode = 500;
+        Object.setPrototypeOf(this, DatabaseConnectionError.prototype);
+    }
+    serializeErrors() {
+        return [
+            {
+                message: this.reason
+            }
+        ];
+    }
+}
+exports.DatabaseConnectionError = DatabaseConnectionError;

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

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

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

@@ -0,0 +1,16 @@
+"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(message = "Not authorized") {
+        super(message);
+        this.message = message;
+        this.statusCode = 401;
+        Object.setPrototypeOf(this, NotAuthorizedError.prototype);
+    }
+    serializeErrors() {
+        return [{ message: this.message }];
+    }
+}
+exports.NotAuthorizedError = NotAuthorizedError;

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

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

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

@@ -0,0 +1,19 @@
+"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("In-valid route");
+        this.statusCode = 404;
+        Object.setPrototypeOf(this, NotFoundError.prototype);
+    }
+    serializeErrors() {
+        return [
+            {
+                message: "In-valid route, this route does not exist",
+            },
+        ];
+    }
+}
+exports.NotFoundError = NotFoundError;

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

@@ -0,0 +1,14 @@
+import { type 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,27 @@
+"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 because we are extending the 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,
+                };
+            else
+                return {
+                    message: error.msg,
+                };
+        });
+    }
+}
+exports.RequestValidationError = RequestValidationError;

package/build/index.d.ts

@@ -1,7 +1,11 @@
-interface Color {
-    red: number;
-    blue: number;
-    green: number;
-}
-declare const color: Color;
-export default color;
+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 "./middleware/Authentication";
+export * from "./middleware/current-user";
+export * from "./middleware/error-handler";
+export * from "./middleware/require-auth";
+export * from "./middleware/validate-request";

package/build/index.js

@@ -1,8 +1,29 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const color = {
-    blue: 5,
-    green: 15,
-    red: 15,
+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);
 };
-exports.default = color;
+Object.defineProperty(exports, "__esModule", { value: true });
+//Middleware
+__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);
+//Errors
+__exportStar(require("./middleware/Authentication"), exports);
+__exportStar(require("./middleware/current-user"), exports);
+__exportStar(require("./middleware/error-handler"), exports);
+__exportStar(require("./middleware/require-auth"), exports);
+__exportStar(require("./middleware/validate-request"), exports);

package/build/middleware/Authentication.d.ts

@@ -0,0 +1,18 @@
+import { NextFunction, Request, Response } from "express";
+interface UserPayload {
+    id: string;
+    email: string;
+}
+declare global {
+    namespace Express {
+        interface Request {
+            currentUser?: UserPayload;
+        }
+    }
+}
+export declare class Authentication {
+    private static handle;
+    static blank(req: Request, res: Response, next: NextFunction): Promise<void>;
+    static auth(req: Request, res: Response, next: NextFunction): Promise<void>;
+}
+export {};

package/build/middleware/Authentication.js

@@ -0,0 +1,58 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Authentication = void 0;
+const express_validator_1 = require("express-validator");
+const types_1 = require("../types");
+const request_validation_error_1 = require("../errors/request-validation-error");
+const jsonwebtoken_1 = __importDefault(require("jsonwebtoken"));
+const bad_request_error_1 = require("../errors/bad-request-error");
+//This is my middleware
+class Authentication {
+    static handle(req, res, next, loginType) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            const errors = (0, express_validator_1.validationResult)(req);
+            if (!errors.isEmpty()) {
+                return next(new request_validation_error_1.RequestValidationError(errors.array()));
+                // return next(new Error("Invalid input fields"))
+                //   throw new RequestValidationError(errors.array());
+            }
+            if (loginType === types_1.UserLogin.LOGGED_IN) {
+                if (!((_a = req.session) === null || _a === void 0 ? void 0 : _a.jwt)) {
+                    return next(new bad_request_error_1.BadRequestError("Token is required", 401));
+                }
+                try {
+                    const payload = jsonwebtoken_1.default.verify(req.session.jwt, process.env.JWT_KEY);
+                    req.currentUser = payload;
+                }
+                catch (error) {
+                    return next(new bad_request_error_1.BadRequestError("In-valid token", 401));
+                }
+            }
+            next();
+        });
+    }
+    static blank(req, res, next) {
+        return __awaiter(this, void 0, void 0, function* () {
+            Authentication.handle(req, res, next, types_1.UserLogin.OPEN_TO_ALL);
+        });
+    }
+    static auth(req, res, next) {
+        return __awaiter(this, void 0, void 0, function* () {
+            Authentication.handle(req, res, next, types_1.UserLogin.LOGGED_IN);
+        });
+    }
+}
+exports.Authentication = Authentication;

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

@@ -0,0 +1,14 @@
+import { type Request, type Response, type 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/middleware/current-user.js

@@ -0,0 +1,20 @@
+"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)) {
+        return next();
+    }
+    try {
+        const payload = jsonwebtoken_1.default.verify(req.session.jwt, process.env.JWT_KEY);
+        req.currentUser = payload;
+    }
+    catch (err) { }
+    next();
+};
+exports.currentUser = currentUser;

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

@@ -0,0 +1,2 @@
+import { type NextFunction, type Request, type Response } from "express";
+export declare const errorHandler: (err: Error, req: Request, res: Response, next: NextFunction) => Response<any, Record<string, any>> | undefined;

package/build/middleware/error-handler.js

@@ -0,0 +1,14 @@
+"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) => {
+    var _a;
+    if (err instanceof custom_error_1.CustomError) {
+        return res.status(err.statusCode).json(err.serializeErrors());
+    }
+    res.status(500).send({
+        message: (_a = err.message) !== null && _a !== void 0 ? _a : 'Something went wrong',
+    });
+};
+exports.errorHandler = errorHandler;

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

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

package/build/middleware/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) {
+        return next(new not_authorized_error_1.NotAuthorizedError());
+    }
+    next();
+};
+exports.requireAuth = requireAuth;

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

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

package/build/middleware/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()) {
+        return next(new request_validation_error_1.RequestValidationError(errors.array()));
+    }
+    next();
+};
+exports.validateRequest = validateRequest;

package/build/types/index.d.ts

@@ -0,0 +1 @@
+export * from "./users";

package/build/types/index.js

@@ -0,0 +1,17 @@
+"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("./users"), exports);

package/build/types/users/index.d.ts

@@ -0,0 +1,4 @@
+export declare enum UserLogin {
+    LOGGED_IN = "login-user",
+    OPEN_TO_ALL = "open-to-all"
+}

package/build/types/users/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserLogin = void 0;
+var UserLogin;
+(function (UserLogin) {
+    UserLogin["LOGGED_IN"] = "login-user";
+    UserLogin["OPEN_TO_ALL"] = "open-to-all";
+})(UserLogin || (exports.UserLogin = UserLogin = {}));

package/package.json

@@ -1,22 +1,41 @@
 {
   "name": "@articketing2021/common",
-  "version": "1.0.1",
-  "description": "",
+  "version": "1.0.4",
+  "description": "Common reusable utilities, middlewares, and types for Articketing microservices.",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",
   "files": [
     "build/**/*"
   ],
-  "keywords": [],
-  "author": "",
+  "keywords": [
+    "common",
+    "typescript",
+    "express",
+    "microservices",
+    "articketing"
+  ],
+  "author": "Ajay Rathod",
   "license": "ISC",
   "devDependencies": {
-    "del-cli": "^7.0.0",
-    "typescript": "^5.9.3"
+    "@types/cookie-session": "^2.0.49",
+    "@types/express": "^5.0.3",
+    "@types/jsonwebtoken": "^9.0.10",
+    "typescript": "^5.9.3",
+    "tsconfig-paths": "^4.2.0",
+    "ts-node-dev": "^2.0.0",
+    "tsc-alias": "^1.8.9",
+    "del-cli": "^7.0.0"
+  },
+  "dependencies": {
+    "cookie-session": "^2.1.1",
+    "express": "^5.1.0",
+    "express-validator": "^7.2.1",
+    "jsonwebtoken": "^9.0.2"
   },
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
     "clean": "del-cli ./build/*",
-    "build": "pnpm clean && tsc"
+    "build": "pnpm clean && tsc && tsc-alias",
+    "pub": "pnpm version patch && pnpm build && pnpm publish",
+    "dev": "ts-node-dev -r tsconfig-paths/register src/index.ts"
   }
 }