n4auth/node_modules/@azure/msal-common/dist/error/ClientConfigurationError.d.ts

172 lines
5.5 KiB
TypeScript
Raw Permalink Normal View History

2021-07-15 20:10:20 +00:00
import { ClientAuthError } from "./ClientAuthError";
/**
* ClientConfigurationErrorMessage class containing string constants used by error codes and messages.
*/
export declare const ClientConfigurationErrorMessage: {
redirectUriNotSet: {
code: string;
desc: string;
};
postLogoutUriNotSet: {
code: string;
desc: string;
};
claimsRequestParsingError: {
code: string;
desc: string;
};
authorityUriInsecure: {
code: string;
desc: string;
};
urlParseError: {
code: string;
desc: string;
};
urlEmptyError: {
code: string;
desc: string;
};
emptyScopesError: {
code: string;
desc: string;
};
nonArrayScopesError: {
code: string;
desc: string;
};
clientIdSingleScopeError: {
code: string;
desc: string;
};
invalidPrompt: {
code: string;
desc: string;
};
invalidClaimsRequest: {
code: string;
desc: string;
};
tokenRequestEmptyError: {
code: string;
desc: string;
};
logoutRequestEmptyError: {
code: string;
desc: string;
};
invalidCodeChallengeMethod: {
code: string;
desc: string;
};
invalidCodeChallengeParams: {
code: string;
desc: string;
};
invalidCloudDiscoveryMetadata: {
code: string;
desc: string;
};
invalidAuthorityMetadata: {
code: string;
desc: string;
};
untrustedAuthority: {
code: string;
desc: string;
};
resourceRequestParametersRequired: {
code: string;
desc: string;
};
};
/**
* Error thrown when there is an error in configuration of the MSAL.js library.
*/
export declare class ClientConfigurationError extends ClientAuthError {
constructor(errorCode: string, errorMessage?: string);
/**
* Creates an error thrown when the redirect uri is empty (not set by caller)
*/
static createRedirectUriEmptyError(): ClientConfigurationError;
/**
* Creates an error thrown when the post-logout redirect uri is empty (not set by caller)
*/
static createPostLogoutRedirectUriEmptyError(): ClientConfigurationError;
/**
* Creates an error thrown when the claims request could not be successfully parsed
*/
static createClaimsRequestParsingError(claimsRequestParseError: string): ClientConfigurationError;
/**
* Creates an error thrown if authority uri is given an insecure protocol.
* @param urlString
*/
static createInsecureAuthorityUriError(urlString: string): ClientConfigurationError;
/**
* Creates an error thrown if URL string does not parse into separate segments.
* @param urlString
*/
static createUrlParseError(urlParseError: string): ClientConfigurationError;
/**
* Creates an error thrown if URL string is empty or null.
* @param urlString
*/
static createUrlEmptyError(): ClientConfigurationError;
/**
* Error thrown when scopes are not an array
* @param inputScopes
*/
static createScopesNonArrayError(inputScopes: Array<string>): ClientConfigurationError;
/**
* Error thrown when scopes are empty.
* @param scopesValue
*/
static createEmptyScopesArrayError(inputScopes: Array<string>): ClientConfigurationError;
/**
* Error thrown when client id scope is not provided as single scope.
* @param inputScopes
*/
static createClientIdSingleScopeError(inputScopes: Array<string>): ClientConfigurationError;
/**
* Error thrown when prompt is not an allowed type.
* @param promptValue
*/
static createInvalidPromptError(promptValue: string): ClientConfigurationError;
/**
* Creates error thrown when claims parameter is not a stringified JSON object
*/
static createInvalidClaimsRequestError(): ClientConfigurationError;
/**
* Throws error when token request is empty and nothing cached in storage.
*/
static createEmptyLogoutRequestError(): ClientConfigurationError;
/**
* Throws error when token request is empty and nothing cached in storage.
*/
static createEmptyTokenRequestError(): ClientConfigurationError;
/**
* Throws error when an invalid code_challenge_method is passed by the user
*/
static createInvalidCodeChallengeMethodError(): ClientConfigurationError;
/**
* Throws error when both params: code_challenge and code_challenge_method are not passed together
*/
static createInvalidCodeChallengeParamsError(): ClientConfigurationError;
/**
* Throws an error when the user passes invalid cloudDiscoveryMetadata
*/
static createInvalidCloudDiscoveryMetadataError(): ClientConfigurationError;
/**
* Throws an error when the user passes invalid cloudDiscoveryMetadata
*/
static createInvalidAuthorityMetadataError(): ClientConfigurationError;
/**
* Throws error when provided authority is not a member of the trusted host list
*/
static createUntrustedAuthorityError(): ClientConfigurationError;
/**
* Throws error when resourceRequestMethod or resourceRequestUri is missing
*/
static createResourceRequestParametersRequiredError(): ClientConfigurationError;
}
//# sourceMappingURL=ClientConfigurationError.d.ts.map