axios-annotations 1.3.3 → 2.0.0

package/lib/core/service.d.ts

@@ -1,33 +1,153 @@
-import Config from "./config";
-import {AxiosPromise, AxiosRequestConfig} from "axios";
-import {AbortControllerAdapter} from "../decorator/abort-source";
-
-export interface RequestController {
-    ignoreResidualParams: (ignore?: boolean) => RequestController;
-
-    param: (key: string, required?: boolean) => RequestController;
-
-    header: (header: string, value: string | ((...args: any[]) => string)) => RequestController;
-
-    body: (key: string) => RequestController;
-
-    config: (config: Partial<AxiosRequestConfig>) => RequestController;
-
-    send: (data?: Record<string, any>) => AxiosPromise<any>;
-
-    with: (registration: string) => RequestController;
-
-    abort: (abortController: (AbortController | AbortControllerAdapter) | ((...args: any[]) => (AbortControllerAdapter | AbortController))) => RequestController;
-}
-
-export default class Service {
-    constructor(path?: string);
-
-    config: Config;
-
-    path: string;
-
-    request(method: string, path: string, data?: any, config?: Partial<AxiosRequestConfig>): AxiosPromise<any>;
-
-    requestWith(method: string, path?: string): RequestController;
-}
+import type { AxiosRequestConfig, AxiosResponse, CancelTokenSource } from "axios";
+import AbortControllerAdapter from "./cancel";
+import Config from "./config";
+export type HeaderMappingValueType = string | ((...args: any[]) => string);
+export type AxiosConfigOptionMappingType = keyof AxiosRequestConfig | ((...args: any[]) => (keyof AxiosRequestConfig));
+export type AbortControllerGenerator = ((...args: any[]) => (AbortController | AbortControllerAdapter));
+export type QueryStringEncodeFeatures = {
+    ignoreResidualParams?: boolean;
+    abortController?: (AbortController | AbortControllerAdapter) | AbortControllerGenerator;
+};
+export type RequestParamEncodeRule = {
+    body?: boolean;
+    required?: boolean;
+};
+export type NextAbortVersionAxiosRequestConfig = AxiosRequestConfig & {
+    signal: AbortSignal;
+};
+export declare const ConfigMapping: {
+    requestHeaders(rules: Record<string, HeaderMappingValueType>, args?: any[]): Record<string, string>;
+    axiosConfig<D = any>(options: AxiosConfigOptionMappingType[], args: any[]): AxiosRequestConfig<D>;
+    querystring(features: QueryStringEncodeFeatures | null, rules: Record<string, RequestParamEncodeRule>, data: Record<string, any>): string;
+    /**
+     * 从参数对象中提取 body 所属字段
+     * @param rules
+     * @param data
+     */
+    body(rules: Record<string, RequestParamEncodeRule>, data: Record<string, any>): any;
+};
+export default class Service {
+    _path: string;
+    _config: Config;
+    _headers: Record<string, Record<string, HeaderMappingValueType>>;
+    _params: Record<string, Record<string, RequestParamEncodeRule>>;
+    _configs: Record<string, AxiosConfigOptionMappingType[]>;
+    _for: Record<string, string>;
+    _features: Record<string, QueryStringEncodeFeatures>;
+    constructor(path?: any);
+    get config(): Config;
+    set config(value: Config);
+    get path(): string;
+    set path(value: string);
+    params(id: string, name: string, config?: RequestParamEncodeRule): void;
+    headers(id: string, header: string, value: HeaderMappingValueType): void;
+    for(id: string, registrationName?: string): string;
+    abort(id: string, abortController: (AbortController | AbortControllerAdapter | AbortControllerGenerator)): void;
+    features(id: string, options?: QueryStringEncodeFeatures): QueryStringEncodeFeatures;
+    configs(id: string, options: AxiosConfigOptionMappingType): void;
+    /**
+     * 填充路径占位符 <br/>
+     * override this method to custom placeholder replacement <br>
+     * default implement: data = { id: 111 }; <br/>
+     * "/path/{id}" -> return "/path/111"
+     * @param path
+     * @param data
+     */
+    pathVariable(path: string, data: Record<string, any>): string;
+    createRequestConfig(id: string, path: string, data: Record<string, any>, headerArgs?: any[], configArgs?: AxiosConfigOptionMappingType[]): {
+        path: string;
+        body: any;
+        config: AxiosRequestConfig<any>;
+        query: string;
+    };
+    request<T = any, R = AxiosResponse<T>, D = any>(method: string, path: string, data?: Record<string, any>, config?: AxiosRequestConfig<D>): Promise<R>;
+    requestWith<T = any, R = AxiosResponse<T>, D = any>(method: string, path?: string): {
+        with(registration: string): {
+            with(registration: string): any;
+            param: (key: string, required?: boolean) => any;
+            abort(abortController: ((AbortController & {
+                source: CancelTokenSource;
+            }) | AbortControllerGenerator)): any;
+            ignoreResidualParams(ignore?: boolean): any;
+            header: (header: string, value: HeaderMappingValueType) => any;
+            body: (key: string) => any;
+            config: (cfg: AxiosConfigOptionMappingType) => any;
+            send: (data?: Record<string, any>) => (Promise<R>);
+        };
+        param: (key: string, required?: boolean) => {
+            with(registration: string): any;
+            param: (key: string, required?: boolean) => any;
+            abort(abortController: ((AbortController & {
+                source: CancelTokenSource;
+            }) | AbortControllerGenerator)): any;
+            ignoreResidualParams(ignore?: boolean): any;
+            header: (header: string, value: HeaderMappingValueType) => any;
+            body: (key: string) => any;
+            config: (cfg: AxiosConfigOptionMappingType) => any;
+            send: (data?: Record<string, any>) => (Promise<R>);
+        };
+        abort(abortController: ((AbortController & {
+            source: CancelTokenSource;
+        }) | AbortControllerGenerator)): {
+            with(registration: string): any;
+            param: (key: string, required?: boolean) => any;
+            abort(abortController: ((AbortController & {
+                source: CancelTokenSource;
+            }) | AbortControllerGenerator)): any;
+            ignoreResidualParams(ignore?: boolean): any;
+            header: (header: string, value: HeaderMappingValueType) => any;
+            body: (key: string) => any;
+            config: (cfg: AxiosConfigOptionMappingType) => any;
+            send: (data?: Record<string, any>) => (Promise<R>);
+        };
+        ignoreResidualParams(ignore?: boolean): {
+            with(registration: string): any;
+            param: (key: string, required?: boolean) => any;
+            abort(abortController: ((AbortController & {
+                source: CancelTokenSource;
+            }) | AbortControllerGenerator)): any;
+            ignoreResidualParams(ignore?: boolean): any;
+            header: (header: string, value: HeaderMappingValueType) => any;
+            body: (key: string) => any;
+            config: (cfg: AxiosConfigOptionMappingType) => any;
+            send: (data?: Record<string, any>) => (Promise<R>);
+        };
+        header: (header: string, value: HeaderMappingValueType) => {
+            with(registration: string): any;
+            param: (key: string, required?: boolean) => any;
+            abort(abortController: ((AbortController & {
+                source: CancelTokenSource;
+            }) | AbortControllerGenerator)): any;
+            ignoreResidualParams(ignore?: boolean): any;
+            header: (header: string, value: HeaderMappingValueType) => any;
+            body: (key: string) => any;
+            config: (cfg: AxiosConfigOptionMappingType) => any;
+            send: (data?: Record<string, any>) => (Promise<R>);
+        };
+        body: (key: string) => {
+            with(registration: string): any;
+            param: (key: string, required?: boolean) => any;
+            abort(abortController: ((AbortController & {
+                source: CancelTokenSource;
+            }) | AbortControllerGenerator)): any;
+            ignoreResidualParams(ignore?: boolean): any;
+            header: (header: string, value: HeaderMappingValueType) => any;
+            body: (key: string) => any;
+            config: (cfg: AxiosConfigOptionMappingType) => any;
+            send: (data?: Record<string, any>) => (Promise<R>);
+        };
+        config: (cfg: AxiosConfigOptionMappingType) => {
+            with(registration: string): any;
+            param: (key: string, required?: boolean) => any;
+            abort(abortController: ((AbortController & {
+                source: CancelTokenSource;
+            }) | AbortControllerGenerator)): any;
+            ignoreResidualParams(ignore?: boolean): any;
+            header: (header: string, value: HeaderMappingValueType) => any;
+            body: (key: string) => any;
+            config: (cfg: AxiosConfigOptionMappingType) => any;
+            send: (data?: Record<string, any>) => (Promise<R>);
+        };
+        send: (data?: Record<string, any>) => (Promise<R>);
+    };
+}