-
Notifications
You must be signed in to change notification settings - Fork 246
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(backend): Introduce OrganizationRoleAPI
- Loading branch information
1 parent
c64f647
commit 5b9dbaa
Showing
7 changed files
with
143 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
'@clerk/backend': patch | ||
--- | ||
|
||
Add OrganizationRoleAPI for CRUD operations regarding instance level organization roles. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,98 @@ | ||
import { joinPaths } from '../../util/path'; | ||
import type { DeletedObject } from '../resources'; | ||
import type { OrganizationRole } from '../resources/OrganizationRole'; | ||
import { AbstractAPI } from './AbstractApi'; | ||
|
||
const basePath = '/organizations_roles'; | ||
|
||
type GetOrganizationRoleListParams = { | ||
limit?: number; | ||
offset?: number; | ||
}; | ||
|
||
type CreateParams = { | ||
name: string; | ||
key: string; | ||
description: string; | ||
permissions: string[]; | ||
}; | ||
|
||
type GetOrganizationRoleParams = { roleId: string }; | ||
|
||
type UpdateParams = { | ||
name?: string; | ||
description?: string; | ||
//TODO(@pantelis): Will this override or union ? | ||
permissions?: string[]; | ||
}; | ||
|
||
type RemovePermissionParams = { | ||
permissionId: string; | ||
roleId: string; | ||
}; | ||
|
||
type AssignPermissionParams = RemovePermissionParams; | ||
|
||
export class OrganizationRoleAPI extends AbstractAPI { | ||
public async getOrganizationRoleList(params?: GetOrganizationRoleListParams) { | ||
return this.request<OrganizationRole[]>({ | ||
method: 'GET', | ||
path: basePath, | ||
queryParams: params, | ||
}); | ||
} | ||
|
||
public async createOrganizationRole(params: CreateParams) { | ||
return this.request<OrganizationRole>({ | ||
method: 'POST', | ||
path: basePath, | ||
bodyParams: params, | ||
}); | ||
} | ||
|
||
public async getOrganizationRole(params: GetOrganizationRoleParams) { | ||
this.requireId(params.roleId); | ||
|
||
return this.request<OrganizationRole>({ | ||
method: 'GET', | ||
path: joinPaths(basePath, params.roleId), | ||
}); | ||
} | ||
|
||
public async updateOrganizationRole(roleId: string, params: UpdateParams) { | ||
this.requireId(roleId); | ||
return this.request<OrganizationRole>({ | ||
method: 'PATCH', | ||
path: joinPaths(basePath, roleId), | ||
bodyParams: params, | ||
}); | ||
} | ||
|
||
public async deleteOrganizationRole(roleId: string) { | ||
this.requireId(roleId); | ||
return this.request<DeletedObject>({ | ||
method: 'DELETE', | ||
path: joinPaths(basePath, roleId), | ||
}); | ||
} | ||
|
||
public async assignPermissionToRole(params: AssignPermissionParams) { | ||
const { roleId, permissionId } = params; | ||
this.requireId(roleId); | ||
this.requireId(permissionId); | ||
return this.request<OrganizationRole>({ | ||
method: 'POST', | ||
path: joinPaths(basePath, roleId, 'permission', permissionId), | ||
}); | ||
} | ||
|
||
public async removePermissionFromRole(params: RemovePermissionParams) { | ||
const { roleId, permissionId } = params; | ||
this.requireId(roleId); | ||
this.requireId(permissionId); | ||
return this.request<OrganizationRole>({ | ||
method: 'DELETE', | ||
path: joinPaths(basePath, roleId, 'permission', permissionId), | ||
}); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
import type { OrganizationRoleJSON } from './JSON'; | ||
|
||
export class OrganizationRole { | ||
constructor( | ||
readonly id: string, | ||
readonly name: string, | ||
readonly key: string, | ||
readonly description: string, | ||
readonly permissions: string[], | ||
readonly createdAt: number, | ||
readonly updatedAt: number, | ||
) {} | ||
|
||
static fromJSON(data: OrganizationRoleJSON): OrganizationRole { | ||
return new OrganizationRole( | ||
data.id, | ||
data.name, | ||
data.key, | ||
data.description, | ||
data.permissions, | ||
data.created_at, | ||
data.updated_at, | ||
); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters