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

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

@@ -0,0 +1,184 @@
+import { ISPQueryable, _SPQueryable } from "../spqueryable.js";
+export declare class _SiteScripts extends _SPQueryable {
+    constructor(base: string | ISPQueryable, methodName?: string);
+    run<T>(props: any): Promise<T>;
+    /**
+     * Gets a list of information on all existing site scripts.
+     */
+    getSiteScripts(): Promise<ISiteScriptInfo[]>;
+    /**
+     * 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.
+     */
+    createSiteScript(title: string, description: string, content: any): Promise<ISiteScriptInfo>;
+    /**
+     * 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.
+     */
+    getSiteScriptMetadata(id: string): Promise<ISiteScriptInfo>;
+    /**
+     * Deletes a site script.
+     *
+     * @param id The ID of the site script to delete.
+     */
+    deleteSiteScript(id: string): Promise<void>;
+    /**
+     * 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.
+     */
+    updateSiteScript(updateInfo: ISiteScriptUpdateInfo, content?: any): Promise<ISiteScriptInfo>;
+    /**
+     * Gets the site script syntax (JSON) for a specific list
+     * @param listUrl The absolute url of the list to retrieve site script
+     */
+    getSiteScriptFromList(listUrl: string): Promise<string>;
+    /**
+     * 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
+     */
+    getSiteScriptFromWeb(webUrl: string, info: ISiteScriptSerializationInfo): Promise<ISiteScriptSerializationResult>;
+    /**
+     * 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
+     */
+    executeSiteScriptAction(actionDefinition: string): Promise<ISiteScriptActionResult>;
+}
+export interface ISiteScripts extends _SiteScripts {
+}
+export declare const SiteScripts: (baseUrl: string | ISPQueryable, methodName?: string) => ISiteScripts;
+/**
+ * Result from creating or retrieving a site script
+ *
+ */
+export interface ISiteScriptInfo {
+    /**
+     * The ID of the site script to apply
+     */
+    Id: string;
+    /**
+     * The display name of the site script
+     */
+    Title: string;
+    /**
+     * The description for the site script
+     */
+    Description: string;
+    /**
+     * The JSON data/definition for the site script
+     */
+    Content: string;
+    /**
+     * The version number of the site script
+     */
+    Version: string;
+}
+/**
+ * Data for updating a site script
+ *
+ */
+export interface ISiteScriptUpdateInfo {
+    /**
+     * The ID of the site script to update
+     */
+    Id: string;
+    /**
+     * (Optional) The new display name for the updated site script
+     */
+    Title?: string;
+    /**
+     * (Optional) The new description for the updated site script
+     */
+    Description?: string;
+    /**
+     * (Optional) The new JSON data/definition for the updated site script
+     */
+    Content?: string;
+    /**
+     * (Optional) The new version for the updated site script
+     */
+    Version?: string;
+}
+export interface ISiteScriptSerializationInfo {
+    /**
+     * (Optional) Include branding
+     */
+    IncludeBranding?: boolean;
+    /**
+     * (Optional) Lists to include e.g. ["Lists/MyList"]
+     */
+    IncludedLists?: string[];
+    /**
+     * (Optional) Include links to exported items
+     */
+    IncludeLinksToExportedItems?: boolean;
+    /**
+     * (Optional) Include regional settings
+     */
+    IncludeRegionalSettings?: boolean;
+    /**
+     * (Optional) Include site external sharing capability
+     */
+    IncludeSiteExternalSharingCapability?: boolean;
+    /**
+     * (Optional) Include theme
+     */
+    IncludeTheme?: boolean;
+}
+export interface ISiteScriptSerializationResult {
+    /**
+     * The site script in JSON format
+     */
+    JSON: string;
+    /**
+    * A collection of warnings
+    */
+    Warnings: string[];
+}
+export interface ISiteScriptActionResult {
+    /**
+     * The title of the action.
+     */
+    Title: string;
+    /**
+     * Text associated with the outcome of the action. If this is present, it is usually an error message.
+     */
+    OutcomeText: string;
+    /**
+     * Indicates the outcome of the action.
+     */
+    Outcome: SiteScriptActionOutcome;
+    /**
+     * Indicates the target of the action.
+     */
+    Target: string;
+}
+export declare enum SiteScriptActionOutcome {
+    /**
+     * The stage was deemed to have completed successfully.
+     */
+    Success = 0,
+    /**
+     * The stage was deemed to have failed to complete successfully (non-blocking, rest of recipe
+     * execution should still be able to proceed).
+     */
+    Failure = 1,
+    /**
+     * No action was taken for this stage / this stage was skipped.
+     */
+    NoOp = 2,
+    /**
+     * There was an exception but the operation succeeded. This is analagous to the operation completing
+     * in a "yellow" state.
+     */
+    SucceededWithException = 3
+}
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../packages/sp/site-scripts/types.ts"],"names":[],"mappings":"AACA,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;;OAEG;IACI,cAAc,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;IAInD;;;;;OAKG;IACI,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,GAAG,OAAO,CAAC,eAAe,CAAC;IAMnG;;;;OAIG;IACI,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;IAIlE;;;;OAIG;IACI,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIlD;;;;;;OAMG;IACI,gBAAgB,CAAC,UAAU,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,eAAe,CAAC;IASnG;;;OAGG;IACI,qBAAqB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAI9D;;;;OAIG;IACI,oBAAoB,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,4BAA4B,GAAG,OAAO,CAAC,8BAA8B,CAAC;IAIxH;;;;;OAKG;IACI,uBAAuB,CAAC,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC,uBAAuB,CAAC;CAG7F;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,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,4BAA4B;IACzC;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB;;OAEG;IACH,2BAA2B,CAAC,EAAE,OAAO,CAAC;IACtC;;OAEG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC;;OAEG;IACH,oCAAoC,CAAC,EAAE,OAAO,CAAC;IAC/C;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,MAAM,WAAW,8BAA8B;IAC3C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;MAEE;IACF,QAAQ,EAAE,MAAM,EAAE,CAAC;CACtB;AAED,MAAM,WAAW,uBAAuB;IAEpC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,OAAO,EAAE,uBAAuB,CAAC;IAEjC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAClB;AAED,oBAAY,uBAAuB;IAE/B;;OAEG;IACH,OAAO,IAAI;IAEX;;;OAGG;IACH,OAAO,IAAI;IAEX;;OAEG;IACH,IAAI,IAAI;IAER;;;OAGG;IACH,sBAAsB,IAAI;CAC7B"}

package/commonjs/site-scripts/types.js

@@ -0,0 +1,112 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SiteScriptActionOutcome = exports.SiteScripts = exports._SiteScripts = void 0;
+const queryable_1 = require("@pnp/queryable");
+const spqueryable_js_1 = require("../spqueryable.js");
+const extract_web_url_js_1 = require("../utils/extract-web-url.js");
+const core_1 = require("@pnp/core");
+const encode_path_str_js_1 = require("../utils/encode-path-str.js");
+class _SiteScripts extends spqueryable_js_1._SPQueryable {
+    constructor(base, methodName = "") {
+        super(base);
+        this._url = (0, core_1.combine)((0, extract_web_url_js_1.extractWebUrl)(this._url), `_api/Microsoft.Sharepoint.Utilities.WebTemplateExtensions.SiteScriptUtility.${methodName}`);
+    }
+    run(props) {
+        return (0, spqueryable_js_1.spPost)(this, (0, queryable_1.body)(props));
+    }
+    /**
+     * Gets a list of information on all existing site scripts.
+     */
+    getSiteScripts() {
+        return SiteScriptsCloneFactory(this, "GetSiteScripts").run({});
+    }
+    /**
+     * 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.
+     */
+    createSiteScript(title, description, content) {
+        return SiteScriptsCloneFactory(this, `CreateSiteScript(Title=@title,Description=@desc)?@title='${(0, encode_path_str_js_1.encodePath)(title)}'&@desc='${(0, encode_path_str_js_1.encodePath)(description)}'`)
+            .run(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.
+     */
+    getSiteScriptMetadata(id) {
+        return SiteScriptsCloneFactory(this, "GetSiteScriptMetadata").run({ id });
+    }
+    /**
+     * Deletes a site script.
+     *
+     * @param id The ID of the site script to delete.
+     */
+    deleteSiteScript(id) {
+        return SiteScriptsCloneFactory(this, "DeleteSiteScript").run({ 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.
+     */
+    updateSiteScript(updateInfo, content) {
+        if (content) {
+            updateInfo.Content = JSON.stringify(content);
+        }
+        return SiteScriptsCloneFactory(this, "UpdateSiteScript").run({ updateInfo });
+    }
+    /**
+     * Gets the site script syntax (JSON) for a specific list
+     * @param listUrl The absolute url of the list to retrieve site script
+     */
+    getSiteScriptFromList(listUrl) {
+        return SiteScriptsCloneFactory(this, "GetSiteScriptFromList").run({ 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
+     */
+    getSiteScriptFromWeb(webUrl, info) {
+        return SiteScriptsCloneFactory(this, "getSiteScriptFromWeb").run({ webUrl, 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
+     */
+    executeSiteScriptAction(actionDefinition) {
+        return SiteScriptsCloneFactory(this, "executeSiteScriptAction").run({ actionDefinition });
+    }
+}
+exports._SiteScripts = _SiteScripts;
+const SiteScripts = (baseUrl, methodName) => new _SiteScripts(baseUrl, methodName);
+exports.SiteScripts = SiteScripts;
+const SiteScriptsCloneFactory = (baseUrl, methodName = "") => (0, exports.SiteScripts)(baseUrl, methodName);
+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 = exports.SiteScriptActionOutcome || (exports.SiteScriptActionOutcome = {}));
+//# sourceMappingURL=types.js.map

package/commonjs/site-scripts/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../../packages/sp/site-scripts/types.ts"],"names":[],"mappings":";;;AAAA,8CAAsC;AACtC,sDAAuE;AACvE,oEAA4D;AAC5D,oCAAoC;AACpC,oEAAyD;AAEzD,MAAa,YAAa,SAAQ,6BAAY;IAE1C,YAAY,IAA2B,EAAE,UAAU,GAAG,EAAE;QACpD,KAAK,CAAC,IAAI,CAAC,CAAC;QACZ,IAAI,CAAC,IAAI,GAAG,IAAA,cAAO,EAAC,IAAA,kCAAa,EAAC,IAAI,CAAC,IAAI,CAAC,EAAE,+EAA+E,UAAU,EAAE,CAAC,CAAC;IAC/I,CAAC;IAEM,GAAG,CAAI,KAAU;QACpB,OAAO,IAAA,uBAAM,EAAI,IAAI,EAAE,IAAA,gBAAI,EAAC,KAAK,CAAC,CAAC,CAAC;IACxC,CAAC;IAED;;OAEG;IACI,cAAc;QACjB,OAAO,uBAAuB,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC,GAAG,CAAoB,EAAE,CAAC,CAAC;IACtF,CAAC;IAED;;;;;OAKG;IACI,gBAAgB,CAAC,KAAa,EAAE,WAAmB,EAAE,OAAY;QACpE,OAAO,uBAAuB,CAAC,IAAI,EAC/B,4DAA4D,IAAA,+BAAU,EAAC,KAAK,CAAC,YAAY,IAAA,+BAAU,EAAC,WAAW,CAAC,GAAG,CAAC;aACnH,GAAG,CAAkB,OAAO,CAAC,CAAC;IACvC,CAAC;IAED;;;;OAIG;IACI,qBAAqB,CAAC,EAAU;QACnC,OAAO,uBAAuB,CAAC,IAAI,EAAE,uBAAuB,CAAC,CAAC,GAAG,CAAkB,EAAE,EAAE,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;;;OAIG;IACI,gBAAgB,CAAC,EAAU;QAC9B,OAAO,uBAAuB,CAAC,IAAI,EAAE,kBAAkB,CAAC,CAAC,GAAG,CAAO,EAAE,EAAE,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;OAMG;IACI,gBAAgB,CAAC,UAAiC,EAAE,OAAa;QAEpE,IAAI,OAAO,EAAE;YACT,UAAU,CAAC,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;SAChD;QAED,OAAO,uBAAuB,CAAC,IAAI,EAAE,kBAAkB,CAAC,CAAC,GAAG,CAAkB,EAAE,UAAU,EAAE,CAAC,CAAC;IAClG,CAAC;IAED;;;OAGG;IACI,qBAAqB,CAAC,OAAe;QACxC,OAAO,uBAAuB,CAAC,IAAI,EAAE,uBAAuB,CAAC,CAAC,GAAG,CAAS,EAAE,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAED;;;;OAIG;IACI,oBAAoB,CAAC,MAAc,EAAE,IAAkC;QAC1E,OAAO,uBAAuB,CAAC,IAAI,EAAE,sBAAsB,CAAC,CAAC,GAAG,CAAiC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;IACvH,CAAC;IAED;;;;;OAKG;IACI,uBAAuB,CAAC,gBAAwB;QACnD,OAAO,uBAAuB,CAAC,IAAI,EAAE,yBAAyB,CAAC,CAAC,GAAG,CAA0B,EAAE,gBAAgB,EAAE,CAAC,CAAC;IACvH,CAAC;CACJ;AA1FD,oCA0FC;AAEM,MAAM,WAAW,GAAG,CAAC,OAA8B,EAAE,UAAmB,EAAgB,EAAE,CAAC,IAAI,YAAY,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;AAA3H,QAAA,WAAW,eAAgH;AAGxI,MAAM,uBAAuB,GAAG,CAAC,OAA8B,EAAE,UAAU,GAAG,EAAE,EAAwB,EAAE,CAAM,IAAA,mBAAW,EAAC,OAAO,EAAE,UAAU,CAAC,CAAC;AAqHjJ,IAAY,uBAuBX;AAvBD,WAAY,uBAAuB;IAE/B;;OAEG;IACH,2EAAW,CAAA;IAEX;;;OAGG;IACH,2EAAW,CAAA;IAEX;;OAEG;IACH,qEAAQ,CAAA;IAER;;;OAGG;IACH,yGAA0B,CAAA;AAC9B,CAAC,EAvBW,uBAAuB,GAAvB,+BAAuB,KAAvB,+BAAuB,QAuBlC"}

package/commonjs/site-scripts/web.d.ts

@@ -0,0 +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>;
+    }
+}
+//# sourceMappingURL=web.d.ts.map

package/commonjs/site-scripts/web.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"web.d.ts","sourceRoot":"","sources":["../../../../../packages/sp/site-scripts/web.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,4BAA4B,EAAE,8BAA8B,EAAE,MAAM,YAAY,CAAC;AAE1F,OAAO,QAAQ,eAAe,CAAC;IAC3B,UAAU,IAAI;QACV,aAAa,CAAC,WAAW,CAAC,EAAE,4BAA4B,GAAG,OAAO,CAAC,8BAA8B,CAAC,CAAC;KACtG;IAED,UAAU,IAAI;QACV;;;WAGG;QACH,aAAa,CAAC,WAAW,CAAC,EAAE,4BAA4B,GAAG,OAAO,CAAC,8BAA8B,CAAC,CAAC;KACtG;CACJ"}

package/commonjs/site-scripts/web.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@pnp/core");
+const types_js_1 = require("../webs/types.js");
+const types_js_2 = require("./types.js");
+types_js_1._Web.prototype.getSiteScript = async function (extractInfo) {
+    const info = await this.select("Url")();
+    return (0, types_js_2.SiteScripts)(this.toUrl(), "").using((0, core_1.AssignFrom)(this)).getSiteScriptFromWeb(info.Url, extractInfo);
+};
+//# sourceMappingURL=web.js.map

package/commonjs/site-scripts/web.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"web.js","sourceRoot":"","sources":["../../../../../packages/sp/site-scripts/web.ts"],"names":[],"mappings":";;AAAA,oCAAuC;AACvC,+CAAwC;AACxC,yCAAyC;AAiBzC,eAAI,CAAC,SAAS,CAAC,aAAa,GAAG,KAAK,WAAuB,WAA0C;IAEjG,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAmB,CAAC;IACzD,OAAO,IAAA,sBAAW,EAAC,IAAI,CAAC,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,IAAA,iBAAU,EAAC,IAAI,CAAC,CAAC,CAAC,oBAAoB,CAAC,IAAI,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;AAC7G,CAAC,CAAC"}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../packages/sp/site-users/index.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,CAAC;AAElB,OAAO,EACH,SAAS,EACT,oBAAoB,EACpB,QAAQ,EACR,SAAS,EACT,UAAU,EACV,cAAc,EACd,iBAAiB,EACjB,aAAa,GAChB,MAAM,YAAY,CAAC"}

package/commonjs/site-users/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SiteUsers = exports.SiteUser = void 0;
+require("./web.js");
+var types_js_1 = require("./types.js");
+Object.defineProperty(exports, "SiteUser", { enumerable: true, get: function () { return types_js_1.SiteUser; } });
+Object.defineProperty(exports, "SiteUsers", { enumerable: true, get: function () { return types_js_1.SiteUsers; } });
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/sp/site-users/index.ts"],"names":[],"mappings":";;;AAAA,oBAAkB;AAElB,uCASoB;AANhB,oGAAA,QAAQ,OAAA;AACR,qGAAA,SAAS,OAAA"}

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

@@ -0,0 +1,138 @@
+import { _SPCollection, _SPInstance, IDeleteable } from "../spqueryable.js";
+import { ISiteGroups } from "../site-groups/types.js";
+import { PrincipalType } from "../types.js";
+export declare class _SiteUsers extends _SPCollection<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("../spqueryable.js").ISPInvokableFactory<ISiteUsers>;
+/**
+ * Describes a single user
+ *
+ */
+export declare class _SiteUser extends _SPInstance<ISiteUserInfo> {
+    delete: (this: import("../spqueryable.js").ISPQueryable<any>) => Promise<void>;
+    /**
+     * Gets the groups for this user
+     *
+     */
+    get groups(): ISiteGroups;
+    /**
+     * Updates this user
+     *
+     * @param props Group properties to update
+     */
+    update(props: Partial<ISiteUserInfo>): Promise<IUserUpdateResult>;
+}
+export interface ISiteUser extends _SiteUser, IDeleteable {
+}
+export declare const SiteUser: import("../spqueryable.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

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../packages/sp/site-users/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,aAAa,EAEb,WAAW,EACX,WAAW,EAId,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAc,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAGlE,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE5C,qBACa,UAAW,SAAQ,aAAa,CAAC,aAAa,EAAE,CAAC;IAE1D;;;;OAIG;IACI,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS;IAIrC;;;;OAIG;IACI,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS;IAI3C;;;;OAIG;IACI,cAAc,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS;IAInD;;;;OAIG;IACI,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAI3C;;;;OAIG;IACI,iBAAiB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAMzD;;;;;OAKG;IACU,GAAG,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;CAI1D;AACD,MAAM,WAAW,UAAW,SAAQ,UAAU;CAAI;AAClD,eAAO,MAAM,SAAS,6DAA6C,CAAC;AAEpE;;;GAGG;AACH,qBAAa,SAAU,SAAQ,WAAW,CAAC,aAAa,CAAC;IAE9C,MAAM,yEAAgB;IAE7B;;;OAGG;IACH,IAAW,MAAM,IAAI,WAAW,CAE/B;IAED;;;;OAIG;IACU,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,OAAO,CAAC,iBAAiB,CAAC;CAUjF;AACD,MAAM,WAAW,SAAU,SAAQ,SAAS,EAAE,WAAW;CAAI;AAC7D,eAAO,MAAM,QAAQ,4DAA2C,CAAC;AAEjE,MAAM,WAAW,aAAc,SAAQ,cAAc;IAEjD,UAAU,EAAE,MAAM,CAAC;IACnB,8BAA8B,EAAE,OAAO,CAAC;IACxC,MAAM,EAAE;QACJ,MAAM,EAAE,MAAM,CAAC;QACf,YAAY,EAAE,MAAM,CAAC;KACxB,CAAC;IACF,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;CACpC;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAE3B;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,YAAY,EAAE,OAAO,CAAC;IAEtB;;;OAGG;IACH,uBAAuB,EAAE,OAAO,CAAC;IAEjC;;;OAGG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,aAAa,EAAE,MAAM,GAAG,aAAa,CAAC;IAEtC;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAC9B,IAAI,EAAE,SAAS,CAAC;IAChB,IAAI,EAAE,GAAG,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACjC,IAAI,EAAE,cAAc,CAAC;IACrB,IAAI,EAAE,SAAS,CAAC;CACnB"}

package/commonjs/site-users/types.js

@@ -0,0 +1,99 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SiteUser = exports._SiteUser = exports.SiteUsers = exports._SiteUsers = void 0;
+const tslib_1 = require("tslib");
+const spqueryable_js_1 = require("../spqueryable.js");
+const types_js_1 = require("../site-groups/types.js");
+const queryable_1 = require("@pnp/queryable");
+const decorators_js_1 = require("../decorators.js");
+let _SiteUsers = class _SiteUsers extends spqueryable_js_1._SPCollection {
+    /**
+     * Gets a user from the collection by id
+     *
+     * @param id The id of the user to retrieve
+     */
+    getById(id) {
+        return (0, exports.SiteUser)(this, `getById(${id})`);
+    }
+    /**
+     * Gets a user from the collection by email
+     *
+     * @param email The email address of the user to retrieve
+     */
+    getByEmail(email) {
+        return (0, exports.SiteUser)(this, `getByEmail('${email}')`);
+    }
+    /**
+     * Gets a user from the collection by login name
+     *
+     * @param loginName The login name of the user to retrieve
+     */
+    getByLoginName(loginName) {
+        return (0, exports.SiteUser)(this).concat(`('!@v::${loginName}')`);
+    }
+    /**
+     * Removes a user from the collection by id
+     *
+     * @param id The id of the user to remove
+     */
+    removeById(id) {
+        return (0, spqueryable_js_1.spPost)((0, exports.SiteUsers)(this, `removeById(${id})`));
+    }
+    /**
+     * Removes a user from the collection by login name
+     *
+     * @param loginName The login name of the user to remove
+     */
+    removeByLoginName(loginName) {
+        const o = (0, exports.SiteUsers)(this, "removeByLoginName(@v)");
+        o.query.set("@v", `'${loginName}'`);
+        return (0, spqueryable_js_1.spPost)(o);
+    }
+    /**
+     * Adds a user to a site collection
+     *
+     * @param loginName The login name of the user to add  to a site collection
+     *
+     */
+    async add(loginName) {
+        await (0, spqueryable_js_1.spPost)(this, (0, queryable_1.body)({ LoginName: loginName }));
+        return this.getByLoginName(loginName);
+    }
+};
+_SiteUsers = (0, tslib_1.__decorate)([
+    (0, decorators_js_1.defaultPath)("siteusers")
+], _SiteUsers);
+exports._SiteUsers = _SiteUsers;
+exports.SiteUsers = (0, spqueryable_js_1.spInvokableFactory)(_SiteUsers);
+/**
+ * Describes a single user
+ *
+ */
+class _SiteUser extends spqueryable_js_1._SPInstance {
+    constructor() {
+        super(...arguments);
+        this.delete = (0, spqueryable_js_1.deleteable)();
+    }
+    /**
+     * Gets the groups for this user
+     *
+     */
+    get groups() {
+        return (0, types_js_1.SiteGroups)(this, "groups");
+    }
+    /**
+     * Updates this user
+     *
+     * @param props Group properties to update
+     */
+    async update(props) {
+        const data = await (0, spqueryable_js_1.spPostMerge)(this, (0, queryable_1.body)(props));
+        return {
+            data,
+            user: this,
+        };
+    }
+}
+exports._SiteUser = _SiteUser;
+exports.SiteUser = (0, spqueryable_js_1.spInvokableFactory)(_SiteUser);
+//# sourceMappingURL=types.js.map

package/commonjs/site-users/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../../packages/sp/site-users/types.ts"],"names":[],"mappings":";;;;AAAA,sDAQ2B;AAC3B,sDAAkE;AAClE,8CAAsC;AACtC,oDAA+C;AAI/C,IAAa,UAAU,GAAvB,MAAa,UAAW,SAAQ,8BAA8B;IAE1D;;;;OAIG;IACI,OAAO,CAAC,EAAU;QACrB,OAAO,IAAA,gBAAQ,EAAC,IAAI,EAAE,WAAW,EAAE,GAAG,CAAC,CAAC;IAC5C,CAAC;IAED;;;;OAIG;IACI,UAAU,CAAC,KAAa;QAC3B,OAAO,IAAA,gBAAQ,EAAC,IAAI,EAAE,eAAe,KAAK,IAAI,CAAC,CAAC;IACpD,CAAC;IAED;;;;OAIG;IACI,cAAc,CAAC,SAAiB;QACnC,OAAO,IAAA,gBAAQ,EAAC,IAAI,CAAC,CAAC,MAAM,CAAC,UAAU,SAAS,IAAI,CAAC,CAAC;IAC1D,CAAC;IAED;;;;OAIG;IACI,UAAU,CAAC,EAAU;QACxB,OAAO,IAAA,uBAAM,EAAC,IAAA,iBAAS,EAAC,IAAI,EAAE,cAAc,EAAE,GAAG,CAAC,CAAC,CAAC;IACxD,CAAC;IAED;;;;OAIG;IACI,iBAAiB,CAAC,SAAiB;QACtC,MAAM,CAAC,GAAG,IAAA,iBAAS,EAAC,IAAI,EAAE,uBAAuB,CAAC,CAAC;QACnD,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,SAAS,GAAG,CAAC,CAAC;QACpC,OAAO,IAAA,uBAAM,EAAC,CAAC,CAAC,CAAC;IACrB,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,GAAG,CAAC,SAAiB;QAC9B,MAAM,IAAA,uBAAM,EAAC,IAAI,EAAE,IAAA,gBAAI,EAAC,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC;QACnD,OAAO,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;IAC1C,CAAC;CACJ,CAAA;AA3DY,UAAU;IADtB,IAAA,2BAAW,EAAC,WAAW,CAAC;GACZ,UAAU,CA2DtB;AA3DY,gCAAU;AA6DV,QAAA,SAAS,GAAG,IAAA,mCAAkB,EAAa,UAAU,CAAC,CAAC;AAEpE;;;GAGG;AACH,MAAa,SAAU,SAAQ,4BAA0B;IAAzD;;QAEW,WAAM,GAAG,IAAA,2BAAU,GAAE,CAAC;IAyBjC,CAAC;IAvBG;;;OAGG;IACH,IAAW,MAAM;QACb,OAAO,IAAA,qBAAU,EAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACtC,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,MAAM,CAAC,KAA6B;QAE7C,MAAM,IAAI,GAAG,MAAM,IAAA,4BAAW,EAAC,IAAI,EAAE,IAAA,gBAAI,EAAC,KAAK,CAAC,CAAC,CAAC;QAElD,OAAO;YACH,IAAI;YACJ,IAAI,EAAE,IAAI;SACb,CAAC;IACN,CAAC;CAEJ;AA3BD,8BA2BC;AAEY,QAAA,QAAQ,GAAG,IAAA,mCAAkB,EAAY,SAAS,CAAC,CAAC"}

package/commonjs/site-users/web.d.ts

@@ -0,0 +1,32 @@
+import { ISiteUsers, ISiteUser, IWebEnsureUserResult } from "./types.js";
+declare module "../webs/types" {
+    interface _Web {
+        readonly siteUsers: ISiteUsers;
+        readonly currentUser: ISiteUser;
+        ensureUser(loginName: string): Promise<IWebEnsureUserResult>;
+        getUserById(id: number): ISiteUser;
+    }
+    interface IWeb {
+        /**
+         * The site users
+         */
+        readonly siteUsers: ISiteUsers;
+        /**
+         * Information on the current user
+         */
+        readonly currentUser: ISiteUser;
+        /**
+        * Checks whether the specified login name belongs to a valid user in the web. If the user doesn't exist, adds the user to the web.
+        *
+        * @param loginName The login name of the user (ex: i:0#.f|membership|user@domain.onmicrosoft.com)
+        */
+        ensureUser(loginName: string): Promise<IWebEnsureUserResult>;
+        /**
+         * Returns the user corresponding to the specified member identifier for the current site
+         *
+         * @param id The id of the user
+         */
+        getUserById(id: number): ISiteUser;
+    }
+}
+//# sourceMappingURL=web.d.ts.map

package/commonjs/site-users/web.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"web.d.ts","sourceRoot":"","sources":["../../../../../packages/sp/site-users/web.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,UAAU,EAAa,SAAS,EAAY,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAI9F,OAAO,QAAQ,eAAe,CAAC;IAC3B,UAAU,IAAI;QACV,QAAQ,CAAC,SAAS,EAAE,UAAU,CAAC;QAC/B,QAAQ,CAAC,WAAW,EAAE,SAAS,CAAC;QAChC,UAAU,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;QAC7D,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS,CAAC;KACtC;IACD,UAAU,IAAI;QAEV;;WAEG;QACH,QAAQ,CAAC,SAAS,EAAE,UAAU,CAAC;QAE/B;;WAEG;QACH,QAAQ,CAAC,WAAW,EAAE,SAAS,CAAC;QAEhC;;;;UAIE;QACF,UAAU,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;QAE7D;;;;WAIG;QACH,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS,CAAC;KACtC;CACJ"}

package/commonjs/site-users/web.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const queryable_1 = require("@pnp/queryable");
+const types_js_1 = require("../webs/types.js");
+const types_js_2 = require("./types.js");
+const odata_url_from_js_1 = require("../utils/odata-url-from.js");
+const spqueryable_js_1 = require("../spqueryable.js");
+(0, queryable_1.addProp)(types_js_1._Web, "siteUsers", types_js_2.SiteUsers);
+(0, queryable_1.addProp)(types_js_1._Web, "currentUser", types_js_2.SiteUser);
+types_js_1._Web.prototype.ensureUser = async function (logonName) {
+    const data = await (0, spqueryable_js_1.spPost)((0, types_js_1.Web)(this, "ensureuser"), (0, queryable_1.body)({ logonName }));
+    return {
+        data,
+        user: (0, types_js_2.SiteUser)([this, (0, odata_url_from_js_1.odataUrlFrom)(data)]),
+    };
+};
+types_js_1._Web.prototype.getUserById = function (id) {
+    return (0, types_js_2.SiteUser)(this, `getUserById(${id})`);
+};
+//# sourceMappingURL=web.js.map