@pnp/sp 2.8.0 → 2.12.0

package/webparts/file.d.ts

@@ -1,16 +1,16 @@
-import { WebPartsPersonalizationScope, ILimitedWebPartManager } from "./types.js";
-declare module "../files/types" {
-    interface _File {
-        getLimitedWebPartManager(scope?: WebPartsPersonalizationScope): ILimitedWebPartManager;
-    }
-    interface IFile {
-        /**
-         * Specifies the control set used to access, modify, or add Web Parts associated with this Web Part Page and view.
-         * An exception is thrown if the file is not an ASPX page.
-         *
-         * @param scope The WebPartsPersonalizationScope view on the Web Parts page.
-         */
-        getLimitedWebPartManager(scope?: WebPartsPersonalizationScope): ILimitedWebPartManager;
-    }
-}
+import { WebPartsPersonalizationScope, ILimitedWebPartManager } from "./types.js";
+declare module "../files/types" {
+    interface _File {
+        getLimitedWebPartManager(scope?: WebPartsPersonalizationScope): ILimitedWebPartManager;
+    }
+    interface IFile {
+        /**
+         * Specifies the control set used to access, modify, or add Web Parts associated with this Web Part Page and view.
+         * An exception is thrown if the file is not an ASPX page.
+         *
+         * @param scope The WebPartsPersonalizationScope view on the Web Parts page.
+         */
+        getLimitedWebPartManager(scope?: WebPartsPersonalizationScope): ILimitedWebPartManager;
+    }
+}
 //# sourceMappingURL=file.d.ts.map

package/webparts/file.js

@@ -1,7 +1,7 @@
-import { _File } from "../files/types.js";
-import { WebPartsPersonalizationScope, LimitedWebPartManager } from "./types.js";
-_File.prototype.getLimitedWebPartManager = function (scope) {
-    if (scope === void 0) { scope = WebPartsPersonalizationScope.Shared; }
-    return LimitedWebPartManager(this, "getLimitedWebPartManager(scope=" + scope + ")");
-};
+import { _File } from "../files/types.js";
+import { WebPartsPersonalizationScope, LimitedWebPartManager } from "./types.js";
+_File.prototype.getLimitedWebPartManager = function (scope) {
+    if (scope === void 0) { scope = WebPartsPersonalizationScope.Shared; }
+    return LimitedWebPartManager(this, "getLimitedWebPartManager(scope=" + scope + ")");
+};
 //# sourceMappingURL=file.js.map

package/webparts/index.d.ts

@@ -1,3 +1,3 @@
-import "./file.js";
-export { ILimitedWebPartManager, WebPartsPersonalizationScope, WebPartDefinitions, WebPartDefinition, LimitedWebPartManager, IWebPartDefinitions, IWebPartDefinition, } from "./types.js";
+import "./file.js";
+export { ILimitedWebPartManager, WebPartsPersonalizationScope, WebPartDefinitions, WebPartDefinition, LimitedWebPartManager, IWebPartDefinitions, IWebPartDefinition, } from "./types.js";
 //# sourceMappingURL=index.d.ts.map

package/webparts/index.js

@@ -1,3 +1,3 @@
-import "./file.js";
-export { WebPartsPersonalizationScope, WebPartDefinitions, WebPartDefinition, LimitedWebPartManager, } from "./types.js";
+import "./file.js";
+export { WebPartsPersonalizationScope, WebPartDefinitions, WebPartDefinition, LimitedWebPartManager, } from "./types.js";
 //# sourceMappingURL=index.js.map

package/webparts/types.d.ts

@@ -1,84 +1,84 @@
-import { _SharePointQueryableInstance, _SharePointQueryableCollection, ISharePointQueryableInstance, _SharePointQueryable, ISharePointQueryable } from "../sharepointqueryable.js";
-export declare class _LimitedWebPartManager extends _SharePointQueryable implements ILimitedWebPartManager {
-    get scope(): ISharePointQueryable;
-    get webparts(): IWebPartDefinitions;
-    export(id: string): Promise<string>;
-    import(xml: string): Promise<any>;
-}
-export interface ILimitedWebPartManager {
-    /**
-     * Gets the scope of this web part manager (User = 0 or Shared = 1)
-     */
-    readonly scope: ISharePointQueryable;
-    /**
-     * Gets the set of web part definitions contained by this web part manager
-     */
-    readonly webparts: IWebPartDefinitions;
-    /**
-     * Exports a webpart definition
-     *
-     * @param id the GUID id of the definition to export
-     */
-    export(id: string): Promise<string>;
-    /**
-     * Imports a webpart
-     *
-     * @param xml webpart definition which must be valid XML in the .dwp or .webpart format
-     */
-    import(xml: string): Promise<any>;
-}
-export declare const LimitedWebPartManager: (baseUrl: string | ISharePointQueryable, path?: string) => ILimitedWebPartManager;
-export declare class _WebPartDefinitions extends _SharePointQueryableCollection {
-    /**
-     * Gets a web part definition from the collection by id
-     *
-     * @param id The storage ID of the SPWebPartDefinition to retrieve
-     */
-    getById(id: string): IWebPartDefinition;
-    /**
-     * Gets a web part definition from the collection by storage id
-     *
-     * @param id The WebPart.ID of the SPWebPartDefinition to retrieve
-     */
-    getByControlId(id: string): IWebPartDefinition;
-}
-export interface IWebPartDefinitions extends _WebPartDefinitions {
-}
-export declare const WebPartDefinitions: import("../sharepointqueryable.js").ISPInvokableFactory<IWebPartDefinitions>;
-export declare class _WebPartDefinition extends _SharePointQueryableInstance {
-    /**
-    * Gets the webpart information associated with this definition
-    */
-    get webpart(): ISharePointQueryableInstance;
-    /**
-     * Saves changes to the Web Part made using other properties and methods on the SPWebPartDefinition object
-     */
-    saveChanges(): Promise<any>;
-    /**
-     * Moves the Web Part to a different location on a Web Part Page
-     *
-     * @param zoneId The ID of the Web Part Zone to which to move the Web Part
-     * @param zoneIndex A Web Part zone index that specifies the position at which the Web Part is to be moved within the destination Web Part zone
-     */
-    moveTo(zoneId: string, zoneIndex: number): Promise<void>;
-    /**
-     * Closes the Web Part. If the Web Part is already closed, this method does nothing
-     */
-    close(): Promise<void>;
-    /**
-     * Opens the Web Part. If the Web Part is already closed, this method does nothing
-     */
-    open(): Promise<void>;
-    /**
-     * Removes a webpart from a page, all settings will be lost
-     */
-    delete(): Promise<void>;
-}
-export interface IWebPartDefinition extends _WebPartDefinition {
-}
-export declare const WebPartDefinition: import("../sharepointqueryable.js").ISPInvokableFactory<IWebPartDefinition>;
-export declare enum WebPartsPersonalizationScope {
-    User = 0,
-    Shared = 1
-}
+import { _SharePointQueryableInstance, _SharePointQueryableCollection, ISharePointQueryableInstance, _SharePointQueryable, ISharePointQueryable } from "../sharepointqueryable.js";
+export declare class _LimitedWebPartManager extends _SharePointQueryable implements ILimitedWebPartManager {
+    get scope(): ISharePointQueryable;
+    get webparts(): IWebPartDefinitions;
+    export(id: string): Promise<string>;
+    import(xml: string): Promise<any>;
+}
+export interface ILimitedWebPartManager {
+    /**
+     * Gets the scope of this web part manager (User = 0 or Shared = 1)
+     */
+    readonly scope: ISharePointQueryable;
+    /**
+     * Gets the set of web part definitions contained by this web part manager
+     */
+    readonly webparts: IWebPartDefinitions;
+    /**
+     * Exports a webpart definition
+     *
+     * @param id the GUID id of the definition to export
+     */
+    export(id: string): Promise<string>;
+    /**
+     * Imports a webpart
+     *
+     * @param xml webpart definition which must be valid XML in the .dwp or .webpart format
+     */
+    import(xml: string): Promise<any>;
+}
+export declare const LimitedWebPartManager: (baseUrl: string | ISharePointQueryable, path?: string) => ILimitedWebPartManager;
+export declare class _WebPartDefinitions extends _SharePointQueryableCollection {
+    /**
+     * Gets a web part definition from the collection by id
+     *
+     * @param id The storage ID of the SPWebPartDefinition to retrieve
+     */
+    getById(id: string): IWebPartDefinition;
+    /**
+     * Gets a web part definition from the collection by storage id
+     *
+     * @param id The WebPart.ID of the SPWebPartDefinition to retrieve
+     */
+    getByControlId(id: string): IWebPartDefinition;
+}
+export interface IWebPartDefinitions extends _WebPartDefinitions {
+}
+export declare const WebPartDefinitions: import("../sharepointqueryable.js").ISPInvokableFactory<IWebPartDefinitions>;
+export declare class _WebPartDefinition extends _SharePointQueryableInstance {
+    /**
+    * Gets the webpart information associated with this definition
+    */
+    get webpart(): ISharePointQueryableInstance;
+    /**
+     * Saves changes to the Web Part made using other properties and methods on the SPWebPartDefinition object
+     */
+    saveChanges(): Promise<any>;
+    /**
+     * Moves the Web Part to a different location on a Web Part Page
+     *
+     * @param zoneId The ID of the Web Part Zone to which to move the Web Part
+     * @param zoneIndex A Web Part zone index that specifies the position at which the Web Part is to be moved within the destination Web Part zone
+     */
+    moveTo(zoneId: string, zoneIndex: number): Promise<void>;
+    /**
+     * Closes the Web Part. If the Web Part is already closed, this method does nothing
+     */
+    close(): Promise<void>;
+    /**
+     * Opens the Web Part. If the Web Part is already closed, this method does nothing
+     */
+    open(): Promise<void>;
+    /**
+     * Removes a webpart from a page, all settings will be lost
+     */
+    delete(): Promise<void>;
+}
+export interface IWebPartDefinition extends _WebPartDefinition {
+}
+export declare const WebPartDefinition: import("../sharepointqueryable.js").ISPInvokableFactory<IWebPartDefinition>;
+export declare enum WebPartsPersonalizationScope {
+    User = 0,
+    Shared = 1
+}
 //# sourceMappingURL=types.d.ts.map

package/webparts/types.js

@@ -1,118 +1,118 @@
-import { __extends } from "tslib";
-import { _SharePointQueryableInstance, _SharePointQueryableCollection, _SharePointQueryable, spInvokableFactory, SharePointQueryable, SharePointQueryableInstance, } from "../sharepointqueryable.js";
-import { body } from "@pnp/odata";
-import { spPost } from "../operations.js";
-import { tag } from "../telemetry.js";
-var _LimitedWebPartManager = /** @class */ (function (_super) {
-    __extends(_LimitedWebPartManager, _super);
-    function _LimitedWebPartManager() {
-        return _super !== null && _super.apply(this, arguments) || this;
-    }
-    Object.defineProperty(_LimitedWebPartManager.prototype, "scope", {
-        get: function () {
-            return tag.configure(SharePointQueryable(this, "Scope"), "f.scope");
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(_LimitedWebPartManager.prototype, "webparts", {
-        get: function () {
-            return WebPartDefinitions(this, "webparts");
-        },
-        enumerable: false,
-        configurable: true
-    });
-    _LimitedWebPartManager.prototype.export = function (id) {
-        return spPost(this.clone(LimitedWebPartManagerCloneFactory, "ExportWebPart"), body({ webPartId: id }));
-    };
-    _LimitedWebPartManager.prototype.import = function (xml) {
-        return spPost(this.clone(LimitedWebPartManagerCloneFactory, "ImportWebPart"), body({ webPartXml: xml }));
-    };
-    return _LimitedWebPartManager;
-}(_SharePointQueryable));
-export { _LimitedWebPartManager };
-export var LimitedWebPartManager = function (baseUrl, path) { return new _LimitedWebPartManager(baseUrl, path); };
-var LimitedWebPartManagerCloneFactory = function (baseUrl, path) { return LimitedWebPartManager(baseUrl, path); };
-var _WebPartDefinitions = /** @class */ (function (_super) {
-    __extends(_WebPartDefinitions, _super);
-    function _WebPartDefinitions() {
-        return _super !== null && _super.apply(this, arguments) || this;
-    }
-    /**
-     * Gets a web part definition from the collection by id
-     *
-     * @param id The storage ID of the SPWebPartDefinition to retrieve
-     */
-    _WebPartDefinitions.prototype.getById = function (id) {
-        return WebPartDefinition(this, "getbyid('" + id + "')");
-    };
-    /**
-     * Gets a web part definition from the collection by storage id
-     *
-     * @param id The WebPart.ID of the SPWebPartDefinition to retrieve
-     */
-    _WebPartDefinitions.prototype.getByControlId = function (id) {
-        return WebPartDefinition(this, "getByControlId('" + id + "')");
-    };
-    return _WebPartDefinitions;
-}(_SharePointQueryableCollection));
-export { _WebPartDefinitions };
-export var WebPartDefinitions = spInvokableFactory(_WebPartDefinitions);
-var _WebPartDefinition = /** @class */ (function (_super) {
-    __extends(_WebPartDefinition, _super);
-    function _WebPartDefinition() {
-        return _super !== null && _super.apply(this, arguments) || this;
-    }
-    Object.defineProperty(_WebPartDefinition.prototype, "webpart", {
-        /**
-        * Gets the webpart information associated with this definition
-        */
-        get: function () {
-            return SharePointQueryableInstance(this, "webpart");
-        },
-        enumerable: false,
-        configurable: true
-    });
-    /**
-     * Saves changes to the Web Part made using other properties and methods on the SPWebPartDefinition object
-     */
-    _WebPartDefinition.prototype.saveChanges = function () {
-        return spPost(this.clone(WebPartDefinition, "SaveWebPartChanges"));
-    };
-    /**
-     * Moves the Web Part to a different location on a Web Part Page
-     *
-     * @param zoneId The ID of the Web Part Zone to which to move the Web Part
-     * @param zoneIndex A Web Part zone index that specifies the position at which the Web Part is to be moved within the destination Web Part zone
-     */
-    _WebPartDefinition.prototype.moveTo = function (zoneId, zoneIndex) {
-        return spPost(this.clone(WebPartDefinition, "MoveWebPartTo(zoneID='" + zoneId + "', zoneIndex=" + zoneIndex + ")"));
-    };
-    /**
-     * Closes the Web Part. If the Web Part is already closed, this method does nothing
-     */
-    _WebPartDefinition.prototype.close = function () {
-        return spPost(this.clone(WebPartDefinition, "CloseWebPart"));
-    };
-    /**
-     * Opens the Web Part. If the Web Part is already closed, this method does nothing
-     */
-    _WebPartDefinition.prototype.open = function () {
-        return spPost(this.clone(WebPartDefinition, "OpenWebPart"));
-    };
-    /**
-     * Removes a webpart from a page, all settings will be lost
-     */
-    _WebPartDefinition.prototype.delete = function () {
-        return spPost(this.clone(WebPartDefinition, "DeleteWebPart"));
-    };
-    return _WebPartDefinition;
-}(_SharePointQueryableInstance));
-export { _WebPartDefinition };
-export var WebPartDefinition = spInvokableFactory(_WebPartDefinition);
-export var WebPartsPersonalizationScope;
-(function (WebPartsPersonalizationScope) {
-    WebPartsPersonalizationScope[WebPartsPersonalizationScope["User"] = 0] = "User";
-    WebPartsPersonalizationScope[WebPartsPersonalizationScope["Shared"] = 1] = "Shared";
-})(WebPartsPersonalizationScope || (WebPartsPersonalizationScope = {}));
+import { __extends } from "tslib";
+import { _SharePointQueryableInstance, _SharePointQueryableCollection, _SharePointQueryable, spInvokableFactory, SharePointQueryable, SharePointQueryableInstance, } from "../sharepointqueryable.js";
+import { body } from "@pnp/odata";
+import { spPost } from "../operations.js";
+import { tag } from "../telemetry.js";
+var _LimitedWebPartManager = /** @class */ (function (_super) {
+    __extends(_LimitedWebPartManager, _super);
+    function _LimitedWebPartManager() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    Object.defineProperty(_LimitedWebPartManager.prototype, "scope", {
+        get: function () {
+            return tag.configure(SharePointQueryable(this, "Scope"), "f.scope");
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(_LimitedWebPartManager.prototype, "webparts", {
+        get: function () {
+            return WebPartDefinitions(this, "webparts");
+        },
+        enumerable: false,
+        configurable: true
+    });
+    _LimitedWebPartManager.prototype.export = function (id) {
+        return spPost(this.clone(LimitedWebPartManagerCloneFactory, "ExportWebPart"), body({ webPartId: id }));
+    };
+    _LimitedWebPartManager.prototype.import = function (xml) {
+        return spPost(this.clone(LimitedWebPartManagerCloneFactory, "ImportWebPart"), body({ webPartXml: xml }));
+    };
+    return _LimitedWebPartManager;
+}(_SharePointQueryable));
+export { _LimitedWebPartManager };
+export var LimitedWebPartManager = function (baseUrl, path) { return new _LimitedWebPartManager(baseUrl, path); };
+var LimitedWebPartManagerCloneFactory = function (baseUrl, path) { return LimitedWebPartManager(baseUrl, path); };
+var _WebPartDefinitions = /** @class */ (function (_super) {
+    __extends(_WebPartDefinitions, _super);
+    function _WebPartDefinitions() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    /**
+     * Gets a web part definition from the collection by id
+     *
+     * @param id The storage ID of the SPWebPartDefinition to retrieve
+     */
+    _WebPartDefinitions.prototype.getById = function (id) {
+        return WebPartDefinition(this, "getbyid('" + id + "')");
+    };
+    /**
+     * Gets a web part definition from the collection by storage id
+     *
+     * @param id The WebPart.ID of the SPWebPartDefinition to retrieve
+     */
+    _WebPartDefinitions.prototype.getByControlId = function (id) {
+        return WebPartDefinition(this, "getByControlId('" + id + "')");
+    };
+    return _WebPartDefinitions;
+}(_SharePointQueryableCollection));
+export { _WebPartDefinitions };
+export var WebPartDefinitions = spInvokableFactory(_WebPartDefinitions);
+var _WebPartDefinition = /** @class */ (function (_super) {
+    __extends(_WebPartDefinition, _super);
+    function _WebPartDefinition() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    Object.defineProperty(_WebPartDefinition.prototype, "webpart", {
+        /**
+        * Gets the webpart information associated with this definition
+        */
+        get: function () {
+            return SharePointQueryableInstance(this, "webpart");
+        },
+        enumerable: false,
+        configurable: true
+    });
+    /**
+     * Saves changes to the Web Part made using other properties and methods on the SPWebPartDefinition object
+     */
+    _WebPartDefinition.prototype.saveChanges = function () {
+        return spPost(this.clone(WebPartDefinition, "SaveWebPartChanges"));
+    };
+    /**
+     * Moves the Web Part to a different location on a Web Part Page
+     *
+     * @param zoneId The ID of the Web Part Zone to which to move the Web Part
+     * @param zoneIndex A Web Part zone index that specifies the position at which the Web Part is to be moved within the destination Web Part zone
+     */
+    _WebPartDefinition.prototype.moveTo = function (zoneId, zoneIndex) {
+        return spPost(this.clone(WebPartDefinition, "MoveWebPartTo(zoneID='" + zoneId + "', zoneIndex=" + zoneIndex + ")"));
+    };
+    /**
+     * Closes the Web Part. If the Web Part is already closed, this method does nothing
+     */
+    _WebPartDefinition.prototype.close = function () {
+        return spPost(this.clone(WebPartDefinition, "CloseWebPart"));
+    };
+    /**
+     * Opens the Web Part. If the Web Part is already closed, this method does nothing
+     */
+    _WebPartDefinition.prototype.open = function () {
+        return spPost(this.clone(WebPartDefinition, "OpenWebPart"));
+    };
+    /**
+     * Removes a webpart from a page, all settings will be lost
+     */
+    _WebPartDefinition.prototype.delete = function () {
+        return spPost(this.clone(WebPartDefinition, "DeleteWebPart"));
+    };
+    return _WebPartDefinition;
+}(_SharePointQueryableInstance));
+export { _WebPartDefinition };
+export var WebPartDefinition = spInvokableFactory(_WebPartDefinition);
+export var WebPartsPersonalizationScope;
+(function (WebPartsPersonalizationScope) {
+    WebPartsPersonalizationScope[WebPartsPersonalizationScope["User"] = 0] = "User";
+    WebPartsPersonalizationScope[WebPartsPersonalizationScope["Shared"] = 1] = "Shared";
+})(WebPartsPersonalizationScope || (WebPartsPersonalizationScope = {}));
 //# sourceMappingURL=types.js.map

package/webs/index.d.ts

@@ -1,17 +1,17 @@
-import { IWeb } from "./types.js";
-import { SPBatch } from "../batch.js";
-export { IWeb, IWebs, Web, IWebAddResult, IWebUpdateResult, Webs, IWebInfo, IStorageEntity, IWebInfosData, } from "./types.js";
-declare module "../rest" {
-    interface SPRest {
-        /**
-         * Access to the current web instance
-         */
-        readonly web: IWeb;
-        /**
-         * Creates a new batch object for use with the SharePointQueryable.addToBatch method
-         *
-         */
-        createBatch(): SPBatch;
-    }
-}
+import { IWeb } from "./types.js";
+import { SPBatch } from "../batch.js";
+export { IWeb, IWebs, Web, IWebAddResult, IWebUpdateResult, Webs, IWebInfo, IStorageEntity, IWebInfosData, } from "./types.js";
+declare module "../rest" {
+    interface SPRest {
+        /**
+         * Access to the current web instance
+         */
+        readonly web: IWeb;
+        /**
+         * Creates a new batch object for use with the SharePointQueryable.addToBatch method
+         *
+         */
+        createBatch(): SPBatch;
+    }
+}
 //# sourceMappingURL=index.d.ts.map

package/webs/index.js

@@ -1,17 +1,17 @@
-import { Web } from "./types.js";
-import { SPRest } from "../rest.js";
-export { Web, Webs, } from "./types.js";
-Reflect.defineProperty(SPRest.prototype, "web", {
-    configurable: true,
-    enumerable: true,
-    get: function () {
-        return this.childConfigHook(function (_a) {
-            var options = _a.options, baseUrl = _a.baseUrl, runtime = _a.runtime;
-            return Web(baseUrl).configure(options).setRuntime(runtime);
-        });
-    },
-});
-SPRest.prototype.createBatch = function () {
-    return this.web.createBatch();
-};
+import { Web } from "./types.js";
+import { SPRest } from "../rest.js";
+export { Web, Webs, } from "./types.js";
+Reflect.defineProperty(SPRest.prototype, "web", {
+    configurable: true,
+    enumerable: true,
+    get: function () {
+        return this.childConfigHook(function (_a) {
+            var options = _a.options, baseUrl = _a.baseUrl, runtime = _a.runtime;
+            return Web(baseUrl).configure(options).setRuntime(runtime);
+        });
+    },
+});
+SPRest.prototype.createBatch = function () {
+    return this.web.createBatch();
+};
 //# sourceMappingURL=index.js.map