refactor(types,clerk-js): Extract SignInFuture and SignUpFuture method params into types (#6645)

Author: nikosdouvlis

.changeset/lovely-bananas-allow.md

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

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

@@ -16,7 +16,6 @@ import type {
   EmailCodeConfig,
   EmailLinkConfig,
   EnterpriseSSOConfig,
-  OAuthStrategy,
   PassKeyConfig,
   PasskeyFactor,
   PhoneCodeConfig,
@@ -26,10 +25,16 @@ import type {
   ResetPasswordParams,
   ResetPasswordPhoneCodeFactorConfig,
   SamlConfig,
-  SetActiveNavigate,
   SignInCreateParams,
   SignInFirstFactor,
+  SignInFutureCreateParams,
+  SignInFutureEmailCodeSendParams,
+  SignInFutureEmailCodeVerifyParams,
+  SignInFutureFinalizeParams,
+  SignInFuturePasswordParams,
+  SignInFutureResetPasswordSubmitParams,
   SignInFutureResource,
+  SignInFutureSSOParams,
   SignInIdentifier,
   SignInJSON,
   SignInJSONSnapshot,
@@ -551,7 +556,8 @@ class SignInFuture implements SignInFutureResource {
     });
   }
 
-  async verifyResetPasswordEmailCode({ code }: { code: string }): Promise<{ error: unknown }> {
+  async verifyResetPasswordEmailCode(params: SignInFutureEmailCodeVerifyParams): Promise<{ error: unknown }> {
+    const { code } = params;
     return runAsyncResourceTask(this.resource, async () => {
       await this.resource.__internal_basePost({
         body: { code, strategy: 'reset_password_email_code' },
@@ -560,13 +566,8 @@ class SignInFuture implements SignInFutureResource {
     });
   }
 
-  async submitResetPassword({
-    password,
-    signOutOfOtherSessions = true,
-  }: {
-    password: string;
-    signOutOfOtherSessions?: boolean;
-  }): Promise<{ error: unknown }> {
+  async submitResetPassword(params: SignInFutureResetPasswordSubmitParams): Promise<{ error: unknown }> {
+    const { password, signOutOfOtherSessions = true } = params;
     return runAsyncResourceTask(this.resource, async () => {
       await this.resource.__internal_basePost({
         body: { password, signOutOfOtherSessions },
@@ -575,13 +576,7 @@ class SignInFuture implements SignInFutureResource {
     });
   }
 
-  async create(params: {
-    identifier?: string;
-    strategy?: OAuthStrategy | 'saml' | 'enterprise_sso';
-    redirectUrl?: string;
-    actionCompleteRedirectUrl?: string;
-    transfer?: boolean;
-  }): Promise<{ error: unknown }> {
+  async create(params: SignInFutureCreateParams): Promise<{ error: unknown }> {
     return runAsyncResourceTask(this.resource, async () => {
       await this.resource.__internal_basePost({
         path: this.resource.pathRoot,
@@ -590,7 +585,8 @@ class SignInFuture implements SignInFutureResource {
     });
   }
 
-  async password({ identifier, password }: { identifier?: string; password: string }): Promise<{ error: unknown }> {
+  async password(params: SignInFuturePasswordParams): Promise<{ error: unknown }> {
+    const { identifier, password } = params;
     return runAsyncResourceTask(this.resource, async () => {
       const previousIdentifier = this.resource.identifier;
       await this.resource.__internal_basePost({
@@ -600,7 +596,8 @@ class SignInFuture implements SignInFutureResource {
     });
   }
 
-  async sendEmailCode({ email }: { email: string }): Promise<{ error: unknown }> {
+  async sendEmailCode(params: SignInFutureEmailCodeSendParams): Promise<{ error: unknown }> {
+    const { email } = params;
     return runAsyncResourceTask(this.resource, async () => {
       if (!this.resource.id) {
         await this.create({ identifier: email });
@@ -620,7 +617,8 @@ class SignInFuture implements SignInFutureResource {
     });
   }
 
-  async verifyEmailCode({ code }: { code: string }): Promise<{ error: unknown }> {
+  async verifyEmailCode(params: SignInFutureEmailCodeVerifyParams): Promise<{ error: unknown }> {
+    const { code } = params;
     return runAsyncResourceTask(this.resource, async () => {
       await this.resource.__internal_basePost({
         body: { code, strategy: 'email_code' },
@@ -629,29 +627,18 @@ class SignInFuture implements SignInFutureResource {
     });
   }
 
-  async sso({
-    flow = 'auto',
-    strategy,
-    redirectUrl,
-    redirectUrlComplete,
-  }: {
-    flow?: 'auto' | 'modal';
-    strategy: OAuthStrategy | 'saml' | 'enterprise_sso';
-    redirectUrl: string;
-    redirectUrlComplete: string;
-  }): Promise<{ error: unknown }> {
+  async sso(params: SignInFutureSSOParams): Promise<{ error: unknown }> {
+    const { flow = 'auto', strategy, redirectUrl, redirectCallbackUrl } = params;
     return runAsyncResourceTask(this.resource, async () => {
       if (flow !== 'auto') {
         throw new Error('modal flow is not supported yet');
       }
 
-      const redirectUrlWithAuthToken = SignIn.clerk.buildUrlWithAuth(redirectUrl);
-
       if (!this.resource.id) {
         await this.create({
           strategy,
-          redirectUrl: redirectUrlWithAuthToken,
-          actionCompleteRedirectUrl: redirectUrlComplete,
+          redirectUrl: SignIn.clerk.buildUrlWithAuth(redirectCallbackUrl),
+          actionCompleteRedirectUrl: redirectUrl,
         });
       }
 
@@ -663,7 +650,8 @@ class SignInFuture implements SignInFutureResource {
     });
   }
 
-  async finalize({ navigate }: { navigate?: SetActiveNavigate } = {}): Promise<{ error: unknown }> {
+  async finalize(params?: SignInFutureFinalizeParams): Promise<{ error: unknown }> {
+    const { navigate } = params || {};
     return runAsyncResourceTask(this.resource, async () => {
       if (!this.resource.createdSessionId) {
         throw new Error('Cannot finalize sign-in without a created session.');

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

@@ -14,11 +14,15 @@ import type {
   PreparePhoneNumberVerificationParams,
   PrepareVerificationParams,
   PrepareWeb3WalletVerificationParams,
-  SetActiveNavigate,
   SignUpAuthenticateWithWeb3Params,
   SignUpCreateParams,
   SignUpField,
+  SignUpFutureCreateParams,
+  SignUpFutureEmailCodeVerifyParams,
+  SignUpFutureFinalizeParams,
+  SignUpFuturePasswordParams,
   SignUpFutureResource,
+  SignUpFutureSSoParams,
   SignUpIdentificationField,
   SignUpJSON,
   SignUpJSONSnapshot,
@@ -541,7 +545,8 @@ class SignUpFuture implements SignUpFutureResource {
     return { captchaToken, captchaWidgetType, captchaError };
   }
 
-  async create({ transfer }: { transfer?: boolean }): Promise<{ error: unknown }> {
+  async create(params: SignUpFutureCreateParams): Promise<{ error: unknown }> {
+    const { transfer } = params;
     return runAsyncResourceTask(this.resource, async () => {
       const { captchaToken, captchaWidgetType, captchaError } = await this.getCaptchaToken();
       await this.resource.__internal_basePost({
@@ -551,7 +556,8 @@ class SignUpFuture implements SignUpFutureResource {
     });
   }
 
-  async password({ emailAddress, password }: { emailAddress: string; password: string }): Promise<{ error: unknown }> {
+  async password(params: SignUpFuturePasswordParams): Promise<{ error: unknown }> {
+    const { emailAddress, password } = params;
     return runAsyncResourceTask(this.resource, async () => {
       const { captchaToken, captchaWidgetType, captchaError } = await this.getCaptchaToken();
 
@@ -578,7 +584,8 @@ class SignUpFuture implements SignUpFutureResource {
     });
   }
 
-  async verifyEmailCode({ code }: { code: string }): Promise<{ error: unknown }> {
+  async verifyEmailCode(params: SignUpFutureEmailCodeVerifyParams): Promise<{ error: unknown }> {
+    const { code } = params;
     return runAsyncResourceTask(this.resource, async () => {
       await this.resource.__internal_basePost({
         body: { strategy: 'email_code', code },
@@ -587,23 +594,16 @@ class SignUpFuture implements SignUpFutureResource {
     });
   }
 
-  async sso({
-    strategy,
-    redirectUrl,
-    redirectUrlComplete,
-  }: {
-    strategy: string;
-    redirectUrl: string;
-    redirectUrlComplete: string;
-  }): Promise<{ error: unknown }> {
+  async sso(params: SignUpFutureSSoParams): Promise<{ error: unknown }> {
+    const { strategy, redirectUrl, redirectCallbackUrl } = params;
     return runAsyncResourceTask(this.resource, async () => {
       const { captchaToken, captchaWidgetType, captchaError } = await this.getCaptchaToken();
       await this.resource.__internal_basePost({
         path: this.resource.pathRoot,
         body: {
           strategy,
-          redirectUrl: SignUp.clerk.buildUrlWithAuth(redirectUrl),
-          redirectUrlComplete,
+          redirectUrl: SignUp.clerk.buildUrlWithAuth(redirectCallbackUrl),
+          redirectUrlComplete: redirectUrl,
           captchaToken,
           captchaWidgetType,
           captchaError,
@@ -620,7 +620,8 @@ class SignUpFuture implements SignUpFutureResource {
     });
   }
 
-  async finalize({ navigate }: { navigate?: SetActiveNavigate } = {}): Promise<{ error: unknown }> {
+  async finalize(params?: SignUpFutureFinalizeParams): Promise<{ error: unknown }> {
+    const { navigate } = params || {};
     return runAsyncResourceTask(this.resource, async () => {
       if (!this.resource.createdSessionId) {
         throw new Error('Cannot finalize sign-up without a created session.');

packages/types/src/index.ts

@@ -1,19 +1,24 @@
 export * from './api';
+export * from './apiKeys';
+export * from './apiKeysSettings';
 export * from './appearance';
-export * from './elementIds';
 export * from './attributes';
 export * from './authConfig';
+export * from './authObject';
 export * from './backupCode';
 export * from './clerk';
 export * from './client';
 export * from './commerce';
 export * from './commerceSettings';
+export * from './customMenuItems';
+export * from './customPages';
 export * from './deletedObject';
 export * from './displayConfig';
+export * from './elementIds';
 export * from './emailAddress';
+export * from './enterpriseAccount';
 export * from './environment';
 export * from './externalAccount';
-export * from './enterpriseAccount';
 export * from './factors';
 export * from './hooks';
 export * from './identificationLink';
@@ -22,9 +27,9 @@ export * from './image';
 export * from './instance';
 export * from './json';
 export * from './jwt';
+export * from './jwtv2';
 export * from './key';
 export * from './localization';
-export * from './jwtv2';
 export * from './multiDomain';
 export * from './oauth';
 export * from './organization';
@@ -34,8 +39,11 @@ export * from './organizationMembership';
 export * from './organizationMembershipRequest';
 export * from './organizationSettings';
 export * from './organizationSuggestion';
+export * from './pagination';
+export * from './passkey';
 export * from './passwords';
 export * from './permission';
+export * from './phoneCodeChannel';
 export * from './phoneNumber';
 export * from './protect';
 export * from './redirects';
@@ -44,32 +52,28 @@ export * from './role';
 export * from './router';
 export * from './saml';
 export * from './samlAccount';
+export * from './samlConnection';
 export * from './session';
 export * from './sessionVerification';
 export * from './signIn';
+export * from './signInCommon';
+export * from './signInFuture';
 export * from './signUp';
+export * from './signUpCommon';
+export * from './signUpFuture';
+export * from './snapshots';
 export * from './ssr';
 export * from './state';
 export * from './strategies';
+export * from './telemetry';
 export * from './theme';
 export * from './token';
 export * from './totp';
-export * from './telemetry';
 export * from './user';
 export * from './userOrganizationInvitation';
 export * from './userSettings';
 export * from './utils';
 export * from './verification';
+export * from './waitlist';
 export * from './web3';
 export * from './web3Wallet';
-export * from './customPages';
-export * from './pagination';
-export * from './passkey';
-export * from './customMenuItems';
-export * from './samlConnection';
-export * from './waitlist';
-export * from './apiKeys';
-export * from './apiKeysSettings';
-export * from './snapshots';
-export * from './authObject';
-export * from './phoneCodeChannel';

packages/types/src/json.ts

@@ -26,8 +26,9 @@ import type { PhoneCodeChannel } from './phoneCodeChannel';
 import type { SamlIdpSlug } from './saml';
 import type { SessionStatus, SessionTask } from './session';
 import type { SessionVerificationLevel, SessionVerificationStatus } from './sessionVerification';
-import type { SignInFirstFactor, SignInJSON, SignInSecondFactor } from './signIn';
-import type { SignUpField, SignUpIdentificationField, SignUpStatus } from './signUp';
+import type { SignInJSON } from './signIn';
+import type { SignInFirstFactor, SignInSecondFactor } from './signInCommon';
+import type { SignUpField, SignUpIdentificationField, SignUpStatus } from './signUpCommon';
 import type { BoxShadow, Color, EmUnit, FontWeight, HexColor } from './theme';
 import type { UserSettingsJSON } from './userSettings';
 import type { CamelToSnake } from './utils';