gd-sprest 9.6.9 → 9.7.1

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

@@ -26,6 +26,9 @@ export interface IBase<Type = any, Result = Type, QueryResult = Result> extends
     /** The responses. */
     responses: Array<IBase>;
 
+    /** The flag to stop any requests for a query or batch request. */
+    stopFl: boolean;
+
     /** The wait flags. */
     waitFlags: Array<boolean>;
 
@@ -73,6 +76,12 @@ export interface IBase<Type = any, Result = Type, QueryResult = Result> extends
     /** Gets the property. */
     getProperty(propertyName: string, requestType?: string);
 
+    /** Returns the root base object. */
+    root(): IBase;
+
+    /** Stops any requests for a batch or query. */
+    stop();
+
     /** Updates the metdata uri. */
     updateMetadataUri(metadata, targetInfo: ITargetInfoProps);
 

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

@@ -86,6 +86,9 @@ export interface ITargetInfoProps {
     /** The request type. */
     requestType?: number;
 
+    /** The property that contains the request response. */
+    returnProp?: string;
+
     /** The url of the site/web to execute the request against. */
     url?: string;
 }

package/build/mapper/def.js

@@ -3796,6 +3796,7 @@ exports.Mapper = {
         },
         validateGroupName: {
             argNames: ["displayName", "alias"],
+            returnProp: "ValidateGroupName"
         },
     },
     "SP.Directory.Group": {
@@ -5315,6 +5316,7 @@ exports.Mapper = {
         getUserEffectivePermissions: {
             argNames: ["userName"],
             name: "getUserEffectivePermissions(@user)?@user='[[userName]]'",
+            returnProp: "GetUserEffectivePermissions",
             requestType: utils_1.RequestType.GetReplace
         },
         getView: {
@@ -5552,6 +5554,7 @@ exports.Mapper = {
         getUserEffectivePermissions: {
             argNames: ["userName"],
             name: "getUserEffectivePermissions(@user)?@user='[[userName]]'",
+            returnProp: "GetUserEffectivePermissions",
             requestType: utils_1.RequestType.GetReplace
         },
         getVersionById: {
@@ -8521,6 +8524,7 @@ exports.Mapper = {
         getUserEffectivePermissions: {
             argNames: ["userName"],
             name: "getUserEffectivePermissions(@user)?@user='[[userName]]'",
+            returnProp: "GetUserEffectivePermissions",
             requestType: utils_1.RequestType.GetReplace
         },
         getViewFromPath: {
@@ -9012,6 +9016,7 @@ exports.Mapper = {
         getUserEffectivePermissions: {
             argNames: ["userName"],
             name: "getUserEffectivePermissions(@user)?@user='[[userName]]'",
+            returnProp: "GetUserEffectivePermissions",
             requestType: utils_1.RequestType.GetReplace
         },
         getVersionById: {

package/build/rest.js

@@ -9,7 +9,7 @@ var sptypes_1 = require("./sptypes");
  * SharePoint REST Library
  */
 exports.$REST = {
-    __ver: 9.69,
+    __ver: 9.71,
     AppContext: function (siteUrl) { return Lib.Site.getAppContext(siteUrl); },
     Apps: Lib.Apps,
     ContextInfo: Lib.ContextInfo,

package/build/utils/base.js

@@ -52,6 +52,12 @@ var Base = /** @class */ (function () {
     Base.prototype.getProperty = function (propertyName, requestType) { return _1.Helper.getProperty(this, propertyName, requestType); };
     // Method to get the request digest value
     Base.prototype.getRequestDigest = function () { return this.targetInfo.requestDigest; };
+    // Returns the root base object
+    Base.prototype.root = function () { var root = this; while (root.parent) {
+        root = root.parent;
+    } return root; };
+    // Method to stop any requests related to getting all items with the query
+    Base.prototype.stop = function () { this.stopFl = true; };
     // Method to stringify the object
     Base.prototype.stringify = function () { return _1.Helper.stringify(this); };
     // Method to update the metadata uri

package/build/utils/helper.js

@@ -21,6 +21,8 @@ exports.Helper = {
         obj["getCollection"] = base.getCollection;
         obj["getProperty"] = base.getProperty;
         obj["parent"] = base;
+        obj["root"] = base.root;
+        obj["stop"] = base.stop;
         obj["targetInfo"] = base.targetInfo;
         obj["updateMetadataUri"] = base.updateMetadataUri;
         obj["waitForRequestsToComplete"] = base.waitForRequestsToComplete;
@@ -91,6 +93,7 @@ exports.Helper = {
         targetInfo.method = methodInfo.requestMethod;
         targetInfo.requestDigest = typeof (targetInfo.requestDigest) === "undefined" && base.base && base.base.targetInfo.requestDigest ? base.base.targetInfo.requestDigest : targetInfo.requestDigest;
         targetInfo.requestType = methodConfig.requestType;
+        targetInfo.returnProp = methodConfig.returnProp;
         // See if we are appending the endpoint
         if (methodInfo.appendEndpointFl) {
             // Append to the endpoint

package/build/utils/request.js

@@ -217,6 +217,13 @@ exports.Request = {
                 }
             }
         }
+        // See if a return property was set and value exists
+        if (base.targetInfo.returnProp && data[base.targetInfo.returnProp]) {
+            // Parse the data properties
+            for (var key in data[base.targetInfo.returnProp]) {
+                base[key] = data[base.targetInfo.returnProp][key];
+            }
+        }
     },
     // Method to execute the request
     execute: function (base, args) {
@@ -428,8 +435,13 @@ exports.Request = {
         var isBatchRequest = base.base && base.base.batchRequests && base.base.batchRequests.length > 0;
         if (isBatchRequest) {
             var batchIdx_1 = 0;
+            var root_1 = base.root();
             // Parse the requests
             (0, executor_1.Executor)(base.base.batchRequests, function (batchRequest) {
+                // Do nothing if the stop flag is set
+                if (root_1.stopFl) {
+                    return;
+                }
                 // Return a promise
                 return new Promise(function (resolve) {
                     // Execute the request
@@ -695,8 +707,10 @@ exports.Request = {
                     }
                     // See if there are more items to get
                     if (base.nextFl) {
+                        // Get the root base object
+                        var root = base.root();
                         // See if we are getting all items in the base request
-                        if (base.getAllItemsFl) {
+                        if (base.getAllItemsFl && root.stopFl != true) {
                             // Create the target information to query the next set of results
                             var targetInfo = Object.create(base.targetInfo);
                             targetInfo.accessToken = base.targetInfo.accessToken || (base.xhr.isGraph ? lib_1.Graph.Token : null);

package/dist/gd-sprest.d.ts

@@ -7413,6 +7413,9 @@ declare module 'gd-sprest/utils/base' {
             /** The responses. */
             responses: Array<IBase>;
     
+            /** The flag to stop any requests for a query or batch request. */
+            stopFl: boolean;
+    
             /** The wait flags. */
             waitFlags: Array<boolean>;
     
@@ -7454,6 +7457,12 @@ declare module 'gd-sprest/utils/base' {
             /** Gets the property. */
             getProperty(propertyName: string, requestType?: string);
     
+            /** Returns the root base object. */
+            root(): IBase;
+    
+            /** Stops any requests for a batch or query. */
+            stop();
+    
             /** Updates the metdata uri. */
             updateMetadataUri(metadata, targetInfo: ITargetInfoProps);
     
@@ -7707,6 +7716,9 @@ declare module 'gd-sprest/utils/targetInfo' {
             /** The request type. */
             requestType?: number;
     
+            /** The property that contains the request response. */
+            returnProp?: string;
+    
             /** The url of the site/web to execute the request against. */
             url?: string;
     }