spws
Version:
SharePoint Web Services Wrapper
139 lines • 7.55 kB
JavaScript
;
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 };
}
};
var __read = (this && this.__read) || function (o, n) {
var m = typeof Symbol === "function" && o[Symbol.iterator];
if (!m) return o;
var i = m.call(o), r, ar = [], e;
try {
while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
}
catch (error) { e = { error: error }; }
finally {
try {
if (r && !r.done && (m = i["return"])) m.call(i);
}
finally { if (e) throw e.error; }
}
return ar;
};
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");
/**
* Updates information for the specified group. The API does not support changing the description (Microsoft docs are incorrect).
* @param oldGroupName A string that contains the old name of the group.
* @param groupName A string that contains the new name of the group.
* @param ownerIdentifier A string that contains the user name (DOMAIN\User_Alias) for the owner of the group.
* @param ownerType A string that specifies the type of owner, which can be either user or group.
* @param description A string that contains the description for the group.
* @link https://docs.microsoft.com/en-us/previous-versions/office/developer/sharepoint-services/ms774703(v=office.12)
* @example
* ```
* const res = await removeUserFromGroup("dev\\john.smith", "Site Owners")
* ```
*/
var updateGroupInfo = function (params) { return __awaiter(void 0, void 0, void 0, function () {
var ownerType, ownerIdentifier, envelopeXml, req, res, error_1;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
_a.trys.push([0, 2, , 3]);
ownerType = params.ownerType, ownerIdentifier = params.ownerIdentifier;
// Validate ownerIdentifier if ownerType is a user
if (ownerType === "user" && !ownerIdentifier.includes("\\")) {
throw new classes_1.SpwsError({
message: "Expected ownerIdentifier of a valid string including the domain (e.g. dev\\john.smith) but received type of ".concat(typeof ownerIdentifier, " with value ").concat(ownerIdentifier || "(no value)"),
});
}
envelopeXml = Object.entries(params)
.map(function (_a) {
var _b = __read(_a, 2), key = _b[0], value = _b[1];
// Don't validate the webURL
if (key === "webURL")
return "";
// If the value is empty or not a string
if (!value || typeof value !== "string")
// Throw error
throw new classes_1.SpwsError({
message: "Expected ".concat(key, " of a valid string but received type of ").concat(typeof value, " with value ").concat(value || "(no value)"),
});
// Return xml
return "<".concat(key, ">").concat((0, utils_1.escapeXml)(value), "</").concat(key, ">");
})
.join("");
req = new classes_1.SpwsRequest({
webService: enum_1.WebServices.UserGroup,
webURL: params.webURL || __1.defaults.webURL,
soapAction: "http://schemas.microsoft.com/sharepoint/soap/directory/UpdateGroupInfo",
});
// Create envelope
req.createEnvelope("<UpdateGroupInfo xmlns=\"http://schemas.microsoft.com/sharepoint/soap/directory/\">\n ".concat(envelopeXml, "\n <description></description>\n </UpdateGroupInfo>"));
return [4 /*yield*/, req.send()];
case 1:
res = _a.sent();
// If fault, throw error
if (res.responseXML.querySelector("soap\\:Fault, Fault"))
throw new classes_1.SpwsError(res);
// Return object
return [2 /*return*/, __assign(__assign({}, res), { data: { success: true } })];
case 2:
error_1 = _a.sent();
throw new classes_1.SpwsError(error_1);
case 3: return [2 /*return*/];
}
});
}); };
exports.default = updateGroupInfo;
//# sourceMappingURL=updateGroupInfo.js.map