@kwiz/common 1.0.1

package/dist/utils/sharepoint.rest/user-search.js

@@ -0,0 +1,239 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SPPeopleSearchService = void 0;
+const _dependencies_1 = require("../_dependencies");
+const rest_1 = require("../rest");
+const user_1 = require("./user");
+/**
+ * Service implementation to search people in SharePoint
+ */
+class SPPeopleSearchService {
+    /**
+     * Service constructor
+     */
+    constructor(context) {
+        this.context = context;
+        this.cachedLocalUsers = {};
+        this.cachedLocalUsers[this.context.siteUrl] = [];
+    }
+    /**
+     * Generate the user photo link using SharePoint user photo endpoint.
+     *
+     * @param value
+     */
+    generateUserPhotoLink(value, size = "M") {
+        return `${this.context.siteUrl}/_layouts/15/userphoto.aspx?accountname=${encodeURIComponent(value)}&size=M`;
+    }
+    /**
+     * Generate sum of principal types
+     *
+     * PrincipalType controls the type of entities that are returned in the results.
+     * Choices are All - 15, Distribution List - 2 , Security Groups - 4, SharePoint Groups - 8, User - 1.
+     * These values can be combined (example: 13 is security + SP groups + users)
+     *
+     * @param principalTypes
+     */
+    getSumOfPrincipalTypes(principalTypes) {
+        return !!principalTypes && principalTypes.length > 0 ? principalTypes.reduce((a, b) => a + b, 0) : 1;
+    }
+    /**
+     * Retrieve the specified group
+     *
+     * @param groupName
+     * @param siteUrl
+     */
+    getGroupId(groupName, siteUrl = null) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // if (Environment.type === EnvironmentType.Local) {
+            //     return 1;
+            // } else {
+            const groups = yield this.searchTenant(siteUrl, groupName, 1, [8 /* PrincipalType.SharePointGroup */], false, 0);
+            return (groups && groups.length > 0) ? parseInt(groups[0].id) : null;
+            //}
+        });
+    }
+    /**
+     * Search person by its email or login name
+     */
+    searchPersonByEmailOrLogin(email, principalTypes, siteUrl = null, groupId = null, ensureUser = false) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // if (Environment.type === EnvironmentType.Local) {
+            //     // If the running environment is local, load the data from the mock
+            //     const mockUsers = await this.searchPeopleFromMock(email);
+            //     return (mockUsers && mockUsers.length > 0) ? mockUsers[0] : null;
+            // } else {
+            const userResults = yield this.searchTenant(siteUrl, email, 1, principalTypes, ensureUser, groupId);
+            return (userResults && userResults.length > 0) ? userResults[0] : null;
+            //}
+        });
+    }
+    /**
+     * Search All Users from the SharePoint People database
+     */
+    searchPeople(query, maximumSuggestions, principalTypes, siteUrl = null, groupId = null, ensureUser = false) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // if (Environment.type === EnvironmentType.Local) {
+            //     // If the running environment is local, load the data from the mock
+            //     return this.searchPeopleFromMock(query);
+            // } else {
+            return yield this.searchTenant(siteUrl, query, maximumSuggestions, principalTypes, ensureUser, groupId);
+            //}
+        });
+    }
+    /**
+     * Tenant search
+     */
+    searchTenant(siteUrl, query, maximumSuggestions, principalTypes, ensureUser, groupId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                // If the running env is SharePoint, loads from the peoplepicker web service
+                const userRequestUrl = `${siteUrl || this.context.siteUrl}/_api/SP.UI.ApplicationPages.ClientPeoplePickerWebServiceInterface.clientPeoplePickerSearchUser`;
+                const searchBody = {
+                    queryParams: {
+                        AllowEmailAddresses: true,
+                        AllowMultipleEntities: false,
+                        AllUrlZones: false,
+                        MaximumEntitySuggestions: maximumSuggestions,
+                        PrincipalSource: 15,
+                        PrincipalType: this.getSumOfPrincipalTypes(principalTypes),
+                        QueryString: query
+                    }
+                };
+                // Search on the local site when "0"
+                if (siteUrl) {
+                    searchBody.queryParams["SharePointGroupID"] = 0;
+                }
+                // Check if users need to be searched in a specific group
+                if (groupId) {
+                    searchBody.queryParams["SharePointGroupID"] = groupId;
+                }
+                // Do the call against the People REST API endpoint            
+                const userDataResp = yield (0, rest_1.GetJson)(userRequestUrl, JSON.stringify(searchBody), {
+                    headers: {
+                        Accept: _dependencies_1.jsonTypes.standard,
+                        "content-type": _dependencies_1.contentTypes.json
+                    }
+                });
+                if (userDataResp && userDataResp.value && userDataResp.value.length > 0) {
+                    let values = userDataResp.value;
+                    if (typeof userDataResp.value === "string") {
+                        values = JSON.parse(userDataResp.value);
+                    }
+                    // Filter out "UNVALIDATED_EMAIL_ADDRESS"
+                    values = values.filter(v => !(v.EntityData && v.EntityData.PrincipalType && v.EntityData.PrincipalType === "UNVALIDATED_EMAIL_ADDRESS"));
+                    // Check if local user IDs need to be retrieved
+                    if (ensureUser) {
+                        for (const value of values) {
+                            // Only ensure the user if it is not a SharePoint group
+                            if (!value.EntityData || (value.EntityData && typeof value.EntityData.SPGroupID === "undefined")) {
+                                const id = yield this.ensureUser(value.Key);
+                                value.LoginName = value.Key;
+                                value.Key = id;
+                            }
+                        }
+                    }
+                    // Filter out NULL keys
+                    values = values.filter(v => v.Key !== null);
+                    const userResults = values.map(element => {
+                        switch (element.EntityType) {
+                            case 'User':
+                                return {
+                                    id: element.Key,
+                                    loginName: element.LoginName ? element.LoginName : element.Key,
+                                    imageUrl: this.generateUserPhotoLink(element.Description || ""),
+                                    imageInitials: this.getFullNameInitials(element.DisplayText),
+                                    text: element.DisplayText, // name
+                                    secondaryText: element.EntityData.Email || element.Description, // email
+                                    tertiaryText: "", // status
+                                    optionalText: "" // anything
+                                };
+                            case 'SecGroup':
+                                return {
+                                    id: element.Key,
+                                    loginName: element.LoginName ? element.LoginName : element.Key,
+                                    imageInitials: this.getFullNameInitials(element.DisplayText),
+                                    text: element.DisplayText,
+                                    secondaryText: element.ProviderName
+                                };
+                            case 'FormsRole':
+                                return {
+                                    id: element.Key,
+                                    loginName: element.LoginName ? element.LoginName : element.Key,
+                                    imageInitials: this.getFullNameInitials(element.DisplayText),
+                                    text: element.DisplayText,
+                                    secondaryText: element.ProviderName
+                                };
+                            default:
+                                return {
+                                    id: element.EntityData.SPGroupID,
+                                    loginName: element.EntityData.AccountName,
+                                    imageInitials: this.getFullNameInitials(element.DisplayText),
+                                    text: element.DisplayText,
+                                    secondaryText: element.EntityData.AccountName
+                                };
+                        }
+                    });
+                    return userResults;
+                }
+                // Nothing to return
+                return [];
+            }
+            catch (e) {
+                console.error("PeopleSearchService::searchTenant: error occured while fetching the users.");
+                return [];
+            }
+        });
+    }
+    /**
+     * Retrieves the local user ID
+     *
+     * @param userId
+     */
+    ensureUser(userId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const siteUrl = this.context.siteUrl;
+            if (this.cachedLocalUsers && this.cachedLocalUsers[siteUrl]) {
+                const users = this.cachedLocalUsers[siteUrl];
+                const userIdx = (0, _dependencies_1.firstIndexOf)(users, u => u.LoginName === userId);
+                if (userIdx !== -1) {
+                    return users[userIdx].Id;
+                }
+            }
+            const user = yield (0, user_1.EnsureUser)(siteUrl, userId);
+            if (user && user.Id) {
+                this.cachedLocalUsers[siteUrl].push(user);
+                return user.Id;
+            }
+            return null;
+        });
+    }
+    /**
+     * Generates Initials from a full name
+     */
+    getFullNameInitials(fullName) {
+        if (fullName === null) {
+            return fullName;
+        }
+        const words = fullName.split(' ');
+        if (words.length === 0) {
+            return '';
+        }
+        else if (words.length === 1) {
+            return words[0].charAt(0);
+        }
+        else {
+            return (words[0].charAt(0) + words[1].charAt(0));
+        }
+    }
+}
+exports.SPPeopleSearchService = SPPeopleSearchService;
+//# sourceMappingURL=user-search.js.map

package/dist/utils/sharepoint.rest/user-search.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"user-search.js","sourceRoot":"","sources":["../../../src/utils/sharepoint.rest/user-search.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,oDAAmG;AACnG,kCAAkC;AAClC,iCAAoC;AAkBpC;;GAEG;AACH,MAAa,qBAAqB;IAG9B;;OAEG;IACH,YAAoB,OAAoB;QAApB,YAAO,GAAP,OAAO,CAAa;QACpC,IAAI,CAAC,gBAAgB,GAAG,EAAE,CAAC;QAC3B,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;IACrD,CAAC;IAED;;;;OAIG;IACI,qBAAqB,CAAC,KAAa,EAAE,OAAkB,GAAG;QAC7D,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,2CAA2C,kBAAkB,CAAC,KAAK,CAAC,SAAS,CAAC;IAChH,CAAC;IAED;;;;;;;;OAQG;IACI,sBAAsB,CAAC,cAA+B;QACzD,OAAO,CAAC,CAAC,cAAc,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACzG,CAAC;IAED;;;;;OAKG;IACU,UAAU,CAAC,SAAiB,EAAE,UAAkB,IAAI;;YAC7D,oDAAoD;YACpD,gBAAgB;YAChB,WAAW;YACX,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,SAAS,EAAE,CAAC,EAAE,uCAA+B,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;YACzG,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;YACrE,GAAG;QACP,CAAC;KAAA;IAED;;OAEG;IACU,0BAA0B,CAAC,KAAa,EAAE,cAA+B,EAAE,UAAkB,IAAI,EAAE,UAAkB,IAAI,EAAE,aAAsB,KAAK;;YAC/J,oDAAoD;YACpD,0EAA0E;YAC1E,gEAAgE;YAChE,wEAAwE;YACxE,WAAW;YACX,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;YACpG,OAAO,CAAC,WAAW,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;YACvE,GAAG;QACP,CAAC;KAAA;IAED;;OAEG;IACU,YAAY,CAAC,KAAa,EAAE,kBAA0B,EAAE,cAA+B,EAAE,UAAkB,IAAI,EAAE,UAAkB,IAAI,EAAE,aAAsB,KAAK;;YAC7K,oDAAoD;YACpD,0EAA0E;YAC1E,+CAA+C;YAC/C,WAAW;YACX,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,cAAc,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;YACxG,GAAG;QACP,CAAC;KAAA;IAED;;OAEG;IACW,YAAY,CAAC,OAAe,EAAE,KAAa,EAAE,kBAA0B,EAAE,cAA+B,EAAE,UAAmB,EAAE,OAAe;;YACxJ,IAAI,CAAC;gBACD,4EAA4E;gBAC5E,MAAM,cAAc,GAAW,GAAG,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,OAAO,iGAAiG,CAAC;gBACnK,MAAM,UAAU,GAAG;oBACf,WAAW,EAAE;wBACT,mBAAmB,EAAE,IAAI;wBACzB,qBAAqB,EAAE,KAAK;wBAC5B,WAAW,EAAE,KAAK;wBAClB,wBAAwB,EAAE,kBAAkB;wBAC5C,eAAe,EAAE,EAAE;wBACnB,aAAa,EAAE,IAAI,CAAC,sBAAsB,CAAC,cAAc,CAAC;wBAC1D,WAAW,EAAE,KAAK;qBACrB;iBACJ,CAAC;gBAEF,oCAAoC;gBACpC,IAAI,OAAO,EAAE,CAAC;oBACV,UAAU,CAAC,WAAW,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC;gBACpD,CAAC;gBAED,yDAAyD;gBACzD,IAAI,OAAO,EAAE,CAAC;oBACV,UAAU,CAAC,WAAW,CAAC,mBAAmB,CAAC,GAAG,OAAO,CAAC;gBAC1D,CAAC;gBAED,+DAA+D;gBAC/D,MAAM,YAAY,GAAG,MAAM,IAAA,cAAO,EAC9B,cAAc,EACd,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,EAC1B;oBACI,OAAO,EAAE;wBACL,MAAM,EAAE,yBAAS,CAAC,QAAQ;wBAC1B,cAAc,EAAE,4BAAY,CAAC,IAAI;qBACpC;iBACJ,CAAC,CAAA;gBAEN,IAAI,YAAY,IAAI,YAAY,CAAC,KAAK,IAAI,YAAY,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACtE,IAAI,MAAM,GAAQ,YAAY,CAAC,KAAK,CAAC;oBAErC,IAAI,OAAO,YAAY,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;wBACzC,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;oBAC5C,CAAC;oBAED,yCAAyC;oBACzC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,IAAI,CAAC,CAAC,UAAU,CAAC,aAAa,IAAI,CAAC,CAAC,UAAU,CAAC,aAAa,KAAK,2BAA2B,CAAC,CAAC,CAAC;oBAEzI,+CAA+C;oBAC/C,IAAI,UAAU,EAAE,CAAC;wBACb,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;4BACzB,uDAAuD;4BACvD,IAAI,CAAC,KAAK,CAAC,UAAU,IAAI,CAAC,KAAK,CAAC,UAAU,IAAI,OAAO,KAAK,CAAC,UAAU,CAAC,SAAS,KAAK,WAAW,CAAC,EAAE,CAAC;gCAC/F,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gCAC5C,KAAK,CAAC,SAAS,GAAG,KAAK,CAAC,GAAG,CAAC;gCAC5B,KAAK,CAAC,GAAG,GAAG,EAAE,CAAC;4BACnB,CAAC;wBACL,CAAC;oBACL,CAAC;oBAED,uBAAuB;oBACvB,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,CAAC,CAAC;oBAC5C,MAAM,WAAW,GAAG,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE;wBACrC,QAAQ,OAAO,CAAC,UAAU,EAAE,CAAC;4BACzB,KAAK,MAAM;gCACP,OAAO;oCACH,EAAE,EAAE,OAAO,CAAC,GAAG;oCACf,SAAS,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG;oCAC9D,QAAQ,EAAE,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,WAAW,IAAI,EAAE,CAAC;oCAC/D,aAAa,EAAE,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,WAAW,CAAC;oCAC5D,IAAI,EAAE,OAAO,CAAC,WAAW,EAAE,OAAO;oCAClC,aAAa,EAAE,OAAO,CAAC,UAAU,CAAC,KAAK,IAAI,OAAO,CAAC,WAAW,EAAE,QAAQ;oCACxE,YAAY,EAAE,EAAE,EAAE,SAAS;oCAC3B,YAAY,EAAE,EAAE,CAAC,WAAW;iCACN,CAAC;4BAC/B,KAAK,UAAU;gCACX,OAAO;oCACH,EAAE,EAAE,OAAO,CAAC,GAAG;oCACf,SAAS,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG;oCAC9D,aAAa,EAAE,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,WAAW,CAAC;oCAC5D,IAAI,EAAE,OAAO,CAAC,WAAW;oCACzB,aAAa,EAAE,OAAO,CAAC,YAAY;iCACb,CAAC;4BAC/B,KAAK,WAAW;gCACZ,OAAO;oCACH,EAAE,EAAE,OAAO,CAAC,GAAG;oCACf,SAAS,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG;oCAC9D,aAAa,EAAE,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,WAAW,CAAC;oCAC5D,IAAI,EAAE,OAAO,CAAC,WAAW;oCACzB,aAAa,EAAE,OAAO,CAAC,YAAY;iCACb,CAAC;4BAC/B;gCACI,OAAO;oCACH,EAAE,EAAE,OAAO,CAAC,UAAU,CAAC,SAAS;oCAChC,SAAS,EAAE,OAAO,CAAC,UAAU,CAAC,WAAW;oCACzC,aAAa,EAAE,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,WAAW,CAAC;oCAC5D,IAAI,EAAE,OAAO,CAAC,WAAW;oCACzB,aAAa,EAAE,OAAO,CAAC,UAAU,CAAC,WAAW;iCACvB,CAAC;wBACnC,CAAC;oBACL,CAAC,CAAC,CAAC;oBAEH,OAAO,WAAW,CAAC;gBACvB,CAAC;gBAGD,oBAAoB;gBACpB,OAAO,EAAE,CAAC;YACd,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACT,OAAO,CAAC,KAAK,CAAC,4EAA4E,CAAC,CAAC;gBAC5F,OAAO,EAAE,CAAC;YACd,CAAC;QACL,CAAC;KAAA;IAED;;;;OAIG;IACW,UAAU,CAAC,MAAc;;YACnC,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;YACrC,IAAI,IAAI,CAAC,gBAAgB,IAAI,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC1D,MAAM,KAAK,GAAG,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;gBAC7C,MAAM,OAAO,GAAG,IAAA,4BAAY,EAAC,KAAK,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,KAAK,MAAM,CAAC,CAAC;gBACjE,IAAI,OAAO,KAAK,CAAC,CAAC,EAAE,CAAC;oBACjB,OAAO,KAAK,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC;gBAC7B,CAAC;YACL,CAAC;YAED,MAAM,IAAI,GAAG,MAAM,IAAA,iBAAU,EAAC,OAAO,EAAE,MAAM,CAAC,CAAA;YAC9C,IAAI,IAAI,IAAI,IAAI,CAAC,EAAE,EAAE,CAAC;gBAClB,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC1C,OAAO,IAAI,CAAC,EAAE,CAAC;YACnB,CAAC;YACD,OAAO,IAAI,CAAC;QAChB,CAAC;KAAA;IAED;;OAEG;IACK,mBAAmB,CAAC,QAAgB;QACxC,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;YACpB,OAAO,QAAQ,CAAC;QACpB,CAAC;QAED,MAAM,KAAK,GAAa,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC5C,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACrB,OAAO,EAAE,CAAC;QACd,CAAC;aAAM,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC5B,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAC9B,CAAC;aAAM,CAAC;YACJ,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QACrD,CAAC;IACL,CAAC;CACJ;AAtOD,sDAsOC"}

package/dist/utils/sharepoint.rest/user.d.ts

@@ -0,0 +1,71 @@
+import { IGroupInfo, ISPPeoplePickerControlFormEntity, IUserInfo, PrincipalType } from "../_dependencies";
+/** Get user login name */
+export declare function GetUserLoginName(siteUrl?: string): Promise<string>;
+/** Get user login name syncronously */
+export declare function GetUserLoginNameSync(siteUrl?: string): string;
+export declare function GetCurrentUser(siteUrl?: string, options?: {
+    expandGroups: boolean;
+    refreshCache?: boolean;
+}): Promise<IUserInfo>;
+export declare function GetCurrentUserSync(siteUrl?: string, options?: {
+    expandGroups: boolean;
+}): IUserInfo;
+export declare function GetUser(siteUrl?: string, userId?: number, options?: {
+    expandGroups: boolean;
+}): Promise<IUserInfo>;
+export declare function GetUserSync(siteUrl?: string, userId?: number, options?: {
+    expandGroups: boolean;
+}): IUserInfo;
+export declare function GetUserByLogin(siteUrl?: string, loginName?: string, options?: {
+    expandGroups: boolean;
+}): Promise<IUserInfo>;
+export declare function GetUserByLoginSync(siteUrl?: string, loginName?: string, options?: {
+    expandGroups: boolean;
+}): IUserInfo;
+export declare function EnsureUser(siteUrl: string, userLogin: string, options?: {
+    expandGroups: boolean;
+}): Promise<IUserInfo>;
+export declare function EnsureUserSync(siteUrl: string, userLogin: string, options?: {
+    expandGroups: boolean;
+}): IUserInfo;
+export declare function GetOrEnsureUserByLoginSync(siteUrl: string, key: string, options?: {
+    expandGroups: boolean;
+}): IUserInfo;
+export declare function GetSecurityGroupByTitle(siteUrl: string, title: string): Promise<IUserInfo>;
+export declare function GetSecurityGroupByTitleSync(siteUrl: string, title: string): IUserInfo;
+export declare function GetGroup(siteUrl?: string, groupId?: number, options?: {
+    expandUsers: boolean;
+    refreshCache?: boolean;
+}): Promise<IGroupInfo>;
+export declare function GetGroupSync(siteUrl?: string, groupId?: number, options?: {
+    expandUsers: boolean;
+}): IGroupInfo;
+export declare function GetGroupByName(siteUrl: string, groupName: string, options?: {
+    expandUsers: boolean;
+    refreshCache?: boolean;
+}): Promise<IGroupInfo>;
+export declare function GetGroupByNameSync(siteUrl: string, groupName: string, options?: {
+    expandUsers: boolean;
+}): IGroupInfo;
+export declare function GetSiteGroups(siteUrl: string, refreshCache?: boolean): Promise<IGroupInfo[]>;
+export declare function GetInfoFromSPPeoplePickerControlFormEntity(entity: ISPPeoplePickerControlFormEntity): IUserInfo | IGroupInfo;
+interface ICreateSiteGroupResult {
+    Id: number;
+    IsHiddenInUI: boolean;
+    LoginName: string;
+    Title: string;
+    PrincipalType: PrincipalType.SharePointGroup;
+    AllowMembersEditMembership: boolean;
+    AllowRequestToJoinLeave: boolean;
+    AutoAcceptRequestToJoinLeave: boolean;
+    Description: string;
+    OnlyAllowMembersViewMembership: boolean;
+    OwnerTitle: string;
+}
+export declare function CreateSiteGroup(siteUrl: string, info: {
+    name: string;
+    description: string;
+}): Promise<ICreateSiteGroupResult>;
+export declare function AddUserToGroup(siteUrl: string, groupId: number, userIdOrLogin: number | string): Promise<void>;
+export declare function RemoveUserFromGroup(siteUrl: string, groupId: number, userId: number): Promise<void>;
+export {};