@pnp/sp 2.8.0 → 2.12.0

package/site-designs/types.js

@@ -1,204 +1,204 @@
-import { __awaiter, __decorate, __extends, __generator } from "tslib";
-import { _SharePointQueryable } from "../sharepointqueryable.js";
-import { extractWebUrl } from "../utils/extractweburl.js";
-import { headers, body } from "@pnp/odata";
-import { spPost } from "../operations.js";
-import { hOP } from "@pnp/common";
-import { tag } from "../telemetry.js";
-var _SiteDesigns = /** @class */ (function (_super) {
-    __extends(_SiteDesigns, _super);
-    function _SiteDesigns(baseUrl, methodName) {
-        if (methodName === void 0) { methodName = ""; }
-        var _this = this;
-        var url = typeof baseUrl === "string" ? baseUrl : baseUrl.toUrl();
-        _this = _super.call(this, extractWebUrl(url), "_api/Microsoft.Sharepoint.Utilities.WebTemplateExtensions.SiteScriptUtility." + methodName) || this;
-        return _this;
-    }
-    _SiteDesigns.prototype.execute = function (props) {
-        return spPost(this, body(props, headers({ "Content-Type": "application/json;charset=utf-8" })));
-    };
-    /**
-     * Creates a new site design available to users when they create a new site from the SharePoint home page.
-     *
-     * @param creationInfo A sitedesign creation information object
-     */
-    _SiteDesigns.prototype.createSiteDesign = function (creationInfo) {
-        return this.clone(SiteDesignsCloneFactory, "CreateSiteDesign").execute({ info: creationInfo });
-    };
-    /**
-     * Applies a site design to an existing site collection.
-     *
-     * @param siteDesignId The ID of the site design to apply.
-     * @param webUrl The URL of the site collection where you want to apply the site design.
-     */
-    _SiteDesigns.prototype.applySiteDesign = function (siteDesignId, webUrl) {
-        return this.clone(SiteDesignsCloneFactory, "ApplySiteDesign").execute({ siteDesignId: siteDesignId, "webUrl": webUrl });
-    };
-    /**
-     * Gets the list of available site designs
-     */
-    _SiteDesigns.prototype.getSiteDesigns = function () {
-        return this.clone(SiteDesignsCloneFactory, "GetSiteDesigns").execute({});
-    };
-    /**
-     * Gets information about a specific site design.
-     * @param id The ID of the site design to get information about.
-     */
-    _SiteDesigns.prototype.getSiteDesignMetadata = function (id) {
-        return this.clone(SiteDesignsCloneFactory, "GetSiteDesignMetadata").execute({ id: id });
-    };
-    /**
-     * Updates a site design with new values. In the REST call, all parameters are optional except the site script Id.
-     * If you had previously set the IsDefault parameter to TRUE and wish it to remain true, you must pass in this parameter again (otherwise it will be reset to FALSE).
-     * @param updateInfo A sitedesign update information object
-     */
-    _SiteDesigns.prototype.updateSiteDesign = function (updateInfo) {
-        return this.clone(SiteDesignsCloneFactory, "UpdateSiteDesign").execute({ updateInfo: updateInfo });
-    };
-    /**
-     * Deletes a site design.
-     * @param id The ID of the site design to delete.
-     */
-    _SiteDesigns.prototype.deleteSiteDesign = function (id) {
-        return this.clone(SiteDesignsCloneFactory, "DeleteSiteDesign").execute({ id: id });
-    };
-    /**
-     * Gets a list of principals that have access to a site design.
-     * @param id The ID of the site design to get rights information from.
-     */
-    _SiteDesigns.prototype.getSiteDesignRights = function (id) {
-        return this.clone(SiteDesignsCloneFactory, "GetSiteDesignRights").execute({ id: id });
-    };
-    /**
-     * Grants access to a site design for one or more principals.
-     * @param id The ID of the site design to grant rights on.
-     * @param principalNames An array of one or more principals to grant view rights.
-     *                       Principals can be users or mail-enabled security groups in the form of "alias" or "alias@<domain name>.com"
-     * @param grantedRights Always set to 1. This represents the View right.
-     */
-    _SiteDesigns.prototype.grantSiteDesignRights = function (id, principalNames, grantedRights) {
-        if (grantedRights === void 0) { grantedRights = 1; }
-        return this.clone(SiteDesignsCloneFactory, "GrantSiteDesignRights")
-            .execute({
-            "grantedRights": grantedRights.toString(),
-            "id": id,
-            "principalNames": principalNames,
-        });
-    };
-    /**
-     * Revokes access from a site design for one or more principals.
-     * @param id The ID of the site design to revoke rights from.
-     * @param principalNames An array of one or more principals to revoke view rights from.
-     *                       If all principals have rights revoked on the site design, the site design becomes viewable to everyone.
-     */
-    _SiteDesigns.prototype.revokeSiteDesignRights = function (id, principalNames) {
-        return this.clone(SiteDesignsCloneFactory, "RevokeSiteDesignRights")
-            .execute({
-            "id": id,
-            "principalNames": principalNames,
-        });
-    };
-    /**
-     * Adds a site design task on the specified web url to be invoked asynchronously.
-     * @param webUrl The absolute url of the web on where to create the task
-     * @param siteDesignId The ID of the site design to create a task for
-     */
-    _SiteDesigns.prototype.addSiteDesignTask = function (webUrl, siteDesignId) {
-        return this.clone(SiteDesignsCloneFactory, "AddSiteDesignTask")
-            .execute({ "webUrl": webUrl, "siteDesignId": siteDesignId });
-    };
-    /**
-     * Adds a site design task on the current web to be invoked asynchronously.
-     * @param siteDesignId The ID of the site design to create a task for
-     */
-    _SiteDesigns.prototype.addSiteDesignTaskToCurrentWeb = function (siteDesignId) {
-        return this.clone(SiteDesignsCloneFactory, "AddSiteDesignTaskToCurrentWeb")
-            .execute({ "siteDesignId": siteDesignId });
-    };
-    /**
-     * Retrieves the site design task, if the task has finished running null will be returned
-     * @param id The ID of the site design task
-     */
-    _SiteDesigns.prototype.getSiteDesignTask = function (id) {
-        return __awaiter(this, void 0, void 0, function () {
-            var task;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.clone(SiteDesignsCloneFactory, "GetSiteDesignTask")
-                            .execute({ "taskId": id })];
-                    case 1:
-                        task = _a.sent();
-                        return [2 /*return*/, hOP(task, "ID") ? task : null];
-                }
-            });
-        });
-    };
-    /**
-     * Retrieves a list of site design that have run on a specific web
-     * @param webUrl The url of the web where the site design was applied
-     * @param siteDesignId (Optional) the site design ID, if not provided will return all site design runs
-     */
-    _SiteDesigns.prototype.getSiteDesignRun = function (webUrl, siteDesignId) {
-        return this.clone(SiteDesignsCloneFactory, "GetSiteDesignRun")
-            .execute({ "webUrl": webUrl, siteDesignId: siteDesignId });
-    };
-    /**
-     * Retrieves the status of a site design that has been run or is still running
-     * @param webUrl The url of the web where the site design was applied
-     * @param runId the run ID
-     */
-    _SiteDesigns.prototype.getSiteDesignRunStatus = function (webUrl, runId) {
-        return this.clone(SiteDesignsCloneFactory, "GetSiteDesignRunStatus")
-            .execute({ "webUrl": webUrl, runId: runId });
-    };
-    __decorate([
-        tag("sd.createSiteDesign")
-    ], _SiteDesigns.prototype, "createSiteDesign", null);
-    __decorate([
-        tag("sd.applySiteDesign")
-    ], _SiteDesigns.prototype, "applySiteDesign", null);
-    __decorate([
-        tag("sd.getSiteDesigns")
-    ], _SiteDesigns.prototype, "getSiteDesigns", null);
-    __decorate([
-        tag("sd.getSiteDesignMetadata")
-    ], _SiteDesigns.prototype, "getSiteDesignMetadata", null);
-    __decorate([
-        tag("sd.updateSiteDesign")
-    ], _SiteDesigns.prototype, "updateSiteDesign", null);
-    __decorate([
-        tag("sd.deleteSiteDesign")
-    ], _SiteDesigns.prototype, "deleteSiteDesign", null);
-    __decorate([
-        tag("sd.getSiteDesignRights")
-    ], _SiteDesigns.prototype, "getSiteDesignRights", null);
-    __decorate([
-        tag("sd.grantSiteDesignRights")
-    ], _SiteDesigns.prototype, "grantSiteDesignRights", null);
-    __decorate([
-        tag("sd.revokeSiteDesignRights")
-    ], _SiteDesigns.prototype, "revokeSiteDesignRights", null);
-    __decorate([
-        tag("sd.addSiteDesignTask")
-    ], _SiteDesigns.prototype, "addSiteDesignTask", null);
-    __decorate([
-        tag("sd.addSiteDesignTaskToCurrentWeb")
-    ], _SiteDesigns.prototype, "addSiteDesignTaskToCurrentWeb", null);
-    __decorate([
-        tag("sd.getSiteDesignTask")
-    ], _SiteDesigns.prototype, "getSiteDesignTask", null);
-    __decorate([
-        tag("sd.getSiteDesignRun")
-    ], _SiteDesigns.prototype, "getSiteDesignRun", null);
-    __decorate([
-        tag("sd.getSiteDesignRunStatus")
-    ], _SiteDesigns.prototype, "getSiteDesignRunStatus", null);
-    return _SiteDesigns;
-}(_SharePointQueryable));
-export { _SiteDesigns };
-export var SiteDesigns = function (baseUrl, methodName) { return new _SiteDesigns(baseUrl, methodName); };
-var SiteDesignsCloneFactory = function (baseUrl, methodName) {
-    if (methodName === void 0) { methodName = ""; }
-    return SiteDesigns(baseUrl, methodName);
-};
+import { __awaiter, __decorate, __extends, __generator } from "tslib";
+import { _SharePointQueryable } from "../sharepointqueryable.js";
+import { extractWebUrl } from "../utils/extractweburl.js";
+import { headers, body } from "@pnp/odata";
+import { spPost } from "../operations.js";
+import { hOP } from "@pnp/common";
+import { tag } from "../telemetry.js";
+var _SiteDesigns = /** @class */ (function (_super) {
+    __extends(_SiteDesigns, _super);
+    function _SiteDesigns(baseUrl, methodName) {
+        if (methodName === void 0) { methodName = ""; }
+        var _this = this;
+        var url = typeof baseUrl === "string" ? baseUrl : baseUrl.toUrl();
+        _this = _super.call(this, extractWebUrl(url), "_api/Microsoft.Sharepoint.Utilities.WebTemplateExtensions.SiteScriptUtility." + methodName) || this;
+        return _this;
+    }
+    _SiteDesigns.prototype.execute = function (props) {
+        return spPost(this, body(props, headers({ "Content-Type": "application/json;charset=utf-8" })));
+    };
+    /**
+     * Creates a new site design available to users when they create a new site from the SharePoint home page.
+     *
+     * @param creationInfo A sitedesign creation information object
+     */
+    _SiteDesigns.prototype.createSiteDesign = function (creationInfo) {
+        return this.clone(SiteDesignsCloneFactory, "CreateSiteDesign").execute({ info: creationInfo });
+    };
+    /**
+     * Applies a site design to an existing site collection.
+     *
+     * @param siteDesignId The ID of the site design to apply.
+     * @param webUrl The URL of the site collection where you want to apply the site design.
+     */
+    _SiteDesigns.prototype.applySiteDesign = function (siteDesignId, webUrl) {
+        return this.clone(SiteDesignsCloneFactory, "ApplySiteDesign").execute({ siteDesignId: siteDesignId, "webUrl": webUrl });
+    };
+    /**
+     * Gets the list of available site designs
+     */
+    _SiteDesigns.prototype.getSiteDesigns = function () {
+        return this.clone(SiteDesignsCloneFactory, "GetSiteDesigns").execute({});
+    };
+    /**
+     * Gets information about a specific site design.
+     * @param id The ID of the site design to get information about.
+     */
+    _SiteDesigns.prototype.getSiteDesignMetadata = function (id) {
+        return this.clone(SiteDesignsCloneFactory, "GetSiteDesignMetadata").execute({ id: id });
+    };
+    /**
+     * Updates a site design with new values. In the REST call, all parameters are optional except the site script Id.
+     * If you had previously set the IsDefault parameter to TRUE and wish it to remain true, you must pass in this parameter again (otherwise it will be reset to FALSE).
+     * @param updateInfo A sitedesign update information object
+     */
+    _SiteDesigns.prototype.updateSiteDesign = function (updateInfo) {
+        return this.clone(SiteDesignsCloneFactory, "UpdateSiteDesign").execute({ updateInfo: updateInfo });
+    };
+    /**
+     * Deletes a site design.
+     * @param id The ID of the site design to delete.
+     */
+    _SiteDesigns.prototype.deleteSiteDesign = function (id) {
+        return this.clone(SiteDesignsCloneFactory, "DeleteSiteDesign").execute({ id: id });
+    };
+    /**
+     * Gets a list of principals that have access to a site design.
+     * @param id The ID of the site design to get rights information from.
+     */
+    _SiteDesigns.prototype.getSiteDesignRights = function (id) {
+        return this.clone(SiteDesignsCloneFactory, "GetSiteDesignRights").execute({ id: id });
+    };
+    /**
+     * Grants access to a site design for one or more principals.
+     * @param id The ID of the site design to grant rights on.
+     * @param principalNames An array of one or more principals to grant view rights.
+     *                       Principals can be users or mail-enabled security groups in the form of "alias" or "alias@<domain name>.com"
+     * @param grantedRights Always set to 1. This represents the View right.
+     */
+    _SiteDesigns.prototype.grantSiteDesignRights = function (id, principalNames, grantedRights) {
+        if (grantedRights === void 0) { grantedRights = 1; }
+        return this.clone(SiteDesignsCloneFactory, "GrantSiteDesignRights")
+            .execute({
+            "grantedRights": grantedRights.toString(),
+            "id": id,
+            "principalNames": principalNames,
+        });
+    };
+    /**
+     * Revokes access from a site design for one or more principals.
+     * @param id The ID of the site design to revoke rights from.
+     * @param principalNames An array of one or more principals to revoke view rights from.
+     *                       If all principals have rights revoked on the site design, the site design becomes viewable to everyone.
+     */
+    _SiteDesigns.prototype.revokeSiteDesignRights = function (id, principalNames) {
+        return this.clone(SiteDesignsCloneFactory, "RevokeSiteDesignRights")
+            .execute({
+            "id": id,
+            "principalNames": principalNames,
+        });
+    };
+    /**
+     * Adds a site design task on the specified web url to be invoked asynchronously.
+     * @param webUrl The absolute url of the web on where to create the task
+     * @param siteDesignId The ID of the site design to create a task for
+     */
+    _SiteDesigns.prototype.addSiteDesignTask = function (webUrl, siteDesignId) {
+        return this.clone(SiteDesignsCloneFactory, "AddSiteDesignTask")
+            .execute({ "webUrl": webUrl, "siteDesignId": siteDesignId });
+    };
+    /**
+     * Adds a site design task on the current web to be invoked asynchronously.
+     * @param siteDesignId The ID of the site design to create a task for
+     */
+    _SiteDesigns.prototype.addSiteDesignTaskToCurrentWeb = function (siteDesignId) {
+        return this.clone(SiteDesignsCloneFactory, "AddSiteDesignTaskToCurrentWeb")
+            .execute({ "siteDesignId": siteDesignId });
+    };
+    /**
+     * Retrieves the site design task, if the task has finished running null will be returned
+     * @param id The ID of the site design task
+     */
+    _SiteDesigns.prototype.getSiteDesignTask = function (id) {
+        return __awaiter(this, void 0, void 0, function () {
+            var task;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.clone(SiteDesignsCloneFactory, "GetSiteDesignTask")
+                            .execute({ "taskId": id })];
+                    case 1:
+                        task = _a.sent();
+                        return [2 /*return*/, hOP(task, "ID") ? task : null];
+                }
+            });
+        });
+    };
+    /**
+     * Retrieves a list of site design that have run on a specific web
+     * @param webUrl The url of the web where the site design was applied
+     * @param siteDesignId (Optional) the site design ID, if not provided will return all site design runs
+     */
+    _SiteDesigns.prototype.getSiteDesignRun = function (webUrl, siteDesignId) {
+        return this.clone(SiteDesignsCloneFactory, "GetSiteDesignRun")
+            .execute({ "webUrl": webUrl, siteDesignId: siteDesignId });
+    };
+    /**
+     * Retrieves the status of a site design that has been run or is still running
+     * @param webUrl The url of the web where the site design was applied
+     * @param runId the run ID
+     */
+    _SiteDesigns.prototype.getSiteDesignRunStatus = function (webUrl, runId) {
+        return this.clone(SiteDesignsCloneFactory, "GetSiteDesignRunStatus")
+            .execute({ "webUrl": webUrl, runId: runId });
+    };
+    __decorate([
+        tag("sd.createSiteDesign")
+    ], _SiteDesigns.prototype, "createSiteDesign", null);
+    __decorate([
+        tag("sd.applySiteDesign")
+    ], _SiteDesigns.prototype, "applySiteDesign", null);
+    __decorate([
+        tag("sd.getSiteDesigns")
+    ], _SiteDesigns.prototype, "getSiteDesigns", null);
+    __decorate([
+        tag("sd.getSiteDesignMetadata")
+    ], _SiteDesigns.prototype, "getSiteDesignMetadata", null);
+    __decorate([
+        tag("sd.updateSiteDesign")
+    ], _SiteDesigns.prototype, "updateSiteDesign", null);
+    __decorate([
+        tag("sd.deleteSiteDesign")
+    ], _SiteDesigns.prototype, "deleteSiteDesign", null);
+    __decorate([
+        tag("sd.getSiteDesignRights")
+    ], _SiteDesigns.prototype, "getSiteDesignRights", null);
+    __decorate([
+        tag("sd.grantSiteDesignRights")
+    ], _SiteDesigns.prototype, "grantSiteDesignRights", null);
+    __decorate([
+        tag("sd.revokeSiteDesignRights")
+    ], _SiteDesigns.prototype, "revokeSiteDesignRights", null);
+    __decorate([
+        tag("sd.addSiteDesignTask")
+    ], _SiteDesigns.prototype, "addSiteDesignTask", null);
+    __decorate([
+        tag("sd.addSiteDesignTaskToCurrentWeb")
+    ], _SiteDesigns.prototype, "addSiteDesignTaskToCurrentWeb", null);
+    __decorate([
+        tag("sd.getSiteDesignTask")
+    ], _SiteDesigns.prototype, "getSiteDesignTask", null);
+    __decorate([
+        tag("sd.getSiteDesignRun")
+    ], _SiteDesigns.prototype, "getSiteDesignRun", null);
+    __decorate([
+        tag("sd.getSiteDesignRunStatus")
+    ], _SiteDesigns.prototype, "getSiteDesignRunStatus", null);
+    return _SiteDesigns;
+}(_SharePointQueryable));
+export { _SiteDesigns };
+export var SiteDesigns = function (baseUrl, methodName) { return new _SiteDesigns(baseUrl, methodName); };
+var SiteDesignsCloneFactory = function (baseUrl, methodName) {
+    if (methodName === void 0) { methodName = ""; }
+    return SiteDesigns(baseUrl, methodName);
+};
 //# sourceMappingURL=types.js.map

package/site-designs/web.d.ts

@@ -1,26 +1,26 @@
-import { ISiteDesignRun, ISiteDesignTask, ISiteScriptActionStatus } from "./types.js";
-declare module "../webs/types" {
-    interface _Web {
-        getSiteDesignRuns(siteDesignId?: string): Promise<ISiteDesignRun[]>;
-        addSiteDesignTask(siteDesignId: string): Promise<ISiteDesignTask>;
-        getSiteDesignRunStatus(runId: string): Promise<ISiteScriptActionStatus[]>;
-    }
-    interface IWeb {
-        /**
-         * Retrieves a list of site design that have run on the current web
-         * @param siteDesignId (Optional) the site design ID, if not provided will return all site design runs
-         */
-        getSiteDesignRuns(siteDesignId?: string): Promise<ISiteDesignRun[]>;
-        /**
-         * Adds a site design task on the current web to be invoked asynchronously.
-         * @param siteDesignId The ID of the site design to create a task for
-         */
-        addSiteDesignTask(siteDesignId: string): Promise<ISiteDesignTask>;
-        /**
-         * Retrieves the status of a site design that has been run or is still running
-         * @param runId the run ID
-         */
-        getSiteDesignRunStatus(runId: string): Promise<ISiteScriptActionStatus[]>;
-    }
-}
+import { ISiteDesignRun, ISiteDesignTask, ISiteScriptActionStatus } from "./types.js";
+declare module "../webs/types" {
+    interface _Web {
+        getSiteDesignRuns(siteDesignId?: string): Promise<ISiteDesignRun[]>;
+        addSiteDesignTask(siteDesignId: string): Promise<ISiteDesignTask>;
+        getSiteDesignRunStatus(runId: string): Promise<ISiteScriptActionStatus[]>;
+    }
+    interface IWeb {
+        /**
+         * Retrieves a list of site design that have run on the current web
+         * @param siteDesignId (Optional) the site design ID, if not provided will return all site design runs
+         */
+        getSiteDesignRuns(siteDesignId?: string): Promise<ISiteDesignRun[]>;
+        /**
+         * Adds a site design task on the current web to be invoked asynchronously.
+         * @param siteDesignId The ID of the site design to create a task for
+         */
+        addSiteDesignTask(siteDesignId: string): Promise<ISiteDesignTask>;
+        /**
+         * Retrieves the status of a site design that has been run or is still running
+         * @param runId the run ID
+         */
+        getSiteDesignRunStatus(runId: string): Promise<ISiteScriptActionStatus[]>;
+    }
+}
 //# sourceMappingURL=web.d.ts.map

package/site-designs/web.js

@@ -1,12 +1,12 @@
-import { _Web } from "../webs/types.js";
-import { SiteDesigns } from "./types.js";
-_Web.prototype.getSiteDesignRuns = function (siteDesignId) {
-    return SiteDesigns(this, "").getSiteDesignRun(undefined, siteDesignId);
-};
-_Web.prototype.addSiteDesignTask = function (siteDesignId) {
-    return SiteDesigns(this, "").addSiteDesignTaskToCurrentWeb(siteDesignId);
-};
-_Web.prototype.getSiteDesignRunStatus = function (runId) {
-    return SiteDesigns(this, "").getSiteDesignRunStatus(undefined, runId);
-};
+import { _Web } from "../webs/types.js";
+import { SiteDesigns } from "./types.js";
+_Web.prototype.getSiteDesignRuns = function (siteDesignId) {
+    return SiteDesigns(this, "").getSiteDesignRun(undefined, siteDesignId);
+};
+_Web.prototype.addSiteDesignTask = function (siteDesignId) {
+    return SiteDesigns(this, "").addSiteDesignTaskToCurrentWeb(siteDesignId);
+};
+_Web.prototype.getSiteDesignRunStatus = function (runId) {
+    return SiteDesigns(this, "").getSiteDesignRunStatus(undefined, runId);
+};
 //# sourceMappingURL=web.js.map

package/site-groups/index.d.ts

@@ -1,3 +1,3 @@
-import "./web.js";
-export { ISiteGroup, IGroupAddResult, IGroupUpdateResult, ISiteGroups, SiteGroup, SiteGroups, ISiteGroupInfo, } from "./types.js";
+import "./web.js";
+export { ISiteGroup, IGroupAddResult, IGroupUpdateResult, ISiteGroups, SiteGroup, SiteGroups, ISiteGroupInfo, } from "./types.js";
 //# sourceMappingURL=index.d.ts.map

package/site-groups/index.js

@@ -1,3 +1,3 @@
-import "./web.js";
-export { SiteGroup, SiteGroups, } from "./types.js";
+import "./web.js";
+export { SiteGroup, SiteGroups, } from "./types.js";
 //# sourceMappingURL=index.js.map