arkos 1.2.14-test → 1.2.14-test.1

package/dist/es2020/modules/auth/auth.service.js

@@ -1,185 +0,0 @@
-import jwt from "jsonwebtoken";
-import bcrypt from "bcryptjs";
-import catchAsync from "../error-handler/utils/catch-async";
-import AppError from "../error-handler/utils/app-error";
-import { callNext } from "../base/base.middlewares";
-import { getArkosConfig } from "../../server";
-import arkosEnv from "../../utils/arkos-env";
-import { getPrismaInstance } from "../../utils/helpers/prisma.helpers";
-export class AuthService {
-    constructor() {
-        this.authenticate = catchAsync(async (req, res, next) => {
-            const arkosConfig = getArkosConfig();
-            if (!arkosConfig?.authentication) {
-                next();
-                return;
-            }
-            req.user = (await this.getAuthenticatedUser(req));
-            next();
-        });
-    }
-    signJwtToken(id, expiresIn, secret) {
-        const { authentication: configs } = getArkosConfig();
-        if (process.env.NODE_ENV === "production" &&
-            !process.env.JWT_SECRET &&
-            !configs?.jwt?.secret)
-            throw new AppError("Missing JWT secret on production!", 500, {}, "MissingJWTOnProduction");
-        secret =
-            secret ||
-                configs?.jwt?.secret ||
-                process.env.JWT_SECRET ||
-                arkosEnv.JWT_SECRET;
-        expiresIn = (expiresIn ||
-            configs?.jwt?.expiresIn ||
-            process.env.JWT_EXPIRES_IN ||
-            arkosEnv.JWT_EXPIRES_IN);
-        return jwt.sign({ id }, secret, {
-            expiresIn: expiresIn,
-        });
-    }
-    isPasswordHashed(password) {
-        return !Number.isNaN(bcrypt.getRounds(password) * 1);
-    }
-    async isCorrectPassword(candidatePassword, userPassword) {
-        return await bcrypt.compare(candidatePassword, userPassword);
-    }
-    async hashPassword(password) {
-        return await bcrypt.hash(password, 12);
-    }
-    isPasswordStrong(password) {
-        const initAuthConfigs = getArkosConfig()?.authentication;
-        const strongPasswordRegex = initAuthConfigs?.passwordValidation?.regex ||
-            /^(?=.*[A-Z])(?=.*[a-z])(?=.*\d).+$/;
-        return strongPasswordRegex.test(password);
-    }
-    userChangedPasswordAfter(user, JWTTimestamp) {
-        if (user.passwordChangedAt) {
-            const convertedTimestamp = parseInt(String(user.passwordChangedAt.getTime() / 1000), 10);
-            return JWTTimestamp < convertedTimestamp;
-        }
-        return false;
-    }
-    async verifyJwtToken(token, secret) {
-        const { authentication: configs } = getArkosConfig();
-        if (process.env.NODE_ENV === "production" &&
-            !process.env.JWT_SECRET &&
-            !configs?.jwt?.secret)
-            throw new AppError("Missing JWT secret!", 500);
-        secret =
-            secret ||
-                configs?.jwt?.secret ||
-                process.env.JWT_SECRET ||
-                arkosEnv.JWT_SECRET;
-        return new Promise((resolve, reject) => {
-            jwt.verify(token, secret, (err, decoded) => {
-                if (err)
-                    reject(err);
-                else
-                    resolve(decoded);
-            });
-        });
-    }
-    handleAccessControl(action, resourceName, accessControl) {
-        return catchAsync(async (req, res, next) => {
-            if (req.user) {
-                const user = req.user;
-                const prisma = getPrismaInstance();
-                const configs = getArkosConfig();
-                if (user.isSuperUser) {
-                    next();
-                    return;
-                }
-                if (configs?.authentication?.mode === "dynamic") {
-                    const matchingRole = await prisma.userRole.findFirst({
-                        where: {
-                            userId: req.user.id,
-                            role: {
-                                permissions: {
-                                    some: {
-                                        resource: resourceName,
-                                        action: action,
-                                    },
-                                },
-                            },
-                        },
-                        select: { id: true },
-                    });
-                    if (!matchingRole)
-                        return next(new AppError("You do not have permission to perfom this action", 403));
-                }
-                else if (configs?.authentication?.mode === "static") {
-                    let authorizedRoles = [];
-                    if (!accessControl)
-                        return next(new AppError("You do not have permission to perform this action", 403));
-                    if (Array.isArray(accessControl))
-                        authorizedRoles = accessControl;
-                    else if (accessControl[action])
-                        authorizedRoles = accessControl[action] || [];
-                    const userRoles = Array.isArray(user?.roles)
-                        ? user.roles
-                        : [user.role];
-                    const hasPermission = userRoles.some((role) => authorizedRoles.includes(role));
-                    if (!hasPermission) {
-                        return next(new AppError("You do not have permission to perform this action", 403));
-                    }
-                }
-            }
-            next();
-        });
-    }
-    async getAuthenticatedUser(req) {
-        const arkosConfig = getArkosConfig();
-        if (!arkosConfig?.authentication)
-            return null;
-        const prisma = getPrismaInstance();
-        let token;
-        if (req?.headers?.authorization &&
-            req?.headers?.authorization.startsWith("Bearer")) {
-            token = req?.headers?.authorization.split(" ")[1];
-        }
-        else if (req?.cookies?.arkos_access_token !== "no-token" && req.cookies) {
-            token = req?.cookies?.arkos_access_token;
-        }
-        if (!token)
-            throw new AppError("You are not logged in! please log in to get access", 401, {}, "LoginRequired");
-        let decoded;
-        try {
-            decoded = await this.verifyJwtToken(token);
-        }
-        catch (err) {
-            throw new AppError("Your auth token is invalid, please login again.", 401, {}, "InvalidAuthToken");
-        }
-        if (!decoded?.id)
-            throw new AppError("Your auth token is invalid, please login again.", 401, {}, "InvalidAuthToken");
-        const user = await prisma.user.findUnique({
-            where: { id: String(decoded.id) },
-            select: {
-                id: true,
-                passwordChangedAt: true,
-                isActive: true,
-                deletedSelfAccountAt: true,
-                isSuperUser: true,
-            },
-        });
-        if (!user)
-            throw new AppError("The user belonging to this token does no longer exists", 401);
-        if (this.userChangedPasswordAfter(user, decoded.iat) &&
-            !req.path?.includes?.("logout"))
-            throw new AppError("User recently changed password! Please log in again.", 401, {}, "PasswordChanged");
-        return user;
-    }
-    handleAuthenticationControl(action, authenticationControl) {
-        if (authenticationControl && typeof authenticationControl === "object") {
-            if (authenticationControl[action] === false)
-                return callNext;
-            else if (authenticationControl[action] === true)
-                return this.authenticate;
-        }
-        else
-            return this.authenticate;
-        return this.authenticate;
-    }
-}
-const authService = new AuthService();
-export default authService;
-//# sourceMappingURL=auth.service.js.map

package/dist/es2020/modules/auth/auth.service.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"auth.service.js","sourceRoot":"","sources":["../../../../src/modules/auth/auth.service.ts"],"names":[],"mappings":"AAAA,OAAO,GAAoB,MAAM,cAAc,CAAC;AAChD,OAAO,MAAM,MAAM,UAAU,CAAC;AAE9B,OAAO,UAAU,MAAM,oCAAoC,CAAC;AAC5D,OAAO,QAAQ,MAAM,kCAAkC,CAAC;AACxD,OAAO,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AACpD,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,QAAQ,MAAM,uBAAuB,CAAC;AAC7C,OAAO,EAAE,iBAAiB,EAAE,MAAM,oCAAoC,CAAC;AAkBvE,MAAM,OAAO,WAAW;IAAxB;QAuVE,iBAAY,GAAG,UAAU,CACvB,KAAK,EAAE,GAAiB,EAAE,GAAkB,EAAE,IAAuB,EAAE,EAAE;YACvE,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;YACrC,IAAI,CAAC,WAAW,EAAE,cAAc,EAAE,CAAC;gBACjC,IAAI,EAAE,CAAC;gBACP,OAAO;YACT,CAAC;YAED,GAAG,CAAC,IAAI,GAAG,CAAC,MAAM,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAS,CAAC;YAC1D,IAAI,EAAE,CAAC;QACT,CAAC,CACF,CAAC;IAoBJ,CAAC;IA7WC,YAAY,CACV,EAAmB,EACnB,SAA+B,EAC/B,MAAe;QAEf,MAAM,EAAE,cAAc,EAAE,OAAO,EAAE,GAAG,cAAc,EAAE,CAAC;QAErD,IACE,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY;YACrC,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU;YACvB,CAAC,OAAO,EAAE,GAAG,EAAE,MAAM;YAErB,MAAM,IAAI,QAAQ,CAChB,mCAAmC,EACnC,GAAG,EACH,EAAE,EACF,wBAAwB,CACzB,CAAC;QAEJ,MAAM;YACJ,MAAM;gBACN,OAAO,EAAE,GAAG,EAAE,MAAM;gBACpB,OAAO,CAAC,GAAG,CAAC,UAAU;gBACtB,QAAQ,CAAC,UAAU,CAAC;QAEtB,SAAS,GAAG,CAAC,SAAS;YACpB,OAAO,EAAE,GAAG,EAAE,SAAS;YACvB,OAAO,CAAC,GAAG,CAAC,cAAc;YAC1B,QAAQ,CAAC,cAAc,CAAmC,CAAC;QAE7D,OAAO,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE;YAC9B,SAAS,EAAE,SAAuB;SACnC,CAAC,CAAC;IACL,CAAC;IAaD,gBAAgB,CAAC,QAAgB;QAC/B,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;IACvD,CAAC;IASD,KAAK,CAAC,iBAAiB,CACrB,iBAAyB,EACzB,YAAoB;QAEpB,OAAO,MAAM,MAAM,CAAC,OAAO,CAAC,iBAAiB,EAAE,YAAY,CAAC,CAAC;IAC/D,CAAC;IAQD,KAAK,CAAC,YAAY,CAAC,QAAgB;QACjC,OAAO,MAAM,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IACzC,CAAC;IAmBM,gBAAgB,CAAC,QAAgB;QACtC,MAAM,eAAe,GAAG,cAAc,EAAE,EAAE,cAAc,CAAC;QAEzD,MAAM,mBAAmB,GACvB,eAAe,EAAE,kBAAkB,EAAE,KAAK;YAC1C,oCAAoC,CAAC;QACvC,OAAO,mBAAmB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC5C,CAAC;IASD,wBAAwB,CAAC,IAAU,EAAE,YAAoB;QACvD,IAAI,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC3B,MAAM,kBAAkB,GAAG,QAAQ,CACjC,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,EAC/C,EAAE,CACH,CAAC;YAEF,OAAO,YAAY,GAAG,kBAAkB,CAAC;QAC3C,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAUD,KAAK,CAAC,cAAc,CAClB,KAAa,EACb,MAAe;QAEf,MAAM,EAAE,cAAc,EAAE,OAAO,EAAE,GAAG,cAAc,EAAE,CAAC;QAErD,IACE,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY;YACrC,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU;YACvB,CAAC,OAAO,EAAE,GAAG,EAAE,MAAM;YAErB,MAAM,IAAI,QAAQ,CAAC,qBAAqB,EAAE,GAAG,CAAC,CAAC;QAEjD,MAAM;YACJ,MAAM;gBACN,OAAO,EAAE,GAAG,EAAE,MAAM;gBACpB,OAAO,CAAC,GAAG,CAAC,UAAU;gBACtB,QAAQ,CAAC,UAAU,CAAC;QAEtB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,GAAG,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE;gBACzC,IAAI,GAAG;oBAAE,MAAM,CAAC,GAAG,CAAC,CAAC;;oBAChB,OAAO,CAAC,OAAyB,CAAC,CAAC;YAC1C,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAUD,mBAAmB,CACjB,MAAoB,EACpB,YAAoB,EACpB,aAAmC;QAEnC,OAAO,UAAU,CACf,KAAK,EACH,GAAiB,EACjB,GAAkB,EAClB,IAAuB,EACvB,EAAE;YACF,IAAI,GAAG,CAAC,IAAI,EAAE,CAAC;gBACb,MAAM,IAAI,GAAG,GAAG,CAAC,IAAW,CAAC;gBAC7B,MAAM,MAAM,GAAG,iBAAiB,EAAE,CAAC;gBACnC,MAAM,OAAO,GAAG,cAAc,EAAE,CAAC;gBAEjC,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;oBACrB,IAAI,EAAE,CAAC;oBACP,OAAO;gBACT,CAAC;gBAED,IAAI,OAAO,EAAE,cAAc,EAAE,IAAI,KAAK,SAAS,EAAE,CAAC;oBAChD,MAAM,YAAY,GAAG,MAAM,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC;wBACnD,KAAK,EAAE;4BACL,MAAM,EAAE,GAAG,CAAC,IAAI,CAAC,EAAE;4BACnB,IAAI,EAAE;gCACJ,WAAW,EAAE;oCACX,IAAI,EAAE;wCACJ,QAAQ,EAAE,YAAY;wCACtB,MAAM,EAAE,MAAM;qCACf;iCACF;6BACF;yBACF;wBACD,MAAM,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE;qBACrB,CAAC,CAAC;oBAEH,IAAI,CAAC,YAAY;wBACf,OAAO,IAAI,CACT,IAAI,QAAQ,CACV,kDAAkD,EAClD,GAAG,CACJ,CACF,CAAC;gBACN,CAAC;qBAAM,IAAI,OAAO,EAAE,cAAc,EAAE,IAAI,KAAK,QAAQ,EAAE,CAAC;oBACtD,IAAI,eAAe,GAAa,EAAE,CAAC;oBAEnC,IAAI,CAAC,aAAa;wBAChB,OAAO,IAAI,CACT,IAAI,QAAQ,CACV,mDAAmD,EACnD,GAAG,CACJ,CACF,CAAC;oBAEJ,IAAI,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC;wBAAE,eAAe,GAAG,aAAa,CAAC;yBAC7D,IAAI,aAAa,CAAC,MAAM,CAAC;wBAC5B,eAAe,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;oBAEhD,MAAM,SAAS,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC;wBAC1C,CAAC,CAAC,IAAI,CAAC,KAAK;wBACZ,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;oBAChB,MAAM,aAAa,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,IAAY,EAAE,EAAE,CACpD,eAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,CAC/B,CAAC;oBAEF,IAAI,CAAC,aAAa,EAAE,CAAC;wBACnB,OAAO,IAAI,CACT,IAAI,QAAQ,CACV,mDAAmD,EACnD,GAAG,CACJ,CACF,CAAC;oBACJ,CAAC;gBACH,CAAC;YACH,CAAC;YAED,IAAI,EAAE,CAAC;QACT,CAAC,CACF,CAAC;IACJ,CAAC;IAQD,KAAK,CAAC,oBAAoB,CAAC,GAAiB;QAC1C,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;QACrC,IAAI,CAAC,WAAW,EAAE,cAAc;YAAE,OAAO,IAAI,CAAC;QAE9C,MAAM,MAAM,GAAG,iBAAiB,EAAE,CAAC;QAEnC,IAAI,KAAyB,CAAC;QAE9B,IACE,GAAG,EAAE,OAAO,EAAE,aAAa;YAC3B,GAAG,EAAE,OAAO,EAAE,aAAa,CAAC,UAAU,CAAC,QAAQ,CAAC,EAChD,CAAC;YACD,KAAK,GAAG,GAAG,EAAE,OAAO,EAAE,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QACpD,CAAC;aAAM,IAAI,GAAG,EAAE,OAAO,EAAE,kBAAkB,KAAK,UAAU,IAAI,GAAG,CAAC,OAAO,EAAE,CAAC;YAC1E,KAAK,GAAG,GAAG,EAAE,OAAO,EAAE,kBAAkB,CAAC;QAC3C,CAAC;QAED,IAAI,CAAC,KAAK;YACR,MAAM,IAAI,QAAQ,CAChB,oDAAoD,EACpD,GAAG,EACH,EAAE,EACF,eAAe,CAChB,CAAC;QAEJ,IAAI,OAAmC,CAAC;QACxC,IAAI,CAAC;YACH,OAAO,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;QAC7C,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,IAAI,QAAQ,CAChB,iDAAiD,EACjD,GAAG,EACH,EAAE,EACF,kBAAkB,CACnB,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,OAAO,EAAE,EAAE;YACd,MAAM,IAAI,QAAQ,CAChB,iDAAiD,EACjD,GAAG,EACH,EAAE,EACF,kBAAkB,CACnB,CAAC;QAEJ,MAAM,IAAI,GAAe,MAAO,MAAc,CAAC,IAAI,CAAC,UAAU,CAAC;YAC7D,KAAK,EAAE,EAAE,EAAE,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE;YACjC,MAAM,EAAE;gBACN,EAAE,EAAE,IAAI;gBACR,iBAAiB,EAAE,IAAI;gBACvB,QAAQ,EAAE,IAAI;gBACd,oBAAoB,EAAE,IAAI;gBAC1B,WAAW,EAAE,IAAI;aAClB;SACF,CAAC,CAAC;QAEH,IAAI,CAAC,IAAI;YACP,MAAM,IAAI,QAAQ,CAChB,wDAAwD,EACxD,GAAG,CACJ,CAAC;QAEJ,IACE,IAAI,CAAC,wBAAwB,CAAC,IAAI,EAAE,OAAO,CAAC,GAAI,CAAC;YACjD,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,EAAE,CAAC,QAAQ,CAAC;YAE/B,MAAM,IAAI,QAAQ,CAChB,sDAAsD,EACtD,GAAG,EACH,EAAE,EACF,iBAAiB,CAClB,CAAC;QAEJ,OAAO,IAAI,CAAC;IACd,CAAC;IA8BD,2BAA2B,CACzB,MAAoB,EACpB,qBAA+D;QAE/D,IAAI,qBAAqB,IAAI,OAAO,qBAAqB,KAAK,QAAQ,EAAE,CAAC;YACvE,IAAI,qBAAqB,CAAC,MAAM,CAAC,KAAK,KAAK;gBAAE,OAAO,QAAQ,CAAC;iBACxD,IAAI,qBAAqB,CAAC,MAAM,CAAC,KAAK,IAAI;gBAAE,OAAO,IAAI,CAAC,YAAY,CAAC;QAC5E,CAAC;;YAAM,OAAO,IAAI,CAAC,YAAY,CAAC;QAEhC,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;CACF;AAKD,MAAM,WAAW,GAAG,IAAI,WAAW,EAAE,CAAC;AAEtC,eAAe,WAAW,CAAC","sourcesContent":["import jwt, { SignOptions } from \"jsonwebtoken\";\nimport bcrypt from \"bcryptjs\";\nimport { User } from \"../../types\";\nimport catchAsync from \"../error-handler/utils/catch-async\";\nimport AppError from \"../error-handler/utils/app-error\";\nimport { callNext } from \"../base/base.middlewares\";\nimport { getArkosConfig } from \"../../server\";\nimport arkosEnv from \"../../utils/arkos-env\";\nimport { getPrismaInstance } from \"../../utils/helpers/prisma.helpers\";\nimport {\n  ArkosRequest,\n  ArkosResponse,\n  ArkosNextFunction,\n  ArkosRequestHandler,\n} from \"../../types\";\nimport {\n  AuthJwtPayload,\n  AccessAction,\n  AccessControlConfig,\n  AuthenticationControlConfig,\n} from \"../../types/auth\";\nimport { MsDuration } from \"./utils/helpers/auth.controller.helpers\";\n\n/**\n * Handles various authentication-related tasks such as JWT signing, password hashing, and verifying user credentials.\n */\nexport class AuthService {\n  /**\n   * Signs a JWT token for the user.\n   *\n   * @param {number | string} id - The unique identifier of the user to generate the token for.\n   * @param {string | number} [expiresIn] - The expiration time for the token. Defaults to environment variable `JWT_EXPIRES_IN`.\n   * @param {string} [secret] - The secret key used to sign the token. Defaults to environment variable `JWT_SECRET`.\n   * @returns {string} The signed JWT token.\n   */\n  signJwtToken(\n    id: number | string,\n    expiresIn?: MsDuration | number,\n    secret?: string\n  ): string {\n    const { authentication: configs } = getArkosConfig();\n\n    if (\n      process.env.NODE_ENV === \"production\" &&\n      !process.env.JWT_SECRET &&\n      !configs?.jwt?.secret\n    )\n      throw new AppError(\n        \"Missing JWT secret on production!\",\n        500,\n        {},\n        \"MissingJWTOnProduction\"\n      );\n\n    secret =\n      secret ||\n      configs?.jwt?.secret ||\n      process.env.JWT_SECRET ||\n      arkosEnv.JWT_SECRET;\n\n    expiresIn = (expiresIn ||\n      configs?.jwt?.expiresIn ||\n      process.env.JWT_EXPIRES_IN ||\n      arkosEnv.JWT_EXPIRES_IN) as keyof SignOptions[\"expiresIn\"];\n\n    return jwt.sign({ id }, secret, {\n      expiresIn: expiresIn as MsDuration,\n    });\n  }\n\n  /**\n   * Is used by default internally by Arkos under `BaseService` class to check if the password is already hashed.\n   *\n   * This was just added to prevent unwanted errors when someone just forgets that the `BaseService` class will automatically hash the password field using `authService.hashPassword` by default.\n   *\n   * So now before `BaseService` hashes it will test it.\n   *\n   *\n   * @param password The password to be tested if is hashed\n   * @returns\n   */\n  isPasswordHashed(password: string) {\n    return !Number.isNaN(bcrypt.getRounds(password) * 1);\n  }\n\n  /**\n   * Compares a candidate password with the stored user password to check if they match.\n   *\n   * @param {string} candidatePassword - The password provided by the user during login.\n   * @param {string} userPassword - The password stored in the database.\n   * @returns {Promise<boolean>} Returns true if the passwords match, otherwise false.\n   */\n  async isCorrectPassword(\n    candidatePassword: string,\n    userPassword: string\n  ): Promise<boolean> {\n    return await bcrypt.compare(candidatePassword, userPassword);\n  }\n\n  /**\n   * Hashes a plain text password using bcrypt.\n   *\n   * @param {string} password - The password to be hashed.\n   * @returns {Promise<string>} Returns the hashed password.\n   */\n  async hashPassword(password: string): Promise<string> {\n    return await bcrypt.hash(password, 12);\n  }\n\n  /**\n   * Checks if a password is strong, requiring uppercase, lowercase, and numeric characters as the default.\n   *\n   * **NB**: You must pay attention when using custom validation with zod or class-validator, try to use the same regex always.\n   *\n   * **Note**: You can define it when calling arkos.init()\n   * ```ts\n   * arkos.init({\n   *  authentication: {\n   *    passwordValidation:{ regex: /your-desired-regex/, message: 'password must contain...'}\n   *  }\n   * })\n   * ```\n   *\n   * @param {string} password - The password to check.\n   * @returns {boolean} Returns true if the password meets the strength criteria, otherwise false.\n   */\n  public isPasswordStrong(password: string): boolean {\n    const initAuthConfigs = getArkosConfig()?.authentication;\n\n    const strongPasswordRegex =\n      initAuthConfigs?.passwordValidation?.regex ||\n      /^(?=.*[A-Z])(?=.*[a-z])(?=.*\\d).+$/;\n    return strongPasswordRegex.test(password);\n  }\n\n  /**\n   * Checks if a user has changed their password after the JWT was issued.\n   *\n   * @param {User} user - The user object containing the passwordChangedAt field.\n   * @param {number} JWTTimestamp - The timestamp when the JWT was issued.\n   * @returns {boolean} Returns true if the user changed their password after the JWT was issued, otherwise false.\n   */\n  userChangedPasswordAfter(user: User, JWTTimestamp: number): boolean {\n    if (user.passwordChangedAt) {\n      const convertedTimestamp = parseInt(\n        String(user.passwordChangedAt.getTime() / 1000),\n        10\n      );\n\n      return JWTTimestamp < convertedTimestamp;\n    }\n    return false;\n  }\n\n  /**\n   * Verifies the authenticity of a JWT token.\n   *\n   * @param {string} token - The JWT token to verify.\n   * @param {string} [secret] - The secret key used to verify the token. Defaults to environment variable `JWT_SECRET`.\n   * @returns {Promise<AuthJwtPayload>} Returns the decoded JWT payload if the token is valid.\n   * @throws {Error} Throws an error if the token is invalid or expired.\n   */\n  async verifyJwtToken(\n    token: string,\n    secret?: string\n  ): Promise<AuthJwtPayload> {\n    const { authentication: configs } = getArkosConfig();\n\n    if (\n      process.env.NODE_ENV === \"production\" &&\n      !process.env.JWT_SECRET &&\n      !configs?.jwt?.secret\n    )\n      throw new AppError(\"Missing JWT secret!\", 500);\n\n    secret =\n      secret ||\n      configs?.jwt?.secret ||\n      process.env.JWT_SECRET ||\n      arkosEnv.JWT_SECRET;\n\n    return new Promise((resolve, reject) => {\n      jwt.verify(token, secret, (err, decoded) => {\n        if (err) reject(err);\n        else resolve(decoded as AuthJwtPayload);\n      });\n    });\n  }\n\n  /**\n   * Middleware function to handle access control based on user roles and permissions.\n   *\n   * @param {AccessAction} action - The action being performed (e.g., create, update, delete, view).\n   * @param {string} resourceName - The resource name that the action is being performed on (e.g., \"User\", \"Post\").\n   * @param {AccessControlConfig} accessControl - The access control configuration.\n   * @returns {ArkosRequestHandler} The middleware function that checks if the user has permission to perform the action.\n   */\n  handleAccessControl(\n    action: AccessAction,\n    resourceName: string,\n    accessControl?: AccessControlConfig\n  ): ArkosRequestHandler {\n    return catchAsync(\n      async (\n        req: ArkosRequest,\n        res: ArkosResponse,\n        next: ArkosNextFunction\n      ) => {\n        if (req.user) {\n          const user = req.user as any;\n          const prisma = getPrismaInstance();\n          const configs = getArkosConfig();\n\n          if (user.isSuperUser) {\n            next();\n            return;\n          }\n\n          if (configs?.authentication?.mode === \"dynamic\") {\n            const matchingRole = await prisma.userRole.findFirst({\n              where: {\n                userId: req.user.id,\n                role: {\n                  permissions: {\n                    some: {\n                      resource: resourceName,\n                      action: action,\n                    },\n                  },\n                },\n              },\n              select: { id: true },\n            });\n\n            if (!matchingRole)\n              return next(\n                new AppError(\n                  \"You do not have permission to perfom this action\",\n                  403\n                )\n              );\n          } else if (configs?.authentication?.mode === \"static\") {\n            let authorizedRoles: string[] = [];\n\n            if (!accessControl)\n              return next(\n                new AppError(\n                  \"You do not have permission to perform this action\",\n                  403\n                )\n              );\n\n            if (Array.isArray(accessControl)) authorizedRoles = accessControl;\n            else if (accessControl[action])\n              authorizedRoles = accessControl[action] || [];\n\n            const userRoles = Array.isArray(user?.roles)\n              ? user.roles\n              : [user.role];\n            const hasPermission = userRoles.some((role: string) =>\n              authorizedRoles.includes(role)\n            );\n\n            if (!hasPermission) {\n              return next(\n                new AppError(\n                  \"You do not have permission to perform this action\",\n                  403\n                )\n              );\n            }\n          }\n        }\n\n        next();\n      }\n    );\n  }\n\n  /**\n   * Processes the cookies or authoriation token and returns the user.\n   * @param req\n   * @returns {Promise<User | null>} - if authentication is turned off in arkosConfig it returns null\n   * @throws {AppError} Throws an error if the token is invalid or the user is not logged in.\n   */\n  async getAuthenticatedUser(req: ArkosRequest): Promise<User | null> {\n    const arkosConfig = getArkosConfig();\n    if (!arkosConfig?.authentication) return null;\n\n    const prisma = getPrismaInstance();\n\n    let token: string | undefined;\n\n    if (\n      req?.headers?.authorization &&\n      req?.headers?.authorization.startsWith(\"Bearer\")\n    ) {\n      token = req?.headers?.authorization.split(\" \")[1];\n    } else if (req?.cookies?.arkos_access_token !== \"no-token\" && req.cookies) {\n      token = req?.cookies?.arkos_access_token;\n    }\n\n    if (!token)\n      throw new AppError(\n        \"You are not logged in! please log in to get access\",\n        401,\n        {},\n        \"LoginRequired\"\n      );\n\n    let decoded: AuthJwtPayload | undefined;\n    try {\n      decoded = await this.verifyJwtToken(token);\n    } catch (err) {\n      throw new AppError(\n        \"Your auth token is invalid, please login again.\",\n        401,\n        {},\n        \"InvalidAuthToken\"\n      );\n    }\n\n    if (!decoded?.id)\n      throw new AppError(\n        \"Your auth token is invalid, please login again.\",\n        401,\n        {},\n        \"InvalidAuthToken\"\n      );\n\n    const user: any | null = await (prisma as any).user.findUnique({\n      where: { id: String(decoded.id) },\n      select: {\n        id: true,\n        passwordChangedAt: true,\n        isActive: true,\n        deletedSelfAccountAt: true,\n        isSuperUser: true,\n      },\n    });\n\n    if (!user)\n      throw new AppError(\n        \"The user belonging to this token does no longer exists\",\n        401\n      );\n\n    if (\n      this.userChangedPasswordAfter(user, decoded.iat!) &&\n      !req.path?.includes?.(\"logout\")\n    )\n      throw new AppError(\n        \"User recently changed password! Please log in again.\",\n        401,\n        {},\n        \"PasswordChanged\"\n      );\n\n    return user;\n  }\n\n  /**\n   * Middleware function to authenticate the user based on the JWT token.\n   *\n   * @param {ArkosRequest} req - The request object.\n   * @param {ArkosResponse} res - The response object.\n   * @param {ArkosNextFunction} next - The next middleware function to be called.\n   * @returns {void}\n   */\n  authenticate = catchAsync(\n    async (req: ArkosRequest, res: ArkosResponse, next: ArkosNextFunction) => {\n      const arkosConfig = getArkosConfig();\n      if (!arkosConfig?.authentication) {\n        next();\n        return;\n      }\n\n      req.user = (await this.getAuthenticatedUser(req)) as User;\n      next();\n    }\n  );\n\n  /**\n   * Handles authentication control by checking the `authenticationControl` configuration in the `authConfigs`.\n   *\n   * @param {ControllerActions} action - The action being performed (e.g., create, update, delete, view).\n   * @param {AuthenticationControlConfig} authenticationControl - The authentication configuration object.\n   * @returns {ArkosRequestHandler} The middleware function that checks if authentication is required.\n   */\n  handleAuthenticationControl(\n    action: AccessAction,\n    authenticationControl?: AuthenticationControlConfig | undefined\n  ): ArkosRequestHandler {\n    if (authenticationControl && typeof authenticationControl === \"object\") {\n      if (authenticationControl[action] === false) return callNext;\n      else if (authenticationControl[action] === true) return this.authenticate;\n    } else return this.authenticate;\n\n    return this.authenticate;\n  }\n}\n\n/**\n * Handles various authentication-related tasks such as JWT signing, password hashing, and verifying user credentials.\n */\nconst authService = new AuthService();\n\nexport default authService;\n"]}

package/dist/es2020/modules/auth/utils/helpers/auth.controller.helpers.js

@@ -1,73 +0,0 @@
-import { getArkosConfig } from "../../../../server";
-import AppError from "../../../error-handler/utils/app-error";
-export const determineUsernameField = (req) => {
-    const authConfigs = getArkosConfig()?.authentication;
-    if (req.query?.usernameField &&
-        typeof req.query?.usernameField === "string" &&
-        authConfigs?.login?.allowedUsernames?.includes?.(req.query.usernameField))
-        return req.query.usernameField;
-    else if (req.query?.usernameField)
-        throw new AppError("Invalid usernameField parameter, it is not allowed!", 400);
-    return authConfigs?.login?.allowedUsernames?.[0] || "username";
-};
-export const createPrismaWhereClause = (path, value) => {
-    if (!path)
-        return {};
-    const parts = path.split(".");
-    const whereClause = {};
-    if (parts.length === 1) {
-        whereClause[parts[0]] = value;
-        return whereClause;
-    }
-    let current = whereClause;
-    for (let i = 0; i < parts.length - 1; i++) {
-        const part = parts[i];
-        current[part] = {};
-        current = current[part];
-    }
-    current[parts[parts.length - 1]] = value;
-    return whereClause;
-};
-export const getNestedValue = (obj, path) => {
-    if (!obj || !path)
-        return undefined;
-    const properties = path.split(".");
-    const lastProperty = properties[properties.length - 1];
-    if (lastProperty in obj) {
-        return obj[lastProperty];
-    }
-    return undefined;
-};
-function normalizeDuration(input) {
-    return input
-        .toLowerCase()
-        .replace(/years?|yr|year/g, "y")
-        .replace(/minutes?|min/g, "m")
-        .replace(/seconds?|sec|secs/g, "s")
-        .replace(/hours?|hr/g, "h")
-        .replace(/days?/g, "d")
-        .replace(/weeks?/g, "w")
-        .replace(/milliseconds?/g, "ms");
-}
-export function toMs(input) {
-    if (typeof input === "number")
-        return input * 1000;
-    const normalizedInput = normalizeDuration(input.trim());
-    const regex = /^(\d+(?:\.\d+)?)(ms|s|m|h|d|w|y)$/i;
-    const match = normalizedInput.match(regex);
-    if (!match)
-        throw new Error(`Invalid time format: ${input}`);
-    const value = parseFloat(match[1]);
-    const unit = match[2].toLowerCase();
-    const multipliers = {
-        ms: 1,
-        s: 1000,
-        m: 60000,
-        h: 3600000,
-        d: 86400000,
-        w: 604800000,
-        y: 31557600000,
-    };
-    return value * multipliers[unit];
-}
-//# sourceMappingURL=auth.controller.helpers.js.map

package/dist/es2020/modules/base/base.controller.js

@@ -1,151 +0,0 @@
-import catchAsync from "../error-handler/utils/catch-async";
-import APIFeatures from "../../utils/features/api.features";
-import { BaseService } from "./base.service";
-import AppError from "../error-handler/utils/app-error";
-import { kebabCase, pascalCase } from "../../utils/helpers/change-case.helpers";
-import { getModelModules, getModels } from "../../utils/helpers/models.helpers";
-import { getAppRoutes } from "./utils/helpers/base.controller.helpers";
-import pluralize from "pluralize";
-export class BaseController {
-    constructor(modelName) {
-        this.createOne = catchAsync(async (req, res, next) => {
-            const data = await this.service.createOne(req.body, req.prismaQueryOptions);
-            if (this.middlewares.afterCreateOne) {
-                req.responseData = { data };
-                req.responseStatus = 201;
-                return next();
-            }
-            res.status(201).json({ data });
-        });
-        this.createMany = catchAsync(async (req, res, next) => {
-            const data = await this.service.createMany(req.body, req.prismaQueryOptions);
-            if (!data) {
-                return next(new AppError("Failed to create the resources. Please check your input.", 400));
-            }
-            if (this.middlewares.afterCreateMany) {
-                req.responseData = { data };
-                req.responseStatus = 201;
-                return next();
-            }
-            res.status(201).json({ data });
-        });
-        this.findMany = catchAsync(async (req, res, next) => {
-            const { filters: { where, ...queryOptions }, } = new APIFeatures(req, this.modelName)
-                .filter()
-                .sort()
-                .limitFields()
-                .paginate();
-            const [data, total] = (await Promise.all([
-                this.service.findMany(where, queryOptions),
-                this.service.count(where),
-            ]));
-            if (this.middlewares.afterFindMany) {
-                req.responseData = { total, results: data.length, data };
-                req.responseStatus = 200;
-                return next();
-            }
-            res.status(200).json({ total, results: data.length, data });
-        });
-        this.findOne = catchAsync(async (req, res, next) => {
-            const data = await this.service.findOne(req.params, req.prismaQueryOptions);
-            if (!data) {
-                if (Object.keys(req.params).length === 1 &&
-                    "id" in req.params &&
-                    req.params.id !== "me") {
-                    return next(new AppError(`${pascalCase(String(this.modelName))} with ID ${req.params?.id} not found`, 404, {}, "not_found"));
-                }
-                else {
-                    return next(new AppError(`${pascalCase(String(this.modelName))} not found`, 404, {}, "not_found"));
-                }
-            }
-            if (this.middlewares.afterFindOne) {
-                req.responseData = { data };
-                req.responseStatus = 200;
-                return next();
-            }
-            res.status(200).json({ data });
-        });
-        this.updateOne = catchAsync(async (req, res, next) => {
-            const data = await this.service.updateOne(req.params, req.body, req.prismaQueryOptions);
-            if (!data) {
-                if (Object.keys(req.params).length === 1 && "id" in req.params) {
-                    return next(new AppError(`${pascalCase(String(this.modelName))} with ID ${req.params?.id} not found`, 404, {}, "not_found"));
-                }
-                else {
-                    return next(new AppError(`${pascalCase(String(this.modelName))} not found`, 404, {}, "not_found"));
-                }
-            }
-            if (this.middlewares.afterUpdateOne) {
-                req.responseData = { data };
-                req.responseStatus = 200;
-                return next();
-            }
-            res.status(200).json({ data });
-        });
-        this.updateMany = catchAsync(async (req, res, next) => {
-            if (!Object.keys(req.query).some((key) => key !== "prismaQueryOptions")) {
-                return next(new AppError("Filter criteria not provided for bulk update.", 400));
-            }
-            req.query.filterMode = req.query?.filterMode || "AND";
-            const { filters: { where, ...queryOptions }, } = new APIFeatures(req, this.modelName).filter().sort();
-            delete queryOptions.include;
-            const data = (await this.service.updateMany(where, req.body, queryOptions));
-            if (!data || data.count === 0)
-                return next(new AppError(`${pluralize(pascalCase(String(this.modelName)))} not found`, 404));
-            if (this.middlewares.afterUpdateMany) {
-                req.responseData = { results: data.count, data };
-                req.responseStatus = 200;
-                return next();
-            }
-            res.status(200).json({ results: data.count, data });
-        });
-        this.deleteOne = catchAsync(async (req, res, next) => {
-            const data = await this.service.deleteOne(req.params);
-            if (!data) {
-                if (Object.keys(req.params).length === 1 && "id" in req.params) {
-                    return next(new AppError(`${pascalCase(String(this.modelName))} with ID ${req.params?.id} not found`, 404, {}, "not_found"));
-                }
-                else {
-                    return next(new AppError(`${pascalCase(String(this.modelName))} not found`, 404, {}, "not_found"));
-                }
-            }
-            if (this.middlewares.afterDeleteOne) {
-                req.additionalData = { data };
-                req.responseStatus = 204;
-                return next();
-            }
-            res.status(204).send();
-        });
-        this.deleteMany = catchAsync(async (req, res, next) => {
-            if (!Object.keys(req.query).some((key) => key !== "prismaQueryOptions")) {
-                return next(new AppError("Filter criteria not provided for bulk deletion.", 400));
-            }
-            req.query.filterMode = req.query?.filterMode || "AND";
-            const { filters: { where }, } = new APIFeatures(req, this.modelName).filter().sort();
-            const data = await this.service.deleteMany(where);
-            if (!data || data.count === 0) {
-                return next(new AppError(`No records found to delete`, 404));
-            }
-            if (this.middlewares.afterDeleteMany) {
-                req.responseData = { results: data.count, data };
-                req.responseStatus = 200;
-                return next();
-            }
-            res.status(200).json({ results: data.count, data });
-        });
-        this.modelName = modelName;
-        this.service = new BaseService(modelName);
-        this.middlewares = getModelModules(modelName)?.middlewares || {};
-    }
-}
-export function getAvalibleRoutes(req, res, next) {
-    const routes = getAppRoutes();
-    res.json(routes);
-}
-export const getAvailableResources = catchAsync(async (req, res, next) => {
-    const models = getModels();
-    res.status(200).json({
-        data: [...models.map((model) => kebabCase(model)), "file-upload"],
-    });
-});
-//# sourceMappingURL=base.controller.js.map

package/dist/es2020/modules/base/base.controller.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"base.controller.js","sourceRoot":"","sources":["../../../../src/modules/base/base.controller.ts"],"names":[],"mappings":"AACA,OAAO,UAAU,MAAM,oCAAoC,CAAC;AAC5D,OAAO,WAAW,MAAM,mCAAmC,CAAC;AAC5D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,QAAQ,MAAM,kCAAkC,CAAC;AACxD,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,yCAAyC,CAAC;AAChF,OAAO,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,oCAAoC,CAAC;AAChF,OAAO,EAAE,YAAY,EAAE,MAAM,yCAAyC,CAAC;AACvE,OAAO,SAAS,MAAM,WAAW,CAAC;AA+DlC,MAAM,OAAO,cAAc;IAuBzB,YAAY,SAAiB;QAa7B,cAAS,GAAG,UAAU,CACpB,KAAK,EAAE,GAAiB,EAAE,GAAkB,EAAE,IAAuB,EAAE,EAAE;YACvE,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,SAAS,CACvC,GAAG,CAAC,IAAI,EACR,GAAG,CAAC,kBAAkB,CACvB,CAAC;YAEF,IAAI,IAAI,CAAC,WAAW,CAAC,cAAc,EAAE,CAAC;gBACpC,GAAG,CAAC,YAAY,GAAG,EAAE,IAAI,EAAE,CAAC;gBAC5B,GAAG,CAAC,cAAc,GAAG,GAAG,CAAC;gBACzB,OAAO,IAAI,EAAE,CAAC;YAChB,CAAC;YAED,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;QACjC,CAAC,CACF,CAAC;QASF,eAAU,GAAG,UAAU,CACrB,KAAK,EAAE,GAAiB,EAAE,GAAkB,EAAE,IAAuB,EAAE,EAAE;YACvE,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CACxC,GAAG,CAAC,IAAI,EACR,GAAG,CAAC,kBAAkB,CACvB,CAAC;YAEF,IAAI,CAAC,IAAI,EAAE,CAAC;gBACV,OAAO,IAAI,CACT,IAAI,QAAQ,CACV,0DAA0D,EAC1D,GAAG,CACJ,CACF,CAAC;YACJ,CAAC;YAED,IAAI,IAAI,CAAC,WAAW,CAAC,eAAe,EAAE,CAAC;gBACrC,GAAG,CAAC,YAAY,GAAG,EAAE,IAAI,EAAE,CAAC;gBAC5B,GAAG,CAAC,cAAc,GAAG,GAAG,CAAC;gBACzB,OAAO,IAAI,EAAE,CAAC;YAChB,CAAC;YAED,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;QACjC,CAAC,CACF,CAAC;QASF,aAAQ,GAAG,UAAU,CACnB,KAAK,EAAE,GAAiB,EAAE,GAAkB,EAAE,IAAuB,EAAE,EAAE;YACvE,MAAM,EACJ,OAAO,EAAE,EAAE,KAAK,EAAE,GAAG,YAAY,EAAE,GACpC,GAAG,IAAI,WAAW,CAAC,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC;iBACrC,MAAM,EAAE;iBACR,IAAI,EAAE;iBACN,WAAW,EAAE;iBACb,QAAQ,EAAE,CAAC;YAGd,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,GAAG,CAAC,MAAM,OAAO,CAAC,GAAG,CAAC;gBACvC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,EAAE,YAAY,CAAC;gBAC1C,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC;aAC1B,CAAC,CAAoC,CAAC;YAEvC,IAAI,IAAI,CAAC,WAAW,CAAC,aAAa,EAAE,CAAC;gBACnC,GAAG,CAAC,YAAY,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC;gBACzD,GAAG,CAAC,cAAc,GAAG,GAAG,CAAC;gBACzB,OAAO,IAAI,EAAE,CAAC;YAChB,CAAC;YAED,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;QAC9D,CAAC,CACF,CAAC;QASF,YAAO,GAAG,UAAU,CAClB,KAAK,EAAE,GAAiB,EAAE,GAAkB,EAAE,IAAuB,EAAE,EAAE;YACvE,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CACrC,GAAG,CAAC,MAAM,EACV,GAAG,CAAC,kBAAkB,CACvB,CAAC;YAEF,IAAI,CAAC,IAAI,EAAE,CAAC;gBACV,IACE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,MAAM,KAAK,CAAC;oBACpC,IAAI,IAAI,GAAG,CAAC,MAAM;oBAClB,GAAG,CAAC,MAAM,CAAC,EAAE,KAAK,IAAI,EACtB,CAAC;oBACD,OAAO,IAAI,CACT,IAAI,QAAQ,CACV,GAAG,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,YACnC,GAAG,CAAC,MAAM,EAAE,EACd,YAAY,EACZ,GAAG,EACH,EAAE,EACF,WAAW,CACZ,CACF,CAAC;gBACJ,CAAC;qBAAM,CAAC;oBACN,OAAO,IAAI,CACT,IAAI,QAAQ,CACV,GAAG,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,YAAY,EACjD,GAAG,EACH,EAAE,EACF,WAAW,CACZ,CACF,CAAC;gBACJ,CAAC;YACH,CAAC;YAED,IAAI,IAAI,CAAC,WAAW,CAAC,YAAY,EAAE,CAAC;gBAClC,GAAG,CAAC,YAAY,GAAG,EAAE,IAAI,EAAE,CAAC;gBAC5B,GAAG,CAAC,cAAc,GAAG,GAAG,CAAC;gBACzB,OAAO,IAAI,EAAE,CAAC;YAChB,CAAC;YAED,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;QACjC,CAAC,CACF,CAAC;QASF,cAAS,GAAG,UAAU,CACpB,KAAK,EAAE,GAAiB,EAAE,GAAkB,EAAE,IAAuB,EAAE,EAAE;YACvE,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,SAAS,CACvC,GAAG,CAAC,MAAM,EACV,GAAG,CAAC,IAAI,EACR,GAAG,CAAC,kBAAkB,CACvB,CAAC;YAEF,IAAI,CAAC,IAAI,EAAE,CAAC;gBACV,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;oBAC/D,OAAO,IAAI,CACT,IAAI,QAAQ,CACV,GAAG,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,YACnC,GAAG,CAAC,MAAM,EAAE,EACd,YAAY,EACZ,GAAG,EACH,EAAE,EACF,WAAW,CACZ,CACF,CAAC;gBACJ,CAAC;qBAAM,CAAC;oBACN,OAAO,IAAI,CACT,IAAI,QAAQ,CACV,GAAG,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,YAAY,EACjD,GAAG,EACH,EAAE,EACF,WAAW,CACZ,CACF,CAAC;gBACJ,CAAC;YACH,CAAC;YAED,IAAI,IAAI,CAAC,WAAW,CAAC,cAAc,EAAE,CAAC;gBACpC,GAAG,CAAC,YAAY,GAAG,EAAE,IAAI,EAAE,CAAC;gBAC5B,GAAG,CAAC,cAAc,GAAG,GAAG,CAAC;gBACzB,OAAO,IAAI,EAAE,CAAC;YAChB,CAAC;YAED,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;QACjC,CAAC,CACF,CAAC;QASF,eAAU,GAAG,UAAU,CACrB,KAAK,EAAE,GAAiB,EAAE,GAAkB,EAAE,IAAuB,EAAE,EAAE;YACvE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,KAAK,oBAAoB,CAAC,EAAE,CAAC;gBACxE,OAAO,IAAI,CACT,IAAI,QAAQ,CAAC,+CAA+C,EAAE,GAAG,CAAC,CACnE,CAAC;YACJ,CAAC;YAED,GAAG,CAAC,KAAK,CAAC,UAAU,GAAG,GAAG,CAAC,KAAK,EAAE,UAAU,IAAI,KAAK,CAAC;YACtD,MAAM,EACJ,OAAO,EAAE,EAAE,KAAK,EAAE,GAAG,YAAY,EAAE,GACpC,GAAG,IAAI,WAAW,CAAC,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC;YACzD,OAAO,YAAY,CAAC,OAAO,CAAC;YAE5B,MAAM,IAAI,GAAG,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CACzC,KAAK,EACL,GAAG,CAAC,IAAI,EACR,YAAY,CACb,CAAsB,CAAC;YAExB,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,KAAK,KAAK,CAAC;gBAC3B,OAAO,IAAI,CACT,IAAI,QAAQ,CACV,GAAG,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,YAAY,EAC5D,GAAG,CACJ,CACF,CAAC;YAEJ,IAAI,IAAI,CAAC,WAAW,CAAC,eAAe,EAAE,CAAC;gBACrC,GAAG,CAAC,YAAY,GAAG,EAAE,OAAO,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC;gBACjD,GAAG,CAAC,cAAc,GAAG,GAAG,CAAC;gBACzB,OAAO,IAAI,EAAE,CAAC;YAChB,CAAC;YAED,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;QACtD,CAAC,CACF,CAAC;QASF,cAAS,GAAG,UAAU,CACpB,KAAK,EAAE,GAAiB,EAAE,GAAkB,EAAE,IAAuB,EAAE,EAAE;YACvE,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YAEtD,IAAI,CAAC,IAAI,EAAE,CAAC;gBACV,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;oBAC/D,OAAO,IAAI,CACT,IAAI,QAAQ,CACV,GAAG,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,YACnC,GAAG,CAAC,MAAM,EAAE,EACd,YAAY,EACZ,GAAG,EACH,EAAE,EACF,WAAW,CACZ,CACF,CAAC;gBACJ,CAAC;qBAAM,CAAC;oBACN,OAAO,IAAI,CACT,IAAI,QAAQ,CACV,GAAG,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,YAAY,EACjD,GAAG,EACH,EAAE,EACF,WAAW,CACZ,CACF,CAAC;gBACJ,CAAC;YACH,CAAC;YAED,IAAI,IAAI,CAAC,WAAW,CAAC,cAAc,EAAE,CAAC;gBACpC,GAAG,CAAC,cAAc,GAAG,EAAE,IAAI,EAAE,CAAC;gBAC9B,GAAG,CAAC,cAAc,GAAG,GAAG,CAAC;gBACzB,OAAO,IAAI,EAAE,CAAC;YAChB,CAAC;YAED,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;QACzB,CAAC,CACF,CAAC;QASF,eAAU,GAAG,UAAU,CACrB,KAAK,EAAE,GAAiB,EAAE,GAAkB,EAAE,IAAuB,EAAE,EAAE;YACvE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,KAAK,oBAAoB,CAAC,EAAE,CAAC;gBACxE,OAAO,IAAI,CACT,IAAI,QAAQ,CAAC,iDAAiD,EAAE,GAAG,CAAC,CACrE,CAAC;YACJ,CAAC;YAED,GAAG,CAAC,KAAK,CAAC,UAAU,GAAG,GAAG,CAAC,KAAK,EAAE,UAAU,IAAI,KAAK,CAAC;YACtD,MAAM,EACJ,OAAO,EAAE,EAAE,KAAK,EAAE,GACnB,GAAG,IAAI,WAAW,CAAC,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC;YAEzD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;YAElD,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,KAAK,KAAK,CAAC,EAAE,CAAC;gBAC9B,OAAO,IAAI,CAAC,IAAI,QAAQ,CAAC,4BAA4B,EAAE,GAAG,CAAC,CAAC,CAAC;YAC/D,CAAC;YAED,IAAI,IAAI,CAAC,WAAW,CAAC,eAAe,EAAE,CAAC;gBACrC,GAAG,CAAC,YAAY,GAAG,EAAE,OAAO,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC;gBACjD,GAAG,CAAC,cAAc,GAAG,GAAG,CAAC;gBACzB,OAAO,IAAI,EAAE,CAAC;YAChB,CAAC;YAED,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;QACtD,CAAC,CACF,CAAC;QAhUA,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,OAAO,GAAG,IAAI,WAAW,CAAC,SAAS,CAAC,CAAC;QAC1C,IAAI,CAAC,WAAW,GAAG,eAAe,CAAC,SAAS,CAAC,EAAE,WAAW,IAAI,EAAE,CAAC;IACnE,CAAC;CA8TF;AASD,MAAM,UAAU,iBAAiB,CAC/B,GAAiB,EACjB,GAAkB,EAClB,IAAuB;IAEvB,MAAM,MAAM,GAAG,YAAY,EAAE,CAAC;IAE9B,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AACnB,CAAC;AASD,MAAM,CAAC,MAAM,qBAAqB,GAAG,UAAU,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;IACvE,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;IAC3B,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;QACnB,IAAI,EAAE,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,aAAa,CAAC;KAClE,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { ArkosRequest, ArkosResponse, ArkosNextFunction } from \"../../types\";\nimport catchAsync from \"../error-handler/utils/catch-async\";\nimport APIFeatures from \"../../utils/features/api.features\";\nimport { BaseService } from \"./base.service\";\nimport AppError from \"../error-handler/utils/app-error\";\nimport { kebabCase, pascalCase } from \"../../utils/helpers/change-case.helpers\";\nimport { getModelModules, getModels } from \"../../utils/helpers/models.helpers\";\nimport { getAppRoutes } from \"./utils/helpers/base.controller.helpers\";\nimport pluralize from \"pluralize\";\n\n/**\n * The `BaseController` class provides standardized RESTful API endpoints\n * for any Prisma model based on its name. It supports automatic integration\n * with Prisma services and dynamic middleware hooks for extending behaviors.\n *\n * This controller includes:\n * - `createOne` / `createMany`\n * - `findOne` / `findMany`\n * - `updateOne` / `updateMany`\n * - `deleteOne` / `deleteMany`\n *\n * It handles:\n * - Prisma query options\n * - APIFeatures: filtering, sorting, pagination, field limiting\n * - Middleware hooks: `afterCreateOne`, `afterUpdateMany`, etc.\n *\n * @class BaseController\n * @example\n *\n * **Extending the Controller**\n *\n * ```ts\n * // src/modules/product/product.controller.ts\n *\n * class ProductController extends BaseController {}\n *\n * const productController = new ProcutController(\"product\")\n *\n * export default productController\n *\n * ```\n * **Using in custom Router**\n *\n * ```ts\n * // src/modules/product/product.router.ts\n *\n * import { Router } from \"express\";\n * import productController from \"./product.controller\";\n *\n * const productRouter = Router();\n *\n * // Arkos handles this base endpoints by default it\n * // is just an example\n *\n * productRouter.post(\"/\", productController.createOne);\n * productRouter.get(\"/\", productController.findMany);\n * productRouter.get(\"/:id\", productController.findOne);\n * productRouter.patch(\"/:id\", productController.updateOne);\n * productRouter.delete(\"/:id\", productController.deleteOne);\n *\n * export default productRouter\n * ```\n *\n * @param {string} modelName - The Prisma model name this controller handles.\n *\n * @see {@link https://www.arkosjs.com/docs/api-reference/the-base-controller-class}\n *--\n *\n * **See about how Arkos handles routers**\n * @see {@link https://www.arkosjs.com/docs/guide/adding-custom-routers}\n */\nexport class BaseController {\n  /**\n   * Service instance to handle business logic operations\n   * @private\n   */\n  private service: BaseService<any>;\n\n  /**\n   * Name of the model this controller handles\n   * @private\n   */\n  private modelName: string;\n\n  /**\n   * Model-specific middlewares loaded from model modules\n   * @private\n   */\n  private middlewares: any;\n\n  /**\n   * Creates a new BaseController instance\n   * @param {string} modelName - The name of the model for which this controller will handle operations\n   */\n  constructor(modelName: string) {\n    this.modelName = modelName;\n    this.service = new BaseService(modelName);\n    this.middlewares = getModelModules(modelName)?.middlewares || {};\n  }\n\n  /**\n   * Creates a single resource\n   * @param {ArkosRequest} req - Express request object\n   * @param {ArkosResponse} res - Express response object\n   * @param {ArkosNextFunction} next - Express next function\n   * @returns {Promise<void>}\n   */\n  createOne = catchAsync(\n    async (req: ArkosRequest, res: ArkosResponse, next: ArkosNextFunction) => {\n      const data = await this.service.createOne(\n        req.body,\n        req.prismaQueryOptions\n      );\n\n      if (this.middlewares.afterCreateOne) {\n        req.responseData = { data };\n        req.responseStatus = 201;\n        return next();\n      }\n\n      res.status(201).json({ data });\n    }\n  );\n\n  /**\n   * Creates multiple resources in a single operation\n   * @param {ArkosRequest} req - Express request object\n   * @param {ArkosResponse} res - Express response object\n   * @param {ArkosNextFunction} next - Express next function\n   * @returns {Promise<void>}\n   */\n  createMany = catchAsync(\n    async (req: ArkosRequest, res: ArkosResponse, next: ArkosNextFunction) => {\n      const data = await this.service.createMany(\n        req.body,\n        req.prismaQueryOptions\n      );\n\n      if (!data) {\n        return next(\n          new AppError(\n            \"Failed to create the resources. Please check your input.\",\n            400\n          )\n        );\n      }\n\n      if (this.middlewares.afterCreateMany) {\n        req.responseData = { data };\n        req.responseStatus = 201;\n        return next();\n      }\n\n      res.status(201).json({ data });\n    }\n  );\n\n  /**\n   * Retrieves multiple resources with filtering, sorting, pagination, and field selection\n   * @param {ArkosRequest} req - Express request object\n   * @param {ArkosResponse} res - Express response object\n   * @param {ArkosNextFunction} next - Express next function\n   * @returns {Promise<void>}\n   */\n  findMany = catchAsync(\n    async (req: ArkosRequest, res: ArkosResponse, next: ArkosNextFunction) => {\n      const {\n        filters: { where, ...queryOptions },\n      } = new APIFeatures(req, this.modelName)\n        .filter()\n        .sort()\n        .limitFields()\n        .paginate();\n\n      // Execute both operations separately\n      const [data, total] = (await Promise.all([\n        this.service.findMany(where, queryOptions),\n        this.service.count(where),\n      ])) as [Record<string, any>[], number];\n\n      if (this.middlewares.afterFindMany) {\n        req.responseData = { total, results: data.length, data };\n        req.responseStatus = 200;\n        return next();\n      }\n\n      res.status(200).json({ total, results: data.length, data });\n    }\n  );\n\n  /**\n   * Retrieves a single resource by its identifier\n   * @param {ArkosRequest} req - Express request object\n   * @param {ArkosResponse} res - Express response object\n   * @param {ArkosNextFunction} next - Express next function\n   * @returns {Promise<void>}\n   */\n  findOne = catchAsync(\n    async (req: ArkosRequest, res: ArkosResponse, next: ArkosNextFunction) => {\n      const data = await this.service.findOne(\n        req.params,\n        req.prismaQueryOptions\n      );\n\n      if (!data) {\n        if (\n          Object.keys(req.params).length === 1 &&\n          \"id\" in req.params &&\n          req.params.id !== \"me\"\n        ) {\n          return next(\n            new AppError(\n              `${pascalCase(String(this.modelName))} with ID ${\n                req.params?.id\n              } not found`,\n              404,\n              {},\n              \"not_found\"\n            )\n          );\n        } else {\n          return next(\n            new AppError(\n              `${pascalCase(String(this.modelName))} not found`,\n              404,\n              {},\n              \"not_found\"\n            )\n          );\n        }\n      }\n\n      if (this.middlewares.afterFindOne) {\n        req.responseData = { data };\n        req.responseStatus = 200;\n        return next();\n      }\n\n      res.status(200).json({ data });\n    }\n  );\n\n  /**\n   * Updates a single resource by its identifier\n   * @param {ArkosRequest} req - Express request object\n   * @param {ArkosResponse} res - Express response object\n   * @param {ArkosNextFunction} next - Express next function\n   * @returns {Promise<void>}\n   */\n  updateOne = catchAsync(\n    async (req: ArkosRequest, res: ArkosResponse, next: ArkosNextFunction) => {\n      const data = await this.service.updateOne(\n        req.params,\n        req.body,\n        req.prismaQueryOptions\n      );\n\n      if (!data) {\n        if (Object.keys(req.params).length === 1 && \"id\" in req.params) {\n          return next(\n            new AppError(\n              `${pascalCase(String(this.modelName))} with ID ${\n                req.params?.id\n              } not found`,\n              404,\n              {},\n              \"not_found\"\n            )\n          );\n        } else {\n          return next(\n            new AppError(\n              `${pascalCase(String(this.modelName))} not found`,\n              404,\n              {},\n              \"not_found\"\n            )\n          );\n        }\n      }\n\n      if (this.middlewares.afterUpdateOne) {\n        req.responseData = { data };\n        req.responseStatus = 200;\n        return next();\n      }\n\n      res.status(200).json({ data });\n    }\n  );\n\n  /**\n   * Updates multiple resources that match specified criteria\n   * @param {ArkosRequest} req - Express request object\n   * @param {ArkosResponse} res - Express response object\n   * @param {ArkosNextFunction} next - Express next function\n   * @returns {Promise<void>}\n   */\n  updateMany = catchAsync(\n    async (req: ArkosRequest, res: ArkosResponse, next: ArkosNextFunction) => {\n      if (!Object.keys(req.query).some((key) => key !== \"prismaQueryOptions\")) {\n        return next(\n          new AppError(\"Filter criteria not provided for bulk update.\", 400)\n        );\n      }\n\n      req.query.filterMode = req.query?.filterMode || \"AND\";\n      const {\n        filters: { where, ...queryOptions },\n      } = new APIFeatures(req, this.modelName).filter().sort();\n      delete queryOptions.include;\n\n      const data = (await this.service.updateMany(\n        where,\n        req.body,\n        queryOptions\n      )) as { count: number };\n\n      if (!data || data.count === 0)\n        return next(\n          new AppError(\n            `${pluralize(pascalCase(String(this.modelName)))} not found`,\n            404\n          )\n        );\n\n      if (this.middlewares.afterUpdateMany) {\n        req.responseData = { results: data.count, data };\n        req.responseStatus = 200;\n        return next();\n      }\n\n      res.status(200).json({ results: data.count, data });\n    }\n  );\n\n  /**\n   * Deletes a single resource by its identifier\n   * @param {ArkosRequest} req - Express request object\n   * @param {ArkosResponse} res - Express response object\n   * @param {ArkosNextFunction} next - Express next function\n   * @returns {Promise<void>}\n   */\n  deleteOne = catchAsync(\n    async (req: ArkosRequest, res: ArkosResponse, next: ArkosNextFunction) => {\n      const data = await this.service.deleteOne(req.params);\n\n      if (!data) {\n        if (Object.keys(req.params).length === 1 && \"id\" in req.params) {\n          return next(\n            new AppError(\n              `${pascalCase(String(this.modelName))} with ID ${\n                req.params?.id\n              } not found`,\n              404,\n              {},\n              \"not_found\"\n            )\n          );\n        } else {\n          return next(\n            new AppError(\n              `${pascalCase(String(this.modelName))} not found`,\n              404,\n              {},\n              \"not_found\"\n            )\n          );\n        }\n      }\n\n      if (this.middlewares.afterDeleteOne) {\n        req.additionalData = { data };\n        req.responseStatus = 204;\n        return next();\n      }\n\n      res.status(204).send();\n    }\n  );\n\n  /**\n   * Deletes multiple resources that match specified criteria\n   * @param {ArkosRequest} req - Express request object\n   * @param {ArkosResponse} res - Express response object\n   * @param {ArkosNextFunction} next - Express next function\n   * @returns {Promise<void>}\n   */\n  deleteMany = catchAsync(\n    async (req: ArkosRequest, res: ArkosResponse, next: ArkosNextFunction) => {\n      if (!Object.keys(req.query).some((key) => key !== \"prismaQueryOptions\")) {\n        return next(\n          new AppError(\"Filter criteria not provided for bulk deletion.\", 400)\n        );\n      }\n\n      req.query.filterMode = req.query?.filterMode || \"AND\";\n      const {\n        filters: { where },\n      } = new APIFeatures(req, this.modelName).filter().sort();\n\n      const data = await this.service.deleteMany(where);\n\n      if (!data || data.count === 0) {\n        return next(new AppError(`No records found to delete`, 404));\n      }\n\n      if (this.middlewares.afterDeleteMany) {\n        req.responseData = { results: data.count, data };\n        req.responseStatus = 200;\n        return next();\n      }\n\n      res.status(200).json({ results: data.count, data });\n    }\n  );\n}\n\n/**\n * Returns a list of all registered API routes in the Express application\n * @param {ArkosRequest} req - Express request object\n * @param {ArkosResponse} res - Express response object\n * @param {ArkosNextFunction} next - Express next function\n * @returns {void}\n */\nexport function getAvalibleRoutes(\n  req: ArkosRequest,\n  res: ArkosResponse,\n  next: ArkosNextFunction\n) {\n  const routes = getAppRoutes();\n\n  res.json(routes);\n}\n\n/**\n * Returns a list of all available resource endpoints based on the application's models\n * @param {ArkosRequest} req - Express request object\n * @param {ArkosResponse} res - Express response object\n * @param {ArkosNextFunction} next - Express next function\n * @returns {Promise<void>}\n */\nexport const getAvailableResources = catchAsync(async (req, res, next) => {\n  const models = getModels();\n  res.status(200).json({\n    data: [...models.map((model) => kebabCase(model)), \"file-upload\"],\n  });\n});\n"]}

package/dist/es2020/modules/base/base.middlewares.js

@@ -1,81 +0,0 @@
-import { getArkosConfig } from "../../server";
-import deepmerge from "../../utils/helpers/deepmerge.helper";
-import { catchAsync } from "../../exports/error-handler";
-import validateDto from "../../utils/validate-dto";
-import validateSchema from "../../utils/validate-schema";
-import { resolvePrismaQueryOptions } from "./utils/helpers/base.middlewares.helpers";
-export function callNext(req, res, next) {
-    next();
-}
-export function sendResponse(req, res, next) {
-    if (Number(req?.responseStatus) === 204)
-        res.status(Number(req?.responseStatus)).send();
-    else if (req.responseData && req?.responseStatus)
-        res.status(Number(req?.responseStatus)).json(req.responseData);
-    else if (Number(req?.responseStatus) && !req.responseData)
-        res.status(Number(req?.responseStatus)).send();
-    else
-        res
-            .status(500)
-            .json({ message: "No status or data attached to the response" });
-}
-export function addRouteMiddlwaresAndConfigs() { }
-export function addPrismaQueryOptionsToRequest(prismaQueryOptions, action) {
-    return (req, res, next) => {
-        const configs = getArkosConfig();
-        const resolvedOptions = resolvePrismaQueryOptions(prismaQueryOptions, action);
-        const requestQueryOptions = configs?.request?.parameters
-            ?.allowDangerousPrismaQueryOptions
-            ? JSON.parse(req.query?.prismaQueryOptions || "{}")
-            : {};
-        req.prismaQueryOptions = deepmerge(resolvedOptions, requestQueryOptions);
-        next();
-    };
-}
-export function handleRequestLogs(req, res, next) {
-    const startTime = Date.now();
-    const methodColors = {
-        GET: "\x1b[36m",
-        POST: "\x1b[32m",
-        PUT: "\x1b[33m",
-        PATCH: "\x1b[33m",
-        DELETE: "\x1b[31m",
-        HEAD: "\x1b[34m",
-        OPTIONS: "\x1b[34m",
-    };
-    const getStatusColor = (statusCode) => {
-        if (statusCode >= 200 && statusCode < 300)
-            return "\x1b[32m";
-        if (statusCode >= 300 && statusCode < 400)
-            return "\x1b[33m";
-        if (statusCode >= 400 && statusCode < 500)
-            return "\x1b[33m";
-        if (statusCode >= 500)
-            return "\x1b[31m";
-        return "\x1b[0m";
-    };
-    res.on("finish", () => {
-        const duration = Date.now() - startTime;
-        const now = new Date();
-        const time = now.toTimeString().split(" ")[0];
-        const methodColor = methodColors[req.method] || "\x1b[0m";
-        const statusColor = getStatusColor(res.statusCode);
-        console.info(`[\x1b[36mINFO\x1b[0m] \x1b[90m${time}\x1b[0m ${methodColor}${req.method}\x1b[0m ${decodeURIComponent(req.originalUrl)} ${statusColor}${res.statusCode}\x1b[0m \x1b[35m${duration}ms\x1b[0m`);
-    });
-    next();
-}
-export function handleRequestBodyValidationAndTransformation(schemaOrDtoClass, classValidatorValidationOptions) {
-    return catchAsync(async (req, res, next) => {
-        const validationConfigs = getArkosConfig()?.validation;
-        let body = req.body;
-        if (validationConfigs?.resolver === "class-validator" && schemaOrDtoClass)
-            req.body = await validateDto(schemaOrDtoClass, body, deepmerge({
-                whitelist: true,
-                ...classValidatorValidationOptions,
-            }, validationConfigs?.validationOptions || {}));
-        else if (validationConfigs?.resolver === "zod" && schemaOrDtoClass)
-            req.body = await validateSchema(schemaOrDtoClass, body);
-        next();
-    });
-}
-//# sourceMappingURL=base.middlewares.js.map

package/dist/es2020/modules/base/base.middlewares.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"base.middlewares.js","sourceRoot":"","sources":["../../../../src/modules/base/base.middlewares.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,SAAS,MAAM,sCAAsC,CAAC;AAC7D,OAAO,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AACzD,OAAO,WAAW,MAAM,0BAA0B,CAAC;AACnD,OAAO,cAAc,MAAM,6BAA6B,CAAC;AAIzD,OAAO,EAAE,yBAAyB,EAAE,MAAM,0CAA0C,CAAC;AAErF,MAAM,UAAU,QAAQ,CAAC,GAAY,EAAE,GAAa,EAAE,IAAkB;IACtE,IAAI,EAAE,CAAC;AACT,CAAC;AAED,MAAM,UAAU,YAAY,CAC1B,GAAiB,EACjB,GAAkB,EAClB,IAAuB;IAEvB,IAAI,MAAM,CAAC,GAAG,EAAE,cAAc,CAAC,KAAK,GAAG;QACrC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;SAC5C,IAAI,GAAG,CAAC,YAAY,IAAI,GAAG,EAAE,cAAc;QAC9C,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;SAC5D,IAAI,MAAM,CAAC,GAAG,EAAE,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,YAAY;QACvD,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;;QAE/C,GAAG;aACA,MAAM,CAAC,GAAG,CAAC;aACX,IAAI,CAAC,EAAE,OAAO,EAAE,4CAA4C,EAAE,CAAC,CAAC;AACvE,CAAC;AAED,MAAM,UAAU,4BAA4B,KAAI,CAAC;AAkBjD,MAAM,UAAU,8BAA8B,CAC5C,kBAAqE,EACrE,MAAyB;IAEzB,OAAO,CAAC,GAAiB,EAAE,GAAkB,EAAE,IAAkB,EAAE,EAAE;QACnE,MAAM,OAAO,GAAG,cAAc,EAAE,CAAC;QAGjC,MAAM,eAAe,GAAG,yBAAyB,CAC/C,kBAAkB,EAClB,MAAM,CACP,CAAC;QAGF,MAAM,mBAAmB,GAAG,OAAO,EAAE,OAAO,EAAE,UAAU;YACtD,EAAE,gCAAgC;YAClC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAE,GAAG,CAAC,KAAK,EAAE,kBAA6B,IAAI,IAAI,CAAC;YAC/D,CAAC,CAAC,EAAE,CAAC;QAGP,GAAG,CAAC,kBAAkB,GAAG,SAAS,CAAC,eAAe,EAAE,mBAAmB,CAAC,CAAC;QAEzE,IAAI,EAAE,CAAC;IACT,CAAC,CAAC;AACJ,CAAC;AAMD,MAAM,UAAU,iBAAiB,CAC/B,GAAY,EACZ,GAAa,EACb,IAAkB;IAElB,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAG7B,MAAM,YAAY,GAAG;QACnB,GAAG,EAAE,UAAU;QACf,IAAI,EAAE,UAAU;QAChB,GAAG,EAAE,UAAU;QACf,KAAK,EAAE,UAAU;QACjB,MAAM,EAAE,UAAU;QAClB,IAAI,EAAE,UAAU;QAChB,OAAO,EAAE,UAAU;KACpB,CAAC;IAGF,MAAM,cAAc,GAAG,CAAC,UAAkB,EAAE,EAAE;QAC5C,IAAI,UAAU,IAAI,GAAG,IAAI,UAAU,GAAG,GAAG;YAAE,OAAO,UAAU,CAAC;QAC7D,IAAI,UAAU,IAAI,GAAG,IAAI,UAAU,GAAG,GAAG;YAAE,OAAO,UAAU,CAAC;QAC7D,IAAI,UAAU,IAAI,GAAG,IAAI,UAAU,GAAG,GAAG;YAAE,OAAO,UAAU,CAAC;QAC7D,IAAI,UAAU,IAAI,GAAG;YAAE,OAAO,UAAU,CAAC;QACzC,OAAO,SAAS,CAAC;IACnB,CAAC,CAAC;IAEF,GAAG,CAAC,EAAE,CAAC,QAAQ,EAAE,GAAG,EAAE;QACpB,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC;QAGxC,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,MAAM,IAAI,GAAG,GAAG,CAAC,YAAY,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QAE9C,MAAM,WAAW,GACf,YAAY,CAAC,GAAG,CAAC,MAAmC,CAAC,IAAI,SAAS,CAAC;QACrE,MAAM,WAAW,GAAG,cAAc,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAEnD,OAAO,CAAC,IAAI,CACV,iCAAiC,IAAI,WAAW,WAAW,GACzD,GAAG,CAAC,MACN,WAAW,kBAAkB,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,WAAW,GAC3D,GAAG,CAAC,UACN,mBAAmB,QAAQ,WAAW,CACvC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,IAAI,EAAE,CAAC;AACT,CAAC;AAcD,MAAM,UAAU,4CAA4C,CAC1D,gBAAqD,EACrD,+BAAkD;IAElD,OAAO,UAAU,CACf,KAAK,EAAE,GAAiB,EAAE,GAAkB,EAAE,IAAuB,EAAE,EAAE;QACvE,MAAM,iBAAiB,GAAG,cAAc,EAAE,EAAE,UAAU,CAAC;QACvD,IAAI,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;QAEpB,IAAI,iBAAiB,EAAE,QAAQ,KAAK,iBAAiB,IAAI,gBAAgB;YACvE,GAAG,CAAC,IAAI,GAAG,MAAM,WAAW,CAC1B,gBAAuC,EACvC,IAAI,EACJ,SAAS,CACP;gBACE,SAAS,EAAE,IAAI;gBACf,GAAG,+BAA+B;aACnC,EACD,iBAAiB,EAAE,iBAAiB,IAAI,EAAE,CAC3C,CACF,CAAC;aACC,IAAI,iBAAiB,EAAE,QAAQ,KAAK,KAAK,IAAI,gBAAgB;YAChE,GAAG,CAAC,IAAI,GAAG,MAAM,cAAc,CAAC,gBAAgC,EAAE,IAAI,CAAC,CAAC;QAE1E,IAAI,EAAE,CAAC;IACT,CAAC,CACF,CAAC;AACJ,CAAC","sourcesContent":["import { NextFunction, Request, Response } from \"express\";\nimport {\n  PrismaQueryOptions,\n  ArkosNextFunction,\n  ArkosRequest,\n  ArkosRequestHandler,\n  ArkosResponse,\n  AuthPrismaQueryOptions,\n} from \"../../types\";\nimport { getArkosConfig } from \"../../server\";\nimport deepmerge from \"../../utils/helpers/deepmerge.helper\";\nimport { catchAsync } from \"../../exports/error-handler\";\nimport validateDto from \"../../utils/validate-dto\";\nimport validateSchema from \"../../utils/validate-schema\";\nimport { ZodSchema } from \"zod\";\nimport { ClassConstructor } from \"class-transformer\";\nimport { ValidatorOptions } from \"class-validator\";\nimport { resolvePrismaQueryOptions } from \"./utils/helpers/base.middlewares.helpers\";\n\nexport function callNext(req: Request, res: Response, next: NextFunction) {\n  next();\n}\n\nexport function sendResponse(\n  req: ArkosRequest,\n  res: ArkosResponse,\n  next: ArkosNextFunction\n) {\n  if (Number(req?.responseStatus) === 204)\n    res.status(Number(req?.responseStatus)).send();\n  else if (req.responseData && req?.responseStatus)\n    res.status(Number(req?.responseStatus)).json(req.responseData);\n  else if (Number(req?.responseStatus) && !req.responseData)\n    res.status(Number(req?.responseStatus)).send();\n  else\n    res\n      .status(500)\n      .json({ message: \"No status or data attached to the response\" });\n}\n\nexport function addRouteMiddlwaresAndConfigs() {}\n\n/**\n * Type representing all possible actions that can be performed on a controller\n * Combines both standard CRUD operations and auth-specific operations\n */\nexport type ControllerActions =\n  | keyof PrismaQueryOptions<any>\n  | keyof Omit<AuthPrismaQueryOptions<any>, keyof PrismaQueryOptions<any>>;\n\n/**\n * Middleware to add Prisma query options to the request's query parameters.\n *\n * @template T - The type of the Prisma model.\n * @param {PrismaQueryOptions<T> | AuthPrismaQueryOptions<T>} prismaQueryOptions - The Prisma query options to attach.\n * @param {ControllerActions} action - The controller action to apply.\n * @returns A middleware function that attaches the query options to the request.\n */\nexport function addPrismaQueryOptionsToRequest<T extends Record<string, any>>(\n  prismaQueryOptions: PrismaQueryOptions<T> | AuthPrismaQueryOptions<T>,\n  action: ControllerActions\n) {\n  return (req: ArkosRequest, res: ArkosResponse, next: NextFunction) => {\n    const configs = getArkosConfig();\n\n    // Resolve and merge all applicable options using the helper\n    const resolvedOptions = resolvePrismaQueryOptions(\n      prismaQueryOptions,\n      action\n    );\n\n    // Parse and merge any dangerous query options from request if allowed\n    const requestQueryOptions = configs?.request?.parameters\n      ?.allowDangerousPrismaQueryOptions\n      ? JSON.parse((req.query?.prismaQueryOptions as string) || \"{}\")\n      : {};\n\n    // Final merge with request options having the highest priority\n    req.prismaQueryOptions = deepmerge(resolvedOptions, requestQueryOptions);\n\n    next();\n  };\n}\n\n/**\n * Logs request events with colored text such as errors, requests responses.\n *\n */\nexport function handleRequestLogs(\n  req: Request,\n  res: Response,\n  next: NextFunction\n) {\n  const startTime = Date.now(); // Capture the start time\n\n  // Define colors for each HTTP method\n  const methodColors = {\n    GET: \"\\x1b[36m\", // Cyan\n    POST: \"\\x1b[32m\", // Green\n    PUT: \"\\x1b[33m\", // Orange/Yellow\n    PATCH: \"\\x1b[33m\", // Orange/Yellow\n    DELETE: \"\\x1b[31m\", // Red\n    HEAD: \"\\x1b[34m\", // Blue\n    OPTIONS: \"\\x1b[34m\", // Blue\n  };\n\n  // Function to determine status code color\n  const getStatusColor = (statusCode: number) => {\n    if (statusCode >= 200 && statusCode < 300) return \"\\x1b[32m\"; // Green\n    if (statusCode >= 300 && statusCode < 400) return \"\\x1b[33m\"; // Orange/Yellow\n    if (statusCode >= 400 && statusCode < 500) return \"\\x1b[33m\"; // Red\n    if (statusCode >= 500) return \"\\x1b[31m\"; // White on Red background\n    return \"\\x1b[0m\"; // Default (no color)\n  };\n\n  res.on(\"finish\", () => {\n    const duration = Date.now() - startTime; // Calculate the time taken to process the request\n\n    // Get the current date and time\n    const now = new Date();\n    const time = now.toTimeString().split(\" \")[0]; // Format as HH:MM:SS\n\n    const methodColor =\n      methodColors[req.method as keyof typeof methodColors] || \"\\x1b[0m\"; // Default to no color\n    const statusColor = getStatusColor(res.statusCode); // Get the color for the status code\n\n    console.info(\n      `[\\x1b[36mINFO\\x1b[0m] \\x1b[90m${time}\\x1b[0m ${methodColor}${\n        req.method\n      }\\x1b[0m ${decodeURIComponent(req.originalUrl)} ${statusColor}${\n        res.statusCode\n      }\\x1b[0m \\x1b[35m${duration}ms\\x1b[0m`\n    );\n  });\n\n  next(); // Pass control to the next middleware or route handler\n}\n\n// Overload for 'auth'\nexport function handleRequestBodyValidationAndTransformation<T extends object>(\n  schemaOrDtoClass?: ClassConstructor<T>,\n  classValidatorValidationOptions?: ValidatorOptions\n): ArkosRequestHandler;\n\n// Overload for other models\nexport function handleRequestBodyValidationAndTransformation<T extends object>(\n  schemaOrDtoClass?: ZodSchema<T>\n): ArkosRequestHandler;\n\n// Implementation\nexport function handleRequestBodyValidationAndTransformation<T extends object>(\n  schemaOrDtoClass?: ZodSchema<T> | ClassConstructor<T>,\n  classValidatorValidationOptions?: ValidatorOptions\n) {\n  return catchAsync(\n    async (req: ArkosRequest, res: ArkosResponse, next: ArkosNextFunction) => {\n      const validationConfigs = getArkosConfig()?.validation;\n      let body = req.body;\n\n      if (validationConfigs?.resolver === \"class-validator\" && schemaOrDtoClass)\n        req.body = await validateDto(\n          schemaOrDtoClass as ClassConstructor<T>,\n          body,\n          deepmerge(\n            {\n              whitelist: true,\n              ...classValidatorValidationOptions,\n            },\n            validationConfigs?.validationOptions || {}\n          )\n        );\n      else if (validationConfigs?.resolver === \"zod\" && schemaOrDtoClass)\n        req.body = await validateSchema(schemaOrDtoClass as ZodSchema<T>, body);\n\n      next();\n    }\n  );\n}\n"]}

package/dist/es2020/modules/base/base.router.js

@@ -1,17 +0,0 @@
-import { Router } from "express";
-import { getAvalibleRoutes, getAvailableResources } from "./base.controller";
-import { getModels } from "../../utils/helpers/models.helpers";
-import authService from "../auth/auth.service";
-import { setupRouters } from "./utils/helpers/base.router.helpers";
-export async function getPrismaModelsRouter(arkosConfigs) {
-    const router = Router();
-    await Promise.all(setupRouters(getModels(), router, arkosConfigs));
-    return router;
-}
-export function getAvailableResourcesAndRoutesRouter() {
-    const router = Router();
-    router.get("/available-routes", authService?.authenticate, getAvalibleRoutes);
-    router.get("/available-resources", authService?.authenticate, getAvailableResources);
-    return router;
-}
-//# sourceMappingURL=base.router.js.map

package/dist/es2020/modules/base/base.router.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"base.router.js","sourceRoot":"","sources":["../../../../src/modules/base/base.router.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACjC,OAAO,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAC;AAC7E,OAAO,EAAE,SAAS,EAAE,MAAM,oCAAoC,CAAC;AAE/D,OAAO,WAAW,MAAM,sBAAsB,CAAC;AAE/C,OAAO,EAAE,YAAY,EAAE,MAAM,qCAAqC,CAAC;AAEnE,MAAM,CAAC,KAAK,UAAU,qBAAqB,CAAC,YAAyB;IACnE,MAAM,MAAM,GAAW,MAAM,EAAE,CAAC;IAEhC,MAAM,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,SAAS,EAAE,EAAE,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC;IAEnE,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,oCAAoC;IAClD,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC;IAExB,MAAM,CAAC,GAAG,CACR,mBAAmB,EACnB,WAAW,EAAE,YAAY,EAEzB,iBAAiB,CAClB,CAAC;IAEF,MAAM,CAAC,GAAG,CACR,sBAAsB,EACtB,WAAW,EAAE,YAAY,EAEzB,qBAAqB,CACtB,CAAC;IAEF,OAAO,MAAM,CAAC;AAChB,CAAC","sourcesContent":["import { Router } from \"express\";\nimport { getAvalibleRoutes, getAvailableResources } from \"./base.controller\";\nimport { getModels } from \"../../utils/helpers/models.helpers\";\n\nimport authService from \"../auth/auth.service\";\nimport { ArkosConfig } from \"../../types/arkos-config\";\nimport { setupRouters } from \"./utils/helpers/base.router.helpers\";\n\nexport async function getPrismaModelsRouter(arkosConfigs: ArkosConfig) {\n  const router: Router = Router();\n\n  await Promise.all(setupRouters(getModels(), router, arkosConfigs));\n\n  return router;\n}\n\nexport function getAvailableResourcesAndRoutesRouter(): Router {\n  const router = Router();\n  //\n  router.get(\n    \"/available-routes\",\n    authService?.authenticate,\n    // authService?.handleAccessControl({}, \"view\", \"\"),\n    getAvalibleRoutes\n  );\n\n  router.get(\n    \"/available-resources\",\n    authService?.authenticate,\n    // authService?.handleAccessControl({}, \"view\", \"\"),\n    getAvailableResources\n  );\n\n  return router;\n}\n"]}