@vendure/core/dist/common/error/errors.d.ts

A modern, headless ecommerce framework

import { ID } from '@vendure/common/lib/shared-types';
import { LogLevel } from '../../config/logger/vendure-logger';
import { coreEntitiesMap } from '../../entity/entities';
import { I18nError } from '../../i18n/i18n-error';
/**
 * @description
 * This error should be thrown when some unexpected and exceptional case is encountered.
 *
 * @docsCategory errors
 * @docsPage Error Types
 */
export declare class InternalServerError extends I18nError {
    constructor(message: string, variables?: {
        [key: string]: string | number;
    });
}
/**
 * @description
 * This error should be thrown when user input is not as expected.
 *
 * @docsCategory errors
 * @docsPage Error Types
 */
export declare class UserInputError extends I18nError {
    constructor(message: string, variables?: {
        [key: string]: string | number;
    });
}
/**
 * @description
 * This error should be thrown when an operation is attempted which is not allowed.
 *
 * @docsCategory errors
 * @docsPage Error Types
 */
export declare class IllegalOperationError extends I18nError {
    constructor(message: string, variables?: {
        [key: string]: string | number;
    });
}
/**
 * @description
 * This error should be thrown when the user's authentication credentials do not match.
 *
 * @docsCategory errors
 * @docsPage Error Types
 */
export declare class UnauthorizedError extends I18nError {
    constructor();
}
/**
 * @description
 * This error should be thrown when a user attempts to access a resource which is outside of
 * his or her privileges.
 *
 * @docsCategory errors
 * @docsPage Error Types
 */
export declare class ForbiddenError extends I18nError {
    constructor(logLevel?: LogLevel);
}
/**
 * @description
 * This error should be thrown when an external authentication attempt presents an email
 * address which already belongs to an existing account, but the external provider has not
 * verified that the authenticating user owns that email address. Linking in this situation
 * would allow account takeover, so it is refused.
 *
 * @docsCategory errors
 * @docsPage Error Types
 * @since 3.7.0
 */
export declare class UnverifiedExternalEmailError extends I18nError {
    constructor();
}
/**
 * @description
 * This error should be thrown when a {@link Channel} cannot be found based on the provided
 * channel token.
 *
 * @docsCategory errors
 * @docsPage Error Types
 */
export declare class ChannelNotFoundError extends I18nError {
    constructor(token: string);
}
/**
 * @description
 * This error should be thrown when an entity cannot be found in the database, i.e. no entity of
 * the given entityName (Product, User etc.) exists with the provided id.
 *
 * @docsCategory errors
 * @docsPage Error Types
 */
export declare class EntityNotFoundError extends I18nError {
    constructor(entityName: keyof typeof coreEntitiesMap | string, id: ID);
}