spws/lib/services/userGroup/getGroupCollectionFromUser.js

SharePoint Web Services Wrapper

"use strict";
var __assign = (this && this.__assign) || function () {
    __assign = Object.assign || function(t) {
        for (var s, i = 1, n = arguments.length; i < n; i++) {
            s = arguments[i];
            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
                t[p] = s[p];
        }
        return t;
    };
    return __assign.apply(this, arguments);
};
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());
    });
};
var __generator = (this && this.__generator) || function (thisArg, body) {
    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
    function verb(n) { return function (v) { return step([n, v]); }; }
    function step(op) {
        if (f) throw new TypeError("Generator is already executing.");
        while (g && (g = 0, op[0] && (_ = 0)), _) try {
            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
            if (y = 0, t) op = [op[0] & 2, t.value];
            switch (op[0]) {
                case 0: case 1: t = op; break;
                case 4: _.label++; return { value: op[1], done: false };
                case 5: _.label++; y = op[1]; op = [0]; continue;
                case 7: op = _.ops.pop(); _.trys.pop(); continue;
                default:
                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
                    if (t[2]) _.ops.pop();
                    _.trys.pop(); continue;
            }
            op = body.call(thisArg, _);
        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
    }
};
Object.defineProperty(exports, "__esModule", { value: true });
// SPWS Library
var __1 = require("../..");
// Classes
var classes_1 = require("../../classes");
// Enum
var enum_1 = require("../../enum");
// Utils
var utils_1 = require("../../utils");
/**
 * Returns information about the collection of groups of which the specified user is a member
 * @param userLoginName The user login name including the domain
 * @link https://docs.microsoft.com/en-us/previous-versions/office/developer/sharepoint-services/ms772552(v=office.12)
 * @example
 * ```
 * // Get groups for current site
 * const res = await getGroupCollectionFromUser("dev\\john.smith");
 *
 * // Get groups for different site
 * const res = await getGroupCollectionFromUser("dev\\john.smith", { webURL: "/sites/other "});
 * ```
 */
var getGroupCollectionFromUser = function (userLoginName, _a) {
    var _b = _a === void 0 ? {} : _a, _c = _b.webURL, webURL = _c === void 0 ? __1.defaults.webURL : _c;
    return __awaiter(void 0, void 0, void 0, function () {
        var req, res, data, error_1;
        return __generator(this, function (_d) {
            switch (_d.label) {
                case 0:
                    _d.trys.push([0, 2, , 3]);
                    // If userLoginName is not provided and default user is not null
                    if (!userLoginName || typeof userLoginName !== "string") {
                        throw new classes_1.SpwsError({
                            message: "Unable to get current user as loginName was not provided",
                        });
                    }
                    req = new classes_1.SpwsRequest({
                        webURL: webURL,
                        webService: enum_1.WebServices.UserGroup,
                    });
                    // Create envelope
                    req.createEnvelope("\n      <GetGroupCollectionFromUser xmlns=\"http://schemas.microsoft.com/sharepoint/soap/directory/\">\n        <userLoginName>".concat((0, utils_1.escapeXml)(userLoginName), "</userLoginName>\n      </GetGroupCollectionFromUser>"));
                    return [4 /*yield*/, req.send()];
                case 1:
                    res = _d.sent();
                    data = Array.from(res.responseXML.querySelectorAll("Group")).map(function (el) { return ({
                        ID: el.getAttribute("ID"),
                        Name: el.getAttribute("Name"),
                        Description: el.getAttribute("Description") || "",
                        OwnerID: +el.getAttribute("OwnerID"),
                        OwnerIsUser: el.getAttribute("OwnerIsUser") === "True",
                    }); });
                    // Return response
                    return [2 /*return*/, __assign(__assign({}, res), { data: data })];
                case 2:
                    error_1 = _d.sent();
                    throw new classes_1.SpwsError(error_1);
                case 3: return [2 /*return*/];
            }
        });
    });
};
exports.default = getGroupCollectionFromUser;
//# sourceMappingURL=getGroupCollectionFromUser.js.map