gd-sprest 9.7.6 → 9.7.8

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

@@ -58,9 +58,6 @@ export interface IBase<Type = any, Result = Type, QueryResult = Result> extends
     /** Flag to get all items. */
     getAllItemsFl: boolean;
 
-    /** Time in ms to wait inbetween requests when getting all items. */
-    getAllItemsWaitTime: number;
-
     /** Flag determining if more items exist. */
     nextFl: boolean;
 

package/build/rest.js

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

package/build/utils/helper.js

@@ -124,7 +124,6 @@ export const Helper = {
         // Set the properties
         obj.base = base.base ? base.base : base;
         obj.getAllItemsFl = methodInfo.getAllItemsFl;
-        obj.getAllItemsWaitTime = methodInfo.getAllItemsWaitTime;
         obj.parent = base;
         obj.requestType = methodConfig.requestType;
         // Ensure the return type exists

package/build/utils/methodInfo.js

@@ -28,8 +28,6 @@ export class MethodInfo {
     get body() { return this.methodData; }
     // Flag to determine if we are getting all items
     get getAllItemsFl() { return this.methodInfo.getAllItemsFl; }
-    // Time in ms to wait inbetween requests for getting all items
-    get getAllItemsWaitTime() { return this.methodInfo.getAllItemsWaitTime; }
     // Flag to determine if this method replaces the endpoint
     get replaceEndpointFl() { return this.methodInfo.replaceEndpointFl ? true : false; }
     // The request method
@@ -198,7 +196,6 @@ export class MethodInfo {
             url = "?" + oData.QueryString;
             // Set the get all items Flag
             this.methodInfo.getAllItemsFl = oData.GetAllItems;
-            this.methodInfo.getAllItemsWaitTime = oData.GetAllItemsWaitTime;
         }
         // Else, see if we are not passing the data in the body or query string as a variable
         else if (!this.passDataInBody && !this.passDataInQSAsVar) {

package/build/utils/oData.js

@@ -12,7 +12,6 @@ export class OData {
         this._expand = oData && oData.Expand ? oData.Expand : [];
         this._filter = oData && oData.Filter ? oData.Filter : null;
         this._getAllItems = oData && oData.GetAllItems ? oData.GetAllItems : false;
-        this._getAllItemsWaitTime = oData && oData.GetAllItemsWaitTime ? oData.GetAllItemsWaitTime : 0;
         this._orderBy = oData && oData.OrderBy ? oData.OrderBy : [];
         this._search = oData && oData.Search ? oData.Search : null;
         this._select = oData && oData.Select ? oData.Select : [];
@@ -35,9 +34,6 @@ export class OData {
     // Flag to get all items
     get GetAllItems() { return this._getAllItems; }
     set GetAllItems(value) { this._getAllItems = value; }
-    // Time in ms to wait between calls to avoid throttling
-    get GetAllItemsWaitTime() { return this._getAllItemsWaitTime; }
-    set GetAllItemsWaitTime(value) { this._getAllItemsWaitTime = value; }
     // Order By
     get OrderBy() { return this._orderBy; }
     set OrderBy(value) { this._orderBy = value; }

package/build/utils/request.js

@@ -698,6 +698,14 @@ export const Request = {
                             targetInfo.accessToken = base.targetInfo.accessToken || (base.xhr.isGraph ? Graph.Token : null);
                             targetInfo.endpoint = "";
                             targetInfo.url = data["@odata.nextLink"] || data.d.__next;
+                            // Set the sleep value to prevent throttling
+                            let sleepInMS = 0;
+                            if (xhr.rateLimit && xhr.rateLimit.remaining < 50) {
+                                // Set the rate
+                                sleepInMS = xhr.rateLimit.reset * 1000;
+                                // Log
+                                console.info("[gd-sprest] Throttle approaching... Waiting " + sleepInMS + "ms before sending the next request.", xhr.rateLimit);
+                            }
                             // Wait before we execute the call
                             setTimeout(() => {
                                 // Create a new object
@@ -713,6 +721,8 @@ export const Request = {
                                             // Update the expanded properties
                                             Helper.updateExpandedProperties(base);
                                         }
+                                        // Set the rate limit information
+                                        base.rateLimit = xhr.rateLimit;
                                         // Append the raw data results
                                         if ((_b = base["d"]) === null || _b === void 0 ? void 0 : _b.results) {
                                             base["d"].results = base["d"].results.concat(data.d.results);
@@ -728,7 +738,7 @@ export const Request = {
                                         resolve();
                                     }
                                 });
-                            }, typeof (base.getAllItemsWaitTime) === "number" ? base.getAllItemsWaitTime : 0);
+                            }, sleepInMS);
                         }
                         else {
                             // Add a method to get the next set of results

package/build/utils/xhrRequest.js

@@ -33,12 +33,27 @@ export class XHRRequest {
     get isGraph() { return this.targetInfo.isGraph; }
     // Flag indicating the request has completed
     get completedFl() { return this.xhr ? this.xhr.readyState == 4 : false; }
+    // Gets a response header
+    getResponseHeader(key) { return this.xhr ? this.xhr.getResponseHeader(key) : ""; }
     // The response
     get response() { return this.xhr ? this.xhr.response : null; }
     // The xml http request
     get request() { return this.xhr ? this.xhr : null; }
     // The data send in the body of the request
     get requestData() { return this.targetInfo.requestData; }
+    // Return the rate limit information
+    get rateLimit() {
+        // Ensure the rate limit information exists
+        if (this.xhr == null || this.getResponseHeader("RateLimit-Limit") == null) {
+            return null;
+        }
+        // Return the rate limit information
+        return {
+            limit: this.getResponseHeader("RateLimit-Limit"),
+            remaining: parseInt(this.getResponseHeader("RateLimit-Remaining")),
+            reset: parseInt(this.getResponseHeader("RateLimit-Reset"))
+        };
+    }
     // The request headers
     get requestHeaders() { return this.headers; }
     // The request information

package/dist/gd-sprest.d.ts

@@ -7439,9 +7439,6 @@ declare module 'gd-sprest/utils/base' {
             /** Flag to get all items. */
             getAllItemsFl: boolean;
     
-            /** Time in ms to wait inbetween requests when getting all items. */
-            getAllItemsWaitTime: number;
-    
             /** Flag determining if more items exist. */
             nextFl: boolean;