interfaces.ts

export type IHTTPMethods = 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'CONNECT' | 'OPTIONS' | 'TRACE';

export interface IAPIOptions {
    fetchMethod: (url: string, options?: any) => Promise<any>;
    domains: { default: string, [key: string]: string };
    prefixes: { default: string, [key: string]: string };
    encodeParameters?: boolean;
    middlewares?: APIMiddleware[];
    responseMiddleware?: ResponseMiddleware;
    debugAPI?: boolean;
    printNetworkRequests?: boolean;
    disableCache?: boolean;
    cacheExpiration?: number;
    cachePrefix?: string;
    ignoreHeadersWhenCaching?: boolean;
    capServices?: boolean;
    capLimit?: number;
}

export interface IAPIService {
    path?: string;
    expiration?: number;
    method?: IHTTPMethods;
    domain?: string;
    prefix?: string;
    middlewares?: APIMiddleware[];
    responseMiddleware?: ResponseMiddleware;
    ignoreHeadersWhenCaching?: boolean;
    disableCache?: boolean;
    capService?: boolean;
    capLimit?: number;
    rawData?: boolean;
}

export interface IAPIServices {
    [key: string]: IAPIService;
}

export interface IFetchOptions extends IAPIService {
    pathParameters?: { [key: string]: any };
    queryParameters?: { [key: string]: any };
    headers?: { [key: string]: string };
    fetchHeaders?: boolean;
    middlewares?: APIMiddleware[];
    responseMiddleware?: ResponseMiddleware;
    fetchOptions?: any;
}

export interface IFetchResponse {
    success: boolean;
    data?: any;
}

export interface ICachedData {
    success: boolean;
    data?: any;
    fresh?: boolean;
}

export interface ICacheDictionary {
    [key: string]: number;
}

export interface IAPICacheDriver {
    getItem(key: string): Promise<any>;
    setItem(key: string, value: string, callback?: (err: any, value: string) => any): Promise<any>;
    removeItem(key: string): Promise<any>;
}

export interface IMiddlewarePaths {
    fullPath: string;
    withoutQueryParams: string;
}

export type APIMiddleware = (serviceDefinition: IAPIService, paths: IMiddlewarePaths, options?: IFetchOptions) => any;
export type ResponseMiddleware = (response: any) => any;