@pnp/sp 2.8.0 → 2.12.0

package/files/types.js

@@ -1,854 +1,854 @@
-import { __awaiter, __decorate, __extends, __generator, __read, __spreadArray } from "tslib";
-import { _SharePointQueryableInstance, _SharePointQueryableCollection, spInvokableFactory, SharePointQueryableInstance, deleteableWithETag, } from "../sharepointqueryable.js";
-import { TextParser, BlobParser, JSONParser, BufferParser, headers, body } from "@pnp/odata";
-import { assign, getGUID, isFunc, stringIsNullOrEmpty, isUrlAbsolute } from "@pnp/common";
-import { Item } from "../items/index.js";
-import { odataUrlFrom } from "../odata.js";
-import { defaultPath } from "../decorators.js";
-import { spPost } from "../operations.js";
-import { escapeQueryStrValue } from "../utils/escapeQueryStrValue.js";
-import { extractWebUrl } from "../utils/extractweburl.js";
-import { tag } from "../telemetry.js";
-import { toResourcePath } from "../utils/toResourcePath.js";
-/**
- * Describes a collection of File objects
- *
- */
-var _Files = /** @class */ (function (_super) {
-    __extends(_Files, _super);
-    function _Files() {
-        return _super !== null && _super.apply(this, arguments) || this;
-    }
-    /**
-     * Gets a File by filename
-     *
-     * @param name The name of the file, including extension.
-     */
-    _Files.prototype.getByName = function (name) {
-        if (/%#/.test(name)) {
-            throw Error("For file names containing % or # please use web.getFileByServerRelativePath");
-        }
-        return tag.configure(File(this).concat("('" + escapeQueryStrValue(name) + "')"), "fis.getByName");
-    };
-    /**
-     * Uploads a file. Not supported for batching
-     *
-     * @param url The folder-relative url of the file.
-     * @param content The file contents
-     * @param shouldOverWrite Should a file with the same name in the same location be overwritten? (default: true)
-     * @returns The new File and the raw response.
-     */
-    _Files.prototype.add = function (url, content, shouldOverWrite) {
-        if (shouldOverWrite === void 0) { shouldOverWrite = true; }
-        return __awaiter(this, void 0, void 0, function () {
-            var response;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, spPost(Files(this, "add(overwrite=" + shouldOverWrite + ",url='" + escapeQueryStrValue(url) + "')"), {
-                            body: content,
-                        })];
-                    case 1:
-                        response = _a.sent();
-                        return [2 /*return*/, {
-                                data: response,
-                                file: this.getByName(url),
-                            }];
-                }
-            });
-        });
-    };
-    /**
-     * Adds a file using the pound percent safe methods
-     *
-     * @param url Excoded url of the file
-     * @param content The file content
-     * @param parameters Additional parameters to control method behavior
-     */
-    _Files.prototype.addUsingPath = function (url, content, parameters) {
-        if (parameters === void 0) { parameters = { Overwrite: false }; }
-        return __awaiter(this, void 0, void 0, function () {
-            var path, resp;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        path = ["AddUsingPath(decodedurl='" + escapeQueryStrValue(url) + "'"];
-                        if (parameters) {
-                            if (parameters.Overwrite) {
-                                path.push(",Overwrite=true");
-                            }
-                            if (parameters.AutoCheckoutOnInvalidData) {
-                                path.push(",AutoCheckoutOnInvalidData=true");
-                            }
-                            if (!stringIsNullOrEmpty(parameters.XorHash)) {
-                                path.push(",XorHash=" + escapeQueryStrValue(parameters.XorHash));
-                            }
-                        }
-                        path.push(")");
-                        return [4 /*yield*/, spPost(Files(this, path.join("")), { body: content })];
-                    case 1:
-                        resp = _a.sent();
-                        return [2 /*return*/, {
-                                data: resp,
-                                file: File(odataUrlFrom(resp)),
-                            }];
-                }
-            });
-        });
-    };
-    /**
-     * Uploads a file. Not supported for batching
-     *
-     * @param url The folder-relative url of the file.
-     * @param content The Blob file content to add
-     * @param progress A callback function which can be used to track the progress of the upload
-     * @param shouldOverWrite Should a file with the same name in the same location be overwritten? (default: true)
-     * @param chunkSize The size of each file slice, in bytes (default: 10485760)
-     * @returns The new File and the raw response.
-     */
-    _Files.prototype.addChunked = function (url, content, progress, shouldOverWrite, chunkSize) {
-        if (shouldOverWrite === void 0) { shouldOverWrite = true; }
-        if (chunkSize === void 0) { chunkSize = 10485760; }
-        return __awaiter(this, void 0, void 0, function () {
-            var response, odataUrl, file;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, spPost(this.clone(Files, "add(overwrite=" + shouldOverWrite + ",url='" + escapeQueryStrValue(url) + "')", false))];
-                    case 1:
-                        response = _a.sent();
-                        odataUrl = odataUrlFrom(response);
-                        if (!stringIsNullOrEmpty(odataUrl) && /%27/i.test(odataUrl)) {
-                            odataUrl = odataUrl.replace(/%27/ig, "''");
-                        }
-                        file = File(odataUrl);
-                        return [4 /*yield*/, file.setContentChunked(content, progress, chunkSize)];
-                    case 2: return [2 /*return*/, _a.sent()];
-                }
-            });
-        });
-    };
-    /**
-     * Adds a ghosted file to an existing list or document library. Not supported for batching.
-     *
-     * @param fileUrl The server-relative url where you want to save the file.
-     * @param templateFileType The type of use to create the file.
-     * @returns The template file that was added and the raw response.
-     */
-    _Files.prototype.addTemplateFile = function (fileUrl, templateFileType) {
-        return __awaiter(this, void 0, void 0, function () {
-            var response;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, spPost(this.clone(Files, "addTemplateFile(urloffile='" + escapeQueryStrValue(fileUrl) + "',templatefiletype=" + templateFileType + ")", false))];
-                    case 1:
-                        response = _a.sent();
-                        return [2 /*return*/, {
-                                data: response,
-                                file: File(odataUrlFrom(response)),
-                            }];
-                }
-            });
-        });
-    };
-    __decorate([
-        tag("fis.add")
-    ], _Files.prototype, "add", null);
-    __decorate([
-        tag("fis.addUsingPath")
-    ], _Files.prototype, "addUsingPath", null);
-    __decorate([
-        tag("fis.addChunked")
-    ], _Files.prototype, "addChunked", null);
-    __decorate([
-        tag("fis.addTemplateFile")
-    ], _Files.prototype, "addTemplateFile", null);
-    _Files = __decorate([
-        defaultPath("files")
-    ], _Files);
-    return _Files;
-}(_SharePointQueryableCollection));
-export { _Files };
-export var Files = spInvokableFactory(_Files);
-/**
- * Describes a single File instance
- *
- */
-var _File = /** @class */ (function (_super) {
-    __extends(_File, _super);
-    function _File() {
-        var _this = _super !== null && _super.apply(this, arguments) || this;
-        _this.delete = deleteableWithETag("fi");
-        return _this;
-    }
-    Object.defineProperty(_File.prototype, "listItemAllFields", {
-        /**
-         * Gets a value that specifies the list item field values for the list item corresponding to the file.
-         *
-         */
-        get: function () {
-            return tag.configure(SharePointQueryableInstance(this, "listItemAllFields"), "fi.listItemAllFields");
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(_File.prototype, "versions", {
-        /**
-         * Gets a collection of versions
-         *
-         */
-        get: function () {
-            return tag.configure(Versions(this), "fi.versions");
-        },
-        enumerable: false,
-        configurable: true
-    });
-    /**
-     * Approves the file submitted for content approval with the specified comment.
-     * Only documents in lists that are enabled for content approval can be approved.
-     *
-     * @param comment The comment for the approval.
-     */
-    _File.prototype.approve = function (comment) {
-        if (comment === void 0) { comment = ""; }
-        return spPost(this.clone(File, "approve(comment='" + escapeQueryStrValue(comment) + "')"));
-    };
-    /**
-     * Stops the chunk upload session without saving the uploaded data. Does not support batching.
-     * If the file doesn’t already exist in the library, the partially uploaded file will be deleted.
-     * Use this in response to user action (as in a request to cancel an upload) or an error or exception.
-     * Use the uploadId value that was passed to the StartUpload method that started the upload session.
-     * This method is currently available only on Office 365.
-     *
-     * @param uploadId The unique identifier of the upload session.
-     */
-    _File.prototype.cancelUpload = function (uploadId) {
-        return spPost(this.clone(File, "cancelUpload(uploadId=guid'" + uploadId + "')", false));
-    };
-    /**
-     * Checks the file in to a document library based on the check-in type.
-     *
-     * @param comment A comment for the check-in. Its length must be <= 1023.
-     * @param checkinType The check-in type for the file.
-     */
-    _File.prototype.checkin = function (comment, checkinType) {
-        if (comment === void 0) { comment = ""; }
-        if (checkinType === void 0) { checkinType = CheckinType.Major; }
-        if (comment.length > 1023) {
-            throw Error("The maximum comment length is 1023 characters.");
-        }
-        return spPost(this.clone(File, "checkin(comment='" + escapeQueryStrValue(comment) + "',checkintype=" + checkinType + ")"));
-    };
-    /**
-     * Checks out the file from a document library.
-     */
-    _File.prototype.checkout = function () {
-        return spPost(this.clone(File, "checkout"));
-    };
-    /**
-     * Copies the file to the destination url.
-     *
-     * @param url The absolute url or server relative url of the destination file path to copy to.
-     * @param shouldOverWrite Should a file with the same name in the same location be overwritten?
-     */
-    _File.prototype.copyTo = function (url, shouldOverWrite) {
-        if (shouldOverWrite === void 0) { shouldOverWrite = true; }
-        return spPost(this.clone(File, "copyTo(strnewurl='" + escapeQueryStrValue(url) + "',boverwrite=" + shouldOverWrite + ")"));
-    };
-    /**
-     * Copies the file by path to destination path.
-     * Also works with different site collections.
-     *
-     * @param destUrl The absolute url or server relative url of the destination file path to copy to.
-     * @param shouldOverWrite Should a file with the same name in the same location be overwritten?
-     * @param keepBoth Keep both if file with the same name in the same location already exists? Only relevant when shouldOverWrite is set to false.
-     */
-    _File.prototype.copyByPath = function (destUrl, shouldOverWrite, KeepBoth) {
-        if (KeepBoth === void 0) { KeepBoth = false; }
-        return __awaiter(this, void 0, void 0, function () {
-            var _a, srcUrl, absoluteUrl, webBaseUrl, hostUrl;
-            return __generator(this, function (_b) {
-                switch (_b.label) {
-                    case 0: return [4 /*yield*/, this.select("ServerRelativeUrl")()];
-                    case 1:
-                        _a = _b.sent(), srcUrl = _a.ServerRelativeUrl, absoluteUrl = _a["odata.id"];
-                        webBaseUrl = extractWebUrl(absoluteUrl);
-                        hostUrl = webBaseUrl.replace("://", "___").split("/")[0].replace("___", "://");
-                        return [4 /*yield*/, spPost(File(webBaseUrl, "/_api/SP.MoveCopyUtil.CopyFileByPath(overwrite=@a1)?@a1=" + shouldOverWrite), body({
-                                destPath: toResourcePath(isUrlAbsolute(destUrl) ? destUrl : "" + hostUrl + destUrl),
-                                options: {
-                                    KeepBoth: KeepBoth,
-                                    ResetAuthorAndCreatedOnCopy: true,
-                                    ShouldBypassSharedLocks: true,
-                                    __metadata: {
-                                        type: "SP.MoveCopyOptions",
-                                    },
-                                },
-                                srcPath: toResourcePath(isUrlAbsolute(srcUrl) ? srcUrl : "" + hostUrl + srcUrl),
-                            }))];
-                    case 2:
-                        _b.sent();
-                        return [2 /*return*/];
-                }
-            });
-        });
-    };
-    /**
-     * Denies approval for a file that was submitted for content approval.
-     * Only documents in lists that are enabled for content approval can be denied.
-     *
-     * @param comment The comment for the denial.
-     */
-    _File.prototype.deny = function (comment) {
-        if (comment === void 0) { comment = ""; }
-        if (comment.length > 1023) {
-            throw Error("The maximum comment length is 1023 characters.");
-        }
-        return spPost(this.clone(File, "deny(comment='" + escapeQueryStrValue(comment) + "')"));
-    };
-    /**
-     * Moves the file to the specified destination url.
-     *
-     * @param url The absolute url or server relative url of the destination file path to move to.
-     * @param moveOperations The bitwise MoveOperations value for how to move the file.
-     */
-    _File.prototype.moveTo = function (url, moveOperations) {
-        if (moveOperations === void 0) { moveOperations = MoveOperations.Overwrite; }
-        return spPost(this.clone(File, "moveTo(newurl='" + escapeQueryStrValue(url) + "',flags=" + moveOperations + ")"));
-    };
-    /**
-     * Moves the file by path to the specified destination url.
-     * Also works with different site collections.
-     *
-     * @param destUrl The absolute url or server relative url of the destination file path to move to.
-     * @param shouldOverWrite Should a file with the same name in the same location be overwritten?
-     * @param keepBoth Keep both if file with the same name in the same location already exists? Only relevant when shouldOverWrite is set to false.
-     */
-    _File.prototype.moveByPath = function (destUrl, shouldOverWrite, KeepBoth) {
-        if (KeepBoth === void 0) { KeepBoth = false; }
-        return __awaiter(this, void 0, void 0, function () {
-            var _a, srcUrl, absoluteUrl, webBaseUrl, hostUrl;
-            return __generator(this, function (_b) {
-                switch (_b.label) {
-                    case 0: return [4 /*yield*/, this.select("ServerRelativeUrl")()];
-                    case 1:
-                        _a = _b.sent(), srcUrl = _a.ServerRelativeUrl, absoluteUrl = _a["odata.id"];
-                        webBaseUrl = extractWebUrl(absoluteUrl);
-                        hostUrl = webBaseUrl.replace("://", "___").split("/")[0].replace("___", "://");
-                        return [4 /*yield*/, spPost(File(webBaseUrl, "/_api/SP.MoveCopyUtil.MoveFileByPath(overwrite=@a1)?@a1=" + shouldOverWrite), body({
-                                destPath: toResourcePath(isUrlAbsolute(destUrl) ? destUrl : "" + hostUrl + destUrl),
-                                options: {
-                                    KeepBoth: KeepBoth,
-                                    ResetAuthorAndCreatedOnCopy: false,
-                                    ShouldBypassSharedLocks: true,
-                                    __metadata: {
-                                        type: "SP.MoveCopyOptions",
-                                    },
-                                },
-                                srcPath: toResourcePath(isUrlAbsolute(srcUrl) ? srcUrl : "" + hostUrl + srcUrl),
-                            }))];
-                    case 2:
-                        _b.sent();
-                        return [2 /*return*/];
-                }
-            });
-        });
-    };
-    /**
-     * Submits the file for content approval with the specified comment.
-     *
-     * @param comment The comment for the published file. Its length must be <= 1023.
-     */
-    _File.prototype.publish = function (comment) {
-        if (comment === void 0) { comment = ""; }
-        if (comment.length > 1023) {
-            throw Error("The maximum comment length is 1023 characters.");
-        }
-        return spPost(this.clone(File, "publish(comment='" + escapeQueryStrValue(comment) + "')"));
-    };
-    /**
-     * Moves the file to the Recycle Bin and returns the identifier of the new Recycle Bin item.
-     *
-     * @returns The GUID of the recycled file.
-     */
-    _File.prototype.recycle = function () {
-        return spPost(this.clone(File, "recycle"));
-    };
-    /**
-     * Deletes the file object with options.
-     *
-     * @param parameters Specifies the options to use when deleting a file.
-     */
-    _File.prototype.deleteWithParams = function (parameters) {
-        return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                return [2 /*return*/, spPost(this.clone(File, "DeleteWithParameters"), body({ parameters: parameters }))];
-            });
-        });
-    };
-    /**
-     * Reverts an existing checkout for the file.
-     *
-     */
-    _File.prototype.undoCheckout = function () {
-        return spPost(this.clone(File, "undoCheckout"));
-    };
-    /**
-     * Removes the file from content approval or unpublish a major version.
-     *
-     * @param comment The comment for the unpublish operation. Its length must be <= 1023.
-     */
-    _File.prototype.unpublish = function (comment) {
-        if (comment === void 0) { comment = ""; }
-        if (comment.length > 1023) {
-            throw Error("The maximum comment length is 1023 characters.");
-        }
-        return spPost(this.clone(File, "unpublish(comment='" + escapeQueryStrValue(comment) + "')"));
-    };
-    /**
-     * Checks to see if the file represented by this object exists
-     *
-     */
-    _File.prototype.exists = function () {
-        return __awaiter(this, void 0, void 0, function () {
-            var r, e_1;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        _a.trys.push([0, 2, , 3]);
-                        return [4 /*yield*/, this.clone(File).select("Exists")()];
-                    case 1:
-                        r = _a.sent();
-                        return [2 /*return*/, r.Exists];
-                    case 2:
-                        e_1 = _a.sent();
-                        // this treats any error here as the file not existing, which
-                        // might not be true, but is good enough.
-                        return [2 /*return*/, false];
-                    case 3: return [2 /*return*/];
-                }
-            });
-        });
-    };
-    /**
-     * Gets the contents of the file as text. Not supported in batching.
-     *
-     */
-    _File.prototype.getText = function () {
-        return this.clone(File, "$value", false).usingParser(new TextParser())(headers({ "binaryStringResponseBody": "true" }));
-    };
-    /**
-     * Gets the contents of the file as a blob, does not work in Node.js. Not supported in batching.
-     *
-     */
-    _File.prototype.getBlob = function () {
-        return this.clone(File, "$value", false).usingParser(new BlobParser())(headers({ "binaryStringResponseBody": "true" }));
-    };
-    /**
-     * Gets the contents of a file as an ArrayBuffer, works in Node.js. Not supported in batching.
-     */
-    _File.prototype.getBuffer = function () {
-        return this.clone(File, "$value", false).usingParser(new BufferParser())(headers({ "binaryStringResponseBody": "true" }));
-    };
-    /**
-     * Gets the contents of a file as an ArrayBuffer, works in Node.js. Not supported in batching.
-     */
-    _File.prototype.getJSON = function () {
-        return this.clone(File, "$value", false).usingParser(new JSONParser())(headers({ "binaryStringResponseBody": "true" }));
-    };
-    /**
-     * Sets the content of a file, for large files use setContentChunked. Not supported in batching.
-     *
-     * @param content The file content
-     *
-     */
-    _File.prototype.setContent = function (content) {
-        return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, spPost(this.clone(File, "$value", false), {
-                            body: content,
-                            headers: {
-                                "X-HTTP-Method": "PUT",
-                            },
-                        })];
-                    case 1:
-                        _a.sent();
-                        return [2 /*return*/, File(this)];
-                }
-            });
-        });
-    };
-    /**
-     * Gets the associated list item for this file, loading the default properties
-     */
-    _File.prototype.getItem = function () {
-        var selects = [];
-        for (var _i = 0; _i < arguments.length; _i++) {
-            selects[_i] = arguments[_i];
-        }
-        return __awaiter(this, void 0, void 0, function () {
-            var q, d;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        q = this.listItemAllFields;
-                        return [4 /*yield*/, q.select.apply(q, __spreadArray([], __read(selects)))()];
-                    case 1:
-                        d = _a.sent();
-                        return [2 /*return*/, assign(Item(odataUrlFrom(d)), d)];
-                }
-            });
-        });
-    };
-    /**
-     * Sets the contents of a file using a chunked upload approach. Not supported in batching.
-     *
-     * @param file The file to upload
-     * @param progress A callback function which can be used to track the progress of the upload
-     * @param chunkSize The size of each file slice, in bytes (default: 10485760)
-     */
-    _File.prototype.setContentChunked = function (file, progress, chunkSize) {
-        if (chunkSize === void 0) { chunkSize = 10485760; }
-        return __awaiter(this, void 0, void 0, function () {
-            var fileSize, totalBlocks, uploadId, currentPointer, i;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        if (!isFunc(progress)) {
-                            progress = function () { return null; };
-                        }
-                        fileSize = file.size;
-                        totalBlocks = parseInt((fileSize / chunkSize).toString(), 10) + ((fileSize % chunkSize === 0) ? 1 : 0);
-                        uploadId = getGUID();
-                        // report that we are starting
-                        progress({ uploadId: uploadId, blockNumber: 1, chunkSize: chunkSize, currentPointer: 0, fileSize: fileSize, stage: "starting", totalBlocks: totalBlocks });
-                        return [4 /*yield*/, this.startUpload(uploadId, file.slice(0, chunkSize))];
-                    case 1:
-                        currentPointer = _a.sent();
-                        i = 2;
-                        _a.label = 2;
-                    case 2:
-                        if (!(i < totalBlocks)) return [3 /*break*/, 5];
-                        progress({ uploadId: uploadId, blockNumber: i, chunkSize: chunkSize, currentPointer: currentPointer, fileSize: fileSize, stage: "continue", totalBlocks: totalBlocks });
-                        return [4 /*yield*/, this.continueUpload(uploadId, currentPointer, file.slice(currentPointer, currentPointer + chunkSize))];
-                    case 3:
-                        currentPointer = _a.sent();
-                        _a.label = 4;
-                    case 4:
-                        i++;
-                        return [3 /*break*/, 2];
-                    case 5:
-                        progress({ uploadId: uploadId, blockNumber: totalBlocks, chunkSize: chunkSize, currentPointer: currentPointer, fileSize: fileSize, stage: "finishing", totalBlocks: totalBlocks });
-                        return [2 /*return*/, this.finishUpload(uploadId, currentPointer, file.slice(currentPointer))];
-                }
-            });
-        });
-    };
-    /**
-     * Starts a new chunk upload session and uploads the first fragment.
-     * The current file content is not changed when this method completes.
-     * The method is idempotent (and therefore does not change the result) as long as you use the same values for uploadId and stream.
-     * The upload session ends either when you use the CancelUpload method or when you successfully
-     * complete the upload session by passing the rest of the file contents through the ContinueUpload and FinishUpload methods.
-     * The StartUpload and ContinueUpload methods return the size of the running total of uploaded data in bytes,
-     * so you can pass those return values to subsequent uses of ContinueUpload and FinishUpload.
-     * This method is currently available only on Office 365.
-     *
-     * @param uploadId The unique identifier of the upload session.
-     * @param fragment The file contents.
-     * @returns The size of the total uploaded data in bytes.
-     */
-    _File.prototype.startUpload = function (uploadId, fragment) {
-        return __awaiter(this, void 0, void 0, function () {
-            var n;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, spPost(this.clone(File, "startUpload(uploadId=guid'" + uploadId + "')", false), { body: fragment })];
-                    case 1:
-                        n = _a.sent();
-                        if (typeof n === "object") {
-                            // When OData=verbose the payload has the following shape:
-                            // { StartUpload: "10485760" }
-                            n = n.StartUpload;
-                        }
-                        return [2 /*return*/, parseFloat(n)];
-                }
-            });
-        });
-    };
-    /**
-     * Continues the chunk upload session with an additional fragment.
-     * The current file content is not changed.
-     * Use the uploadId value that was passed to the StartUpload method that started the upload session.
-     * This method is currently available only on Office 365.
-     *
-     * @param uploadId The unique identifier of the upload session.
-     * @param fileOffset The size of the offset into the file where the fragment starts.
-     * @param fragment The file contents.
-     * @returns The size of the total uploaded data in bytes.
-     */
-    _File.prototype.continueUpload = function (uploadId, fileOffset, fragment) {
-        return __awaiter(this, void 0, void 0, function () {
-            var n;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, spPost(this.clone(File, "continueUpload(uploadId=guid'" + uploadId + "',fileOffset=" + fileOffset + ")", false), { body: fragment })];
-                    case 1:
-                        n = _a.sent();
-                        if (typeof n === "object") {
-                            // When OData=verbose the payload has the following shape:
-                            // { ContinueUpload: "20971520" }
-                            n = n.ContinueUpload;
-                        }
-                        return [2 /*return*/, parseFloat(n)];
-                }
-            });
-        });
-    };
-    /**
-     * Uploads the last file fragment and commits the file. The current file content is changed when this method completes.
-     * Use the uploadId value that was passed to the StartUpload method that started the upload session.
-     * This method is currently available only on Office 365.
-     *
-     * @param uploadId The unique identifier of the upload session.
-     * @param fileOffset The size of the offset into the file where the fragment starts.
-     * @param fragment The file contents.
-     * @returns The newly uploaded file.
-     */
-    _File.prototype.finishUpload = function (uploadId, fileOffset, fragment) {
-        return __awaiter(this, void 0, void 0, function () {
-            var response;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, spPost(this.clone(File, "finishUpload(uploadId=guid'" + uploadId + "',fileOffset=" + fileOffset + ")", false), { body: fragment })];
-                    case 1:
-                        response = _a.sent();
-                        return [2 /*return*/, {
-                                data: response,
-                                file: File(odataUrlFrom(response)),
-                            }];
-                }
-            });
-        });
-    };
-    __decorate([
-        tag("fi.approve")
-    ], _File.prototype, "approve", null);
-    __decorate([
-        tag("fi.cancelUpload")
-    ], _File.prototype, "cancelUpload", null);
-    __decorate([
-        tag("fi.checkin")
-    ], _File.prototype, "checkin", null);
-    __decorate([
-        tag("fi.checkout")
-    ], _File.prototype, "checkout", null);
-    __decorate([
-        tag("fi.copyTo")
-    ], _File.prototype, "copyTo", null);
-    __decorate([
-        tag("fi.copyByPath")
-    ], _File.prototype, "copyByPath", null);
-    __decorate([
-        tag("fi.deny")
-    ], _File.prototype, "deny", null);
-    __decorate([
-        tag("fi.moveTo")
-    ], _File.prototype, "moveTo", null);
-    __decorate([
-        tag("fi.moveByPath")
-    ], _File.prototype, "moveByPath", null);
-    __decorate([
-        tag("fi.publish")
-    ], _File.prototype, "publish", null);
-    __decorate([
-        tag("fi.recycle")
-    ], _File.prototype, "recycle", null);
-    __decorate([
-        tag("fi.del-params")
-    ], _File.prototype, "deleteWithParams", null);
-    __decorate([
-        tag("fi.undoCheckout")
-    ], _File.prototype, "undoCheckout", null);
-    __decorate([
-        tag("fi.unpublish")
-    ], _File.prototype, "unpublish", null);
-    __decorate([
-        tag("fi.exists")
-    ], _File.prototype, "exists", null);
-    __decorate([
-        tag("fi.getText")
-    ], _File.prototype, "getText", null);
-    __decorate([
-        tag("fi.getBlob")
-    ], _File.prototype, "getBlob", null);
-    __decorate([
-        tag("fi.getBuffer")
-    ], _File.prototype, "getBuffer", null);
-    __decorate([
-        tag("fi.getJSON")
-    ], _File.prototype, "getJSON", null);
-    __decorate([
-        tag("fi.setContent")
-    ], _File.prototype, "setContent", null);
-    __decorate([
-        tag("fi.getItem")
-    ], _File.prototype, "getItem", null);
-    __decorate([
-        tag("fi.startUpload")
-    ], _File.prototype, "startUpload", null);
-    __decorate([
-        tag("fi.continueUpload")
-    ], _File.prototype, "continueUpload", null);
-    __decorate([
-        tag("fi.finishUpload")
-    ], _File.prototype, "finishUpload", null);
-    return _File;
-}(_SharePointQueryableInstance));
-export { _File };
-export var File = spInvokableFactory(_File);
-/**
- * Describes a collection of Version objects
- *
- */
-var _Versions = /** @class */ (function (_super) {
-    __extends(_Versions, _super);
-    function _Versions() {
-        return _super !== null && _super.apply(this, arguments) || this;
-    }
-    /**
-     * Gets a version by id
-     *
-     * @param versionId The id of the version to retrieve
-     */
-    _Versions.prototype.getById = function (versionId) {
-        return tag.configure(Version(this).concat("(" + versionId + ")"), "vers.getById");
-    };
-    /**
-     * Deletes all the file version objects in the collection.
-     *
-     */
-    _Versions.prototype.deleteAll = function () {
-        return spPost(Versions(this, "deleteAll"));
-    };
-    /**
-     * Deletes the specified version of the file.
-     *
-     * @param versionId The ID of the file version to delete.
-     */
-    _Versions.prototype.deleteById = function (versionId) {
-        return spPost(this.clone(Versions, "deleteById(vid=" + versionId + ")"));
-    };
-    /**
-     * Recycles the specified version of the file.
-     *
-     * @param versionId The ID of the file version to delete.
-     */
-    _Versions.prototype.recycleByID = function (versionId) {
-        return spPost(this.clone(Versions, "recycleByID(vid=" + versionId + ")"));
-    };
-    /**
-     * Deletes the file version object with the specified version label.
-     *
-     * @param label The version label of the file version to delete, for example: 1.2
-     */
-    _Versions.prototype.deleteByLabel = function (label) {
-        return spPost(this.clone(Versions, "deleteByLabel(versionlabel='" + escapeQueryStrValue(label) + "')"));
-    };
-    /**
-     * Recycles the file version object with the specified version label.
-     *
-     * @param label The version label of the file version to delete, for example: 1.2
-     */
-    _Versions.prototype.recycleByLabel = function (label) {
-        return spPost(this.clone(Versions, "recycleByLabel(versionlabel='" + escapeQueryStrValue(label) + "')"));
-    };
-    /**
-     * Creates a new file version from the file specified by the version label.
-     *
-     * @param label The version label of the file version to restore, for example: 1.2
-     */
-    _Versions.prototype.restoreByLabel = function (label) {
-        return spPost(this.clone(Versions, "restoreByLabel(versionlabel='" + escapeQueryStrValue(label) + "')"));
-    };
-    __decorate([
-        tag("vers.deleteAll")
-    ], _Versions.prototype, "deleteAll", null);
-    __decorate([
-        tag("vers.deleteById")
-    ], _Versions.prototype, "deleteById", null);
-    __decorate([
-        tag("vers.recycleByID")
-    ], _Versions.prototype, "recycleByID", null);
-    __decorate([
-        tag("vers.deleteByLabel")
-    ], _Versions.prototype, "deleteByLabel", null);
-    __decorate([
-        tag("vers.recycleByLabel")
-    ], _Versions.prototype, "recycleByLabel", null);
-    __decorate([
-        tag("vers.restoreByLabel")
-    ], _Versions.prototype, "restoreByLabel", null);
-    _Versions = __decorate([
-        defaultPath("versions")
-    ], _Versions);
-    return _Versions;
-}(_SharePointQueryableCollection));
-export { _Versions };
-export var Versions = spInvokableFactory(_Versions);
-/**
- * Describes a single Version instance
- *
- */
-var _Version = /** @class */ (function (_super) {
-    __extends(_Version, _super);
-    function _Version() {
-        var _this = _super !== null && _super.apply(this, arguments) || this;
-        _this.delete = deleteableWithETag("ver");
-        return _this;
-    }
-    return _Version;
-}(_SharePointQueryableInstance));
-export { _Version };
-export var Version = spInvokableFactory(_Version);
-/**
- * Types for document check in.
- * Minor = 0
- * Major = 1
- * Overwrite = 2
- */
-export var CheckinType;
-(function (CheckinType) {
-    CheckinType[CheckinType["Minor"] = 0] = "Minor";
-    CheckinType[CheckinType["Major"] = 1] = "Major";
-    CheckinType[CheckinType["Overwrite"] = 2] = "Overwrite";
-})(CheckinType || (CheckinType = {}));
-/**
- * File move opertions
- */
-export var MoveOperations;
-(function (MoveOperations) {
-    /**
-     * Produce an error if a file with the same name exists in the destination
-     */
-    MoveOperations[MoveOperations["None"] = 0] = "None";
-    /**
-     * Overwrite a file with the same name if it exists. Value is 1.
-     */
-    MoveOperations[MoveOperations["Overwrite"] = 1] = "Overwrite";
-    /**
-     * Complete the move operation even if supporting files are separated from the file. Value is 8.
-     */
-    MoveOperations[MoveOperations["AllowBrokenThickets"] = 8] = "AllowBrokenThickets";
-    /**
-     * Boolean specifying whether to retain the source of the move's editor and modified by datetime.
-     */
-    MoveOperations[MoveOperations["RetainEditorAndModifiedOnMove"] = 2048] = "RetainEditorAndModifiedOnMove";
-})(MoveOperations || (MoveOperations = {}));
-export var TemplateFileType;
-(function (TemplateFileType) {
-    TemplateFileType[TemplateFileType["StandardPage"] = 0] = "StandardPage";
-    TemplateFileType[TemplateFileType["WikiPage"] = 1] = "WikiPage";
-    TemplateFileType[TemplateFileType["FormPage"] = 2] = "FormPage";
-    TemplateFileType[TemplateFileType["ClientSidePage"] = 3] = "ClientSidePage";
-})(TemplateFileType || (TemplateFileType = {}));
+import { __awaiter, __decorate, __extends, __generator, __read, __spreadArray } from "tslib";
+import { _SharePointQueryableInstance, _SharePointQueryableCollection, spInvokableFactory, SharePointQueryableInstance, deleteableWithETag, } from "../sharepointqueryable.js";
+import { TextParser, BlobParser, JSONParser, BufferParser, headers, body } from "@pnp/odata";
+import { assign, getGUID, isFunc, stringIsNullOrEmpty, isUrlAbsolute } from "@pnp/common";
+import { Item } from "../items/index.js";
+import { odataUrlFrom } from "../odata.js";
+import { defaultPath } from "../decorators.js";
+import { spPost } from "../operations.js";
+import { escapeQueryStrValue } from "../utils/escapeQueryStrValue.js";
+import { extractWebUrl } from "../utils/extractweburl.js";
+import { tag } from "../telemetry.js";
+import { toResourcePath } from "../utils/toResourcePath.js";
+/**
+ * Describes a collection of File objects
+ *
+ */
+var _Files = /** @class */ (function (_super) {
+    __extends(_Files, _super);
+    function _Files() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    /**
+     * Gets a File by filename
+     *
+     * @param name The name of the file, including extension.
+     */
+    _Files.prototype.getByName = function (name) {
+        if (/%#/.test(name)) {
+            throw Error("For file names containing % or # please use web.getFileByServerRelativePath");
+        }
+        return tag.configure(File(this).concat("('" + escapeQueryStrValue(name) + "')"), "fis.getByName");
+    };
+    /**
+     * Uploads a file. Not supported for batching
+     *
+     * @param url The folder-relative url of the file.
+     * @param content The file contents
+     * @param shouldOverWrite Should a file with the same name in the same location be overwritten? (default: true)
+     * @returns The new File and the raw response.
+     */
+    _Files.prototype.add = function (url, content, shouldOverWrite) {
+        if (shouldOverWrite === void 0) { shouldOverWrite = true; }
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, spPost(Files(this, "add(overwrite=" + shouldOverWrite + ",url='" + escapeQueryStrValue(url) + "')"), {
+                            body: content,
+                        })];
+                    case 1:
+                        response = _a.sent();
+                        return [2 /*return*/, {
+                                data: response,
+                                file: this.getByName(url),
+                            }];
+                }
+            });
+        });
+    };
+    /**
+     * Adds a file using the pound percent safe methods
+     *
+     * @param url Excoded url of the file
+     * @param content The file content
+     * @param parameters Additional parameters to control method behavior
+     */
+    _Files.prototype.addUsingPath = function (url, content, parameters) {
+        if (parameters === void 0) { parameters = { Overwrite: false }; }
+        return __awaiter(this, void 0, void 0, function () {
+            var path, resp;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        path = ["AddUsingPath(decodedurl='" + escapeQueryStrValue(url) + "'"];
+                        if (parameters) {
+                            if (parameters.Overwrite) {
+                                path.push(",Overwrite=true");
+                            }
+                            if (parameters.AutoCheckoutOnInvalidData) {
+                                path.push(",AutoCheckoutOnInvalidData=true");
+                            }
+                            if (!stringIsNullOrEmpty(parameters.XorHash)) {
+                                path.push(",XorHash=" + escapeQueryStrValue(parameters.XorHash));
+                            }
+                        }
+                        path.push(")");
+                        return [4 /*yield*/, spPost(Files(this, path.join("")), { body: content })];
+                    case 1:
+                        resp = _a.sent();
+                        return [2 /*return*/, {
+                                data: resp,
+                                file: File(odataUrlFrom(resp)),
+                            }];
+                }
+            });
+        });
+    };
+    /**
+     * Uploads a file. Not supported for batching
+     *
+     * @param url The folder-relative url of the file.
+     * @param content The Blob file content to add
+     * @param progress A callback function which can be used to track the progress of the upload
+     * @param shouldOverWrite Should a file with the same name in the same location be overwritten? (default: true)
+     * @param chunkSize The size of each file slice, in bytes (default: 10485760)
+     * @returns The new File and the raw response.
+     */
+    _Files.prototype.addChunked = function (url, content, progress, shouldOverWrite, chunkSize) {
+        if (shouldOverWrite === void 0) { shouldOverWrite = true; }
+        if (chunkSize === void 0) { chunkSize = 10485760; }
+        return __awaiter(this, void 0, void 0, function () {
+            var response, odataUrl, file;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, spPost(this.clone(Files, "add(overwrite=" + shouldOverWrite + ",url='" + escapeQueryStrValue(url) + "')", false))];
+                    case 1:
+                        response = _a.sent();
+                        odataUrl = odataUrlFrom(response);
+                        if (!stringIsNullOrEmpty(odataUrl) && /%27/i.test(odataUrl)) {
+                            odataUrl = odataUrl.replace(/%27/ig, "''");
+                        }
+                        file = File(odataUrl);
+                        return [4 /*yield*/, file.setContentChunked(content, progress, chunkSize)];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    /**
+     * Adds a ghosted file to an existing list or document library. Not supported for batching.
+     *
+     * @param fileUrl The server-relative url where you want to save the file.
+     * @param templateFileType The type of use to create the file.
+     * @returns The template file that was added and the raw response.
+     */
+    _Files.prototype.addTemplateFile = function (fileUrl, templateFileType) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, spPost(this.clone(Files, "addTemplateFile(urloffile='" + escapeQueryStrValue(fileUrl) + "',templatefiletype=" + templateFileType + ")", false))];
+                    case 1:
+                        response = _a.sent();
+                        return [2 /*return*/, {
+                                data: response,
+                                file: File(odataUrlFrom(response)),
+                            }];
+                }
+            });
+        });
+    };
+    __decorate([
+        tag("fis.add")
+    ], _Files.prototype, "add", null);
+    __decorate([
+        tag("fis.addUsingPath")
+    ], _Files.prototype, "addUsingPath", null);
+    __decorate([
+        tag("fis.addChunked")
+    ], _Files.prototype, "addChunked", null);
+    __decorate([
+        tag("fis.addTemplateFile")
+    ], _Files.prototype, "addTemplateFile", null);
+    _Files = __decorate([
+        defaultPath("files")
+    ], _Files);
+    return _Files;
+}(_SharePointQueryableCollection));
+export { _Files };
+export var Files = spInvokableFactory(_Files);
+/**
+ * Describes a single File instance
+ *
+ */
+var _File = /** @class */ (function (_super) {
+    __extends(_File, _super);
+    function _File() {
+        var _this = _super !== null && _super.apply(this, arguments) || this;
+        _this.delete = deleteableWithETag("fi");
+        return _this;
+    }
+    Object.defineProperty(_File.prototype, "listItemAllFields", {
+        /**
+         * Gets a value that specifies the list item field values for the list item corresponding to the file.
+         *
+         */
+        get: function () {
+            return tag.configure(SharePointQueryableInstance(this, "listItemAllFields"), "fi.listItemAllFields");
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(_File.prototype, "versions", {
+        /**
+         * Gets a collection of versions
+         *
+         */
+        get: function () {
+            return tag.configure(Versions(this), "fi.versions");
+        },
+        enumerable: false,
+        configurable: true
+    });
+    /**
+     * Approves the file submitted for content approval with the specified comment.
+     * Only documents in lists that are enabled for content approval can be approved.
+     *
+     * @param comment The comment for the approval.
+     */
+    _File.prototype.approve = function (comment) {
+        if (comment === void 0) { comment = ""; }
+        return spPost(this.clone(File, "approve(comment='" + escapeQueryStrValue(comment) + "')"));
+    };
+    /**
+     * Stops the chunk upload session without saving the uploaded data. Does not support batching.
+     * If the file doesn’t already exist in the library, the partially uploaded file will be deleted.
+     * Use this in response to user action (as in a request to cancel an upload) or an error or exception.
+     * Use the uploadId value that was passed to the StartUpload method that started the upload session.
+     * This method is currently available only on Office 365.
+     *
+     * @param uploadId The unique identifier of the upload session.
+     */
+    _File.prototype.cancelUpload = function (uploadId) {
+        return spPost(this.clone(File, "cancelUpload(uploadId=guid'" + uploadId + "')", false));
+    };
+    /**
+     * Checks the file in to a document library based on the check-in type.
+     *
+     * @param comment A comment for the check-in. Its length must be <= 1023.
+     * @param checkinType The check-in type for the file.
+     */
+    _File.prototype.checkin = function (comment, checkinType) {
+        if (comment === void 0) { comment = ""; }
+        if (checkinType === void 0) { checkinType = CheckinType.Major; }
+        if (comment.length > 1023) {
+            throw Error("The maximum comment length is 1023 characters.");
+        }
+        return spPost(this.clone(File, "checkin(comment='" + escapeQueryStrValue(comment) + "',checkintype=" + checkinType + ")"));
+    };
+    /**
+     * Checks out the file from a document library.
+     */
+    _File.prototype.checkout = function () {
+        return spPost(this.clone(File, "checkout"));
+    };
+    /**
+     * Copies the file to the destination url.
+     *
+     * @param url The absolute url or server relative url of the destination file path to copy to.
+     * @param shouldOverWrite Should a file with the same name in the same location be overwritten?
+     */
+    _File.prototype.copyTo = function (url, shouldOverWrite) {
+        if (shouldOverWrite === void 0) { shouldOverWrite = true; }
+        return spPost(this.clone(File, "copyTo(strnewurl='" + escapeQueryStrValue(url) + "',boverwrite=" + shouldOverWrite + ")"));
+    };
+    /**
+     * Copies the file by path to destination path.
+     * Also works with different site collections.
+     *
+     * @param destUrl The absolute url or server relative url of the destination file path to copy to.
+     * @param shouldOverWrite Should a file with the same name in the same location be overwritten?
+     * @param keepBoth Keep both if file with the same name in the same location already exists? Only relevant when shouldOverWrite is set to false.
+     */
+    _File.prototype.copyByPath = function (destUrl, shouldOverWrite, KeepBoth) {
+        if (KeepBoth === void 0) { KeepBoth = false; }
+        return __awaiter(this, void 0, void 0, function () {
+            var _a, srcUrl, absoluteUrl, webBaseUrl, hostUrl;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0: return [4 /*yield*/, this.select("ServerRelativeUrl")()];
+                    case 1:
+                        _a = _b.sent(), srcUrl = _a.ServerRelativeUrl, absoluteUrl = _a["odata.id"];
+                        webBaseUrl = extractWebUrl(absoluteUrl);
+                        hostUrl = webBaseUrl.replace("://", "___").split("/")[0].replace("___", "://");
+                        return [4 /*yield*/, spPost(File(webBaseUrl, "/_api/SP.MoveCopyUtil.CopyFileByPath(overwrite=@a1)?@a1=" + shouldOverWrite), body({
+                                destPath: toResourcePath(isUrlAbsolute(destUrl) ? destUrl : "" + hostUrl + destUrl),
+                                options: {
+                                    KeepBoth: KeepBoth,
+                                    ResetAuthorAndCreatedOnCopy: true,
+                                    ShouldBypassSharedLocks: true,
+                                    __metadata: {
+                                        type: "SP.MoveCopyOptions",
+                                    },
+                                },
+                                srcPath: toResourcePath(isUrlAbsolute(srcUrl) ? srcUrl : "" + hostUrl + srcUrl),
+                            }))];
+                    case 2:
+                        _b.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * Denies approval for a file that was submitted for content approval.
+     * Only documents in lists that are enabled for content approval can be denied.
+     *
+     * @param comment The comment for the denial.
+     */
+    _File.prototype.deny = function (comment) {
+        if (comment === void 0) { comment = ""; }
+        if (comment.length > 1023) {
+            throw Error("The maximum comment length is 1023 characters.");
+        }
+        return spPost(this.clone(File, "deny(comment='" + escapeQueryStrValue(comment) + "')"));
+    };
+    /**
+     * Moves the file to the specified destination url.
+     *
+     * @param url The absolute url or server relative url of the destination file path to move to.
+     * @param moveOperations The bitwise MoveOperations value for how to move the file.
+     */
+    _File.prototype.moveTo = function (url, moveOperations) {
+        if (moveOperations === void 0) { moveOperations = MoveOperations.Overwrite; }
+        return spPost(this.clone(File, "moveTo(newurl='" + escapeQueryStrValue(url) + "',flags=" + moveOperations + ")"));
+    };
+    /**
+     * Moves the file by path to the specified destination url.
+     * Also works with different site collections.
+     *
+     * @param destUrl The absolute url or server relative url of the destination file path to move to.
+     * @param shouldOverWrite Should a file with the same name in the same location be overwritten?
+     * @param keepBoth Keep both if file with the same name in the same location already exists? Only relevant when shouldOverWrite is set to false.
+     */
+    _File.prototype.moveByPath = function (destUrl, shouldOverWrite, KeepBoth) {
+        if (KeepBoth === void 0) { KeepBoth = false; }
+        return __awaiter(this, void 0, void 0, function () {
+            var _a, srcUrl, absoluteUrl, webBaseUrl, hostUrl;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0: return [4 /*yield*/, this.select("ServerRelativeUrl")()];
+                    case 1:
+                        _a = _b.sent(), srcUrl = _a.ServerRelativeUrl, absoluteUrl = _a["odata.id"];
+                        webBaseUrl = extractWebUrl(absoluteUrl);
+                        hostUrl = webBaseUrl.replace("://", "___").split("/")[0].replace("___", "://");
+                        return [4 /*yield*/, spPost(File(webBaseUrl, "/_api/SP.MoveCopyUtil.MoveFileByPath(overwrite=@a1)?@a1=" + shouldOverWrite), body({
+                                destPath: toResourcePath(isUrlAbsolute(destUrl) ? destUrl : "" + hostUrl + destUrl),
+                                options: {
+                                    KeepBoth: KeepBoth,
+                                    ResetAuthorAndCreatedOnCopy: false,
+                                    ShouldBypassSharedLocks: true,
+                                    __metadata: {
+                                        type: "SP.MoveCopyOptions",
+                                    },
+                                },
+                                srcPath: toResourcePath(isUrlAbsolute(srcUrl) ? srcUrl : "" + hostUrl + srcUrl),
+                            }))];
+                    case 2:
+                        _b.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * Submits the file for content approval with the specified comment.
+     *
+     * @param comment The comment for the published file. Its length must be <= 1023.
+     */
+    _File.prototype.publish = function (comment) {
+        if (comment === void 0) { comment = ""; }
+        if (comment.length > 1023) {
+            throw Error("The maximum comment length is 1023 characters.");
+        }
+        return spPost(this.clone(File, "publish(comment='" + escapeQueryStrValue(comment) + "')"));
+    };
+    /**
+     * Moves the file to the Recycle Bin and returns the identifier of the new Recycle Bin item.
+     *
+     * @returns The GUID of the recycled file.
+     */
+    _File.prototype.recycle = function () {
+        return spPost(this.clone(File, "recycle"));
+    };
+    /**
+     * Deletes the file object with options.
+     *
+     * @param parameters Specifies the options to use when deleting a file.
+     */
+    _File.prototype.deleteWithParams = function (parameters) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, spPost(this.clone(File, "DeleteWithParameters"), body({ parameters: parameters }))];
+            });
+        });
+    };
+    /**
+     * Reverts an existing checkout for the file.
+     *
+     */
+    _File.prototype.undoCheckout = function () {
+        return spPost(this.clone(File, "undoCheckout"));
+    };
+    /**
+     * Removes the file from content approval or unpublish a major version.
+     *
+     * @param comment The comment for the unpublish operation. Its length must be <= 1023.
+     */
+    _File.prototype.unpublish = function (comment) {
+        if (comment === void 0) { comment = ""; }
+        if (comment.length > 1023) {
+            throw Error("The maximum comment length is 1023 characters.");
+        }
+        return spPost(this.clone(File, "unpublish(comment='" + escapeQueryStrValue(comment) + "')"));
+    };
+    /**
+     * Checks to see if the file represented by this object exists
+     *
+     */
+    _File.prototype.exists = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var r, e_1;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 2, , 3]);
+                        return [4 /*yield*/, this.clone(File).select("Exists")()];
+                    case 1:
+                        r = _a.sent();
+                        return [2 /*return*/, r.Exists];
+                    case 2:
+                        e_1 = _a.sent();
+                        // this treats any error here as the file not existing, which
+                        // might not be true, but is good enough.
+                        return [2 /*return*/, false];
+                    case 3: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * Gets the contents of the file as text. Not supported in batching.
+     *
+     */
+    _File.prototype.getText = function () {
+        return this.clone(File, "$value", false).usingParser(new TextParser())(headers({ "binaryStringResponseBody": "true" }));
+    };
+    /**
+     * Gets the contents of the file as a blob, does not work in Node.js. Not supported in batching.
+     *
+     */
+    _File.prototype.getBlob = function () {
+        return this.clone(File, "$value", false).usingParser(new BlobParser())(headers({ "binaryStringResponseBody": "true" }));
+    };
+    /**
+     * Gets the contents of a file as an ArrayBuffer, works in Node.js. Not supported in batching.
+     */
+    _File.prototype.getBuffer = function () {
+        return this.clone(File, "$value", false).usingParser(new BufferParser())(headers({ "binaryStringResponseBody": "true" }));
+    };
+    /**
+     * Gets the contents of a file as an ArrayBuffer, works in Node.js. Not supported in batching.
+     */
+    _File.prototype.getJSON = function () {
+        return this.clone(File, "$value", false).usingParser(new JSONParser())(headers({ "binaryStringResponseBody": "true" }));
+    };
+    /**
+     * Sets the content of a file, for large files use setContentChunked. Not supported in batching.
+     *
+     * @param content The file content
+     *
+     */
+    _File.prototype.setContent = function (content) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, spPost(this.clone(File, "$value", false), {
+                            body: content,
+                            headers: {
+                                "X-HTTP-Method": "PUT",
+                            },
+                        })];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/, File(this)];
+                }
+            });
+        });
+    };
+    /**
+     * Gets the associated list item for this file, loading the default properties
+     */
+    _File.prototype.getItem = function () {
+        var selects = [];
+        for (var _i = 0; _i < arguments.length; _i++) {
+            selects[_i] = arguments[_i];
+        }
+        return __awaiter(this, void 0, void 0, function () {
+            var q, d;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        q = this.listItemAllFields;
+                        return [4 /*yield*/, q.select.apply(q, __spreadArray([], __read(selects), false))()];
+                    case 1:
+                        d = _a.sent();
+                        return [2 /*return*/, assign(Item(odataUrlFrom(d)), d)];
+                }
+            });
+        });
+    };
+    /**
+     * Sets the contents of a file using a chunked upload approach. Not supported in batching.
+     *
+     * @param file The file to upload
+     * @param progress A callback function which can be used to track the progress of the upload
+     * @param chunkSize The size of each file slice, in bytes (default: 10485760)
+     */
+    _File.prototype.setContentChunked = function (file, progress, chunkSize) {
+        if (chunkSize === void 0) { chunkSize = 10485760; }
+        return __awaiter(this, void 0, void 0, function () {
+            var fileSize, totalBlocks, uploadId, currentPointer, i;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (!isFunc(progress)) {
+                            progress = function () { return null; };
+                        }
+                        fileSize = file.size;
+                        totalBlocks = parseInt((fileSize / chunkSize).toString(), 10) + ((fileSize % chunkSize === 0) ? 1 : 0);
+                        uploadId = getGUID();
+                        // report that we are starting
+                        progress({ uploadId: uploadId, blockNumber: 1, chunkSize: chunkSize, currentPointer: 0, fileSize: fileSize, stage: "starting", totalBlocks: totalBlocks });
+                        return [4 /*yield*/, this.startUpload(uploadId, file.slice(0, chunkSize))];
+                    case 1:
+                        currentPointer = _a.sent();
+                        i = 2;
+                        _a.label = 2;
+                    case 2:
+                        if (!(i < totalBlocks)) return [3 /*break*/, 5];
+                        progress({ uploadId: uploadId, blockNumber: i, chunkSize: chunkSize, currentPointer: currentPointer, fileSize: fileSize, stage: "continue", totalBlocks: totalBlocks });
+                        return [4 /*yield*/, this.continueUpload(uploadId, currentPointer, file.slice(currentPointer, currentPointer + chunkSize))];
+                    case 3:
+                        currentPointer = _a.sent();
+                        _a.label = 4;
+                    case 4:
+                        i++;
+                        return [3 /*break*/, 2];
+                    case 5:
+                        progress({ uploadId: uploadId, blockNumber: totalBlocks, chunkSize: chunkSize, currentPointer: currentPointer, fileSize: fileSize, stage: "finishing", totalBlocks: totalBlocks });
+                        return [2 /*return*/, this.finishUpload(uploadId, currentPointer, file.slice(currentPointer))];
+                }
+            });
+        });
+    };
+    /**
+     * Starts a new chunk upload session and uploads the first fragment.
+     * The current file content is not changed when this method completes.
+     * The method is idempotent (and therefore does not change the result) as long as you use the same values for uploadId and stream.
+     * The upload session ends either when you use the CancelUpload method or when you successfully
+     * complete the upload session by passing the rest of the file contents through the ContinueUpload and FinishUpload methods.
+     * The StartUpload and ContinueUpload methods return the size of the running total of uploaded data in bytes,
+     * so you can pass those return values to subsequent uses of ContinueUpload and FinishUpload.
+     * This method is currently available only on Office 365.
+     *
+     * @param uploadId The unique identifier of the upload session.
+     * @param fragment The file contents.
+     * @returns The size of the total uploaded data in bytes.
+     */
+    _File.prototype.startUpload = function (uploadId, fragment) {
+        return __awaiter(this, void 0, void 0, function () {
+            var n;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, spPost(this.clone(File, "startUpload(uploadId=guid'" + uploadId + "')", false), { body: fragment })];
+                    case 1:
+                        n = _a.sent();
+                        if (typeof n === "object") {
+                            // When OData=verbose the payload has the following shape:
+                            // { StartUpload: "10485760" }
+                            n = n.StartUpload;
+                        }
+                        return [2 /*return*/, parseFloat(n)];
+                }
+            });
+        });
+    };
+    /**
+     * Continues the chunk upload session with an additional fragment.
+     * The current file content is not changed.
+     * Use the uploadId value that was passed to the StartUpload method that started the upload session.
+     * This method is currently available only on Office 365.
+     *
+     * @param uploadId The unique identifier of the upload session.
+     * @param fileOffset The size of the offset into the file where the fragment starts.
+     * @param fragment The file contents.
+     * @returns The size of the total uploaded data in bytes.
+     */
+    _File.prototype.continueUpload = function (uploadId, fileOffset, fragment) {
+        return __awaiter(this, void 0, void 0, function () {
+            var n;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, spPost(this.clone(File, "continueUpload(uploadId=guid'" + uploadId + "',fileOffset=" + fileOffset + ")", false), { body: fragment })];
+                    case 1:
+                        n = _a.sent();
+                        if (typeof n === "object") {
+                            // When OData=verbose the payload has the following shape:
+                            // { ContinueUpload: "20971520" }
+                            n = n.ContinueUpload;
+                        }
+                        return [2 /*return*/, parseFloat(n)];
+                }
+            });
+        });
+    };
+    /**
+     * Uploads the last file fragment and commits the file. The current file content is changed when this method completes.
+     * Use the uploadId value that was passed to the StartUpload method that started the upload session.
+     * This method is currently available only on Office 365.
+     *
+     * @param uploadId The unique identifier of the upload session.
+     * @param fileOffset The size of the offset into the file where the fragment starts.
+     * @param fragment The file contents.
+     * @returns The newly uploaded file.
+     */
+    _File.prototype.finishUpload = function (uploadId, fileOffset, fragment) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, spPost(this.clone(File, "finishUpload(uploadId=guid'" + uploadId + "',fileOffset=" + fileOffset + ")", false), { body: fragment })];
+                    case 1:
+                        response = _a.sent();
+                        return [2 /*return*/, {
+                                data: response,
+                                file: File(odataUrlFrom(response)),
+                            }];
+                }
+            });
+        });
+    };
+    __decorate([
+        tag("fi.approve")
+    ], _File.prototype, "approve", null);
+    __decorate([
+        tag("fi.cancelUpload")
+    ], _File.prototype, "cancelUpload", null);
+    __decorate([
+        tag("fi.checkin")
+    ], _File.prototype, "checkin", null);
+    __decorate([
+        tag("fi.checkout")
+    ], _File.prototype, "checkout", null);
+    __decorate([
+        tag("fi.copyTo")
+    ], _File.prototype, "copyTo", null);
+    __decorate([
+        tag("fi.copyByPath")
+    ], _File.prototype, "copyByPath", null);
+    __decorate([
+        tag("fi.deny")
+    ], _File.prototype, "deny", null);
+    __decorate([
+        tag("fi.moveTo")
+    ], _File.prototype, "moveTo", null);
+    __decorate([
+        tag("fi.moveByPath")
+    ], _File.prototype, "moveByPath", null);
+    __decorate([
+        tag("fi.publish")
+    ], _File.prototype, "publish", null);
+    __decorate([
+        tag("fi.recycle")
+    ], _File.prototype, "recycle", null);
+    __decorate([
+        tag("fi.del-params")
+    ], _File.prototype, "deleteWithParams", null);
+    __decorate([
+        tag("fi.undoCheckout")
+    ], _File.prototype, "undoCheckout", null);
+    __decorate([
+        tag("fi.unpublish")
+    ], _File.prototype, "unpublish", null);
+    __decorate([
+        tag("fi.exists")
+    ], _File.prototype, "exists", null);
+    __decorate([
+        tag("fi.getText")
+    ], _File.prototype, "getText", null);
+    __decorate([
+        tag("fi.getBlob")
+    ], _File.prototype, "getBlob", null);
+    __decorate([
+        tag("fi.getBuffer")
+    ], _File.prototype, "getBuffer", null);
+    __decorate([
+        tag("fi.getJSON")
+    ], _File.prototype, "getJSON", null);
+    __decorate([
+        tag("fi.setContent")
+    ], _File.prototype, "setContent", null);
+    __decorate([
+        tag("fi.getItem")
+    ], _File.prototype, "getItem", null);
+    __decorate([
+        tag("fi.startUpload")
+    ], _File.prototype, "startUpload", null);
+    __decorate([
+        tag("fi.continueUpload")
+    ], _File.prototype, "continueUpload", null);
+    __decorate([
+        tag("fi.finishUpload")
+    ], _File.prototype, "finishUpload", null);
+    return _File;
+}(_SharePointQueryableInstance));
+export { _File };
+export var File = spInvokableFactory(_File);
+/**
+ * Describes a collection of Version objects
+ *
+ */
+var _Versions = /** @class */ (function (_super) {
+    __extends(_Versions, _super);
+    function _Versions() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    /**
+     * Gets a version by id
+     *
+     * @param versionId The id of the version to retrieve
+     */
+    _Versions.prototype.getById = function (versionId) {
+        return tag.configure(Version(this).concat("(" + versionId + ")"), "vers.getById");
+    };
+    /**
+     * Deletes all the file version objects in the collection.
+     *
+     */
+    _Versions.prototype.deleteAll = function () {
+        return spPost(Versions(this, "deleteAll"));
+    };
+    /**
+     * Deletes the specified version of the file.
+     *
+     * @param versionId The ID of the file version to delete.
+     */
+    _Versions.prototype.deleteById = function (versionId) {
+        return spPost(this.clone(Versions, "deleteById(vid=" + versionId + ")"));
+    };
+    /**
+     * Recycles the specified version of the file.
+     *
+     * @param versionId The ID of the file version to delete.
+     */
+    _Versions.prototype.recycleByID = function (versionId) {
+        return spPost(this.clone(Versions, "recycleByID(vid=" + versionId + ")"));
+    };
+    /**
+     * Deletes the file version object with the specified version label.
+     *
+     * @param label The version label of the file version to delete, for example: 1.2
+     */
+    _Versions.prototype.deleteByLabel = function (label) {
+        return spPost(this.clone(Versions, "deleteByLabel(versionlabel='" + escapeQueryStrValue(label) + "')"));
+    };
+    /**
+     * Recycles the file version object with the specified version label.
+     *
+     * @param label The version label of the file version to delete, for example: 1.2
+     */
+    _Versions.prototype.recycleByLabel = function (label) {
+        return spPost(this.clone(Versions, "recycleByLabel(versionlabel='" + escapeQueryStrValue(label) + "')"));
+    };
+    /**
+     * Creates a new file version from the file specified by the version label.
+     *
+     * @param label The version label of the file version to restore, for example: 1.2
+     */
+    _Versions.prototype.restoreByLabel = function (label) {
+        return spPost(this.clone(Versions, "restoreByLabel(versionlabel='" + escapeQueryStrValue(label) + "')"));
+    };
+    __decorate([
+        tag("vers.deleteAll")
+    ], _Versions.prototype, "deleteAll", null);
+    __decorate([
+        tag("vers.deleteById")
+    ], _Versions.prototype, "deleteById", null);
+    __decorate([
+        tag("vers.recycleByID")
+    ], _Versions.prototype, "recycleByID", null);
+    __decorate([
+        tag("vers.deleteByLabel")
+    ], _Versions.prototype, "deleteByLabel", null);
+    __decorate([
+        tag("vers.recycleByLabel")
+    ], _Versions.prototype, "recycleByLabel", null);
+    __decorate([
+        tag("vers.restoreByLabel")
+    ], _Versions.prototype, "restoreByLabel", null);
+    _Versions = __decorate([
+        defaultPath("versions")
+    ], _Versions);
+    return _Versions;
+}(_SharePointQueryableCollection));
+export { _Versions };
+export var Versions = spInvokableFactory(_Versions);
+/**
+ * Describes a single Version instance
+ *
+ */
+var _Version = /** @class */ (function (_super) {
+    __extends(_Version, _super);
+    function _Version() {
+        var _this = _super !== null && _super.apply(this, arguments) || this;
+        _this.delete = deleteableWithETag("ver");
+        return _this;
+    }
+    return _Version;
+}(_SharePointQueryableInstance));
+export { _Version };
+export var Version = spInvokableFactory(_Version);
+/**
+ * Types for document check in.
+ * Minor = 0
+ * Major = 1
+ * Overwrite = 2
+ */
+export var CheckinType;
+(function (CheckinType) {
+    CheckinType[CheckinType["Minor"] = 0] = "Minor";
+    CheckinType[CheckinType["Major"] = 1] = "Major";
+    CheckinType[CheckinType["Overwrite"] = 2] = "Overwrite";
+})(CheckinType || (CheckinType = {}));
+/**
+ * File move opertions
+ */
+export var MoveOperations;
+(function (MoveOperations) {
+    /**
+     * Produce an error if a file with the same name exists in the destination
+     */
+    MoveOperations[MoveOperations["None"] = 0] = "None";
+    /**
+     * Overwrite a file with the same name if it exists. Value is 1.
+     */
+    MoveOperations[MoveOperations["Overwrite"] = 1] = "Overwrite";
+    /**
+     * Complete the move operation even if supporting files are separated from the file. Value is 8.
+     */
+    MoveOperations[MoveOperations["AllowBrokenThickets"] = 8] = "AllowBrokenThickets";
+    /**
+     * Boolean specifying whether to retain the source of the move's editor and modified by datetime.
+     */
+    MoveOperations[MoveOperations["RetainEditorAndModifiedOnMove"] = 2048] = "RetainEditorAndModifiedOnMove";
+})(MoveOperations || (MoveOperations = {}));
+export var TemplateFileType;
+(function (TemplateFileType) {
+    TemplateFileType[TemplateFileType["StandardPage"] = 0] = "StandardPage";
+    TemplateFileType[TemplateFileType["WikiPage"] = 1] = "WikiPage";
+    TemplateFileType[TemplateFileType["FormPage"] = 2] = "FormPage";
+    TemplateFileType[TemplateFileType["ClientSidePage"] = 3] = "ClientSidePage";
+})(TemplateFileType || (TemplateFileType = {}));
 //# sourceMappingURL=types.js.map