spws
Version:
SharePoint Web Services Wrapper
98 lines • 6.19 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");
var utils_1 = require("../../utils");
/**
* @description Saves the Web Part configuration for a specified Web Part on a SharePoint page.
* This function sends the updated XML configuration for a given Web Part and applies it to the page.
* It uses the `SaveWebPart` SOAP operation provided by the SharePoint WebPartPages web service.
*
* @param {string} pageURL - The relative URL of the page that contains the Web Part (e.g., "/sites/mysite/pages/sample.aspx").
* @param {string} storageKey - A unique identifier (GUID) of the Web Part to be saved.
* @param {string} storage - Specifies the storage scope: "None", "Personal", or "Shared". Defaults to "Shared".
* @param {string} webPartXml - The XML representation of the Web Part configuration.
* @param {string} [webURL] - Optional: The base URL of the SharePoint site. If not provided, defaults to the value in `defaults.webURL`.
* @returns {Promise<Operation>} - A promise that resolves to an Operation object, including a success flag if the Web Part was saved successfully.
*/
var saveWebPart = function (_a) {
var pageURL = _a.pageURL, storageKey = _a.storageKey, _b = _a.storage, storage = _b === void 0 ? "Shared" : _b, webPartXml = _a.webPartXml, webURL = _a.webURL;
return __awaiter(void 0, void 0, void 0, function () {
var req, res, error_1;
return __generator(this, function (_c) {
switch (_c.label) {
case 0:
_c.trys.push([0, 2, , 3]);
req = new classes_1.SpwsRequest({
webService: enum_1.WebServices.WebPartPages,
soapAction: "http://microsoft.com/sharepoint/webpartpages/SaveWebPart",
webURL: webURL || __1.defaults.webURL,
});
// Create SOAP envelope for the SaveWebPart operation
req.createEnvelope("<SaveWebPart xmlns=\"http://microsoft.com/sharepoint/webpartpages\">\n <pageUrl>".concat(pageURL, "</pageUrl>\n <storageKey>").concat(storageKey, "</storageKey>\n <webPartXml>").concat((0, utils_1.escapeXml)(webPartXml), "</webPartXml>\n <storage>").concat(storage, "</storage>\n </SaveWebPart>"));
return [4 /*yield*/, req.send()];
case 1:
res = _c.sent();
// Check for SOAP Fault errors in the response
if (res.responseXML.querySelector("soap\\:Fault, Fault"))
throw new classes_1.SpwsError(res);
// Return the result indicating the Web Part was successfully saved
return [2 /*return*/, __assign(__assign({}, res), { data: { success: true } })];
case 2:
error_1 = _c.sent();
throw new classes_1.SpwsError(error_1);
case 3: return [2 /*return*/];
}
});
});
};
exports.default = saveWebPart;
//# sourceMappingURL=saveWebPart.js.map