axios-annotations 1.2.1 → 1.3.1

package/README.md

@@ -228,6 +228,114 @@ class AuthService extends Service {
 }
 ```
 
+## Abort
+注意：小程序端可能没有实现请求取消接口。
+### 静态注入
+
+```javascript
+const controller = new AbortController();
+// ...
+class AuthService extends Service {
+    // ...
+    @RequestConfig({
+      signal: controller.signal
+    })
+    bar() {
+        // ....
+        return {};
+    }
+}
+
+// 取消请求
+controller.abort()
+```
+
+或者：
+
+```javascript
+const controller = new AbortController();
+
+// ...
+class AuthService extends Service {
+  // ...
+  @AbortSource(controller) bar() {
+    // ....
+    return {};
+  }
+}
+
+new AuthService().bar().then(() => {
+
+}).catch(e => {
+  console.log(axios.isCancel(e));
+});
+
+// 取消请求
+controller.abort()
+```
+
+兼容旧版 `CancelToken` `(deprecated)`:
+```javascript
+const CancelToken = axios.CancelToken;
+
+const controller = new AbortControllerAdapter(CancelToken);
+
+// ...
+class AuthService extends Service {
+  // ...
+  @AbortSource(controller) bar() {
+    // ....
+    return {};
+  }
+}
+
+
+new AuthService().bar().then(() => {
+
+}).catch(e => {
+  console.log(axios.isCancel(e));
+});
+
+// 取消请求
+controller.abort("cancel test")
+```
+
+### 动态注入中断源
+不确定中断时机。
+```javascript
+// 自定义中断逻辑
+class AbortSourceManager {
+    // ...
+    
+    create () {
+        return AbortController();
+    }
+    
+    abortAll () {
+        // ...
+    }
+}
+
+const manager = new AbortSourceManager();
+
+// ...
+class AuthService extends Service {
+    // ...
+    @RequestConfig((...args)=>{
+        const controller = manager.create();
+        return {
+          // ...
+          signal: controller.signal
+        };
+    })
+    bar() {
+        // ....
+        return {};
+    }
+}
+```
+
+
 ## Plugin
 
 ### Custom Plugin
@@ -539,6 +647,10 @@ import {authorizer} from "/path/config.js";
 #### IgnoreResidualParams(ignore?)
 + ignore : boolean `拼接 QueryString 时是否忽略没有声明的参数`
 
+#### RequestConfig(config)
++ axiosConfig: Config - class decorator，注解类，传入框架配置对象，注意不是 AxiosConfig。
++ axiosConfig: AxiosConfig | (...args:any[]) => AxiosConfig - method decorator，注解方法，注解方法时可根据请求参数构造配置对象。
+
 ```javascript
 // GET /foo?p1=p1&p2=p2&p3=p3
 class TestService extends Service {

package/core/config.d.ts

@@ -0,0 +1,29 @@
+import {AxiosInstance} from "axios";
+
+export default class Config {
+    constructor(protocol?: string, host?: string, port?: number, prefix?: string, plugins?: ((config: Config) => void)[]);
+
+    static forName(name: string): Config;
+
+    host: string;
+
+    port: number | null | string;
+
+    protocol: string;
+
+    prefix: string;
+
+    origin: string;
+
+    baseURL: string;
+
+    axios: AxiosInstance;
+
+    plugins: ((config: Config) => void)[];
+
+    register(name: string): Config;
+
+    unregister(): Config;
+}
+
+export const config: Config;

package/core/parser.d.ts

@@ -0,0 +1,15 @@
+declare const URLSearchParamsParser: {
+    encode: (encoder: object) => string;
+
+    decode: (data: object) => object;
+
+    has: (encoder: object, key: string) => boolean;
+
+    delete: (encoder: object, key: string) => void;
+
+    get: (encoder: object, key: string) => any;
+
+    append: (encoder: object, key: string, value: any) => void;
+}
+
+export default URLSearchParamsParser;

package/core/service.d.ts

@@ -0,0 +1,33 @@
+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;
+}

package/decorator/abort-source.d.ts

@@ -0,0 +1,9 @@
+import {AxiosPromise, CancelToken} from "axios";
+
+export class AbortControllerAdapter {
+    constructor(CancelToken: CancelToken);
+
+    abort(reason?: string): void;
+}
+
+export default function AbortSource(abortController: (AbortController | AbortControllerAdapter) | ((...args: any[]) => (AbortController | AbortControllerAdapter))): (() => AxiosPromise<any>);

package/decorator/abort-source.js

@@ -0,0 +1 @@
+module.exports = require("../lib/decorator/abort-source");

package/decorator/delete-mapping.d.ts

@@ -0,0 +1,3 @@
+import {AxiosPromise} from "axios";
+
+export default function DeleteMapping(path?: string): (() => AxiosPromise<any>);

package/decorator/get-mapping.d.ts

@@ -0,0 +1,3 @@
+import {AxiosPromise} from "axios";
+
+export default function GetMapping(path?: string): (() => AxiosPromise<any>);

package/decorator/ignore-residual-params.d.ts

@@ -0,0 +1,3 @@
+import {AxiosPromise} from "axios";
+
+export default function IgnoreResidualParams(ignore?: boolean): (() => AxiosPromise<any>);

package/decorator/patch-mapping.d.ts

@@ -0,0 +1,3 @@
+import {AxiosPromise} from "axios";
+
+export default function PatchMapping(path?: string): (() => AxiosPromise<any>);

package/decorator/post-mapping.d.ts

@@ -0,0 +1,3 @@
+import {AxiosPromise} from "axios";
+
+export default function PostMapping(path?: string): (() => AxiosPromise<any>);

package/decorator/put-mapping.d.ts

@@ -0,0 +1,3 @@
+import {AxiosPromise} from "axios";
+
+export default function PutMapping(path?: string): (() => AxiosPromise<any>);

package/decorator/request-body.d.ts

@@ -0,0 +1,3 @@
+import {AxiosPromise} from "axios";
+
+export default function RequestBody(name?: string): (() => AxiosPromise<any>);

package/decorator/request-config.d.ts

@@ -0,0 +1,7 @@
+import {AxiosPromise, AxiosRequestConfig} from "axios";
+import Config from "../core/config";
+import Service from "../core/service";
+
+export default function RequestConfig(config: Config): (() => Service);
+
+export default function RequestConfig(config: ((...args: any[]) => Partial<AxiosRequestConfig>) | Partial<AxiosRequestConfig>): (() => AxiosPromise<any>);

package/decorator/request-header.d.ts

@@ -0,0 +1,5 @@
+import {AxiosPromise} from "axios";
+
+export default function RequestHeader(header: string, value: string): (() => AxiosPromise<any>);
+
+export default function RequestHeader(header: string, value: ((...args: any[]) => string)): (() => AxiosPromise<any>);

package/decorator/request-mapping.d.ts

@@ -0,0 +1,6 @@
+import {AxiosPromise} from "axios";
+import Service from "../core/service";
+
+export default function RequestMapping(path: string, method: string): (() => AxiosPromise<any>);
+
+export default function RequestMapping(path: string): (() => Service);

package/decorator/request-param.d.ts

@@ -0,0 +1,3 @@
+import {AxiosPromise} from "axios";
+
+export default function RequestParam(name: string, required?: boolean): (() => AxiosPromise<any>);

package/decorator/request-with.d.ts

@@ -0,0 +1,3 @@
+import {AxiosPromise} from "axios";
+
+export default function RequestWith(registration: string): (() => AxiosPromise<any>);

package/lib/core/service.d.ts

@@ -1,5 +1,6 @@
 import Config from "./config";
 import {AxiosPromise, AxiosRequestConfig} from "axios";
+import {AbortControllerAdapter} from "../decorator/abort-source";
 
 export interface RequestController {
     ignoreResidualParams: (ignore?: boolean) => RequestController;
@@ -15,6 +16,8 @@ export interface 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 {
@@ -27,4 +30,4 @@ export default class Service {
     request(method: string, path: string, data?: any, config?: Partial<AxiosRequestConfig>): AxiosPromise<any>;
 
     requestWith(method: string, path?: string): RequestController;
-}
+}

package/lib/core/service.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.default=exports.ConfigMapping=void 0;var _common=require("./common"),_parser=_interopRequireDefault(require("./parser")),_config=_interopRequireWildcard(require("./config"));function _getRequireWildcardCache(e){var t,r;return"function"!=typeof WeakMap?null:(t=new WeakMap,r=new WeakMap,(_getRequireWildcardCache=function(e){return e?r:t})(e))}function _interopRequireWildcard(e,t){if(!t&&e&&e.__esModule)return e;if(null===e||"object"!==_typeof(e)&&"function"!=typeof e)return{default:e};t=_getRequireWildcardCache(t);if(t&&t.has(e))return t.get(e);var r,n,i={},o=Object.defineProperty&&Object.getOwnPropertyDescriptor;for(r in e)"default"!==r&&Object.prototype.hasOwnProperty.call(e,r)&&((n=o?Object.getOwnPropertyDescriptor(e,r):null)&&(n.get||n.set)?Object.defineProperty(i,r,n):i[r]=e[r]);return i.default=e,t&&t.set(e,i),i}function _interopRequireDefault(e){return e&&e.__esModule?e:{default:e}}function _typeof(e){return(_typeof="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e})(e)}function _createForOfIteratorHelper(e,t){var r,n,i,o,a="undefined"!=typeof Symbol&&e[Symbol.iterator]||e["@@iterator"];if(a)return n=!(r=!0),{s:function(){a=a.call(e)},n:function(){var e=a.next();return r=e.done,e},e:function(e){n=!0,i=e},f:function(){try{r||null==a.return||a.return()}finally{if(n)throw i}}};if(Array.isArray(e)||(a=_unsupportedIterableToArray(e))||t&&e&&"number"==typeof e.length)return a&&(e=a),o=0,{s:t=function(){},n:function(){return o>=e.length?{done:!0}:{done:!1,value:e[o++]}},e:function(e){throw e},f:t};throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}function _unsupportedIterableToArray(e,t){var r;if(e)return"string"==typeof e?_arrayLikeToArray(e,t):"Map"===(r="Object"===(r=Object.prototype.toString.call(e).slice(8,-1))&&e.constructor?e.constructor.name:r)||"Set"===r?Array.from(e):"Arguments"===r||/^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(r)?_arrayLikeToArray(e,t):void 0}function _arrayLikeToArray(e,t){(null==t||t>e.length)&&(t=e.length);for(var r=0,n=new Array(t);r<t;r++)n[r]=e[r];return n}function _classCallCheck(e,t){if(!(e instanceof t))throw new TypeError("Cannot call a class as a function")}function _defineProperties(e,t){for(var r=0;r<t.length;r++){var n=t[r];n.enumerable=n.enumerable||!1,n.configurable=!0,"value"in n&&(n.writable=!0),Object.defineProperty(e,_toPropertyKey(n.key),n)}}function _createClass(e,t,r){return t&&_defineProperties(e.prototype,t),r&&_defineProperties(e,r),Object.defineProperty(e,"prototype",{writable:!1}),e}function _defineProperty(e,t,r){return(t=_toPropertyKey(t))in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function _toPropertyKey(e){e=_toPrimitive(e,"string");return"symbol"===_typeof(e)?e:String(e)}function _toPrimitive(e,t){if("object"!==_typeof(e)||null===e)return e;var r=e[Symbol.toPrimitive];if(void 0===r)return("string"===t?String:Number)(e);r=r.call(e,t||"default");if("object"!==_typeof(r))return r;throw new TypeError("@@toPrimitive must return a primitive value.")}var ConfigMapping={requestHeaders:function(e){var t=1<arguments.length&&void 0!==arguments[1]?arguments[1]:[],r={};if(e)for(var n in e){var i=e[n];r[n]="function"==typeof i?i.apply(void 0,t):i}return r},axiosConfig:function(e,t){var r={};return(e||[]).forEach(function(e){"function"==typeof e?Object.assign(r,e.apply(void 0,t)):Object.assign(r,e)}),r},querystring:function(e,t,r){if(!r)return"";var n;if(t){var i,o,a=_parser.default.decode(r);for(i in r){var s=r[i],f=t[i];f?f.body?_parser.default.delete(a,i):f.required?(0,_common.isNullOrEmpty)(s)&&!_parser.default.has(a,i)&&_parser.default.append(a,i,""):(0,_common.isNullOrEmpty)(s)&&_parser.default.has(a,i)&&_parser.default.delete(a,i):e&&!0===e.ignoreResidualParams&&_parser.default.delete(a,i)}for(o in t){var u=t[o];u&&!u.body&&u.required&&!_parser.default.has(a,o)&&_parser.default.append(a,o,"")}return _parser.default.encode(a)}return e&&!0===e.ignoreResidualParams?"":(n=_parser.default.decode(r),_parser.default.encode(n))},body:function(e,t){if(e)for(var r in e)if(!0===e[r].body)return(0,_common.isNullOrEmpty)(t)?void 0:t[r];return null}},Service=(exports.ConfigMapping=ConfigMapping,function(){function n(){var e=0<arguments.length&&void 0!==arguments[0]?arguments[0]:null;if(_classCallCheck(this,n),_defineProperty(this,"_path",""),_defineProperty(this,"_config",_config.config),_defineProperty(this,"_headers",{}),_defineProperty(this,"_params",{}),_defineProperty(this,"_configs",{}),_defineProperty(this,"_for",{}),_defineProperty(this,"_features",{}),!this._path&&e&&(this._path=e),"function"==typeof Object.getPrototypeOf?(Object.getPrototypeOf(this)._path&&(this._path=Object.getPrototypeOf(this)._path),Object.getPrototypeOf(this)._config&&(this._config=Object.getPrototypeOf(this)._config)):(this.__proto__._path&&(this._path=this.__proto__._path),this.__proto__._config&&(this._config=this.__proto__._config)),this.config&&this.config.plugins&&this.config.plugins.length){var t,r=_createForOfIteratorHelper(this.config.plugins);try{for(r.s();!(t=r.n()).done;)(0,t.value)(this.config)}catch(e){r.e(e)}finally{r.f()}}}return _createClass(n,[{key:"config",get:function(){return this._config},set:function(e){this._config=e}},{key:"path",get:function(){return this._path},set:function(e){this._path=e}},{key:"params",value:function(e,t){var r=2<arguments.length&&void 0!==arguments[2]?arguments[2]:{required:!1};if(!this._params||!this._params[e]||!Object.hasOwnProperty.call(this._params[e],t)){var r=Object.assign({required:!1,body:!1},r),n=this._params||{},i=this._params&&this._params[e]||{},o=i[t]||{};if(!0===r.body)for(var a in i)i[a].body=!1;this._params=Object.assign(n,_defineProperty({},e,Object.assign(i,_defineProperty({},t,Object.assign(o,r)))))}}},{key:"headers",value:function(e,t,r){var n=this._headers||{};Object.assign(n,_defineProperty({},e,Object.assign(n[e]||{},_defineProperty({},t,r))))}},{key:"for",value:function(e,t){if(1===arguments.length)return this._for[e];Object.assign(this._for,_defineProperty({},e,t))}},{key:"features",value:function(e,t){if(1===arguments.length)return this._features[e];Object.assign(this._features,_defineProperty({},e,t))}},{key:"configs",value:function(e,t){var r=this._configs||{};Object.assign(r,_defineProperty({},e,(r[e]||[]).concat(t)))}},{key:"pathVariable",value:function(e,t){var r=e||"",e=r.match(/{\w+}/g);return Array.isArray(e)&&e.forEach(function(e){e=e.substring(1,e.length-1);r=r.replaceAll("{".concat(e,"}"),t[e])}),r}},{key:"createRequestConfig",value:function(e,t,r){var n=3<arguments.length&&void 0!==arguments[3]?arguments[3]:[],i=4<arguments.length&&void 0!==arguments[4]?arguments[4]:[],o=ConfigMapping.querystring(this._features[e],this._params[e],r),r=ConfigMapping.body(this._params[e],r),n=ConfigMapping.requestHeaders(this._headers[e],n),e=ConfigMapping.axiosConfig(this._configs[e],i),i="".concat(t).concat(o?(0<=t.lastIndexOf("?")?"&":"?")+o:"");return Object.assign(e,{headers:Object.assign(n,e.headers||null)}),{path:i,body:r,config:e,query:o}}},{key:"request",value:function(e,t){var r=2<arguments.length&&void 0!==arguments[2]?arguments[2]:{},n=3<arguments.length&&void 0!==arguments[3]?arguments[3]:{},t=0<=t.indexOf("http")?t:this.config.baseURL+(0,_common.normalizePath)("/".concat(this.path||"","/").concat(t));return this.config.axios.request(Object.assign({method:e,url:t,data:r},n))}},{key:"requestWith",value:function(o){var a=this,s=1<arguments.length&&void 0!==arguments[1]?arguments[1]:"",f={},u=[],c={},p={},l=this.config,n={with:function(e){e=_config.default.forName(e);return e&&(l=e),n},param:function(e){return Object.assign(f,_defineProperty({},e,Object.assign(f[e]||{},{required:1<arguments.length&&void 0!==arguments[1]&&arguments[1],body:!1}))),n},ignoreResidualParams:function(){return Object.assign(p,{ignoreResidualParams:!0===(!(0<arguments.length&&void 0!==arguments[0])||arguments[0])}),n},header:function(e,t){return Object.assign(c,_defineProperty({},e,t)),n},body:function(e){var t,r=f[e]||{};for(t in f)f[t].body=!1;return Object.assign(f,_defineProperty({},e,Object.assign(r,{required:!1,body:!0}))),n},config:function(e){return u.push(e),n},send:function(){var e=0<arguments.length&&void 0!==arguments[0]?arguments[0]:{},t=ConfigMapping.querystring(p,f,e),r=ConfigMapping.body(f,e),n=ConfigMapping.requestHeaders(c,[e]),i=ConfigMapping.axiosConfig(u,[e]);return Object.assign(i,{headers:Object.assign(n,i.headers||null)}),l?(0,_common.forward)(l.axios,l.origin,l.prefix,a.path,s,o,t,r,i):(n="".concat(a.pathVariable(s||"",e)).concat(t?(0<=s.lastIndexOf("?")?"&":"?")+t:""),a.request(o,n,r,i))}};return n}}]),n}());exports.default=Service;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.default=exports.ConfigMapping=void 0;var _common=require("./common"),_parser=_interopRequireDefault(require("./parser")),_config=_interopRequireWildcard(require("./config"));function _getRequireWildcardCache(e){var t,r;return"function"!=typeof WeakMap?null:(t=new WeakMap,r=new WeakMap,(_getRequireWildcardCache=function(e){return e?r:t})(e))}function _interopRequireWildcard(e,t){if(!t&&e&&e.__esModule)return e;if(null===e||"object"!==_typeof(e)&&"function"!=typeof e)return{default:e};t=_getRequireWildcardCache(t);if(t&&t.has(e))return t.get(e);var r,n,i={},o=Object.defineProperty&&Object.getOwnPropertyDescriptor;for(r in e)"default"!==r&&Object.prototype.hasOwnProperty.call(e,r)&&((n=o?Object.getOwnPropertyDescriptor(e,r):null)&&(n.get||n.set)?Object.defineProperty(i,r,n):i[r]=e[r]);return i.default=e,t&&t.set(e,i),i}function _interopRequireDefault(e){return e&&e.__esModule?e:{default:e}}function _typeof(e){return(_typeof="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e})(e)}function _createForOfIteratorHelper(e,t){var r,n,i,o,a="undefined"!=typeof Symbol&&e[Symbol.iterator]||e["@@iterator"];if(a)return n=!(r=!0),{s:function(){a=a.call(e)},n:function(){var e=a.next();return r=e.done,e},e:function(e){n=!0,i=e},f:function(){try{r||null==a.return||a.return()}finally{if(n)throw i}}};if(Array.isArray(e)||(a=_unsupportedIterableToArray(e))||t&&e&&"number"==typeof e.length)return a&&(e=a),o=0,{s:t=function(){},n:function(){return o>=e.length?{done:!0}:{done:!1,value:e[o++]}},e:function(e){throw e},f:t};throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}function _unsupportedIterableToArray(e,t){var r;if(e)return"string"==typeof e?_arrayLikeToArray(e,t):"Map"===(r="Object"===(r=Object.prototype.toString.call(e).slice(8,-1))&&e.constructor?e.constructor.name:r)||"Set"===r?Array.from(e):"Arguments"===r||/^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(r)?_arrayLikeToArray(e,t):void 0}function _arrayLikeToArray(e,t){(null==t||t>e.length)&&(t=e.length);for(var r=0,n=new Array(t);r<t;r++)n[r]=e[r];return n}function _classCallCheck(e,t){if(!(e instanceof t))throw new TypeError("Cannot call a class as a function")}function _defineProperties(e,t){for(var r=0;r<t.length;r++){var n=t[r];n.enumerable=n.enumerable||!1,n.configurable=!0,"value"in n&&(n.writable=!0),Object.defineProperty(e,_toPropertyKey(n.key),n)}}function _createClass(e,t,r){return t&&_defineProperties(e.prototype,t),r&&_defineProperties(e,r),Object.defineProperty(e,"prototype",{writable:!1}),e}function _defineProperty(e,t,r){return(t=_toPropertyKey(t))in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function _toPropertyKey(e){e=_toPrimitive(e,"string");return"symbol"===_typeof(e)?e:String(e)}function _toPrimitive(e,t){if("object"!==_typeof(e)||null===e)return e;var r=e[Symbol.toPrimitive];if(void 0===r)return("string"===t?String:Number)(e);r=r.call(e,t||"default");if("object"!==_typeof(r))return r;throw new TypeError("@@toPrimitive must return a primitive value.")}var ConfigMapping={requestHeaders:function(e){var t=1<arguments.length&&void 0!==arguments[1]?arguments[1]:[],r={};if(e)for(var n in e){var i=e[n];r[n]="function"==typeof i?i.apply(void 0,t):i}return r},axiosConfig:function(e,t){var r={};return(e||[]).forEach(function(e){"function"==typeof e?Object.assign(r,e.apply(void 0,t)):Object.assign(r,e)}),r},querystring:function(e,t,r){if(!r)return"";var n;if(t){var i,o,a=_parser.default.decode(r);for(i in r){var s=r[i],f=t[i];f?f.body?_parser.default.delete(a,i):f.required?(0,_common.isNullOrEmpty)(s)&&!_parser.default.has(a,i)&&_parser.default.append(a,i,""):(0,_common.isNullOrEmpty)(s)&&_parser.default.has(a,i)&&_parser.default.delete(a,i):e&&!0===e.ignoreResidualParams&&_parser.default.delete(a,i)}for(o in t){var u=t[o];u&&!u.body&&u.required&&!_parser.default.has(a,o)&&_parser.default.append(a,o,"")}return _parser.default.encode(a)}return e&&!0===e.ignoreResidualParams?"":(n=_parser.default.decode(r),_parser.default.encode(n))},body:function(e,t){if(e)for(var r in e)if(!0===e[r].body)return(0,_common.isNullOrEmpty)(t)?void 0:t[r];return null}},Service=(exports.ConfigMapping=ConfigMapping,function(){function n(){var e=0<arguments.length&&void 0!==arguments[0]?arguments[0]:null;if(_classCallCheck(this,n),_defineProperty(this,"_path",""),_defineProperty(this,"_config",_config.config),_defineProperty(this,"_headers",{}),_defineProperty(this,"_params",{}),_defineProperty(this,"_configs",{}),_defineProperty(this,"_for",{}),_defineProperty(this,"_features",{}),!this._path&&e&&(this._path=e),"function"==typeof Object.getPrototypeOf?(Object.getPrototypeOf(this)._path&&(this._path=Object.getPrototypeOf(this)._path),Object.getPrototypeOf(this)._config&&(this._config=Object.getPrototypeOf(this)._config)):(this.__proto__._path&&(this._path=this.__proto__._path),this.__proto__._config&&(this._config=this.__proto__._config)),this.config&&this.config.plugins&&this.config.plugins.length){var t,r=_createForOfIteratorHelper(this.config.plugins);try{for(r.s();!(t=r.n()).done;)(0,t.value)(this.config)}catch(e){r.e(e)}finally{r.f()}}}return _createClass(n,[{key:"config",get:function(){return this._config},set:function(e){this._config=e}},{key:"path",get:function(){return this._path},set:function(e){this._path=e}},{key:"params",value:function(e,t){var r=2<arguments.length&&void 0!==arguments[2]?arguments[2]:{required:!1};if(!this._params||!this._params[e]||!Object.hasOwnProperty.call(this._params[e],t)){var r=Object.assign({required:!1,body:!1},r),n=this._params||{},i=this._params&&this._params[e]||{},o=i[t]||{};if(!0===r.body)for(var a in i)i[a].body=!1;this._params=Object.assign(n,_defineProperty({},e,Object.assign(i,_defineProperty({},t,Object.assign(o,r)))))}}},{key:"headers",value:function(e,t,r){var n=this._headers||{};Object.assign(n,_defineProperty({},e,Object.assign(n[e]||{},_defineProperty({},t,r))))}},{key:"for",value:function(e,t){if(1===arguments.length)return this._for[e];Object.assign(this._for,_defineProperty({},e,t))}},{key:"abort",value:function(e,t){t=Object.assign(this.features(e)||{},{abortController:t});this.features(e,t)}},{key:"features",value:function(e,t){if(1===arguments.length)return this._features[e];Object.assign(this._features,_defineProperty({},e,t))}},{key:"configs",value:function(e,t){var r=this._configs||{};Object.assign(r,_defineProperty({},e,(r[e]||[]).concat(t)))}},{key:"pathVariable",value:function(e,t){var r=e||"",e=r.match(/{\w+}/g);return Array.isArray(e)&&e.forEach(function(e){e=e.substring(1,e.length-1);r=r.replaceAll("{".concat(e,"}"),t[e])}),r}},{key:"createRequestConfig",value:function(e,t,r){var n=3<arguments.length&&void 0!==arguments[3]?arguments[3]:[],i=4<arguments.length&&void 0!==arguments[4]?arguments[4]:[],o=ConfigMapping.querystring(this._features[e],this._params[e],r),r=ConfigMapping.body(this._params[e],r),n=ConfigMapping.requestHeaders(this._headers[e],n),a=ConfigMapping.axiosConfig(this._configs[e],i),t="".concat(t).concat(o?(0<=t.lastIndexOf("?")?"&":"?")+o:"");return this._features&&this._features[e]&&this._features[e].abortController&&(i="function"==typeof(e=this._features[e].abortController)?e.apply(void 0,i):e)&&(i.source?a.cancelToken=i.source.token:a.signal=i.signal),Object.assign(a,{headers:Object.assign(n,a.headers||null)}),{path:t,body:r,config:a,query:o}}},{key:"request",value:function(e,t){var r=2<arguments.length&&void 0!==arguments[2]?arguments[2]:{},n=3<arguments.length&&void 0!==arguments[3]?arguments[3]:{},t=0<=t.indexOf("http")?t:this.config.baseURL+(0,_common.normalizePath)("/".concat(this.path||"","/").concat(t));return this.config.axios.request(Object.assign({method:e,url:t,data:r},n))}},{key:"requestWith",value:function(a){var s=this,f=1<arguments.length&&void 0!==arguments[1]?arguments[1]:"",u={},c=[],p={},l={},d=this.config,n={with:function(e){e=_config.default.forName(e);return e&&(d=e),n},param:function(e){return Object.assign(u,_defineProperty({},e,Object.assign(u[e]||{},{required:1<arguments.length&&void 0!==arguments[1]&&arguments[1],body:!1}))),n},abort:function(e){return Object.assign(l,{abortController:e}),n},ignoreResidualParams:function(){return Object.assign(l,{ignoreResidualParams:!0===(!(0<arguments.length&&void 0!==arguments[0])||arguments[0])}),n},header:function(e,t){return Object.assign(p,_defineProperty({},e,t)),n},body:function(e){var t,r=u[e]||{};for(t in u)u[t].body=!1;return Object.assign(u,_defineProperty({},e,Object.assign(r,{required:!1,body:!0}))),n},config:function(e){return c.push(e),n},send:function(){var e=0<arguments.length&&void 0!==arguments[0]?arguments[0]:{},t=ConfigMapping.querystring(l,u,e),r=ConfigMapping.body(u,e),n=ConfigMapping.requestHeaders(p,[e]),i=ConfigMapping.axiosConfig(c,[e]),o=l.abortController;return Object.assign(i,{headers:Object.assign(n,i.headers||null)}),o&&(n="function"==typeof o?o.apply(void 0,[e]):o)&&(n.source?i.cancelToken=n.source.token:i.signal=n.signal),d?(0,_common.forward)(d.axios,d.origin,d.prefix,s.path,f,a,t,r,i):(o="".concat(s.pathVariable(f||"",e)).concat(t?(0<=f.lastIndexOf("?")?"&":"?")+t:""),s.request(a,o,r,i))}};return n}}]),n}());exports.default=Service;

package/lib/decorator/abort-source.d.ts

@@ -0,0 +1,9 @@
+import {AxiosPromise, CancelToken} from "axios";
+
+export class AbortControllerAdapter {
+    constructor(CancelToken: CancelToken);
+
+    abort(reason?: string): void;
+}
+
+export default function AbortSource(abortController: (AbortController | AbortControllerAdapter) | ((...args: any[]) => (AbortController | AbortControllerAdapter))): (() => AxiosPromise<any>);

package/lib/decorator/abort-source.js

@@ -0,0 +1 @@
+"use strict";function _typeof(e){return(_typeof="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e})(e)}function _classCallCheck(e,t){if(!(e instanceof t))throw new TypeError("Cannot call a class as a function")}function _defineProperties(e,t){for(var r=0;r<t.length;r++){var o=t[r];o.enumerable=o.enumerable||!1,o.configurable=!0,"value"in o&&(o.writable=!0),Object.defineProperty(e,_toPropertyKey(o.key),o)}}function _createClass(e,t,r){return t&&_defineProperties(e.prototype,t),r&&_defineProperties(e,r),Object.defineProperty(e,"prototype",{writable:!1}),e}function _defineProperty(e,t,r){return(t=_toPropertyKey(t))in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function _toPropertyKey(e){e=_toPrimitive(e,"string");return"symbol"===_typeof(e)?e:String(e)}function _toPrimitive(e,t){if("object"!==_typeof(e)||null===e)return e;var r=e[Symbol.toPrimitive];if(void 0===r)return("string"===t?String:Number)(e);r=r.call(e,t||"default");if("object"!==_typeof(r))return r;throw new TypeError("@@toPrimitive must return a primitive value.")}Object.defineProperty(exports,"__esModule",{value:!0}),exports.AbortControllerAdapter=void 0,exports.default=_default;var AbortControllerAdapter=function(){function t(e){_classCallCheck(this,t),_defineProperty(this,"_source",null),this._source=e.source()}return _createClass(t,[{key:"signal",get:function(){return{reason:this._source.token&&this._source.token.reason&&this._source.token.reason.message||"",aborted:!(!this._source.token||!this._source.token.reason)&&"ERR_CANCELED"===this._source.token.reason.code}}},{key:"source",get:function(){return this._source}},{key:"abort",value:function(){var e=0<arguments.length&&void 0!==arguments[0]?arguments[0]:"";e?this._source.cancel(e):this._source.cancel()}}]),t}();function _default(u){return function(e,n,t){var i;t&&(i=t.value,t.value=function(){for(var e=arguments.length,t=new Array(e),r=0;r<e;r++)t[r]=arguments[r];var o=u;return"function"==typeof u&&(o=u.apply(void 0,t)),this.abort(n,o),i.apply(this,arguments)})}}exports.AbortControllerAdapter=AbortControllerAdapter;

package/lib/decorator/request-config.d.ts

@@ -4,4 +4,4 @@ import Service from "../core/service";
 
 export default function RequestConfig(config: Config): (() => Service);
 
-export default function RequestConfig(config: Partial<AxiosRequestConfig>): (() => AxiosPromise<any>);
+export default function RequestConfig(config: ((...args: any[]) => Partial<AxiosRequestConfig>) | Partial<AxiosRequestConfig>): (() => AxiosPromise<any>);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "axios-annotations",
-  "version": "1.2.1",
+  "version": "1.3.1",
   "repository": {
     "type": "git",
     "url": "git+ssh://git@github.com/sitorhy/axios-annotations.git"

package/plugins/auth/authorizer.d.ts

@@ -0,0 +1,49 @@
+import {AxiosError, AxiosPromise, AxiosRequestConfig} from "axios";
+import SessionStorage from "./storage";
+import SessionHistory from "./history";
+
+export interface Session {
+    access_token?: string;
+
+    refresh_token?: string;
+
+    token?: string;
+
+    accessToken?: string;
+
+    refreshToken?: string;
+
+    expires_in?: number;
+
+    expiresIn?: number;
+
+    scope?: string;
+
+    token_type?: string;
+}
+
+export default class Authorizer {
+    sessionKey: string;
+
+    sessionStorage: SessionStorage;
+
+    sessionHistory: SessionHistory;
+
+    getSession(): Promise<Partial<Session>>;
+
+    storageSession(session: Session): Promise<void>;
+
+    refreshSession(session: Session): Promise<Partial<Session>> | Promise<Record<string, any>> | Promise<any>;
+
+    withAuthentication(request: AxiosRequestConfig, session: Partial<Session>): void;
+
+    checkSession(request: AxiosRequestConfig, session: Partial<Session>): boolean;
+
+    checkResponse(response: Response): boolean;
+
+    onAuthorizedDenied(error: AxiosError): Promise<void>;
+
+    onSessionInvalidated(): void;
+
+    invalidateSession(): Promise<void>;
+}

package/plugins/auth/history.d.ts

@@ -0,0 +1,15 @@
+import {Session} from "./authorizer";
+
+export default class SessionHistory {
+    add(session: Session): void;
+
+    check(jwt: string): boolean;
+
+    deprecate(session: Session): void;
+
+    clean(): void;
+
+    isDeprecated(session: Session): boolean;
+
+    size: number;
+}

package/plugins/auth/index.d.ts

@@ -0,0 +1,4 @@
+import Authorizer from "./authorizer";
+import Config from "../../core/config";
+
+export default function AuthorizationPlugin(authorizer: Authorizer): (config: Config) => void;

package/plugins/auth/queue.d.ts

@@ -0,0 +1,16 @@
+import {AxiosError, AxiosPromise} from "axios";
+import Authorizer from "./authorizer";
+
+export default class PendingQueue {
+    constructor(authorizer: Authorizer);
+
+    resend(error: AxiosError, retries?: number): AxiosPromise<any>;
+
+    push(error: AxiosError): AxiosPromise<any>;
+
+    pop(): void;
+
+    clear(): void;
+
+    size: number;
+}

package/plugins/auth/storage.d.ts

@@ -0,0 +1,7 @@
+export default class SessionStorage {
+    set(key: string, value: any): Promise<void>;
+
+    get(key: string): Promise<any>;
+
+    remove(key: string): Promise<void>;
+}