spws
Version:
SharePoint Web Services Wrapper
277 lines • 16.2 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;
};
var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
if (ar || !(i in from)) {
if (!ar) ar = Array.prototype.slice.call(from, 0, i);
ar[i] = from[i];
}
}
return to.concat(ar || Array.prototype.slice.call(from));
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
// Libraries
var __1 = require("../../..");
// TODO: Remove this library dependency
var camljs_1 = __importDefault(require("camljs"));
// Classes
var classes_1 = require("../../../classes");
// Enum
var enum_1 = require("../../../enum");
// Utils
var utils_1 = require("../../../utils");
// Local
var sendRequest_1 = __importDefault(require("./sendRequest"));
// Create cache for any data that doesn't need to be repeated
var cache = { listViewThreshold: {} };
/**
* Adds the user to the specified group
* @param listName A string that contains either the display name or the GUID for the list
* @link https://docs.microsoft.com/en-us/previous-versions/office/developer/sharepoint-services/ms772599(v=office.12)
* @link https://docs.microsoft.com/en-us/openspecs/sharepoint_protocols/ms-listsws/fa650bde-c79b-4a2a-bb5d-c43e74166322?redirectedfrom=MSDN
* @example
* ```
* const res = await getListItems("Task Tracker")
* ```
*/
var getListItems = function (listName, _a) {
var _b = _a === void 0 ? {} : _a, _c = _b.onBatchStart, onBatchStart = _c === void 0 ? undefined : _c, _d = _b.onBatchStep, onBatchStep = _d === void 0 ? undefined : _d, parseItem = _b.parseItem, _e = _b.batch, batch = _e === void 0 ? false : _e, _f = _b.viewName, viewName = _f === void 0 ? "" : _f, _g = _b.fields, fields = _g === void 0 ? [] : _g, _h = _b.query, query = _h === void 0 ? "<Query/>" : _h, _j = _b.webURL, webURL = _j === void 0 ? __1.defaults.webURL : _j, _k = _b.queryOptions, queryOptions = _k === void 0 ? __assign({}, __1.defaults.queryOptions) : _k, _l = _b.rowLimit, rowLimit = _l === void 0 ? 0 : _l;
return __awaiter(void 0, void 0, void 0, function () {
var viewFields_1, parseFields_1, fieldsClone_1, fieldRefs, queryOpt_1, camlQuery_1, lastItemID_1, firstItemID_1, batchCount, listViewThreshold, lastID, firstID, batches_1, response_1, error_1;
return __generator(this, function (_m) {
switch (_m.label) {
case 0:
_m.trys.push([0, 9, , 10]);
// Validate type
if (typeof listName !== "string")
throw new classes_1.SpwsError({
message: "Expected string for listName but received ".concat(typeof listName),
});
// Validate truthy string
if (!listName)
throw new classes_1.SpwsError({
message: "Expected listName to be a valid string but received an empty string",
});
// Validate fields
if (fields && !Array.isArray(fields))
throw new classes_1.SpwsError({
message: "Expected fields to be an array but recieved ".concat(typeof fields),
});
viewFields_1 = "<ViewFields Properties='True' />";
parseFields_1 = Array.isArray(fields) && fields.length > 0;
fieldsClone_1 = [];
// If fields is an array and has fields
if (parseFields_1) {
// Add to fields clone
fieldsClone_1 = __spreadArray([], __read(new Set(__spreadArray(__spreadArray([], __read(fields), false), [enum_1.Fields.EncodedAbsUrl], false))), false);
fieldRefs = fieldsClone_1.map(function (field) { return "<FieldRef Name=\"".concat(field, "\" />"); }).join("");
// Wrap fieldRefs with viewFields tag
viewFields_1 = "<ViewFields>".concat(fieldRefs, "</ViewFields>");
}
queryOpt_1 = "<QueryOptions>";
// If queryOptions are defined
if (queryOptions) {
// Iterate through all queryOptions
Object.entries(queryOptions).forEach(function (_a) {
var _b = __read(_a, 2), tagName = _b[0], value = _b[1];
// If value is not undefined
if (typeof value !== "undefined") {
// Add to query opt string
queryOpt_1 += "<".concat(tagName, ">").concat(value, "</").concat(tagName, ">");
}
});
}
// Close Query Options Tag
queryOpt_1 += "</QueryOptions>";
camlQuery_1 = /<query>|<\/query>|<query\/>/i.test(query)
? query
: "<Query>".concat(query, "</Query>");
lastItemID_1 = 0;
firstItemID_1 = 0;
batchCount = 1;
if (!batch) return [3 /*break*/, 5];
if (!!cache.listViewThreshold[webURL]) return [3 /*break*/, 2];
return [4 /*yield*/, (0, __1.getListViewThreshold)(listName, { webURL: webURL })];
case 1:
listViewThreshold = (_m.sent()).data;
// Set cached list view threshold
cache.listViewThreshold[webURL] = listViewThreshold;
_m.label = 2;
case 2: return [4 /*yield*/, (0, __1.getLastItemID)(listName, { webURL: webURL })];
case 3:
lastID = (_m.sent()).data;
lastItemID_1 = lastID;
if (!(lastID > 0)) return [3 /*break*/, 5];
return [4 /*yield*/, (0, __1.getFirstItemID)(listName, { webURL: webURL })];
case 4:
firstID = (_m.sent()).data;
firstItemID_1 = firstID;
// Calculate batchCount
batchCount = Math.ceil((lastItemID_1 - firstID) / cache.listViewThreshold[webURL]) || 1;
_m.label = 5;
case 5:
batches_1 = Array.from(new Array(batchCount));
if (!(batch && onBatchStart)) return [3 /*break*/, 7];
return [4 /*yield*/, onBatchStart(batches_1.length)];
case 6:
_m.sent();
_m.label = 7;
case 7:
response_1 = {
data: [],
responseText: [],
responseXML: [],
status: [],
statusText: [],
envelope: [],
};
// Iterate over all batches
return [4 /*yield*/, (0, utils_1.asyncForEach)(batches_1, function (b, index) { return __awaiter(void 0, void 0, void 0, function () {
var payload, fromID, toID, res;
var _a;
return __generator(this, function (_b) {
switch (_b.label) {
case 0:
payload = {
camlQuery: camlQuery_1,
fields: fieldsClone_1,
listName: listName,
parseFields: parseFields_1,
queryOpt: queryOpt_1,
req: new classes_1.SpwsRequest({ webService: enum_1.WebServices.Lists, webURL: webURL }),
rowLimit: rowLimit,
viewFields: viewFields_1,
viewName: viewName,
parseItem: parseItem,
};
// if (index > 0) return;
if (batch) {
fromID = firstItemID_1 + cache.listViewThreshold[webURL] * index - 1;
toID = fromID + cache.listViewThreshold[webURL];
// Use lastItemID if the less than the toID
if (toID > lastItemID_1)
toID = lastItemID_1;
// If the query has no children
if (camlQuery_1.length < 15) {
payload.camlQuery = "<Query>".concat(new camljs_1.default()
.Where()
.CounterField("ID")
.GreaterThan(fromID)
.And()
.CounterField("ID")
.LessThanOrEqualTo(toID)
.ToString(), "</Query>");
}
else {
// Append to the query if it had children
payload.camlQuery = camljs_1.default.FromXml(camlQuery_1)
.ModifyWhere()
.AppendAnd()
.CounterField("ID")
.GreaterThan(fromID)
.And()
.CounterField("ID")
.LessThanOrEqualTo(toID)
.ToString();
}
}
return [4 /*yield*/, (0, sendRequest_1.default)(payload)];
case 1:
res = _b.sent();
if (!(batch && onBatchStep)) return [3 /*break*/, 3];
return [4 /*yield*/, onBatchStep({ index: index, total: batches_1.length, res: res })];
case 2:
_b.sent();
_b.label = 3;
case 3:
// Push to responses
(_a = response_1.data).push.apply(_a, __spreadArray([], __read(res.data), false));
response_1.responseText.push(res.responseText);
response_1.responseXML.push(res.responseXML);
response_1.status.push(res.status);
response_1.statusText.push(res.statusText);
response_1.envelope.push(res.envelope);
return [2 /*return*/];
}
});
}); })];
case 8:
// Iterate over all batches
_m.sent();
// Return response
return [2 /*return*/, response_1];
case 9:
error_1 = _m.sent();
throw new classes_1.SpwsError(error_1);
case 10: return [2 /*return*/];
}
});
});
};
exports.default = getListItems;
//# sourceMappingURL=index.js.map