Move Role constants from frontend core to shared core

packages/backend-core/src/security/roles.ts

@@ -7,18 +7,11 @@ import {
   doWithDB,
 } from "../db"
 import { getAppDB } from "../context"
-import { Screen, Role as RoleDoc } from "@budibase/types"
+import { Screen, Role as RoleDoc, Roles } from "@budibase/types"
 import cloneDeep from "lodash/fp/cloneDeep"
 
-export const BUILTIN_ROLE_IDS = {
-  ADMIN: "ADMIN",
-  POWER: "POWER",
-  BASIC: "BASIC",
-  PUBLIC: "PUBLIC",
-}
-
 const BUILTIN_IDS = {
-  ...BUILTIN_ROLE_IDS,
+  ...Roles,
   BUILDER: "BUILDER",
 }
 

packages/backend-core/src/users/test/utils.spec.ts

@@ -1,4 +1,4 @@
-import { User, UserGroup } from "@budibase/types"
+import { Roles, User, UserGroup } from "@budibase/types"
 import { generator, structures } from "../../../tests"
 import { DBTestConfiguration } from "../../../tests/extra"
 import { getGlobalDB } from "../../context"
@@ -28,12 +28,12 @@ describe("Users", () => {
   })
 
   it("User is a creator if it has CREATOR permission in some application", async () => {
-    const user: User = structures.users.user({ roles: { app1: "CREATOR" } })
+    const user: User = structures.users.user({ roles: { app1: Roles.CREATOR } })
     expect(await isCreator(user)).toBe(true)
   })
 
   it("User is a creator if it has ADMIN permission in some application", async () => {
-    const user: User = structures.users.user({ roles: { app1: "ADMIN" } })
+    const user: User = structures.users.user({ roles: { app1: Roles.ADMIN } })
     expect(await isCreator(user)).toBe(true)
   })
 
@@ -42,7 +42,7 @@ describe("Users", () => {
     const groupId = "gr_17abffe89e0b40268e755b952f101a59"
     const group: UserGroup = {
       ...structures.userGroups.userGroup(),
-      ...{ _id: groupId, roles: { app1: "ADMIN" } },
+      ...{ _id: groupId, roles: { app1: Roles.ADMIN } },
     }
     const users: User[] = []
     for (let i = 0; i < usersInGroup; i++) {

packages/backend-core/src/users/utils.ts

@@ -1,12 +1,17 @@
-import { CloudAccount, ContextUser, User, UserGroup } from "@budibase/types"
+import {
+  CloudAccount,
+  ContextUser,
+  User,
+  UserGroup,
+  Roles as BUILTIN_ROLE_IDS,
+} from "@budibase/types"
 import * as accountSdk from "../accounts"
 import env from "../environment"
 import { getPlatformUser } from "./lookup"
 import { EmailUnavailableError } from "../errors"
 import { getTenantId } from "../context"
 import { sdk } from "@budibase/shared-core"
 import { getAccountByTenantId } from "../accounts"
-import { BUILTIN_ROLE_IDS } from "../security/roles"
 import * as context from "../context"
 
 // extract from shared-core to make easily accessible from backend-core

packages/builder/src/components/common/RoleSelect.svelte

@@ -4,6 +4,7 @@
   import { licensing } from "stores/portal"
 
   import { Constants, RoleUtils } from "@budibase/frontend-core"
+  import { Roles } from "@budibase/types"
   import { createEventDispatcher } from "svelte"
   import { capitalise } from "helpers"
 
@@ -51,9 +52,9 @@
           name: enrichLabel(role.name),
           _id: role._id,
         }))
-      if (allowedRoles.includes(Constants.Roles.CREATOR)) {
+      if (allowedRoles.includes(Roles.CREATOR)) {
         options.push({
-          _id: Constants.Roles.CREATOR,
+          _id: Roles.CREATOR,
           name: "Can edit",
           enabled: false,
         })
@@ -70,7 +71,7 @@
     // Add creator if required
     if (allowCreator) {
       options.unshift({
-        _id: Constants.Roles.CREATOR,
+        _id: Roles.CREATOR,
         name: "Can edit",
         tag:
           !$licensing.perAppBuildersEnabled &&
@@ -88,15 +89,15 @@
 
     // Remove public if not allowed
     if (!allowPublic) {
-      options = options.filter(role => role._id !== Constants.Roles.PUBLIC)
+      options = options.filter(role => role._id !== Roles.PUBLIC)
     }
 
     return options
   }
 
   const getColor = role => {
     // Creator and remove options have no colors
-    if (role._id === Constants.Roles.CREATOR || role._id === RemoveID) {
+    if (role._id === Roles.CREATOR || role._id === RemoveID) {
       return null
     }
     return RoleUtils.getRoleColour(role._id)
@@ -135,8 +136,7 @@
     getOptionColour={getColor}
     getOptionIcon={getIcon}
     isOptionEnabled={option =>
-      option._id !== Constants.Roles.CREATOR ||
-      $licensing.perAppBuildersEnabled}
+      option._id !== Roles.CREATOR || $licensing.perAppBuildersEnabled}
     {placeholder}
     {error}
   />
@@ -155,8 +155,7 @@
     getOptionColour={getColor}
     getOptionIcon={getIcon}
     isOptionEnabled={option =>
-      (option._id !== Constants.Roles.CREATOR ||
-        $licensing.perAppBuildersEnabled) &&
+      (option._id !== Roles.CREATOR || $licensing.perAppBuildersEnabled) &&
       option.enabled !== false}
     {placeholder}
     {error}

packages/builder/src/components/integration/AccessLevelSelect.svelte

@@ -1,7 +1,7 @@
 <script>
   import { Label, notifications, Select } from "@budibase/bbui"
   import { permissions, roles } from "stores/builder"
-  import { Constants } from "@budibase/frontend-core"
+  import { Roles } from "@budibase/types"
 
   export let query
   export let label
@@ -35,14 +35,14 @@
     }
     fetched = queryToFetch
     if (!queryToFetch || !queryToFetch._id) {
-      roleId = Constants.Roles.BASIC
+      roleId = Roles.BASIC
       loaded = true
       return
     }
     try {
       roleId = (await permissions.forResource(queryToFetch._id))["read"].role
     } catch (err) {
-      roleId = Constants.Roles.BASIC
+      roleId = Roles.BASIC
     }
     loaded = true
   }

packages/builder/src/pages/builder/app/[application]/_components/BuilderSidePanel.svelte

@@ -30,6 +30,7 @@
     RoleUtils,
   } from "@budibase/frontend-core"
   import { sdk } from "@budibase/shared-core"
+  import { Roles } from "@budibase/types"
   import { API } from "api"
   import GroupIcon from "../../../portal/users/groups/_components/GroupIcon.svelte"
   import RoleSelect from "components/common/RoleSelect.svelte"
@@ -49,7 +50,7 @@
   let error
   let form
   let creationRoleType = Constants.BudibaseRoles.AppUser
-  let creationAccessType = Constants.Roles.BASIC
+  let creationAccessType = Roles.BASIC
 
   let appInvites = []
   let filteredInvites = []
@@ -133,9 +134,9 @@
         const isAppBuilder = user.builder?.apps?.includes(prodAppId)
         let role
         if (isAdminOrGlobalBuilder) {
-          role = Constants.Roles.ADMIN
+          role = Roles.ADMIN
         } else if (isAppBuilder) {
-          role = Constants.Roles.CREATOR
+          role = Roles.CREATOR
         } else {
           const appRole = user.roles[prodAppId]
           if (appRole) {
@@ -218,7 +219,7 @@
       if (user.isAppBuilder) {
         await removeAppBuilder(user._id, prodAppId)
       }
-      if (role === Constants.Roles.CREATOR) {
+      if (role === Roles.CREATOR) {
         await removeAppBuilder(user._id, prodAppId)
       }
       await updateAppUser(user, role)
@@ -296,7 +297,7 @@
     return {
       ...group,
       role: group?.builder?.apps.includes(prodAppId)
-        ? Constants.Roles.CREATOR
+        ? Roles.CREATOR
         : group.roles?.[
             groups.actions.getGroupAppIds(group).find(x => x === prodAppId)
           ],
@@ -376,7 +377,7 @@
     ]
 
     const notCreatingAdmin = creationRoleType !== Constants.BudibaseRoles.Admin
-    const isCreator = creationAccessType === Constants.Roles.CREATOR
+    const isCreator = creationAccessType === Roles.CREATOR
     if (notCreatingAdmin && isCreator) {
       payload[0].builder.apps = [prodAppId]
     } else if (notCreatingAdmin && !isCreator) {
@@ -446,11 +447,11 @@
       },
     }
 
-    if (role === Constants.Roles.CREATOR) {
+    if (role === Roles.CREATOR) {
       updateBody.builder = updateBody.builder || {}
       updateBody.builder.apps = [...(updateBody.builder.apps ?? []), prodAppId]
       delete updateBody?.apps?.[prodAppId]
-    } else if (role !== Constants.Roles.CREATOR && invite?.builder?.apps) {
+    } else if (role !== Roles.CREATOR && invite?.builder?.apps) {
       invite.builder.apps = []
     }
     await users.updateInvite(updateBody)
@@ -505,7 +506,7 @@
       (invite.info?.admin?.global && invite.info?.builder?.global) ||
       invite.info?.builder?.apps?.includes(prodAppId)
     ) {
-      return Constants.Roles.CREATOR
+      return Roles.CREATOR
     }
     return invite.info.apps?.[prodAppId]
   }
@@ -523,7 +524,7 @@
 
   const parseRole = user => {
     if (user.isAdminOrGlobalBuilder) {
-      return Constants.Roles.CREATOR
+      return Roles.CREATOR
     }
     return user.role
   }
@@ -532,11 +533,11 @@
     // Ensure we don't get into an invalid combo of tenant role and app access
     if (
       e.detail === Constants.BudibaseRoles.AppUser &&
-      creationAccessType === Constants.Roles.CREATOR
+      creationAccessType === Roles.CREATOR
     ) {
-      creationAccessType = Constants.Roles.BASIC
+      creationAccessType = Roles.BASIC
     } else if (e.detail === Constants.BudibaseRoles.Admin) {
-      creationAccessType = Constants.Roles.CREATOR
+      creationAccessType = Roles.CREATOR
     }
   }
 </script>
@@ -660,7 +661,7 @@
                       autoWidth
                       align="right"
                       allowedRoles={user.isAdminOrGlobalBuilder
-                        ? [Constants.Roles.CREATOR]
+                        ? [Roles.CREATOR]
                         : null}
                       labelPrefix="Can use as"
                     />
@@ -706,7 +707,7 @@
                       allowRemove={group.role}
                       allowPublic={false}
                       quiet={true}
-                      allowCreator={group.role === Constants.Roles.CREATOR}
+                      allowCreator={group.role === Roles.CREATOR}
                       on:change={e => {
                         onUpdateGroup(group, e.detail)
                       }}
@@ -747,7 +748,7 @@
                       quiet={true}
                       on:addcreator={() => {}}
                       on:change={e => {
-                        if (e.detail === Constants.Roles.CREATOR) {
+                        if (e.detail === Roles.CREATOR) {
                           addAppBuilder(user._id)
                         } else {
                           onUpdateUser(user, e.detail)
@@ -759,7 +760,7 @@
                       autoWidth
                       align="right"
                       allowedRoles={user.isAdminOrGlobalBuilder
-                        ? [Constants.Roles.CREATOR]
+                        ? [Roles.CREATOR]
                         : null}
                       labelPrefix="Can use as"
                     />
@@ -832,7 +833,7 @@
                 align="right"
                 fancySelect
                 allowedRoles={creationRoleType === Constants.BudibaseRoles.Admin
-                  ? [Constants.Roles.CREATOR]
+                  ? [Roles.CREATOR]
                   : null}
                 footer={getRoleFooter({
                   isAdminOrGlobalBuilder:

packages/builder/src/pages/builder/app/[application]/design/[screenId]/[componentId]/_components/Navigation/NavItemConfiguration.svelte

@@ -4,7 +4,7 @@
   import NavItem from "./NavItem.svelte"
   import { generate } from "shortid"
   import { getSequentialName } from "helpers/duplicate"
-  import { Constants } from "@budibase/frontend-core"
+  import { Roles } from "@budibase/types"
 
   export let bindings
 
@@ -52,7 +52,7 @@
           getName: x => x.text,
         }),
         url: "",
-        roleId: Constants.Roles.BASIC,
+        roleId: Roles.BASIC,
         type: "link",
       },
     ])

packages/builder/src/pages/builder/portal/users/groups/[groupId].svelte

@@ -21,7 +21,7 @@
   import GroupIcon from "./_components/GroupIcon.svelte"
   import GroupUsers from "./_components/GroupUsers.svelte"
   import { sdk } from "@budibase/shared-core"
-  import { Constants } from "@budibase/frontend-core"
+  import { Roles } from "@budibase/types"
 
   export let groupId
 
@@ -60,7 +60,7 @@
     .map(app => ({
       ...app,
       role: group?.builder?.apps.includes(appsStore.getProdAppID(app.devId))
-        ? Constants.Roles.CREATOR
+        ? Roles.CREATOR
         : group?.roles?.[appsStore.getProdAppID(app.devId)],
     }))
 

packages/builder/src/pages/builder/portal/users/users/[userId].svelte

@@ -31,6 +31,7 @@
   import AppNameTableRenderer from "./_components/AppNameTableRenderer.svelte"
   import AppRoleTableRenderer from "./_components/AppRoleTableRenderer.svelte"
   import { sdk } from "@budibase/shared-core"
+  import { Roles } from "@budibase/types"
   import ActiveDirectoryInfo from "../_components/ActiveDirectoryInfo.svelte"
 
   export let userId
@@ -136,11 +137,11 @@
 
   const getRole = (prodAppId, roles) => {
     if (privileged) {
-      return Constants.Roles.ADMIN
+      return Roles.ADMIN
     }
 
     if (user?.builder?.apps?.includes(prodAppId)) {
-      return Constants.Roles.CREATOR
+      return Roles.CREATOR
     }
 
     return roles[prodAppId]

packages/builder/src/pages/builder/portal/users/users/_components/AppRoleTableRenderer.svelte

@@ -1,20 +1,21 @@
 <script>
   import { StatusLight } from "@budibase/bbui"
-  import { RoleUtils, Constants } from "@budibase/frontend-core"
+  import { RoleUtils } from "@budibase/frontend-core"
   import { roles } from "stores/builder"
   import { capitalise } from "helpers"
+  import { Roles } from "@budibase/types"
 
   export let value
 
   const getRoleLabel = roleId => {
     const role = $roles.find(x => x._id === roleId)
-    return roleId === Constants.Roles.CREATOR
-      ? capitalise(Constants.Roles.CREATOR.toLowerCase())
+    return roleId === Roles.CREATOR
+      ? capitalise(Roles.CREATOR.toLowerCase())
       : role?.name || "Custom role"
   }
 </script>
 
-{#if value === Constants.Roles.CREATOR}
+{#if value === Roles.CREATOR}
   Can edit
 {:else}
   <StatusLight square color={RoleUtils.getRoleColour(value)}>