@azure/msal-browser 4.13.1 → 4.14.0

package/src/custom_auth/sign_up/auth_flow/state/SignUpCodeRequiredState.ts

@@ -0,0 +1,196 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { UnexpectedError } from "../../../core/error/UnexpectedError.js";
+import {
+    SIGN_UP_ATTRIBUTES_REQUIRED_RESULT_TYPE,
+    SIGN_UP_COMPLETED_RESULT_TYPE,
+    SIGN_UP_PASSWORD_REQUIRED_RESULT_TYPE,
+} from "../../interaction_client/result/SignUpActionResult.js";
+import { SignUpResendCodeResult } from "../result/SignUpResendCodeResult.js";
+import { SignUpSubmitCodeResult } from "../result/SignUpSubmitCodeResult.js";
+import { SignUpState } from "./SignUpState.js";
+import { SignUpCodeRequiredStateParameters } from "./SignUpStateParameters.js";
+import { SignUpPasswordRequiredState } from "./SignUpPasswordRequiredState.js";
+import { SignUpAttributesRequiredState } from "./SignUpAttributesRequiredState.js";
+import { SignUpCompletedState } from "./SignUpCompletedState.js";
+import { SignInScenario } from "../../../sign_in/auth_flow/SignInScenario.js";
+
+/*
+ * Sign-up code required state.
+ */
+export class SignUpCodeRequiredState extends SignUpState<SignUpCodeRequiredStateParameters> {
+    /**
+     * Submit one-time passcode to continue sign-up flow.
+     * @param {string} code - The code to submit.
+     * @returns {Promise<SignUpSubmitCodeResult>} The result of the operation.
+     */
+    async submitCode(code: string): Promise<SignUpSubmitCodeResult> {
+        try {
+            this.ensureCodeIsValid(code, this.stateParameters.codeLength);
+
+            this.stateParameters.logger.verbose(
+                "Submitting code for sign-up.",
+                this.stateParameters.correlationId
+            );
+
+            const result = await this.stateParameters.signUpClient.submitCode({
+                clientId: this.stateParameters.config.auth.clientId,
+                correlationId: this.stateParameters.correlationId,
+                challengeType:
+                    this.stateParameters.config.customAuth.challengeTypes ?? [],
+                continuationToken: this.stateParameters.continuationToken ?? "",
+                code: code,
+                username: this.stateParameters.username,
+            });
+
+            this.stateParameters.logger.verbose(
+                "Code submitted for sign-up.",
+                this.stateParameters.correlationId
+            );
+
+            if (result.type === SIGN_UP_PASSWORD_REQUIRED_RESULT_TYPE) {
+                // Password required
+                this.stateParameters.logger.verbose(
+                    "Password required for sign-up.",
+                    this.stateParameters.correlationId
+                );
+
+                return new SignUpSubmitCodeResult(
+                    new SignUpPasswordRequiredState({
+                        correlationId: result.correlationId,
+                        continuationToken: result.continuationToken,
+                        logger: this.stateParameters.logger,
+                        config: this.stateParameters.config,
+                        signInClient: this.stateParameters.signInClient,
+                        signUpClient: this.stateParameters.signUpClient,
+                        cacheClient: this.stateParameters.cacheClient,
+                        username: this.stateParameters.username,
+                    })
+                );
+            } else if (
+                result.type === SIGN_UP_ATTRIBUTES_REQUIRED_RESULT_TYPE
+            ) {
+                // Attributes required
+                this.stateParameters.logger.verbose(
+                    "Attributes required for sign-up.",
+                    this.stateParameters.correlationId
+                );
+
+                return new SignUpSubmitCodeResult(
+                    new SignUpAttributesRequiredState({
+                        correlationId: result.correlationId,
+                        continuationToken: result.continuationToken,
+                        logger: this.stateParameters.logger,
+                        config: this.stateParameters.config,
+                        signInClient: this.stateParameters.signInClient,
+                        signUpClient: this.stateParameters.signUpClient,
+                        cacheClient: this.stateParameters.cacheClient,
+                        username: this.stateParameters.username,
+                        requiredAttributes: result.requiredAttributes,
+                    })
+                );
+            } else if (result.type === SIGN_UP_COMPLETED_RESULT_TYPE) {
+                // Sign-up completed
+                this.stateParameters.logger.verbose(
+                    "Sign-up completed.",
+                    this.stateParameters.correlationId
+                );
+
+                return new SignUpSubmitCodeResult(
+                    new SignUpCompletedState({
+                        correlationId: result.correlationId,
+                        continuationToken: result.continuationToken,
+                        logger: this.stateParameters.logger,
+                        config: this.stateParameters.config,
+                        signInClient: this.stateParameters.signInClient,
+                        cacheClient: this.stateParameters.cacheClient,
+                        username: this.stateParameters.username,
+                        signInScenario: SignInScenario.SignInAfterSignUp,
+                    })
+                );
+            }
+
+            return SignUpSubmitCodeResult.createWithError(
+                new UnexpectedError(
+                    "Unknown sign-up result type.",
+                    this.stateParameters.correlationId
+                )
+            );
+        } catch (error) {
+            this.stateParameters.logger.errorPii(
+                `Failed to submit code for sign up. Error: ${error}.`,
+                this.stateParameters.correlationId
+            );
+
+            return SignUpSubmitCodeResult.createWithError(error);
+        }
+    }
+
+    /**
+     * Resends the another one-time passcode for sign-up flow if the previous one hasn't been verified.
+     * @returns {Promise<SignUpResendCodeResult>} The result of the operation.
+     */
+    async resendCode(): Promise<SignUpResendCodeResult> {
+        try {
+            this.stateParameters.logger.verbose(
+                "Resending code for sign-up.",
+                this.stateParameters.correlationId
+            );
+
+            const result = await this.stateParameters.signUpClient.resendCode({
+                clientId: this.stateParameters.config.auth.clientId,
+                challengeType:
+                    this.stateParameters.config.customAuth.challengeTypes ?? [],
+                username: this.stateParameters.username,
+                correlationId: this.stateParameters.correlationId,
+                continuationToken: this.stateParameters.continuationToken ?? "",
+            });
+
+            this.stateParameters.logger.verbose(
+                "Code resent for sign-up.",
+                this.stateParameters.correlationId
+            );
+
+            return new SignUpResendCodeResult(
+                new SignUpCodeRequiredState({
+                    correlationId: result.correlationId,
+                    continuationToken: result.continuationToken,
+                    logger: this.stateParameters.logger,
+                    config: this.stateParameters.config,
+                    signInClient: this.stateParameters.signInClient,
+                    signUpClient: this.stateParameters.signUpClient,
+                    cacheClient: this.stateParameters.cacheClient,
+                    username: this.stateParameters.username,
+                    codeLength: result.codeLength,
+                    codeResendInterval: result.interval,
+                })
+            );
+        } catch (error) {
+            this.stateParameters.logger.errorPii(
+                `Failed to resend code for sign up. Error: ${error}.`,
+                this.stateParameters.correlationId
+            );
+
+            return SignUpResendCodeResult.createWithError(error);
+        }
+    }
+
+    /**
+     * Gets the sent code length.
+     * @returns {number} The length of the code.
+     */
+    getCodeLength(): number {
+        return this.stateParameters.codeLength;
+    }
+
+    /**
+     * Gets the interval in seconds for the code to be resent.
+     * @returns {number} The interval in seconds for the code to be resent.
+     */
+    getCodeResendInterval(): number {
+        return this.stateParameters.codeResendInterval;
+    }
+}

package/src/custom_auth/sign_up/auth_flow/state/SignUpCompletedState.ts

@@ -0,0 +1,11 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { SignInContinuationState } from "../../../sign_in/auth_flow/state/SignInContinuationState.js";
+
+/**
+ * Represents the state of a sign-up operation that has been completed scuccessfully.
+ */
+export class SignUpCompletedState extends SignInContinuationState {}

package/src/custom_auth/sign_up/auth_flow/state/SignUpFailedState.ts

@@ -0,0 +1,11 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { AuthFlowStateBase } from "../../../core/auth_flow/AuthFlowState.js";
+
+/**
+ * Represents the state of a sign-up operation that has failed.
+ */
+export class SignUpFailedState extends AuthFlowStateBase {}

package/src/custom_auth/sign_up/auth_flow/state/SignUpPasswordRequiredState.ts

@@ -0,0 +1,112 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { UnexpectedError } from "../../../core/error/UnexpectedError.js";
+import { SignInScenario } from "../../../sign_in/auth_flow/SignInScenario.js";
+import {
+    SIGN_UP_ATTRIBUTES_REQUIRED_RESULT_TYPE,
+    SIGN_UP_COMPLETED_RESULT_TYPE,
+} from "../../interaction_client/result/SignUpActionResult.js";
+import { SignUpSubmitPasswordResult } from "../result/SignUpSubmitPasswordResult.js";
+import { SignUpAttributesRequiredState } from "./SignUpAttributesRequiredState.js";
+import { SignUpCompletedState } from "./SignUpCompletedState.js";
+import { SignUpState } from "./SignUpState.js";
+import { SignUpPasswordRequiredStateParameters } from "./SignUpStateParameters.js";
+
+/*
+ * Sign-up password required state.
+ */
+export class SignUpPasswordRequiredState extends SignUpState<SignUpPasswordRequiredStateParameters> {
+    /**
+     * Submits a password for sign-up.
+     * @param {string} password - The password to submit.
+     * @returns {Promise<SignUpSubmitPasswordResult>} The result of the operation.
+     */
+    async submitPassword(
+        password: string
+    ): Promise<SignUpSubmitPasswordResult> {
+        try {
+            this.ensurePasswordIsNotEmpty(password);
+
+            this.stateParameters.logger.verbose(
+                "Submitting password for sign-up.",
+                this.stateParameters.correlationId
+            );
+
+            const result =
+                await this.stateParameters.signUpClient.submitPassword({
+                    clientId: this.stateParameters.config.auth.clientId,
+                    correlationId: this.stateParameters.correlationId,
+                    challengeType:
+                        this.stateParameters.config.customAuth.challengeTypes ??
+                        [],
+                    continuationToken:
+                        this.stateParameters.continuationToken ?? "",
+                    password: password,
+                    username: this.stateParameters.username,
+                });
+
+            this.stateParameters.logger.verbose(
+                "Password submitted for sign-up.",
+                this.stateParameters.correlationId
+            );
+
+            if (result.type === SIGN_UP_ATTRIBUTES_REQUIRED_RESULT_TYPE) {
+                // Attributes required
+                this.stateParameters.logger.verbose(
+                    "Attributes required for sign-up.",
+                    this.stateParameters.correlationId
+                );
+
+                return new SignUpSubmitPasswordResult(
+                    new SignUpAttributesRequiredState({
+                        correlationId: result.correlationId,
+                        continuationToken: result.continuationToken,
+                        logger: this.stateParameters.logger,
+                        config: this.stateParameters.config,
+                        signInClient: this.stateParameters.signInClient,
+                        signUpClient: this.stateParameters.signUpClient,
+                        cacheClient: this.stateParameters.cacheClient,
+                        username: this.stateParameters.username,
+                        requiredAttributes: result.requiredAttributes,
+                    })
+                );
+            } else if (result.type === SIGN_UP_COMPLETED_RESULT_TYPE) {
+                // Sign-up completed
+                this.stateParameters.logger.verbose(
+                    "Sign-up completed.",
+                    this.stateParameters.correlationId
+                );
+
+                return new SignUpSubmitPasswordResult(
+                    new SignUpCompletedState({
+                        correlationId: result.correlationId,
+                        continuationToken: result.continuationToken,
+                        logger: this.stateParameters.logger,
+                        config: this.stateParameters.config,
+                        signInClient: this.stateParameters.signInClient,
+                        cacheClient: this.stateParameters.cacheClient,
+                        username: this.stateParameters.username,
+                        signInScenario: SignInScenario.SignInAfterSignUp,
+                    })
+                );
+            }
+
+            return SignUpSubmitPasswordResult.createWithError(
+                new UnexpectedError(
+                    "Unknown sign-up result type.",
+                    this.stateParameters.correlationId
+                )
+            );
+        } catch (error) {
+            this.stateParameters.logger.errorPii(
+                `Failed to submit password for sign up. Error: ${error}.`,
+                this.stateParameters.correlationId
+            );
+
+            return SignUpSubmitPasswordResult.createWithError(error);
+        }
+    }
+}

package/src/custom_auth/sign_up/auth_flow/state/SignUpState.ts

@@ -0,0 +1,34 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { AuthFlowActionRequiredStateBase } from "../../../core/auth_flow/AuthFlowState.js";
+import { ensureArgumentIsNotEmptyString } from "../../../core/utils/ArgumentValidator.js";
+import { SignUpStateParameters } from "./SignUpStateParameters.js";
+
+/*
+ * Base state handler for sign-up flow.
+ */
+export abstract class SignUpState<
+    TParameters extends SignUpStateParameters
+> extends AuthFlowActionRequiredStateBase<TParameters> {
+    /*
+     * Creates a new SignUpState.
+     * @param stateParameters - The state parameters for sign-up.
+     */
+    constructor(stateParameters: TParameters) {
+        super(stateParameters);
+
+        ensureArgumentIsNotEmptyString(
+            "username",
+            stateParameters.username,
+            stateParameters.correlationId
+        );
+        ensureArgumentIsNotEmptyString(
+            "continuationToken",
+            stateParameters.continuationToken,
+            stateParameters.correlationId
+        );
+    }
+}

package/src/custom_auth/sign_up/auth_flow/state/SignUpStateParameters.ts

@@ -0,0 +1,31 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { SignUpClient } from "../../interaction_client/SignUpClient.js";
+import { SignInClient } from "../../../sign_in/interaction_client/SignInClient.js";
+import { CustomAuthSilentCacheClient } from "../../../get_account/interaction_client/CustomAuthSilentCacheClient.js";
+import { AuthFlowActionRequiredStateParameters } from "../../../core/auth_flow/AuthFlowState.js";
+import { UserAttribute } from "../../../core/network_client/custom_auth_api/types/ApiErrorResponseTypes.js";
+
+export interface SignUpStateParameters
+    extends AuthFlowActionRequiredStateParameters {
+    username: string;
+    signUpClient: SignUpClient;
+    signInClient: SignInClient;
+    cacheClient: CustomAuthSilentCacheClient;
+}
+
+export type SignUpPasswordRequiredStateParameters = SignUpStateParameters;
+
+export interface SignUpCodeRequiredStateParameters
+    extends SignUpStateParameters {
+    codeLength: number;
+    codeResendInterval: number;
+}
+
+export interface SignUpAttributesRequiredStateParameters
+    extends SignUpStateParameters {
+    requiredAttributes: Array<UserAttribute>;
+}