export declare type HttpMethod = 'GET' | 'POST' | 'PUT' | 'DELETE';
export declare type RequestQuery = Record<string, any>;
export declare type RequestBody = Record<string, any> | null;
export declare type ResponseHeaders = Record<string, any>;
export interface MockRequest {
    requestQuery: ResponseHeaders;
    requestBody: any;
    requestHeaders: ResponseHeaders;
}
export interface MockResponse {
    responseBody: any;
    responseCode: number;
    responseHeaders: ResponseHeaders;
}
export declare type MockParams = Pick<Mock, 'url' | 'method' | 'responseCode' | 'responseHeaders'>;
export interface Mock {
    /**
     * A regular expression that should match with the URL of the HTTP request.
     */
    url: RegExp;
    /**
     * HTTP method.
     */
    method: HttpMethod;
    /**
     * A function that contains a logic that returns response data accordingly to the request (query params and payload).
     */
    responseFn: (requestQuery: RequestQuery, requestBody: RequestBody) => MockResponse['responseBody'];
    /**
     * Status code of the HTTP transaction. (default: `200`)
     */
    responseCode?: number;
    /**
     * Headers of the response. (default: `{}`)
     */
    responseHeaders?: ResponseHeaders;
    /**
     * Time of the response delay (in milliseconds). (default: `0`)
     */
    delay?: number;
}
export interface MockScenarios {
    default: Mock[];
    [mockScenario: string]: Mock[];
}
export interface MockOptions {
    /**
     * Whether pass through the request to the network if no mock exists. (default: `true`)
     */
    fallbackToNetwork?: boolean;
    /**
     * Whether log information about request/response of the mock to the console. (default: `false`)
     */
    loggingEnabled?: boolean;
    /**
     * Whether accept search string placed after the hashtag in URL,
     * e.g. `http://localhost:4200/#/?mockScenario=scenarioKey`. (default: `false`)
     */
    useLocationHash?: boolean;
    /**
     * The scenario key to use for mocking. (default: `'default'`)
     */
    mockScenario?: keyof MockScenarios;
    /**
     * Common response code for all mocks that can be overridden by the response code of the particular mock. (default: `200`)
     */
    defaultResponseCode?: number;
    /**
     * Common response headers for all mocks that can be overridden by the response headers of the particular mock. (default: `{}`)
     */
    defaultResponseHeaders?: ResponseHeaders;
    /**
     * Common mock delay for all mocks that can be overridden by the mock delay of the particular mock. (default: `0`)
     */
    defaultDelay?: number;
    /**
     * Wrapper function that applies to all mock responses.
     * Useful when you change the overall data response structure without an impact on the data.
     */
    responseProxyFn?: (responseBody: any, // The result of the `responseFn: (requestQuery: RequestQuery, requestBody: RequestBody) => any`
    mockParams: MockParams, mockRequest: MockRequest) => MockResponse;
    /**
     * Disables specific mocks.
     * With this option, you can easily disable particular mocks when you're about to connect to the real API.
     */
    ignoredMocks?: RegExp[];
}