@mjtickets981/common 1.0.2 → 1.0.3

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);
+    serializeErrors(): {
+        message: string;
+        field?: 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,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 {
+    statusCode: number;
+    reason: string;
+    constructor();
+    serializeErrors(): {
+        message: string;
+    }[];
+}

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

@@ -0,0 +1,37 @@
+"use strict";
+// export class DatabaseConnectionError extends Error {
+//   statusCode = 500;
+//   reason = "Error connecting to database";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DatabaseConnectionError = void 0;
+//   constructor() {
+//     super();
+//     // Only because we are extending a built in class
+//     Object.setPrototypeOf(this, DatabaseConnectionError.prototype);
+//   }
+//   serializeErrors() {
+//     return [
+//       {
+//         message: this.reason,
+//       },
+//     ];
+//   }
+// }
+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 because we are 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,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() {
+        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,9 @@
+import { CustomError } from "./custom-error";
+export declare class NotFoundError extends CustomError {
+    statusCode: number;
+    constructor();
+    serializeErrors(): {
+        message: string;
+        field?: 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("Route not found");
+        this.statusCode = 404;
+        Object.setPrototypeOf(this, NotFoundError.prototype);
+    }
+    serializeErrors() {
+        return [
+            {
+                message: "Route not found",
+            },
+        ];
+    }
+}
+exports.NotFoundError = NotFoundError;

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

@@ -0,0 +1,11 @@
+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;
+    }[];
+}

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

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RequestValidationError = void 0;
+const custom_error_1 = require("./custom-error");
+// ValidationError is a type that comes back whenever we do a validation attempt using express-validator
+// The type refers has contains properties like msg, param, field etc....
+// interface CustomError {
+//   statusCode: number;
+//   serializeErrors(): { message: string; field?: string }[]; // This is going to return an array of objects and each of these
+//   // objects should have a message which is of type string and a field which is optional. Our custom class will satisify the
+//   // above interface by writing the implements the CustomError interface as below.
+// }
+// export class RequestValidationError extends Error {
+//   // implements CustomError
+//   statusCode = 400;
+//   constructor(public errors: ValidationError[]) {
+//     super();
+//     // Only because we are extending a built in class
+//     Object.setPrototypeOf(this, RequestValidationError.prototype);
+//   }
+//   serializeErrors() {
+//     return this.errors
+//       .map((err) => {
+//         if (err.type === "field") {
+//           return { message: err.msg, field: err.path };
+//         }
+//       })
+//       .filter((error) => error !== undefined);
+//   }
+// }
+class RequestValidationError extends custom_error_1.CustomError {
+    constructor(errors) {
+        super("Invalid request parameters");
+        this.errors = errors;
+        // implements CustomError
+        this.statusCode = 400;
+        // Only because we are extending a built in class
+        Object.setPrototypeOf(this, RequestValidationError.prototype);
+    }
+    serializeErrors() {
+        return this.errors
+            .map((err) => {
+            if (err.type === "field") {
+                return { message: err.msg, field: err.path };
+            }
+        })
+            .filter((error) => error !== undefined);
+    }
+}
+exports.RequestValidationError = RequestValidationError;

package/build/index.d.ts

@@ -1,7 +1,10 @@
-interface Color {
-    red: number;
-    green: number;
-    blue: 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 "./middlewares/error-handler";
+export * from "./middlewares/current-user";
+export * from "./middlewares/require-auth";
+export * from "./middlewares/validate-request";

package/build/index.js

@@ -1,9 +1,26 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const color = {
-    red: 10,
-    green: 10,
-    blue: 10,
+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);
 };
-console.log(color);
-exports.default = color;
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./errors/bad-request-error"), exports); // This is going to import ev erything from the bad-request-error file
+__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/error-handler"), exports);
+__exportStar(require("./middlewares/current-user"), 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,31 @@
+"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)) {
+        // If the jwt property is not set then it means that the user is not logged in
+        return next();
+    }
+    try {
+        const payload = jsonwebtoken_1.default.verify(req.session.jwt, process.env.JWT_KEY); // Whenever we call the verify() here then we are going to get back
+        // a payload either a string (or) an object. This is goping to be the information that we stored inside the jwt when we created it.
+        // If the jwt is valid, we can attach the payload to the request object. If you recall about the JWT, inside the payload we have an
+        // ID property which is a string and email which is a string. So we are going to first create an interface for the payload and then
+        // we are going to use that interface to type the payload variable.
+        req.currentUser = payload; // Attach the current user to the request object.
+        // When we are trying to assign the currentUser property to the request object and TypeScript is unhappy about that because typescript
+        // has a type definition file for express that defines exactly what a request is, and this type definition file says that a request
+        // doesnot have a property of currentUser. So we need to somehow augment the definition of what a request is. So we are going to
+        // add a additional property to the type definition of what a request is.
+    }
+    catch (err) {
+        // If the jwt is invalid, we can just ignore it and continue
+    }
+    next(); // Whether the jwt is valid or not, we call next() to continue to the next middleware
+};
+exports.currentUser = currentUser;

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

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

package/build/middlewares/error-handler.js

@@ -0,0 +1,50 @@
+"use strict";
+// The only requirement we need when we write error handling middleware is , The function in this error handling middleware
+// it has to recieve 4 arguments and the order of these arguments are the error, req, res, next
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.errorHandler = void 0;
+const custom_error_1 = require("../errors/custom-error");
+// import { ErrorRequestHandler } from "express";
+// import { RequestValidationError } from "../errors/request-validation-error";
+// import { DatabaseConnectionError } from "../errors/database-connection-error";
+const errorHandler = (err, req, res, next) => {
+    //   console.log("Something went wrong", err);
+    //   if (err instanceof RequestValidationError) {
+    //     // const formattedErrors = err.errors.map((error) => {
+    //     //   return {
+    //     //     message: error.msg,
+    //     //     field: error.param,
+    //     //   };
+    //     // });
+    //     // const formattedErrors = err.errors.map((error) => {
+    //     //   if (error.type === "field") {
+    //     //     return { message: error.msg, field: error.path };
+    //     //   }
+    //     // });
+    //     return res.status(err.statusCode).send({ errors: err.serializeErrors() });
+    //   }
+    //   if (err instanceof DatabaseConnectionError) {
+    //     // console.log("handling this error as a DB connection error");
+    //     return res.status(err.statusCode).send({
+    //       errors:
+    //         //    [
+    //         //     {
+    //         //       message: err.reason,
+    //         //     },
+    //         //   ],
+    //         err.serializeErrors(),
+    //     });
+    //   }
+    if (err instanceof custom_error_1.CustomError) {
+        res.status(err.statusCode).send({ errors: err.serializeErrors() });
+        return;
+    }
+    res.status(400).send({
+        errors: [
+            {
+                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,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.requireAuth = void 0;
+const not_authorized_error_1 = require("../errors/not-authorized-error");
+const requireAuth = () => {
+    // We are going to really make a big assumption here where we are going to assume that we will never use the requiredAuth middleware
+    // in a situation where the user is not logged in. So we are going to assume that the currentUser property is always set on the request object.
+    // By the time this request shows up inside the requireAuth middleware, We should already checked to see if there is a JSON Web Token
+    // is present (or) not. We should have already attempted to decode it and set it on the req.currentUser property. Again if the
+    // req.currentUser property is not defined then it means that we have to reject this request and respond with an error.
+    return (req, res, next) => {
+        if (!req.currentUser) {
+            // If the currentUser property is not set then it means that the user is not logged in
+            //   return res.status(401).send({ error: "Not authorized" });
+            throw new not_authorized_error_1.NotAuthorizedError();
+        }
+        next(); // If the user is logged in, we call next() to continue to the next middleware
+    };
+};
+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,17 @@
+"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) => {
+    // Express distinguishes between a error handling middleware and a normal one on the no of arguments that the
+    // function accepts. Here we want to produce errors if the request is not valid.
+    const errors = (0, express_validator_1.validationResult)(req);
+    if (!errors.isEmpty()) {
+        // If there are any errors then we want to throw a RequestValidationError
+        throw new request_validation_error_1.RequestValidationError(errors.array());
+    }
+    next(); // If there are no errors then we want to call the next middleware in the chain.
+    // This is how we can validate the request body using express-validator and throw a custom error if the validation fails.
+};
+exports.validateRequest = validateRequest;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mjtickets981/common",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",
@@ -18,5 +18,14 @@
   "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.1",
+    "express": "^5.1.0",
+    "express-validator": "^7.2.1",
+    "jsonwebtoken": "^9.0.2"
   }
 }