fix: move channel parameter from sign in to sign up (#647)

The `channel` parameter for WhatsApp should be on the `Signup` method instead of the `SignIn` method Relevant Server side code: https://github.com/supabase/gotrue/blob/master/internal/api/signup.go#L22 --------- Co-authored-by: joel@joellee.org <joel@joellee.org> Co-authored-by: Stojan Dimitrovski <sdimitrovski@gmail.com>
supabase · Apr 6, 2023 · e83caba · e83caba
1 parent 325d748
commit e83caba
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 10 deletions.
diff --git a/src/GoTrueClient.ts b/src/GoTrueClient.ts
@@ -285,6 +285,7 @@ export default class GoTrueClient {
             phone,
             password,
             data: options?.data ?? {},
+            channel: options?.channel ?? 'sms',
             gotrue_meta_security: { captcha_token: options?.captchaToken },
           },
           xform: _sessionResponse,
@@ -325,10 +326,7 @@ export default class GoTrueClient {
    * Be aware that you may get back an error message that will not distingish
    * between the cases where the account does not exist or that the
    * email/phone and password combination is wrong or that the account can only
-   * be accessed via social login. Do note that you will need
-   * to configure a Whatsapp sender on Twilio if you are using phone sign in
-   * with 'whatsapp'. The whatsapp channel is not supported on other providers
-   * at this time.
+   * be accessed via social login.
    */
   async signInWithPassword(credentials: SignInWithPasswordCredentials): Promise<AuthResponse> {
     try {
@@ -354,7 +352,6 @@ export default class GoTrueClient {
             phone,
             password,
             gotrue_meta_security: { captcha_token: options?.captchaToken },
-            channel: options?.channel ?? 'sms',
           },
           xform: _sessionResponse,
         })

diff --git a/src/lib/helpers.ts b/src/lib/helpers.ts
@@ -245,7 +245,9 @@ export function generatePKCEVerifier() {
   const verifierLength = 56
   const array = new Uint32Array(verifierLength)
   if (typeof window.crypto === 'undefined') {
-    throw new Error('PKCE is not supported on devices without WebCrypto API support or equivalent polyfills')
+    throw new Error(
+      'PKCE is not supported on devices without WebCrypto API support, please add polyfills'
+    )
   }
   window.crypto.getRandomValues(array)
   return Array.from(array, dec2hex).join('')
@@ -255,7 +257,9 @@ async function sha256(randomString: string) {
   const encoder = new TextEncoder()
   const encodedData = encoder.encode(randomString)
   if (typeof window.crypto === 'undefined') {
-    throw new Error('PKCE is not supported on devices without WebCrypto API support or equivalent polyfills')
+    throw new Error(
+      'PKCE is not supported on devices without WebCrypto API support, please add polyfills'
+    )
   }
   const hash = await window.crypto.subtle.digest('SHA-256', encodedData)
   const bytes = new Uint8Array(hash)

diff --git a/src/lib/types.ts b/src/lib/types.ts
@@ -363,8 +363,10 @@ export type SignUpWithPasswordCredentials =
          * The `data` should be a JSON object that includes user-specific info, such as their first and last name.
          */
         data?: object
-        /** Verification token received when the user completes the captcha on the site. */
+        /** Verification token received when the user completes the captcha on the site. Requires a configured WhatsApp sender on Twilio */
         captchaToken?: string
+        /** Messaging channel to use (e.g. whatsapp or sms) */
+        channel?: 'sms' | 'whatsapp'
       }
     }
 export type SignInWithPasswordCredentials =
@@ -392,8 +394,6 @@ export type SignInWithPasswordCredentials =
         data?: object
         /** Verification token received when the user completes the captcha on the site. */
         captchaToken?: string
-        /** Messaging channel to use (e.g. whatsapp or sms) */
-        channel?: 'sms' | 'whatsapp'
       }
     }