refactor(clerk-js,types): Add phoneNumber & email to password method (#6661)

Author: nikosdouvlis

.changeset/rare-results-leave.md

@@ -0,0 +1,2 @@
+---
+---

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

@@ -635,12 +635,16 @@ class SignInFuture implements SignInFutureResource {
   }
 
   async password(params: SignInFuturePasswordParams): Promise<{ error: unknown }> {
-    const { identifier, password } = params;
+    if ([params.identifier, params.email, params.phoneNumber].filter(Boolean).length > 1) {
+      throw new Error('Only one of identifier, email, or phoneNumber can be provided');
+    }
+
     return runAsyncResourceTask(this.resource, async () => {
+      const identifier = params.identifier || params.email || params.phoneNumber;
       const previousIdentifier = this.resource.identifier;
       await this.resource.__internal_basePost({
         path: this.resource.pathRoot,
-        body: { identifier: identifier || previousIdentifier, password },
+        body: { identifier: identifier || previousIdentifier, password: params.password },
       });
     });
   }

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

@@ -595,21 +595,30 @@ class SignUpFuture implements SignUpFutureResource {
   }
 
   async password(params: SignUpFuturePasswordParams): Promise<{ error: unknown }> {
-    const { emailAddress, password } = params;
+    if ([params.emailAddress, params.phoneNumber].filter(Boolean).length > 1) {
+      throw new Error('Only one of emailAddress or phoneNumber can be provided');
+    }
+
     return runAsyncResourceTask(this.resource, async () => {
       const { captchaToken, captchaWidgetType, captchaError } = await this.getCaptchaToken();
 
-      await this.resource.__internal_basePost({
-        path: this.resource.pathRoot,
-        body: {
-          strategy: 'password',
-          emailAddress,
-          password,
-          captchaToken,
-          captchaWidgetType,
-          captchaError,
-        },
-      });
+      const body: Record<string, unknown> = {
+        strategy: 'password',
+        password: params.password,
+        captchaToken,
+        captchaWidgetType,
+        captchaError,
+      };
+
+      if (params.phoneNumber) {
+        body.phoneNumber = params.phoneNumber;
+      }
+
+      if (params.emailAddress) {
+        body.emailAddress = params.emailAddress;
+      }
+
+      await this.resource.__internal_basePost({ path: this.resource.pathRoot, body });
     });
   }
 

packages/types/src/signInFuture.ts

@@ -11,10 +11,25 @@ export interface SignInFutureCreateParams {
   transfer?: boolean;
 }
 
-export interface SignInFuturePasswordParams {
-  identifier?: string;
-  password: string;
-}
+export type SignInFuturePasswordParams =
+  | {
+      identifier: string;
+      password: string;
+      email?: never;
+      phoneNumber?: never;
+    }
+  | {
+      password: string;
+      email: string;
+      identifier?: never;
+      phoneNumber?: never;
+    }
+  | {
+      password: string;
+      phoneNumber: string;
+      identifier?: never;
+      email?: never;
+    };
 
 export interface SignInFutureEmailCodeSendParams {
   email: string;

packages/types/src/signUpFuture.ts

@@ -10,10 +10,17 @@ export interface SignUpFutureEmailCodeVerifyParams {
   code: string;
 }
 
-export interface SignUpFuturePasswordParams {
-  emailAddress: string;
-  password: string;
-}
+export type SignUpFuturePasswordParams =
+  | {
+      emailAddress: string;
+      password: string;
+      phoneNumber?: never;
+    }
+  | {
+      phoneNumber: string;
+      password: string;
+      emailAddress?: never;
+    };
 
 export interface SignUpFuturePhoneCodeSendParams {
   phoneNumber?: string;