feat(backend,types,clerk-js): Introduce hasImage

* feat(backend): Add has_image field in user / organization * feat(clerk-js): Add has_image field in user / organization * feat(types): Add has_image field in user / organization / session * chore(repo): Add changeset for hasImage property
clerk · Aug 2, 2023 · 86de584 · 86de584
1 parent 0ba4245
commit 86de584
Show file tree

Hide file tree

Showing 16 changed files with 34 additions and 0 deletions.
diff --git a/.changeset/quiet-shirts-notice.md b/.changeset/quiet-shirts-notice.md
@@ -0,0 +1,7 @@
+---
+'@clerk/clerk-js': minor
+'@clerk/backend': minor
+'@clerk/types': minor
+---
+
+Introduce `hasImage` in User / Organization / Session resources
diff --git a/packages/backend/src/api/resources/JSON.ts b/packages/backend/src/api/resources/JSON.ts
@@ -138,6 +138,7 @@ export interface OrganizationJSON extends ClerkResourceJSON {
    */
   logo_url: string | null;
   image_url: string;
+  has_image: boolean;
   public_metadata: OrganizationPublicMetadata | null;
   private_metadata?: OrganizationPrivateMetadata;
   created_by: string;
@@ -178,6 +179,7 @@ export interface OrganizationMembershipPublicUserDataJSON {
    */
   profile_image_url: string;
   image_url: string;
+  has_image: boolean;
   user_id: string;
 }
 
@@ -264,6 +266,7 @@ export interface UserJSON extends ClerkResourceJSON {
    */
   profile_image_url: string;
   image_url: string;
+  has_image: boolean;
   primary_email_address_id: string;
   primary_phone_number_id: string | null;
   primary_web3_wallet_id: string | null;

diff --git a/packages/backend/src/api/resources/Organization.ts b/packages/backend/src/api/resources/Organization.ts
@@ -10,6 +10,7 @@ export class Organization {
      */
     readonly logoUrl: string | null,
     readonly imageUrl: string,
+    readonly hasImage: boolean,
     readonly createdBy: string,
     readonly createdAt: number,
     readonly updatedAt: number,
@@ -26,6 +27,7 @@ export class Organization {
       data.slug,
       data.logo_url,
       data.image_url,
+      data.has_image,
       data.created_by,
       data.created_at,
       data.updated_at,

diff --git a/packages/backend/src/api/resources/OrganizationMembership.ts b/packages/backend/src/api/resources/OrganizationMembership.ts
@@ -38,6 +38,7 @@ export class OrganizationMembershipPublicUserData {
      */
     readonly profileImageUrl: string,
     readonly imageUrl: string,
+    readonly hasImage: boolean,
     readonly userId: string,
   ) {}
 
@@ -48,6 +49,7 @@ export class OrganizationMembershipPublicUserData {
       data.last_name,
       data.profile_image_url,
       data.image_url,
+      data.has_image,
       data.user_id,
     );
   }

diff --git a/packages/backend/src/api/resources/User.ts b/packages/backend/src/api/resources/User.ts
@@ -19,6 +19,7 @@ export class User {
      */
     readonly profileImageUrl: string,
     readonly imageUrl: string,
+    readonly hasImage: boolean,
     readonly gender: string,
     readonly birthday: string,
     readonly primaryEmailAddressId: string | null,
@@ -50,6 +51,7 @@ export class User {
       data.updated_at,
       data.profile_image_url,
       data.image_url,
+      data.has_image,
       data.gender,
       data.birthday,
       data.primary_email_address_id,

diff --git a/packages/clerk-js/src/core/resources/Organization.test.ts b/packages/clerk-js/src/core/resources/Organization.test.ts
@@ -16,6 +16,7 @@ describe('Organization', () => {
       pending_invitations_count: 10,
       admin_delete_enabled: true,
       max_allowed_memberships: 3,
+      has_image: true,
     });
 
     expect(organization).toMatchSnapshot();

diff --git a/packages/clerk-js/src/core/resources/Organization.ts b/packages/clerk-js/src/core/resources/Organization.ts
@@ -29,6 +29,7 @@ export class Organization extends BaseResource implements OrganizationResource {
    */
   logoUrl!: string;
   imageUrl!: string;
+  hasImage!: boolean;
   publicMetadata: OrganizationPublicMetadata = {};
   adminDeleteEnabled!: boolean;
   createdAt!: Date;
@@ -181,6 +182,7 @@ export class Organization extends BaseResource implements OrganizationResource {
     this.slug = data.slug;
     this.logoUrl = data.logo_url;
     this.imageUrl = data.image_url;
+    this.hasImage = data.has_image;
     this.publicMetadata = data.public_metadata;
     this.membersCount = data.members_count;
     this.pendingInvitationsCount = data.pending_invitations_count;

diff --git a/packages/clerk-js/src/core/resources/OrganizationMembership.test.ts b/packages/clerk-js/src/core/resources/OrganizationMembership.test.ts
@@ -22,6 +22,7 @@ describe('OrganizationMembership', () => {
         pending_invitations_count: 10,
         admin_delete_enabled: true,
         max_allowed_memberships: 3,
+        has_image: true,
       },
       public_metadata: {
         foo: 'bar',
@@ -34,6 +35,7 @@ describe('OrganizationMembership', () => {
         image_url: 'https://clerk.com',
         identifier: 'test@identifier.gr',
         id: 'test_user_id',
+        has_image: true,
       },
     });
 

diff --git a/packages/clerk-js/src/core/resources/OrganizationMembership.ts b/packages/clerk-js/src/core/resources/OrganizationMembership.ts
@@ -68,6 +68,7 @@ export class OrganizationMembership extends BaseResource implements Organization
         lastName: data.public_user_data.last_name,
         profileImageUrl: data.public_user_data.profile_image_url,
         imageUrl: data.public_user_data.image_url,
+        hasImage: data.public_user_data.has_image,
         identifier: data.public_user_data.identifier,
         userId: data.public_user_data.user_id,
       };

diff --git a/packages/clerk-js/src/core/resources/User.ts b/packages/clerk-js/src/core/resources/User.ts
@@ -79,6 +79,7 @@ export class User extends BaseResource implements UserResource {
    */
   profileImageUrl = '';
   imageUrl = '';
+  hasImage = false;
   twoFactorEnabled = false;
   totpEnabled = false;
   backupCodeEnabled = false;
@@ -296,6 +297,7 @@ export class User extends BaseResource implements UserResource {
 
     this.profileImageUrl = data.profile_image_url;
     this.imageUrl = data.image_url;
+    this.hasImage = data.has_image;
     this.username = data.username;
     this.passwordEnabled = data.password_enabled;
     this.emailAddresses = (data.email_addresses || []).map(

diff --git a/packages/clerk-js/src/core/resources/__snapshots__/Organization.test.ts.snap b/packages/clerk-js/src/core/resources/__snapshots__/Organization.test.ts.snap
@@ -8,6 +8,7 @@ Organization {
   "destroy": [Function],
   "getMemberships": [Function],
   "getPendingInvitations": [Function],
+  "hasImage": true,
   "id": "test_id",
   "imageUrl": "https://clerk.com",
   "inviteMember": [Function],

diff --git a/packages/clerk-js/src/core/resources/__snapshots__/OrganizationMembership.test.ts.snap b/packages/clerk-js/src/core/resources/__snapshots__/OrganizationMembership.test.ts.snap
@@ -12,6 +12,7 @@ OrganizationMembership {
     "destroy": [Function],
     "getMemberships": [Function],
     "getPendingInvitations": [Function],
+    "hasImage": true,
     "id": "test_org_id",
     "imageUrl": "https://clerk.com",
     "inviteMember": [Function],
@@ -38,6 +39,7 @@ OrganizationMembership {
   },
   "publicUserData": {
     "firstName": "test_first_name",
+    "hasImage": true,
     "identifier": "test@identifier.gr",
     "imageUrl": "https://clerk.com",
     "lastName": "test_last_name",

diff --git a/packages/types/src/json.ts b/packages/types/src/json.ts
@@ -188,6 +188,7 @@ export interface UserJSON extends ClerkResourceJSON {
    */
   profile_image_url: string;
   image_url: string;
+  has_image: boolean;
   username: string;
   email_addresses: EmailAddressJSON[];
   phone_numbers: PhoneNumberJSON[];
@@ -228,6 +229,7 @@ export interface PublicUserDataJSON extends ClerkResourceJSON {
    */
   profile_image_url: string;
   image_url: string;
+  has_image: boolean;
   identifier: string;
   user_id?: string;
 }
@@ -306,6 +308,7 @@ export interface OrganizationJSON extends ClerkResourceJSON {
    */
   logo_url: string;
   image_url: string;
+  has_image: boolean;
   name: string;
   slug: string;
   public_metadata: OrganizationPublicMetadata;
@@ -360,6 +363,7 @@ export interface UserDataJSON {
    */
   profile_image_url?: string;
   image_url: string;
+  has_image: boolean;
 }
 
 export interface TOTPJSON extends ClerkResourceJSON {

diff --git a/packages/types/src/organization.ts b/packages/types/src/organization.ts
@@ -32,6 +32,7 @@ export interface OrganizationResource extends ClerkResource {
    */
   logoUrl: string | null;
   imageUrl: string;
+  hasImage: boolean;
   membersCount: number;
   pendingInvitationsCount: number;
   publicMetadata: OrganizationPublicMetadata;

diff --git a/packages/types/src/session.ts b/packages/types/src/session.ts
@@ -61,6 +61,7 @@ export interface PublicUserData {
    */
   profileImageUrl: string;
   imageUrl: string;
+  hasImage: boolean;
   identifier: string;
   userId?: string;
 }

diff --git a/packages/types/src/user.ts b/packages/types/src/user.ts
@@ -64,6 +64,7 @@ export interface UserResource extends ClerkResource {
    */
   profileImageUrl: string;
   imageUrl: string;
+  hasImage: boolean;
   emailAddresses: EmailAddressResource[];
   phoneNumbers: PhoneNumberResource[];
   web3Wallets: Web3WalletResource[];