Fix returing types and merge create update roles to one single api

supertokens · Nov 8, 2023 · dd9ee0c · dd9ee0c
1 parent 5811643
commit dd9ee0c
Show file tree

Hide file tree

Showing 16 changed files with 158 additions and 149 deletions.
diff --git a/lib/build/recipe/dashboard/api/userroles/addRoleToUser.d.ts b/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" | "FEATURE_NOT_ENABLED_ERROR";
-}>;
+) => Promise<
+    | {
+          status: "OK";
+          didUserAlreadyHaveRole: boolean;
+      }
+    | {
+          status: "UNKNOWN_ROLE_ERROR" | "FEATURE_NOT_ENABLED_ERROR";
+      }
+>;
 export default addRoleToUser;
diff --git a/lib/build/recipe/dashboard/api/userroles/removeUserRole.d.ts b/lib/build/recipe/dashboard/api/userroles/removeUserRole.d.ts
@@ -5,7 +5,13 @@ declare const removeUserRole: (
     tenantId: string,
     options: APIOptions,
     __: any
-) => Promise<{
-    status: "OK" | "UNKNOWN_ROLE_ERROR" | "FEATURE_NOT_ENABLED_ERROR";
-}>;
+) => Promise<
+    | {
+          status: "OK";
+          didUserHaveRole: boolean;
+      }
+    | {
+          status: "UNKNOWN_ROLE_ERROR" | "FEATURE_NOT_ENABLED_ERROR";
+      }
+>;
 export default removeUserRole;
diff --git a/lib/build/recipe/dashboard/api/userroles/roles/createRole.d.ts b/lib/build/recipe/dashboard/api/userroles/roles/createRole.d.ts
diff --git a/lib/build/recipe/dashboard/api/userroles/roles/createRole.js b/lib/build/recipe/dashboard/api/userroles/roles/createRole.js
diff --git a/...userroles/permissions/addPermissions.d.ts → ...les/roles/createRoleOrAddPermissions.d.ts b/...userroles/permissions/addPermissions.d.ts → ...les/roles/createRoleOrAddPermissions.d.ts
@@ -1,10 +1,10 @@
 // @ts-nocheck
 import { APIInterface, APIOptions } from "../../../types";
-declare const addPermissions: (
+declare const createRoleOrAddPermissions: (
     _: APIInterface,
-    ___: string,
+    __: string,
     options: APIOptions,
-    __: any
+    ___: any
 ) => Promise<
     | {
           status: "OK";
@@ -14,4 +14,4 @@ declare const addPermissions: (
           status: "FEATURE_NOT_ENABLED_ERROR";
       }
 >;
-export default addPermissions;
+export default createRoleOrAddPermissions;
diff --git a/...i/userroles/permissions/addPermissions.js → ...roles/roles/createRoleOrAddPermissions.js b/...i/userroles/permissions/addPermissions.js → ...roles/roles/createRoleOrAddPermissions.js
@@ -8,7 +8,7 @@ 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 addPermissions = async (_, ___, options, __) => {
+const createRoleOrAddPermissions = async (_, __, options, ___) => {
     try {
         recipe_1.default.getInstanceOrThrowError();
     } catch (_) {
@@ -17,8 +17,8 @@ const addPermissions = async (_, ___, options, __) => {
         };
     }
     const requestBody = await options.req.getJSONBody();
-    const role = requestBody.role;
     const permissions = requestBody.permissions;
+    const role = requestBody.role;
     if (role === undefined || typeof role !== "string") {
         throw new error_1.default({
             message: "Required parameter 'role' is missing or has an invalid type",
@@ -34,4 +34,4 @@ const addPermissions = async (_, ___, options, __) => {
     const response = await userroles_1.default.createNewRoleOrAddPermissions(role, permissions);
     return response;
 };
-exports.default = addPermissions;
+exports.default = createRoleOrAddPermissions;
diff --git a/lib/build/recipe/dashboard/api/userroles/roles/deleteRole.d.ts b/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" | "FEATURE_NOT_ENABLED_ERROR";
-}>;
+) => Promise<
+    | {
+          status: "OK";
+          didRoleExist: boolean;
+      }
+    | {
+          status: "FEATURE_NOT_ENABLED_ERROR";
+      }
+>;
 export default deleteRole;
diff --git a/lib/build/recipe/dashboard/api/userroles/roles/getAllRoles.js b/lib/build/recipe/dashboard/api/userroles/roles/getAllRoles.js
@@ -6,31 +6,66 @@ var __importDefault =
     };
 Object.defineProperty(exports, "__esModule", { value: true });
 const userroles_1 = __importDefault(require("../../../../userroles"));
+const error_1 = __importDefault(require("../../../../../error"));
 const recipe_1 = __importDefault(require("../../../../userroles/recipe"));
-const getAllRoles = async (_, __, ___, ____) => {
+const getAllRoles = async (_, __, options, ____) => {
     try {
         recipe_1.default.getInstanceOrThrowError();
     } catch (_) {
         return {
             status: "FEATURE_NOT_ENABLED_ERROR",
         };
     }
+    const limit = Number(options.req.getKeyValueFromQuery("limit"));
+    let page = Number(options.req.getKeyValueFromQuery("page"));
+    if (limit === undefined || isNaN(limit) === false) {
+        throw new error_1.default({
+            message: "Missing required parameter 'limit'",
+            type: error_1.default.BAD_INPUT_ERROR,
+        });
+    }
+    if (page === undefined || isNaN(page) === false) {
+        throw new error_1.default({
+            message: "Missing required parameter 'page'",
+            type: error_1.default.BAD_INPUT_ERROR,
+        });
+    }
+    //set default page number to 1 if the page number is negitive or zero
+    if (page <= 0) {
+        page = 1;
+    }
+    const skip = limit * (page - 1);
     const response = await userroles_1.default.getAllRoles();
+    const totalPages = Math.ceil(response.roles.length / limit);
+    if (page > totalPages) {
+        return {
+            roles: [],
+            totalPages,
+            status: "OK",
+        };
+    }
+    const paginatedRoles = response.roles.slice(skip, skip + limit);
     let roles = [];
-    for (let i = 0; i < response.roles.length; i++) {
-        const role = response.roles[i];
+    for (let i = 0; i < paginatedRoles.length; i++) {
+        const role = paginatedRoles[i];
         try {
             const res = await userroles_1.default.getPermissionsForRole(role);
             if (res.status === "OK") {
                 roles.push({
                     role,
                     permissions: res.permissions,
                 });
+            } else {
+                roles.push({
+                    role,
+                    permissions: [],
+                });
             }
         } catch (_) {}
     }
     return {
         roles,
+        totalPages,
         status: "OK",
     };
 };

diff --git a/lib/build/recipe/dashboard/recipe.js b/lib/build/recipe/dashboard/recipe.js
@@ -50,14 +50,13 @@ const analytics_1 = __importDefault(require("./api/analytics"));
 const listTenants_1 = __importDefault(require("./api/listTenants"));
 const userUnlinkGet_1 = require("./api/userdetails/userUnlinkGet");
 const getAllRoles_1 = __importDefault(require("./api/userroles/roles/getAllRoles"));
-const createRole_1 = __importDefault(require("./api/userroles/roles/createRole"));
 const deleteRole_1 = __importDefault(require("./api/userroles/roles/deleteRole"));
-const addPermissions_1 = __importDefault(require("./api/userroles/permissions/addPermissions"));
 const removePermissions_1 = __importDefault(require("./api/userroles/permissions/removePermissions"));
 const getPermissionsForRole_1 = __importDefault(require("./api/userroles/permissions/getPermissionsForRole"));
 const addRoleToUser_1 = __importDefault(require("./api/userroles/addRoleToUser"));
 const getRolesForUser_1 = __importDefault(require("./api/userroles/getRolesForUser"));
 const removeUserRole_1 = __importDefault(require("./api/userroles/removeUserRole"));
+const createRoleOrAddPermissions_1 = __importDefault(require("./api/userroles/roles/createRoleOrAddPermissions"));
 class Recipe extends recipeModule_1.default {
     constructor(recipeId, appInfo, isInServerlessEnv, config) {
         super(recipeId, appInfo);
@@ -394,8 +393,8 @@ class Recipe extends recipeModule_1.default {
             } else if (id === constants_1.USERROLES_LIST_API) {
                 apiFunction = getAllRoles_1.default;
             } else if (id === constants_1.USERROLES_ROLE_API) {
-                if (req.getMethod() === "post") {
-                    apiFunction = createRole_1.default;
+                if (req.getMethod() === "put") {
+                    apiFunction = createRoleOrAddPermissions_1.default;
                 }
                 if (req.getMethod() === "delete") {
                     apiFunction = deleteRole_1.default;
@@ -404,9 +403,6 @@ class Recipe extends recipeModule_1.default {
                 if (req.getMethod() === "get") {
                     apiFunction = getPermissionsForRole_1.default;
                 }
-                if (req.getMethod() === "put") {
-                    apiFunction = addPermissions_1.default;
-                }
             } else if (id === constants_1.USERROLES_REMOVE_PERMISSIONS_API) {
                 apiFunction = removePermissions_1.default;
             } else if (id === constants_1.USERROLES_USER_API) {

diff --git a/lib/ts/recipe/dashboard/api/userroles/addRoleToUser.ts b/lib/ts/recipe/dashboard/api/userroles/addRoleToUser.ts
@@ -9,9 +9,15 @@ const addRoleToUser = async (
     tenantId: string,
     options: APIOptions,
     __: any
-): Promise<{
-    status: "OK" | "UNKNOWN_ROLE_ERROR" | "FEATURE_NOT_ENABLED_ERROR";
-}> => {
+): Promise<
+    | {
+          status: "OK";
+          didUserAlreadyHaveRole: boolean;
+      }
+    | {
+          status: "UNKNOWN_ROLE_ERROR" | "FEATURE_NOT_ENABLED_ERROR";
+      }
+> => {
     try {
         UserRolesRecipe.getInstanceOrThrowError();
     } catch (_) {

diff --git a/lib/ts/recipe/dashboard/api/userroles/permissions/addPermissions.ts b/lib/ts/recipe/dashboard/api/userroles/permissions/addPermissions.ts
diff --git a/lib/ts/recipe/dashboard/api/userroles/removeUserRole.ts b/lib/ts/recipe/dashboard/api/userroles/removeUserRole.ts
@@ -9,9 +9,15 @@ const removeUserRole = async (
     tenantId: string,
     options: APIOptions,
     __: any
-): Promise<{
-    status: "OK" | "UNKNOWN_ROLE_ERROR" | "FEATURE_NOT_ENABLED_ERROR";
-}> => {
+): Promise<
+    | {
+          status: "OK";
+          didUserHaveRole: boolean;
+      }
+    | {
+          status: "UNKNOWN_ROLE_ERROR" | "FEATURE_NOT_ENABLED_ERROR";
+      }
+> => {
     try {
         UserRolesRecipe.getInstanceOrThrowError();
     } catch (_) {

diff --git a/...shboard/api/userroles/roles/createRole.ts → ...roles/roles/createRoleOrAddPermissions.ts b/...shboard/api/userroles/roles/createRole.ts → ...roles/roles/createRoleOrAddPermissions.ts
@@ -4,14 +4,12 @@ import UserRoles from "../../../../userroles";
 
 import STError from "../../../../../error";
 
-const createRole = async (
+const createRoleOrAddPermissions = async (
     _: APIInterface,
     __: string,
     options: APIOptions,
     ___: any
-): Promise<{
-    status: "OK" | "ROLE_ALREADY_EXITS" | "FEATURE_NOT_ENABLED_ERROR";
-}> => {
+): Promise<{ status: "OK"; createdNewRole: boolean } | { status: "FEATURE_NOT_ENABLED_ERROR" }> => {
     try {
         UserRolesRecipe.getInstanceOrThrowError();
     } catch (_) {
@@ -43,4 +41,4 @@ const createRole = async (
     return response;
 };
 
-export default createRole;
+export default createRoleOrAddPermissions;
diff --git a/lib/ts/recipe/dashboard/api/userroles/roles/deleteRole.ts b/lib/ts/recipe/dashboard/api/userroles/roles/deleteRole.ts
@@ -9,9 +9,15 @@ const deleteRole = async (
     ___: string,
     options: APIOptions,
     __: any
-): Promise<{
-    status: "OK" | "ROLE_DO_NOT_EXISTS" | "FEATURE_NOT_ENABLED_ERROR";
-}> => {
+): Promise<
+    | {
+          status: "OK";
+          didRoleExist: boolean;
+      }
+    | {
+          status: "FEATURE_NOT_ENABLED_ERROR";
+      }
+> => {
     try {
         UserRolesRecipe.getInstanceOrThrowError();
     } catch (_) {