@pnp/sp 2.8.0 → 2.12.0

package/attachments/types.d.ts

@@ -1,93 +1,93 @@
-import { _SharePointQueryableInstance, _SharePointQueryableCollection, IDeleteableWithETag } from "../sharepointqueryable.js";
-export declare class _Attachments extends _SharePointQueryableCollection<IAttachmentInfo[]> {
-    /**
-    * Gets a Attachment File by filename
-    *
-    * @param name The name of the file, including extension.
-    */
-    getByName(name: string): IAttachment;
-    /**
-     * Adds a new attachment to the collection. Not supported for batching.
-     *
-     * @param name The name of the file, including extension.
-     * @param content The Base64 file content.
-     */
-    add(name: string, content: string | Blob | ArrayBuffer): Promise<IAttachmentAddResult>;
-    /**
-     * Adds multiple new attachment to the collection. Not supported for batching.
-     *
-     * @param files The collection of files to add
-     */
-    addMultiple(files: IAttachmentFileInfo[]): Promise<void>;
-    /**
-     * Delete multiple attachments from the collection. Not supported for batching.
-     *
-     * @param files The collection of files to delete
-     */
-    deleteMultiple(...files: string[]): Promise<void>;
-    /**
-     * Delete multiple attachments from the collection and send to recycle bin. Not supported for batching.
-     *
-     * @param files The collection of files to be deleted and sent to recycle bin
-     */
-    recycleMultiple(...files: string[]): Promise<void>;
-}
-export interface IAttachments extends _Attachments {
-}
-export declare const Attachments: import("../sharepointqueryable.js").ISPInvokableFactory<IAttachments>;
-export declare class _Attachment extends _SharePointQueryableInstance<IAttachmentInfo> {
-    delete: (this: import("../sharepointqueryable.js").ISharePointQueryable<any>, eTag?: string) => Promise<void>;
-    /**
-     * Gets the contents of the file as text
-     *
-     */
-    getText(): Promise<string>;
-    /**
-     * Gets the contents of the file as a blob, does not work in Node.js
-     *
-     */
-    getBlob(): Promise<Blob>;
-    /**
-     * Gets the contents of a file as an ArrayBuffer, works in Node.js
-     */
-    getBuffer(): Promise<ArrayBuffer>;
-    /**
-     * Gets the contents of a file as an ArrayBuffer, works in Node.js
-     */
-    getJSON(): Promise<any>;
-    /**
-     * Sets the content of a file. Not supported for batching
-     *
-     * @param content The value to set for the file contents
-     */
-    setContent(content: string | ArrayBuffer | Blob): Promise<IAttachment>;
-    /**
-     * Delete this attachment file and send it to recycle bin
-     *
-     * @param eTag Value used in the IF-Match header, by default "*"
-     */
-    recycle(eTag?: string): Promise<void>;
-    private getParsed;
-}
-export interface IAttachment extends _Attachment, IDeleteableWithETag {
-}
-export declare const Attachment: import("../sharepointqueryable.js").ISPInvokableFactory<IAttachment>;
-export interface IAttachmentAddResult {
-    file: IAttachment;
-    data: IAttachmentFileInfo;
-}
-export interface IAttachmentFileInfo {
-    name: string;
-    content: string | Blob | ArrayBuffer;
-}
-export interface IAttachmentInfo {
-    FileName: string;
-    FileNameAsPath: {
-        DecodedUrl: string;
-    };
-    ServerRelativePath: {
-        DecodedUrl: string;
-    };
-    ServerRelativeUrl: string;
-}
+import { _SharePointQueryableInstance, _SharePointQueryableCollection, IDeleteableWithETag } from "../sharepointqueryable.js";
+export declare class _Attachments extends _SharePointQueryableCollection<IAttachmentInfo[]> {
+    /**
+    * Gets a Attachment File by filename
+    *
+    * @param name The name of the file, including extension.
+    */
+    getByName(name: string): IAttachment;
+    /**
+     * Adds a new attachment to the collection. Not supported for batching.
+     *
+     * @param name The name of the file, including extension.
+     * @param content The Base64 file content.
+     */
+    add(name: string, content: string | Blob | ArrayBuffer): Promise<IAttachmentAddResult>;
+    /**
+     * Adds multiple new attachment to the collection. Not supported for batching.
+     *
+     * @param files The collection of files to add
+     */
+    addMultiple(files: IAttachmentFileInfo[]): Promise<void>;
+    /**
+     * Delete multiple attachments from the collection. Not supported for batching.
+     *
+     * @param files The collection of files to delete
+     */
+    deleteMultiple(...files: string[]): Promise<void>;
+    /**
+     * Delete multiple attachments from the collection and send to recycle bin. Not supported for batching.
+     *
+     * @param files The collection of files to be deleted and sent to recycle bin
+     */
+    recycleMultiple(...files: string[]): Promise<void>;
+}
+export interface IAttachments extends _Attachments {
+}
+export declare const Attachments: import("../sharepointqueryable.js").ISPInvokableFactory<IAttachments>;
+export declare class _Attachment extends _SharePointQueryableInstance<IAttachmentInfo> {
+    delete: (this: import("../sharepointqueryable.js").ISharePointQueryable<any>, eTag?: string) => Promise<void>;
+    /**
+     * Gets the contents of the file as text
+     *
+     */
+    getText(): Promise<string>;
+    /**
+     * Gets the contents of the file as a blob, does not work in Node.js
+     *
+     */
+    getBlob(): Promise<Blob>;
+    /**
+     * Gets the contents of a file as an ArrayBuffer, works in Node.js
+     */
+    getBuffer(): Promise<ArrayBuffer>;
+    /**
+     * Gets the contents of a file as an ArrayBuffer, works in Node.js
+     */
+    getJSON(): Promise<any>;
+    /**
+     * Sets the content of a file. Not supported for batching
+     *
+     * @param content The value to set for the file contents
+     */
+    setContent(content: string | ArrayBuffer | Blob): Promise<IAttachment>;
+    /**
+     * Delete this attachment file and send it to recycle bin
+     *
+     * @param eTag Value used in the IF-Match header, by default "*"
+     */
+    recycle(eTag?: string): Promise<void>;
+    private getParsed;
+}
+export interface IAttachment extends _Attachment, IDeleteableWithETag {
+}
+export declare const Attachment: import("../sharepointqueryable.js").ISPInvokableFactory<IAttachment>;
+export interface IAttachmentAddResult {
+    file: IAttachment;
+    data: IAttachmentFileInfo;
+}
+export interface IAttachmentFileInfo {
+    name: string;
+    content: string | Blob | ArrayBuffer;
+}
+export interface IAttachmentInfo {
+    FileName: string;
+    FileNameAsPath: {
+        DecodedUrl: string;
+    };
+    ServerRelativePath: {
+        DecodedUrl: string;
+    };
+    ServerRelativeUrl: string;
+}
 //# sourceMappingURL=types.d.ts.map

package/attachments/types.js

@@ -1,241 +1,241 @@
-import { __awaiter, __decorate, __extends, __generator } from "tslib";
-import { defaultPath } from "../decorators.js";
-import { spPost } from "../operations.js";
-import { _SharePointQueryableInstance, _SharePointQueryableCollection, spInvokableFactory, deleteableWithETag, } from "../sharepointqueryable.js";
-import { TextParser, BlobParser, JSONParser, BufferParser, headers } from "@pnp/odata";
-import { tag } from "../telemetry.js";
-var _Attachments = /** @class */ (function (_super) {
-    __extends(_Attachments, _super);
-    function _Attachments() {
-        return _super !== null && _super.apply(this, arguments) || this;
-    }
-    /**
-    * Gets a Attachment File by filename
-    *
-    * @param name The name of the file, including extension.
-    */
-    _Attachments.prototype.getByName = function (name) {
-        var f = tag.configure(Attachment(this), "ats.getByName");
-        f.concat("('" + name + "')");
-        return f;
-    };
-    /**
-     * Adds a new attachment to the collection. Not supported for batching.
-     *
-     * @param name The name of the file, including extension.
-     * @param content The Base64 file content.
-     */
-    _Attachments.prototype.add = function (name, content) {
-        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(Attachments, "add(FileName='" + name + "')", false), { body: content })];
-                    case 1:
-                        response = _a.sent();
-                        return [2 /*return*/, {
-                                data: response,
-                                file: this.getByName(name),
-                            }];
-                }
-            });
-        });
-    };
-    /**
-     * Adds multiple new attachment to the collection. Not supported for batching.
-     *
-     * @param files The collection of files to add
-     */
-    _Attachments.prototype.addMultiple = function (files) {
-        return __awaiter(this, void 0, void 0, function () {
-            var i;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        i = 0;
-                        _a.label = 1;
-                    case 1:
-                        if (!(i < files.length)) return [3 /*break*/, 4];
-                        return [4 /*yield*/, this.add(files[i].name, files[i].content)];
-                    case 2:
-                        _a.sent();
-                        _a.label = 3;
-                    case 3:
-                        i++;
-                        return [3 /*break*/, 1];
-                    case 4: return [2 /*return*/];
-                }
-            });
-        });
-    };
-    /**
-     * Delete multiple attachments from the collection. Not supported for batching.
-     *
-     * @param files The collection of files to delete
-     */
-    _Attachments.prototype.deleteMultiple = function () {
-        var files = [];
-        for (var _i = 0; _i < arguments.length; _i++) {
-            files[_i] = arguments[_i];
-        }
-        return __awaiter(this, void 0, void 0, function () {
-            var i;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        i = 0;
-                        _a.label = 1;
-                    case 1:
-                        if (!(i < files.length)) return [3 /*break*/, 4];
-                        return [4 /*yield*/, this.getByName(files[i]).delete()];
-                    case 2:
-                        _a.sent();
-                        _a.label = 3;
-                    case 3:
-                        i++;
-                        return [3 /*break*/, 1];
-                    case 4: return [2 /*return*/];
-                }
-            });
-        });
-    };
-    /**
-     * Delete multiple attachments from the collection and send to recycle bin. Not supported for batching.
-     *
-     * @param files The collection of files to be deleted and sent to recycle bin
-     */
-    _Attachments.prototype.recycleMultiple = function () {
-        var files = [];
-        for (var _i = 0; _i < arguments.length; _i++) {
-            files[_i] = arguments[_i];
-        }
-        return __awaiter(this, void 0, void 0, function () {
-            var i;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        i = 0;
-                        _a.label = 1;
-                    case 1:
-                        if (!(i < files.length)) return [3 /*break*/, 4];
-                        return [4 /*yield*/, this.getByName(files[i]).recycle()];
-                    case 2:
-                        _a.sent();
-                        _a.label = 3;
-                    case 3:
-                        i++;
-                        return [3 /*break*/, 1];
-                    case 4: return [2 /*return*/];
-                }
-            });
-        });
-    };
-    __decorate([
-        tag("ats.add")
-    ], _Attachments.prototype, "add", null);
-    __decorate([
-        tag("ats.addMultiple")
-    ], _Attachments.prototype, "addMultiple", null);
-    __decorate([
-        tag("ats.deleteMultiple")
-    ], _Attachments.prototype, "deleteMultiple", null);
-    __decorate([
-        tag("ats.recycleMultiple")
-    ], _Attachments.prototype, "recycleMultiple", null);
-    _Attachments = __decorate([
-        defaultPath("AttachmentFiles")
-    ], _Attachments);
-    return _Attachments;
-}(_SharePointQueryableCollection));
-export { _Attachments };
-export var Attachments = spInvokableFactory(_Attachments);
-var _Attachment = /** @class */ (function (_super) {
-    __extends(_Attachment, _super);
-    function _Attachment() {
-        var _this = _super !== null && _super.apply(this, arguments) || this;
-        _this.delete = deleteableWithETag("at");
-        return _this;
-    }
-    /**
-     * Gets the contents of the file as text
-     *
-     */
-    _Attachment.prototype.getText = function () {
-        return this.getParsed(new TextParser());
-    };
-    /**
-     * Gets the contents of the file as a blob, does not work in Node.js
-     *
-     */
-    _Attachment.prototype.getBlob = function () {
-        return this.getParsed(new BlobParser());
-    };
-    /**
-     * Gets the contents of a file as an ArrayBuffer, works in Node.js
-     */
-    _Attachment.prototype.getBuffer = function () {
-        return this.getParsed(new BufferParser());
-    };
-    /**
-     * Gets the contents of a file as an ArrayBuffer, works in Node.js
-     */
-    _Attachment.prototype.getJSON = function () {
-        return this.getParsed(new JSONParser());
-    };
-    /**
-     * Sets the content of a file. Not supported for batching
-     *
-     * @param content The value to set for the file contents
-     */
-    _Attachment.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(Attachment, "$value", false), headers({ "X-HTTP-Method": "PUT" }, {
-                            body: content,
-                        }))];
-                    case 1:
-                        _a.sent();
-                        return [2 /*return*/, Attachment(this)];
-                }
-            });
-        });
-    };
-    /**
-     * Delete this attachment file and send it to recycle bin
-     *
-     * @param eTag Value used in the IF-Match header, by default "*"
-     */
-    _Attachment.prototype.recycle = function (eTag) {
-        if (eTag === void 0) { eTag = "*"; }
-        return spPost(this.clone(Attachment, "recycleObject"), headers({
-            "IF-Match": eTag,
-            "X-HTTP-Method": "DELETE",
-        }));
-    };
-    _Attachment.prototype.getParsed = function (parser) {
-        return this.clone(Attachment, "$value", false).usingParser(parser)();
-    };
-    __decorate([
-        tag("at.getText")
-    ], _Attachment.prototype, "getText", null);
-    __decorate([
-        tag("at.getBlob")
-    ], _Attachment.prototype, "getBlob", null);
-    __decorate([
-        tag("at.getBuffer")
-    ], _Attachment.prototype, "getBuffer", null);
-    __decorate([
-        tag("at.getJSON")
-    ], _Attachment.prototype, "getJSON", null);
-    __decorate([
-        tag("at.setContent")
-    ], _Attachment.prototype, "setContent", null);
-    __decorate([
-        tag("at.recycle")
-    ], _Attachment.prototype, "recycle", null);
-    return _Attachment;
-}(_SharePointQueryableInstance));
-export { _Attachment };
-export var Attachment = spInvokableFactory(_Attachment);
+import { __awaiter, __decorate, __extends, __generator } from "tslib";
+import { defaultPath } from "../decorators.js";
+import { spPost } from "../operations.js";
+import { _SharePointQueryableInstance, _SharePointQueryableCollection, spInvokableFactory, deleteableWithETag, } from "../sharepointqueryable.js";
+import { TextParser, BlobParser, JSONParser, BufferParser, headers } from "@pnp/odata";
+import { tag } from "../telemetry.js";
+var _Attachments = /** @class */ (function (_super) {
+    __extends(_Attachments, _super);
+    function _Attachments() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    /**
+    * Gets a Attachment File by filename
+    *
+    * @param name The name of the file, including extension.
+    */
+    _Attachments.prototype.getByName = function (name) {
+        var f = tag.configure(Attachment(this), "ats.getByName");
+        f.concat("('" + name + "')");
+        return f;
+    };
+    /**
+     * Adds a new attachment to the collection. Not supported for batching.
+     *
+     * @param name The name of the file, including extension.
+     * @param content The Base64 file content.
+     */
+    _Attachments.prototype.add = function (name, content) {
+        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(Attachments, "add(FileName='" + name + "')", false), { body: content })];
+                    case 1:
+                        response = _a.sent();
+                        return [2 /*return*/, {
+                                data: response,
+                                file: this.getByName(name),
+                            }];
+                }
+            });
+        });
+    };
+    /**
+     * Adds multiple new attachment to the collection. Not supported for batching.
+     *
+     * @param files The collection of files to add
+     */
+    _Attachments.prototype.addMultiple = function (files) {
+        return __awaiter(this, void 0, void 0, function () {
+            var i;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        i = 0;
+                        _a.label = 1;
+                    case 1:
+                        if (!(i < files.length)) return [3 /*break*/, 4];
+                        return [4 /*yield*/, this.add(files[i].name, files[i].content)];
+                    case 2:
+                        _a.sent();
+                        _a.label = 3;
+                    case 3:
+                        i++;
+                        return [3 /*break*/, 1];
+                    case 4: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * Delete multiple attachments from the collection. Not supported for batching.
+     *
+     * @param files The collection of files to delete
+     */
+    _Attachments.prototype.deleteMultiple = function () {
+        var files = [];
+        for (var _i = 0; _i < arguments.length; _i++) {
+            files[_i] = arguments[_i];
+        }
+        return __awaiter(this, void 0, void 0, function () {
+            var i;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        i = 0;
+                        _a.label = 1;
+                    case 1:
+                        if (!(i < files.length)) return [3 /*break*/, 4];
+                        return [4 /*yield*/, this.getByName(files[i]).delete()];
+                    case 2:
+                        _a.sent();
+                        _a.label = 3;
+                    case 3:
+                        i++;
+                        return [3 /*break*/, 1];
+                    case 4: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * Delete multiple attachments from the collection and send to recycle bin. Not supported for batching.
+     *
+     * @param files The collection of files to be deleted and sent to recycle bin
+     */
+    _Attachments.prototype.recycleMultiple = function () {
+        var files = [];
+        for (var _i = 0; _i < arguments.length; _i++) {
+            files[_i] = arguments[_i];
+        }
+        return __awaiter(this, void 0, void 0, function () {
+            var i;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        i = 0;
+                        _a.label = 1;
+                    case 1:
+                        if (!(i < files.length)) return [3 /*break*/, 4];
+                        return [4 /*yield*/, this.getByName(files[i]).recycle()];
+                    case 2:
+                        _a.sent();
+                        _a.label = 3;
+                    case 3:
+                        i++;
+                        return [3 /*break*/, 1];
+                    case 4: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    __decorate([
+        tag("ats.add")
+    ], _Attachments.prototype, "add", null);
+    __decorate([
+        tag("ats.addMultiple")
+    ], _Attachments.prototype, "addMultiple", null);
+    __decorate([
+        tag("ats.deleteMultiple")
+    ], _Attachments.prototype, "deleteMultiple", null);
+    __decorate([
+        tag("ats.recycleMultiple")
+    ], _Attachments.prototype, "recycleMultiple", null);
+    _Attachments = __decorate([
+        defaultPath("AttachmentFiles")
+    ], _Attachments);
+    return _Attachments;
+}(_SharePointQueryableCollection));
+export { _Attachments };
+export var Attachments = spInvokableFactory(_Attachments);
+var _Attachment = /** @class */ (function (_super) {
+    __extends(_Attachment, _super);
+    function _Attachment() {
+        var _this = _super !== null && _super.apply(this, arguments) || this;
+        _this.delete = deleteableWithETag("at");
+        return _this;
+    }
+    /**
+     * Gets the contents of the file as text
+     *
+     */
+    _Attachment.prototype.getText = function () {
+        return this.getParsed(new TextParser());
+    };
+    /**
+     * Gets the contents of the file as a blob, does not work in Node.js
+     *
+     */
+    _Attachment.prototype.getBlob = function () {
+        return this.getParsed(new BlobParser());
+    };
+    /**
+     * Gets the contents of a file as an ArrayBuffer, works in Node.js
+     */
+    _Attachment.prototype.getBuffer = function () {
+        return this.getParsed(new BufferParser());
+    };
+    /**
+     * Gets the contents of a file as an ArrayBuffer, works in Node.js
+     */
+    _Attachment.prototype.getJSON = function () {
+        return this.getParsed(new JSONParser());
+    };
+    /**
+     * Sets the content of a file. Not supported for batching
+     *
+     * @param content The value to set for the file contents
+     */
+    _Attachment.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(Attachment, "$value", false), headers({ "X-HTTP-Method": "PUT" }, {
+                            body: content,
+                        }))];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/, Attachment(this)];
+                }
+            });
+        });
+    };
+    /**
+     * Delete this attachment file and send it to recycle bin
+     *
+     * @param eTag Value used in the IF-Match header, by default "*"
+     */
+    _Attachment.prototype.recycle = function (eTag) {
+        if (eTag === void 0) { eTag = "*"; }
+        return spPost(this.clone(Attachment, "recycleObject"), headers({
+            "IF-Match": eTag,
+            "X-HTTP-Method": "DELETE",
+        }));
+    };
+    _Attachment.prototype.getParsed = function (parser) {
+        return this.clone(Attachment, "$value", false).usingParser(parser)();
+    };
+    __decorate([
+        tag("at.getText")
+    ], _Attachment.prototype, "getText", null);
+    __decorate([
+        tag("at.getBlob")
+    ], _Attachment.prototype, "getBlob", null);
+    __decorate([
+        tag("at.getBuffer")
+    ], _Attachment.prototype, "getBuffer", null);
+    __decorate([
+        tag("at.getJSON")
+    ], _Attachment.prototype, "getJSON", null);
+    __decorate([
+        tag("at.setContent")
+    ], _Attachment.prototype, "setContent", null);
+    __decorate([
+        tag("at.recycle")
+    ], _Attachment.prototype, "recycle", null);
+    return _Attachment;
+}(_SharePointQueryableInstance));
+export { _Attachment };
+export var Attachment = spInvokableFactory(_Attachment);
 //# sourceMappingURL=types.js.map