gd-sprest 9.0.4 → 9.0.6

package/@types/lib/contextInfo.d.ts

@@ -464,6 +464,11 @@ export interface IContextInformation {
      * Methods
      */
 
+    /**
+     * Runs a loop to ensure the digest value doesn't expire.
+     */
+    enableRefreshToken();
+
     /**
      * Generates a guid.
      * @returns A GUID as a string value.
@@ -483,19 +488,6 @@ export interface IContextInformation {
      * @param spfxPageContext - The page context information variable from a SPFx project.
      */
     setPageContext(spfxPageContext: any);
-
-    /**
-     * Updates the form digest context information.
-     * @param digestValue The form digest value.
-     * @param timeout The timeout value in seconds.
-     */
-    updateToken(digestValue: string, timeout: number);
-
-    /**
-     * Validates the date/time of a form digest value to ensure it's still valid.
-     * @param digestValue The request digest form value. The default context info for the page is used, if a value isn't given.
-     */
-    validateToken(digestValue?: string): boolean;
 }
 
 // Theme State

package/build/lib/contextInfo.js

@@ -744,11 +744,39 @@ var _ContextInfo = /** @class */ (function () {
             url: url
         });
     };
-    // Method to update the token
-    _ContextInfo.updateToken = function (digestValue, timeout) {
-        // Update the context information
-        this._contextInfo.formDigestTimeoutSeconds = timeout;
-        this._contextInfo.formDigestValue = digestValue;
+    _ContextInfo.enableRefreshToken = function () {
+        var _this = this;
+        // See if the request digest exists
+        if (this.formDigestValue == null) {
+            return;
+        }
+        // See if we already have a loop method
+        if (this._loopId) {
+            return;
+        }
+        // Create a loop
+        this._loopId = setInterval(function () {
+            // See if the digest is valid
+            if (_this.validateToken()) {
+                return;
+            }
+            // Log
+            console.info("[gd-sprest] Token has expired. Trying to refresh the token.");
+            // Get the context
+            _this.getWeb().execute(function (context) {
+                // Log
+                console.info("[gd-sprest] Successfully updated the token information.");
+                // Update the context info
+                _this._contextInfo.formDigestTimeoutSeconds = context.GetContextWebInformation.FormDigestTimeoutSeconds;
+                _this._contextInfo.formDigestValue = context.GetContextWebInformation.FormDigestValue;
+            }, function () {
+                // Log
+                console.info("[gd-sprest] Unable to get the context information to refresh the token.");
+                // Stop the loop
+                clearInterval(_this._loopId);
+                _this._loopId = null;
+            });
+        }, 500);
     };
     // Method to validate the token
     _ContextInfo.validateToken = function (digestValue) {
@@ -763,10 +791,18 @@ var _ContextInfo = /** @class */ (function () {
         // Return true if it's still valid
         return Date.now() < dtToken.getTime() + timeout * 1000;
     };
+    var _a;
+    _a = _ContextInfo;
     // The page context information from an spfx project
     _ContextInfo._spfxPageContext = null;
     // Method to set the page context information from an SPFX project
-    _ContextInfo.setPageContext = function (spfxPageContext) { exports.ContextInfo["_spfxPageContext"] = spfxPageContext; };
+    _ContextInfo.setPageContext = function (spfxPageContext) {
+        // Set the page context information
+        exports.ContextInfo["_spfxPageContext"] = spfxPageContext;
+        // Enable the refresh token
+        _a.enableRefreshToken();
+    };
+    _ContextInfo._loopId = null;
     return _ContextInfo;
 }());
 exports.ContextInfo = _ContextInfo;

package/build/rest.js

@@ -9,7 +9,7 @@ var sptypes_1 = require("./sptypes");
  * SharePoint REST Library
  */
 exports.$REST = {
-    __ver: 9.04,
+    __ver: 9.06,
     AppContext: function (siteUrl) { return Lib.Site.getAppContext(siteUrl); },
     Apps: Lib.Apps,
     ContextInfo: Lib.ContextInfo,
@@ -55,6 +55,8 @@ var global = Lib.ContextInfo.window.$REST;
 if (global == null || global.__ver == null || global.__ver < exports.$REST.__ver) {
     // Set the global variable
     Lib.ContextInfo.window.$REST = exports.$REST;
+    // Enable the refresh token
+    Lib.ContextInfo.enableRefreshToken();
     // Ensure the SP lib exists
     if (Lib.ContextInfo.window.SP) {
         // If MDS is turned on in a SP2013 environment, it may throw an error

package/build/utils/xhrRequest.js

@@ -200,33 +200,6 @@ var XHRRequest = /** @class */ (function () {
     // Method to execute the xml http request
     XHRRequest.prototype.execute = function () {
         var _this = this;
-        // Executes the request
-        var processRequest = function () {
-            // See if we are targeting the context endpoint
-            if (_this.targetInfo.props.endpoint == "contextinfo") {
-                // Execute the request
-                _this.executeRequest(requestDigest);
-            }
-            // See if this is a post request and the request digest does not exist
-            else if (_this.targetInfo.requestMethod != "GET" && requestDigest == "") {
-                // See if this is a synchronous request
-                if (!_this.asyncFl) {
-                    // Log
-                    console.info("[gd-sprest] POST requests must include the request digest information for synchronous requests. This is due to the modern page not including this information on the page.");
-                }
-                else {
-                    // Get the context information
-                    lib_1.ContextInfo.getWeb(_this.targetInfo.props.url || document.location.pathname.substr(0, document.location.pathname.lastIndexOf('/'))).execute(function (contextInfo) {
-                        // Execute the request
-                        _this.executeRequest(contextInfo.GetContextWebInformation.FormDigestValue);
-                    });
-                }
-            }
-            else {
-                // Execute the request
-                _this.executeRequest(requestDigest);
-            }
-        };
         // Set the request digest
         var requestDigest = this.targetInfo.props.requestDigest || "";
         if (requestDigest == "") {
@@ -234,25 +207,29 @@ var XHRRequest = /** @class */ (function () {
             requestDigest = lib_1.ContextInfo.document ? lib_1.ContextInfo.document.querySelector("#__REQUESTDIGEST") : "";
             requestDigest = requestDigest ? requestDigest.value : lib_1.ContextInfo.formDigestValue;
         }
-        // See if we need to update the request digest
-        if (requestDigest && lib_1.ContextInfo.validateToken(requestDigest) == false) {
-            // Log
-            console.info("[gd-sprest] Token has expired. Trying to refresh the token.");
-            // See if this is an async request
-            if (this.asyncFl) {
-                // Refresh the request digest value and then process the request
-                this.refreshToken(requestDigest, processRequest);
+        // See if we are targeting the context endpoint
+        if (this.targetInfo.props.endpoint == "contextinfo") {
+            // Execute the request
+            this.executeRequest(requestDigest);
+        }
+        // See if this is a post request and the request digest does not exist
+        else if (this.targetInfo.requestMethod != "GET" && requestDigest == "") {
+            // See if this is a synchronous request
+            if (!this.asyncFl) {
+                // Log
+                console.info("[gd-sprest] POST requests must include the request digest information for synchronous requests. This is due to the modern page not including this information on the page.");
             }
             else {
-                // Refresh the request digest value
-                this.refreshToken(requestDigest);
-                // Process the request
-                processRequest();
+                // Get the context information
+                lib_1.ContextInfo.getWeb(this.targetInfo.props.url || document.location.pathname.substr(0, document.location.pathname.lastIndexOf('/'))).execute(function (contextInfo) {
+                    // Execute the request
+                    _this.executeRequest(contextInfo.GetContextWebInformation.FormDigestValue);
+                });
             }
         }
         else {
-            // Process the request
-            processRequest();
+            // Execute the request
+            this.executeRequest(requestDigest);
         }
     };
     // Method to execute the xml http request
@@ -301,46 +278,6 @@ var XHRRequest = /** @class */ (function () {
             this.targetInfo.props.bufferFl || this.targetInfo.requestData == null ? this.xhr.send() : this.xhr.send(this.targetInfo.requestData);
         }
     };
-    // Method to refresh the token
-    XHRRequest.prototype.refreshToken = function (requestDigest, onComplete) {
-        // Process the response
-        var processResponse = function () {
-            // Get the response
-            var context = JSON.parse(xhr.response);
-            // Update the context information
-            lib_1.ContextInfo.updateToken(context.GetContextWebInformation.FormDigestValue, context.GetContextWebInformation.FormDigestTimeoutSeconds);
-        };
-        // Create the request
-        var xhr = this.createXHR();
-        var url = (this.targetInfo.props.url || lib_1.ContextInfo.webAbsoluteUrl) + "/_api/context";
-        xhr.open("POST", url, onComplete ? true : false);
-        // Set the headers
-        xhr.setRequestHeader("Accept", "application/json");
-        xhr.setRequestHeader("Content-Type", "application/json");
-        xhr.setRequestHeader("X-RequestDigest", requestDigest);
-        xhr.setRequestHeader("X-HTTP-Method", "POST");
-        // See if we are making an asynchronous request
-        if (onComplete) {
-            // Set the state change event
-            xhr.onreadystatechange = function () {
-                // See if the request has finished
-                if (xhr.readyState == 4) {
-                    // Update the context information
-                    processResponse();
-                    // Call the complete method
-                    onComplete();
-                }
-            };
-            // Execute the request
-            xhr.send();
-        }
-        else {
-            // Execute the request
-            xhr.send();
-            // Process the response
-            processResponse();
-        }
-    };
     return XHRRequest;
 }());
 exports.XHRRequest = XHRRequest;

package/dist/gd-sprest.d.ts

@@ -959,6 +959,11 @@ declare module 'gd-sprest/lib/contextInfo' {
             };
     
     
+            /**
+                * Runs a loop to ensure the digest value doesn't expire.
+                */
+            enableRefreshToken();
+    
             /**
                 * Generates a guid.
                 * @returns A GUID as a string value.
@@ -978,19 +983,6 @@ declare module 'gd-sprest/lib/contextInfo' {
                 * @param spfxPageContext - The page context information variable from a SPFx project.
                 */
             setPageContext(spfxPageContext: any);
-    
-            /**
-                * Updates the form digest context information.
-                * @param digestValue The form digest value.
-                * @param timeout The timeout value in seconds.
-                */
-            updateToken(digestValue: string, timeout: number);
-    
-            /**
-                * Validates the date/time of a form digest value to ensure it's still valid.
-                * @param digestValue The request digest form value. The default context info for the page is used, if a value isn't given.
-                */
-            validateToken(digestValue?: string): boolean;
     }
     
     export interface IThemeState {