@opengeoweb/api 4.12.0 → 4.13.0

package/index.esm.js

@@ -281,6 +281,10 @@ function useApiContext() {
 }
 
 var DEFAULT_TIMEOUT = 15000;
+var KEEP_ALIVE_IN_SECONDS = 60; // Number of seconds in between intervals to check with the token request if connection is stil intact
+
+var KEEP_ALIVE_POLLER_IN_SECONDS = 10; // Number of milliseconds to check if connection is restored or to check if KEEP_ALIVE_IN_SECONDS has passed
+
 var REFRESH_TOKEN_WHEN_PCT_EXPIRED = 75; // Refresh token when 75% expired. Set to (10 / 3600) * 100 = 0.2777778%  to test with 10 second interval.
 
 var DEFAULT_TOKEN_EXPIRES_IN = 3600; // Number of seconds a token expires by default
@@ -312,108 +316,168 @@ var makeCredentialsFromTokenResponse = function makeCredentialsFromTokenResponse
   var tokenExpirationInSeconds = expires_in && expires_in > 0 ? expires_in : DEFAULT_TOKEN_EXPIRES_IN; // If not set or zero in the token, assume valid for 1 hour.
 
   var pctTokenExpirationInSeconds = tokenExpirationInSeconds * (REFRESH_TOKEN_WHEN_PCT_EXPIRED / 100);
-  var epochTimeTokenExpirationInSeconds = pctTokenExpirationInSeconds + Date.now() * MILLISECOND_TO_SECOND;
+  var epochTimeTokenExpirationInSeconds = pctTokenExpirationInSeconds + getCurrentTimeInSeconds();
   var isAuthCognito = userInfo.iss.includes('cognito');
   var newAuth = {
     username: isAuthCognito ? userInfo['cognito:username'] : userInfo.email,
     token: access_token,
     refresh_token: refresh_token || '',
-    expires_at: epochTimeTokenExpirationInSeconds
+    expires_at: epochTimeTokenExpirationInSeconds,
+    keep_session_alive_at: getCurrentTimeInSeconds() + KEEP_ALIVE_IN_SECONDS
   };
   return newAuth;
 };
-var createApiInstance = function createApiInstance(_ref) {
+var refreshAccessToken = function refreshAccessToken(_ref) {
   var auth = _ref.auth,
-      onSetAuth = _ref.onSetAuth,
       _ref$config = _ref.config;
   _ref$config = _ref$config === void 0 ? {} : _ref$config;
-  var baseURL = _ref$config.baseURL,
-      appURL = _ref$config.appURL,
-      authTokenURL = _ref$config.authTokenURL,
+  var authTokenURL = _ref$config.authTokenURL,
       authClientId = _ref$config.authClientId,
+      appURL = _ref$config.appURL,
       _ref$timeout = _ref.timeout,
       timeout = _ref$timeout === void 0 ? DEFAULT_TIMEOUT : _ref$timeout;
-  var axiosInstance = axios.create({
-    baseURL: baseURL,
+  // Refresh token request with a new axios instance
+  // without request interceptor
+  var tokenAxiosInstance = axios.create({
     headers: {},
     timeout: timeout
   });
-
-  var refreshAccessToken = function refreshAccessToken() {
-    // Refresh token request with a new axios instance
-    // without request interceptor
-    var tokenAxiosInstance = axios.create({
-      headers: {},
-      timeout: timeout
-    });
-    var refreshPayload = {
-      refresh_token: auth.refresh_token,
-      redirect_uri: "".concat(appURL, "/code"),
-      grant_type: 'refresh_token',
-      client_id: authClientId
-    };
-    /* Send data in the "application/x-www-form-urlencoded" format.
-      If only JSON is supported, use Axios' default content type ("application/x-www-form-urlencoded"). */
-
-    var useDefaultContentType = authTokenURL.includes('amazonaws.com');
-    var data = useDefaultContentType ? refreshPayload : new URLSearchParams(refreshPayload);
-    var config = {
-      headers: {
-        'Content-Type': useDefaultContentType ? 'application/json' : 'application/x-www-form-urlencoded'
+  var refreshPayload = {
+    refresh_token: auth.refresh_token,
+    redirect_uri: "".concat(appURL, "/code"),
+    grant_type: 'refresh_token',
+    client_id: authClientId
+  };
+  /* Send data in the "application/x-www-form-urlencoded" format.
+    If only JSON is supported, use Axios' default content type ("application/x-www-form-urlencoded"). */
+
+  var useDefaultContentType = authTokenURL.includes('amazonaws.com');
+  var data = useDefaultContentType ? refreshPayload : new URLSearchParams(refreshPayload);
+  var axiosConfig = {
+    headers: {
+      'Content-Type': useDefaultContentType ? 'application/json' : 'application/x-www-form-urlencoded'
+    }
+  };
+  return tokenAxiosInstance.post(authTokenURL, data, axiosConfig);
+};
+var refreshAccessTokenAndSetAuthContext = function refreshAccessTokenAndSetAuthContext(_ref2) {
+  var auth = _ref2.auth,
+      onSetAuth = _ref2.onSetAuth,
+      config = _ref2.config,
+      _ref2$timeout = _ref2.timeout,
+      timeout = _ref2$timeout === void 0 ? DEFAULT_TIMEOUT : _ref2$timeout;
+  return __awaiter(void 0, void 0, void 0, /*#__PURE__*/regeneratorRuntime.mark(function _callee() {
+    var refreshedToken, newAuth;
+    return regeneratorRuntime.wrap(function _callee$(_context) {
+      while (1) {
+        switch (_context.prev = _context.next) {
+          case 0:
+            _context.prev = 0;
+            _context.next = 3;
+            return refreshAccessToken({
+              auth: auth,
+              config: config,
+              timeout: timeout
+            });
+
+          case 3:
+            refreshedToken = _context.sent;
+            newAuth = makeCredentialsFromTokenResponse(refreshedToken);
+            /*
+              Note: Should not use the spread operator here on the auth object to create a new object.
+              Creating a new object and setting that via onSetAuth might change the auth object too late.
+              Instead assign the new token directly to the property and then use the onSetAuth.
+            */
+            // eslint-disable-next-line no-param-reassign
+
+            auth.token = newAuth.token; // eslint-disable-next-line no-param-reassign
+
+            auth.expires_at = newAuth.expires_at; // eslint-disable-next-line no-param-reassign
+
+            auth.refresh_token = newAuth.refresh_token || auth.refresh_token; // eslint-disable-next-line no-param-reassign
+
+            auth.keep_session_alive_at = newAuth.keep_session_alive_at;
+            onSetAuth(Object.assign(Object.assign({}, auth), {
+              has_connection_issue: false
+            }));
+            _context.next = 15;
+            break;
+
+          case 12:
+            _context.prev = 12;
+            _context.t0 = _context["catch"](0);
+            onSetAuth(Object.assign(Object.assign({}, auth), {
+              has_connection_issue: true
+            }));
+
+          case 15:
+          case "end":
+            return _context.stop();
+        }
       }
-    };
-    return tokenAxiosInstance.post(authTokenURL, data, config);
-  }; // Request interceptor for API calls done BEFORE the request is made.
-
+    }, _callee, null, [[0, 12]]);
+  }));
+};
+var createApiInstance = function createApiInstance(_ref3) {
+  var auth = _ref3.auth,
+      onSetAuth = _ref3.onSetAuth,
+      _ref3$config = _ref3.config;
+  _ref3$config = _ref3$config === void 0 ? {} : _ref3$config;
+  var baseURL = _ref3$config.baseURL,
+      authTokenURL = _ref3$config.authTokenURL,
+      authClientId = _ref3$config.authClientId,
+      appURL = _ref3$config.appURL,
+      _ref3$timeout = _ref3.timeout,
+      timeout = _ref3$timeout === void 0 ? DEFAULT_TIMEOUT : _ref3$timeout;
+  var axiosInstance = axios.create({
+    baseURL: baseURL,
+    headers: {},
+    timeout: timeout
+  }); // Request interceptor for API calls done BEFORE the request is made.
 
-  axiosInstance.interceptors.request.use(function (config) {
-    return __awaiter(void 0, void 0, void 0, /*#__PURE__*/regeneratorRuntime.mark(function _callee() {
-      var timeInSecondsLeftBeforeExpiration, refreshedToken, newAuth, newConfig;
-      return regeneratorRuntime.wrap(function _callee$(_context) {
+  axiosInstance.interceptors.request.use(function (axiosConfig) {
+    return __awaiter(void 0, void 0, void 0, /*#__PURE__*/regeneratorRuntime.mark(function _callee2() {
+      var timeInSecondsLeftBeforeExpiration, newConfig;
+      return regeneratorRuntime.wrap(function _callee2$(_context2) {
         while (1) {
-          switch (_context.prev = _context.next) {
+          switch (_context2.prev = _context2.next) {
             case 0:
-              timeInSecondsLeftBeforeExpiration = auth && auth.expires_at ? auth.expires_at - Date.now() * MILLISECOND_TO_SECOND : 0; // If expires_at is not set, don't do anything. (set timeInSecondsLeftBeforeExpiration = 0 will skip refresh)
+              timeInSecondsLeftBeforeExpiration = auth && auth.expires_at ? auth.expires_at - getCurrentTimeInSeconds() : 0; // If expires_at is not set, don't do anything. (set timeInSecondsLeftBeforeExpiration = 0 will skip refresh)
 
               if (!(timeInSecondsLeftBeforeExpiration < 0)) {
-                _context.next = 9;
+                _context2.next = 4;
                 break;
               }
 
-              _context.next = 4;
-              return refreshAccessToken();
+              _context2.next = 4;
+              return refreshAccessTokenAndSetAuthContext({
+                auth: auth,
+                onSetAuth: onSetAuth,
+                config: {
+                  baseURL: baseURL,
+                  authTokenURL: authTokenURL,
+                  authClientId: authClientId,
+                  appURL: appURL
+                },
+                timeout: timeout
+              });
 
             case 4:
-              refreshedToken = _context.sent;
-              newAuth = makeCredentialsFromTokenResponse(refreshedToken);
-              /*
-                 Note: Should not use the spread operator here on the auth object to create a new object.
-                 Creating a new object and setting that via onSetAuth might change the auth object too late.
-                 Instead assign the new token directly to the property and then use the onSetAuth.
-              */
-              // eslint-disable-next-line no-param-reassign
-
-              auth.token = newAuth.token; // eslint-disable-next-line no-param-reassign
-
-              auth.expires_at = newAuth.expires_at;
-              onSetAuth(auth);
-
-            case 9:
-              newConfig = Object.assign(Object.assign({}, config), {
+              newConfig = Object.assign(Object.assign({}, axiosConfig), {
                 headers: Object.assign({
                   'Content-Type': 'application/json',
                   Authorization: "Bearer ".concat(auth.token),
                   Accept: 'application/json'
-                }, config.headers)
+                }, axiosConfig.headers)
               });
-              return _context.abrupt("return", newConfig);
+              return _context2.abrupt("return", newConfig);
 
-            case 11:
+            case 6:
             case "end":
-              return _context.stop();
+              return _context2.stop();
           }
         }
-      }, _callee);
+      }, _callee2);
     }));
   }, function (error) {
     Promise.reject(error);
@@ -422,56 +486,55 @@ var createApiInstance = function createApiInstance(_ref) {
   axiosInstance.interceptors.response.use(function (response) {
     return response;
   }, function (error) {
-    return __awaiter(void 0, void 0, void 0, /*#__PURE__*/regeneratorRuntime.mark(function _callee2() {
-      var originalRequest, refreshedToken, newAuth;
-      return regeneratorRuntime.wrap(function _callee2$(_context2) {
+    return __awaiter(void 0, void 0, void 0, /*#__PURE__*/regeneratorRuntime.mark(function _callee3() {
+      var originalRequest;
+      return regeneratorRuntime.wrap(function _callee3$(_context3) {
         while (1) {
-          switch (_context2.prev = _context2.next) {
+          switch (_context3.prev = _context3.next) {
             case 0:
               originalRequest = error.config;
 
               if (!(error.response && error.response.status && (error.response.status === 401 || error.response.status === 403) && !originalRequest.inRetry)) {
-                _context2.next = 10;
+                _context3.next = 6;
                 break;
               }
 
               originalRequest.inRetry = true;
-              _context2.next = 5;
-              return refreshAccessToken();
+              _context3.next = 5;
+              return refreshAccessTokenAndSetAuthContext({
+                auth: auth,
+                onSetAuth: onSetAuth,
+                config: {
+                  baseURL: baseURL,
+                  authTokenURL: authTokenURL,
+                  authClientId: authClientId,
+                  appURL: appURL
+                },
+                timeout: timeout
+              });
 
             case 5:
-              refreshedToken = _context2.sent;
-              newAuth = makeCredentialsFromTokenResponse(refreshedToken);
-              /*
-                 Note: Should not use the spread operator here on the auth object to create a new object.
-                 Creating a new object and setting that via onSetAuth might change the auth object too late.
-                 Instead assign the new token directly to the property and then use the onSetAuth.
-              */
-              // eslint-disable-next-line no-param-reassign
-
-              auth.token = newAuth.token;
-              onSetAuth(auth);
-              return _context2.abrupt("return", axiosInstance(originalRequest));
-
-            case 10:
-              return _context2.abrupt("return", Promise.reject(error));
-
-            case 11:
+              return _context3.abrupt("return", axiosInstance(originalRequest));
+
+            case 6:
+              return _context3.abrupt("return", Promise.reject(error));
+
+            case 7:
             case "end":
-              return _context2.stop();
+              return _context3.stop();
           }
         }
-      }, _callee2);
+      }, _callee3);
     }));
   });
   return axiosInstance;
 };
-var createNonAuthApiInstance = function createNonAuthApiInstance(_ref2) {
-  var _ref2$config = _ref2.config;
-  _ref2$config = _ref2$config === void 0 ? {} : _ref2$config;
-  var baseURL = _ref2$config.baseURL,
-      _ref2$timeout = _ref2.timeout,
-      timeout = _ref2$timeout === void 0 ? DEFAULT_TIMEOUT : _ref2$timeout;
+var createNonAuthApiInstance = function createNonAuthApiInstance(_ref4) {
+  var _ref4$config = _ref4.config;
+  _ref4$config = _ref4$config === void 0 ? {} : _ref4$config;
+  var baseURL = _ref4$config.baseURL,
+      _ref4$timeout = _ref4.timeout,
+      timeout = _ref4$timeout === void 0 ? DEFAULT_TIMEOUT : _ref4$timeout;
   var axiosInstance = axios.create({
     baseURL: baseURL,
     headers: {},
@@ -479,11 +542,11 @@ var createNonAuthApiInstance = function createNonAuthApiInstance(_ref2) {
   }); // Request interceptor for API calls
 
   axiosInstance.interceptors.request.use(function (config) {
-    return __awaiter(void 0, void 0, void 0, /*#__PURE__*/regeneratorRuntime.mark(function _callee3() {
+    return __awaiter(void 0, void 0, void 0, /*#__PURE__*/regeneratorRuntime.mark(function _callee4() {
       var newConfig;
-      return regeneratorRuntime.wrap(function _callee3$(_context3) {
+      return regeneratorRuntime.wrap(function _callee4$(_context4) {
         while (1) {
-          switch (_context3.prev = _context3.next) {
+          switch (_context4.prev = _context4.next) {
             case 0:
               newConfig = Object.assign(Object.assign({}, config), {
                 headers: Object.assign({
@@ -491,14 +554,14 @@ var createNonAuthApiInstance = function createNonAuthApiInstance(_ref2) {
                   Accept: 'application/json'
                 }, config.headers)
               });
-              return _context3.abrupt("return", newConfig);
+              return _context4.abrupt("return", newConfig);
 
             case 2:
             case "end":
-              return _context3.stop();
+              return _context4.stop();
           }
         }
-      }, _callee3);
+      }, _callee4);
     }));
   }, function (error) {
     Promise.reject(error);
@@ -540,5 +603,8 @@ var createFakeApiInstance = function createFakeApiInstance() {
     }
   };
 };
+var getCurrentTimeInSeconds = function getCurrentTimeInSeconds() {
+  return Date.now() * MILLISECOND_TO_SECOND;
+};
 
-export { ApiProvider, MILLISECOND_TO_SECOND, REFRESH_TOKEN_WHEN_PCT_EXPIRED, createApiInstance, createFakeApiInstance, createNonAuthApiInstance, fakeApiRequest, getApi, makeCredentialsFromTokenResponse, useApi, useApiContext, useDebounce };
+export { ApiProvider, KEEP_ALIVE_IN_SECONDS, KEEP_ALIVE_POLLER_IN_SECONDS, MILLISECOND_TO_SECOND, REFRESH_TOKEN_WHEN_PCT_EXPIRED, createApiInstance, createFakeApiInstance, createNonAuthApiInstance, fakeApiRequest, getApi, getCurrentTimeInSeconds, makeCredentialsFromTokenResponse, refreshAccessToken, refreshAccessTokenAndSetAuthContext, useApi, useApiContext, useDebounce };

package/index.umd.js

@@ -308,6 +308,10 @@
     }
 
     var DEFAULT_TIMEOUT = 15000;
+    var KEEP_ALIVE_IN_SECONDS = 60; // Number of seconds in between intervals to check with the token request if connection is stil intact
+
+    var KEEP_ALIVE_POLLER_IN_SECONDS = 10; // Number of milliseconds to check if connection is restored or to check if KEEP_ALIVE_IN_SECONDS has passed
+
     var REFRESH_TOKEN_WHEN_PCT_EXPIRED = 75; // Refresh token when 75% expired. Set to (10 / 3600) * 100 = 0.2777778%  to test with 10 second interval.
 
     var DEFAULT_TOKEN_EXPIRES_IN = 3600; // Number of seconds a token expires by default
@@ -339,25 +343,122 @@
       var tokenExpirationInSeconds = expires_in && expires_in > 0 ? expires_in : DEFAULT_TOKEN_EXPIRES_IN; // If not set or zero in the token, assume valid for 1 hour.
 
       var pctTokenExpirationInSeconds = tokenExpirationInSeconds * (REFRESH_TOKEN_WHEN_PCT_EXPIRED / 100);
-      var epochTimeTokenExpirationInSeconds = pctTokenExpirationInSeconds + Date.now() * MILLISECOND_TO_SECOND;
+      var epochTimeTokenExpirationInSeconds = pctTokenExpirationInSeconds + getCurrentTimeInSeconds();
       var isAuthCognito = userInfo.iss.includes('cognito');
       var newAuth = {
         username: isAuthCognito ? userInfo['cognito:username'] : userInfo.email,
         token: access_token,
         refresh_token: refresh_token || '',
-        expires_at: epochTimeTokenExpirationInSeconds
+        expires_at: epochTimeTokenExpirationInSeconds,
+        keep_session_alive_at: getCurrentTimeInSeconds() + KEEP_ALIVE_IN_SECONDS
       };
       return newAuth;
     };
+    var refreshAccessToken = function refreshAccessToken(_a) {
+      var auth = _a.auth,
+          _b = _a.config,
+          _c = _b === void 0 ? {} : _b,
+          authTokenURL = _c.authTokenURL,
+          authClientId = _c.authClientId,
+          appURL = _c.appURL,
+          _d = _a.timeout,
+          timeout = _d === void 0 ? DEFAULT_TIMEOUT : _d; // Refresh token request with a new axios instance
+      // without request interceptor
+
+
+      var tokenAxiosInstance = axios__default["default"].create({
+        headers: {},
+        timeout: timeout
+      });
+      var refreshPayload = {
+        refresh_token: auth.refresh_token,
+        redirect_uri: appURL + "/code",
+        grant_type: 'refresh_token',
+        client_id: authClientId
+      };
+      /* Send data in the "application/x-www-form-urlencoded" format.
+        If only JSON is supported, use Axios' default content type ("application/x-www-form-urlencoded"). */
+
+      var useDefaultContentType = authTokenURL.includes('amazonaws.com');
+      var data = useDefaultContentType ? refreshPayload : new URLSearchParams(refreshPayload);
+      var axiosConfig = {
+        headers: {
+          'Content-Type': useDefaultContentType ? 'application/json' : 'application/x-www-form-urlencoded'
+        }
+      };
+      return tokenAxiosInstance.post(authTokenURL, data, axiosConfig);
+    };
+    var refreshAccessTokenAndSetAuthContext = function refreshAccessTokenAndSetAuthContext(_a) {
+      var auth = _a.auth,
+          onSetAuth = _a.onSetAuth,
+          config = _a.config,
+          _b = _a.timeout,
+          timeout = _b === void 0 ? DEFAULT_TIMEOUT : _b;
+      return __awaiter(void 0, void 0, void 0, function () {
+        var refreshedToken, newAuth;
+        return __generator(this, function (_c) {
+          switch (_c.label) {
+            case 0:
+              _c.trys.push([0, 2,, 3]);
+
+              return [4
+              /*yield*/
+              , refreshAccessToken({
+                auth: auth,
+                config: config,
+                timeout: timeout
+              })];
+
+            case 1:
+              refreshedToken = _c.sent();
+              newAuth = makeCredentialsFromTokenResponse(refreshedToken);
+              /*
+                Note: Should not use the spread operator here on the auth object to create a new object.
+                Creating a new object and setting that via onSetAuth might change the auth object too late.
+                Instead assign the new token directly to the property and then use the onSetAuth.
+              */
+              // eslint-disable-next-line no-param-reassign
+
+              auth.token = newAuth.token; // eslint-disable-next-line no-param-reassign
+
+              auth.expires_at = newAuth.expires_at; // eslint-disable-next-line no-param-reassign
+
+              auth.refresh_token = newAuth.refresh_token || auth.refresh_token; // eslint-disable-next-line no-param-reassign
+
+              auth.keep_session_alive_at = newAuth.keep_session_alive_at;
+              onSetAuth(__assign(__assign({}, auth), {
+                has_connection_issue: false
+              }));
+              return [3
+              /*break*/
+              , 3];
+
+            case 2:
+              _c.sent();
+              onSetAuth(__assign(__assign({}, auth), {
+                has_connection_issue: true
+              }));
+              return [3
+              /*break*/
+              , 3];
+
+            case 3:
+              return [2
+              /*return*/
+              ];
+          }
+        });
+      });
+    };
     var createApiInstance = function createApiInstance(_a) {
       var auth = _a.auth,
           onSetAuth = _a.onSetAuth,
           _b = _a.config,
           _c = _b === void 0 ? {} : _b,
           baseURL = _c.baseURL,
-          appURL = _c.appURL,
           authTokenURL = _c.authTokenURL,
           authClientId = _c.authClientId,
+          appURL = _c.appURL,
           _d = _a.timeout,
           timeout = _d === void 0 ? DEFAULT_TIMEOUT : _d;
 
@@ -365,72 +466,44 @@
         baseURL: baseURL,
         headers: {},
         timeout: timeout
-      });
-
-      var refreshAccessToken = function refreshAccessToken() {
-        // Refresh token request with a new axios instance
-        // without request interceptor
-        var tokenAxiosInstance = axios__default["default"].create({
-          headers: {},
-          timeout: timeout
-        });
-        var refreshPayload = {
-          refresh_token: auth.refresh_token,
-          redirect_uri: appURL + "/code",
-          grant_type: 'refresh_token',
-          client_id: authClientId
-        };
-        /* Send data in the "application/x-www-form-urlencoded" format.
-          If only JSON is supported, use Axios' default content type ("application/x-www-form-urlencoded"). */
-
-        var useDefaultContentType = authTokenURL.includes('amazonaws.com');
-        var data = useDefaultContentType ? refreshPayload : new URLSearchParams(refreshPayload);
-        var config = {
-          headers: {
-            'Content-Type': useDefaultContentType ? 'application/json' : 'application/x-www-form-urlencoded'
-          }
-        };
-        return tokenAxiosInstance.post(authTokenURL, data, config);
-      }; // Request interceptor for API calls done BEFORE the request is made.
-
+      }); // Request interceptor for API calls done BEFORE the request is made.
 
-      axiosInstance.interceptors.request.use(function (config) {
+      axiosInstance.interceptors.request.use(function (axiosConfig) {
         return __awaiter(void 0, void 0, void 0, function () {
-          var timeInSecondsLeftBeforeExpiration, refreshedToken, newAuth, newConfig;
+          var timeInSecondsLeftBeforeExpiration, newConfig;
           return __generator(this, function (_a) {
             switch (_a.label) {
               case 0:
-                timeInSecondsLeftBeforeExpiration = auth && auth.expires_at ? auth.expires_at - Date.now() * MILLISECOND_TO_SECOND : 0;
+                timeInSecondsLeftBeforeExpiration = auth && auth.expires_at ? auth.expires_at - getCurrentTimeInSeconds() : 0;
                 if (!(timeInSecondsLeftBeforeExpiration < 0)) return [3
                 /*break*/
                 , 2];
                 return [4
                 /*yield*/
-                , refreshAccessToken()];
+                , refreshAccessTokenAndSetAuthContext({
+                  auth: auth,
+                  onSetAuth: onSetAuth,
+                  config: {
+                    baseURL: baseURL,
+                    authTokenURL: authTokenURL,
+                    authClientId: authClientId,
+                    appURL: appURL
+                  },
+                  timeout: timeout
+                })];
 
               case 1:
-                refreshedToken = _a.sent();
-                newAuth = makeCredentialsFromTokenResponse(refreshedToken);
-                /*
-                   Note: Should not use the spread operator here on the auth object to create a new object.
-                   Creating a new object and setting that via onSetAuth might change the auth object too late.
-                   Instead assign the new token directly to the property and then use the onSetAuth.
-                */
-                // eslint-disable-next-line no-param-reassign
-
-                auth.token = newAuth.token; // eslint-disable-next-line no-param-reassign
-
-                auth.expires_at = newAuth.expires_at;
-                onSetAuth(auth);
+                _a.sent();
+
                 _a.label = 2;
 
               case 2:
-                newConfig = __assign(__assign({}, config), {
+                newConfig = __assign(__assign({}, axiosConfig), {
                   headers: __assign({
                     'Content-Type': 'application/json',
                     Authorization: "Bearer " + auth.token,
                     Accept: 'application/json'
-                  }, config.headers)
+                  }, axiosConfig.headers)
                 });
                 return [2
                 /*return*/
@@ -446,7 +519,7 @@
         return response;
       }, function (error) {
         return __awaiter(void 0, void 0, void 0, function () {
-          var originalRequest, refreshedToken, newAuth;
+          var originalRequest;
           return __generator(this, function (_a) {
             switch (_a.label) {
               case 0:
@@ -457,20 +530,21 @@
                 originalRequest.inRetry = true;
                 return [4
                 /*yield*/
-                , refreshAccessToken()];
+                , refreshAccessTokenAndSetAuthContext({
+                  auth: auth,
+                  onSetAuth: onSetAuth,
+                  config: {
+                    baseURL: baseURL,
+                    authTokenURL: authTokenURL,
+                    authClientId: authClientId,
+                    appURL: appURL
+                  },
+                  timeout: timeout
+                })];
 
               case 1:
-                refreshedToken = _a.sent();
-                newAuth = makeCredentialsFromTokenResponse(refreshedToken);
-                /*
-                   Note: Should not use the spread operator here on the auth object to create a new object.
-                   Creating a new object and setting that via onSetAuth might change the auth object too late.
-                   Instead assign the new token directly to the property and then use the onSetAuth.
-                */
-                // eslint-disable-next-line no-param-reassign
-
-                auth.token = newAuth.token;
-                onSetAuth(auth);
+                _a.sent();
+
                 return [2
                 /*return*/
                 , axiosInstance(originalRequest)];
@@ -553,8 +627,13 @@
         }
       };
     };
+    var getCurrentTimeInSeconds = function getCurrentTimeInSeconds() {
+      return Date.now() * MILLISECOND_TO_SECOND;
+    };
 
     exports.ApiProvider = ApiProvider;
+    exports.KEEP_ALIVE_IN_SECONDS = KEEP_ALIVE_IN_SECONDS;
+    exports.KEEP_ALIVE_POLLER_IN_SECONDS = KEEP_ALIVE_POLLER_IN_SECONDS;
     exports.MILLISECOND_TO_SECOND = MILLISECOND_TO_SECOND;
     exports.REFRESH_TOKEN_WHEN_PCT_EXPIRED = REFRESH_TOKEN_WHEN_PCT_EXPIRED;
     exports.createApiInstance = createApiInstance;
@@ -562,7 +641,10 @@
     exports.createNonAuthApiInstance = createNonAuthApiInstance;
     exports.fakeApiRequest = fakeApiRequest;
     exports.getApi = getApi;
+    exports.getCurrentTimeInSeconds = getCurrentTimeInSeconds;
     exports.makeCredentialsFromTokenResponse = makeCredentialsFromTokenResponse;
+    exports.refreshAccessToken = refreshAccessToken;
+    exports.refreshAccessTokenAndSetAuthContext = refreshAccessTokenAndSetAuthContext;
     exports.useApi = useApi;
     exports.useApiContext = useApiContext;
     exports.useDebounce = useDebounce;

package/lib/components/ApiContext/types.d.ts

@@ -9,6 +9,8 @@ export interface Credentials {
     token: string;
     refresh_token: string;
     expires_at?: number;
+    keep_session_alive_at?: any;
+    has_connection_issue?: boolean;
 }
 export declare type ApiUrls = {
     baseURL?: string;

package/lib/components/ApiContext/utils.d.ts

@@ -1,5 +1,7 @@
 import { AxiosInstance, AxiosResponse } from 'axios';
 import { CreateApiProps, Credentials } from './types';
+export declare const KEEP_ALIVE_IN_SECONDS = 60;
+export declare const KEEP_ALIVE_POLLER_IN_SECONDS = 10;
 export declare const REFRESH_TOKEN_WHEN_PCT_EXPIRED = 75;
 export declare const MILLISECOND_TO_SECOND: number;
 /**
@@ -11,7 +13,10 @@ export declare const MILLISECOND_TO_SECOND: number;
  * @returns Credentials object.
  */
 export declare const makeCredentialsFromTokenResponse: (tokenResponse: AxiosResponse) => Credentials;
-export declare const createApiInstance: ({ auth, onSetAuth, config: { baseURL, appURL, authTokenURL, authClientId }, timeout, }: CreateApiProps) => AxiosInstance;
+export declare const refreshAccessToken: ({ auth, config: { authTokenURL, authClientId, appURL }, timeout, }: CreateApiProps) => Promise<AxiosResponse>;
+export declare const refreshAccessTokenAndSetAuthContext: ({ auth, onSetAuth, config, timeout, }: CreateApiProps) => Promise<void>;
+export declare const createApiInstance: ({ auth, onSetAuth, config: { baseURL, authTokenURL, authClientId, appURL }, timeout, }: CreateApiProps) => AxiosInstance;
 export declare const createNonAuthApiInstance: ({ config: { baseURL }, timeout, }: CreateApiProps) => AxiosInstance;
 export declare const fakeApiRequest: (signal?: AbortController | undefined) => Promise<void>;
 export declare const createFakeApiInstance: () => AxiosInstance;
+export declare const getCurrentTimeInSeconds: () => number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opengeoweb/api",
-  "version": "4.12.0",
+  "version": "4.13.0",
   "description": "GeoWeb API library for the opengeoweb project",
   "license": "Apache-2.0",
   "repository": {
@@ -14,14 +14,14 @@
   "peerDependencies": {
     "react": "^18.2.0",
     "axios": "^0.25.0",
-    "@opengeoweb/shared": "4.12.0",
+    "@opengeoweb/shared": "4.13.0",
     "@mui/material": "^5.10.8",
-    "@opengeoweb/theme": "4.12.0",
+    "@opengeoweb/theme": "4.13.0",
     "react-draggable": "^4.4.5",
     "re-resizable": "^6.9.0",
     "@redux-eggs/core": "^2.2.0",
     "react-redux": "^8.0.4",
-    "@opengeoweb/form-fields": "4.12.0",
+    "@opengeoweb/form-fields": "4.13.0",
     "react-hook-form": "^7.41.5",
     "moment": "^2.29.0",
     "moment-timezone": "^0.5.31",