axios-annotations 2.0.1 → 2.1.1

package/README.md

@@ -131,9 +131,9 @@ tsconfig.json / jsconfig.json
 ```javascript
 import {
   Service,
-  equestConfig,
-  equestParam,
-  equestMapping,
+  RequestConfig,
+  RequestParam,
+  RequestMapping,
   RequestBody,
   RequestHeader,
   IgnoreResidualParams
@@ -185,6 +185,49 @@ ApiCommon.test.get("a","b",null);
 
 如果不爽部分IDE的`non-promise inspection info`下划线，也可以给方法加上`async`。
 
+### 代码提示
+
+> Expect<ResponseType, PromiseType = AxiosPromise<ResponseType>>
+
+`Typescript`不支持装饰器修改方法返回值，但是可以绕开检查。<br/>
+
+Using a method decorator can not change the function return type.<br/>
+
+使用`Expect`绕过类型检查，获得代码提示功能。<br/>
+
+Using `Expect` to bypass type-checking and get code intelligence.
+
+```typescript
+import {Expect} from "axios-annotations";
+
+// ...
+
+export default class TestService extends Service {
+    @RequestBody()
+    @RequestMapping("/message", "POST")
+    @RequestHeader("Content-Type", "text/plain")
+    postMessage(message: string) {
+        return Expect<{
+            data: string;
+            success: boolean;
+        }>({
+            body: message
+        });
+    }
+}
+
+// call method, the return value can be deconstructed by IDE
+
+const res: AxiosResponse<{
+    data:string;
+    success:boolean;
+}> = await new TestService().postMessage("foo");
+
+console.log(res.data.data);
+```
+
+
+
 ### QueryString Encoding
 
 `key-values pair`转查询串算法，运行环境不支持`URLSearchParams`时使用默认算法，也可以自定义。

package/index.d.ts

@@ -1 +1 @@
-export { Config, config, URLSearchParamsParser, AbortControllerAdapter, AxiosStaticInstanceProvider, Service, AbortSource, DeleteMapping, GetMapping, IgnoreResidualParams, PatchMapping, PostMapping, PutMapping, RequestBody, RequestConfig, RequestHeader, RequestMapping, RequestParam, RequestWith } from "./lib/index";
+export { Config, config, URLSearchParamsParser, AbortControllerAdapter, AxiosStaticInstanceProvider, Service, AbortSource, DeleteMapping, GetMapping, IgnoreResidualParams, PatchMapping, PostMapping, PutMapping, RequestBody, RequestConfig, RequestHeader, RequestMapping, RequestParam, RequestWith, Expect } from "./lib/index";

package/index.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
-exports.RequestWith = exports.RequestParam = exports.RequestMapping = exports.RequestHeader = exports.RequestConfig = exports.RequestBody = exports.PutMapping = exports.PostMapping = exports.PatchMapping = exports.IgnoreResidualParams = exports.GetMapping = exports.DeleteMapping = exports.AbortSource = exports.Service = exports.AxiosStaticInstanceProvider = exports.AbortControllerAdapter = exports.URLSearchParamsParser = exports.config = exports.Config = void 0;
+exports.Expect = exports.RequestWith = exports.RequestParam = exports.RequestMapping = exports.RequestHeader = exports.RequestConfig = exports.RequestBody = exports.PutMapping = exports.PostMapping = exports.PatchMapping = exports.IgnoreResidualParams = exports.GetMapping = exports.DeleteMapping = exports.AbortSource = exports.Service = exports.AxiosStaticInstanceProvider = exports.AbortControllerAdapter = exports.URLSearchParamsParser = exports.config = exports.Config = void 0;
 var index_1 = require("./lib/index");
 Object.defineProperty(exports, "Config", {
     enumerable: true,
@@ -119,3 +119,9 @@ Object.defineProperty(exports, "RequestWith", {
         return index_1.RequestWith;
     }
 });
+Object.defineProperty(exports, "Expect", {
+    enumerable: true,
+    get: function get() {
+        return index_1.Expect;
+    }
+});

package/lib/core/config.d.ts

@@ -1,10 +1,10 @@
 import AxiosStaticInstanceProvider from "./provider";
-import type { AxiosInstance } from "axios";
-export type ConfigPlugin = (axios: AxiosInstance, config: Config) => void;
+import type { AxiosInstance, AxiosStatic } from "axios";
+export type ConfigPlugin<StaticType = AxiosStatic, InstanceType = AxiosInstance> = (axios: InstanceType, config: Config<StaticType, InstanceType>) => void;
 export type PartialConstructorString = string | null;
 export type PartialConstructorNumber = number | null;
-export type PartialPluginConstructorPlugins = ConfigPlugin[] | null;
-export default class Config {
+export type PartialPluginConstructorPlugins<StaticType = AxiosStatic, InstanceType = AxiosInstance> = ConfigPlugin<StaticType, InstanceType>[] | null;
+export default class Config<StaticType = AxiosStatic, InstanceType = AxiosInstance> {
     private _host;
     private _port;
     private _protocol;
@@ -17,11 +17,11 @@ export default class Config {
         host?: PartialConstructorString;
         port?: PartialConstructorNumber;
         prefix?: PartialConstructorString;
-        plugins?: PartialPluginConstructorPlugins;
-        axiosProvider?: AxiosStaticInstanceProvider;
+        plugins?: PartialPluginConstructorPlugins<StaticType, InstanceType>;
+        axiosProvider?: AxiosStaticInstanceProvider<StaticType>;
     });
     static forName(name: string): Config | null;
-    init(protocol: PartialConstructorString, host: PartialConstructorString, port: PartialConstructorNumber, prefix: PartialConstructorString, plugins: PartialPluginConstructorPlugins): void;
+    init(protocol: PartialConstructorString, host: PartialConstructorString, port: PartialConstructorNumber, prefix: PartialConstructorString, plugins: PartialPluginConstructorPlugins<StaticType, InstanceType>): void;
     get host(): string;
     set host(value: string);
     get port(): number;
@@ -40,21 +40,21 @@ export default class Config {
      * return "http://localhost:8080/a"
      */
     get baseURL(): string;
-    get plugins(): PartialPluginConstructorPlugins;
-    set plugins(value: PartialPluginConstructorPlugins);
-    get axiosProvider(): AxiosStaticInstanceProvider;
-    set axiosProvider(value: AxiosStaticInstanceProvider);
+    get plugins(): PartialPluginConstructorPlugins<StaticType, InstanceType>;
+    set plugins(value: PartialPluginConstructorPlugins<StaticType, InstanceType>);
+    get axiosProvider(): AxiosStaticInstanceProvider<StaticType>;
+    set axiosProvider(value: AxiosStaticInstanceProvider<StaticType>);
     /**
      * register config global and return self.
      * @param name
      * @return {Config} config self
      */
-    register(name: string): Config;
+    register(name: string): Config<StaticType, InstanceType>;
     /**
      * remove self from global config store.
      * @return {Config} - config self
      */
-    unregister(): Config;
-    requestAxiosInstance(): Promise<AxiosInstance>;
+    unregister(): Config<StaticType, InstanceType>;
+    requestAxiosInstance(): Promise<InstanceType>;
 }
-export declare const config: Config;
+export declare const config: Config<AxiosStatic, AxiosInstance>;

package/lib/core/expect.d.ts

@@ -0,0 +1,4 @@
+import type {AxiosPromise} from "axios";
+
+export default function Expect<T, D = AxiosPromise<T>>(params: any): D;
+export {};

package/lib/core/expect.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+exports["default"] = Expect;
+/**
+ * 警告 Warning: <br/>
+ * 仅用于仿冒使用装饰器的方法返回值，绕过IDE/Typescript的类型检查，获得代码提示功能。<br/>
+ *
+ * Only used to ensure the return value of a method that uses decorators,
+ * bypassing IDE/Typescript type checking and obtaining code intelligence.
+ */
+function Expect(params) {
+    return params;
+}

package/lib/core/provider.d.ts

@@ -1,6 +1,6 @@
 import type { AxiosStatic } from "axios";
-export default class AxiosStaticInstanceProvider {
-    __instance: AxiosStatic | null;
-    provide(): Promise<AxiosStatic>;
-    get(): Promise<AxiosStatic>;
+export default class AxiosStaticInstanceProvider<StaticType = AxiosStatic> {
+    __instance: StaticType | null;
+    provide(): Promise<StaticType>;
+    get(): Promise<StaticType>;
 }

package/lib/core/provider.js

@@ -152,6 +152,12 @@ var AxiosStaticInstanceProvider = /** @class */ function() {
             return __generator(this, function(_b) {
                 switch(_b.label){
                     case 0:
+                        if (this.__instance) {
+                            return [
+                                2 /*return*/ ,
+                                this.__instance
+                            ];
+                        }
                         _a = this;
                         return [
                             4 /*yield*/ ,

package/lib/index.d.ts

@@ -1,5 +1,6 @@
 export { default as Config } from "./core/config";
 export { config } from "./core/config";
+export { default as Expect } from "./core/expect";
 export { default as URLSearchParamsParser } from "./core/parser";
 export { default as Service } from "./core/service";
 export { default as AbortControllerAdapter } from "./core/cancel";

package/lib/index.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
-exports.RequestWith = exports.RequestParam = exports.RequestMapping = exports.RequestHeader = exports.RequestConfig = exports.RequestBody = exports.PutMapping = exports.PostMapping = exports.PatchMapping = exports.IgnoreResidualParams = exports.GetMapping = exports.DeleteMapping = exports.AbortSource = exports.AxiosStaticInstanceProvider = exports.AbortControllerAdapter = exports.Service = exports.URLSearchParamsParser = exports.config = exports.Config = void 0;
+exports.RequestWith = exports.RequestParam = exports.RequestMapping = exports.RequestHeader = exports.RequestConfig = exports.RequestBody = exports.PutMapping = exports.PostMapping = exports.PatchMapping = exports.IgnoreResidualParams = exports.GetMapping = exports.DeleteMapping = exports.AbortSource = exports.AxiosStaticInstanceProvider = exports.AbortControllerAdapter = exports.Service = exports.URLSearchParamsParser = exports.Expect = exports.config = exports.Config = void 0;
 var config_1 = require("./core/config");
 Object.defineProperty(exports, "Config", {
     enumerable: true,
@@ -18,6 +18,13 @@ Object.defineProperty(exports, "config", {
         return config_2.config;
     }
 });
+var expect_1 = require("./core/expect");
+Object.defineProperty(exports, "Expect", {
+    enumerable: true,
+    get: function get() {
+        return expect_1["default"];
+    }
+});
 var parser_1 = require("./core/parser");
 Object.defineProperty(exports, "URLSearchParamsParser", {
     enumerable: true,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "axios-annotations",
-  "version": "2.0.1",
+  "version": "2.1.1",
   "description": "HTTP client library uses Axios without Typescript.",
   "main": "index.js",
   "miniprogram": "lib",