@azure/msal-browser/src/error/BrowserConfigurationAuthError.ts

Microsoft Authentication Library for js

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

import { AuthError } from "@azure/msal-common/browser";
import * as BrowserConfigurationAuthErrorCodes from "./BrowserConfigurationAuthErrorCodes.js";
export { BrowserConfigurationAuthErrorCodes };

export const BrowserConfigurationAuthErrorMessages = {
    [BrowserConfigurationAuthErrorCodes.storageNotSupported]:
        "Given storage configuration option was not supported.",
    [BrowserConfigurationAuthErrorCodes.stubbedPublicClientApplicationCalled]:
        "Stub instance of Public Client Application was called. If using msal-react, please ensure context is not used without a provider. For more visit: aka.ms/msaljs/browser-errors",
    [BrowserConfigurationAuthErrorCodes.inMemRedirectUnavailable]:
        "Redirect cannot be supported. In-memory storage was selected and storeAuthStateInCookie=false, which would cause the library to be unable to handle the incoming hash. If you would like to use the redirect API, please use session/localStorage or set storeAuthStateInCookie=true.",
};

/**
 * BrowserAuthErrorMessage class containing string constants used by error codes and messages.
 * @deprecated Use BrowserAuthErrorCodes instead
 */
export const BrowserConfigurationAuthErrorMessage = {
    storageNotSupportedError: {
        code: BrowserConfigurationAuthErrorCodes.storageNotSupported,
        desc: BrowserConfigurationAuthErrorMessages[
            BrowserConfigurationAuthErrorCodes.storageNotSupported
        ],
    },
    stubPcaInstanceCalled: {
        code: BrowserConfigurationAuthErrorCodes.stubbedPublicClientApplicationCalled,
        desc: BrowserConfigurationAuthErrorMessages[
            BrowserConfigurationAuthErrorCodes
                .stubbedPublicClientApplicationCalled
        ],
    },
    inMemRedirectUnavailable: {
        code: BrowserConfigurationAuthErrorCodes.inMemRedirectUnavailable,
        desc: BrowserConfigurationAuthErrorMessages[
            BrowserConfigurationAuthErrorCodes.inMemRedirectUnavailable
        ],
    },
};

/**
 * Browser library error class thrown by the MSAL.js library for SPAs
 */
export class BrowserConfigurationAuthError extends AuthError {
    constructor(errorCode: string, errorMessage?: string) {
        super(errorCode, errorMessage);
        this.name = "BrowserConfigurationAuthError";

        Object.setPrototypeOf(this, BrowserConfigurationAuthError.prototype);
    }
}

export function createBrowserConfigurationAuthError(
    errorCode: string
): BrowserConfigurationAuthError {
    return new BrowserConfigurationAuthError(
        errorCode,
        BrowserConfigurationAuthErrorMessages[errorCode]
    );
}