@azure/msal-browser/src/custom_auth/sign_in/interaction_client/result/SignInActionResult.ts

Microsoft Authentication Library for js

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

import { AuthenticationResult } from "../../../../response/AuthenticationResult.js";
import { AuthenticationMethod } from "../../../core/network_client/custom_auth_api/types/ApiResponseTypes.js";

interface SignInActionResult {
    type: string;
    correlationId: string;
}

interface SignInContinuationTokenResult extends SignInActionResult {
    continuationToken: string;
}

export interface SignInCompletedResult extends SignInActionResult {
    type: typeof SIGN_IN_COMPLETED_RESULT_TYPE;
    authenticationResult: AuthenticationResult;
}

export interface SignInPasswordRequiredResult
    extends SignInContinuationTokenResult {
    type: typeof SIGN_IN_PASSWORD_REQUIRED_RESULT_TYPE;
}

export interface SignInCodeSendResult extends SignInContinuationTokenResult {
    type: typeof SIGN_IN_CODE_SEND_RESULT_TYPE;
    challengeChannel: string;
    challengeTargetLabel: string;
    codeLength: number;
    bindingMethod: string;
}

export interface SignInJitRequiredResult extends SignInContinuationTokenResult {
    type: typeof SIGN_IN_JIT_REQUIRED_RESULT_TYPE;
    authMethods: AuthenticationMethod[];
}

export interface SignInMfaRequiredResult extends SignInContinuationTokenResult {
    type: typeof SIGN_IN_MFA_REQUIRED_RESULT_TYPE;
    authMethods: AuthenticationMethod[];
}

export const SIGN_IN_CODE_SEND_RESULT_TYPE = "SignInCodeSendResult";
export const SIGN_IN_PASSWORD_REQUIRED_RESULT_TYPE =
    "SignInPasswordRequiredResult";
export const SIGN_IN_COMPLETED_RESULT_TYPE = "SignInCompletedResult";
export const SIGN_IN_JIT_REQUIRED_RESULT_TYPE = "SignInJitRequiredResult";
export const SIGN_IN_MFA_REQUIRED_RESULT_TYPE = "SignInMfaRequiredResult";

export function createSignInCompleteResult(
    input: Omit<SignInCompletedResult, "type">
): SignInCompletedResult {
    return {
        type: SIGN_IN_COMPLETED_RESULT_TYPE,
        ...input,
    };
}

export function createSignInPasswordRequiredResult(
    input: Omit<SignInPasswordRequiredResult, "type">
): SignInPasswordRequiredResult {
    return {
        type: SIGN_IN_PASSWORD_REQUIRED_RESULT_TYPE,
        ...input,
    };
}

export function createSignInCodeSendResult(
    input: Omit<SignInCodeSendResult, "type">
): SignInCodeSendResult {
    return {
        type: SIGN_IN_CODE_SEND_RESULT_TYPE,
        ...input,
    };
}

export function createSignInJitRequiredResult(
    input: Omit<SignInJitRequiredResult, "type">
): SignInJitRequiredResult {
    return {
        type: SIGN_IN_JIT_REQUIRED_RESULT_TYPE,
        ...input,
    };
}

export function createSignInMfaRequiredResult(
    input: Omit<SignInMfaRequiredResult, "type">
): SignInMfaRequiredResult {
    return {
        type: SIGN_IN_MFA_REQUIRED_RESULT_TYPE,
        ...input,
    };
}