gd-sprest 7.0.0 → 7.0.3

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

@@ -18,7 +18,7 @@ export interface IBase<Type = any, Result = Type, QueryResult = Result> extends
      */
 
     /** The batch requests. */
-    batchRequests: Array<Array<{ callback?: any, response?: IBase, targetInfo: ITargetInfo }>>;
+    batchRequests: Array<Array<IBatchRequest>>;
 
     /** The index of this object in the responses array. */
     responseIndex: number;

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

@@ -0,0 +1,12 @@
+import { IBase } from "./base";
+import { ITargetInfo } from "./targetInfo";
+
+/**
+ * Batch Request
+ */
+export interface IBatchRequest {
+    callback?: any;
+    changesetId?: string;
+    response?: IBase;
+    targetInfo: ITargetInfo;
+}

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

@@ -1,4 +1,5 @@
 export * from "./base";
+export * from "./batch";
 export * from "./helper";
 export * from "./request";
 export * from "./requestType";

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

@@ -20,7 +20,7 @@ export interface IRequest {
     parseXML(xml: string): IBase;
 
     /** Updates the data object. */
-    updateDataObject(base: IBase, isBatchRequest: boolean, batchCallback?: (batchResponses: Array<any>) => void);
+    updateDataObject(base: IBase, isBatchRequest: boolean, batchIdx: number, batchCallback?: (batchResponses: Array<any>) => void);
 
     /** Validates the data collection results. */
     validateDataCollectionResults(base: IBase): PromiseLike<void>;

package/build/mapper/def.js

@@ -6,6 +6,7 @@ exports.Mapper = {
     "MS.FileServices.File": {
         copyTo: {
             argNames: ["target", "overwrite"],
+            requestType: utils_1.RequestType.PostWithArgs
         },
         delete: {
             requestType: utils_1.RequestType.Delete
@@ -69,6 +70,7 @@ exports.Mapper = {
     "Microsoft.Office.Server.ContentCenter.SPMachineLearningModel": {
         copy: {
             argNames: ["copyTo"],
+            requestType: utils_1.RequestType.PostWithArgs
         },
         delete: {},
         importMeta: {},
@@ -1466,6 +1468,7 @@ exports.Mapper = {
     "PS.Calendar": {
         copyTo: {
             argNames: ["name"],
+            requestType: utils_1.RequestType.PostWithArgs
         },
         delete: {
             requestType: utils_1.RequestType.Delete
@@ -4427,9 +4430,12 @@ exports.Mapper = {
         },
         checkOut: {},
         checkoutPage: {},
-        copy: {},
+        copy: {
+            requestType: utils_1.RequestType.Post
+        },
         copyWithConfiguration: {
             argNames: ["sitePageFlags", "isNews"],
+            requestType: utils_1.RequestType.Post
         },
         createNewsCopy: {},
         demoteFromNews: {},
@@ -4565,9 +4571,12 @@ exports.Mapper = {
         },
         checkOut: {},
         checkoutPage: {},
-        copy: {},
+        copy: {
+            requestType: utils_1.RequestType.Post
+        },
         copyWithConfiguration: {
             argNames: ["sitePageFlags", "isNews"],
+            requestType: utils_1.RequestType.Post
         },
         createNewsCopy: {},
         demoteFromNews: {},
@@ -4645,7 +4654,7 @@ exports.Mapper = {
             requestType: utils_1.RequestType.Post
         },
         copy: {
-            requestType: utils_1.RequestType.Post
+            requestType: utils_1.RequestType.PostWithArgs
         },
         copyWithConfiguration: {
             argNames: ["sitePageFlags", "isNews"],
@@ -4752,7 +4761,9 @@ exports.Mapper = {
         },
         checkOut: {},
         checkoutPage: {},
-        copy: {},
+        copy: {
+            requestType: utils_1.RequestType.Post
+        },
         copyWithConfiguration: {
             argNames: ["sitePageFlags", "isNews"],
         },
@@ -4870,7 +4881,9 @@ exports.Mapper = {
         },
         checkOut: {},
         checkoutPage: {},
-        copy: {},
+        copy: {
+            requestType: utils_1.RequestType.Post
+        },
         copyWithConfiguration: {
             argNames: ["sitePageFlags", "isNews"],
         },

package/build/rest.js

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

package/build/utils/batch.js

@@ -11,7 +11,7 @@ var Batch = /** @class */ (function () {
     }
     // Method to execute a batch request
     Batch.execute = function (base, args) {
-        var appendFl = false;
+        var createFl = false;
         var callback = null;
         // Parse the arguments
         for (var i = 0; i < args.length; i++) {
@@ -19,8 +19,8 @@ var Batch = /** @class */ (function () {
             // Check the type
             switch (typeof (arg)) {
                 case "boolean":
-                    // Set the append flag
-                    appendFl = arg;
+                    // Set the create flag
+                    createFl = arg;
                     break;
                 case "function":
                     // Set the callback method
@@ -30,39 +30,39 @@ var Batch = /** @class */ (function () {
         }
         // Set the base
         base.base = base.base ? base.base : base;
-        // See if we are appending this request
-        if (appendFl && base.base.batchRequests) {
-            // Append the request
-            base.base.batchRequests[base.base.batchRequests.length - 1].push({
-                callback: callback,
-                targetInfo: new _1.TargetInfo(base.targetInfo)
-            });
-        }
-        else {
+        // See if we are creating a new request
+        if (createFl || base.base.batchRequests == null) {
             // Ensure the batch requests exist
             base.base.batchRequests = base.base.batchRequests || [];
             // Create the request
             base.base.batchRequests.push([{
                     callback: callback,
+                    changesetId: lib_1.ContextInfo.generateGUID(),
                     targetInfo: new _1.TargetInfo(base.targetInfo)
                 }]);
         }
+        else {
+            // Append the request
+            base.base.batchRequests[base.base.batchRequests.length - 1].push({
+                callback: callback,
+                changesetId: lib_1.ContextInfo.generateGUID(),
+                targetInfo: new _1.TargetInfo(base.targetInfo)
+            });
+        }
         // Return this object
         return base;
     };
     // Method to generate a batch request
-    Batch.getTargetInfo = function (requests) {
+    Batch.getTargetInfo = function (url, requests) {
         var batchId = "batch_" + lib_1.ContextInfo.generateGUID();
         var batchRequests = [];
-        // Parse the requests
-        for (var i = 0; i < requests.length; i++) {
-            // Create the batch request
-            batchRequests.push(Batch.createBatch(batchId, requests[i]));
-        }
+        // Create the batch request
+        batchRequests.push(Batch.createBatch(batchId, requests));
         // End the batch request
         batchRequests.push("--" + batchId + "--");
-        // Return the target info
+        // Return the target information
         return new _1.TargetInfo({
+            url: url,
             endpoint: "$batch",
             method: "POST",
             data: batchRequests.join("\r\n"),
@@ -82,11 +82,10 @@ var Batch = /** @class */ (function () {
             // Determine if the batch requires a change set
             var requiresChangeset = request_1 && request_1.targetInfo.requestMethod != "GET";
             if (requiresChangeset) {
-                var changesetId = "changeset_" + lib_1.ContextInfo.generateGUID();
                 // Create a change set
-                batch.push("Content-Type: multipart/mixed; boundary=" + changesetId);
+                batch.push("Content-Type: multipart/mixed; boundary=" + request_1.changesetId);
                 batch.push("");
-                batch.push("--" + changesetId);
+                batch.push("--" + request_1.changesetId);
                 batch.push("Content-Type: application/http");
                 batch.push("Content-Transfer-Encoding: binary");
                 batch.push("");
@@ -95,7 +94,7 @@ var Batch = /** @class */ (function () {
                 batch.push("");
                 request_1.targetInfo.requestData ? batch.push(request_1.targetInfo.requestData) : null;
                 batch.push("");
-                batch.push("--" + changesetId + "--");
+                batch.push("--" + request_1.changesetId + "--");
             }
             else {
                 // Create a change set
@@ -121,19 +120,15 @@ var Batch = /** @class */ (function () {
         return request.join("\r\n");
     };
     // Process the batch request callbacks
-    Batch.processCallbacks = function (requests) {
-        if (requests === void 0) { requests = []; }
+    Batch.processCallbacks = function (batchRequests) {
+        if (batchRequests === void 0) { batchRequests = []; }
         // Parse the requests
-        for (var i = 0; i < requests.length; i++) {
-            var request = requests[i];
-            // Parse the batch request
-            for (var j = 0; j < request.length; j++) {
-                var batchRequest = request[j];
-                // See if a callback exists
-                if (batchRequest.callback) {
-                    // Execute the callback
-                    batchRequest.callback(batchRequest.response, batchRequest.targetInfo);
-                }
+        for (var i = 0; i < batchRequests.length; i++) {
+            var batchRequest = batchRequests[i];
+            // See if a callback exists
+            if (batchRequest.callback) {
+                // Execute the callback
+                batchRequest.callback(batchRequest.response, batchRequest.targetInfo);
             }
         }
     };

package/build/utils/request.js

@@ -4,6 +4,7 @@ exports.Request = void 0;
 var base_1 = require("./base");
 var batch_1 = require("./batch");
 var lib_1 = require("../lib");
+var executor_1 = require("../helper/executor");
 var helper_1 = require("./helper");
 var mapper_1 = require("../mapper");
 var requestType_1 = require("./requestType");
@@ -288,81 +289,109 @@ exports.Request = {
     },
     // Method to execute the request
     executeRequest: function (base, asyncFl, callback) {
-        var isBatchRequest = base.base && base.base.batchRequests && base.base.batchRequests.length > 0;
-        var targetInfo = isBatchRequest ? batch_1.Batch.getTargetInfo(base.base.batchRequests) : new targetInfo_1.TargetInfo(base.targetInfo);
-        // See if this is an asynchronous request
-        if (asyncFl) {
-            // See if the not a batch request, and it already exists
-            if (base.xhr && !isBatchRequest) {
-                // Execute the callback
-                callback ? callback(base, false) : null;
-            }
-            else {
-                // Create the request
-                base.xhr = new xhrRequest_1.XHRRequest(asyncFl, targetInfo, function () {
-                    // Update the response and status
-                    base.response = base.xhr.response;
-                    base.status = base.xhr.status;
-                    var errorFl = !(base.status >= 200 && base.status < 300);
-                    // See if we are returning a file buffer
-                    if (base.requestType == requestType_1.RequestType.GetBuffer) {
-                        // Execute the callback
-                        callback ? callback(base.response, errorFl) : null;
-                    }
-                    else {
-                        // Update the data object
-                        exports.Request.updateDataObject(base, isBatchRequest, callback);
-                        // Ensure this isn't a batch request
-                        if (!isBatchRequest) {
-                            // See if this is an xml response
-                            if (base.xml) {
-                                // Execute the callback
-                                callback ? callback(base, errorFl) : null;
-                            }
-                            else {
-                                // Validate the data collection
-                                exports.Request.validateDataCollectionResults(base).then(
-                                // Success
-                                function () {
+        // Execution method
+        var execute = function (targetInfo, batchIdx, onComplete) {
+            // See if this is an asynchronous request
+            if (asyncFl) {
+                // See if the not a batch request, and it already exists
+                if (base.xhr && !isBatchRequest) {
+                    // Execute the callback
+                    callback ? callback(base, false) : null;
+                }
+                else {
+                    // Create the request
+                    base.xhr = new xhrRequest_1.XHRRequest(asyncFl, targetInfo, function () {
+                        // Update the response and status
+                        base.response = base.xhr.response;
+                        base.status = base.xhr.status;
+                        var errorFl = !(base.status >= 200 && base.status < 300);
+                        // See if we are returning a file buffer
+                        if (base.requestType == requestType_1.RequestType.GetBuffer) {
+                            // Execute the callback
+                            callback ? callback(base.response, errorFl) : null;
+                        }
+                        else {
+                            // Update the data object
+                            exports.Request.updateDataObject(base, isBatchRequest, batchIdx, callback);
+                            // Ensure this isn't a batch request
+                            if (!isBatchRequest) {
+                                // See if this is an xml response
+                                if (base.xml) {
                                     // Execute the callback
                                     callback ? callback(base, errorFl) : null;
-                                }, 
-                                // Error
-                                function () {
-                                    // Execute the callback and set the error flag
-                                    callback ? callback(base, true) : null;
-                                });
+                                }
+                                else {
+                                    // Validate the data collection
+                                    exports.Request.validateDataCollectionResults(base).then(
+                                    // Success
+                                    function () {
+                                        // Execute the callback
+                                        callback ? callback(base, errorFl) : null;
+                                    }, 
+                                    // Error
+                                    function () {
+                                        // Execute the callback and set the error flag
+                                        callback ? callback(base, true) : null;
+                                    });
+                                }
                             }
                         }
-                    }
-                });
+                        // Call the event
+                        onComplete ? onComplete() : null;
+                    });
+                }
             }
-        }
-        // Else, see if we already executed this request
-        else if (base.xhr) {
-            return base;
-        }
-        // Else, we haven't executed this request
-        else {
-            // Create the request
-            base.xhr = new xhrRequest_1.XHRRequest(asyncFl, targetInfo);
-            // Update the response and status
-            base.response = base.xhr.response;
-            base.status = base.xhr.status;
-            // See if we are returning a file buffer
-            if (base.requestType == requestType_1.RequestType.GetBuffer) {
-                // Return the response
-                return base.response;
+            // Else, see if we already executed this request
+            else if (base.xhr) {
+                return base;
             }
-            // Update the base object
-            exports.Request.updateDataObject(base, isBatchRequest, callback);
-            // See if the base is a collection and has more results
-            if (base["d"] && base["d"].__next) {
-                // Add the "next" method to get the next set of results
-                base["next"] = new Function("return this.getNextSetOfResults();");
+            // Else, we haven't executed this request
+            else {
+                // Create the request
+                base.xhr = new xhrRequest_1.XHRRequest(asyncFl, targetInfo);
+                // Update the response and status
+                base.response = base.xhr.response;
+                base.status = base.xhr.status;
+                // See if we are returning a file buffer
+                if (base.requestType == requestType_1.RequestType.GetBuffer) {
+                    // Return the response
+                    return base.response;
+                }
+                // Update the base object
+                exports.Request.updateDataObject(base, isBatchRequest, batchIdx, callback);
+                // See if the base is a collection and has more results
+                if (base["d"] && base["d"].__next) {
+                    // Add the "next" method to get the next set of results
+                    base["next"] = new Function("return this.getNextSetOfResults();");
+                }
+                // Call the event
+                onComplete ? onComplete() : null;
+                // Return the base object
+                return base;
             }
-            // Return the base object
-            return base;
+        };
+        // See if this is a batch request
+        var isBatchRequest = base.base && base.base.batchRequests && base.base.batchRequests.length > 0;
+        if (isBatchRequest) {
+            var batchIdx_1 = 0;
+            // Parse the requests
+            executor_1.Executor(base.base.batchRequests, function (batchRequest) {
+                // Return a promise
+                return new Promise(function (resolve) {
+                    // Execute the request
+                    execute(batch_1.Batch.getTargetInfo(base.targetInfo.url, batchRequest), batchIdx_1++, function () {
+                        // Resolve the request
+                        resolve(null);
+                    });
+                });
+            }).then(function () {
+                // Clear the batch requests
+                base.base.batchRequests = null;
+            });
+        }
+        else {
+            // Execute the request
+            return execute(new targetInfo_1.TargetInfo(base.targetInfo));
         }
     },
     // Method to parse the xml
@@ -419,8 +448,9 @@ exports.Request = {
         return objData;
     },
     // Method to convert the input arguments into an object
-    updateDataObject: function (base, isBatchRequest, batchCallback) {
+    updateDataObject: function (base, isBatchRequest, batchIdx, batchCallback) {
         if (isBatchRequest === void 0) { isBatchRequest = false; }
+        if (batchIdx === void 0) { batchIdx = 0; }
         // Ensure the request was successful
         if (base.status >= 200 && base.status < 300) {
             // Return if we are expecting a buffer
@@ -428,7 +458,6 @@ exports.Request = {
                 return;
             }
             // Parse the responses
-            var batchIdx = 0;
             var batchRequestIdx = 0;
             var responses = isBatchRequest ? base.response.split("\n") : [base.response];
             for (var i = 0; i < responses.length; i++) {
@@ -532,11 +561,9 @@ exports.Request = {
             // See if this was a batch request
             if (isBatchRequest) {
                 // Process the callbacks
-                batch_1.Batch.processCallbacks(base.base.batchRequests);
+                batch_1.Batch.processCallbacks(base.base.batchRequests[batchIdx]);
                 // Execute the callback if it exists
                 batchCallback ? batchCallback(base.base.batchRequests) : null;
-                // Clear the batch requests
-                base.base.batchRequests = null;
             }
         }
     },

package/dist/gd-sprest.d.ts

@@ -5672,6 +5672,7 @@ declare module 'gd-sprest/intellisense/webTemplateExtensions' {
 
 declare module 'gd-sprest/utils' {
     export * from "gd-sprest/utils/base";
+    export * from "gd-sprest/utils/batch";
     export * from "gd-sprest/utils/helper";
     export * from "gd-sprest/utils/request";
     export * from "gd-sprest/utils/requestType";
@@ -6254,7 +6255,7 @@ declare module 'gd-sprest/utils/base' {
     
     
             /** The batch requests. */
-            batchRequests: Array<Array<{ callback?: any, response?: IBase, targetInfo: ITargetInfo }>>;
+            batchRequests: Array<Array<IBatchRequest>>;
     
             /** The index of this object in the responses array. */
             responseIndex: number;
@@ -6313,6 +6314,21 @@ declare module 'gd-sprest/utils/base' {
     }
 }
 
+declare module 'gd-sprest/utils/batch' {
+    import { IBase } from "gd-sprest/utils/base";
+    import { ITargetInfo } from "gd-sprest/utils/targetInfo";
+    
+    /**
+      * Batch Request
+      */
+    export interface IBatchRequest {
+        callback?: any;
+        changesetId?: string;
+        response?: IBase;
+        targetInfo: ITargetInfo;
+    }
+}
+
 declare module 'gd-sprest/utils/helper' {
     import { IMethodInfo, IRequestInfo } from "gd-sprest-def/lib/base";
     import { IBase } from "gd-sprest/utils/base";
@@ -6386,7 +6402,7 @@ declare module 'gd-sprest/utils/request' {
         parseXML(xml: string): IBase;
     
         /** Updates the data object. */
-        updateDataObject(base: IBase, isBatchRequest: boolean, batchCallback?: (batchResponses: Array<any>) => void);
+        updateDataObject(base: IBase, isBatchRequest: boolean, batchIdx: number, batchCallback?: (batchResponses: Array<any>) => void);
     
         /** Validates the data collection results. */
         validateDataCollectionResults(base: IBase): PromiseLike<void>;