feat: userroles and permission on dashboard recipe

CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html)
 
+## [unreleased]
+
+### Added
+
+-   Added User roles and permissions feature to dashboard recipe.
+
 ## [16.5.1] - 2023-11-15
 
 -   Fixes issue with `createResetPasswordLink` and `sendResetPasswordEmail` in thirdpartyemailpassword recipe.

lib/build/framework/fastify/index.d.ts

@@ -1,21 +1,18 @@
 // @ts-nocheck
 /// <reference types="node" />
 export type { SessionRequest } from "./framework";
-export declare const plugin: import("fastify").FastifyPluginCallback<
-    Record<never, never>,
-    import("fastify").RawServerDefault
->;
+export declare const plugin: import("fastify").FastifyPluginCallback<Record<never, never>, import("http").Server>;
 export declare const errorHandler: () => (
     err: any,
     req: import("fastify").FastifyRequest<
         import("fastify/types/route").RouteGenericInterface,
-        import("fastify").RawServerDefault,
+        import("http").Server,
         import("http").IncomingMessage
     >,
     res: import("fastify").FastifyReply<
-        import("fastify").RawServerDefault,
+        import("http").Server,
         import("http").IncomingMessage,
-        import("http").ServerResponse<import("http").IncomingMessage>,
+        import("http").ServerResponse,
         import("fastify/types/route").RouteGenericInterface,
         unknown
     >

lib/build/framework/utils.d.ts

@@ -45,7 +45,7 @@ export declare function setCookieForServerResponse(
     expires: number,
     path: string,
     sameSite: "strict" | "lax" | "none"
-): ServerResponse<IncomingMessage>;
+): ServerResponse;
 export declare function getCookieValueToSetInHeader(
     prev: string | string[] | undefined,
     val: string | string[],

lib/build/recipe/dashboard/api/userroles/addRoleToUser.d.ts

@@ -5,7 +5,13 @@ declare const addRoleToUser: (
     tenantId: string,
     options: APIOptions,
     __: any
-) => Promise<{
-    status: "OK" | "UNKNOWN_ROLE_ERROR" | "ROLE_ALREADY_ASSIGNED";
-}>;
+) => Promise<
+    | {
+          status: "OK";
+          didUserAlreadyHaveRole: boolean;
+      }
+    | {
+          status: "UNKNOWN_ROLE_ERROR" | "FEATURE_NOT_ENABLED_ERROR";
+      }
+>;
 export default addRoleToUser;

lib/build/recipe/dashboard/api/userroles/addRoleToUser.js

@@ -5,9 +5,17 @@ var __importDefault =
         return mod && mod.__esModule ? mod : { default: mod };
     };
 Object.defineProperty(exports, "__esModule", { value: true });
+const recipe_1 = __importDefault(require("../../../userroles/recipe"));
 const userroles_1 = __importDefault(require("../../../userroles"));
 const error_1 = __importDefault(require("../../../../error"));
 const addRoleToUser = async (_, tenantId, options, __) => {
+    try {
+        recipe_1.default.getInstanceOrThrowError();
+    } catch (_) {
+        return {
+            status: "FEATURE_NOT_ENABLED_ERROR",
+        };
+    }
     const requestBody = await options.req.getJSONBody();
     const userId = requestBody.userId;
     const role = requestBody.role;
@@ -24,18 +32,6 @@ const addRoleToUser = async (_, tenantId, options, __) => {
         });
     }
     const response = await userroles_1.default.addRoleToUser(tenantId, userId, role);
-    if (response.status === "OK" && response.didUserAlreadyHaveRole === true) {
-        return {
-            status: "ROLE_ALREADY_ASSIGNED",
-        };
-    }
-    if (response.status === "UNKNOWN_ROLE_ERROR") {
-        return {
-            status: "UNKNOWN_ROLE_ERROR",
-        };
-    }
-    return {
-        status: "OK",
-    };
+    return response;
 };
 exports.default = addRoleToUser;

lib/build/recipe/dashboard/api/userroles/permissions/getPermissionsForRole.d.ts

@@ -5,8 +5,13 @@ declare const getPermissionsForRole: (
     ___: string,
     options: APIOptions,
     __: any
-) => Promise<{
-    status: "OK";
-    permissions: string[];
-}>;
+) => Promise<
+    | {
+          status: "OK";
+          permissions: string[];
+      }
+    | {
+          status: "FEATURE_NOT_ENABLED_ERROR" | "UNKNOWN_ROLE_ERROR";
+      }
+>;
 export default getPermissionsForRole;

lib/build/recipe/dashboard/api/userroles/permissions/getPermissionsForRole.js

@@ -5,9 +5,17 @@ var __importDefault =
         return mod && mod.__esModule ? mod : { default: mod };
     };
 Object.defineProperty(exports, "__esModule", { value: true });
+const recipe_1 = __importDefault(require("../../../../userroles/recipe"));
 const userroles_1 = __importDefault(require("../../../../userroles"));
 const error_1 = __importDefault(require("../../../../../error"));
 const getPermissionsForRole = async (_, ___, options, __) => {
+    try {
+        recipe_1.default.getInstanceOrThrowError();
+    } catch (_) {
+        return {
+            status: "FEATURE_NOT_ENABLED_ERROR",
+        };
+    }
     const role = options.req.getKeyValueFromQuery("role");
     if (role === undefined || typeof role !== "string") {
         throw new error_1.default({
@@ -16,12 +24,6 @@ const getPermissionsForRole = async (_, ___, options, __) => {
         });
     }
     const response = await userroles_1.default.getPermissionsForRole(role);
-    if (response.status === "UNKNOWN_ROLE_ERROR") {
-        return {
-            status: "OK",
-            permissions: [],
-        };
-    }
     return response;
 };
 exports.default = getPermissionsForRole;

lib/build/recipe/dashboard/api/userroles/permissions/removePermissions.d.ts

@@ -6,6 +6,6 @@ declare const removePermissionsFromRole: (
     options: APIOptions,
     __: any
 ) => Promise<{
-    status: "OK" | "UNKNOWN_ROLE_ERROR";
+    status: "OK" | "UNKNOWN_ROLE_ERROR" | "FEATURE_NOT_ENABLED_ERROR";
 }>;
 export default removePermissionsFromRole;

lib/build/recipe/dashboard/api/userroles/permissions/removePermissions.js

@@ -5,9 +5,17 @@ var __importDefault =
         return mod && mod.__esModule ? mod : { default: mod };
     };
 Object.defineProperty(exports, "__esModule", { value: true });
+const recipe_1 = __importDefault(require("../../../../userroles/recipe"));
 const userroles_1 = __importDefault(require("../../../../userroles"));
 const error_1 = __importDefault(require("../../../../../error"));
 const removePermissionsFromRole = async (_, ___, options, __) => {
+    try {
+        recipe_1.default.getInstanceOrThrowError();
+    } catch (_) {
+        return {
+            status: "FEATURE_NOT_ENABLED_ERROR",
+        };
+    }
     const requestBody = await options.req.getJSONBody();
     const role = requestBody.role;
     const permissions = requestBody.permissions;

lib/build/recipe/dashboard/api/userroles/removeUserRole.d.ts

@@ -8,9 +8,10 @@ declare const removeUserRole: (
 ) => Promise<
     | {
           status: "OK";
+          didUserHaveRole: boolean;
       }
     | {
-          status: "UNKNOWN_ROLE_ERROR";
+          status: "UNKNOWN_ROLE_ERROR" | "FEATURE_NOT_ENABLED_ERROR";
       }
 >;
 export default removeUserRole;

lib/build/recipe/dashboard/api/userroles/removeUserRole.js

@@ -5,9 +5,17 @@ var __importDefault =
         return mod && mod.__esModule ? mod : { default: mod };
     };
 Object.defineProperty(exports, "__esModule", { value: true });
+const recipe_1 = __importDefault(require("../../../userroles/recipe"));
 const userroles_1 = __importDefault(require("../../../userroles"));
 const error_1 = __importDefault(require("../../../../error"));
 const removeUserRole = async (_, tenantId, options, __) => {
+    try {
+        recipe_1.default.getInstanceOrThrowError();
+    } catch (_) {
+        return {
+            status: "FEATURE_NOT_ENABLED_ERROR",
+        };
+    }
     const userId = options.req.getKeyValueFromQuery("userId");
     const role = options.req.getKeyValueFromQuery("role");
     if (role === undefined || typeof role !== "string") {

lib/build/recipe/dashboard/api/userroles/roles/createRoleOrAddPermissions.d.ts

@@ -0,0 +1,17 @@
+// @ts-nocheck
+import { APIInterface, APIOptions } from "../../../types";
+declare const createRoleOrAddPermissions: (
+    _: APIInterface,
+    __: string,
+    options: APIOptions,
+    ___: any
+) => Promise<
+    | {
+          status: "OK";
+          createdNewRole: boolean;
+      }
+    | {
+          status: "FEATURE_NOT_ENABLED_ERROR";
+      }
+>;
+export default createRoleOrAddPermissions;

lib/build/recipe/dashboard/api/userroles/roles/createRole.js → lib/build/recipe/dashboard/api/userroles/roles/createRoleOrAddPermissions.js

@@ -5,9 +5,17 @@ var __importDefault =
         return mod && mod.__esModule ? mod : { default: mod };
     };
 Object.defineProperty(exports, "__esModule", { value: true });
+const recipe_1 = __importDefault(require("../../../../userroles/recipe"));
 const userroles_1 = __importDefault(require("../../../../userroles"));
 const error_1 = __importDefault(require("../../../../../error"));
-const createRole = async (_, __, options, ___) => {
+const createRoleOrAddPermissions = async (_, __, options, ___) => {
+    try {
+        recipe_1.default.getInstanceOrThrowError();
+    } catch (_) {
+        return {
+            status: "FEATURE_NOT_ENABLED_ERROR",
+        };
+    }
     const requestBody = await options.req.getJSONBody();
     const permissions = requestBody.permissions;
     const role = requestBody.role;
@@ -23,15 +31,7 @@ const createRole = async (_, __, options, ___) => {
             type: error_1.default.BAD_INPUT_ERROR,
         });
     }
-    //TODO: check for a is this role already exists or not before creating the new role.
     const response = await userroles_1.default.createNewRoleOrAddPermissions(role, permissions);
-    if (response.status === "OK" && response.createdNewRole === false) {
-        return {
-            status: "ROLE_ALREADY_EXITS",
-        };
-    }
-    return {
-        status: "OK",
-    };
+    return response;
 };
-exports.default = createRole;
+exports.default = createRoleOrAddPermissions;

lib/build/recipe/dashboard/api/userroles/roles/deleteRole.d.ts

@@ -5,7 +5,13 @@ declare const deleteRole: (
     ___: string,
     options: APIOptions,
     __: any
-) => Promise<{
-    status: "OK" | "ROLE_DO_NOT_EXISTS";
-}>;
+) => Promise<
+    | {
+          status: "OK";
+          didRoleExist: boolean;
+      }
+    | {
+          status: "FEATURE_NOT_ENABLED_ERROR";
+      }
+>;
 export default deleteRole;

lib/build/recipe/dashboard/api/userroles/roles/deleteRole.js

@@ -5,9 +5,17 @@ var __importDefault =
         return mod && mod.__esModule ? mod : { default: mod };
     };
 Object.defineProperty(exports, "__esModule", { value: true });
+const recipe_1 = __importDefault(require("../../../../userroles/recipe"));
 const userroles_1 = __importDefault(require("../../../../userroles"));
 const error_1 = __importDefault(require("../../../../../error"));
 const deleteRole = async (_, ___, options, __) => {
+    try {
+        recipe_1.default.getInstanceOrThrowError();
+    } catch (_) {
+        return {
+            status: "FEATURE_NOT_ENABLED_ERROR",
+        };
+    }
     const role = options.req.getKeyValueFromQuery("role");
     if (role === undefined || typeof role !== "string") {
         throw new error_1.default({
@@ -16,13 +24,6 @@ const deleteRole = async (_, ___, options, __) => {
         });
     }
     const response = await userroles_1.default.deleteRole(role);
-    if (response.status === "OK" && response.didRoleExist === false) {
-        return {
-            status: "ROLE_DO_NOT_EXISTS",
-        };
-    }
-    return {
-        status: "OK",
-    };
+    return response;
 };
 exports.default = deleteRole;