spws
Version:
SharePoint Web Services Wrapper
202 lines • 11.8 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 __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
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");
var getListStaticName_1 = __importDefault(require("../../utils/getListStaticName"));
/**
* Returns a schema for the specified list.
*
* @param listName The list display name or GUID
* @link https://docs.microsoft.com/en-us/previous-versions/office/developer/sharepoint-services/ms772709(v=office.12)
* @example
* ```
* // Get list using default parameters
* const list = await getList({ listName: "Announcements" });
* // Get list on another site
* const list = await getList({ listName: "Announcements", webURL: "/sites/hr" });
* // Get list with only the Title and Fields attributes parsed
* const list = await getList({ listName: "Title", attributes: ["Title", "Fields"] })
* ```
*/
var getList = function (listName, _a) {
var _b = _a === void 0 ? {} : _a, _c = _b.webURL, webURL = _c === void 0 ? __1.defaults.webURL : _c, _d = _b.attributes, attributes = _d === void 0 ? [] : _d;
return __awaiter(void 0, void 0, void 0, function () {
var req, res, list_1, attributesArray, data, serializer_1, error_1;
return __generator(this, function (_e) {
switch (_e.label) {
case 0:
req = new classes_1.SpwsRequest({ webService: enum_1.WebServices.Lists, webURL: webURL });
// Create envelope
req.createEnvelope("<GetList xmlns=\"http://schemas.microsoft.com/sharepoint/soap/\"><listName>".concat((0, utils_1.escapeXml)(listName), "</listName></GetList>"));
_e.label = 1;
case 1:
_e.trys.push([1, 3, , 4]);
return [4 /*yield*/, req.send()];
case 2:
res = _e.sent();
list_1 = res.responseXML.querySelector("List");
// If the list cannot be found
if (!list_1)
throw new classes_1.SpwsError(res);
attributesArray = attributes.length > 0
? attributes
: Array.from(list_1.attributes).map(function (el) { return el.name; });
data = attributesArray.reduce(function (object, attribute) {
object[attribute] = list_1.getAttribute(attribute) || "";
return object;
}, {});
// If the attributes param is empty, or it included StaticName
if (attributes.length === 0 || attributes.includes("StaticName")) {
// Try to get the static name
try {
data.StaticName = (0, getListStaticName_1.default)({
DefaultViewUrl: data.DefaultViewUrl,
Title: data.Title,
});
}
catch (error) {
// On error do nothing
}
}
serializer_1 = new XMLSerializer();
// If the attributes param is empty, or it included fields
if (attributes.length === 0 ||
attributes.includes(enum_1.ListAttributes.Fields))
// Add fields to data
data[enum_1.ListAttributes.Fields] = Array.from(
// Field attributes must be an array
list_1.querySelectorAll("".concat(enum_1.ListAttributes.Fields, " > Field"))).map(function (fieldElement) {
// Create field object
var field = {};
// Get the field type
var fieldType = fieldElement.getAttribute(enum_1.Field.Type);
// Reduce field from available attributes
field = Array.from(fieldElement.attributes).reduce(function (object, element) {
// Get field name and value
var key = element.nodeName;
var value = element.textContent || "";
// If the value is true or false
if (["TRUE", "FALSE"].includes(value)) {
// Cast to boolean
value = value === "TRUE";
}
// Assign key and prop
object[key] = value;
return object;
}, field);
// Handle Child Elements: Choices
if (fieldType === "Choice" || fieldType === "MultiChoice") {
// Add choicess to the field
field.Choices = Array.from(fieldElement.querySelectorAll("CHOICE"))
// Return text content
.map(function (_a) {
var textContent = _a.textContent;
return textContent;
})
// Remove empty choices
.filter(function (choice) { return choice; });
}
// Handle Child Elements: Validation
var validation = fieldElement.querySelector("Validation");
if (validation)
field.Validation = serializer_1.serializeToString(validation);
// Handle Child Elements: Default Formula
var defaultFormula = fieldElement.querySelector("DefaultFormula");
if (defaultFormula)
field.DefaultFormula = defaultFormula.textContent || "";
// Handle Child Elements: Default Formula Value
var defaultFormulaValue = fieldElement.querySelector("DefaultFormulaValue");
if (defaultFormulaValue)
field.DefaultFormulaValue = defaultFormulaValue.textContent || "";
// Handle Child Elements: Default Value
var defaultValue = fieldElement.querySelector("Default");
if (defaultValue)
field.Default = defaultValue.textContent || "";
// Handle Child Elements: Formula
if (field.Type === "Calculated") {
// String to store formula xml
var xml = "";
// Check each xml node and append to xml string
var formula = fieldElement.querySelector("Formula");
if (formula)
xml += serializer_1.serializeToString(formula);
var formulaDisplayNames = fieldElement.querySelector("FormulaDisplayNames");
if (formulaDisplayNames)
xml += serializer_1.serializeToString(formulaDisplayNames);
var fieldRefs = fieldElement.querySelector("FieldRefs");
if (fieldRefs)
xml += serializer_1.serializeToString(fieldRefs);
// If xml string is truthy, assign to field
if (xml)
field.Formula = xml;
}
// Return
return field;
});
return [2 /*return*/, __assign(__assign({}, res), { data: data })];
case 3:
error_1 = _e.sent();
throw new classes_1.SpwsError(error_1);
case 4: return [2 /*return*/];
}
});
});
};
exports.default = getList;
//# sourceMappingURL=getList.js.map