gd-sprest 9.7.8 → 9.7.9

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

@@ -1,4 +1,4 @@
-import { IBaseExecution } from "gd-sprest-def/lib/base";
+import { IBaseExecution, IRateLimit } from "gd-sprest-def/lib/base";
 import { BasePermissions, ContextWebInformation } from "gd-sprest-def/lib/SP/complextypes";
 
 /**
@@ -284,6 +284,9 @@ export interface IContextInformation {
     /** Publishing Feature On */
     PublishingFeatureOn: boolean;
 
+    /** The last rate limit information for a request. */
+    rateLimit?: IRateLimit & { requestTime: number; }
+
     /** Recycle Bin Item Count */
     RecycleBinItemCount: number;
 
@@ -464,6 +467,11 @@ export interface IContextInformation {
      * Methods
      */
 
+    /**
+     * Clears the callback events for the rate limit.
+     */
+    clearRateLimitCallbacks();
+
     /**
      * Runs a loop to ensure the digest value doesn't expire.
      */
@@ -483,6 +491,12 @@ export interface IContextInformation {
      */
     getWeb(url: string): IBaseExecution<{ GetContextWebInformation: ContextWebInformation }>;
 
+    /**
+     * Event triggered when the rate limit information is set.
+     * @param callback The method to execute when the rate limit value is set.
+     */
+    onRateLimitDetected(callback: (rateLimit: IRateLimit) => void);
+
     /**
      * Value in minutes, to refresh the token prior to it expiring
      */
@@ -493,6 +507,12 @@ export interface IContextInformation {
      * @param spfxPageContext - The page context information variable from a SPFx project.
      */
     setPageContext(spfxPageContext: any);
+
+    /**
+     * Sets the rate limit information from the last request containing it.
+     * @param rateLimit The rate limit information from the request.
+     */
+    setRateLimit(rateLimit: IRateLimit);
 }
 
 // Theme State

package/@types/utils/xhrRequest.d.ts

@@ -1,3 +1,4 @@
+import { IRateLimit } from "gd-sprest-def/base";
 import { ITargetInfo } from "./targetInfo";
 
 /**
@@ -18,6 +19,9 @@ export interface IXHRRequest {
     // Flag indicating if this is a graph request
     isGraph: boolean;
 
+    // The rate limit information
+    rateLimit?: IRateLimit;
+
     // The response
     response: string;
 

package/build/lib/contextInfo.js

@@ -191,6 +191,11 @@ class _ContextInfo {
             url
         });
     }
+    static clearRateLimitCallbacks() { this._onRateLimitCallbacks = []; }
+    static onRateLimitDetected(callback) {
+        // Add the event
+        this._onRateLimitCallbacks.push(callback);
+    }
     static enableRefreshToken(callback) {
         let isRunning = false;
         // Set the refresh event
@@ -308,6 +313,8 @@ class _ContextInfo {
 _a = _ContextInfo;
 // The page context information from an spfx project
 _ContextInfo._spfxPageContext = null;
+// Method to add an event
+_ContextInfo._onRateLimitCallbacks = [];
 // Method to set the page context information from an SPFX project
 _ContextInfo.setPageContext = (spfxPageContext) => {
     // Set the page context information
@@ -315,6 +322,17 @@ _ContextInfo.setPageContext = (spfxPageContext) => {
     // Enable the refresh token
     _a.enableRefreshToken();
 };
+// Method to set the rate limit value
+_ContextInfo.setRateLimit = (rateLimit) => {
+    // Ensure a value exists
+    if (rateLimit) {
+        // Set the rate limit information
+        ContextInfo.rateLimit = rateLimit;
+        ContextInfo.rateLimit.requestTime = Date.now();
+        // Call the events
+        _a._onRateLimitCallbacks.forEach(callback => { callback(rateLimit); });
+    }
+};
 _ContextInfo._worker = null;
 _ContextInfo._onRefresh = [];
 // Value in minutes to refresh the token

package/build/rest.js

@@ -6,7 +6,7 @@ import { GraphTypes, SPTypes } from "./sptypes";
  * SharePoint REST Library
  */
 export const $REST = {
-    __ver: 9.78,
+    __ver: 9.79,
     AppContext: (siteUrl) => { return Lib.Site.getAppContext(siteUrl); },
     Apps: Lib.Apps,
     ContextInfo: Lib.ContextInfo,

package/build/utils/request.js

@@ -347,10 +347,16 @@ export const Request = {
                 else {
                     // Create the request
                     base.xhr = new XHRRequest(asyncFl, targetInfo, () => {
-                        // Update the response and status
+                        // Update the base properties
+                        base.rateLimit = base.xhr.rateLimit;
                         base.response = base.xhr.response;
                         base.status = base.xhr.status;
                         let errorFl = !(base.status >= 200 && base.status < 300);
+                        // See if a rate limit exists
+                        if (base.rateLimit) {
+                            // Set the context information
+                            ContextInfo.setRateLimit(base.rateLimit);
+                        }
                         // See if we are returning a file buffer
                         if (base.requestType == RequestType.GetBuffer) {
                             // Execute the callback
@@ -395,9 +401,15 @@ export const Request = {
             else {
                 // Create the request
                 base.xhr = new XHRRequest(asyncFl, targetInfo);
-                // Update the response and status
+                // Update the base properties
+                base.rateLimit = base.xhr.rateLimit;
                 base.response = base.xhr.response;
                 base.status = base.xhr.status;
+                // See if a rate limit exists
+                if (base.rateLimit) {
+                    // Set the context information
+                    ContextInfo.setRateLimit(base.rateLimit);
+                }
                 // See if we are returning a file buffer
                 if (base.requestType == RequestType.GetBuffer) {
                     // Return the response

package/dist/gd-sprest.d.ts

@@ -2838,7 +2838,7 @@ declare module 'gd-sprest/lib/apps' {
 }
 
 declare module 'gd-sprest/lib/contextInfo' {
-    import { IBaseExecution } from "gd-sprest-def/lib/base";
+    import { IBaseExecution, IRateLimit } from "gd-sprest-def/lib/base";
     import { BasePermissions, ContextWebInformation } from "gd-sprest-def/lib/SP/complextypes";
     
     /**
@@ -3121,6 +3121,9 @@ declare module 'gd-sprest/lib/contextInfo' {
             /** Publishing Feature On */
             PublishingFeatureOn: boolean;
     
+            /** The last rate limit information for a request. */
+            rateLimit?: IRateLimit & { requestTime: number; }
+    
             /** Recycle Bin Item Count */
             RecycleBinItemCount: number;
     
@@ -3298,6 +3301,11 @@ declare module 'gd-sprest/lib/contextInfo' {
             };
     
     
+            /**
+                * Clears the callback events for the rate limit.
+                */
+            clearRateLimitCallbacks();
+    
             /**
                 * Runs a loop to ensure the digest value doesn't expire.
                 */
@@ -3317,6 +3325,12 @@ declare module 'gd-sprest/lib/contextInfo' {
                 */
             getWeb(url: string): IBaseExecution<{ GetContextWebInformation: ContextWebInformation }>;
     
+            /**
+                * Event triggered when the rate limit information is set.
+                * @param callback The method to execute when the rate limit value is set.
+                */
+            onRateLimitDetected(callback: (rateLimit: IRateLimit) => void);
+    
             /**
                 * Value in minutes, to refresh the token prior to it expiring
                 */
@@ -3327,6 +3341,12 @@ declare module 'gd-sprest/lib/contextInfo' {
                 * @param spfxPageContext - The page context information variable from a SPFx project.
                 */
             setPageContext(spfxPageContext: any);
+    
+            /**
+                * Sets the rate limit information from the last request containing it.
+                * @param rateLimit The rate limit information from the request.
+                */
+            setRateLimit(rateLimit: IRateLimit);
     }
     
     export interface IThemeState {
@@ -7722,6 +7742,7 @@ declare module 'gd-sprest/utils/targetInfo' {
 }
 
 declare module 'gd-sprest/utils/xhrRequest' {
+    import { IRateLimit } from "gd-sprest-def/base";
     import { ITargetInfo } from "gd-sprest/utils/targetInfo";
     
     /**
@@ -7742,6 +7763,9 @@ declare module 'gd-sprest/utils/xhrRequest' {
             // Flag indicating if this is a graph request
             isGraph: boolean;
     
+            // The rate limit information
+            rateLimit?: IRateLimit;
+    
             // The response
             response: string;