Convert class methods into properties wherever it is relevant (#23)

* Convert class methods into properties wherever it is relevant * Added code coverage report config * Moving simple logics from functions to properties
auth0 · Jan 9, 2025 · 096b0a4 · 096b0a4
1 parent 36e01a6
commit 096b0a4
Show file tree

Hide file tree

Showing 67 changed files with 474 additions and 387 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,5 @@
 node_modules/
 dist/
 docs/
+coverage/
 .DS_Store
diff --git a/packages/auth0-acul-js/interfaces/models/branding.ts b/packages/auth0-acul-js/interfaces/models/branding.ts
@@ -58,6 +58,6 @@ export interface BrandingThemes{
 
 /* @namespace Client */
 export interface BrandingMembers {
-  getSettings(): BrandingSettings | null;
-  getThemes(): BrandingThemes | null;
+  settings: BrandingSettings | null;
+  themes: BrandingThemes | null;
 }
diff --git a/packages/auth0-acul-js/interfaces/models/client.ts b/packages/auth0-acul-js/interfaces/models/client.ts
@@ -14,5 +14,5 @@ export interface ClientMembers {
   name: string;
   logoUri: string | null;
   description: string | null;
-  getMetadata(): { [key: string]: string } | null;
+  metadata: { [key: string]: string } | null;
 }
diff --git a/packages/auth0-acul-js/interfaces/models/organization.ts b/packages/auth0-acul-js/interfaces/models/organization.ts
@@ -20,7 +20,7 @@ export interface OrganizationMembers {
   name: string | null;
   usage: string | null;
   displayName: string | null;
-  getBranding():
+  branding:
     | {
         logoUrl?: string | undefined;
         colors?: {
@@ -29,5 +29,5 @@ export interface OrganizationMembers {
         };
       }
     | null;
-  getMetadata(): { [key: string]: string } | null;
+  metadata: { [key: string]: string } | null;
 }
diff --git a/packages/auth0-acul-js/interfaces/models/screen.ts b/packages/auth0-acul-js/interfaces/models/screen.ts
@@ -51,8 +51,8 @@ export interface ScreenMembers {
   captchaSiteKey: string | null;
   captchaProvider: string | null;
   isCaptchaAvailable: boolean;
-  getScreenData(): Record<string, string> | null;
-  getScreenLinks(): Record<string, string> | null;
-  getScreenTexts(): Record<string, string> | null;
-  getCaptchaConfig(): CaptchaContext | null;
+  data: Record<string, string> | null;
+  links: Record<string, string> | null;
+  texts: Record<string, string> | null;
+  captcha: CaptchaContext | null;
 }
diff --git a/packages/auth0-acul-js/interfaces/models/tenant.ts b/packages/auth0-acul-js/interfaces/models/tenant.ts
@@ -8,6 +8,6 @@ export interface TenantContext {
 export interface TenantMembers {
   name: string | null;
   friendlyName: string | null;
-  getEnabledLocales(): string[] | null;
-  getEnabledFactors(): string[] | null;
+  enabledLocales: string[] | null;
+  enabledFactors: string[] | null;
 }
diff --git a/packages/auth0-acul-js/interfaces/models/transaction.ts b/packages/auth0-acul-js/interfaces/models/transaction.ts
@@ -139,7 +139,7 @@ export interface TransactionMembers {
   countryPrefix: CountryCode['prefix'] | null;
   connectionStrategy: string | null;
   hasErrors: boolean;
-  getErrors(): Error[] | null;
-  getCurrentConnection(): Connection | null;
-  getAlternateConnections(): (Connection | EnterpriseConnection)[] | null;
+  errors: Error[] | null;
+  currentConnection: Connection | null;
+  alternateConnections: (Connection | EnterpriseConnection)[] | null;
 }
diff --git a/packages/auth0-acul-js/interfaces/models/untrusted-data.ts b/packages/auth0-acul-js/interfaces/models/untrusted-data.ts
@@ -12,8 +12,8 @@ export interface UntrustedDataContext {
 }
 
 export interface UntrustedDataMembers {
-  getSubmittedFormData(): { [key: string]: any } | null;
-  getAuthParams(): {
+  submittedFormData: { [key: string]: any } | null;
+  authParams: {
     loginHint: string | undefined;
     screenHint: string | undefined;
     uiLocales: string | undefined;

diff --git a/packages/auth0-acul-js/interfaces/models/user.ts b/packages/auth0-acul-js/interfaces/models/user.ts
@@ -22,8 +22,8 @@ export interface UserMembers {
   email: string | null;
   picture: string | null;
   phoneNumber: string | null;
-  getEnrolledFactors(): Array<string> | null;
-  getOrganizations():
+  enrolledFactors: Array<string> | null;
+  organizations:
     | {
         organizationId: string | undefined;
         organizationName: string | undefined;
@@ -35,6 +35,6 @@ export interface UserMembers {
           | undefined;
       }[]
     | null;
-  getUserMetadata(): { [key: string]: string } | null;
-  getAppMetadata(): { [key: string]: string } | null;
+  userMetadata: { [key: string]: string } | null;
+  appMetadata: { [key: string]: string } | null;
 }
diff --git a/packages/auth0-acul-js/interfaces/screens/email-identifier-challenge.ts b/packages/auth0-acul-js/interfaces/screens/email-identifier-challenge.ts
@@ -9,7 +9,7 @@ export interface EmailChallengeOptions {
 }
 
 export interface ScreenMembersOnEmailIdentifierChallenge extends ScreenMembers {
-  getScreenData(): {
+  data: {
     messageType?: string;
     email?: string;
   } | null;

diff --git a/packages/auth0-acul-js/interfaces/screens/login-id.ts b/packages/auth0-acul-js/interfaces/screens/login-id.ts
@@ -30,16 +30,16 @@ export interface LoginId extends BaseContext {
 export interface ScreenMembersOnLoginId extends ScreenMembers {
   signupLink: string | null;
   resetPasswordLink: string | null;
-  getPublicKey(): PasskeyRead['public_key'] | null;
+  publicKey: PasskeyRead['public_key'] | null;
 }
 
 export interface TransactionMembersOnLoginId extends TransactionMembers {
   isSignupEnabled: boolean;
   isPasskeyEnabled: boolean;
   isForgotPasswordEnabled: boolean;
   isUsernameRequired: boolean;
-  getUsernamePolicy(): UsernamePolicy | null;
-  getAllowedIdentifiers(): ('email' | 'username' | 'phone')[] | null;
+  usernamePolicy: UsernamePolicy | null;
+  allowedIdentifiers: ('email' | 'username' | 'phone')[] | null;
 }
 
 export interface LoginOptions {

diff --git a/packages/auth0-acul-js/interfaces/screens/login-password.ts b/packages/auth0-acul-js/interfaces/screens/login-password.ts
@@ -14,7 +14,7 @@ export interface ScreenMembersOnLoginPassword extends ScreenMembers {
   signupLink: string | null;
   resetPasswordLink: string | null;
   editIdentifierLink: string | null;
-  getScreenData(): {
+  data: {
     username: string;
   } | null;
 }

diff --git a/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts b/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts
@@ -8,7 +8,7 @@ export interface ScreenMembersOnLoginPasswordlessEmailCode extends ScreenMembers
   editIdentifierLink: string | null;
   resetPasswordLink: string | null;
   signupLink: string | null;
-  getScreenData(): {
+  data: {
     email?: string;
     username?: string;
   } | null;

diff --git a/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts b/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts
@@ -13,6 +13,9 @@ export interface ScreenMembersOnLoginPasswordlessSmsOtp extends ScreenMembers {
   signupLink: string | null;
   resetPasswordLink: string | null;
   backLink: string | null;
+  data: {
+    username: string;
+  }
 }
 
 export interface TransactionMembersOnLoginPasswordlessSmsOtp extends TransactionMembers {

diff --git a/packages/auth0-acul-js/interfaces/screens/passkey-enrollment-local.ts b/packages/auth0-acul-js/interfaces/screens/passkey-enrollment-local.ts
@@ -22,7 +22,7 @@ export interface AbortEnrollmentOptions {
 }
 
 export interface ScreenMembersOnPasskeyEnrollmentLocal extends ScreenMembers {
-  getPublicKey: () => PasskeyCreate['public_key'] | null;
+  publicKey: PasskeyCreate['public_key'] | null;
 }
 
 export interface PasskeyEnrollmentLocalMembers extends BaseMembers {

diff --git a/packages/auth0-acul-js/interfaces/screens/passkey-enrollment.ts b/packages/auth0-acul-js/interfaces/screens/passkey-enrollment.ts
@@ -19,7 +19,7 @@ export interface PasskeyEnrollment extends BaseContext {
 export interface ScreenMembersOnPasskeyEnrollment extends ScreenMembers {
   backLink: string | null;
   loginLink: string | null;
-  getPublicKey: () => PasskeyCreate['public_key'] | null;
+  publicKey: PasskeyCreate['public_key'] | null;
 }
 
 export interface PasskeyEnrollmentMembers extends BaseMembers {

diff --git a/packages/auth0-acul-js/interfaces/screens/phone-identifier-challenge.ts b/packages/auth0-acul-js/interfaces/screens/phone-identifier-challenge.ts
@@ -21,7 +21,7 @@ export interface ExtendedScreenContext extends ScreenContext {
 }
 
 export interface ScreenMembersOnPhoneIdentifierChallenge extends ScreenMembers {
-  getScreenData(): {
+  data: {
     messageType?: 'text' | 'voice';
     phone?: string;
   } | null;

diff --git a/packages/auth0-acul-js/interfaces/screens/phone-identifier-enrollment.ts b/packages/auth0-acul-js/interfaces/screens/phone-identifier-enrollment.ts
@@ -8,9 +8,9 @@ export interface ScreenDataOptions extends ScreenData {
 }
 
 export interface ScreenMembersOnPhoneIdentifierEnrollment extends ScreenMembers {
-  getScreenData(): {
-    messageType?: 'text' | 'voice';
+  data: {
     phone?: 'string';
+    messageType?: 'text' | 'voice';
   } | null;
   editIdentifierLink: string | null;
 }

diff --git a/packages/auth0-acul-js/interfaces/screens/signup-id.ts b/packages/auth0-acul-js/interfaces/screens/signup-id.ts
@@ -24,9 +24,9 @@ export interface ScreenMembersOnSignupId extends ScreenMembers {
 
 export interface TransactionMembersOnSignupId extends TransactionMembers {
   isPasskeyEnabled: boolean;
-  getUsernamePolicy(): UsernamePolicy | null;
-  getRequiredIdentifiers(): ('email' | 'username' | 'phone')[] | null;
-  getOptionalIdentifiers(): ('email' | 'username' | 'phone')[] | null;
+  usernamePolicy: UsernamePolicy | null;
+  requiredIdentifiers: ('email' | 'username' | 'phone')[] | null;
+  optionalIdentifiers: ('email' | 'username' | 'phone')[] | null;
 }
 
 export interface SignupId extends BaseContext {

diff --git a/packages/auth0-acul-js/interfaces/screens/signup-password.ts b/packages/auth0-acul-js/interfaces/screens/signup-password.ts
@@ -22,7 +22,7 @@ export interface SignupPassword extends BaseContext {
 export interface ScreenMembersOnSignupPassword extends ScreenMembers {
   loginLink: string | null;
   editLink: string | null;
-  getScreenData(): {
+  data: {
     email?: string;
     phone?: string;
     username?: string;
@@ -31,9 +31,9 @@ export interface ScreenMembersOnSignupPassword extends ScreenMembers {
 
 export interface TransactionMembersOnSignupPassword extends TransactionMembers {
   isPasskeyEnabled: boolean;
-  getPasswordPolicy(): PasswordPolicy | null;
-  getRequiredIdentifiers(): ('email' | 'username' | 'phone')[] | null;
-  getOptionalIdentifiers(): ('email' | 'username' | 'phone')[] | null;
+  passwordPolicy: PasswordPolicy | null;
+  requiredIdentifiers: ('email' | 'username' | 'phone')[] | null;
+  optionalIdentifiers: ('email' | 'username' | 'phone')[] | null;
 }
 
 export interface SignupPasswordOptions {

diff --git a/packages/auth0-acul-js/jest.config.js b/packages/auth0-acul-js/jest.config.js
@@ -14,4 +14,12 @@ export default {
     ],
   },
   roots: ['<rootDir>/tests/unit'],
+  collectCoverage: true,
+  coverageDirectory: '<rootDir>/coverage',
+  coverageReporters: ['text', 'lcov'],
+  collectCoverageFrom: [
+    '**/*.{ts,tsx}',
+    '!**/node_modules/**',
+    '!**/tests/**',
+  ],
 };
diff --git a/packages/auth0-acul-js/src/models/base-context.ts b/packages/auth0-acul-js/src/models/base-context.ts
@@ -14,7 +14,6 @@ import type { BaseContext as UniversalLoginContext, BaseMembers } from '../../in
 import { Branding, Client, Prompt, Screen, Organization, User, Transaction, Tenant, UntrustedData } from '../models';
 
 export class BaseContext implements BaseMembers {
-  private context: UniversalLoginContext;
   branding: BrandingMembers;
   screen: ScreenMembers;
   tenant: TenantMembers;
@@ -25,21 +24,32 @@ export class BaseContext implements BaseMembers {
   user: UserMembers;
   untrustedData: UntrustedDataMembers;
 
+  private static context: UniversalLoginContext | null = null;
+
   constructor() {
-    this.context = (window as any).universal_login_context as UniversalLoginContext;
-    this.branding = new Branding(this.context.branding);
-    this.screen = new Screen(this.context.screen);
-    this.tenant = new Tenant(this.context.tenant);
-    this.prompt = new Prompt(this.context.prompt);
-    this.organization = new Organization(this.context.organization);
-    this.client = new Client(this.context.client);
-    this.transaction = new Transaction(this.context.transaction);
-    this.user = new User(this.context.user);
-    this.untrustedData = new UntrustedData(this.context.untrusted_data);
+    if (!BaseContext.context) {
+      BaseContext.context = (window as any).universal_login_context as UniversalLoginContext;
+    }
+
+    const context = BaseContext.context;
+
+    this.branding = new Branding(context.branding);
+    this.screen = new Screen(context.screen);
+    this.tenant = new Tenant(context.tenant);
+    this.prompt = new Prompt(context.prompt);
+    this.organization = new Organization(context.organization);
+    this.client = new Client(context.client);
+    this.transaction = new Transaction(context.transaction);
+    this.user = new User(context.user);
+    this.untrustedData = new UntrustedData(context.untrusted_data);
   }
 
   /** @ignore */
   getContext<K extends keyof UniversalLoginContext>(model: K): UniversalLoginContext[K] | undefined {
-    return this.context[model];
+    if (!BaseContext.context) {
+      BaseContext.context = (window as any).universal_login_context as UniversalLoginContext;
+    }
+
+    return BaseContext.context[model];
   }
 }
diff --git a/packages/auth0-acul-js/src/models/branding.ts b/packages/auth0-acul-js/src/models/branding.ts
@@ -1,15 +1,15 @@
 import type { BrandingContext, BrandingMembers } from '../../interfaces/models/branding';
 
 export class Branding implements BrandingMembers {
-  private branding: BrandingContext | undefined;
+  settings:  BrandingMembers['settings'];
+  themes: BrandingMembers['themes'];
 
-  constructor(client: BrandingContext | undefined) {
-    this.branding = client;
+  constructor(branding: BrandingContext | undefined) {
+    this.settings = Branding.getSettings(branding);
+    this.themes = Branding.getThemes(branding);
   }
 
-  getSettings(): ReturnType<BrandingMembers['getSettings']> {
-    const { branding } = this;
-
+  static getSettings(branding: BrandingContext | undefined): BrandingMembers['settings'] {
     if (!branding?.settings) return null;
 
     const { colors, favicon_url, logo_url, font } = branding.settings;
@@ -35,11 +35,11 @@ export class Branding implements BrandingMembers {
     };
   }
 
-  getThemes(): ReturnType<BrandingMembers['getThemes']> {
-    if (!this.branding || !this.branding?.themes) return null;
+  static getThemes(branding: BrandingContext | undefined): BrandingMembers['themes'] {
+    if (!branding || !branding?.themes) return null;
 
     const { default: { borders = {}, colors = {}, displayName = '', fonts = {}, page_background: pageBackground = {}, widget = {} } = {} } =
-      this.branding.themes;
+      branding.themes;
 
     return {
       default: {

diff --git a/packages/auth0-acul-js/src/models/client.ts b/packages/auth0-acul-js/src/models/client.ts
@@ -1,29 +1,17 @@
 import type { ClientContext, ClientMembers } from '../../interfaces/models/client';
 
 export class Client implements ClientMembers {
-  protected client: ClientContext;
+  id: ClientMembers['id'];
+  name: ClientMembers['name'];
+  logoUri: ClientMembers['logoUri'];
+  description: ClientMembers['description'];
+  metadata: ClientMembers['metadata'];
 
   constructor(client: ClientContext) {
-    this.client = client;
-  }
-
-  get id(): ClientMembers['id'] {
-    return this.client.id;
-  }
-
-  get name(): ClientMembers['name'] {
-    return this.client.name;
-  }
-
-  get logoUri(): ClientMembers['logoUri'] {
-    return this.client?.logo_uri ?? null;
-  }
-
-  get description(): ClientMembers['description'] {
-    return this.client?.description ?? null;
-  }
-
-  getMetadata(): ReturnType<ClientMembers['getMetadata']> {
-    return this.client?.metadata ?? null;
+    this.id = client.id;
+    this.name = client.name;
+    this.logoUri = client?.logo_uri ?? null;
+    this.description = client?.description ?? null;
+    this.metadata = client?.metadata ?? null;
   }
 }