@azure/msal-browser 4.13.2 → 4.14.0

package/src/custom_auth/reset_password/auth_flow/result/ResetPasswordSubmitCodeResult.ts

@@ -0,0 +1,70 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { AuthFlowResultBase } from "../../../core/auth_flow/AuthFlowResultBase.js";
+import { ResetPasswordSubmitCodeError } from "../error_type/ResetPasswordError.js";
+import { ResetPasswordFailedState } from "../state/ResetPasswordFailedState.js";
+import { ResetPasswordPasswordRequiredState } from "../state/ResetPasswordPasswordRequiredState.js";
+
+/*
+ * Result of a reset password operation that requires a code.
+ */
+export class ResetPasswordSubmitCodeResult extends AuthFlowResultBase<
+    ResetPasswordSubmitCodeResultState,
+    ResetPasswordSubmitCodeError,
+    void
+> {
+    /**
+     * Creates a new instance of ResetPasswordSubmitCodeResult.
+     * @param state The state of the result.
+     */
+    constructor(state: ResetPasswordSubmitCodeResultState) {
+        super(state);
+    }
+
+    /**
+     * Creates a new instance of ResetPasswordSubmitCodeResult with an error.
+     * @param error The error that occurred.
+     * @returns {ResetPasswordSubmitCodeResult} A new instance of ResetPasswordSubmitCodeResult with the error set.
+     */
+    static createWithError(error: unknown): ResetPasswordSubmitCodeResult {
+        const result = new ResetPasswordSubmitCodeResult(
+            new ResetPasswordFailedState()
+        );
+        result.error = new ResetPasswordSubmitCodeError(
+            ResetPasswordSubmitCodeResult.createErrorData(error)
+        );
+
+        return result;
+    }
+
+    /**
+     * Checks if the result is in a failed state.
+     */
+    isFailed(): this is ResetPasswordSubmitCodeResult & {
+        state: ResetPasswordFailedState;
+    } {
+        return this.state instanceof ResetPasswordFailedState;
+    }
+
+    /**
+     * Checks if the result is in a password required state.
+     */
+    isPasswordRequired(): this is ResetPasswordSubmitCodeResult & {
+        state: ResetPasswordPasswordRequiredState;
+    } {
+        return this.state instanceof ResetPasswordPasswordRequiredState;
+    }
+}
+
+/**
+ * The possible states for the ResetPasswordSubmitCodeResult.
+ * This includes:
+ * - ResetPasswordPasswordRequiredState: The reset password process requires a password.
+ * - ResetPasswordFailedState: The reset password process has failed.
+ */
+export type ResetPasswordSubmitCodeResultState =
+    | ResetPasswordPasswordRequiredState
+    | ResetPasswordFailedState;

package/src/custom_auth/reset_password/auth_flow/result/ResetPasswordSubmitPasswordResult.ts

@@ -0,0 +1,65 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { AuthFlowResultBase } from "../../../core/auth_flow/AuthFlowResultBase.js";
+import { ResetPasswordSubmitPasswordError } from "../error_type/ResetPasswordError.js";
+import { ResetPasswordCompletedState } from "../state/ResetPasswordCompletedState.js";
+import { ResetPasswordFailedState } from "../state/ResetPasswordFailedState.js";
+
+/*
+ * Result of a reset password operation that requires a password.
+ */
+export class ResetPasswordSubmitPasswordResult extends AuthFlowResultBase<
+    ResetPasswordSubmitPasswordResultState,
+    ResetPasswordSubmitPasswordError,
+    void
+> {
+    /**
+     * Creates a new instance of ResetPasswordSubmitPasswordResult.
+     * @param state The state of the result.
+     */
+    constructor(state: ResetPasswordSubmitPasswordResultState) {
+        super(state);
+    }
+
+    static createWithError(error: unknown): ResetPasswordSubmitPasswordResult {
+        const result = new ResetPasswordSubmitPasswordResult(
+            new ResetPasswordFailedState()
+        );
+        result.error = new ResetPasswordSubmitPasswordError(
+            ResetPasswordSubmitPasswordResult.createErrorData(error)
+        );
+
+        return result;
+    }
+
+    /**
+     * Checks if the result is in a failed state.
+     */
+    isFailed(): this is ResetPasswordSubmitPasswordResult & {
+        state: ResetPasswordFailedState;
+    } {
+        return this.state instanceof ResetPasswordFailedState;
+    }
+
+    /**
+     * Checks if the result is in a completed state.
+     */
+    isCompleted(): this is ResetPasswordSubmitPasswordResult & {
+        state: ResetPasswordCompletedState;
+    } {
+        return this.state instanceof ResetPasswordCompletedState;
+    }
+}
+
+/**
+ * The possible states for the ResetPasswordSubmitPasswordResult.
+ * This includes:
+ * - ResetPasswordCompletedState: The reset password process has completed successfully.
+ * - ResetPasswordFailedState: The reset password process has failed.
+ */
+export type ResetPasswordSubmitPasswordResultState =
+    | ResetPasswordCompletedState
+    | ResetPasswordFailedState;

package/src/custom_auth/reset_password/auth_flow/state/ResetPasswordCodeRequiredState.ts

@@ -0,0 +1,130 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { ResetPasswordResendCodeResult } from "../result/ResetPasswordResendCodeResult.js";
+import { ResetPasswordSubmitCodeResult } from "../result/ResetPasswordSubmitCodeResult.js";
+import { ResetPasswordCodeRequiredStateParameters } from "./ResetPasswordStateParameters.js";
+import { ResetPasswordState } from "./ResetPasswordState.js";
+import { ResetPasswordPasswordRequiredState } from "./ResetPasswordPasswordRequiredState.js";
+
+/*
+ * Reset password code required state.
+ */
+export class ResetPasswordCodeRequiredState extends ResetPasswordState<ResetPasswordCodeRequiredStateParameters> {
+    /**
+     * Submits a one-time passcode that the customer user received in their email in order to continue password reset flow.
+     * @param {string} code - The code to submit.
+     * @returns {Promise<ResetPasswordSubmitCodeResult>} The result of the operation.
+     */
+    async submitCode(code: string): Promise<ResetPasswordSubmitCodeResult> {
+        try {
+            this.ensureCodeIsValid(code, this.stateParameters.codeLength);
+
+            this.stateParameters.logger.verbose(
+                "Submitting code for password reset.",
+                this.stateParameters.correlationId
+            );
+
+            const result =
+                await this.stateParameters.resetPasswordClient.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 is submitted for password reset.",
+                this.stateParameters.correlationId
+            );
+
+            return new ResetPasswordSubmitCodeResult(
+                new ResetPasswordPasswordRequiredState({
+                    correlationId: result.correlationId,
+                    continuationToken: result.continuationToken,
+                    logger: this.stateParameters.logger,
+                    config: this.stateParameters.config,
+                    resetPasswordClient:
+                        this.stateParameters.resetPasswordClient,
+                    signInClient: this.stateParameters.signInClient,
+                    cacheClient: this.stateParameters.cacheClient,
+                    username: this.stateParameters.username,
+                })
+            );
+        } catch (error) {
+            this.stateParameters.logger.errorPii(
+                `Failed to submit code for password reset. Error: ${error}.`,
+                this.stateParameters.correlationId
+            );
+
+            return ResetPasswordSubmitCodeResult.createWithError(error);
+        }
+    }
+
+    /**
+     * Resends another one-time passcode if the previous one hasn't been verified
+     * @returns {Promise<ResetPasswordResendCodeResult>} The result of the operation.
+     */
+    async resendCode(): Promise<ResetPasswordResendCodeResult> {
+        try {
+            this.stateParameters.logger.verbose(
+                "Resending code for password reset.",
+                this.stateParameters.correlationId
+            );
+
+            const result =
+                await this.stateParameters.resetPasswordClient.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 is resent for password reset.",
+                this.stateParameters.correlationId
+            );
+
+            return new ResetPasswordResendCodeResult(
+                new ResetPasswordCodeRequiredState({
+                    correlationId: result.correlationId,
+                    continuationToken: result.continuationToken,
+                    logger: this.stateParameters.logger,
+                    config: this.stateParameters.config,
+                    resetPasswordClient:
+                        this.stateParameters.resetPasswordClient,
+                    signInClient: this.stateParameters.signInClient,
+                    cacheClient: this.stateParameters.cacheClient,
+                    username: this.stateParameters.username,
+                    codeLength: result.codeLength,
+                })
+            );
+        } catch (error) {
+            this.stateParameters.logger.errorPii(
+                `Failed to resend code for password reset. Error: ${error}.`,
+                this.stateParameters.correlationId
+            );
+
+            return ResetPasswordResendCodeResult.createWithError(error);
+        }
+    }
+
+    /**
+     * Gets the sent code length.
+     * @returns {number} The length of the code.
+     */
+    getCodeLength(): number {
+        return this.stateParameters.codeLength;
+    }
+}

package/src/custom_auth/reset_password/auth_flow/state/ResetPasswordCompletedState.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 that indicates the successful completion of a password reset operation.
+ */
+export class ResetPasswordCompletedState extends SignInContinuationState {}

package/src/custom_auth/reset_password/auth_flow/state/ResetPasswordFailedState.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";
+
+/**
+ * State of a reset password operation that has failed.
+ */
+export class ResetPasswordFailedState extends AuthFlowStateBase {}

package/src/custom_auth/reset_password/auth_flow/state/ResetPasswordPasswordRequiredState.ts

@@ -0,0 +1,73 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { ResetPasswordSubmitPasswordResult } from "../result/ResetPasswordSubmitPasswordResult.js";
+import { ResetPasswordState } from "./ResetPasswordState.js";
+import { ResetPasswordPasswordRequiredStateParameters } from "./ResetPasswordStateParameters.js";
+import { ResetPasswordCompletedState } from "./ResetPasswordCompletedState.js";
+import { SignInScenario } from "../../../sign_in/auth_flow/SignInScenario.js";
+
+/*
+ * Reset password password required state.
+ */
+export class ResetPasswordPasswordRequiredState extends ResetPasswordState<ResetPasswordPasswordRequiredStateParameters> {
+    /**
+     * Submits a new password for reset password flow.
+     * @param {string} password - The password to submit.
+     * @returns {Promise<ResetPasswordSubmitPasswordResult>} The result of the operation.
+     */
+    async submitNewPassword(
+        password: string
+    ): Promise<ResetPasswordSubmitPasswordResult> {
+        try {
+            this.ensurePasswordIsNotEmpty(password);
+
+            this.stateParameters.logger.verbose(
+                "Submitting new password for password reset.",
+                this.stateParameters.correlationId
+            );
+
+            const result =
+                await this.stateParameters.resetPasswordClient.submitNewPassword(
+                    {
+                        clientId: this.stateParameters.config.auth.clientId,
+                        correlationId: this.stateParameters.correlationId,
+                        challengeType:
+                            this.stateParameters.config.customAuth
+                                .challengeTypes ?? [],
+                        continuationToken:
+                            this.stateParameters.continuationToken ?? "",
+                        newPassword: password,
+                        username: this.stateParameters.username,
+                    }
+                );
+
+            this.stateParameters.logger.verbose(
+                "New password is submitted for sign-up.",
+                this.stateParameters.correlationId
+            );
+
+            return new ResetPasswordSubmitPasswordResult(
+                new ResetPasswordCompletedState({
+                    correlationId: result.correlationId,
+                    continuationToken: result.continuationToken,
+                    logger: this.stateParameters.logger,
+                    config: this.stateParameters.config,
+                    username: this.stateParameters.username,
+                    signInClient: this.stateParameters.signInClient,
+                    cacheClient: this.stateParameters.cacheClient,
+                    signInScenario: SignInScenario.SignInAfterPasswordReset,
+                })
+            );
+        } catch (error) {
+            this.stateParameters.logger.errorPii(
+                `Failed to submit password for password reset. Error: ${error}.`,
+                this.stateParameters.correlationId
+            );
+
+            return ResetPasswordSubmitPasswordResult.createWithError(error);
+        }
+    }
+}

package/src/custom_auth/reset_password/auth_flow/state/ResetPasswordState.ts

@@ -0,0 +1,29 @@
+/*
+ * 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 { ResetPasswordStateParameters } from "./ResetPasswordStateParameters.js";
+
+/*
+ * Base state handler for reset password operation.
+ */
+export abstract class ResetPasswordState<
+    TParameters extends ResetPasswordStateParameters
+> extends AuthFlowActionRequiredStateBase<TParameters> {
+    /*
+     * Creates a new state for reset password operation.
+     * @param stateParameters - The state parameters for reset-password.
+     */
+    constructor(stateParameters: TParameters) {
+        super(stateParameters);
+
+        ensureArgumentIsNotEmptyString(
+            "username",
+            this.stateParameters.username,
+            this.stateParameters.correlationId
+        );
+    }
+}

package/src/custom_auth/reset_password/auth_flow/state/ResetPasswordStateParameters.ts

@@ -0,0 +1,25 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { ResetPasswordClient } from "../../interaction_client/ResetPasswordClient.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";
+
+export interface ResetPasswordStateParameters
+    extends AuthFlowActionRequiredStateParameters {
+    username: string;
+    resetPasswordClient: ResetPasswordClient;
+    signInClient: SignInClient;
+    cacheClient: CustomAuthSilentCacheClient;
+}
+
+export type ResetPasswordPasswordRequiredStateParameters =
+    ResetPasswordStateParameters;
+
+export interface ResetPasswordCodeRequiredStateParameters
+    extends ResetPasswordStateParameters {
+    codeLength: number;
+}