@raona/sp
Version:
Raona utilities to work with Sharepoint using pnp/sp
191 lines (190 loc) • 9.71 kB
JavaScript
"use strict";
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) {
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) : new P(function (resolve) { resolve(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 (_) 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 TermTree_1 = require("../entities/sharepoint/TermTree");
var sp_taxonomy_1 = require("@pnp/sp-taxonomy");
var sp_taxonomy_2 = require("@pnp/sp-taxonomy");
var i18nTermCollection_1 = require("../entities/i18nTermCollection");
var SPTaxonomyService = /** @class */ (function () {
/**
* @param context WebpartContextBase or ListViewCommandSetContext
*/
//TODO: not typed because of problems with spfx versions conflicts, create an SPFXContext to mimic it
function SPTaxonomyService(context) {
this.LABELS_NAME = 'Labels';
var contextType = typeof context;
var session;
switch (contextType) {
case 'object':
sp_taxonomy_2.taxonomy.setup({
spfxContext: context,
sp: {
headers: {
'Accept': 'application/json;odata=nometadata'
}
}
});
break;
case 'string':
session = new sp_taxonomy_1.Session(context);
}
this.tSession = session || sp_taxonomy_2.taxonomy;
}
SPTaxonomyService.prototype.getTermsFromTermSet = function (termSetName, select, termGroupName) {
if (select === void 0) { select = ['Id', 'Name', 'Description', 'IsRoot', 'TermsCount', 'PathOfTerm', 'Labels', 'CustomProperties']; }
return __awaiter(this, void 0, void 0, function () {
var _a, termSet, terms, formattedTerms;
return __generator(this, function (_b) {
switch (_b.label) {
case 0: return [4 /*yield*/, this.getTermSetCommon(termSetName, termGroupName)];
case 1:
termSet = _b.sent();
return [4 /*yield*/, (_a = termSet.terms).select.apply(_a, select).get()];
case 2:
terms = _b.sent();
formattedTerms = this.formatTerms(terms, select);
return [2 /*return*/, formattedTerms];
}
});
});
};
/**
* Same as getTermsFromTermSet, but with a wrapper for the translated terms, for easy access.
* @param termSetName Term set name
* @param select only supply this if you know what are you doing, by default it selects Id, Name, Description, IsRoot, TermsCount, PathOfTerm, Labels and CustomProperties
* @remark If you supply select parameter, ensure Labels is included or you won't be able to translate anything.
*/
SPTaxonomyService.prototype.getTranslatedTermsFromTermSet = function (termSetName, select) {
return __awaiter(this, void 0, void 0, function () {
var _a;
return __generator(this, function (_b) {
switch (_b.label) {
case 0:
_a = i18nTermCollection_1.i18nTermCollection.bind;
return [4 /*yield*/, this.getTermsFromTermSet(termSetName, select)];
case 1: return [2 /*return*/, new (_a.apply(i18nTermCollection_1.i18nTermCollection, [void 0, _b.sent()]))()];
}
});
});
};
SPTaxonomyService.prototype.getTermSet = function (termSetName, termGroupName) {
return __awaiter(this, void 0, void 0, function () {
var termSet;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, this.getTermSetCommon(termSetName, termGroupName)];
case 1:
termSet = _a.sent();
return [2 /*return*/, termSet.get()];
}
});
});
};
SPTaxonomyService.prototype.getTermsFromTermSetAsTree = function (termSetName, keepTopOrder) {
if (keepTopOrder === void 0) { keepTopOrder = false; }
return __awaiter(this, void 0, void 0, function () {
var terms;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, this.getTermsFromTermSet(termSetName)];
case 1:
terms = _a.sent();
return [2 /*return*/, new TermTree_1.TermTree(terms, keepTopOrder)];
}
});
});
};
SPTaxonomyService.prototype.getTermSetCommon = function (termSetName, termGroupName) {
return __awaiter(this, void 0, void 0, function () {
var store, group;
return __generator(this, function (_a) {
store = this.tSession.getDefaultSiteCollectionTermStore();
group = termGroupName ? store.groups.getByName(termGroupName) : store.getSiteCollectionGroup(false);
return [2 /*return*/, group.termSets.getByName(termSetName)];
});
});
};
SPTaxonomyService.prototype.formatTerms = function (terms, select) {
var _this = this;
if (select.indexOf(this.LABELS_NAME)) {
return terms.map(function (t) {
var labels = t[_this.LABELS_NAME] || [];
if (labels && labels['_Child_Items_']) {
// labels = labels['_Child_Items_'].map(l => {return {lang: l.Language, value: l.Value};});
labels = labels['_Child_Items_'].reduce(function (obj, label) {
obj[label.Language] = label.Value;
return obj;
}, {});
}
return __assign({}, t, { i18nLabels: labels });
});
}
return terms;
};
SPTaxonomyService.prototype.getRawTaxonomySession = function () {
return this.tSession;
};
SPTaxonomyService.prototype.saveNewTerm = function (termName, lcid, isAvailableForTagging, termSetName, termGroupName) {
return __awaiter(this, void 0, void 0, function () {
var termSet, newTerm;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, this.getTermSet(termSetName, termGroupName)];
case 1:
termSet = _a.sent();
return [4 /*yield*/, termSet.addTerm(termName, lcid, isAvailableForTagging)];
case 2:
newTerm = _a.sent();
return [2 /*return*/, newTerm];
}
});
});
};
return SPTaxonomyService;
}());
exports.SPTaxonomyService = SPTaxonomyService;