feat(clerk-js): Introduce UserSettings.instanceIsPasswordBased

clerk · Feb 23, 2022 · f72a555 · f72a555
1 parent 111b993
commit f72a555
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 21 deletions.
diff --git a/packages/clerk-js/src/core/resources/UserSettings.test.ts b/packages/clerk-js/src/core/resources/UserSettings.test.ts
@@ -32,7 +32,30 @@ describe('UserSettings', () => {
     expect(res).toEqual(['web3_metamask_signature']);
   });
 
-  it('returns enabled social provier strategies', function () {
+  it('returns if the instance is passwordless or password-based', function () {
+    let sut = new UserSettings({
+      attributes: {
+        password: {
+          enabled: true,
+          required: true,
+        },
+      },
+    } as any as UserSettingsJSON);
+
+    expect(sut.instanceIsPasswordBased).toEqual(true);
+
+    sut = new UserSettings({
+      attributes: {
+        password: {
+          enabled: true,
+          required: false,
+        },
+      },
+    } as any as UserSettingsJSON);
+    expect(sut.instanceIsPasswordBased).toEqual(false);
+  });
+
+  it('returns enabled social provider strategies', function () {
     const sut = new UserSettings({
       social: {
         oauth_google: {

diff --git a/packages/clerk-js/src/core/resources/UserSettings.ts b/packages/clerk-js/src/core/resources/UserSettings.ts
@@ -9,7 +9,7 @@ import type {
   Web3Strategy,
 } from '@clerk/types';
 
-import {BaseResource} from './internal';
+import { BaseResource } from './internal';
 
 /**
  * @internal
@@ -23,42 +23,35 @@ export class UserSettings extends BaseResource implements UserSettingsResource {
 
   socialProviderStrategies: OAuthStrategy[] = [];
   web3FirstFactors: Web3Strategy[] = [];
-  enabledFirstFactorIdentifiers: Array<
-    keyof UserSettingsResource['attributes']
-  > = [];
+  enabledFirstFactorIdentifiers: Array<keyof UserSettingsResource['attributes']> = [];
 
   public constructor(data: UserSettingsJSON) {
     super();
     this.fromJSON(data);
   }
 
+  get instanceIsPasswordBased() {
+    return this.attributes.password.enabled && this.attributes.password.required;
+  }
+
   protected fromJSON(data: UserSettingsJSON): this {
     this.social = data.social;
     this.attributes = data.attributes;
     this.signIn = data.sign_in;
     this.signUp = data.sign_up;
-    this.socialProviderStrategies = this.getSocialProviderStrategies(
-      data.social,
-    );
+    this.socialProviderStrategies = this.getSocialProviderStrategies(data.social);
     this.web3FirstFactors = this.getWeb3FirstFactors(data.attributes);
-    this.enabledFirstFactorIdentifiers = this.getEnabledFirstFactorIdentifiers(
-      data.attributes,
-    );
+    this.enabledFirstFactorIdentifiers = this.getEnabledFirstFactorIdentifiers(data.attributes);
     return this;
   }
 
-  private getEnabledFirstFactorIdentifiers(
-    attributes: Attributes,
-  ): Array<keyof UserSettingsResource['attributes']> {
+  private getEnabledFirstFactorIdentifiers(attributes: Attributes): Array<keyof UserSettingsResource['attributes']> {
     if (!attributes) {
       return [];
     }
 
     return Object.entries(attributes)
-      .filter(
-        ([name, attr]) =>
-          attr.used_for_first_factor && !name.startsWith('web3'),
-      )
+      .filter(([name, attr]) => attr.used_for_first_factor && !name.startsWith('web3'))
       .map(([name]) => name) as Array<keyof UserSettingsResource['attributes']>;
   }
 
@@ -68,9 +61,7 @@ export class UserSettings extends BaseResource implements UserSettingsResource {
     }
 
     return Object.entries(attributes)
-      .filter(
-        ([name, attr]) => attr.used_for_first_factor && name.startsWith('web3'),
-      )
+      .filter(([name, attr]) => attr.used_for_first_factor && name.startsWith('web3'))
       .map(([, desc]) => desc.first_factors)
       .flat() as any as Web3Strategy[];
   }

diff --git a/packages/types/src/userSettings.ts b/packages/types/src/userSettings.ts
@@ -70,4 +70,5 @@ export interface UserSettingsResource extends ClerkResource {
   socialProviderStrategies: OAuthStrategy[];
   web3FirstFactors: Web3Strategy[];
   enabledFirstFactorIdentifiers: Attribute[];
+  instanceIsPasswordBased: boolean;
 }