@azure/msal-browser/src/custom_auth/controller/ICustomAuthStandardController.ts

Microsoft Authentication Library for js

/*
 * Copyright (c) Microsoft Corporation. All rights reserved.
 * Licensed under the MIT License.
 */

import { GetAccountResult } from "../get_account/auth_flow/result/GetAccountResult.js";
import { SignInResult } from "../sign_in/auth_flow/result/SignInResult.js";
import { SignUpResult } from "../sign_up/auth_flow/result/SignUpResult.js";
import {
    AccountRetrievalInputs,
    ResetPasswordInputs,
    SignInInputs,
    SignUpInputs,
} from "../CustomAuthActionInputs.js";
import { ResetPasswordStartResult } from "../reset_password/auth_flow/result/ResetPasswordStartResult.js";
import { IController } from "../../controllers/IController.js";

/*
 * Controller interface for standard authentication operations.
 */
export interface ICustomAuthStandardController extends IController {
    /*
     * Gets the current account from the cache.
     * @param accountRetrievalInputs - Inputs for getting the current cached account
     * @returns - The result of the operation
     */
    getCurrentAccount(
        accountRetrievalInputs?: AccountRetrievalInputs
    ): GetAccountResult;

    /*
     * Signs the current user out.
     * @param signInInputs - Inputs for signing in.
     * @returns The result of the operation.
     */
    signIn(signInInputs: SignInInputs): Promise<SignInResult>;

    /*
     * Signs the current user up.
     * @param signUpInputs - Inputs for signing up.
     * @returns The result of the operation.
     */
    signUp(signUpInputs: SignUpInputs): Promise<SignUpResult>;

    /*
     * Resets the password for the current user.
     * @param resetPasswordInputs - Inputs for resetting the password.
     * @returns The result of the operation.
     */
    resetPassword(
        resetPasswordInputs: ResetPasswordInputs
    ): Promise<ResetPasswordStartResult>;
}