@pnp/sp 4.0.0-alpha0-v4nightly.20240108 → 4.0.0-alpha0-v4nightly.20240110

package/commonjs/sharing/types.js

@@ -0,0 +1,117 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RoleType = exports.SharingLinkKind = exports.SharingOperationStatusCode = exports.SharingDomainRestrictionMode = exports.SPSharedObjectType = exports.SharingRole = void 0;
+/**
+ * Indicates the role of the sharing link
+ */
+var SharingRole;
+(function (SharingRole) {
+    SharingRole[SharingRole["None"] = 0] = "None";
+    SharingRole[SharingRole["View"] = 1] = "View";
+    SharingRole[SharingRole["Edit"] = 2] = "Edit";
+    SharingRole[SharingRole["Owner"] = 3] = "Owner";
+})(SharingRole = exports.SharingRole || (exports.SharingRole = {}));
+var SPSharedObjectType;
+(function (SPSharedObjectType) {
+    SPSharedObjectType[SPSharedObjectType["Unknown"] = 0] = "Unknown";
+    SPSharedObjectType[SPSharedObjectType["File"] = 1] = "File";
+    SPSharedObjectType[SPSharedObjectType["Folder"] = 2] = "Folder";
+    SPSharedObjectType[SPSharedObjectType["Item"] = 3] = "Item";
+    SPSharedObjectType[SPSharedObjectType["List"] = 4] = "List";
+    SPSharedObjectType[SPSharedObjectType["Web"] = 5] = "Web";
+    SPSharedObjectType[SPSharedObjectType["Max"] = 6] = "Max";
+})(SPSharedObjectType = exports.SPSharedObjectType || (exports.SPSharedObjectType = {}));
+var SharingDomainRestrictionMode;
+(function (SharingDomainRestrictionMode) {
+    SharingDomainRestrictionMode[SharingDomainRestrictionMode["None"] = 0] = "None";
+    SharingDomainRestrictionMode[SharingDomainRestrictionMode["AllowList"] = 1] = "AllowList";
+    SharingDomainRestrictionMode[SharingDomainRestrictionMode["BlockList"] = 2] = "BlockList";
+})(SharingDomainRestrictionMode = exports.SharingDomainRestrictionMode || (exports.SharingDomainRestrictionMode = {}));
+var SharingOperationStatusCode;
+(function (SharingOperationStatusCode) {
+    /**
+     * The share operation completed without errors.
+     */
+    SharingOperationStatusCode[SharingOperationStatusCode["CompletedSuccessfully"] = 0] = "CompletedSuccessfully";
+    /**
+     * The share operation completed and generated requests for access.
+     */
+    SharingOperationStatusCode[SharingOperationStatusCode["AccessRequestsQueued"] = 1] = "AccessRequestsQueued";
+    /**
+     * The share operation failed as there were no resolved users.
+     */
+    SharingOperationStatusCode[SharingOperationStatusCode["NoResolvedUsers"] = -1] = "NoResolvedUsers";
+    /**
+     * The share operation failed due to insufficient permissions.
+     */
+    SharingOperationStatusCode[SharingOperationStatusCode["AccessDenied"] = -2] = "AccessDenied";
+    /**
+     * The share operation failed when attempting a cross site share, which is not supported.
+     */
+    SharingOperationStatusCode[SharingOperationStatusCode["CrossSiteRequestNotSupported"] = -3] = "CrossSiteRequestNotSupported";
+    /**
+     * The sharing operation failed due to an unknown error.
+     */
+    SharingOperationStatusCode[SharingOperationStatusCode["UnknowError"] = -4] = "UnknowError";
+    /**
+     * The text you typed is too long. Please shorten it.
+     */
+    SharingOperationStatusCode[SharingOperationStatusCode["EmailBodyTooLong"] = -5] = "EmailBodyTooLong";
+    /**
+     * The maximum number of unique scopes in the list has been exceeded.
+     */
+    SharingOperationStatusCode[SharingOperationStatusCode["ListUniqueScopesExceeded"] = -6] = "ListUniqueScopesExceeded";
+    /**
+     * The share operation failed because a sharing capability is disabled in the site.
+     */
+    SharingOperationStatusCode[SharingOperationStatusCode["CapabilityDisabled"] = -7] = "CapabilityDisabled";
+    /**
+     * The specified object for the share operation is not supported.
+     */
+    SharingOperationStatusCode[SharingOperationStatusCode["ObjectNotSupported"] = -8] = "ObjectNotSupported";
+    /**
+     * A SharePoint group cannot contain another SharePoint group.
+     */
+    SharingOperationStatusCode[SharingOperationStatusCode["NestedGroupsNotSupported"] = -9] = "NestedGroupsNotSupported";
+})(SharingOperationStatusCode = exports.SharingOperationStatusCode || (exports.SharingOperationStatusCode = {}));
+var SharingLinkKind;
+(function (SharingLinkKind) {
+    /**
+     * Uninitialized link
+     */
+    SharingLinkKind[SharingLinkKind["Uninitialized"] = 0] = "Uninitialized";
+    /**
+     * Direct link to the object being shared
+     */
+    SharingLinkKind[SharingLinkKind["Direct"] = 1] = "Direct";
+    /**
+     * Organization-shareable link to the object being shared with view permissions
+     */
+    SharingLinkKind[SharingLinkKind["OrganizationView"] = 2] = "OrganizationView";
+    /**
+     * Organization-shareable link to the object being shared with edit permissions
+     */
+    SharingLinkKind[SharingLinkKind["OrganizationEdit"] = 3] = "OrganizationEdit";
+    /**
+     * View only anonymous link
+     */
+    SharingLinkKind[SharingLinkKind["AnonymousView"] = 4] = "AnonymousView";
+    /**
+     * Read/Write anonymous link
+     */
+    SharingLinkKind[SharingLinkKind["AnonymousEdit"] = 5] = "AnonymousEdit";
+    /**
+     * Flexible sharing Link where properties can change without affecting link URL
+     */
+    SharingLinkKind[SharingLinkKind["Flexible"] = 6] = "Flexible";
+})(SharingLinkKind = exports.SharingLinkKind || (exports.SharingLinkKind = {}));
+var RoleType;
+(function (RoleType) {
+    RoleType[RoleType["None"] = 0] = "None";
+    RoleType[RoleType["Guest"] = 1] = "Guest";
+    RoleType[RoleType["Reader"] = 2] = "Reader";
+    RoleType[RoleType["Contributor"] = 3] = "Contributor";
+    RoleType[RoleType["WebDesigner"] = 4] = "WebDesigner";
+    RoleType[RoleType["Administrator"] = 5] = "Administrator";
+})(RoleType = exports.RoleType || (exports.RoleType = {}));
+//# sourceMappingURL=types.js.map

package/commonjs/sharing/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../../packages/sp/sharing/types.ts"],"names":[],"mappings":";;;AAQA;;GAEG;AACH,IAAY,WAKX;AALD,WAAY,WAAW;IACnB,6CAAQ,CAAA;IACR,6CAAQ,CAAA;IACR,6CAAQ,CAAA;IACR,+CAAS,CAAA;AACb,CAAC,EALW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAKtB;AAED,IAAY,kBAQX;AARD,WAAY,kBAAkB;IAC1B,iEAAW,CAAA;IACX,2DAAQ,CAAA;IACR,+DAAU,CAAA;IACV,2DAAQ,CAAA;IACR,2DAAQ,CAAA;IACR,yDAAO,CAAA;IACP,yDAAO,CAAA;AACX,CAAC,EARW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAQ7B;AAED,IAAY,4BAIX;AAJD,WAAY,4BAA4B;IACpC,+EAAQ,CAAA;IACR,yFAAa,CAAA;IACb,yFAAa,CAAA;AACjB,CAAC,EAJW,4BAA4B,GAA5B,oCAA4B,KAA5B,oCAA4B,QAIvC;AAED,IAAY,0BA6CX;AA7CD,WAAY,0BAA0B;IAClC;;OAEG;IACH,6GAAyB,CAAA;IACzB;;OAEG;IACH,2GAAwB,CAAA;IACxB;;OAEG;IACH,kGAAoB,CAAA;IACpB;;OAEG;IACH,4FAAiB,CAAA;IACjB;;OAEG;IACH,4HAAiC,CAAA;IACjC;;OAEG;IACH,0FAAgB,CAAA;IAChB;;OAEG;IACH,oGAAqB,CAAA;IACrB;;OAEG;IACH,oHAA6B,CAAA;IAC7B;;OAEG;IACH,wGAAuB,CAAA;IACvB;;OAEG;IACH,wGAAuB,CAAA;IACvB;;OAEG;IACH,oHAA6B,CAAA;AACjC,CAAC,EA7CW,0BAA0B,GAA1B,kCAA0B,KAA1B,kCAA0B,QA6CrC;AAED,IAAY,eA6BX;AA7BD,WAAY,eAAe;IACvB;;OAEG;IACH,uEAAiB,CAAA;IACjB;;OAEG;IACH,yDAAU,CAAA;IACV;;OAEG;IACH,6EAAoB,CAAA;IACpB;;OAEG;IACH,6EAAoB,CAAA;IACpB;;OAEG;IACH,uEAAiB,CAAA;IACjB;;OAEG;IACH,uEAAiB,CAAA;IACjB;;OAEG;IACH,6DAAY,CAAA;AAChB,CAAC,EA7BW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QA6B1B;AA4fD,IAAY,QAOX;AAPD,WAAY,QAAQ;IAChB,uCAAQ,CAAA;IACR,yCAAS,CAAA;IACT,2CAAU,CAAA;IACV,qDAAe,CAAA;IACf,qDAAe,CAAA;IACf,yDAAiB,CAAA;AACrB,CAAC,EAPW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAOnB"}

package/commonjs/sharing/web.d.ts

@@ -0,0 +1,20 @@
+import { ISharingEmailData, ISharingResult, SharingRole } from "./types.js";
+import { RoleType } from "./types.js";
+/**
+ * Extend _Web
+ */
+declare module "../webs/types" {
+    interface _Web {
+        shareWith: (loginNames: string | string[], role?: SharingRole, emailData?: ISharingEmailData) => Promise<ISharingResult>;
+        shareObject: (url: string, loginNames: string | string[], role: SharingRole, emailData?: ISharingEmailData, group?: RoleType, propagateAcl?: boolean, includeAnonymousLinkInEmail?: boolean, useSimplifiedRoles?: boolean) => Promise<ISharingResult>;
+        shareObjectRaw(options: any): Promise<ISharingResult>;
+        unshareObject(url: string): Promise<ISharingResult>;
+    }
+    interface IWeb {
+        shareWith: (loginNames: string | string[], role?: SharingRole, emailData?: ISharingEmailData) => Promise<ISharingResult>;
+        shareObject: (url: string, loginNames: string | string[], role: SharingRole, emailData?: ISharingEmailData, group?: RoleType, propagateAcl?: boolean, includeAnonymousLinkInEmail?: boolean, useSimplifiedRoles?: boolean) => Promise<ISharingResult>;
+        shareObjectRaw(options: any): Promise<ISharingResult>;
+        unshareObject(url: string): Promise<ISharingResult>;
+    }
+}
+//# sourceMappingURL=web.d.ts.map

package/commonjs/sharing/web.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"web.d.ts","sourceRoot":"","sources":["../../../../../packages/sp/sharing/web.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAC5E,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAMtC;;GAEG;AACH,OAAO,QAAQ,eAAe,CAAC;IAC3B,UAAU,IAAI;QACV,SAAS,EAAE,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,IAAI,CAAC,EAAE,WAAW,EAAE,SAAS,CAAC,EAAE,iBAAiB,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;QACzH,WAAW,EAAE,CAAC,GAAG,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,GAAG,MAAM,EAAE,EAC7B,IAAI,EAAE,WAAW,EACjB,SAAS,CAAC,EAAE,iBAAiB,EAC7B,KAAK,CAAC,EAAE,QAAQ,EAChB,YAAY,CAAC,EAAE,OAAO,EACtB,2BAA2B,CAAC,EAAE,OAAO,EACrC,kBAAkB,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;QAC7D,cAAc,CAAC,OAAO,EAAE,GAAG,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;QACtD,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;KACvD;IACD,UAAU,IAAI;QACV,SAAS,EAAE,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,IAAI,CAAC,EAAE,WAAW,EAAE,SAAS,CAAC,EAAE,iBAAiB,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;QACzH,WAAW,EAAE,CAAC,GAAG,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,GAAG,MAAM,EAAE,EAC7B,IAAI,EAAE,WAAW,EACjB,SAAS,CAAC,EAAE,iBAAiB,EAC7B,KAAK,CAAC,EAAE,QAAQ,EAChB,YAAY,CAAC,EAAE,OAAO,EACtB,2BAA2B,CAAC,EAAE,OAAO,EACrC,kBAAkB,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;QAC7D,cAAc,CAAC,OAAO,EAAE,GAAG,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;QACtD,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;KACvD;CACJ"}

package/commonjs/sharing/web.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const types_js_1 = require("../webs/types.js");
+const types_js_2 = require("./types.js");
+const funcs_js_1 = require("./funcs.js");
+const core_1 = require("@pnp/core");
+const queryable_1 = require("@pnp/queryable");
+const spqueryable_js_1 = require("../spqueryable.js");
+/**
+ * Shares this web with the supplied users (not supported for batching)
+ * @param loginNames The resolved login names to share
+ * @param role The role to share this web
+ * @param emailData Optional email data
+ */
+types_js_1._Web.prototype.shareWith = async function (loginNames, role = types_js_2.SharingRole.View, emailData) {
+    const url = await this.select("Url")();
+    return this.shareObject((0, core_1.combine)(url.Url, "/_layouts/15/aclinv.aspx?forSharing=1&mbypass=1"), loginNames, role, emailData);
+};
+/**
+ * Provides direct access to the static web.ShareObject method
+ *
+ * @param url The url to share
+ * @param loginNames Resolved loginnames string[] of a single login name string
+ * @param roleValue Role value
+ * @param emailData Optional email data
+ * @param groupId Optional group id
+ * @param propagateAcl
+ * @param includeAnonymousLinkInEmail
+ * @param useSimplifiedRoles
+ */
+types_js_1._Web.prototype.shareObject = function (url, loginNames, role, emailData, group, propagateAcl = false, includeAnonymousLinkInEmail = false, useSimplifiedRoles = true) {
+    return (0, funcs_js_1.shareObject)(this, {
+        emailData: emailData,
+        group: group,
+        includeAnonymousLinkInEmail: includeAnonymousLinkInEmail,
+        loginNames: loginNames,
+        propagateAcl: propagateAcl,
+        role: role,
+        url: url,
+        useSimplifiedRoles: useSimplifiedRoles,
+    });
+};
+/**
+ * Supplies a method to pass any set of arguments to ShareObject
+ *
+ * @param options The set of options to send to ShareObject
+ */
+types_js_1._Web.prototype.shareObjectRaw = function (options) {
+    return (0, funcs_js_1.shareObject)(this, options, true);
+};
+/**
+ * Supplies a method to pass any set of arguments to ShareObject
+ *
+ * @param options The set of options to send to ShareObject
+ */
+types_js_1._Web.prototype.unshareObject = function (url) {
+    return (0, spqueryable_js_1.spPost)((0, types_js_1.Web)(this, "unshareObject"), (0, queryable_1.body)({ url }));
+};
+//# sourceMappingURL=web.js.map

package/commonjs/sharing/web.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"web.js","sourceRoot":"","sources":["../../../../../packages/sp/sharing/web.ts"],"names":[],"mappings":";;AAAA,+CAA6C;AAC7C,yCAA4E;AAE5E,yCAAyC;AACzC,oCAAoC;AACpC,8CAAsC;AACtC,sDAA2C;AAkC3C;;;;;GAKG;AACH,eAAI,CAAC,SAAS,CAAC,SAAS,GAAG,KAAK,WAE5B,UAA6B,EAC7B,OAAoB,sBAAW,CAAC,IAAI,EACpC,SAA6B;IAE7B,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;IAEvC,OAAO,IAAI,CAAC,WAAW,CAAC,IAAA,cAAO,EAAC,GAAG,CAAC,GAAG,EAAE,iDAAiD,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;AAC9H,CAAC,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,eAAI,CAAC,SAAS,CAAC,WAAW,GAAG,UAEzB,GAAW,EACX,UAA6B,EAC7B,IAAiB,EACjB,SAA6B,EAC7B,KAAgB,EAChB,YAAY,GAAG,KAAK,EACpB,2BAA2B,GAAG,KAAK,EACnC,kBAAkB,GAAG,IAAI;IAEzB,OAAO,IAAA,sBAAW,EAAC,IAAI,EAAE;QACrB,SAAS,EAAE,SAAS;QACpB,KAAK,EAAE,KAAK;QACZ,2BAA2B,EAAE,2BAA2B;QACxD,UAAU,EAAE,UAAU;QACtB,YAAY,EAAE,YAAY;QAC1B,IAAI,EAAE,IAAI;QACV,GAAG,EAAE,GAAG;QACR,kBAAkB,EAAE,kBAAkB;KACzC,CAAC,CAAC;AACP,CAAC,CAAC;AAEF;;;;GAIG;AACH,eAAI,CAAC,SAAS,CAAC,cAAc,GAAG,UAAsB,OAAY;IAC9D,OAAO,IAAA,sBAAW,EAAC,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;AAC5C,CAAC,CAAC;AAEF;;;;GAIG;AACH,eAAI,CAAC,SAAS,CAAC,aAAa,GAAG,UAAsB,GAAW;IAC5D,OAAO,IAAA,uBAAM,EAAC,IAAA,cAAG,EAAC,IAAI,EAAE,eAAe,CAAC,EAAE,IAAA,gBAAI,EAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;AAC7D,CAAC,CAAC"}

package/commonjs/site-designs/index.d.ts

@@ -0,0 +1,9 @@
+import "./web.js";
+import { ISiteDesigns } from "./types.js";
+export { ISiteDesignCreationInfo, ISiteDesignInfo, ISiteDesignPrincipals, ISiteDesignUpdateInfo, ISiteDesigns, SiteDesigns, ISiteDesignRun, ISiteDesignTask, ISiteScriptActionStatus, } from "./types.js";
+declare module "../fi" {
+    interface SPFI {
+        readonly siteDesigns: ISiteDesigns;
+    }
+}
+//# sourceMappingURL=index.d.ts.map

package/commonjs/site-designs/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../packages/sp/site-designs/index.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,CAAC;AAElB,OAAO,EAAE,YAAY,EAAe,MAAM,YAAY,CAAC;AAEvD,OAAO,EACH,uBAAuB,EACvB,eAAe,EACf,qBAAqB,EACrB,qBAAqB,EACrB,YAAY,EACZ,WAAW,EACX,cAAc,EACd,eAAe,EACf,uBAAuB,GAC1B,MAAM,YAAY,CAAC;AAEpB,OAAO,QAAQ,OAAO,CAAC;IACnB,UAAU,IAAI;QACV,QAAQ,CAAC,WAAW,EAAE,YAAY,CAAC;KACtC;CACJ"}

package/commonjs/site-designs/index.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SiteDesigns = void 0;
+require("./web.js");
+const fi_js_1 = require("../fi.js");
+const types_js_1 = require("./types.js");
+var types_js_2 = require("./types.js");
+Object.defineProperty(exports, "SiteDesigns", { enumerable: true, get: function () { return types_js_2.SiteDesigns; } });
+Reflect.defineProperty(fi_js_1.SPFI.prototype, "siteDesigns", {
+    configurable: true,
+    enumerable: true,
+    get: function () {
+        return this.create(types_js_1.SiteDesigns);
+    },
+});
+//# sourceMappingURL=index.js.map

package/commonjs/site-designs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/sp/site-designs/index.ts"],"names":[],"mappings":";;;AAAA,oBAAkB;AAClB,oCAAgC;AAChC,yCAAuD;AAEvD,uCAUoB;AAJhB,uGAAA,WAAW,OAAA;AAYf,OAAO,CAAC,cAAc,CAAC,YAAI,CAAC,SAAS,EAAE,aAAa,EAAE;IAClD,YAAY,EAAE,IAAI;IAClB,UAAU,EAAE,IAAI;IAChB,GAAG,EAAE;QACD,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAW,CAAC,CAAC;IACpC,CAAC;CACJ,CAAC,CAAC"}

package/commonjs/site-designs/types.d.ts

@@ -0,0 +1,376 @@
+import { ISPQueryable, _SPQueryable } from "../spqueryable.js";
+export declare class _SiteDesigns extends _SPQueryable {
+    constructor(base: string | ISPQueryable, methodName?: string);
+    run<T>(props: any): Promise<T>;
+    /**
+     * 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
+     */
+    createSiteDesign(creationInfo: ISiteDesignCreationInfo): Promise<ISiteDesignInfo>;
+    /**
+     * 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.
+     */
+    applySiteDesign(siteDesignId: string, webUrl: string): Promise<void>;
+    /**
+     * Gets the list of available site designs
+     */
+    getSiteDesigns(): Promise<ISiteDesignInfo[]>;
+    /**
+     * Gets information about a specific site design.
+     * @param id The ID of the site design to get information about.
+     */
+    getSiteDesignMetadata(id: string): Promise<ISiteDesignInfo>;
+    /**
+     * 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
+     */
+    updateSiteDesign(updateInfo: ISiteDesignUpdateInfo): Promise<ISiteDesignInfo>;
+    /**
+     * Deletes a site design.
+     * @param id The ID of the site design to delete.
+     */
+    deleteSiteDesign(id: string): Promise<void>;
+    /**
+     * 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.
+     */
+    getSiteDesignRights(id: string): Promise<ISiteDesignPrincipals[]>;
+    /**
+     * 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.
+     */
+    grantSiteDesignRights(id: string, principalNames: string[], grantedRights?: number): Promise<void>;
+    /**
+     * 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.
+     */
+    revokeSiteDesignRights(id: string, principalNames: string[]): Promise<void>;
+    /**
+     * 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
+     */
+    addSiteDesignTask(webUrl: string, siteDesignId: string): Promise<ISiteDesignTask>;
+    /**
+     * 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
+     */
+    addSiteDesignTaskToCurrentWeb(siteDesignId: string): Promise<ISiteDesignTask>;
+    /**
+     * Retrieves the site design task, if the task has finished running null will be returned
+     * @param id The ID of the site design task
+     */
+    getSiteDesignTask(id: string): Promise<ISiteDesignTask>;
+    /**
+     * 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
+     */
+    getSiteDesignRun(webUrl: string, siteDesignId?: string): Promise<ISiteDesignRun[]>;
+    /**
+     * 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
+     */
+    getSiteDesignRunStatus(webUrl: string, runId: string): Promise<ISiteScriptActionStatus[]>;
+}
+export interface ISiteDesigns extends _SiteDesigns {
+}
+export declare const SiteDesigns: (baseUrl: string | ISPQueryable, methodName?: string) => ISiteDesigns;
+/**
+ * Result from creating or retrieving a site design
+ *
+ */
+export interface ISiteDesignInfo {
+    /**
+     * The ID of the site design to apply.
+     */
+    Id: string;
+    /**
+     * The display name of the site design.
+     */
+    Title: string;
+    /**
+     * Identifies which base template to add the design to. Use the value 64 for the Team site template, and the value 68 for the Communication site template.
+     */
+    WebTemplate: string;
+    /**
+     * An array of one or more site scripts. Each is identified by an ID. The scripts will run in the order listed.
+     */
+    SiteScriptIds: string[];
+    /**
+     * The display description of site design.
+     */
+    Description: string;
+    /**
+     * The URL of a preview image. If none is specified, SharePoint uses a generic image.
+     */
+    PreviewImageUrl: string;
+    /**
+     * The alt text description of the image for accessibility.
+     */
+    PreviewImageAltText: string;
+    /**
+     * True if the site design is applied as the default site design; otherwise, false.
+     * For more information see Customize a default site design https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/customize-default-site-design.
+     */
+    IsDefault: boolean;
+    /**
+     * The version number of the site design
+     */
+    Version: string;
+}
+/**
+ * Data for creating a site design
+ *
+ */
+export interface ISiteDesignCreationInfo {
+    /**
+     * The display name of the site design.
+     */
+    Title: string;
+    /**
+     * Identifies which base template to add the design to. Use the value 64 for the Team site template, and the value 68 for the Communication site template.
+     */
+    WebTemplate: string;
+    /**
+     * An array of one or more site scripts. Each is identified by an ID. The scripts will run in the order listed.
+     */
+    SiteScriptIds?: string[];
+    /**
+     * (Optional) The display description of site design.
+     */
+    Description?: string;
+    /**
+     * (Optional) The URL of a preview image. If none is specified, SharePoint uses a generic image.
+     */
+    PreviewImageUrl?: string;
+    /**
+     * (Optional) The alt text description of the image for accessibility.
+     */
+    PreviewImageAltText?: string;
+    /**
+     * (Optional) True if the site design is applied as the default site design; otherwise, false.
+     * For more information see Customize a default site design https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/customize-default-site-design.
+     */
+    IsDefault?: boolean;
+    /**
+     * Optional thumbnailed preview image data for the SiteDesign.
+     */
+    ThumbnailUrl?: string;
+    /**
+     * Design package associated with this SiteDesign.
+     */
+    DesignPackageId?: string;
+    /**
+     * Optional Template Features of the SiteDesign. It will be an user-readable list of what the site design does.
+     *
+     */
+    TemplateFeatures?: string[];
+    /**
+     * The supported web templates for this SiteDesign.
+     */
+    SupportedWebTemplates?: string[];
+    /**
+     * If true, indicates that the site design only works on a group-connected site.
+     */
+    RequiresGroupConnected?: boolean;
+    /**
+     * If true, indicates that the site design only works on a teams-connected site.
+     */
+    RequiresTeamsConnected?: boolean;
+    /**
+     * If true, indicates that the site design only works on a yammer-connected site.
+     */
+    RequiresYammerConnected?: boolean;
+    /**
+     * If true, indicates that the site design only works on an EDU class-connected site.
+     */
+    RequiresClassConnected?: boolean;
+    /**
+     * If true, indicates that the site design only works if the customer has a Syntex license
+     */
+    RequiresSyntexLicense?: boolean;
+    /**
+     * The site design is only for the tenant admin scenario.
+     */
+    IsTenantAdminOnly?: boolean;
+    /**
+     * The design type indicating whether it is a site or list design.
+     */
+    DesignType?: TemplateDesignType;
+    /**
+     * Indicates the default color associated with list design.
+     */
+    ListColor?: ListDesignColor;
+    /**
+     * Indicates the default icon associated with list design.
+     */
+    ListIcon?: ListDesignIcon;
+    /**
+     * Indicates the set of platforms the list design should be available on. (A List design can target multiple platforms.)
+     */
+    TargetPlatforms?: string[];
+}
+/**
+ * Data for updating a site design
+ *
+ */
+export interface ISiteDesignUpdateInfo extends Partial<ISiteDesignCreationInfo> {
+    Id: string;
+}
+export declare const enum TemplateDesignType {
+    Site = 0,
+    List = 1
+}
+export declare const enum ListDesignColor {
+    DarkRed = 0,
+    Red = 1,
+    Orange = 2,
+    Green = 3,
+    DarkGreen = 4,
+    Teal = 5,
+    Blue = 6,
+    NavyBlue = 7,
+    BluePurple = 8,
+    DarkBlue = 9,
+    Lavendar = 10,
+    Pink = 11
+}
+export declare const enum ListDesignIcon {
+    Bug = 0,
+    Calendar = 1,
+    BullseyeTarget = 2,
+    ClipboardList = 3,
+    Airplane = 4,
+    Rocket = 5,
+    Color = 6,
+    Insights = 7,
+    CubeShape = 8,
+    TestBeakerSolid = 9,
+    Robot = 10,
+    Savings = 11
+}
+/**
+ * Result from retrieving the rights for a site design
+ *
+ */
+export interface ISiteDesignPrincipals {
+    /**
+     * Display name
+     */
+    DisplayName: string;
+    /**
+     * The principal name
+     */
+    PrincipalName: string;
+    /**
+     * The principal name
+     */
+    Rights: number;
+}
+export interface ISiteDesignTask {
+    /**
+     * The ID of the site design task
+     */
+    ID: string;
+    /**
+     * Logonname of the user who created the task
+     */
+    LogonName: string;
+    /**
+     * The ID of the site design the task is running on
+     */
+    SiteDesignID: string;
+    /**
+     * The ID of the site collection
+     */
+    SiteID: string;
+    /**
+     * The ID of the web
+     */
+    WebID: string;
+}
+export interface ISiteScriptActionStatus {
+    /**
+     * Action index
+     */
+    ActionIndex: number;
+    /**
+     * Action key
+     */
+    ActionKey: string;
+    /**
+     * Action title
+     */
+    ActionTitle: string;
+    /**
+     * Last modified
+     */
+    LastModified: number;
+    /**
+     * Ordinal index
+     */
+    OrdinalIndex: string;
+    /**
+     * Outcome code
+     */
+    OutcomeCode: number;
+    /**
+    * Outcome text
+    */
+    OutcomeText: string;
+    /**
+     * Site script id
+     */
+    SiteScriptID: string;
+    /**
+     * Site script index
+     */
+    SiteScriptIndex: number;
+    /**
+     * Site script title
+     */
+    SiteScriptTitle: string;
+}
+export interface ISiteDesignRun {
+    /**
+     * The ID of the site design run
+     */
+    ID: string;
+    /**
+     * The ID of the site design that was applied
+     */
+    SiteDesignID: string;
+    /**
+     * The title of the site design that was applied
+     */
+    SiteDesignTitle: string;
+    /**
+     * The version of the site design that was applied
+     */
+    SiteDesignVersion: number;
+    /**
+     * The site id where the site design was applied
+     */
+    SiteID: string;
+    /**
+     * The start time when the site design was applied
+     */
+    StartTime: number;
+    /**
+     * The web id where the site design was applied
+     */
+    WebID: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/commonjs/site-designs/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../packages/sp/site-designs/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,YAAY,EAAU,MAAM,mBAAmB,CAAC;AAKvE,qBAAa,YAAa,SAAQ,YAAY;gBAE9B,IAAI,EAAE,MAAM,GAAG,YAAY,EAAE,UAAU,SAAK;IAKjD,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,GAAG,GAAG,OAAO,CAAC,CAAC,CAAC;IAIrC;;;;OAIG;IACI,gBAAgB,CAAC,YAAY,EAAE,uBAAuB,GAAG,OAAO,CAAC,eAAe,CAAC;IAIxF;;;;;OAKG;IACI,eAAe,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI3E;;OAEG;IACI,cAAc,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;IAInD;;;OAGG;IACI,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;IAIlE;;;;OAIG;IACI,gBAAgB,CAAC,UAAU,EAAE,qBAAqB,GAAG,OAAO,CAAC,eAAe,CAAC;IAIpF;;;OAGG;IACI,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIlD;;;OAGG;IACI,mBAAmB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,EAAE,CAAC;IAIxE;;;;;;OAMG;IACI,qBAAqB,CAAC,EAAE,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,EAAE,aAAa,SAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAQpG;;;;;OAKG;IACI,sBAAsB,CAAC,EAAE,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAOlF;;;;OAIG;IACI,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;IAIxF;;;OAGG;IACI,6BAA6B,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;IAIpF;;;OAGG;IACU,iBAAiB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;IAKpE;;;;OAIG;IACI,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;IAIzF;;;;OAIG;IACI,sBAAsB,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,uBAAuB,EAAE,CAAC;CAGnG;AACD,MAAM,WAAW,YAAa,SAAQ,YAAY;CAAI;AACtD,eAAO,MAAM,WAAW,YAAa,MAAM,GAAG,YAAY,eAAe,MAAM,KAAG,YAAqD,CAAC;AAKxI;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC5B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAC5B;;;OAGG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACpC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC5B;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,EAAE,CAAC;IACjC;;OAEG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC;;OAEG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC;;OAEG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC;;OAEG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;OAEG;IACH,UAAU,CAAC,EAAE,kBAAkB,CAAC;IAChC;;OAEG;IACH,SAAS,CAAC,EAAE,eAAe,CAAC;IAC5B;;OAEG;IACH,QAAQ,CAAC,EAAE,cAAc,CAAC;IAC1B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAsB,SAAQ,OAAO,CAAC,uBAAuB,CAAC;IAC3E,EAAE,EAAE,MAAM,CAAC;CACd;AAED,0BAAkB,kBAAkB;IAIhC,IAAI,IAAI;IAIR,IAAI,IAAI;CACX;AAED,0BAAkB,eAAe;IAC7B,OAAO,IAAI;IACX,GAAG,IAAI;IACP,MAAM,IAAI;IACV,KAAK,IAAI;IACT,SAAS,IAAI;IACb,IAAI,IAAI;IACR,IAAI,IAAI;IACR,QAAQ,IAAI;IACZ,UAAU,IAAI;IACd,QAAQ,IAAI;IACZ,QAAQ,KAAK;IACb,IAAI,KAAK;CACZ;AAED,0BAAkB,cAAc;IAC5B,GAAG,IAAI;IACP,QAAQ,IAAI;IACZ,cAAc,IAAI;IAClB,aAAa,IAAI;IACjB,QAAQ,IAAI;IACZ,MAAM,IAAI;IACV,KAAK,IAAI;IACT,QAAQ,IAAI;IACZ,SAAS,IAAI;IACb,eAAe,IAAI;IACnB,KAAK,KAAK;IACV,OAAO,KAAK;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IAClC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,eAAe;IAC5B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,uBAAuB;IACpC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;MAEE;IACF,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,cAAc;IAC3B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACjB"}