@pnp/sp 2.10.0 → 2.11.0

package/batch.js

@@ -1,224 +1,224 @@
-import { __awaiter, __extends, __generator } from "tslib";
-import { Batch, HttpRequestError } from "@pnp/odata";
-import { getGUID, isUrlAbsolute, combine, mergeHeaders, hOP, DefaultRuntime } from "@pnp/common";
-import { Logger } from "@pnp/logging";
-import { SPHttpClient } from "./sphttpclient.js";
-import { toAbsoluteUrl } from "./utils/toabsoluteurl.js";
-/**
- * Manages a batch of OData operations
- */
-var SPBatch = /** @class */ (function (_super) {
-    __extends(SPBatch, _super);
-    function SPBatch(url, runtime) {
-        if (runtime === void 0) { runtime = DefaultRuntime; }
-        var _this = _super.call(this) || this;
-        _this.url = url;
-        _this.runtime = runtime;
-        return _this;
-    }
-    /**
-     * Parses the response from a batch request into an array of Response instances
-     *
-     * @param body Text body of the response from the batch request
-     */
-    SPBatch.ParseResponse = function (body) {
-        var responses = [];
-        var header = "--batchresponse_";
-        // Ex. "HTTP/1.1 500 Internal Server Error"
-        var statusRegExp = new RegExp("^HTTP/[0-9.]+ +([0-9]+) +(.*)", "i");
-        var lines = body.split("\n");
-        var state = "batch";
-        var status;
-        var statusText;
-        for (var i = 0; i < lines.length; ++i) {
-            var line = lines[i];
-            switch (state) {
-                case "batch":
-                    if (line.substr(0, header.length) === header) {
-                        state = "batchHeaders";
-                    }
-                    else {
-                        if (line.trim() !== "") {
-                            throw Error("Invalid response, line " + i);
-                        }
-                    }
-                    break;
-                case "batchHeaders":
-                    if (line.trim() === "") {
-                        state = "status";
-                    }
-                    break;
-                case "status": {
-                    var parts = statusRegExp.exec(line);
-                    if (parts.length !== 3) {
-                        throw Error("Invalid status, line " + i);
-                    }
-                    status = parseInt(parts[1], 10);
-                    statusText = parts[2];
-                    state = "statusHeaders";
-                    break;
-                }
-                case "statusHeaders":
-                    if (line.trim() === "") {
-                        state = "body";
-                    }
-                    break;
-                case "body":
-                    responses.push((status === 204) ? new Response() : new Response(line, { status: status, statusText: statusText }));
-                    state = "batch";
-                    break;
-            }
-        }
-        if (state !== "status") {
-            throw Error("Unexpected end of input");
-        }
-        return responses;
-    };
-    SPBatch.prototype.executeImpl = function () {
-        var _a;
-        return __awaiter(this, void 0, void 0, function () {
-            var client, absoluteRequestUrl, batchBody, currentChangeSetId, i, reqInfo, headers, url, method, castHeaders, batchOptions, fetchResponse, text, responses;
-            var _this = this;
-            return __generator(this, function (_b) {
-                switch (_b.label) {
-                    case 0:
-                        Logger.write("[" + this.batchId + "] (" + (new Date()).getTime() + ") Executing batch with " + this.requests.length + " requests.", 1 /* Info */);
-                        // if we don't have any requests, don't bother sending anything
-                        // this could be due to caching further upstream, or just an empty batch
-                        if (this.requests.length < 1) {
-                            Logger.write("Resolving empty batch.", 1 /* Info */);
-                            return [2 /*return*/];
-                        }
-                        client = new SPHttpClient(this.runtime);
-                        return [4 /*yield*/, toAbsoluteUrl(this.url, this.runtime)];
-                    case 1:
-                        absoluteRequestUrl = _b.sent();
-                        batchBody = [];
-                        currentChangeSetId = "";
-                        for (i = 0; i < this.requests.length; i++) {
-                            reqInfo = this.requests[i];
-                            if (reqInfo.method === "GET") {
-                                if (currentChangeSetId.length > 0) {
-                                    // end an existing change set
-                                    batchBody.push("--changeset_" + currentChangeSetId + "--\n\n");
-                                    currentChangeSetId = "";
-                                }
-                                batchBody.push("--batch_" + this.batchId + "\n");
-                            }
-                            else {
-                                if (currentChangeSetId.length < 1) {
-                                    // start new change set
-                                    currentChangeSetId = getGUID();
-                                    batchBody.push("--batch_" + this.batchId + "\n");
-                                    batchBody.push("Content-Type: multipart/mixed; boundary=\"changeset_" + currentChangeSetId + "\"\n\n");
-                                }
-                                batchBody.push("--changeset_" + currentChangeSetId + "\n");
-                            }
-                            // common batch part prefix
-                            batchBody.push("Content-Type: application/http\n");
-                            batchBody.push("Content-Transfer-Encoding: binary\n\n");
-                            headers = new Headers();
-                            url = isUrlAbsolute(reqInfo.url) ? reqInfo.url : combine(absoluteRequestUrl, reqInfo.url);
-                            Logger.write("[" + this.batchId + "] (" + (new Date()).getTime() + ") Adding request " + reqInfo.method + " " + url + " to batch.", 0 /* Verbose */);
-                            if (reqInfo.method !== "GET") {
-                                method = reqInfo.method;
-                                castHeaders = reqInfo.options.headers;
-                                if (hOP(reqInfo, "options") && hOP(reqInfo.options, "headers") && castHeaders["X-HTTP-Method"] !== undefined) {
-                                    method = castHeaders["X-HTTP-Method"];
-                                    delete castHeaders["X-HTTP-Method"];
-                                }
-                                batchBody.push(method + " " + url + " HTTP/1.1\n");
-                                headers.set("Content-Type", "application/json;odata=verbose;charset=utf-8");
-                            }
-                            else {
-                                batchBody.push(reqInfo.method + " " + url + " HTTP/1.1\n");
-                            }
-                            // merge global config headers
-                            mergeHeaders(headers, (_a = this.runtime.get("sp")) === null || _a === void 0 ? void 0 : _a.headers);
-                            // merge per-request headers
-                            if (reqInfo.options) {
-                                mergeHeaders(headers, reqInfo.options.headers);
-                            }
-                            // lastly we apply any default headers we need that may not exist
-                            if (!headers.has("Accept")) {
-                                headers.append("Accept", "application/json");
-                            }
-                            if (!headers.has("Content-Type")) {
-                                headers.append("Content-Type", "application/json;odata=verbose;charset=utf-8");
-                            }
-                            if (!headers.has("X-ClientService-ClientTag")) {
-                                headers.append("X-ClientService-ClientTag", "PnPCoreJS:@pnp-2.10.0:batch");
-                            }
-                            // write headers into batch body
-                            headers.forEach(function (value, name) {
-                                batchBody.push(name + ": " + value + "\n");
-                            });
-                            batchBody.push("\n");
-                            if (reqInfo.options.body) {
-                                batchBody.push(reqInfo.options.body + "\n\n");
-                            }
-                        }
-                        if (currentChangeSetId.length > 0) {
-                            // Close the changeset
-                            batchBody.push("--changeset_" + currentChangeSetId + "--\n\n");
-                            currentChangeSetId = "";
-                        }
-                        batchBody.push("--batch_" + this.batchId + "--\n");
-                        batchOptions = {
-                            "body": batchBody.join(""),
-                            "headers": {
-                                "Content-Type": "multipart/mixed; boundary=batch_" + this.batchId,
-                            },
-                            "method": "POST",
-                        };
-                        Logger.write("[" + this.batchId + "] (" + (new Date()).getTime() + ") Sending batch request.", 1 /* Info */);
-                        return [4 /*yield*/, client.fetch(combine(absoluteRequestUrl, "/_api/$batch"), batchOptions)];
-                    case 2:
-                        fetchResponse = _b.sent();
-                        if (!!fetchResponse.ok) return [3 /*break*/, 4];
-                        return [4 /*yield*/, HttpRequestError.init(fetchResponse)];
-                    case 3: 
-                    // the entire batch resulted in an error and we need to handle that better #1356
-                    // things consistently with the rest of the http errors
-                    throw (_b.sent());
-                    case 4: return [4 /*yield*/, fetchResponse.text()];
-                    case 5:
-                        text = _b.sent();
-                        responses = SPBatch.ParseResponse(text);
-                        if (responses.length !== this.requests.length) {
-                            throw Error("Could not properly parse responses to match requests in batch.");
-                        }
-                        Logger.write("[" + this.batchId + "] (" + (new Date()).getTime() + ") Resolving batched requests.", 1 /* Info */);
-                        // this structure ensures that we resolve the batched requests in the order we expect
-                        // using async this is not guaranteed depending on the requests
-                        return [2 /*return*/, responses.reduce(function (p, response, index) { return p.then(function () { return __awaiter(_this, void 0, void 0, function () {
-                                var request, _a, _b, e_1;
-                                return __generator(this, function (_c) {
-                                    switch (_c.label) {
-                                        case 0:
-                                            request = this.requests[index];
-                                            Logger.write("[" + request.id + "] (" + (new Date()).getTime() + ") Resolving request in batch " + this.batchId + ".", 1 /* Info */);
-                                            _c.label = 1;
-                                        case 1:
-                                            _c.trys.push([1, 3, , 4]);
-                                            _b = (_a = request).resolve;
-                                            return [4 /*yield*/, request.parser.parse(response)];
-                                        case 2:
-                                            _b.apply(_a, [_c.sent()]);
-                                            return [3 /*break*/, 4];
-                                        case 3:
-                                            e_1 = _c.sent();
-                                            request.reject(e_1);
-                                            return [3 /*break*/, 4];
-                                        case 4: return [2 /*return*/];
-                                    }
-                                });
-                            }); }); }, Promise.resolve(void (0)))];
-                }
-            });
-        });
-    };
-    return SPBatch;
-}(Batch));
-export { SPBatch };
+import { __awaiter, __extends, __generator } from "tslib";
+import { Batch, HttpRequestError } from "@pnp/odata";
+import { getGUID, isUrlAbsolute, combine, mergeHeaders, hOP, DefaultRuntime } from "@pnp/common";
+import { Logger } from "@pnp/logging";
+import { SPHttpClient } from "./sphttpclient.js";
+import { toAbsoluteUrl } from "./utils/toabsoluteurl.js";
+/**
+ * Manages a batch of OData operations
+ */
+var SPBatch = /** @class */ (function (_super) {
+    __extends(SPBatch, _super);
+    function SPBatch(url, runtime) {
+        if (runtime === void 0) { runtime = DefaultRuntime; }
+        var _this = _super.call(this) || this;
+        _this.url = url;
+        _this.runtime = runtime;
+        return _this;
+    }
+    /**
+     * Parses the response from a batch request into an array of Response instances
+     *
+     * @param body Text body of the response from the batch request
+     */
+    SPBatch.ParseResponse = function (body) {
+        var responses = [];
+        var header = "--batchresponse_";
+        // Ex. "HTTP/1.1 500 Internal Server Error"
+        var statusRegExp = new RegExp("^HTTP/[0-9.]+ +([0-9]+) +(.*)", "i");
+        var lines = body.split("\n");
+        var state = "batch";
+        var status;
+        var statusText;
+        for (var i = 0; i < lines.length; ++i) {
+            var line = lines[i];
+            switch (state) {
+                case "batch":
+                    if (line.substr(0, header.length) === header) {
+                        state = "batchHeaders";
+                    }
+                    else {
+                        if (line.trim() !== "") {
+                            throw Error("Invalid response, line " + i);
+                        }
+                    }
+                    break;
+                case "batchHeaders":
+                    if (line.trim() === "") {
+                        state = "status";
+                    }
+                    break;
+                case "status": {
+                    var parts = statusRegExp.exec(line);
+                    if (parts.length !== 3) {
+                        throw Error("Invalid status, line " + i);
+                    }
+                    status = parseInt(parts[1], 10);
+                    statusText = parts[2];
+                    state = "statusHeaders";
+                    break;
+                }
+                case "statusHeaders":
+                    if (line.trim() === "") {
+                        state = "body";
+                    }
+                    break;
+                case "body":
+                    responses.push((status === 204) ? new Response() : new Response(line, { status: status, statusText: statusText }));
+                    state = "batch";
+                    break;
+            }
+        }
+        if (state !== "status") {
+            throw Error("Unexpected end of input");
+        }
+        return responses;
+    };
+    SPBatch.prototype.executeImpl = function () {
+        var _a;
+        return __awaiter(this, void 0, void 0, function () {
+            var client, absoluteRequestUrl, batchBody, currentChangeSetId, i, reqInfo, headers, url, method, castHeaders, batchOptions, fetchResponse, text, responses;
+            var _this = this;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        Logger.write("[" + this.batchId + "] (" + (new Date()).getTime() + ") Executing batch with " + this.requests.length + " requests.", 1 /* Info */);
+                        // if we don't have any requests, don't bother sending anything
+                        // this could be due to caching further upstream, or just an empty batch
+                        if (this.requests.length < 1) {
+                            Logger.write("Resolving empty batch.", 1 /* Info */);
+                            return [2 /*return*/];
+                        }
+                        client = new SPHttpClient(this.runtime);
+                        return [4 /*yield*/, toAbsoluteUrl(this.url, this.runtime)];
+                    case 1:
+                        absoluteRequestUrl = _b.sent();
+                        batchBody = [];
+                        currentChangeSetId = "";
+                        for (i = 0; i < this.requests.length; i++) {
+                            reqInfo = this.requests[i];
+                            if (reqInfo.method === "GET") {
+                                if (currentChangeSetId.length > 0) {
+                                    // end an existing change set
+                                    batchBody.push("--changeset_" + currentChangeSetId + "--\n\n");
+                                    currentChangeSetId = "";
+                                }
+                                batchBody.push("--batch_" + this.batchId + "\n");
+                            }
+                            else {
+                                if (currentChangeSetId.length < 1) {
+                                    // start new change set
+                                    currentChangeSetId = getGUID();
+                                    batchBody.push("--batch_" + this.batchId + "\n");
+                                    batchBody.push("Content-Type: multipart/mixed; boundary=\"changeset_" + currentChangeSetId + "\"\n\n");
+                                }
+                                batchBody.push("--changeset_" + currentChangeSetId + "\n");
+                            }
+                            // common batch part prefix
+                            batchBody.push("Content-Type: application/http\n");
+                            batchBody.push("Content-Transfer-Encoding: binary\n\n");
+                            headers = new Headers();
+                            url = isUrlAbsolute(reqInfo.url) ? reqInfo.url : combine(absoluteRequestUrl, reqInfo.url);
+                            Logger.write("[" + this.batchId + "] (" + (new Date()).getTime() + ") Adding request " + reqInfo.method + " " + url + " to batch.", 0 /* Verbose */);
+                            if (reqInfo.method !== "GET") {
+                                method = reqInfo.method;
+                                castHeaders = reqInfo.options.headers;
+                                if (hOP(reqInfo, "options") && hOP(reqInfo.options, "headers") && castHeaders["X-HTTP-Method"] !== undefined) {
+                                    method = castHeaders["X-HTTP-Method"];
+                                    delete castHeaders["X-HTTP-Method"];
+                                }
+                                batchBody.push(method + " " + url + " HTTP/1.1\n");
+                                headers.set("Content-Type", "application/json;odata=verbose;charset=utf-8");
+                            }
+                            else {
+                                batchBody.push(reqInfo.method + " " + url + " HTTP/1.1\n");
+                            }
+                            // merge global config headers
+                            mergeHeaders(headers, (_a = this.runtime.get("sp")) === null || _a === void 0 ? void 0 : _a.headers);
+                            // merge per-request headers
+                            if (reqInfo.options) {
+                                mergeHeaders(headers, reqInfo.options.headers);
+                            }
+                            // lastly we apply any default headers we need that may not exist
+                            if (!headers.has("Accept")) {
+                                headers.append("Accept", "application/json");
+                            }
+                            if (!headers.has("Content-Type")) {
+                                headers.append("Content-Type", "application/json;odata=verbose;charset=utf-8");
+                            }
+                            if (!headers.has("X-ClientService-ClientTag")) {
+                                headers.append("X-ClientService-ClientTag", "PnPCoreJS:@pnp-2.11.0:batch");
+                            }
+                            // write headers into batch body
+                            headers.forEach(function (value, name) {
+                                batchBody.push(name + ": " + value + "\n");
+                            });
+                            batchBody.push("\n");
+                            if (reqInfo.options.body) {
+                                batchBody.push(reqInfo.options.body + "\n\n");
+                            }
+                        }
+                        if (currentChangeSetId.length > 0) {
+                            // Close the changeset
+                            batchBody.push("--changeset_" + currentChangeSetId + "--\n\n");
+                            currentChangeSetId = "";
+                        }
+                        batchBody.push("--batch_" + this.batchId + "--\n");
+                        batchOptions = {
+                            "body": batchBody.join(""),
+                            "headers": {
+                                "Content-Type": "multipart/mixed; boundary=batch_" + this.batchId,
+                            },
+                            "method": "POST",
+                        };
+                        Logger.write("[" + this.batchId + "] (" + (new Date()).getTime() + ") Sending batch request.", 1 /* Info */);
+                        return [4 /*yield*/, client.fetch(combine(absoluteRequestUrl, "/_api/$batch"), batchOptions)];
+                    case 2:
+                        fetchResponse = _b.sent();
+                        if (!!fetchResponse.ok) return [3 /*break*/, 4];
+                        return [4 /*yield*/, HttpRequestError.init(fetchResponse)];
+                    case 3: 
+                    // the entire batch resulted in an error and we need to handle that better #1356
+                    // things consistently with the rest of the http errors
+                    throw (_b.sent());
+                    case 4: return [4 /*yield*/, fetchResponse.text()];
+                    case 5:
+                        text = _b.sent();
+                        responses = SPBatch.ParseResponse(text);
+                        if (responses.length !== this.requests.length) {
+                            throw Error("Could not properly parse responses to match requests in batch.");
+                        }
+                        Logger.write("[" + this.batchId + "] (" + (new Date()).getTime() + ") Resolving batched requests.", 1 /* Info */);
+                        // this structure ensures that we resolve the batched requests in the order we expect
+                        // using async this is not guaranteed depending on the requests
+                        return [2 /*return*/, responses.reduce(function (p, response, index) { return p.then(function () { return __awaiter(_this, void 0, void 0, function () {
+                                var request, _a, _b, e_1;
+                                return __generator(this, function (_c) {
+                                    switch (_c.label) {
+                                        case 0:
+                                            request = this.requests[index];
+                                            Logger.write("[" + request.id + "] (" + (new Date()).getTime() + ") Resolving request in batch " + this.batchId + ".", 1 /* Info */);
+                                            _c.label = 1;
+                                        case 1:
+                                            _c.trys.push([1, 3, , 4]);
+                                            _b = (_a = request).resolve;
+                                            return [4 /*yield*/, request.parser.parse(response)];
+                                        case 2:
+                                            _b.apply(_a, [_c.sent()]);
+                                            return [3 /*break*/, 4];
+                                        case 3:
+                                            e_1 = _c.sent();
+                                            request.reject(e_1);
+                                            return [3 /*break*/, 4];
+                                        case 4: return [2 /*return*/];
+                                    }
+                                });
+                            }); }); }, Promise.resolve(void (0)))];
+                }
+            });
+        });
+    };
+    return SPBatch;
+}(Batch));
+export { SPBatch };
 //# sourceMappingURL=batch.js.map

package/clientside-pages/funcs.d.ts

@@ -1,23 +1,23 @@
-/**
- * Gets the next order value 1 based for the provided collection
- *
- * @param collection Collection of orderable things
- */
-export declare function getNextOrder(collection: {
-    order: number;
-}[]): number;
-/**
- * Normalizes the order value for all the sections, columns, and controls to be 1 based and stepped (1, 2, 3...)
- *
- * @param collection The collection to normalize
- */
-export declare function reindex(collection: {
-    order: number;
-    columns?: {
-        order: number;
-    }[];
-    controls?: {
-        order: number;
-    }[];
-}[]): void;
+/**
+ * Gets the next order value 1 based for the provided collection
+ *
+ * @param collection Collection of orderable things
+ */
+export declare function getNextOrder(collection: {
+    order: number;
+}[]): number;
+/**
+ * Normalizes the order value for all the sections, columns, and controls to be 1 based and stepped (1, 2, 3...)
+ *
+ * @param collection The collection to normalize
+ */
+export declare function reindex(collection: {
+    order: number;
+    columns?: {
+        order: number;
+    }[];
+    controls?: {
+        order: number;
+    }[];
+}[]): void;
 //# sourceMappingURL=funcs.d.ts.map

package/clientside-pages/funcs.js

@@ -1,26 +1,26 @@
-import { hOP } from "@pnp/common";
-/**
- * Gets the next order value 1 based for the provided collection
- *
- * @param collection Collection of orderable things
- */
-export function getNextOrder(collection) {
-    return collection.length < 1 ? 1 : (Math.max.apply(null, collection.map(function (i) { return i.order; })) + 1);
-}
-/**
- * Normalizes the order value for all the sections, columns, and controls to be 1 based and stepped (1, 2, 3...)
- *
- * @param collection The collection to normalize
- */
-export function reindex(collection) {
-    for (var i = 0; i < collection.length; i++) {
-        collection[i].order = i + 1;
-        if (hOP(collection[i], "columns")) {
-            reindex(collection[i].columns);
-        }
-        else if (hOP(collection[i], "controls")) {
-            reindex(collection[i].controls);
-        }
-    }
-}
+import { hOP } from "@pnp/common";
+/**
+ * Gets the next order value 1 based for the provided collection
+ *
+ * @param collection Collection of orderable things
+ */
+export function getNextOrder(collection) {
+    return collection.length < 1 ? 1 : (Math.max.apply(null, collection.map(function (i) { return i.order; })) + 1);
+}
+/**
+ * Normalizes the order value for all the sections, columns, and controls to be 1 based and stepped (1, 2, 3...)
+ *
+ * @param collection The collection to normalize
+ */
+export function reindex(collection) {
+    for (var i = 0; i < collection.length; i++) {
+        collection[i].order = i + 1;
+        if (hOP(collection[i], "columns")) {
+            reindex(collection[i].columns);
+        }
+        else if (hOP(collection[i], "controls")) {
+            reindex(collection[i].controls);
+        }
+    }
+}
 //# sourceMappingURL=funcs.js.map

package/clientside-pages/index.d.ts

@@ -1,3 +1,3 @@
-import "./web.js";
-export { IClientsidePage, ClientsidePageFromFile, CreateClientsidePage, CanvasColumn, CanvasColumnFactor, CanvasSection, IClientsidePageComponent, ClientsidePageLayoutType, ClientsideText, ClientsideWebpart, ColumnControl, ICanvasControlBaseData, IClientControlEmphasis, IClientsideControlBaseData, IClientsidePageColumnData, IClientsidePageSettingsSlice, IClientsideTextData, IClientsideWebPartData, IPageData, LayoutType, PromotedState, TextAlignment, IBannerImageProps, } from "./types.js";
+import "./web.js";
+export { IClientsidePage, ClientsidePageFromFile, CreateClientsidePage, CanvasColumn, CanvasColumnFactor, CanvasSection, IClientsidePageComponent, ClientsidePageLayoutType, ClientsideText, ClientsideWebpart, ColumnControl, ICanvasControlBaseData, IClientControlEmphasis, IClientsideControlBaseData, IClientsidePageColumnData, IClientsidePageSettingsSlice, IClientsideTextData, IClientsideWebPartData, IPageData, LayoutType, PromotedState, TextAlignment, IBannerImageProps, } from "./types.js";
 //# sourceMappingURL=index.d.ts.map

package/clientside-pages/index.js

@@ -1,3 +1,3 @@
-import "./web.js";
-export { ClientsidePageFromFile, CreateClientsidePage, CanvasColumn, CanvasSection, ClientsideText, ClientsideWebpart, ColumnControl, PromotedState, } from "./types.js";
+import "./web.js";
+export { ClientsidePageFromFile, CreateClientsidePage, CanvasColumn, CanvasSection, ClientsideText, ClientsideWebpart, ColumnControl, PromotedState, } from "./types.js";
 //# sourceMappingURL=index.js.map