@azure/msal-browser 4.13.1 → 4.14.0

package/src/custom_auth/sign_in/auth_flow/result/SignInSubmitCredentialResult.ts

@@ -0,0 +1,43 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { CustomAuthAccountData } from "../../../get_account/auth_flow/CustomAuthAccountData.js";
+import { AuthFlowErrorBase } from "../../../core/auth_flow/AuthFlowErrorBase.js";
+import { AuthFlowResultBase } from "../../../core/auth_flow/AuthFlowResultBase.js";
+import { SignInFailedState } from "../state/SignInFailedState.js";
+import { SignInCompletedState } from "../state/SignInCompletedState.js";
+
+/*
+ * Result of a sign-in submit credential operation.
+ */
+export abstract class SignInSubmitCredentialResult<
+    TError extends AuthFlowErrorBase
+> extends AuthFlowResultBase<
+    SignInSubmitCredentialResultState,
+    TError,
+    CustomAuthAccountData
+> {
+    /**
+     * Creates a new instance of SignInSubmitCredentialResult.
+     * @param state The state of the result.
+     * @param resultData The result data.
+     */
+    constructor(
+        state: SignInSubmitCredentialResultState,
+        resultData?: CustomAuthAccountData
+    ) {
+        super(state, resultData);
+    }
+}
+
+/**
+ * The possible states of the SignInSubmitCredentialResult.
+ * This includes:
+ * - SignInCompletedState: The sign-in process has completed successfully.
+ * - SignInFailedState: The sign-in process has failed.
+ */
+export type SignInSubmitCredentialResultState =
+    | SignInCompletedState
+    | SignInFailedState;

package/src/custom_auth/sign_in/auth_flow/result/SignInSubmitPasswordResult.ts

@@ -0,0 +1,41 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { SignInSubmitPasswordError } from "../error_type/SignInError.js";
+import { SignInCompletedState } from "../state/SignInCompletedState.js";
+import { SignInFailedState } from "../state/SignInFailedState.js";
+import { SignInSubmitCredentialResult } from "./SignInSubmitCredentialResult.js";
+
+/*
+ * Result of a sign-in submit password operation.
+ */
+export class SignInSubmitPasswordResult extends SignInSubmitCredentialResult<SignInSubmitPasswordError> {
+    static createWithError(error: unknown): SignInSubmitPasswordResult {
+        const result = new SignInSubmitPasswordResult(new SignInFailedState());
+        result.error = new SignInSubmitPasswordError(
+            SignInSubmitPasswordResult.createErrorData(error)
+        );
+
+        return result;
+    }
+
+    /**
+     * Checks if the result is in a failed state.
+     */
+    isFailed(): this is SignInSubmitPasswordResult & {
+        state: SignInFailedState;
+    } {
+        return this.state instanceof SignInFailedState;
+    }
+
+    /**
+     * Checks if the result is in a completed state.
+     */
+    isCompleted(): this is SignInSubmitPasswordResult & {
+        state: SignInCompletedState;
+    } {
+        return this.state instanceof SignInCompletedState;
+    }
+}

package/src/custom_auth/sign_in/auth_flow/state/SignInCodeRequiredState.ts

@@ -0,0 +1,141 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { CustomAuthAccountData } from "../../../get_account/auth_flow/CustomAuthAccountData.js";
+import {
+    SignInResendCodeParams,
+    SignInSubmitCodeParams,
+} from "../../interaction_client/parameter/SignInParams.js";
+import { SignInResendCodeResult } from "../result/SignInResendCodeResult.js";
+import { SignInSubmitCodeResult } from "../result/SignInSubmitCodeResult.js";
+import { SignInCodeRequiredStateParameters } from "./SignInStateParameters.js";
+import { SignInState } from "./SignInState.js";
+import { SignInCompletedState } from "./SignInCompletedState.js";
+
+/*
+ * Sign-in code required state.
+ */
+export class SignInCodeRequiredState extends SignInState<SignInCodeRequiredStateParameters> {
+    /**
+     * Once user configures email one-time passcode as a authentication method in Microsoft Entra, a one-time passcode will be sent to the user’s email.
+     * Submit this one-time passcode to continue sign-in flow.
+     * @param {string} code - The code to submit.
+     * @returns {Promise<SignInSubmitCodeResult>} The result of the operation.
+     */
+    async submitCode(code: string): Promise<SignInSubmitCodeResult> {
+        try {
+            this.ensureCodeIsValid(code, this.stateParameters.codeLength);
+
+            const submitCodeParams: SignInSubmitCodeParams = {
+                clientId: this.stateParameters.config.auth.clientId,
+                correlationId: this.stateParameters.correlationId,
+                challengeType:
+                    this.stateParameters.config.customAuth.challengeTypes ?? [],
+                scopes: this.stateParameters.scopes ?? [],
+                continuationToken: this.stateParameters.continuationToken ?? "",
+                code: code,
+                username: this.stateParameters.username,
+            };
+
+            this.stateParameters.logger.verbose(
+                "Submitting code for sign-in.",
+                this.stateParameters.correlationId
+            );
+
+            const completedResult =
+                await this.stateParameters.signInClient.submitCode(
+                    submitCodeParams
+                );
+
+            this.stateParameters.logger.verbose(
+                "Code submitted for sign-in.",
+                this.stateParameters.correlationId
+            );
+
+            const accountInfo = new CustomAuthAccountData(
+                completedResult.authenticationResult.account,
+                this.stateParameters.config,
+                this.stateParameters.cacheClient,
+                this.stateParameters.logger,
+                this.stateParameters.correlationId
+            );
+
+            return new SignInSubmitCodeResult(
+                new SignInCompletedState(),
+                accountInfo
+            );
+        } catch (error) {
+            this.stateParameters.logger.errorPii(
+                `Failed to submit code for sign-in. Error: ${error}.`,
+                this.stateParameters.correlationId
+            );
+
+            return SignInSubmitCodeResult.createWithError(error);
+        }
+    }
+
+    /**
+     * Resends the another one-time passcode for sign-in flow if the previous one hasn't been verified.
+     * @returns {Promise<SignInResendCodeResult>} The result of the operation.
+     */
+    async resendCode(): Promise<SignInResendCodeResult> {
+        try {
+            const submitCodeParams: SignInResendCodeParams = {
+                clientId: this.stateParameters.config.auth.clientId,
+                correlationId: this.stateParameters.correlationId,
+                challengeType:
+                    this.stateParameters.config.customAuth.challengeTypes ?? [],
+                continuationToken: this.stateParameters.continuationToken ?? "",
+                username: this.stateParameters.username,
+            };
+
+            this.stateParameters.logger.verbose(
+                "Resending code for sign-in.",
+                this.stateParameters.correlationId
+            );
+
+            const result = await this.stateParameters.signInClient.resendCode(
+                submitCodeParams
+            );
+
+            this.stateParameters.logger.verbose(
+                "Code resent for sign-in.",
+                this.stateParameters.correlationId
+            );
+
+            return new SignInResendCodeResult(
+                new SignInCodeRequiredState({
+                    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,
+                    codeLength: result.codeLength,
+                    scopes: this.stateParameters.scopes,
+                })
+            );
+        } catch (error) {
+            return SignInResendCodeResult.createWithError(error);
+        }
+    }
+
+    /**
+     * Gets the sent code length.
+     * @returns {number} The length of the code.
+     */
+    getCodeLength(): number {
+        return this.stateParameters.codeLength;
+    }
+
+    /**
+     * Gets the scopes to request.
+     * @returns {string[] | undefined} The scopes to request.
+     */
+    getScopes(): string[] | undefined {
+        return this.stateParameters.scopes;
+    }
+}

package/src/custom_auth/sign_in/auth_flow/state/SignInCompletedState.ts

@@ -0,0 +1,12 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { AuthFlowStateBase } from "../../../core/auth_flow/AuthFlowState.js";
+
+/**
+ * Represents the completed state of the sign-in operation.
+ * This state indicates that the sign-in process has finished successfully.
+ */
+export class SignInCompletedState extends AuthFlowStateBase {}

package/src/custom_auth/sign_in/auth_flow/state/SignInContinuationState.ts

@@ -0,0 +1,71 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { CustomAuthAccountData } from "../../../get_account/auth_flow/CustomAuthAccountData.js";
+import { SignInContinuationTokenParams } from "../../interaction_client/parameter/SignInParams.js";
+import { SignInResult } from "../result/SignInResult.js";
+import { SignInWithContinuationTokenInputs } from "../../../CustomAuthActionInputs.js";
+import { SignInContinuationStateParameters } from "./SignInStateParameters.js";
+import { SignInState } from "./SignInState.js";
+import { SignInCompletedState } from "./SignInCompletedState.js";
+
+/*
+ * Sign-in continuation state.
+ */
+export class SignInContinuationState extends SignInState<SignInContinuationStateParameters> {
+    /**
+     * Initiates the sign-in flow with continuation token.
+     * @param {SignInWithContinuationTokenInputs} signInWithContinuationTokenInputs - The result of the operation.
+     * @returns {Promise<SignInResult>} The result of the operation.
+     */
+    async signIn(
+        signInWithContinuationTokenInputs?: SignInWithContinuationTokenInputs
+    ): Promise<SignInResult> {
+        try {
+            const continuationTokenParams: SignInContinuationTokenParams = {
+                clientId: this.stateParameters.config.auth.clientId,
+                correlationId: this.stateParameters.correlationId,
+                challengeType:
+                    this.stateParameters.config.customAuth.challengeTypes ?? [],
+                scopes: signInWithContinuationTokenInputs?.scopes ?? [],
+                continuationToken: this.stateParameters.continuationToken ?? "",
+                username: this.stateParameters.username,
+                signInScenario: this.stateParameters.signInScenario,
+            };
+
+            this.stateParameters.logger.verbose(
+                "Signing in with continuation token.",
+                this.stateParameters.correlationId
+            );
+
+            const completedResult =
+                await this.stateParameters.signInClient.signInWithContinuationToken(
+                    continuationTokenParams
+                );
+
+            this.stateParameters.logger.verbose(
+                "Signed in with continuation token.",
+                this.stateParameters.correlationId
+            );
+
+            const accountInfo = new CustomAuthAccountData(
+                completedResult.authenticationResult.account,
+                this.stateParameters.config,
+                this.stateParameters.cacheClient,
+                this.stateParameters.logger,
+                this.stateParameters.correlationId
+            );
+
+            return new SignInResult(new SignInCompletedState(), accountInfo);
+        } catch (error) {
+            this.stateParameters.logger.errorPii(
+                `Failed to sign in with continuation token. Error: ${error}.`,
+                this.stateParameters.correlationId
+            );
+
+            return SignInResult.createWithError(error);
+        }
+    }
+}

package/src/custom_auth/sign_in/auth_flow/state/SignInFailedState.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-in operation that has been failed.
+ */
+export class SignInFailedState extends AuthFlowStateBase {}

package/src/custom_auth/sign_in/auth_flow/state/SignInPasswordRequiredState.ts

@@ -0,0 +1,83 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { CustomAuthAccountData } from "../../../get_account/auth_flow/CustomAuthAccountData.js";
+import { SignInSubmitPasswordParams } from "../../interaction_client/parameter/SignInParams.js";
+import { SignInSubmitPasswordResult } from "../result/SignInSubmitPasswordResult.js";
+import { SignInCompletedState } from "./SignInCompletedState.js";
+import { SignInState } from "./SignInState.js";
+import { SignInPasswordRequiredStateParameters } from "./SignInStateParameters.js";
+
+/*
+ * Sign-in password required state.
+ */
+export class SignInPasswordRequiredState extends SignInState<SignInPasswordRequiredStateParameters> {
+    /**
+     * Once user configures email with password as a authentication method in Microsoft Entra, user submits a password to continue sign-in flow.
+     * @param {string} password - The password to submit.
+     * @returns {Promise<SignInSubmitPasswordResult>} The result of the operation.
+     */
+    async submitPassword(
+        password: string
+    ): Promise<SignInSubmitPasswordResult> {
+        try {
+            this.ensurePasswordIsNotEmpty(password);
+
+            const submitPasswordParams: SignInSubmitPasswordParams = {
+                clientId: this.stateParameters.config.auth.clientId,
+                correlationId: this.stateParameters.correlationId,
+                challengeType:
+                    this.stateParameters.config.customAuth.challengeTypes ?? [],
+                scopes: this.stateParameters.scopes ?? [],
+                continuationToken: this.stateParameters.continuationToken ?? "",
+                password: password,
+                username: this.stateParameters.username,
+            };
+
+            this.stateParameters.logger.verbose(
+                "Submitting password for sign-in.",
+                this.stateParameters.correlationId
+            );
+
+            const completedResult =
+                await this.stateParameters.signInClient.submitPassword(
+                    submitPasswordParams
+                );
+
+            this.stateParameters.logger.verbose(
+                "Password submitted for sign-in.",
+                this.stateParameters.correlationId
+            );
+
+            const accountInfo = new CustomAuthAccountData(
+                completedResult.authenticationResult.account,
+                this.stateParameters.config,
+                this.stateParameters.cacheClient,
+                this.stateParameters.logger,
+                this.stateParameters.correlationId
+            );
+
+            return new SignInSubmitPasswordResult(
+                new SignInCompletedState(),
+                accountInfo
+            );
+        } catch (error) {
+            this.stateParameters.logger.errorPii(
+                `Failed to sign in after submitting password. Error: ${error}.`,
+                this.stateParameters.correlationId
+            );
+
+            return SignInSubmitPasswordResult.createWithError(error);
+        }
+    }
+
+    /**
+     * Gets the scopes to request.
+     * @returns {string[] | undefined} The scopes to request.
+     */
+    getScopes(): string[] | undefined {
+        return this.stateParameters.scopes;
+    }
+}

package/src/custom_auth/sign_in/auth_flow/state/SignInState.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 { SignInStateParameters } from "./SignInStateParameters.js";
+
+/*
+ * Base state handler for sign-in flow.
+ */
+export abstract class SignInState<
+    TParameters extends SignInStateParameters
+> extends AuthFlowActionRequiredStateBase<TParameters> {
+    /*
+     * Creates a new SignInState.
+     * @param stateParameters - The state parameters for sign-in.
+     */
+    constructor(stateParameters: TParameters) {
+        super(stateParameters);
+
+        ensureArgumentIsNotEmptyString(
+            "username",
+            stateParameters.username,
+            stateParameters.correlationId
+        );
+        ensureArgumentIsNotEmptyString(
+            "continuationToken",
+            stateParameters.continuationToken,
+            stateParameters.correlationId
+        );
+    }
+}

package/src/custom_auth/sign_in/auth_flow/state/SignInStateParameters.ts

@@ -0,0 +1,32 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { AuthFlowActionRequiredStateParameters } from "../../../core/auth_flow/AuthFlowState.js";
+import { CustomAuthSilentCacheClient } from "../../../get_account/interaction_client/CustomAuthSilentCacheClient.js";
+import { SignInClient } from "../../interaction_client/SignInClient.js";
+import { SignInScenarioType } from "../SignInScenario.js";
+
+export interface SignInStateParameters
+    extends AuthFlowActionRequiredStateParameters {
+    username: string;
+    signInClient: SignInClient;
+    cacheClient: CustomAuthSilentCacheClient;
+}
+
+export interface SignInPasswordRequiredStateParameters
+    extends SignInStateParameters {
+    scopes?: string[];
+}
+
+export interface SignInCodeRequiredStateParameters
+    extends SignInStateParameters {
+    codeLength: number;
+    scopes?: string[];
+}
+
+export interface SignInContinuationStateParameters
+    extends SignInStateParameters {
+    signInScenario: SignInScenarioType;
+}