@pnp/sp 2.10.0 → 2.11.0

package/site-scripts/types.js

@@ -1,142 +1,142 @@
-import { __decorate, __extends } from "tslib";
-import { body } from "@pnp/odata";
-import { spPost } from "../operations.js";
-import { _SharePointQueryable } from "../sharepointqueryable.js";
-import { extractWebUrl } from "../utils/extractweburl.js";
-import { tag } from "../telemetry.js";
-import { escapeQueryStrValue } from "../utils/escapeQueryStrValue.js";
-var _SiteScripts = /** @class */ (function (_super) {
-    __extends(_SiteScripts, _super);
-    function _SiteScripts(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;
-    }
-    _SiteScripts.prototype.execute = function (props) {
-        return spPost(this, body(props));
-    };
-    /**
-     * Gets a list of information on all existing site scripts.
-     */
-    _SiteScripts.prototype.getSiteScripts = function () {
-        return this.clone(SiteScriptsCloneFactory, "GetSiteScripts", true).execute({});
-    };
-    /**
-     * Creates a new site script.
-     *
-     * @param title The display name of the site script.
-     * @param content JSON value that describes the script. For more information, see JSON reference.
-     */
-    _SiteScripts.prototype.createSiteScript = function (title, description, content) {
-        return this.clone(SiteScriptsCloneFactory, "CreateSiteScript(Title=@title,Description=@desc)?@title='" + escapeQueryStrValue(title) + "'&@desc='" + escapeQueryStrValue(description) + "'")
-            .execute(content);
-    };
-    /**
-     * Gets information about a specific site script. It also returns the JSON of the script.
-     *
-     * @param id The ID of the site script to get information about.
-     */
-    _SiteScripts.prototype.getSiteScriptMetadata = function (id) {
-        return this.clone(SiteScriptsCloneFactory, "GetSiteScriptMetadata").execute({ id: id });
-    };
-    /**
-     * Deletes a site script.
-     *
-     * @param id The ID of the site script to delete.
-     */
-    _SiteScripts.prototype.deleteSiteScript = function (id) {
-        return this.clone(SiteScriptsCloneFactory, "DeleteSiteScript").execute({ id: id });
-    };
-    /**
-     * Updates a site script with new values. In the REST call, all parameters are optional except the site script Id.
-     *
-     * @param siteScriptUpdateInfo Object that contains the information to update a site script.
-     *                             Make sure you stringify the content object or pass it in the second 'content' parameter
-     * @param content (Optional) A new JSON script defining the script actions. For more information, see Site design JSON schema.
-     */
-    _SiteScripts.prototype.updateSiteScript = function (updateInfo, content) {
-        if (content) {
-            updateInfo.Content = JSON.stringify(content);
-        }
-        return this.clone(SiteScriptsCloneFactory, "UpdateSiteScript").execute({ updateInfo: updateInfo });
-    };
-    /**
-     * Gets the site script syntax (JSON) for a specific list
-     * @param listUrl The absolute url of the list to retrieve site script
-     */
-    _SiteScripts.prototype.getSiteScriptFromList = function (listUrl) {
-        return this.clone(SiteScriptsCloneFactory, "GetSiteScriptFromList").execute({ listUrl: listUrl });
-    };
-    /**
-     * Gets the site script syntax (JSON) for a specific web
-     * @param webUrl The absolute url of the web to retrieve site script
-     * @param extractInfo configuration object to specify what to extract
-     */
-    _SiteScripts.prototype.getSiteScriptFromWeb = function (webUrl, info) {
-        return this.clone(SiteScriptsCloneFactory, "getSiteScriptFromWeb").execute({ webUrl: webUrl, info: info });
-    };
-    /**
-     * Executes the indicated site design action on the indicated web.
-     *
-     * @param webUrl The absolute url of the web to retrieve site script
-     * @param extractInfo configuration object to specify what to extract
-     */
-    _SiteScripts.prototype.executeSiteScriptAction = function (actionDefinition) {
-        return this.clone(SiteScriptsCloneFactory, "executeSiteScriptAction").execute({ actionDefinition: actionDefinition });
-    };
-    __decorate([
-        tag("ss.getSiteScripts")
-    ], _SiteScripts.prototype, "getSiteScripts", null);
-    __decorate([
-        tag("ss.createSiteScript")
-    ], _SiteScripts.prototype, "createSiteScript", null);
-    __decorate([
-        tag("ss.getSiteScriptMetadata")
-    ], _SiteScripts.prototype, "getSiteScriptMetadata", null);
-    __decorate([
-        tag("ss.deleteSiteScript")
-    ], _SiteScripts.prototype, "deleteSiteScript", null);
-    __decorate([
-        tag("ss.updateSiteScript")
-    ], _SiteScripts.prototype, "updateSiteScript", null);
-    __decorate([
-        tag("ss.getSiteScriptFromList")
-    ], _SiteScripts.prototype, "getSiteScriptFromList", null);
-    __decorate([
-        tag("ss.getSiteScriptFromWeb")
-    ], _SiteScripts.prototype, "getSiteScriptFromWeb", null);
-    __decorate([
-        tag("ss.executeSiteScriptAction")
-    ], _SiteScripts.prototype, "executeSiteScriptAction", null);
-    return _SiteScripts;
-}(_SharePointQueryable));
-export { _SiteScripts };
-export var SiteScripts = function (baseUrl, methodName) { return new _SiteScripts(baseUrl, methodName); };
-var SiteScriptsCloneFactory = function (baseUrl, methodName) {
-    if (methodName === void 0) { methodName = ""; }
-    return SiteScripts(baseUrl, methodName);
-};
-export var SiteScriptActionOutcome;
-(function (SiteScriptActionOutcome) {
-    /**
-     * The stage was deemed to have completed successfully.
-     */
-    SiteScriptActionOutcome[SiteScriptActionOutcome["Success"] = 0] = "Success";
-    /**
-     * The stage was deemed to have failed to complete successfully (non-blocking, rest of recipe
-     * execution should still be able to proceed).
-     */
-    SiteScriptActionOutcome[SiteScriptActionOutcome["Failure"] = 1] = "Failure";
-    /**
-     * No action was taken for this stage / this stage was skipped.
-     */
-    SiteScriptActionOutcome[SiteScriptActionOutcome["NoOp"] = 2] = "NoOp";
-    /**
-     * There was an exception but the operation succeeded. This is analagous to the operation completing
-     * in a "yellow" state.
-     */
-    SiteScriptActionOutcome[SiteScriptActionOutcome["SucceededWithException"] = 3] = "SucceededWithException";
-})(SiteScriptActionOutcome || (SiteScriptActionOutcome = {}));
+import { __decorate, __extends } from "tslib";
+import { body } from "@pnp/odata";
+import { spPost } from "../operations.js";
+import { _SharePointQueryable } from "../sharepointqueryable.js";
+import { extractWebUrl } from "../utils/extractweburl.js";
+import { tag } from "../telemetry.js";
+import { escapeQueryStrValue } from "../utils/escapeQueryStrValue.js";
+var _SiteScripts = /** @class */ (function (_super) {
+    __extends(_SiteScripts, _super);
+    function _SiteScripts(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;
+    }
+    _SiteScripts.prototype.execute = function (props) {
+        return spPost(this, body(props));
+    };
+    /**
+     * Gets a list of information on all existing site scripts.
+     */
+    _SiteScripts.prototype.getSiteScripts = function () {
+        return this.clone(SiteScriptsCloneFactory, "GetSiteScripts", true).execute({});
+    };
+    /**
+     * Creates a new site script.
+     *
+     * @param title The display name of the site script.
+     * @param content JSON value that describes the script. For more information, see JSON reference.
+     */
+    _SiteScripts.prototype.createSiteScript = function (title, description, content) {
+        return this.clone(SiteScriptsCloneFactory, "CreateSiteScript(Title=@title,Description=@desc)?@title='" + escapeQueryStrValue(title) + "'&@desc='" + escapeQueryStrValue(description) + "'")
+            .execute(content);
+    };
+    /**
+     * Gets information about a specific site script. It also returns the JSON of the script.
+     *
+     * @param id The ID of the site script to get information about.
+     */
+    _SiteScripts.prototype.getSiteScriptMetadata = function (id) {
+        return this.clone(SiteScriptsCloneFactory, "GetSiteScriptMetadata").execute({ id: id });
+    };
+    /**
+     * Deletes a site script.
+     *
+     * @param id The ID of the site script to delete.
+     */
+    _SiteScripts.prototype.deleteSiteScript = function (id) {
+        return this.clone(SiteScriptsCloneFactory, "DeleteSiteScript").execute({ id: id });
+    };
+    /**
+     * Updates a site script with new values. In the REST call, all parameters are optional except the site script Id.
+     *
+     * @param siteScriptUpdateInfo Object that contains the information to update a site script.
+     *                             Make sure you stringify the content object or pass it in the second 'content' parameter
+     * @param content (Optional) A new JSON script defining the script actions. For more information, see Site design JSON schema.
+     */
+    _SiteScripts.prototype.updateSiteScript = function (updateInfo, content) {
+        if (content) {
+            updateInfo.Content = JSON.stringify(content);
+        }
+        return this.clone(SiteScriptsCloneFactory, "UpdateSiteScript").execute({ updateInfo: updateInfo });
+    };
+    /**
+     * Gets the site script syntax (JSON) for a specific list
+     * @param listUrl The absolute url of the list to retrieve site script
+     */
+    _SiteScripts.prototype.getSiteScriptFromList = function (listUrl) {
+        return this.clone(SiteScriptsCloneFactory, "GetSiteScriptFromList").execute({ listUrl: listUrl });
+    };
+    /**
+     * Gets the site script syntax (JSON) for a specific web
+     * @param webUrl The absolute url of the web to retrieve site script
+     * @param extractInfo configuration object to specify what to extract
+     */
+    _SiteScripts.prototype.getSiteScriptFromWeb = function (webUrl, info) {
+        return this.clone(SiteScriptsCloneFactory, "getSiteScriptFromWeb").execute({ webUrl: webUrl, info: info });
+    };
+    /**
+     * Executes the indicated site design action on the indicated web.
+     *
+     * @param webUrl The absolute url of the web to retrieve site script
+     * @param extractInfo configuration object to specify what to extract
+     */
+    _SiteScripts.prototype.executeSiteScriptAction = function (actionDefinition) {
+        return this.clone(SiteScriptsCloneFactory, "executeSiteScriptAction").execute({ actionDefinition: actionDefinition });
+    };
+    __decorate([
+        tag("ss.getSiteScripts")
+    ], _SiteScripts.prototype, "getSiteScripts", null);
+    __decorate([
+        tag("ss.createSiteScript")
+    ], _SiteScripts.prototype, "createSiteScript", null);
+    __decorate([
+        tag("ss.getSiteScriptMetadata")
+    ], _SiteScripts.prototype, "getSiteScriptMetadata", null);
+    __decorate([
+        tag("ss.deleteSiteScript")
+    ], _SiteScripts.prototype, "deleteSiteScript", null);
+    __decorate([
+        tag("ss.updateSiteScript")
+    ], _SiteScripts.prototype, "updateSiteScript", null);
+    __decorate([
+        tag("ss.getSiteScriptFromList")
+    ], _SiteScripts.prototype, "getSiteScriptFromList", null);
+    __decorate([
+        tag("ss.getSiteScriptFromWeb")
+    ], _SiteScripts.prototype, "getSiteScriptFromWeb", null);
+    __decorate([
+        tag("ss.executeSiteScriptAction")
+    ], _SiteScripts.prototype, "executeSiteScriptAction", null);
+    return _SiteScripts;
+}(_SharePointQueryable));
+export { _SiteScripts };
+export var SiteScripts = function (baseUrl, methodName) { return new _SiteScripts(baseUrl, methodName); };
+var SiteScriptsCloneFactory = function (baseUrl, methodName) {
+    if (methodName === void 0) { methodName = ""; }
+    return SiteScripts(baseUrl, methodName);
+};
+export var SiteScriptActionOutcome;
+(function (SiteScriptActionOutcome) {
+    /**
+     * The stage was deemed to have completed successfully.
+     */
+    SiteScriptActionOutcome[SiteScriptActionOutcome["Success"] = 0] = "Success";
+    /**
+     * The stage was deemed to have failed to complete successfully (non-blocking, rest of recipe
+     * execution should still be able to proceed).
+     */
+    SiteScriptActionOutcome[SiteScriptActionOutcome["Failure"] = 1] = "Failure";
+    /**
+     * No action was taken for this stage / this stage was skipped.
+     */
+    SiteScriptActionOutcome[SiteScriptActionOutcome["NoOp"] = 2] = "NoOp";
+    /**
+     * There was an exception but the operation succeeded. This is analagous to the operation completing
+     * in a "yellow" state.
+     */
+    SiteScriptActionOutcome[SiteScriptActionOutcome["SucceededWithException"] = 3] = "SucceededWithException";
+})(SiteScriptActionOutcome || (SiteScriptActionOutcome = {}));
 //# sourceMappingURL=types.js.map

package/site-scripts/web.d.ts

@@ -1,14 +1,14 @@
-import { ISiteScriptSerializationInfo, ISiteScriptSerializationResult } from "./types.js";
-declare module "../webs/types" {
-    interface _Web {
-        getSiteScript(extractInfo?: ISiteScriptSerializationInfo): Promise<ISiteScriptSerializationResult>;
-    }
-    interface IWeb {
-        /**
-         * Gets the site script syntax (JSON) for the current web
-         * @param extractInfo configuration object to specify what to extract
-         */
-        getSiteScript(extractInfo?: ISiteScriptSerializationInfo): Promise<ISiteScriptSerializationResult>;
-    }
-}
+import { ISiteScriptSerializationInfo, ISiteScriptSerializationResult } from "./types.js";
+declare module "../webs/types" {
+    interface _Web {
+        getSiteScript(extractInfo?: ISiteScriptSerializationInfo): Promise<ISiteScriptSerializationResult>;
+    }
+    interface IWeb {
+        /**
+         * Gets the site script syntax (JSON) for the current web
+         * @param extractInfo configuration object to specify what to extract
+         */
+        getSiteScript(extractInfo?: ISiteScriptSerializationInfo): Promise<ISiteScriptSerializationResult>;
+    }
+}
 //# sourceMappingURL=web.d.ts.map

package/site-scripts/web.js

@@ -1,6 +1,6 @@
-import { _Web } from "../webs/types.js";
-import { SiteScripts } from "./types.js";
-_Web.prototype.getSiteScript = function (extractInfo) {
-    return SiteScripts(this.toUrl(), "").getSiteScriptFromWeb(undefined, extractInfo);
-};
+import { _Web } from "../webs/types.js";
+import { SiteScripts } from "./types.js";
+_Web.prototype.getSiteScript = function (extractInfo) {
+    return SiteScripts(this.toUrl(), "").getSiteScriptFromWeb(undefined, extractInfo);
+};
 //# sourceMappingURL=web.js.map

package/site-users/index.d.ts

@@ -1,3 +1,3 @@
-import "./web.js";
-export { ISiteUser, IWebEnsureUserResult, SiteUser, SiteUsers, ISiteUsers, ISiteUserProps, IUserUpdateResult, } from "./types.js";
+import "./web.js";
+export { ISiteUser, IWebEnsureUserResult, SiteUser, SiteUsers, ISiteUsers, ISiteUserProps, IUserUpdateResult, } from "./types.js";
 //# sourceMappingURL=index.d.ts.map

package/site-users/index.js

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

package/site-users/types.d.ts

@@ -1,139 +1,139 @@
-import { _SharePointQueryableInstance, _SharePointQueryableCollection, IDeleteable } from "../sharepointqueryable.js";
-import { ISiteGroups } from "../site-groups/types.js";
-import { ITypedHash } from "@pnp/common";
-import { PrincipalType } from "../types.js";
-export declare class _SiteUsers extends _SharePointQueryableCollection<ISiteUserInfo[]> {
-    /**
-     * Gets a user from the collection by id
-     *
-     * @param id The id of the user to retrieve
-     */
-    getById(id: number): ISiteUser;
-    /**
-     * Gets a user from the collection by email
-     *
-     * @param email The email address of the user to retrieve
-     */
-    getByEmail(email: string): ISiteUser;
-    /**
-     * Gets a user from the collection by login name
-     *
-     * @param loginName The login name of the user to retrieve
-     */
-    getByLoginName(loginName: string): ISiteUser;
-    /**
-     * Removes a user from the collection by id
-     *
-     * @param id The id of the user to remove
-     */
-    removeById(id: number): Promise<any>;
-    /**
-     * Removes a user from the collection by login name
-     *
-     * @param loginName The login name of the user to remove
-     */
-    removeByLoginName(loginName: string): Promise<any>;
-    /**
-     * Adds a user to a site collection
-     *
-     * @param loginName The login name of the user to add  to a site collection
-     *
-     */
-    add(loginName: string): Promise<ISiteUser>;
-}
-export interface ISiteUsers extends _SiteUsers {
-}
-export declare const SiteUsers: import("../sharepointqueryable.js").ISPInvokableFactory<ISiteUsers>;
-/**
- * Describes a single user
- *
- */
-export declare class _SiteUser extends _SharePointQueryableInstance<ISiteUserInfo> {
-    delete: (this: import("../sharepointqueryable.js").ISharePointQueryable<any>) => Promise<void>;
-    /**
-     * Gets the groups for this user
-     *
-     */
-    get groups(): ISiteGroups;
-    /**
-    * Updates this user instance with the supplied properties
-    *
-    * @param properties A plain object of property names and values to update for the user
-    */
-    update: (props: ITypedHash<any>) => Promise<IUserUpdateResult>;
-}
-export interface ISiteUser extends _SiteUser, IDeleteable {
-}
-export declare const SiteUser: import("../sharepointqueryable.js").ISPInvokableFactory<ISiteUser>;
-export interface ISiteUserInfo extends ISiteUserProps {
-    Expiration: string;
-    IsEmailAuthenticationGuestUser: boolean;
-    UserId: {
-        NameId: string;
-        NameIdIssuer: string;
-    };
-    UserPrincipalName: string | null;
-}
-/**
- * Describes a single user properties
- *
- */
-export interface ISiteUserProps {
-    /**
-     * Contains Site user email
-     *
-     */
-    Email: string;
-    /**
-     * Contains Site user Id
-     *
-     */
-    Id: number;
-    /**
-     * Site user IsHiddenInUI
-     *
-     */
-    IsHiddenInUI: boolean;
-    /**
-     * Site user IsShareByEmailGuestUser
-     *
-     */
-    IsShareByEmailGuestUser: boolean;
-    /**
-     * Describes if Site user Is Site Admin
-     *
-     */
-    IsSiteAdmin: boolean;
-    /**
-     * Site user LoginName
-     *
-     */
-    LoginName: string;
-    /**
-     * Site user Principal type
-     *
-     */
-    PrincipalType: number | PrincipalType;
-    /**
-     * Site user Title
-     *
-     */
-    Title: string;
-}
-/**
- * Properties that provide both a getter, and a setter.
- *
- */
-export interface IUserUpdateResult {
-    user: ISiteUser;
-    data: any;
-}
-/**
- * Result from ensuring a user
- *
- */
-export interface IWebEnsureUserResult {
-    data: ISiteUserProps;
-    user: ISiteUser;
-}
+import { _SharePointQueryableInstance, _SharePointQueryableCollection, IDeleteable } from "../sharepointqueryable.js";
+import { ISiteGroups } from "../site-groups/types.js";
+import { ITypedHash } from "@pnp/common";
+import { PrincipalType } from "../types.js";
+export declare class _SiteUsers extends _SharePointQueryableCollection<ISiteUserInfo[]> {
+    /**
+     * Gets a user from the collection by id
+     *
+     * @param id The id of the user to retrieve
+     */
+    getById(id: number): ISiteUser;
+    /**
+     * Gets a user from the collection by email
+     *
+     * @param email The email address of the user to retrieve
+     */
+    getByEmail(email: string): ISiteUser;
+    /**
+     * Gets a user from the collection by login name
+     *
+     * @param loginName The login name of the user to retrieve
+     */
+    getByLoginName(loginName: string): ISiteUser;
+    /**
+     * Removes a user from the collection by id
+     *
+     * @param id The id of the user to remove
+     */
+    removeById(id: number): Promise<any>;
+    /**
+     * Removes a user from the collection by login name
+     *
+     * @param loginName The login name of the user to remove
+     */
+    removeByLoginName(loginName: string): Promise<any>;
+    /**
+     * Adds a user to a site collection
+     *
+     * @param loginName The login name of the user to add  to a site collection
+     *
+     */
+    add(loginName: string): Promise<ISiteUser>;
+}
+export interface ISiteUsers extends _SiteUsers {
+}
+export declare const SiteUsers: import("../sharepointqueryable.js").ISPInvokableFactory<ISiteUsers>;
+/**
+ * Describes a single user
+ *
+ */
+export declare class _SiteUser extends _SharePointQueryableInstance<ISiteUserInfo> {
+    delete: (this: import("../sharepointqueryable.js").ISharePointQueryable<any>) => Promise<void>;
+    /**
+     * Gets the groups for this user
+     *
+     */
+    get groups(): ISiteGroups;
+    /**
+    * Updates this user instance with the supplied properties
+    *
+    * @param properties A plain object of property names and values to update for the user
+    */
+    update: (props: ITypedHash<any>) => Promise<IUserUpdateResult>;
+}
+export interface ISiteUser extends _SiteUser, IDeleteable {
+}
+export declare const SiteUser: import("../sharepointqueryable.js").ISPInvokableFactory<ISiteUser>;
+export interface ISiteUserInfo extends ISiteUserProps {
+    Expiration: string;
+    IsEmailAuthenticationGuestUser: boolean;
+    UserId: {
+        NameId: string;
+        NameIdIssuer: string;
+    };
+    UserPrincipalName: string | null;
+}
+/**
+ * Describes a single user properties
+ *
+ */
+export interface ISiteUserProps {
+    /**
+     * Contains Site user email
+     *
+     */
+    Email: string;
+    /**
+     * Contains Site user Id
+     *
+     */
+    Id: number;
+    /**
+     * Site user IsHiddenInUI
+     *
+     */
+    IsHiddenInUI: boolean;
+    /**
+     * Site user IsShareByEmailGuestUser
+     *
+     */
+    IsShareByEmailGuestUser: boolean;
+    /**
+     * Describes if Site user Is Site Admin
+     *
+     */
+    IsSiteAdmin: boolean;
+    /**
+     * Site user LoginName
+     *
+     */
+    LoginName: string;
+    /**
+     * Site user Principal type
+     *
+     */
+    PrincipalType: number | PrincipalType;
+    /**
+     * Site user Title
+     *
+     */
+    Title: string;
+}
+/**
+ * Properties that provide both a getter, and a setter.
+ *
+ */
+export interface IUserUpdateResult {
+    user: ISiteUser;
+    data: any;
+}
+/**
+ * Result from ensuring a user
+ *
+ */
+export interface IWebEnsureUserResult {
+    data: ISiteUserProps;
+    user: ISiteUser;
+}
 //# sourceMappingURL=types.d.ts.map