feat: Update register SDK to not use an options parameter (#15642)

The flag itself was not doing much, and it didn't make sense to keep just for the sake of making the typings happy.

Note that this can cause typescript issues, which are easy to resolve by checking on the verification required flag, similar to what we do in the admin dashboard

Author: sradevski

.changeset/heavy-geese-drop.md

@@ -0,0 +1,6 @@
+---
+"@medusajs/js-sdk": minor
+"@medusajs/dashboard": patch
+---
+
+Update the signature of the sdk register method to either return verification response or a token

packages/admin/dashboard/src/hooks/api/auth.tsx

@@ -1,4 +1,8 @@
-import { AuthLoginResponse, FetchError } from "@medusajs/js-sdk"
+import {
+  AuthLoginResponse,
+  AuthRegisterResponse,
+  FetchError,
+} from "@medusajs/js-sdk"
 import { HttpTypes } from "@medusajs/types"
 import { UseMutationOptions, useMutation } from "@tanstack/react-query"
 import { sdk } from "../../lib/client"
@@ -26,7 +30,7 @@ export const useSignInWithEmailPass = (
 
 export const useSignUpWithEmailPass = (
   options?: UseMutationOptions<
-    string,
+    AuthRegisterResponse,
     FetchError,
     HttpTypes.AdminSignInWithEmailPassword
   >

packages/admin/dashboard/src/routes/invite/invite.tsx

@@ -197,11 +197,20 @@ const CreateView = ({
 
   const handleSubmit = form.handleSubmit(async (data) => {
     try {
-      const authToken = await signUpEmailPass({
+      const signupResponse = await signUpEmailPass({
         email: data.email,
         password: data.password,
       })
 
+      // This should not happen since email verification is not enabled in the admin, but it should be covered as a scenario.
+      if (typeof signupResponse !== "string") {
+        throw new Error(
+          "Email verification is required, but not supported by this flow."
+        )
+      }
+
+      const authToken = signupResponse
+
       const invitePayload = {
         email: data.email,
         first_name: data.first_name,

packages/core/js-sdk/src/__tests__/auth.spec.ts

@@ -139,35 +139,6 @@ describe("Auth", () => {
     expect(storage.setItem).not.toHaveBeenCalled()
   })
 
-  it("throws from register by default when verification is required", async () => {
-    server.use(
-      http.post(
-        `${baseUrl}/auth/user/emailpass/register`,
-        async ({ request }) => {
-          expect(await request.json()).toEqual({
-            email: "test@example.com",
-            password: "secret",
-          })
-
-          return HttpResponse.json({
-            verification_required: true,
-            verification: verification,
-          })
-        }
-      )
-    )
-
-    const auth = createAuth()
-
-    await expect(
-      auth.register("user", "emailpass", {
-        email: "test@example.com",
-        password: "secret",
-      })
-    ).rejects.toThrow("Unexpected registration response")
-    expect(storage.setItem).not.toHaveBeenCalled()
-  })
-
   it("returns a verification requirement from register when opted in", async () => {
     server.use(
       http.post(
@@ -187,17 +158,10 @@ describe("Auth", () => {
     )
 
     const auth = createAuth()
-    const result = await auth.register(
-      "user",
-      "emailpass",
-      {
-        email: "test@example.com",
-        password: "secret",
-      },
-      {
-        returnVerification: true,
-      }
-    )
+    const result = await auth.register("user", "emailpass", {
+      email: "test@example.com",
+      password: "secret",
+    })
 
     expect(result).toEqual({
       verification_required: true,

packages/core/js-sdk/src/auth/index.ts

@@ -31,7 +31,7 @@ export type AuthMfaRequiredResponse = {
 /**
  * Response returned when authentication succeeds but must be completed with
  * verification before issuing a token.
- * 
+ *
  * @since 2.15.5
  */
 export type AuthVerificationRequiredResponse = {
@@ -47,24 +47,11 @@ export type AuthVerificationRequiredResponse = {
 
 /**
  * Response returned from a registration attempt.
- * 
+ *
  * @since 2.15.5
  */
 export type AuthRegisterResponse = string | AuthVerificationRequiredResponse
 
-/**
- * Options used when registering with an auth provider.
- * 
- * @since 2.15.5
- */
-export type AuthRegisterOptions = {
-  /**
-   * Return verification state instead of throwing when registration
-   * requires verification before a token can be issued.
-   */
-  returnVerification?: boolean
-}
-
 /**
  * Response returned from an authentication attempt.
  */
@@ -202,7 +189,7 @@ export type AuthMfaVerifyChallengePayload = {
 
 /**
  * Payload used to request a verification token.
- * 
+ *
  * @since 2.15.5
  */
 export type AuthVerificationRequestPayload = {
@@ -218,7 +205,7 @@ export type AuthVerificationRequestPayload = {
 
 /**
  * Payload used to confirm a verification token.
- * 
+ *
  * @since 2.15.5
  */
 export type AuthVerificationConfirmPayload = {
@@ -230,7 +217,7 @@ export type AuthVerificationConfirmPayload = {
 
 /**
  * Response returned after requesting a verification token.
- * 
+ *
  * @since 2.15.5
  */
 export type AuthVerificationRequestResponse = {
@@ -242,7 +229,7 @@ export type AuthVerificationRequestResponse = {
 
 /**
  * Response returned after confirming verification.
- * 
+ *
  * @since 2.15.5
  */
 export type AuthVerificationConfirmResponse = {
@@ -471,7 +458,7 @@ export class Auth {
 
   /**
    * Methods for requesting and confirming verification.
-   * 
+   *
    * @since 2.15.5
    */
   verification = {
@@ -563,11 +550,10 @@ export class Auth {
    *   password: "supersecret"
    * })
    */
-  register = (async (
+  register = async (
     actor: string,
     method: string,
-    payload: HttpTypes.AdminSignUpWithEmailPassword | Record<string, unknown>,
-    options?: AuthRegisterOptions
+    payload: HttpTypes.AdminSignUpWithEmailPassword | Record<string, unknown>
   ): Promise<AuthRegisterResponse> => {
     const { token, verification_required, verification } =
       await this.client.fetch<AuthProviderResponse>(
@@ -579,36 +565,20 @@ export class Auth {
       )
 
     if (verification_required && verification) {
-      if (options?.returnVerification) {
-        return {
-          verification_required: true,
-          verification,
-        }
+      return {
+        verification_required: true,
+        verification,
       }
-
-      throw new Error("Unexpected registration response")
     }
 
     if (!token) {
       throw new Error("Unexpected registration response")
     }
 
+    // The reason we don't use setToken_ (i.e. start a session) here is because the token doesn't have any actor types attached to it yet.
+    // The token should be sent in a separate request to create an actor type, after which we can initiate the session.
     this.client.setToken(token)
-
     return token
-  }) as {
-    (
-      actor: string,
-      method: string,
-      payload: HttpTypes.AdminSignUpWithEmailPassword | Record<string, unknown>,
-      options: AuthRegisterOptions & { returnVerification: true }
-    ): Promise<AuthRegisterResponse>
-    (
-      actor: string,
-      method: string,
-      payload: HttpTypes.AdminSignUpWithEmailPassword | Record<string, unknown>,
-      options?: AuthRegisterOptions
-    ): Promise<string>
   }
 
   /**

packages/core/js-sdk/src/index.ts

@@ -52,7 +52,6 @@ export {
   type AuthMfaVerifyChallengePayload,
   type AuthMfaVerifyPayload,
   type AuthRedirectResponse,
-  type AuthRegisterOptions,
   type AuthRegisterResponse,
 } from "./auth/index.js"
 export { Store } from "./store/index.js"