axios-annotations 1.3.3 → 2.0.0

package/lib/plugins/auth/index.js

@@ -1 +1,368 @@
-"use strict";function _typeof(t){return(_typeof="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(t){return typeof t}:function(t){return t&&"function"==typeof Symbol&&t.constructor===Symbol&&t!==Symbol.prototype?"symbol":typeof t})(t)}Object.defineProperty(exports,"__esModule",{value:!0}),exports.default=AuthorizationPlugin;var _queue=_interopRequireDefault(require("./queue"));function _interopRequireDefault(t){return t&&t.__esModule?t:{default:t}}function _regeneratorRuntime(){_regeneratorRuntime=function(){return a};var a={},t=Object.prototype,u=t.hasOwnProperty,s=Object.defineProperty||function(t,e,r){t[e]=r.value},e="function"==typeof Symbol?Symbol:{},n=e.iterator||"@@iterator",r=e.asyncIterator||"@@asyncIterator",o=e.toStringTag||"@@toStringTag";function i(t,e,r){return Object.defineProperty(t,e,{value:r,enumerable:!0,configurable:!0,writable:!0}),t[e]}try{i({},"")}catch(t){i=function(t,e,r){return t[e]=r}}function c(t,e,r,n){var o,i,a,c,e=e&&e.prototype instanceof h?e:h,e=Object.create(e.prototype),n=new b(n||[]);return s(e,"_invoke",{value:(o=t,i=r,a=n,c="suspendedStart",function(t,e){if("executing"===c)throw new Error("Generator is already running");if("completed"===c){if("throw"===t)throw e;return L()}for(a.method=t,a.arg=e;;){var r=a.delegate;if(r){r=function t(e,r){var n=r.method,o=e.iterator[n];if(void 0===o)return r.delegate=null,"throw"===n&&e.iterator.return&&(r.method="return",r.arg=void 0,t(e,r),"throw"===r.method)||"return"!==n&&(r.method="throw",r.arg=new TypeError("The iterator does not provide a '"+n+"' method")),l;n=f(o,e.iterator,r.arg);if("throw"===n.type)return r.method="throw",r.arg=n.arg,r.delegate=null,l;o=n.arg;return o?o.done?(r[e.resultName]=o.value,r.next=e.nextLoc,"return"!==r.method&&(r.method="next",r.arg=void 0),r.delegate=null,l):o:(r.method="throw",r.arg=new TypeError("iterator result is not an object"),r.delegate=null,l)}(r,a);if(r){if(r===l)continue;return r}}if("next"===a.method)a.sent=a._sent=a.arg;else if("throw"===a.method){if("suspendedStart"===c)throw c="completed",a.arg;a.dispatchException(a.arg)}else"return"===a.method&&a.abrupt("return",a.arg);c="executing";r=f(o,i,a);if("normal"===r.type){if(c=a.done?"completed":"suspendedYield",r.arg===l)continue;return{value:r.arg,done:a.done}}"throw"===r.type&&(c="completed",a.method="throw",a.arg=r.arg)}})}),e}function f(t,e,r){try{return{type:"normal",arg:t.call(e,r)}}catch(t){return{type:"throw",arg:t}}}a.wrap=c;var l={};function h(){}function p(){}function y(){}var e={},v=(i(e,n,function(){return this}),Object.getPrototypeOf),v=v&&v(v(_([]))),d=(v&&v!==t&&u.call(v,n)&&(e=v),y.prototype=h.prototype=Object.create(e));function g(t){["next","throw","return"].forEach(function(e){i(t,e,function(t){return this._invoke(e,t)})})}function m(a,c){var e;s(this,"_invoke",{value:function(r,n){function t(){return new c(function(t,e){!function e(t,r,n,o){var i,t=f(a[t],a,r);if("throw"!==t.type)return(r=(i=t.arg).value)&&"object"==_typeof(r)&&u.call(r,"__await")?c.resolve(r.__await).then(function(t){e("next",t,n,o)},function(t){e("throw",t,n,o)}):c.resolve(r).then(function(t){i.value=t,n(i)},function(t){return e("throw",t,n,o)});o(t.arg)}(r,n,t,e)})}return e=e?e.then(t,t):t()}})}function w(t){var e={tryLoc:t[0]};1 in t&&(e.catchLoc=t[1]),2 in t&&(e.finallyLoc=t[2],e.afterLoc=t[3]),this.tryEntries.push(e)}function x(t){var e=t.completion||{};e.type="normal",delete e.arg,t.completion=e}function b(t){this.tryEntries=[{tryLoc:"root"}],t.forEach(w,this),this.reset(!0)}function _(e){if(e){var r,t=e[n];if(t)return t.call(e);if("function"==typeof e.next)return e;if(!isNaN(e.length))return r=-1,(t=function t(){for(;++r<e.length;)if(u.call(e,r))return t.value=e[r],t.done=!1,t;return t.value=void 0,t.done=!0,t}).next=t}return{next:L}}function L(){return{value:void 0,done:!0}}return s(d,"constructor",{value:p.prototype=y,configurable:!0}),s(y,"constructor",{value:p,configurable:!0}),p.displayName=i(y,o,"GeneratorFunction"),a.isGeneratorFunction=function(t){t="function"==typeof t&&t.constructor;return!!t&&(t===p||"GeneratorFunction"===(t.displayName||t.name))},a.mark=function(t){return Object.setPrototypeOf?Object.setPrototypeOf(t,y):(t.__proto__=y,i(t,o,"GeneratorFunction")),t.prototype=Object.create(d),t},a.awrap=function(t){return{__await:t}},g(m.prototype),i(m.prototype,r,function(){return this}),a.AsyncIterator=m,a.async=function(t,e,r,n,o){void 0===o&&(o=Promise);var i=new m(c(t,e,r,n),o);return a.isGeneratorFunction(e)?i:i.next().then(function(t){return t.done?t.value:i.next()})},g(d),i(d,o,"Generator"),i(d,n,function(){return this}),i(d,"toString",function(){return"[object Generator]"}),a.keys=function(t){var e,r=Object(t),n=[];for(e in r)n.push(e);return n.reverse(),function t(){for(;n.length;){var e=n.pop();if(e in r)return t.value=e,t.done=!1,t}return t.done=!0,t}},a.values=_,b.prototype={constructor:b,reset:function(t){if(this.prev=0,this.next=0,this.sent=this._sent=void 0,this.done=!1,this.delegate=null,this.method="next",this.arg=void 0,this.tryEntries.forEach(x),!t)for(var e in this)"t"===e.charAt(0)&&u.call(this,e)&&!isNaN(+e.slice(1))&&(this[e]=void 0)},stop:function(){this.done=!0;var t=this.tryEntries[0].completion;if("throw"===t.type)throw t.arg;return this.rval},dispatchException:function(r){if(this.done)throw r;var n=this;function t(t,e){return i.type="throw",i.arg=r,n.next=t,e&&(n.method="next",n.arg=void 0),!!e}for(var e=this.tryEntries.length-1;0<=e;--e){var o=this.tryEntries[e],i=o.completion;if("root"===o.tryLoc)return t("end");if(o.tryLoc<=this.prev){var a=u.call(o,"catchLoc"),c=u.call(o,"finallyLoc");if(a&&c){if(this.prev<o.catchLoc)return t(o.catchLoc,!0);if(this.prev<o.finallyLoc)return t(o.finallyLoc)}else if(a){if(this.prev<o.catchLoc)return t(o.catchLoc,!0)}else{if(!c)throw new Error("try statement without catch or finally");if(this.prev<o.finallyLoc)return t(o.finallyLoc)}}}},abrupt:function(t,e){for(var r=this.tryEntries.length-1;0<=r;--r){var n=this.tryEntries[r];if(n.tryLoc<=this.prev&&u.call(n,"finallyLoc")&&this.prev<n.finallyLoc){var o=n;break}}var i=(o=o&&("break"===t||"continue"===t)&&o.tryLoc<=e&&e<=o.finallyLoc?null:o)?o.completion:{};return i.type=t,i.arg=e,o?(this.method="next",this.next=o.finallyLoc,l):this.complete(i)},complete:function(t,e){if("throw"===t.type)throw t.arg;return"break"===t.type||"continue"===t.type?this.next=t.arg:"return"===t.type?(this.rval=this.arg=t.arg,this.method="return",this.next="end"):"normal"===t.type&&e&&(this.next=e),l},finish:function(t){for(var e=this.tryEntries.length-1;0<=e;--e){var r=this.tryEntries[e];if(r.finallyLoc===t)return this.complete(r.completion,r.afterLoc),x(r),l}},catch:function(t){for(var e=this.tryEntries.length-1;0<=e;--e){var r,n,o=this.tryEntries[e];if(o.tryLoc===t)return"throw"===(r=o.completion).type&&(n=r.arg,x(o)),n}throw new Error("illegal catch attempt")},delegateYield:function(t,e,r){return this.delegate={iterator:_(t),resultName:e,nextLoc:r},"next"===this.method&&(this.arg=void 0),l}},a}function asyncGeneratorStep(t,e,r,n,o,i,a){try{var c=t[i](a),u=c.value}catch(t){return void r(t)}c.done?e(u):Promise.resolve(u).then(n,o)}function _asyncToGenerator(c){return function(){var t=this,a=arguments;return new Promise(function(e,r){var n=c.apply(t,a);function o(t){asyncGeneratorStep(n,e,r,o,i,"next",t)}function i(t){asyncGeneratorStep(n,e,r,o,i,"throw",t)}o(void 0)})}}function AuthorizationPlugin(c){return function(t){var e,r,o=!1,i=null,a=new _queue.default(c);t.axios.interceptors.response.use(function(t){return i&&(c.sessionHistory.add(i),i=null),t},(e=_asyncToGenerator(_regeneratorRuntime().mark(function t(e){var r,n;return _regeneratorRuntime().wrap(function(t){for(;;)switch(t.prev=t.next){case 0:if(r=e.response,c.checkResponse(r)){t.next=66;break}if(o){t.next=61;break}return o=!0,t.next=6,c.getSession();case 6:if(n=t.sent,c.sessionHistory.isDeprecated(n))return t.prev=8,t.next=11,c.onAuthorizedDenied(e);t.next=21;break;case 11:c.sessionHistory.clean(),t.next=17;break;case 14:throw t.prev=14,t.t0=t.catch(8),e;case 17:return t.prev=17,o=!1,a.clear(),t.finish(17);case 21:if(i=n,c.checkSession(e.config,n)){t.next=48;break}return t.prev=23,t.t1=c,t.next=27,c.refreshSession(n);case 27:return t.t2=t.sent,t.next=30,t.t1.storageSession.call(t.t1,t.t2);case 30:t.next=48;break;case 32:return t.prev=32,t.t3=t.catch(23),c.sessionHistory.deprecate(n),t.prev=35,t.next=38,c.onAuthorizedDenied(t.t3);case 38:c.sessionHistory.clean(),t.next=44;break;case 41:throw t.prev=41,t.t4=t.catch(35),e;case 44:return t.prev=44,o=!1,a.clear(),t.finish(44);case 48:for(o=!1;a.size;)a.pop();return t.prev=50,t.next=53,a.resend(e);case 53:return t.abrupt("return",t.sent);case 56:throw t.prev=56,t.t5=t.catch(50),t.t5;case 59:t.next=64;break;case 61:return t.next=63,a.push(e);case 63:return t.abrupt("return",t.sent);case 64:t.next=67;break;case 66:throw e;case 67:case"end":return t.stop()}},t,null,[[8,14,17,21],[23,32],[35,41,44,48],[50,56]])})),function(t){return e.apply(this,arguments)})),t.axios.interceptors.request.use((r=_asyncToGenerator(_regeneratorRuntime().mark(function t(e){var r;return _regeneratorRuntime().wrap(function(t){for(;;)switch(t.prev=t.next){case 0:return t.next=2,c.getSession();case 2:return r=t.sent,c.withAuthentication(e,r),t.abrupt("return",e);case 5:case"end":return t.stop()}},t)})),function(t){return r.apply(this,arguments)}))}}
+"use strict";
+var __awaiter = this && this.__awaiter || function(thisArg, _arguments, P, generator) {
+    function adopt(value) {
+        return value instanceof P ? value : new P(function(resolve) {
+            resolve(value);
+        });
+    }
+    return new (P || (P = Promise))(function(resolve, reject) {
+        function fulfilled(value) {
+            try {
+                step(generator.next(value));
+            } catch (e) {
+                reject(e);
+            }
+        }
+        function rejected(value) {
+            try {
+                step(generator["throw"](value));
+            } catch (e) {
+                reject(e);
+            }
+        }
+        function step(result) {
+            result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected);
+        }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = this && this.__generator || function(thisArg, body) {
+    var _ = {
+        label: 0,
+        sent: function sent() {
+            if (t[0] & 1) throw t[1];
+            return t[1];
+        },
+        trys: [],
+        ops: []
+    }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() {
+        return this;
+    }), g;
+    function verb(n) {
+        return function(v) {
+            return step([
+                n,
+                v
+            ]);
+        };
+    }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while(g && (g = 0, op[0] && (_ = 0)), _)try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [
+                op[0] & 2,
+                t.value
+            ];
+            switch(op[0]){
+                case 0:
+                case 1:
+                    t = op;
+                    break;
+                case 4:
+                    _.label++;
+                    return {
+                        value: op[1],
+                        done: false
+                    };
+                case 5:
+                    _.label++;
+                    y = op[1];
+                    op = [
+                        0
+                    ];
+                    continue;
+                case 7:
+                    op = _.ops.pop();
+                    _.trys.pop();
+                    continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) {
+                        _ = 0;
+                        continue;
+                    }
+                    if (op[0] === 3 && (!t || op[1] > t[0] && op[1] < t[3])) {
+                        _.label = op[1];
+                        break;
+                    }
+                    if (op[0] === 6 && _.label < t[1]) {
+                        _.label = t[1];
+                        t = op;
+                        break;
+                    }
+                    if (t && _.label < t[2]) {
+                        _.label = t[2];
+                        _.ops.push(op);
+                        break;
+                    }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop();
+                    continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) {
+            op = [
+                6,
+                e
+            ];
+            y = 0;
+        } finally{
+            f = t = 0;
+        }
+        if (op[0] & 5) throw op[1];
+        return {
+            value: op[0] ? op[1] : void 0,
+            done: true
+        };
+    }
+};
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+exports.SessionStorage = exports.Authorizer = void 0;
+exports["default"] = AuthorizationPlugin;
+var queue_1 = require("./queue");
+var authorizer_1 = require("./authorizer");
+Object.defineProperty(exports, "Authorizer", {
+    enumerable: true,
+    get: function get() {
+        return authorizer_1["default"];
+    }
+});
+var storage_1 = require("./storage");
+Object.defineProperty(exports, "SessionStorage", {
+    enumerable: true,
+    get: function get() {
+        return storage_1["default"];
+    }
+});
+function AuthorizationPlugin(authorizer, options) {
+    return function(axios, config) {
+        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)
+                authorizer.sessionHistory.add(expiredSession);
+                expiredSession = null;
+            }
+            return i;
+        }, function(e) {
+            return __awaiter(this, void 0, void 0, function() {
+                var response, session, e5_1, _a, _b, e2_1, e3_1, e4_1;
+                return __generator(this, function(_c) {
+                    switch(_c.label){
+                        case 0:
+                            response = e.response;
+                            if (!!authorizer.checkResponse(response)) return [
+                                3 /*break*/ ,
+                                24
+                            ];
+                            if (!!unauthorized) return [
+                                3 /*break*/ ,
+                                21
+                            ];
+                            unauthorized = true;
+                            return [
+                                4 /*yield*/ ,
+                                authorizer.getSession()
+                            ];
+                        case 1:
+                            session = _c.sent();
+                            if (!authorizer.sessionHistory.isDeprecated(session)) return [
+                                3 /*break*/ ,
+                                6
+                            ];
+                            _c.label = 2;
+                        case 2:
+                            _c.trys.push([
+                                2,
+                                4,
+                                5,
+                                6
+                            ]);
+                            // You may override this method for home page redirecting.
+                            return [
+                                4 /*yield*/ ,
+                                authorizer.onAuthorizedDenied(e)
+                            ];
+                        case 3:
+                            // You may override this method for home page redirecting.
+                            _c.sent();
+                            authorizer.sessionHistory.clean();
+                            return [
+                                3 /*break*/ ,
+                                6
+                            ];
+                        case 4:
+                            e5_1 = _c.sent();
+                            throw e;
+                        case 5:
+                            unauthorized = false;
+                            queue.clear();
+                            return [
+                                7 /*endfinally*/ 
+                            ];
+                        case 6:
+                            expiredSession = session;
+                            if (!!authorizer.checkSession(e.config, session)) return [
+                                3 /*break*/ ,
+                                16
+                            ];
+                            _c.label = 7;
+                        case 7:
+                            _c.trys.push([
+                                7,
+                                10,
+                                ,
+                                16
+                            ]);
+                            _b = (_a = authorizer).storageSession;
+                            return [
+                                4 /*yield*/ ,
+                                authorizer.refreshSession(session)
+                            ];
+                        case 8:
+                            // 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.
+                            return [
+                                4 /*yield*/ ,
+                                _b.apply(_a, [
+                                    _c.sent()
+                                ])
+                            ];
+                        case 9:
+                            // 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.
+                            _c.sent();
+                            return [
+                                3 /*break*/ ,
+                                16
+                            ];
+                        case 10:
+                            e2_1 = _c.sent();
+                            // invalid refresh_token
+                            authorizer.sessionHistory.deprecate(session);
+                            _c.label = 11;
+                        case 11:
+                            _c.trys.push([
+                                11,
+                                13,
+                                14,
+                                15
+                            ]);
+                            return [
+                                4 /*yield*/ ,
+                                authorizer.onAuthorizedDenied(e2_1)
+                            ];
+                        case 12:
+                            _c.sent();
+                            authorizer.sessionHistory.clean();
+                            return [
+                                3 /*break*/ ,
+                                15
+                            ];
+                        case 13:
+                            e3_1 = _c.sent();
+                            throw e;
+                        case 14:
+                            unauthorized = false;
+                            // cancel all requests resending.
+                            queue.clear();
+                            return [
+                                7 /*endfinally*/ 
+                            ];
+                        case 15:
+                            return [
+                                3 /*break*/ ,
+                                16
+                            ];
+                        case 16:
+                            unauthorized = false;
+                            // the accessToken refreshed, send the request itself and startup resending queue cleaning.
+                            (function() {
+                                while(queue.size){
+                                    queue.pop();
+                                }
+                            })();
+                            _c.label = 17;
+                        case 17:
+                            _c.trys.push([
+                                17,
+                                19,
+                                ,
+                                20
+                            ]);
+                            return [
+                                4 /*yield*/ ,
+                                queue.resend(e)
+                            ];
+                        case 18:
+                            return [
+                                2 /*return*/ ,
+                                _c.sent()
+                            ];
+                        case 19:
+                            e4_1 = _c.sent();
+                            // 500 502 503 ...
+                            throw e4_1;
+                        case 20:
+                            return [
+                                3 /*break*/ ,
+                                23
+                            ];
+                        case 21:
+                            return [
+                                4 /*yield*/ ,
+                                queue.push(e)
+                            ];
+                        case 22:
+                            // No, 401 request occurred, put in to resending queue itself and waiting.
+                            return [
+                                2 /*return*/ ,
+                                _c.sent()
+                            ];
+                        case 23:
+                            return [
+                                3 /*break*/ ,
+                                25
+                            ];
+                        case 24:
+                            // HTTP Code = 500 503 502 ... just throw it
+                            throw e;
+                        case 25:
+                            return [
+                                2 /*return*/ 
+                            ];
+                    }
+                });
+            });
+        });
+        axios.interceptors.request.use(function(request) {
+            return __awaiter(this, void 0, void 0, function() {
+                var session;
+                return __generator(this, function(_a) {
+                    switch(_a.label){
+                        case 0:
+                            return [
+                                4 /*yield*/ ,
+                                authorizer.getSession()
+                            ];
+                        case 1:
+                            session = _a.sent();
+                            authorizer.withAuthentication(request, session);
+                            return [
+                                2 /*return*/ ,
+                                request
+                            ];
+                    }
+                });
+            });
+        });
+    };
+}

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

@@ -1,16 +1,28 @@
-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;
-}
+import type { AxiosError } from "axios";
+import Authorizer from "./authorizer";
+import { Config } from "../../index";
+export default class PendingQueue {
+    _queue: {
+        error: AxiosError;
+        resolve: (arg: any) => void;
+        reject: (arg: any) => void;
+    }[];
+    _authorizer: Authorizer;
+    _config: Config;
+    _minTryRetryInterval: number;
+    _maxTryRetryInterval: number;
+    _retryTimes: number;
+    /**
+     * @param {Authorizer} authorizer
+     * @param {Config} config
+     * @param {number} minTryRetryInterval
+     * @param {number} maxTryRetryInterval
+     * @param retryTimes
+     */
+    constructor(authorizer: Authorizer, config: Config, minTryRetryInterval?: number, maxTryRetryInterval?: number, retryTimes?: number);
+    resend(error: AxiosError, retries?: number): Promise<any>;
+    push(error: AxiosError): Promise<any>;
+    pop(): void;
+    clear(): void;
+    get size(): number;
+}