axios-annotations 2.3.0 → 3.0.0

package/lib/plugins/auth/index.js

@@ -1,5 +1,5 @@
 "use strict";
-var __awaiter = this && this.__awaiter || function(thisArg, _arguments, P, generator) {
+var __awaiter = (void 0) && (void 0).__awaiter || function(thisArg, _arguments, P, generator) {
     function adopt(value) {
         return value instanceof P ? value : new P(function(resolve) {
             resolve(value);
@@ -26,7 +26,7 @@ var __awaiter = this && this.__awaiter || function(thisArg, _arguments, P, gener
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-var __generator = this && this.__generator || function(thisArg, body) {
+var __generator = (void 0) && (void 0).__generator || function(thisArg, body) {
     var _ = {
         label: 0,
         sent: function sent() {
@@ -142,10 +142,10 @@ function AuthorizationPlugin(authorizer, options) {
         var unauthorized = false;
         var expiredSession = null;
         var queue = new queue_1["default"](authorizer, config, (options === null || options === void 0 ? void 0 : options.minTryRetryInterval) || 3000, (options === null || options === void 0 ? void 0 : options.maxTryRetryInterval) || 5000, (options === null || options === void 0 ? void 0 : options.retryTimes) || 3);
-        new queue_1["default"](authorizer, config, (options === null || options === void 0 ? void 0 : options.minTryRetryInterval) || 3000, (options === null || options === void 0 ? void 0 : options.maxTryRetryInterval) || 5000, (options === null || options === void 0 ? void 0 : options.retryTimes) || 3);
         axios.interceptors.response.use(function(i) {
             if (expiredSession) {
                 // Previously requests sent have been rejected, record and release it (will be resending)
+                // 会话过期加入过期队列，但未确认 refreshToken 是否失效
                 authorizer.sessionHistory.add(expiredSession);
                 expiredSession = null;
             }
@@ -202,6 +202,7 @@ function AuthorizationPlugin(authorizer, options) {
                             throw e;
                         case 5:
                             unauthorized = false;
+                            // 全部 reject 掉, 即抛出原始异常
                             queue.clear();
                             return [
                                 7 /*endfinally*/ 
@@ -229,6 +230,7 @@ function AuthorizationPlugin(authorizer, options) {
                             // waiting for next accessToken refresh, on the server side, updates are synchronized.
                             // Note:
                             // even if the refreshing request send few times, the server side will only return the same token.
+                            // 翻译：有效期内多次的刷新请求服务端应该保持 accessToken 不变，客户端不需要线程同步
                             return [
                                 4 /*yield*/ ,
                                 _b.apply(_a, [
@@ -239,6 +241,7 @@ function AuthorizationPlugin(authorizer, options) {
                             // waiting for next accessToken refresh, on the server side, updates are synchronized.
                             // Note:
                             // even if the refreshing request send few times, the server side will only return the same token.
+                            // 翻译：有效期内多次的刷新请求服务端应该保持 accessToken 不变，客户端不需要线程同步
                             _c.sent();
                             return [
                                 3 /*break*/ ,
@@ -247,6 +250,8 @@ function AuthorizationPlugin(authorizer, options) {
                         case 10:
                             e2_1 = _c.sent();
                             // invalid refresh_token
+                            // 此处触发一般就是 refreshSession 刷新返回 401 / 500 等，非标准返回值需要自行抛出异常
+                            // 作废会话，一般就是 refreshToken 失效
                             authorizer.sessionHistory.deprecate(session);
                             _c.label = 11;
                         case 11:
@@ -273,6 +278,7 @@ function AuthorizationPlugin(authorizer, options) {
                         case 14:
                             unauthorized = false;
                             // cancel all requests resending.
+                            // clear 就是 全部 reject 掉
                             queue.clear();
                             return [
                                 7 /*endfinally*/ 
@@ -285,6 +291,7 @@ function AuthorizationPlugin(authorizer, options) {
                         case 16:
                             unauthorized = false;
                             // the accessToken refreshed, send the request itself and startup resending queue cleaning.
+                            // 清空 else 分支积压的请求（重发）
                             (function() {
                                 while(queue.size){
                                     queue.pop();
@@ -303,6 +310,7 @@ function AuthorizationPlugin(authorizer, options) {
                                 queue.resend(e)
                             ];
                         case 18:
+                            // 重发当前请求，当前请求没有压入队列需要单独处理
                             return [
                                 2 /*return*/ ,
                                 _c.sent()

package/lib/plugins/auth/queue.d.ts

@@ -1,6 +1,6 @@
-import type { AxiosError } from "axios";
+import type { AxiosInstance, AxiosError } from 'axios';
 import Authorizer from "./authorizer";
-import { Config } from "../../index";
+import Config from "../../core/config";
 export default class PendingQueue {
     _queue: {
         error: AxiosError;
@@ -12,6 +12,7 @@ export default class PendingQueue {
     _minTryRetryInterval: number;
     _maxTryRetryInterval: number;
     _retryTimes: number;
+    _resendAxiosInstance: AxiosInstance | null;
     /**
      * @param {Authorizer} authorizer
      * @param {Config} config

package/lib/plugins/auth/queue.js

@@ -1,5 +1,5 @@
 "use strict";
-var __awaiter = this && this.__awaiter || function(thisArg, _arguments, P, generator) {
+var __awaiter = (void 0) && (void 0).__awaiter || function(thisArg, _arguments, P, generator) {
     function adopt(value) {
         return value instanceof P ? value : new P(function(resolve) {
             resolve(value);
@@ -26,7 +26,7 @@ var __awaiter = this && this.__awaiter || function(thisArg, _arguments, P, gener
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-var __generator = this && this.__generator || function(thisArg, body) {
+var __generator = (void 0) && (void 0).__generator || function(thisArg, body) {
     var _ = {
         label: 0,
         sent: function sent() {
@@ -150,6 +150,7 @@ var PendingQueue = /** @class */ function() {
             retryTimes = 3;
         }
         this._queue = [];
+        this._resendAxiosInstance = null;
         this._authorizer = authorizer;
         this._config = config;
         this._minTryRetryInterval = minTryRetryInterval;
@@ -158,21 +159,20 @@ var PendingQueue = /** @class */ function() {
     }
     PendingQueue.prototype.resend = function(error_1) {
         return __awaiter(this, arguments, void 0, function(error, retries) {
-            var maxTimes, i, session, axios, e_1;
+            var maxTimes, i, session, _a, e_1;
             if (retries === void 0) {
                 retries = 3;
             }
-            return __generator(this, function(_a) {
-                switch(_a.label){
+            return __generator(this, function(_b) {
+                switch(_b.label){
                     case 0:
                         maxTimes = Math.max(this._retryTimes, retries, 1);
-                        console.log(maxTimes);
                         i = 0;
-                        _a.label = 1;
+                        _b.label = 1;
                     case 1:
                         if (!(i < maxTimes)) return [
                             3 /*break*/ ,
-                            10
+                            11
                         ];
                         if (!(i > 0)) return [
                             3 /*break*/ ,
@@ -183,60 +183,67 @@ var PendingQueue = /** @class */ function() {
                             sleep(random(this._minTryRetryInterval, this._maxTryRetryInterval))
                         ];
                     case 2:
-                        _a.sent();
-                        _a.label = 3;
+                        _b.sent();
+                        _b.label = 3;
                     case 3:
                         return [
                             4 /*yield*/ ,
                             this._authorizer.getSession()
                         ];
                     case 4:
-                        session = _a.sent();
+                        session = _b.sent();
                         if (this._authorizer.sessionHistory.isDeprecated(session)) {
                             // without re-login again, residual invalid session
                             throw error;
                         }
-                        _a.label = 5;
+                        _b.label = 5;
                     case 5:
-                        _a.trys.push([
+                        _b.trys.push([
                             5,
-                            8,
+                            9,
                             ,
-                            9
+                            10
                         ]);
+                        if (!!this._resendAxiosInstance) return [
+                            3 /*break*/ ,
+                            7
+                        ];
+                        _a = this;
                         return [
                             4 /*yield*/ ,
                             this._config.axiosProvider.get()
                         ];
                     case 6:
-                        axios = _a.sent().create();
+                        _a._resendAxiosInstance = _b.sent().create();
+                        _b.label = 7;
+                    case 7:
                         this._authorizer.withAuthentication(error.config, session);
                         return [
                             4 /*yield*/ ,
-                            axios.request(error.config)
+                            this._resendAxiosInstance.request(error.config)
                         ];
-                    case 7:
+                    case 8:
                         // fix: 401 循环 忘了加 await
                         return [
                             2 /*return*/ ,
-                            _a.sent()
+                            _b.sent()
                         ];
-                    case 8:
-                        e_1 = _a.sent();
+                    case 9:
+                        e_1 = _b.sent();
                         if (i >= maxTimes) {
                             throw e_1;
                         }
                         return [
                             3 /*break*/ ,
-                            9
+                            10
                         ];
-                    case 9:
+                    case 10:
                         i++;
                         return [
                             3 /*break*/ ,
                             1
                         ];
-                    case 10:
+                    case 11:
                         throw error;
                 }
             });

package/lib/plugins/auth/storage.js

@@ -1,5 +1,5 @@
 "use strict";
-var __awaiter = this && this.__awaiter || function(thisArg, _arguments, P, generator) {
+var __awaiter = (void 0) && (void 0).__awaiter || function(thisArg, _arguments, P, generator) {
     function adopt(value) {
         return value instanceof P ? value : new P(function(resolve) {
             resolve(value);
@@ -26,7 +26,7 @@ var __awaiter = this && this.__awaiter || function(thisArg, _arguments, P, gener
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-var __generator = this && this.__generator || function(thisArg, body) {
+var __generator = (void 0) && (void 0).__generator || function(thisArg, body) {
     var _ = {
         label: 0,
         sent: function sent() {

package/package.json

@@ -1,16 +1,51 @@
 {
   "name": "axios-annotations",
-  "version": "2.3.0",
+  "version": "3.0.0",
   "description": "HTTP client library uses Axios without Typescript.",
-  "main": "index.js",
-  "miniprogram": "lib",
-  "miniprogramRoot": "lib",
+  "author": "sitorhy",
+  "license": "MIT",
+  "homepage": "https://github.com/sitorhy/axios-annotations#readme",
   "keywords": [
     "axios",
     "axios-annotations",
     "axios-decorators"
   ],
-  "author": "sitorhy",
-  "license": "MIT",
-  "homepage": "https://github.com/sitorhy/axios-annotations#readme"
+
+  "type": "module",
+
+  "main": "./lib/index.js",
+  "module": "./es/index.js",
+  "types": "./lib/index.d.ts",
+
+  "miniprogram": "wechat-mp",
+  "miniprogramRoot": "wechat-mp",
+
+  "files": [
+    "lib",
+    "es",
+    "wechat-mp"
+  ],
+
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./es/index.d.ts",
+        "default": "./es/index.js"
+      },
+      "require": {
+        "types": "./lib/index.d.ts",
+        "default": "./lib/index.js"
+      }
+    },
+    "./plugins/auth": {
+      "import": {
+        "types": "./es/plugins/auth/index.d.ts",
+        "default": "./es/plugins/auth/index.js"
+      },
+      "require": {
+        "types": "./lib/plugins/auth/index.d.ts",
+        "default": "./lib/plugins/auth/index.js"
+      }
+    }
+  }
 }

package/wechat-mp/core/builder.d.ts

@@ -0,0 +1,33 @@
+import type { AxiosResponse, Method } from 'axios';
+import type Config from "./config";
+import { AxiosRequestConfig } from "axios";
+export type ParamsMapper<T = any> = (params: Record<string, any>) => T;
+export declare enum ParamsMappingType {
+    HEADER = "HEADER",
+    PARAM = "PARAM",
+    BODY = "BODY",
+    PATH_VARIABLE = "PATH_VARIABLE"
+}
+export interface ParamsMapping<T = any> {
+    key: string;
+    value: T | ParamsMapper<T>;
+    required?: boolean;
+}
+export type AxiosConfigMapper = (params: Record<string, any>) => AxiosRequestConfig;
+export default class RequestBuilder {
+    private _configs;
+    private readonly _mapping;
+    private readonly _pathVariablesMapping;
+    private _addMapping;
+    private _addPathVariablesMapping;
+    private _clearMapping;
+    param(key: string, required?: boolean): this;
+    param(mapping: ParamsMapping): this;
+    header(key: string, required?: boolean): this;
+    header(mapping: ParamsMapping): this;
+    body(keyOrMapping: string | ParamsMapping): this;
+    pathVariable(keyOrMapping: string | ParamsMapping): this;
+    config(cfg: AxiosRequestConfig | AxiosConfigMapper): this;
+    build(config: Config, path: string, method: Method, source?: Record<string, any>): AxiosRequestConfig;
+    buildWith(config: Config, path: string, method: Method, source?: Record<string, any>): Promise<AxiosResponse<any>>;
+}