import { ResponseType } from 'axios';

export interface IResponseRetryStrategyResult {
    options: IRetryStrategyOptions;
    retryAttempts: number;
}

export interface IResponse<TRawData> {
    data: TRawData;
    headers: IHeader[];
    rawResponse: any;
    status: number;
    retryStrategy: IResponseRetryStrategyResult;
}

export interface IRetryStrategyOptions {
    /**
     * back-off interval between retries
     */
    deltaBackoffMs?: number;
    /**
     * Maximum allowed number of attempts
     */
    maxAttempts?: number;
    /**
     * Indicates if jitter is added to retry
     */
    addJitter?: boolean;
    /**
     * Determines if error can be retried. There are errors that are never retried
     * such as when request is cancelled or the response status is 404 and so on...
     */
    canRetryError?: (error: any) => boolean;
}

export interface IHttpQueryCall {
    url: string;
}

export interface IHttpPostQueryCall extends IHttpQueryCall {
    body: any;
}

export interface IHttpPutQueryCall extends IHttpQueryCall {
    body: any;
}

export interface IHttpPatchQueryCall extends IHttpQueryCall {
    body: any;
}

export interface IHttpDeleteQueryCall extends IHttpQueryCall {}

export interface IHttpGetQueryCall extends IHttpQueryCall {}

export interface IHttpCancelRequestToken<TCancelToken> {
    token: TCancelToken;
    cancel: (cancelMessage?: string) => void;
}

export interface IHttpQueryOptions<TCancelToken> {
    /**
     * retry strategy
     */
    retryStrategy?: IRetryStrategyOptions;
    /**
     * Request headers
     */
    headers?: IHeader[];
    /**
     * Response type
     */
    responseType?: ResponseType;
    /**
     * Cancel token
     */
    cancelToken?: IHttpCancelRequestToken<TCancelToken>;
}

export interface IHeader {
    header: string;
    value: string;
}