Skip to content

Commit 35bcbd1

Browse files
authored
feat(clerk-js,shared): Adds username into public user data core-2 (#7837)
1 parent 13056f0 commit 35bcbd1

4 files changed

Lines changed: 12 additions & 0 deletions

File tree

.changeset/cute-crabs-agree.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
'@clerk/clerk-js': minor
3+
'@clerk/shared': minor
4+
---
5+
6+
Add `username` field into `PublicUserData` object.

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ export class PublicUserData implements IPublicUserData {
1111
hasImage!: boolean;
1212
identifier!: string;
1313
userId?: string;
14+
username?: string;
1415

1516
constructor(data: PublicUserDataJSON | PublicUserDataJSONSnapshot) {
1617
this.fromJSON(data);
@@ -24,6 +25,7 @@ export class PublicUserData implements IPublicUserData {
2425
this.hasImage = data.has_image || false;
2526
this.identifier = data.identifier || '';
2627
this.userId = data.user_id;
28+
this.username = data.username;
2729
}
2830

2931
return this;
@@ -37,6 +39,7 @@ export class PublicUserData implements IPublicUserData {
3739
has_image: this.hasImage,
3840
identifier: this.identifier,
3941
user_id: this.userId,
42+
username: this.username,
4043
};
4144
}
4245
}

packages/clerk-js/src/core/resources/__tests__/PublicUserData.test.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ describe('PublicUserData', () => {
1313
has_image: true,
1414
identifier: 'john-doe',
1515
user_id: '123',
16+
username: 'johndoe',
1617
});
1718

1819
expect(pud).toMatchObject({
@@ -22,6 +23,7 @@ describe('PublicUserData', () => {
2223
hasImage: true,
2324
identifier: 'john-doe',
2425
userId: '123',
26+
username: 'johndoe',
2527
});
2628
});
2729
});

packages/shared/src/types/json.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -338,6 +338,7 @@ export interface PublicUserDataJSON {
338338
has_image: boolean;
339339
identifier: string;
340340
user_id?: string;
341+
username?: string;
341342
}
342343

343344
export interface SessionWithActivitiesJSON extends Omit<SessionJSON, 'user'> {

0 commit comments

Comments
 (0)