Revert "feat(backend): Introduce OrganizationRoleAPI (#2177)"

This reverts commit b3a3dcd
clerk · Dec 4, 2023 · 23833ad · 23833ad
1 parent 920c9e1
commit 23833ad
Show file tree

Hide file tree

Showing 11 changed files with 0 additions and 190 deletions.
diff --git a/.changeset/cold-comics-serve.md b/.changeset/cold-comics-serve.md
diff --git a/packages/backend/src/api/endpoints/OrganizationRoleApi.ts b/packages/backend/src/api/endpoints/OrganizationRoleApi.ts
@@ -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),
-    });
-  }
-}

diff --git a/packages/backend/src/api/endpoints/index.ts b/packages/backend/src/api/endpoints/index.ts
@@ -7,7 +7,6 @@ export * from './EmailApi';
 export * from './InterstitialApi';
 export * from './InvitationApi';
 export * from './OrganizationApi';
-export * from './OrganizationRoleApi';
 export * from './OrganizationPermissionApi';
 export * from './PhoneNumberApi';
 export * from './RedirectUrlApi';

diff --git a/packages/backend/src/api/factory.ts b/packages/backend/src/api/factory.ts
@@ -8,7 +8,6 @@ import {
   InvitationAPI,
   OrganizationAPI,
   OrganizationPermissionAPI,
-  OrganizationRoleAPI,
   PhoneNumberAPI,
   RedirectUrlAPI,
   SessionAPI,
@@ -31,7 +30,6 @@ export function createBackendApiClient(options: CreateBackendApiOptions) {
     interstitial: new InterstitialAPI(request),
     invitations: new InvitationAPI(request),
     organizations: new OrganizationAPI(request),
-    organizationRoles: new OrganizationRoleAPI(request),
     organizationPermissions: new OrganizationPermissionAPI(request),
     phoneNumbers: new PhoneNumberAPI(request),
     redirectUrls: new RedirectUrlAPI(request),

diff --git a/packages/backend/src/api/resources/JSON.ts b/packages/backend/src/api/resources/JSON.ts
@@ -21,7 +21,6 @@ export enum ObjectType {
   Organization = 'organization',
   OrganizationInvitation = 'organization_invitation',
   OrganizationMembership = 'organization_membership',
-  Role = 'role',
   Permission = 'permission',
   PhoneNumber = 'phone_number',
   RedirectUrl = 'redirect_url',
@@ -175,16 +174,6 @@ export interface OrganizationMembershipPublicUserDataJSON {
   user_id: string;
 }
 
-export interface RoleJSON extends ClerkResourceJSON {
-  object: ObjectType.Role;
-  name: string;
-  key: string;
-  description: string;
-  permissions: PermissionJSON[];
-  created_at: number;
-  updated_at: number;
-}
-
 export interface PermissionJSON extends ClerkResourceJSON {
   object: ObjectType.Permission;
   id: string;

diff --git a/packages/backend/src/api/resources/Role.ts b/packages/backend/src/api/resources/Role.ts
diff --git a/packages/backend/src/api/resources/index.ts b/packages/backend/src/api/resources/index.ts
@@ -22,7 +22,6 @@ export * from './Invitation';
 export * from './JSON';
 export * from './OauthAccessToken';
 export * from './Organization';
-export * from './Role';
 export * from './Permission';
 export * from './OrganizationInvitation';
 export * from './OrganizationMembership';

diff --git a/packages/backend/src/exports.test.ts b/packages/backend/src/exports.test.ts
@@ -27,7 +27,6 @@ export default (QUnit: QUnit) => {
         'Permission',
         'PhoneNumber',
         'RedirectUrl',
-        'Role',
         'SMSMessage',
         'Session',
         'SignInToken',

diff --git a/packages/nextjs/src/server/__tests__/__snapshots__/exports.test.ts.snap b/packages/nextjs/src/server/__tests__/__snapshots__/exports.test.ts.snap
@@ -21,7 +21,6 @@ exports[`/server public exports should not include a breaking change 1`] = `
   "Permission",
   "PhoneNumber",
   "RedirectUrl",
-  "Role",
   "SMSMessage",
   "Session",
   "SignInToken",

diff --git a/packages/sdk-node/src/__tests__/__snapshots__/exports.test.ts.snap b/packages/sdk-node/src/__tests__/__snapshots__/exports.test.ts.snap
@@ -23,7 +23,6 @@ exports[`module exports should not change unless explicitly set 1`] = `
   "Permission",
   "PhoneNumber",
   "RedirectUrl",
-  "Role",
   "SMSMessage",
   "Session",
   "SignInToken",
@@ -55,7 +54,6 @@ exports[`module exports should not change unless explicitly set 1`] = `
   "loadInterstitialFromLocal",
   "makeAuthObjectSerializable",
   "organizationPermissions",
-  "organizationRoles",
   "organizations",
   "phoneNumbers",
   "prunePrivateMetadata",

diff --git a/packages/sdk-node/src/index.ts b/packages/sdk-node/src/index.ts
@@ -28,7 +28,6 @@ const {
   emails,
   invitations,
   organizations,
-  organizationRoles,
   organizationPermissions,
   clients,
   allowlistIdentifiers,
@@ -43,7 +42,6 @@ export {
   emails,
   invitations,
   organizations,
-  organizationRoles,
   organizationPermissions,
   phoneNumbers,
   sessions,