@medi-car-bd/mcb-shared-auth 0.0.4

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 FatihOnlinEShopBD
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,50 @@
+# mcb-backend-boilerplate
+
+```bash
+rm -r node_modules package-lock.json
+```
+
+- Prisma Generate
+
+```bash
+pnpm prisma generate
+```
+
+- Run Prisma To Initialize Database
+
+```bash
+pnpm prisma init
+```
+
+- Generate Prisma Client
+
+```bash
+pnpm prisma generate
+
+```
+
+- Run Prisma Migrations
+
+```bash
+pnpm prisma:migrate
+```
+
+- Shared Auth package installation
+
+```bash
+set GITHUB_TOKEN="your_github_token"
+
+pnpm install @mcb-shared-auth/auth
+```
+
+Or Use
+
+```bash
+pnpm install github:Medi-Car-BD/mcb-shared-auth
+```
+
+Patched version of the shared auth package
+
+```bash
+npm version patch
+```

package/dist/config/env.d.ts

@@ -0,0 +1,5 @@
+import "dotenv/config";
+declare const NODE_ENV: string | undefined;
+declare const JWT_SECRET: string | undefined;
+declare const JWT_EXPIRES_IN: string | undefined;
+export { NODE_ENV, JWT_SECRET, JWT_EXPIRES_IN };

package/dist/config/env.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JWT_EXPIRES_IN = exports.JWT_SECRET = exports.NODE_ENV = void 0;
+require("dotenv/config");
+const NODE_ENV = process.env.NODE_ENV;
+exports.NODE_ENV = NODE_ENV;
+const JWT_SECRET = process.env.JWT_SECRET;
+exports.JWT_SECRET = JWT_SECRET;
+const JWT_EXPIRES_IN = process.env.JWT_EXPIRES_IN;
+exports.JWT_EXPIRES_IN = JWT_EXPIRES_IN;

package/dist/config/index.d.ts

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

package/dist/config/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("./env"), exports);

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./utils";
+export * from "./middlewares";
+export * from "./types";

package/dist/index.js

@@ -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("./utils"), exports);
+__exportStar(require("./middlewares"), exports);
+__exportStar(require("./types"), exports);

package/dist/middlewares/authenticate.d.ts

@@ -0,0 +1,6 @@
+import type { Request, Response, NextFunction } from "express";
+import jwt from "jsonwebtoken";
+export type AuthenticatedRequest = Request & {
+    user?: jwt.JwtPayload & Record<string, unknown>;
+};
+export declare const authenticate: (req: AuthenticatedRequest, _res: Response, next: NextFunction) => void;

package/dist/middlewares/authenticate.js

@@ -0,0 +1,26 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.authenticate = void 0;
+const jsonwebtoken_1 = __importDefault(require("jsonwebtoken"));
+const config_1 = require("../config");
+const utils_1 = require("../utils");
+const authenticate = (req, _res, next) => {
+    const header = req.headers.authorization;
+    const token = (header && header.startsWith("Bearer ") && header.split(" ")[1]) ||
+        req.headers["x-access-token"];
+    if (!token) {
+        return next(new utils_1.AppError("Authentication required", 401));
+    }
+    try {
+        const decoded = jsonwebtoken_1.default.verify(token, String(config_1.JWT_SECRET));
+        req.user = decoded;
+        return next();
+    }
+    catch (_a) {
+        return next(new utils_1.AppError("Invalid or expired token", 401));
+    }
+};
+exports.authenticate = authenticate;

package/dist/middlewares/authorize.d.ts

@@ -0,0 +1,3 @@
+import type { Response, NextFunction } from "express";
+import type { AuthenticatedRequest } from "./authenticate";
+export declare const authorize: (...roles: Array<string | number>) => (req: AuthenticatedRequest, _res: Response, next: NextFunction) => void;

package/dist/middlewares/authorize.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.authorize = void 0;
+const utils_1 = require("../utils");
+const authorize = (...roles) => (req, _res, next) => {
+    var _a;
+    const role = (_a = req.user) === null || _a === void 0 ? void 0 : _a.role;
+    if (roles.length === 0)
+        return next();
+    if (!role || !roles.includes(role)) {
+        return next(new utils_1.AppError("Forbidden", 403));
+    }
+    return next();
+};
+exports.authorize = authorize;

package/dist/middlewares/index.d.ts

@@ -0,0 +1,3 @@
+export * from "../utils/globalError";
+export * from "./authenticate";
+export * from "./authorize";

package/dist/middlewares/index.js

@@ -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("../utils/globalError"), exports);
+__exportStar(require("./authenticate"), exports);
+__exportStar(require("./authorize"), exports);

package/dist/types/commonType.d.ts

@@ -0,0 +1,3 @@
+import type { Request, Response, NextFunction } from "express";
+export type TAsyncFunction = (req: Request, res: Response, next: NextFunction) => Promise<void>;
+export type TGenerateSKU = (length: number) => string;

package/dist/types/commonType.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./userType";
+export * from "./commonType";

package/dist/types/index.js

@@ -0,0 +1,18 @@
+"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("./userType"), exports);
+__exportStar(require("./commonType"), exports);

package/dist/types/userType.d.ts

@@ -0,0 +1,9 @@
+export type TUser = {
+    id?: string;
+    name: string | null;
+    email: string;
+    image?: string | null;
+    password: string;
+    createdAt?: Date;
+    updatedAt?: Date;
+};

package/dist/types/userType.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/utils/appError.d.ts

@@ -0,0 +1,11 @@
+export declare class AppError extends Error {
+    statusCode: number;
+    status: "fail" | "error";
+    isOperational: boolean;
+    errmsg?: string;
+    code?: number;
+    errors?: Record<string, unknown>;
+    path?: string;
+    value?: string | number;
+    constructor(message: string, statusCode: number);
+}

package/dist/utils/appError.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AppError = void 0;
+class AppError extends Error {
+    constructor(message, statusCode) {
+        super(message);
+        this.statusCode = statusCode;
+        this.status = `${statusCode}`.startsWith("4") ? "fail" : "error";
+        this.isOperational = true;
+        this.errmsg = message;
+        this.code = statusCode;
+    }
+}
+exports.AppError = AppError;

package/dist/utils/catchAsync.d.ts

@@ -0,0 +1,3 @@
+import type { Request, Response, NextFunction } from "express";
+import type { TAsyncFunction } from "../types";
+export declare const catchAsync: (func: TAsyncFunction) => (req: Request, res: Response, next: NextFunction) => void;

package/dist/utils/catchAsync.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.catchAsync = void 0;
+const catchAsync = (func) => {
+    return (req, res, next) => {
+        func(req, res, next).catch(next);
+    };
+};
+exports.catchAsync = catchAsync;

package/dist/utils/comparePassword.d.ts

@@ -0,0 +1 @@
+export declare const comparePassword: (password: string, userPassword: string) => boolean;

package/dist/utils/comparePassword.js

@@ -0,0 +1,12 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.comparePassword = void 0;
+const bcryptjs_1 = __importDefault(require("bcryptjs"));
+// compare password from request with the one in the database
+const comparePassword = (password, userPassword) => {
+    return bcryptjs_1.default.compareSync(password, userPassword);
+};
+exports.comparePassword = comparePassword;

package/dist/utils/globalError.d.ts

@@ -0,0 +1,6 @@
+import { AppError } from ".";
+import type { Request, Response, NextFunction } from "express";
+declare const processRequest: (req: Request, res: Response, next: NextFunction) => void;
+declare const notFound: (req: Request, res: Response, next: NextFunction) => void;
+declare const errorHandler: (err: AppError, req: Request, res: Response, _next: NextFunction) => void;
+export { notFound, errorHandler, processRequest };

package/dist/utils/globalError.js

@@ -0,0 +1,79 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.processRequest = exports.errorHandler = exports.notFound = void 0;
+const _1 = require(".");
+const processRequest = (req, res, next) => {
+    const corrHeader = req.headers["x-correlation-id"];
+    const correlationId = Array.isArray(corrHeader)
+        ? corrHeader.join(",")
+        : (corrHeader !== null && corrHeader !== void 0 ? corrHeader : "");
+    const requestBody = req.body;
+    _1.logger.info(`${req.originalUrl} - ${req.method} - ${req.ip} - ${correlationId} - ${JSON.stringify(requestBody)}`);
+    next();
+};
+exports.processRequest = processRequest;
+// create a global error handler middleware
+const notFound = (req, res, next) => {
+    // handle error for /favicon.ico request from browser to server, we have ico on public folder
+    const error = new _1.AppError(`Not found - ${req.originalUrl}`, 404);
+    next(error);
+};
+exports.notFound = notFound;
+// create a global error handler middleware
+const errorHandler = (err, req, res, _next) => {
+    var _a, _b;
+    const corrHeader = req.headers["x-correlation-id"];
+    const correlationId = Array.isArray(corrHeader)
+        ? corrHeader.join(",")
+        : (corrHeader !== null && corrHeader !== void 0 ? corrHeader : "");
+    let statusCode = err.statusCode || 500;
+    const status = err.status || "error";
+    let { message } = err;
+    if (err.code === 11000) {
+        statusCode = 400;
+        const value = ((_b = (_a = err.errmsg) === null || _a === void 0 ? void 0 : _a.match(/(["'])(?:\\.|[^\\])*?\1/)) === null || _b === void 0 ? void 0 : _b[0]) || "value";
+        message = `Duplicate field value: ${value}. Please use another value!`;
+    }
+    // use switch case instead of if else for err.name
+    switch (err.name) {
+        case "CastError":
+            statusCode = 400;
+            message = `Invalid ${err.path}: ${err.value}`;
+            break;
+        case "PostgresServerError": {
+            const e = (err.stack || "").split(":");
+            message = `${e[1] || "Postgres server error"}`;
+            break;
+        }
+        case "ValidationError": {
+            const errors = Object.values(err.errors || {}).map((el) => { var _a; return String((_a = el === null || el === void 0 ? void 0 : el.message) !== null && _a !== void 0 ? _a : el); });
+            message = `Invalid input data. ${errors.join(". ")}`;
+            statusCode = 400;
+            break;
+        }
+        case "SyntaxError":
+            message = `Invalid api request. ${err.message}`;
+            statusCode = 400;
+            break;
+        case "JsonWebTokenError":
+            message = `Invalid token. Please log in again!`;
+            statusCode = 401;
+            break;
+        case "TokenExpiredError":
+            message = `Your token has expired!. Please log in again!`;
+            statusCode = 401;
+            break;
+        case "ReferenceError":
+            statusCode = 500;
+            break;
+        default:
+            break;
+    }
+    res.status(statusCode).json({
+        state: status,
+        message,
+        stack: err.stack,
+    });
+    _1.logger.error(`${statusCode} - ${status} - ${req.originalUrl} - ${req.method} - ${req.ip} - ${correlationId} - ${err.message} - ${err.stack} `);
+};
+exports.errorHandler = errorHandler;

package/dist/utils/index.d.ts

@@ -0,0 +1,7 @@
+export * from "./catchAsync";
+export * from "./appError";
+export * from "./logger";
+export * from "./comparePassword";
+export * from "./signToken";
+export * from "./globalError";
+export * from "./limiter";

package/dist/utils/index.js

@@ -0,0 +1,23 @@
+"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("./catchAsync"), exports);
+__exportStar(require("./appError"), exports);
+__exportStar(require("./logger"), exports);
+__exportStar(require("./comparePassword"), exports);
+__exportStar(require("./signToken"), exports);
+__exportStar(require("./globalError"), exports);
+__exportStar(require("./limiter"), exports);

package/dist/utils/limiter.d.ts

@@ -0,0 +1 @@
+export declare const limiter: import("express-rate-limit").RateLimitRequestHandler;

package/dist/utils/limiter.js

@@ -0,0 +1,12 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.limiter = void 0;
+const express_rate_limit_1 = __importDefault(require("express-rate-limit"));
+exports.limiter = (0, express_rate_limit_1.default)({
+    max: 100, // 100 requests
+    windowMs: 15 * 60 * 1000, // 15 minutes
+    message: "Too many requests from this IP, please try again in an hour!", // message to send
+});

package/dist/utils/logger.d.ts

@@ -0,0 +1,2 @@
+import "winston-daily-rotate-file";
+export declare const logger: import("winston").Logger;

package/dist/utils/logger.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logger = void 0;
+const winston_1 = require("winston");
+require("winston-daily-rotate-file");
+const config_1 = require("../config");
+// create logger with a daily rotate file transport with proper type and generics if needed
+exports.logger = (0, winston_1.createLogger)({
+    level: "info",
+    format: winston_1.format.combine(winston_1.format.timestamp({
+        format: "YYYY-MM-DD HH:mm:ss",
+    }), winston_1.format.json()),
+    transports: [
+        new winston_1.transports.DailyRotateFile({
+            filename: "logs/error/%DATE%.log",
+            datePattern: "YYYY-MM-DD",
+            zippedArchive: true,
+            maxSize: "20m",
+            maxFiles: "14d",
+            level: "error",
+        }),
+        new winston_1.transports.DailyRotateFile({
+            filename: "logs/%DATE%.log",
+            datePattern: "YYYY-MM-DD",
+            zippedArchive: true,
+            maxSize: "20m",
+            maxFiles: "14d",
+        }),
+    ],
+});
+if (config_1.NODE_ENV !== "production") {
+    exports.logger.add(new winston_1.transports.Console({
+        format: winston_1.format.combine(winston_1.format.colorize(), winston_1.format.timestamp({
+            format: "YYYY-MM-DD HH:mm:ss",
+        }), winston_1.format.printf((info) => `${info.timestamp} ${info.level}: ${info.message}`)),
+        level: "debug",
+    }));
+}

package/dist/utils/signToken.d.ts

@@ -0,0 +1,2 @@
+import type { TUser } from "../types";
+export declare const signToken: (user: TUser) => string;

package/dist/utils/signToken.js

@@ -0,0 +1,19 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.signToken = void 0;
+const jsonwebtoken_1 = __importDefault(require("jsonwebtoken"));
+const config_1 = require("../config");
+const signToken = (user) => {
+    return jsonwebtoken_1.default.sign({
+        id: user.id,
+        name: user.name,
+        email: user.email,
+        password: user.password,
+    }, config_1.JWT_SECRET, {
+        expiresIn: config_1.JWT_EXPIRES_IN,
+    });
+};
+exports.signToken = signToken;

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@medi-car-bd/mcb-shared-auth",
+  "version": "0.0.4",
+  "description": "Shared authentication module for MCB applications",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "preinstall": "node -e \"\"",
+    "postinstall": "",
+    "build": "tsc",
+    "start": "node dist/index.js",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "lint": "eslint . --ext .ts,.tsx,.js,.jsx",
+    "lint:fix": "eslint . --ext .ts,.tsx,.js,.jsx --fix",
+    "format": "prettier --write .",
+    "format:check": "prettier --check ."
+  },
+  "keywords": [],
+  "author": "MediCarBD",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/express": "^4.17.21",
+    "@types/node": "^20.11.0",
+    "@typescript-eslint/eslint-plugin": "^8.54.0",
+    "@typescript-eslint/parser": "^8.54.0",
+    "eslint": "^9.39.2",
+    "eslint-config-prettier": "^9.1.0",
+    "prettier": "^3.2.5",
+    "typescript": "^5.3.3"
+  },
+  "dependencies": {
+    "bcryptjs": "^2.4.3",
+    "dotenv": "^16.3.1",
+    "express-rate-limit": "^7.1.5",
+    "jsonwebtoken": "^9.0.2",
+    "winston": "^3.11.0",
+    "winston-daily-rotate-file": "^4.7.1"
+  },
+  "peerDependencies": {
+    "express": "^4.18.2"
+  },
+  "files": [
+    "dist"
+  ],
+  "lint-staged": {
+    "*.{ts,tsx,js,jsx}": [
+      "eslint --max-warnings=0 --fix",
+      "prettier --write"
+    ],
+    "*.{json,md,yml,yaml}": [
+      "prettier --write"
+    ]
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Medi-Car-BD/mcb-shared-auth"
+  }
+}