fix(clerk-react,clerk-js,types): Crate of API feedback fixes

Author: igneel64

packages/clerk-js/src/core/clerk.ts

@@ -7,7 +7,6 @@ import type {
   Clerk as ClerkInterface,
   ClerkOptions,
   ClientResource,
-  CreateOrganizationInvitationParams,
   CreateOrganizationParams,
   EnvironmentResource,
   HandleMagicLinkVerificationParams,
@@ -65,7 +64,6 @@ import {
   MagicLinkError,
   MagicLinkErrorCode,
   Organization,
-  OrganizationInvitation,
 } from './resources/internal';
 
 export type ClerkCoreBroadcastChannelEvent = { type: 'signout' };
@@ -632,13 +630,6 @@ export default class Clerk implements ClerkInterface {
     this.#fapiClient.onAfterResponse(callback);
   }
 
-  __unstable_inviteMember = async (
-    organizationId: string,
-    params: CreateOrganizationInvitationParams,
-  ) => {
-    return await OrganizationInvitation.create(organizationId, params);
-  };
-
   #loadInBrowser = async (): Promise<void> => {
     this.#authService = new AuthenticationService(this);
 

packages/clerk-js/src/core/resources/Organization.ts

@@ -1,5 +1,5 @@
 import type {
-  GetMembersParams,
+  GetMembershipsParams,
   MembershipRole,
   OrganizationInvitationJSON,
   OrganizationJSON,
@@ -56,13 +56,13 @@ export class Organization extends BaseResource implements OrganizationResource {
       .catch(() => []);
   }
 
-  getMembers = async (
-    getMemberParams?: GetMembersParams,
+  getMemberships = async (
+    getMemberhipsParams?: GetMembershipsParams,
   ): Promise<OrganizationMembership[]> => {
     return await BaseResource._fetch({
       path: `/organizations/${this.id}/memberships`,
       method: 'GET',
-      search: getMemberParams as any,
+      search: getMemberhipsParams as any,
     })
       .then(res => {
         const members =
@@ -87,8 +87,8 @@ export class Organization extends BaseResource implements OrganizationResource {
       .catch(() => []);
   };
 
-  inviteUser = async (inviteUserParams: InviteUserParams) => {
-    return await OrganizationInvitation.create(this.id, inviteUserParams);
+  inviteMember = async (inviteMemberParams: InviteMemberParams) => {
+    return await OrganizationInvitation.create(this.id, inviteMemberParams);
   };
 
   updateMember = async ({
@@ -105,10 +105,14 @@ export class Organization extends BaseResource implements OrganizationResource {
     );
   };
 
-  removeMember = async (userId: string) => {
-    return await this._baseDelete({
+  removeMember = async (userId: string): Promise<OrganizationMembership> => {
+    return await BaseResource._fetch({
+      method: 'DELETE',
       path: `/organizations/${this.id}/memberships/${userId}`,
-    });
+    }).then(
+      res =>
+        new OrganizationMembership(res?.response as OrganizationMembershipJSON),
+    );
   };
 
   protected fromJSON(data: OrganizationJSON): this {
@@ -128,7 +132,7 @@ export type GetOrganizationParams = {
   offset?: number;
 };
 
-export type InviteUserParams = {
+export type InviteMemberParams = {
   emailAddress: string;
   role: MembershipRole;
   redirectUrl?: string;

packages/clerk-js/src/core/resources/OrganizationInvitation.ts

@@ -44,7 +44,7 @@ export class OrganizationInvitation
     this.fromJSON(data);
   }
 
-  revoke = async () => {
+  revoke = async (): Promise<OrganizationInvitation> => {
     return await this._basePost({
       path: `/organizations/${this.organizationId}/invitations/${this.id}/revoke`,
     });

packages/clerk-js/src/core/resources/OrganizationMembership.test.ts

@@ -5,6 +5,7 @@ describe('OrganizationMembership', () => {
     const organizationMemberShip = new OrganizationMembership({
       object: 'organization_membership',
       id: 'test_id',
+      organization_id: 'test_org_id',
       created_at: 12345,
       updated_at: 5678,
       role: 'admin',

packages/clerk-js/src/core/resources/OrganizationMembership.ts

@@ -6,19 +6,43 @@ import {
 } from '@clerk/types';
 import { unixEpochToDate } from 'utils/date';
 
-export class OrganizationMembership implements OrganizationMembershipResource {
+import { BaseResource } from './internal';
+
+export class OrganizationMembership
+  extends BaseResource
+  implements OrganizationMembershipResource
+{
   id!: string;
+  organizationId!: string;
   publicUserData!: PublicUserData;
   role!: MembershipRole;
   createdAt!: Date;
   updatedAt!: Date;
 
   constructor(data: OrganizationMembershipJSON) {
+    super();
     this.fromJSON(data);
   }
 
+  destroy = async (): Promise<OrganizationMembership> => {
+    // FIXME: Revise the return type of _baseDelete
+    return (await this._baseDelete({
+      path: `/organizations/${this.organizationId}/memberships/${this.publicUserData.userId}`,
+    })) as unknown as OrganizationMembership;
+  };
+
+  update = async ({
+    role,
+  }: UpdateOrganizationMembershipParams): Promise<OrganizationMembership> => {
+    return await this._basePatch({
+      path: `/organizations/${this.organizationId}/memberships/${this.publicUserData.userId}`,
+      body: { role },
+    });
+  };
+
   protected fromJSON(data: OrganizationMembershipJSON): this {
     this.id = data.id;
+    this.organizationId = data.organization_id;
     this.publicUserData = {
       firstName: data.public_user_data.first_name,
       lastName: data.public_user_data.last_name,
@@ -32,3 +56,7 @@ export class OrganizationMembership implements OrganizationMembershipResource {
     return this;
   }
 }
+
+export type UpdateOrganizationMembershipParams = {
+  role: MembershipRole;
+};

packages/clerk-js/src/core/resources/__snapshots__/Organization.test.ts.snap

@@ -4,11 +4,11 @@ exports[`Organization has the same initial properties 1`] = `
 Organization {
   "createdAt": 1970-01-01T00:00:12.345Z,
   "createdBy": "test_user_id",
-  "getMembers": [Function],
+  "getMemberships": [Function],
   "getPendingInvitations": [Function],
   "id": "test_id",
   "instanceId": "test_instance_id",
-  "inviteUser": [Function],
+  "inviteMember": [Function],
   "name": "test_name",
   "pathRoot": "",
   "removeMember": [Function],

packages/clerk-js/src/core/resources/__snapshots__/OrganizationMembership.test.ts.snap

@@ -3,7 +3,10 @@
 exports[`OrganizationMembership has the same initial properties 1`] = `
 OrganizationMembership {
   "createdAt": 1970-01-01T00:00:12.345Z,
+  "destroy": [Function],
   "id": "test_id",
+  "organizationId": "test_org_id",
+  "pathRoot": "",
   "publicUserData": Object {
     "firstName": "test_first_name",
     "identifier": "test@identifier.gr",
@@ -12,6 +15,7 @@ OrganizationMembership {
     "userId": undefined,
   },
   "role": "admin",
+  "update": [Function],
   "updatedAt": 1970-01-01T00:00:05.678Z,
 }
 `;

packages/react/src/hooks/index.ts

@@ -1,3 +1,2 @@
-export * from './useOrganization';
 export * from './useOrganizations';
 export * from './useMagicLink';

packages/react/src/hooks/useOrganization.ts

@@ -237,21 +237,6 @@ export default class IsomorphicClerk {
     }
   }
 
-  __unstable_inviteMember = async (
-    organizationId: string,
-    params: CreateOrganizationInvitationParams,
-  ): Promise<OrganizationInvitationResource | void> => {
-    const callback = () =>
-      // @ts-expect-error
-      this.clerkjs.__unstable_inviteMember(organizationId, params);
-    if (this.clerkjs && this._loaded) {
-      return callback() as Promise<OrganizationInvitationResource>;
-    } else {
-      // @ts-expect-error
-      this.premountMethodCalls.set('__unstable_inviteMember', callback);
-    }
-  };
-
   setSession = (
     session: ActiveSessionResource | string | null,
     beforeEmit?: (session: ActiveSessionResource | null) => void | Promise<any>,

packages/react/src/isomorphicClerk.ts

@@ -334,6 +334,7 @@ export interface OrganizationJSON extends ClerkResourceJSON {
 export interface OrganizationMembershipJSON extends ClerkResourceJSON {
   object: 'organization_membership';
   id: string;
+  organization_id: string;
   public_user_data: PublicUserDataJSON;
   role: MembershipRole;
   created_at: number;

packages/types/src/json.ts

@@ -1,3 +1,5 @@
+import { MembershipRole } from '.';
+
 export interface JWTClaims {
   __raw: string;
   sub: string;
@@ -8,9 +10,11 @@ export interface JWTClaims {
   iat?: number;
   nbf?: number;
   name?: string;
+  orgs?: OrganizationsJWTClaim;
   [key: string]: unknown;
 }
 
+export type OrganizationsJWTClaim = Record<string, MembershipRole>;
 // eslint-disable-next-line @typescript-eslint/naming-convention
 export interface JWT {
   encoded: { header: string; payload: string; signature: string };

packages/types/src/jwt.ts

@@ -1,4 +1,8 @@
-import { MembershipRole, OrganizationMembershipResource } from '.';
+import {
+  MembershipRole,
+  OrganizationInvitationResource,
+  OrganizationMembershipResource,
+} from '.';
 
 export interface OrganizationResource {
   id: string;
@@ -8,12 +12,31 @@ export interface OrganizationResource {
   createdBy: string;
   createdAt: Date;
   updatedAt: Date;
-  getMembers: (
-    params?: GetMembersParams,
+  getMemberships: (
+    params?: GetMembershipsParams,
   ) => Promise<OrganizationMembershipResource[]>;
+  getPendingInvitations: () => Promise<OrganizationInvitationResource[]>;
+  inviteMember: (
+    params: InviteMemberParams,
+  ) => Promise<OrganizationInvitationResource>;
+  updateMember: (
+    params: UpdateMembershipParams,
+  ) => Promise<OrganizationMembershipResource>;
+  removeMember: (userId: string) => Promise<OrganizationMembershipResource>;
 }
 
-export interface GetMembersParams {
+export interface GetMembershipsParams {
   limit?: number;
   offset?: number;
 }
+
+export interface InviteMemberParams {
+  emailAddress: string;
+  role: MembershipRole;
+  redirectUrl?: string;
+}
+
+export interface UpdateMembershipParams {
+  userId: string;
+  role: MembershipRole;
+}

packages/types/src/organization.ts

@@ -2,6 +2,7 @@ import { PublicUserData } from '.';
 
 export interface OrganizationMembershipResource {
   id: string;
+  organizationId: string;
   publicUserData: PublicUserData;
   role: MembershipRole;
   createdAt: Date;