spws
Version:
SharePoint Web Services Wrapper
145 lines • 9.65 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 };
}
};
Object.defineProperty(exports, "__esModule", { value: true });
var __1 = require("../..");
var classes_1 = require("../../classes");
var enum_1 = require("../../enum");
/**
* @description Fetches the Web Part properties for a specified page within a SharePoint site.
* This function retrieves all the Web Parts on a given Web Part page, including their metadata,
* such as IDs, titles, visibility status, and layout details, as well as the full XML representation of each Web Part.
*
* @param {string} pageURL - The relative URL of the Web Part page (e.g., "/sites/mysite/pages/sample.aspx")
* where the Web Part resides.
* @param {string} [webURL] - The optional base URL of the SharePoint site. If not provided, it defaults to the value in `defaults.webURL`.
* @returns {Promise<Operation>} - A promise that resolves to an Operation object containing an array of Web Part properties.
*/
var getWebPartProperties = function (_a) {
var pageURL = _a.pageURL, webURL = _a.webURL;
return __awaiter(void 0, void 0, void 0, function () {
var req, res, responseXML, allNodes, webPartProperties, error_1;
return __generator(this, function (_b) {
switch (_b.label) {
case 0:
_b.trys.push([0, 2, , 3]);
req = new classes_1.SpwsRequest({
webService: enum_1.WebServices.WebPartPages,
webURL: webURL || __1.defaults.webURL,
});
// Create envelope for SOAP request
req.createEnvelope("<GetWebPartProperties xmlns=\"http://microsoft.com/sharepoint/webpartpages\">\n <pageUrl>".concat(pageURL, "</pageUrl>\n <behavior>Version3</behavior>\n <storage>Shared</storage>\n </GetWebPartProperties>"));
return [4 /*yield*/, req.send()];
case 1:
res = _b.sent();
responseXML = res.responseXML;
if (!responseXML) {
throw new classes_1.SpwsError({ message: "Invalid response XML" });
}
allNodes = responseXML.getElementsByTagName("WebPart");
if (allNodes.length === 0) {
return [2 /*return*/, __assign(__assign({}, res), { data: [] })];
}
webPartProperties = Array.from(allNodes).map(function (node) {
// Function to get text content of child node or attribute
var getChildNodeText = function (parent, tagName) {
var child = parent.querySelector(tagName);
return child ? child.textContent || "" : "";
};
return {
webPartXml: new XMLSerializer().serializeToString(node),
// Attributes (these are still fetched as attributes)
xmlns_xsi: node.getAttribute("xmlns:xsi") || "",
xmlns_xsd: node.getAttribute("xmlns:xsd") || "",
xmlns: node.getAttribute("xmlns") || "",
ID: node.getAttribute("ID") || "",
// Child nodes (these are fetched as XML elements)
Title: getChildNodeText(node, "Title"),
FrameType: getChildNodeText(node, "FrameType"),
Description: getChildNodeText(node, "Description"),
IsIncluded: getChildNodeText(node, "IsIncluded").toUpperCase() === "TRUE",
ZoneID: getChildNodeText(node, "ZoneID"),
PartOrder: parseInt(getChildNodeText(node, "PartOrder") || "0"),
FrameState: getChildNodeText(node, "FrameState"),
Height: getChildNodeText(node, "Height") || undefined,
Width: getChildNodeText(node, "Width") || undefined,
AllowRemove: getChildNodeText(node, "AllowRemove").toUpperCase() === "TRUE",
AllowZoneChange: getChildNodeText(node, "AllowZoneChange").toUpperCase() === "TRUE",
AllowMinimize: getChildNodeText(node, "AllowMinimize").toUpperCase() === "TRUE",
AllowConnect: getChildNodeText(node, "AllowConnect").toUpperCase() === "TRUE",
AllowEdit: getChildNodeText(node, "AllowEdit").toUpperCase() === "TRUE",
AllowHide: getChildNodeText(node, "AllowHide").toUpperCase() === "TRUE",
IsVisible: getChildNodeText(node, "IsVisible").toUpperCase() === "TRUE",
DetailLink: getChildNodeText(node, "DetailLink") || undefined,
HelpLink: getChildNodeText(node, "HelpLink") || undefined,
HelpMode: getChildNodeText(node, "HelpMode") || "",
Dir: getChildNodeText(node, "Dir") || "",
PartImageSmall: getChildNodeText(node, "PartImageSmall") || undefined,
MissingAssembly: getChildNodeText(node, "MissingAssembly") || undefined,
PartImageLarge: getChildNodeText(node, "PartImageLarge") || undefined,
IsIncludedFilter: getChildNodeText(node, "IsIncludedFilter") || undefined,
ExportControlledProperties: getChildNodeText(node, "ExportControlledProperties").toUpperCase() === "TRUE",
ConnectionID: getChildNodeText(node, "ConnectionID") || "",
ID_: getChildNodeText(node, "ID") || "",
Assembly: getChildNodeText(node, "Assembly") || "",
TypeName: getChildNodeText(node, "TypeName") || "",
HeaderTitle: getChildNodeText(node, "HeaderTitle") || undefined,
};
});
// Return the array of WebPartProperties
return [2 /*return*/, __assign(__assign({}, res), { data: webPartProperties })];
case 2:
error_1 = _b.sent();
throw new classes_1.SpwsError(error_1);
case 3: return [2 /*return*/];
}
});
});
};
exports.default = getWebPartProperties;
//# sourceMappingURL=getWebPartProperties.js.map