Skip to content

fix(clerk-js,types): Handle missing publicUserData in OrganizationMembership #6016

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 28, 2025
+16 −8
Merged

fix(clerk-js,types): Handle missing publicUserData in OrganizationMembership #6016

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
258336c
fix(clerk-js,types): Handle missing publicUserData in
tmilewski May 27, 2025
a1d4c47
fix: Typing
tmilewski May 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/three-days-wash.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
'@clerk/clerk-js': patch
'@clerk/types': patch
---

Handle missing `publicUserData` in `OrganizationMembership`
10 changes: 6 additions & 4 deletions packages/clerk-js/src/core/resources/OrganizationMembership.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import { BaseResource, Organization, PublicUserData } from './internal';
export class OrganizationMembership extends BaseResource implements OrganizationMembershipResource {
id!: string;
publicMetadata: OrganizationMembershipPublicMetadata = {};
publicUserData!: PublicUserData;
publicUserData?: PublicUserData;
organization!: Organization;
permissions: OrganizationPermissionKey[] = [];
role!: OrganizationCustomRoleKey;
Expand Down Expand Up @@ -50,14 +50,16 @@ export class OrganizationMembership extends BaseResource implements Organization

destroy = async (): Promise<OrganizationMembership> => {
// TODO: Revise the return type of _baseDelete
// TODO: Handle case where publicUserData is not present
return (await this._baseDelete({
path: `/organizations/${this.organization.id}/memberships/${this.publicUserData.userId}`,
path: `/organizations/${this.organization.id}/memberships/${this.publicUserData?.userId}`,
})) as unknown as OrganizationMembership;
};

update = async ({ role }: UpdateOrganizationMembershipParams): Promise<OrganizationMembership> => {
// TODO: Handle case where publicUserData is not present
Copy link
Member

@panteliselef panteliselef May 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

are the todo's needed ?

return await this._basePatch({
path: `/organizations/${this.organization.id}/memberships/${this.publicUserData.userId}`,
path: `/organizations/${this.organization.id}/memberships/${this.publicUserData?.userId}`,
body: { role },
});
};
Expand Down Expand Up @@ -86,7 +88,7 @@ export class OrganizationMembership extends BaseResource implements Organization
id: this.id,
organization: this.organization.__internal_toSnapshot(),
public_metadata: this.publicMetadata,
public_user_data: this.publicUserData.__internal_toSnapshot(),
public_user_data: this.publicUserData?.__internal_toSnapshot(),
permissions: this.permissions,
role: this.role,
created_at: this.createdAt.getTime(),
Expand Down
4 changes: 2 additions & 2 deletions packages/clerk-js/src/ui/components/OrganizationProfile/ActiveMembersList.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ const MemberRow = (props: {
const card = useCardState();
const { user } = useUser();

const isCurrentUser = user?.id === membership.publicUserData.userId;
const isCurrentUser = user?.id === membership.publicUserData?.userId;
const unlocalizedRoleLabel = options?.find(a => a.value === membership.role)?.label;

return (
Expand All @@ -85,7 +85,7 @@ const MemberRow = (props: {
<UserPreview
sx={{ maxWidth: '30ch' }}
user={membership.publicUserData}
subtitle={membership.publicUserData.identifier}
subtitle={membership.publicUserData?.identifier}
badge={isCurrentUser && <Badge localizationKey={localizationKeys('badge__you')} />}
/>
</Td>
Expand Down
2 changes: 1 addition & 1 deletion packages/types/src/json.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -390,7 +390,7 @@ export interface OrganizationMembershipJSON extends ClerkResourceJSON {
organization: OrganizationJSON;
permissions: OrganizationPermissionKey[];
public_metadata: OrganizationMembershipPublicMetadata;
public_user_data: PublicUserDataJSON;
public_user_data?: PublicUserDataJSON;
role: OrganizationCustomRoleKey;
created_at: number;
updated_at: number;
Expand Down
2 changes: 1 addition & 1 deletion packages/types/src/organizationMembership.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ export interface OrganizationMembershipResource extends ClerkResource {
organization: OrganizationResource;
permissions: OrganizationPermissionKey[];
publicMetadata: OrganizationMembershipPublicMetadata;
publicUserData: PublicUserData;
publicUserData?: PublicUserData;
role: OrganizationCustomRoleKey;
createdAt: Date;
updatedAt: Date;
Expand Down
Loading