@pnp/sp 2.8.0 → 2.12.0

package/site-users/types.js

@@ -1,123 +1,123 @@
-import { __awaiter, __decorate, __extends, __generator } from "tslib";
-import { _SharePointQueryableInstance, _SharePointQueryableCollection, spInvokableFactory, deleteable, } from "../sharepointqueryable.js";
-import { SiteGroups } from "../site-groups/types.js";
-import { assign } from "@pnp/common";
-import { metadata } from "../utils/metadata.js";
-import { body } from "@pnp/odata";
-import { defaultPath } from "../decorators.js";
-import { spPost } from "../operations.js";
-import { tag } from "../telemetry.js";
-var _SiteUsers = /** @class */ (function (_super) {
-    __extends(_SiteUsers, _super);
-    function _SiteUsers() {
-        return _super !== null && _super.apply(this, arguments) || this;
-    }
-    /**
-     * Gets a user from the collection by id
-     *
-     * @param id The id of the user to retrieve
-     */
-    _SiteUsers.prototype.getById = function (id) {
-        return tag.configure(SiteUser(this, "getById(" + id + ")"), "sus.getById");
-    };
-    /**
-     * Gets a user from the collection by email
-     *
-     * @param email The email address of the user to retrieve
-     */
-    _SiteUsers.prototype.getByEmail = function (email) {
-        return tag.configure(SiteUser(this, "getByEmail('" + email + "')"), "sus.getByEmail");
-    };
-    /**
-     * Gets a user from the collection by login name
-     *
-     * @param loginName The login name of the user to retrieve
-     */
-    _SiteUsers.prototype.getByLoginName = function (loginName) {
-        return tag.configure(SiteUser(this).concat("('!@v::" + encodeURIComponent(loginName) + "')"), "sus.getByLoginName");
-    };
-    /**
-     * Removes a user from the collection by id
-     *
-     * @param id The id of the user to remove
-     */
-    _SiteUsers.prototype.removeById = function (id) {
-        return spPost(this.clone(SiteUsers, "removeById(" + id + ")"));
-    };
-    /**
-     * Removes a user from the collection by login name
-     *
-     * @param loginName The login name of the user to remove
-     */
-    _SiteUsers.prototype.removeByLoginName = function (loginName) {
-        var o = this.clone(SiteUsers, "removeByLoginName(@v)");
-        o.query.set("@v", "'" + encodeURIComponent(loginName) + "'");
-        return spPost(o);
-    };
-    /**
-     * Adds a user to a site collection
-     *
-     * @param loginName The login name of the user to add  to a site collection
-     *
-     */
-    _SiteUsers.prototype.add = function (loginName) {
-        return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, spPost(this, body(assign(metadata("SP.User"), { LoginName: loginName })))];
-                    case 1:
-                        _a.sent();
-                        return [2 /*return*/, this.getByLoginName(loginName)];
-                }
-            });
-        });
-    };
-    __decorate([
-        tag("sus.remId")
-    ], _SiteUsers.prototype, "removeById", null);
-    __decorate([
-        tag("sus.remLoginName")
-    ], _SiteUsers.prototype, "removeByLoginName", null);
-    __decorate([
-        tag("sus.add")
-    ], _SiteUsers.prototype, "add", null);
-    _SiteUsers = __decorate([
-        defaultPath("siteusers")
-    ], _SiteUsers);
-    return _SiteUsers;
-}(_SharePointQueryableCollection));
-export { _SiteUsers };
-export var SiteUsers = spInvokableFactory(_SiteUsers);
-/**
- * Describes a single user
- *
- */
-var _SiteUser = /** @class */ (function (_super) {
-    __extends(_SiteUser, _super);
-    function _SiteUser() {
-        var _this = _super !== null && _super.apply(this, arguments) || this;
-        _this.delete = deleteable("su");
-        /**
-        * Updates this user instance with the supplied properties
-        *
-        * @param properties A plain object of property names and values to update for the user
-        */
-        _this.update = _this._update("SP.User", function (data) { return ({ data: data, user: _this }); });
-        return _this;
-    }
-    Object.defineProperty(_SiteUser.prototype, "groups", {
-        /**
-         * Gets the groups for this user
-         *
-         */
-        get: function () {
-            return tag.configure(SiteGroups(this, "groups"), "su.groups");
-        },
-        enumerable: false,
-        configurable: true
-    });
-    return _SiteUser;
-}(_SharePointQueryableInstance));
-export { _SiteUser };
-export var SiteUser = spInvokableFactory(_SiteUser);
+import { __awaiter, __decorate, __extends, __generator } from "tslib";
+import { _SharePointQueryableInstance, _SharePointQueryableCollection, spInvokableFactory, deleteable, } from "../sharepointqueryable.js";
+import { SiteGroups } from "../site-groups/types.js";
+import { assign } from "@pnp/common";
+import { metadata } from "../utils/metadata.js";
+import { body } from "@pnp/odata";
+import { defaultPath } from "../decorators.js";
+import { spPost } from "../operations.js";
+import { tag } from "../telemetry.js";
+var _SiteUsers = /** @class */ (function (_super) {
+    __extends(_SiteUsers, _super);
+    function _SiteUsers() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    /**
+     * Gets a user from the collection by id
+     *
+     * @param id The id of the user to retrieve
+     */
+    _SiteUsers.prototype.getById = function (id) {
+        return tag.configure(SiteUser(this, "getById(" + id + ")"), "sus.getById");
+    };
+    /**
+     * Gets a user from the collection by email
+     *
+     * @param email The email address of the user to retrieve
+     */
+    _SiteUsers.prototype.getByEmail = function (email) {
+        return tag.configure(SiteUser(this, "getByEmail('" + email + "')"), "sus.getByEmail");
+    };
+    /**
+     * Gets a user from the collection by login name
+     *
+     * @param loginName The login name of the user to retrieve
+     */
+    _SiteUsers.prototype.getByLoginName = function (loginName) {
+        return tag.configure(SiteUser(this).concat("('!@v::" + encodeURIComponent(loginName) + "')"), "sus.getByLoginName");
+    };
+    /**
+     * Removes a user from the collection by id
+     *
+     * @param id The id of the user to remove
+     */
+    _SiteUsers.prototype.removeById = function (id) {
+        return spPost(this.clone(SiteUsers, "removeById(" + id + ")"));
+    };
+    /**
+     * Removes a user from the collection by login name
+     *
+     * @param loginName The login name of the user to remove
+     */
+    _SiteUsers.prototype.removeByLoginName = function (loginName) {
+        var o = this.clone(SiteUsers, "removeByLoginName(@v)");
+        o.query.set("@v", "'" + encodeURIComponent(loginName) + "'");
+        return spPost(o);
+    };
+    /**
+     * Adds a user to a site collection
+     *
+     * @param loginName The login name of the user to add  to a site collection
+     *
+     */
+    _SiteUsers.prototype.add = function (loginName) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, spPost(this, body(assign(metadata("SP.User"), { LoginName: loginName })))];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/, this.getByLoginName(loginName)];
+                }
+            });
+        });
+    };
+    __decorate([
+        tag("sus.remId")
+    ], _SiteUsers.prototype, "removeById", null);
+    __decorate([
+        tag("sus.remLoginName")
+    ], _SiteUsers.prototype, "removeByLoginName", null);
+    __decorate([
+        tag("sus.add")
+    ], _SiteUsers.prototype, "add", null);
+    _SiteUsers = __decorate([
+        defaultPath("siteusers")
+    ], _SiteUsers);
+    return _SiteUsers;
+}(_SharePointQueryableCollection));
+export { _SiteUsers };
+export var SiteUsers = spInvokableFactory(_SiteUsers);
+/**
+ * Describes a single user
+ *
+ */
+var _SiteUser = /** @class */ (function (_super) {
+    __extends(_SiteUser, _super);
+    function _SiteUser() {
+        var _this = _super !== null && _super.apply(this, arguments) || this;
+        _this.delete = deleteable("su");
+        /**
+        * Updates this user instance with the supplied properties
+        *
+        * @param properties A plain object of property names and values to update for the user
+        */
+        _this.update = _this._update("SP.User", function (data) { return ({ data: data, user: _this }); });
+        return _this;
+    }
+    Object.defineProperty(_SiteUser.prototype, "groups", {
+        /**
+         * Gets the groups for this user
+         *
+         */
+        get: function () {
+            return tag.configure(SiteGroups(this, "groups"), "su.groups");
+        },
+        enumerable: false,
+        configurable: true
+    });
+    return _SiteUser;
+}(_SharePointQueryableInstance));
+export { _SiteUser };
+export var SiteUser = spInvokableFactory(_SiteUser);
 //# sourceMappingURL=types.js.map

package/site-users/web.d.ts

@@ -1,32 +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;
-    }
-}
+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/site-users/web.js

@@ -1,28 +1,28 @@
-import { __awaiter, __generator } from "tslib";
-import { addProp, body } from "@pnp/odata";
-import { _Web, Web } from "../webs/types.js";
-import { SiteUsers, SiteUser } from "./types.js";
-import { odataUrlFrom } from "../odata.js";
-import { spPost } from "../operations.js";
-addProp(_Web, "siteUsers", SiteUsers);
-addProp(_Web, "currentUser", SiteUser, "currentuser");
-_Web.prototype.ensureUser = function (logonName) {
-    return __awaiter(this, void 0, void 0, function () {
-        var data;
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0: return [4 /*yield*/, spPost(this.clone(Web, "ensureuser"), body({ logonName: logonName }))];
-                case 1:
-                    data = _a.sent();
-                    return [2 /*return*/, {
-                            data: data,
-                            user: SiteUser(odataUrlFrom(data)),
-                        }];
-            }
-        });
-    });
-};
-_Web.prototype.getUserById = function (id) {
-    return SiteUser(this, "getUserById(" + id + ")");
-};
+import { __awaiter, __generator } from "tslib";
+import { addProp, body } from "@pnp/odata";
+import { _Web, Web } from "../webs/types.js";
+import { SiteUsers, SiteUser } from "./types.js";
+import { odataUrlFrom } from "../odata.js";
+import { spPost } from "../operations.js";
+addProp(_Web, "siteUsers", SiteUsers);
+addProp(_Web, "currentUser", SiteUser, "currentuser");
+_Web.prototype.ensureUser = function (logonName) {
+    return __awaiter(this, void 0, void 0, function () {
+        var data;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, spPost(this.clone(Web, "ensureuser"), body({ logonName: logonName }))];
+                case 1:
+                    data = _a.sent();
+                    return [2 /*return*/, {
+                            data: data,
+                            user: SiteUser(odataUrlFrom(data)),
+                        }];
+            }
+        });
+    });
+};
+_Web.prototype.getUserById = function (id) {
+    return SiteUser(this, "getUserById(" + id + ")");
+};
 //# sourceMappingURL=web.js.map

package/sites/index.d.ts

@@ -1,8 +1,8 @@
-import { ISite } from "./types.js";
-export { IOpenWebByIdResult, ISite, Site, IContextInfo, IDocumentLibraryInformation, } from "./types.js";
-declare module "../rest" {
-    interface SPRest {
-        readonly site: ISite;
-    }
-}
+import { ISite } from "./types.js";
+export { IOpenWebByIdResult, ISite, Site, IContextInfo, IDocumentLibraryInformation, } from "./types.js";
+declare module "../rest" {
+    interface SPRest {
+        readonly site: ISite;
+    }
+}
 //# sourceMappingURL=index.d.ts.map

package/sites/index.js

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