feat: userroles and permission on dashboard recipe

CHANGELOG.md

@@ -5,6 +5,14 @@ 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]
+
+## [16.6.0] - 2023-11-23
+
+### Added
+
+-   Added User roles and permissions feature to dashboard recipe.
+
 ## [16.5.2] - 2023-11-21
 
 -   Fixes issue with `passwordReset` in emailpassword recipe for custom frameworks ([#746](https://github.com/supertokens/supertokens-node/issues/746))

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

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

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

@@ -0,0 +1,37 @@
+"use strict";
+var __importDefault =
+    (this && this.__importDefault) ||
+    function (mod) {
+        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;
+    if (role === undefined || typeof role !== "string") {
+        throw new error_1.default({
+            message: "Required parameter 'role' is missing or has an invalid type",
+            type: error_1.default.BAD_INPUT_ERROR,
+        });
+    }
+    if (userId === undefined || typeof userId !== "string") {
+        throw new error_1.default({
+            message: "Required parameter 'userId' is missing or has an invalid type",
+            type: error_1.default.BAD_INPUT_ERROR,
+        });
+    }
+    const response = await userroles_1.default.addRoleToUser(tenantId, userId, role);
+    return response;
+};
+exports.default = addRoleToUser;

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

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

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

@@ -0,0 +1,29 @@
+"use strict";
+var __importDefault =
+    (this && this.__importDefault) ||
+    function (mod) {
+        return mod && mod.__esModule ? mod : { default: mod };
+    };
+Object.defineProperty(exports, "__esModule", { value: true });
+const userroles_1 = __importDefault(require("../../../userroles"));
+const recipe_1 = __importDefault(require("../../../userroles/recipe"));
+const error_1 = __importDefault(require("../../../../error"));
+const getRolesForUser = async (_, tenantId, options, __) => {
+    const userId = options.req.getKeyValueFromQuery("userId");
+    try {
+        recipe_1.default.getInstanceOrThrowError();
+    } catch (_) {
+        return {
+            status: "FEATURE_NOT_ENABLED_ERROR",
+        };
+    }
+    if (userId === undefined || typeof userId !== "string") {
+        throw new error_1.default({
+            message: "Required parameter 'userId' is missing or has an invalid type",
+            type: error_1.default.BAD_INPUT_ERROR,
+        });
+    }
+    const response = await userroles_1.default.getRolesForUser(tenantId, userId);
+    return response;
+};
+exports.default = getRolesForUser;

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

@@ -0,0 +1,17 @@
+// @ts-nocheck
+import { APIInterface, APIOptions } from "../../../types";
+declare const getPermissionsForRole: (
+    _: APIInterface,
+    ___: string,
+    options: APIOptions,
+    __: any
+) => 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

@@ -0,0 +1,29 @@
+"use strict";
+var __importDefault =
+    (this && this.__importDefault) ||
+    function (mod) {
+        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({
+            message: "Required parameter 'role' is missing or has an invalid type",
+            type: error_1.default.BAD_INPUT_ERROR,
+        });
+    }
+    const response = await userroles_1.default.getPermissionsForRole(role);
+    return response;
+};
+exports.default = getPermissionsForRole;

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

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

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

@@ -0,0 +1,38 @@
+"use strict";
+var __importDefault =
+    (this && this.__importDefault) ||
+    function (mod) {
+        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;
+    if (role === undefined || typeof role !== "string") {
+        throw new error_1.default({
+            message: "Required parameter 'role' is missing or has an invalid type",
+            type: error_1.default.BAD_INPUT_ERROR,
+        });
+    }
+    if (permissions === undefined || Array.isArray(permissions) === false)
+        if (role === undefined) {
+            throw new error_1.default({
+                message: "Required parameter 'role' is missing or has an invalid type",
+                type: error_1.default.BAD_INPUT_ERROR,
+            });
+        }
+    const response = await userroles_1.default.removePermissionsFromRole(role, permissions);
+    return response;
+};
+exports.default = removePermissionsFromRole;

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

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

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

@@ -0,0 +1,36 @@
+"use strict";
+var __importDefault =
+    (this && this.__importDefault) ||
+    function (mod) {
+        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") {
+        throw new error_1.default({
+            message: "Required parameter 'role' is missing or has an invalid type",
+            type: error_1.default.BAD_INPUT_ERROR,
+        });
+    }
+    if (userId === undefined || typeof userId !== "string") {
+        throw new error_1.default({
+            message: "Required parameter 'userId' is missing or has an invalid type",
+            type: error_1.default.BAD_INPUT_ERROR,
+        });
+    }
+    const response = await userroles_1.default.removeUserRole(tenantId, userId, role);
+    return response;
+};
+exports.default = removeUserRole;

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/createRoleOrAddPermissions.js

@@ -0,0 +1,37 @@
+"use strict";
+var __importDefault =
+    (this && this.__importDefault) ||
+    function (mod) {
+        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 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;
+    if (role === undefined || typeof role !== "string") {
+        throw new error_1.default({
+            message: "Required parameter 'role' is missing or has an invalid type",
+            type: error_1.default.BAD_INPUT_ERROR,
+        });
+    }
+    if (permissions === undefined || Array.isArray(permissions) === false) {
+        throw new error_1.default({
+            message: "Required parameter 'permissions' is missing or has an invalid type",
+            type: error_1.default.BAD_INPUT_ERROR,
+        });
+    }
+    const response = await userroles_1.default.createNewRoleOrAddPermissions(role, permissions);
+    return response;
+};
+exports.default = createRoleOrAddPermissions;

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

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

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

@@ -0,0 +1,29 @@
+"use strict";
+var __importDefault =
+    (this && this.__importDefault) ||
+    function (mod) {
+        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({
+            message: "Required parameter 'role' is missing or has an invalid type",
+            type: error_1.default.BAD_INPUT_ERROR,
+        });
+    }
+    const response = await userroles_1.default.deleteRole(role);
+    return response;
+};
+exports.default = deleteRole;

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

@@ -0,0 +1,4 @@
+// @ts-nocheck
+import { APIFunction } from "../../../types";
+declare const getAllRoles: APIFunction;
+export default getAllRoles;