@inventorjs/api-service/dist/types.d.ts

Api service manager base on axios

/**
 * types
 */
import type { AxiosInstance, AxiosRequestConfig, AxiosRequestHeaders, AxiosInterceptorManager, AxiosResponse, AxiosError, AxiosHeaders } from 'axios';
type RequestInteceptorInternal = Parameters<AxiosInterceptorManager<ApiConfigFinal>['use']>;
type ResponseInteceptorInternal = Parameters<AxiosInterceptorManager<AxiosResponse>['use']>;
export type RequestInteceptorOnFulfilled = RequestInteceptorInternal[0];
export type RequestInteceptorOnRejected = RequestInteceptorInternal[1];
export type RequestInteceptorOptions = RequestInteceptorInternal[2];
export type ResponseInteceptorOptions = ResponseInteceptorInternal[2];
export type ClassType<T = unknown> = {
    new (): T;
};
export type Instance = AxiosInstance;
export type Response<T = unknown, D = unknown> = AxiosResponse<T, D> & {
    config: ApiConfigFinal;
};
export type Headers = AxiosHeaders;
export type RequestHeaders = AxiosRequestConfig['headers'];
export interface ResponseError extends AxiosError {
    config: ApiConfigFinal;
}
export declare abstract class RequestInterceptor {
    options: RequestInteceptorOptions;
    abstract onFulfilled<T = unknown>(config: ApiConfigFinal): Promise<ApiConfigFinal>;
    abstract onRejected<T = unknown>(error: T): Promise<T | undefined | null>;
}
export declare abstract class ResponseInterceptor {
    options: ResponseInteceptorOptions;
    abstract onFulfilled(response: Response): Promise<Response>;
    abstract onRejected(error: unknown): Promise<unknown>;
}
export interface Logger {
    debug: (msg: unknown) => void;
    log: (msg: unknown) => void;
    warn: (msg: unknown) => void;
    error: (msg: unknown) => void;
}
export interface LoggerConfig {
    logger?: Logger;
    customEventName?: {
        success?: string;
        error?: string;
    };
    customAttributeKeys?: {
        event?: string;
        req?: string;
        res?: string;
        err?: string;
        responseTime?: string;
    };
}
export interface ApiConfig<D = unknown> extends AxiosRequestConfig<D> {
    $runtime?: {
        startTime?: number;
        reqId?: string;
        retryCount?: number;
        [k: string]: unknown;
    };
    $ext?: {
        observe?: 'body' | 'response';
        params?: Record<string, number | string>;
        rcChannel?: string;
        retry?: number;
        reqIdHeaderName?: string;
        genReqId?: {
            (config: ApiConfig): string;
        };
        logger?: boolean | LoggerConfig;
        requestInterceptors?: (new () => RequestInterceptor)[];
        responseInterceptors?: (new () => ResponseInterceptor)[];
    };
}
export interface ApiConfigFinal<D = unknown> extends ApiConfig<D> {
    headers: AxiosRequestHeaders;
}
export {};