Merge pull request #36 from PropelAuth/feat/multi-role

multi role support

Author: mrmauer

package-lock.json

@@ -152,6 +152,7 @@ export type AddUserToOrgRequest = {
     userId: string
     orgId: string
     role: string
+    additionalRoles?: string[]
 }
 
 export function addUserToOrg(
@@ -163,6 +164,7 @@ export function addUserToOrg(
         user_id: addUserToOrgRequest.userId,
         org_id: addUserToOrgRequest.orgId,
         role: addUserToOrgRequest.role,
+        additional_roles: addUserToOrgRequest.additionalRoles ?? [],
     }
     return httpRequest(authUrl, integrationApiKey, `${ENDPOINT_PATH}/add_user`, "POST", JSON.stringify(request)).then(
         (httpResponse) => {
@@ -185,6 +187,7 @@ export type ChangeUserRoleInOrgRequest = {
     userId: string
     orgId: string
     role: string
+    additionalRoles?: string[]
 }
 
 export function changeUserRoleInOrg(
@@ -196,6 +199,7 @@ export function changeUserRoleInOrg(
         user_id: changeUserRoleInOrgRequest.userId,
         org_id: changeUserRoleInOrgRequest.orgId,
         role: changeUserRoleInOrgRequest.role,
+        additional_roles: changeUserRoleInOrgRequest.additionalRoles ?? [],
     }
     return httpRequest(
         authUrl,

src/api/org.ts

@@ -278,6 +278,7 @@ export type InviteUserToOrgRequest = {
     orgId: string
     email: string
     role: string
+    additionalRoles?: string[]
 }
 
 export function inviteUserToOrg(
@@ -289,6 +290,7 @@ export function inviteUserToOrg(
         org_id: inviteUserToOrgRequest.orgId,
         email: inviteUserToOrgRequest.email,
         role: inviteUserToOrgRequest.role,
+        additional_roles: inviteUserToOrgRequest.additionalRoles ?? [],
     }
 
     return httpRequest(authUrl, integrationApiKey, `/api/backend/v1/invite_user`, "POST", JSON.stringify(body)).then(

src/api/user.ts

@@ -1,6 +1,11 @@
 export { AccessToken, CreateAccessTokenRequest } from "./api/accessToken"
 export { CreateMagicLinkRequest, MagicLink } from "./api/magicLink"
-export { OrgQuery, OrgQueryResponse } from "./api/org"
+export { 
+    OrgQuery,
+    OrgQueryResponse,
+    AddUserToOrgRequest,
+    ChangeUserRoleInOrgRequest,
+} from "./api/org"
 export { TokenVerificationMetadata } from "./api/tokenVerificationMetadata"
 export {
     CreateUserRequest,
@@ -50,6 +55,7 @@ export {
     Organization,
     OrgIdToOrgMemberInfo,
     OrgMemberInfo,
+    OrgRoleStructure,
     toOrgIdToOrgMemberInfo,
     toUser,
     User,

src/index.ts

@@ -212,15 +212,22 @@ export type UserMetadata = {
     properties?: { [key: string]: unknown }
 }
 
+export enum OrgRoleStructure {
+    SingleRole = "single_role_in_hierarchy",
+    MultiRole = "multi_role",
+}
+
 export class OrgMemberInfo {
     public readonly orgId: string
     public readonly orgName: string
     public readonly orgMetadata: { [key: string]: unknown }
     public readonly urlSafeOrgName: string
+    public readonly orgRoleStructure: OrgRoleStructure 
 
     private readonly userAssignedRole: string
     private readonly userInheritedRolesPlusCurrentRole: string[]
     private readonly userPermissions: string[]
+    private readonly userAssignedAdditionalRoles: string[]
 
     constructor(
         orgId: string,
@@ -229,7 +236,9 @@ export class OrgMemberInfo {
         urlSafeOrgName: string,
         userAssignedRole: string,
         userInheritedRolesPlusCurrentRole: string[],
-        userPermissions: string[]
+        userPermissions: string[],
+        orgRoleStructure?: OrgRoleStructure,
+        userAssignedAdditionalRoles?: string[]
     ) {
         this.orgId = orgId
         this.orgName = orgName
@@ -239,6 +248,8 @@ export class OrgMemberInfo {
         this.userAssignedRole = userAssignedRole
         this.userInheritedRolesPlusCurrentRole = userInheritedRolesPlusCurrentRole
         this.userPermissions = userPermissions
+        this.orgRoleStructure = orgRoleStructure ?? OrgRoleStructure.SingleRole
+        this.userAssignedAdditionalRoles = userAssignedAdditionalRoles ?? []
     }
 
     // getters
@@ -251,16 +262,28 @@ export class OrgMemberInfo {
     }
 
     get inheritedRolesPlusCurrentRole(): string[] {
-        return this.userInheritedRolesPlusCurrentRole
+        if (this.orgRoleStructure === OrgRoleStructure.MultiRole) {
+            return this.userAssignedAdditionalRoles.concat(this.userAssignedRole)
+        } else {
+            return this.userInheritedRolesPlusCurrentRole
+        }
     }
 
     // validation methods
     public isRole(role: string): boolean {
-        return this.userAssignedRole === role
+        if (this.orgRoleStructure === OrgRoleStructure.MultiRole) {
+            return this.userAssignedRole === role || this.userAssignedAdditionalRoles.includes(role)
+        } else {
+            return this.userAssignedRole === role
+        }
     }
 
     public isAtLeastRole(role: string): boolean {
-        return this.userInheritedRolesPlusCurrentRole.includes(role)
+        if (this.orgRoleStructure === OrgRoleStructure.MultiRole) {
+            return this.userAssignedRole === role || this.userAssignedAdditionalRoles.includes(role)
+        } else {
+            return this.userInheritedRolesPlusCurrentRole.includes(role)
+        }
     }
 
     public hasPermission(permission: string): boolean {
@@ -281,7 +304,9 @@ export class OrgMemberInfo {
                 obj.urlSafeOrgName,
                 obj.userAssignedRole,
                 obj.userInheritedRolesPlusCurrentRole,
-                obj.userPermissions
+                obj.userPermissions,
+                obj.orgRoleStructure,
+                obj.userAssignedAdditionalRoles
             )
         } catch (e) {
             console.error(
@@ -309,9 +334,11 @@ export type InternalOrgMemberInfo = {
     org_name: string
     org_metadata: { [key: string]: any }
     url_safe_org_name: string
+    org_role_structure: OrgRoleStructure
     user_role: string
     inherited_user_roles_plus_current_role: string[]
     user_permissions: string[]
+    additional_roles: string[]
 }
 
 // This type is used to represent the user returned from the refresh token.
@@ -382,7 +409,9 @@ export function toOrgIdToOrgMemberInfo(snake_case?: {
                 snakeCaseValue.url_safe_org_name,
                 snakeCaseValue.user_role,
                 snakeCaseValue.inherited_user_roles_plus_current_role,
-                snakeCaseValue.user_permissions
+                snakeCaseValue.user_permissions,
+                snakeCaseValue.org_role_structure,
+                snakeCaseValue.additional_roles
             )
         }
     }

src/user.ts

@@ -47,7 +47,7 @@ function isOrgMemberInfo(value: any) {
         value.hasOwnProperty("urlSafeOrgName") &&
         value.hasOwnProperty("orgMetadata") &&
         value.hasOwnProperty("userAssignedRole") &&
-        value.hasOwnProperty("userRoles") &&
+        value.hasOwnProperty("userInheritedRoles") &&
         value.hasOwnProperty("userPermissions")
     )
 }
@@ -72,16 +72,18 @@ function processKeys(obj: any): any {
                 value["orgMetadata"],
                 value["urlSafeOrgName"],
                 value["userAssignedRole"],
-                value["userRoles"],
-                value["userPermissions"]
+                value["userInheritedRoles"],
+                value["userPermissions"],
+                value["orgRoleStructure"],
+                value["additionalRoles"]
             )
         }
 
         let newKey
         if (key === "user_role") {
             newKey = "userAssignedRole"
         } else if (key === "inherited_user_roles_plus_current_role") {
-            newKey = "userRoles"
+            newKey = "userInheritedRoles"
         } else {
             newKey = camelCase(key)
         }