-
Notifications
You must be signed in to change notification settings - Fork 240
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
revert(backend): Introduce OrganizationPermissionAPI and Organization…
…RoleAPI (#2252) * Revert "feat(backend): Introduce OrganizationRoleAPI (#2177)" This reverts commit b3a3dcd * Revert "feat(backend): Introduce OrganizationPermissionAPI (#2178)" This reverts commit 0ce0edc * chore(backend): Add changeset * chore(backend): Keep the previous changesets
- Loading branch information
1 parent
7d93c4c
commit 93d05c8
Showing
14 changed files
with
8 additions
and
300 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,7 @@ | ||
--- | ||
'@clerk/clerk-sdk-node': patch | ||
'@clerk/backend': patch | ||
'@clerk/nextjs': patch | ||
--- | ||
|
||
Drop the introduction of `OrganizationRole` and `OrganizationPermission` resources fro BAPI. |
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 |
---|---|---|
@@ -1,69 +0,0 @@ | ||
import type { ClerkPaginationRequest } from '@clerk/types'; | ||
|
||
import { joinPaths } from '../../util/path'; | ||
import type { DeletedObject, Permission } from '../resources'; | ||
import { AbstractAPI } from './AbstractApi'; | ||
|
||
const basePath = '/organizations_permissions'; | ||
|
||
type GetOrganizationPermissionListParams = ClerkPaginationRequest<{ | ||
query?: string; | ||
orderBy?: string; | ||
}>; | ||
|
||
type CreateParams = { | ||
name: string; | ||
key: string; | ||
description: string; | ||
}; | ||
|
||
type GetOrganizationPermissionParams = { permissionId: string }; | ||
|
||
type UpdateParams = { | ||
name?: string; | ||
key?: string; | ||
description?: string; | ||
}; | ||
|
||
export class OrganizationPermissionAPI extends AbstractAPI { | ||
public async getOrganizationPermissionList(params?: GetOrganizationPermissionListParams) { | ||
return this.request<Permission[]>({ | ||
method: 'GET', | ||
path: basePath, | ||
queryParams: params, | ||
}); | ||
} | ||
|
||
public async createOrganizationPermission(params: CreateParams) { | ||
return this.request<Permission>({ | ||
method: 'POST', | ||
path: basePath, | ||
bodyParams: params, | ||
}); | ||
} | ||
|
||
public async getOrganizationPermission(params: GetOrganizationPermissionParams) { | ||
this.requireId(params.permissionId); | ||
|
||
return this.request<Permission>({ | ||
method: 'GET', | ||
path: joinPaths(basePath, params.permissionId), | ||
}); | ||
} | ||
|
||
public async updateOrganizationPermission(permissionId: string, params: UpdateParams) { | ||
this.requireId(permissionId); | ||
return this.request<Permission>({ | ||
method: 'PATCH', | ||
path: joinPaths(basePath, permissionId), | ||
bodyParams: params, | ||
}); | ||
} | ||
|
||
public async deleteOrganizationPermission(permissionId: string) { | ||
return this.request<DeletedObject>({ | ||
method: 'DELETE', | ||
path: joinPaths(basePath, 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,138 +0,0 @@ | ||
import type { ClerkPaginationRequest } from '@clerk/types'; | ||
|
||
import { joinPaths } from '../../util/path'; | ||
import type { DeletedObject, Role } from '../resources'; | ||
import { AbstractAPI } from './AbstractApi'; | ||
|
||
const basePath = '/organizations_roles'; | ||
|
||
type GetRoleListParams = ClerkPaginationRequest<{ | ||
query?: string; | ||
order_by?: string; | ||
}>; | ||
|
||
type CreateParams = { | ||
/** | ||
* A name of a role in a readable friendly format. | ||
* F.e. `Teacher` or `Administrator` | ||
*/ | ||
name: string; | ||
|
||
/** | ||
* A unique identifier that represents the role. | ||
* F.e. `org:administrator` | ||
*/ | ||
key: string; | ||
|
||
/** | ||
* A brief description of what the role represents or its intended use. | ||
*/ | ||
description: string; | ||
|
||
/** | ||
* An array of permission ids that will be assigned to this role. | ||
*/ | ||
permissions: string[]; | ||
}; | ||
|
||
type GetOrganizationRoleParams = { roleId: string }; | ||
|
||
type UpdateParams = { | ||
/** | ||
* A name of a role in a readable friendly format. | ||
* F.e. `Teacher` or `Administrator` | ||
* Passing undefined has no effect to the existing value. | ||
*/ | ||
name?: string; | ||
|
||
/** | ||
* A unique identifier that represents the role. | ||
* F.e. `org:administrator` | ||
* Passing undefined has no effect to the existing value. | ||
*/ | ||
key?: string; | ||
|
||
/** | ||
* A brief description of what the role represents or its intended use. | ||
* Passing undefined has no effect to the existing value. | ||
*/ | ||
description?: string; | ||
|
||
/** | ||
* An array of permission ids that will be assigned to this role. | ||
* Passing undefined has no effect to the permission that already exist. | ||
* Passing an empty array will override the existing permissions. | ||
*/ | ||
permissions?: string[]; | ||
}; | ||
|
||
type RemovePermissionParams = { | ||
permissionId: string; | ||
roleId: string; | ||
}; | ||
|
||
type AssignPermissionParams = RemovePermissionParams; | ||
|
||
export class OrganizationRoleAPI extends AbstractAPI { | ||
public async getOrganizationRoleList(params?: GetRoleListParams) { | ||
return this.request<Role[]>({ | ||
method: 'GET', | ||
path: basePath, | ||
queryParams: params, | ||
}); | ||
} | ||
|
||
public async createOrganizationRole(params: CreateParams) { | ||
return this.request<Role>({ | ||
method: 'POST', | ||
path: basePath, | ||
bodyParams: params, | ||
}); | ||
} | ||
|
||
public async getOrganizationRole(params: GetOrganizationRoleParams) { | ||
this.requireId(params.roleId); | ||
|
||
return this.request<Role>({ | ||
method: 'GET', | ||
path: joinPaths(basePath, params.roleId), | ||
}); | ||
} | ||
|
||
public async updateOrganizationRole(roleId: string, params: UpdateParams) { | ||
this.requireId(roleId); | ||
return this.request<Role>({ | ||
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<Role>({ | ||
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<Role>({ | ||
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
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
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
Oops, something went wrong.