@pnp/spfx-controls-react
Version:
Reusable React controls for SharePoint Framework solutions
394 lines • 16.4 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.SPHelper = void 0;
var tslib_1 = require("tslib");
var GeneralHelper_1 = require("./GeneralHelper");
var Constants = tslib_1.__importStar(require("../Constants"));
var sp_1 = require("@pnp/sp");
require("@pnp/sp/fields");
var sp_http_1 = require("@microsoft/sp-http");
require("@pnp/sp/site-users/web");
require("@pnp/sp/webs");
require("@pnp/sp/lists");
/**
* Helper class to work with SharePoint objects and entities
*/
var SPHelper = /** @class */ (function () {
function SPHelper() {
}
/**
* Gets field's Real Name from FieldNamesMapping
* @param columnName current field name
*/
SPHelper.getStoredFieldName = function (columnName) {
if (!columnName)
return '';
var mapping = Constants.FieldNamesMapping;
return mapping[columnName] ? mapping[columnName].storedName : columnName;
};
/**
* Gets Field's text
* @param fieldValue field value as it appears in Field Customizer's onRenderCell event
* @param listItem List Item accessor
* @param context Customizer's context
*/
SPHelper.getFieldText = function (fieldValue, listItem, context) {
var _this = this;
return new Promise(function (resolve) {
var field = context.field;
if (!field) {
resolve('');
return;
}
var fieldName = field.internalName; //this.getFieldNameById(field.id.toString());
var fieldType = field.fieldType;
var strFieldValue = fieldValue ? fieldValue.toString() : '';
var friendlyDisplay;
var titles;
var users;
var lookupValues;
var lookupTexts;
var isImage = false;
var terms;
var termTexts;
var storedName;
switch (fieldType) {
case 'Note':
SPHelper.getFieldProperty(field.id.toString(), "RichText", context, false).then(function (richText) {
var isRichText = richText === 'TRUE';
if (isRichText) {
resolve(GeneralHelper_1.GeneralHelper.getTextFromHTML(strFieldValue));
}
resolve(fieldValue);
}).catch(function () { });
break;
case 'DateTime':
friendlyDisplay = SPHelper.getRowItemValueByName(listItem, "".concat(fieldName, ".FriendlyDisplay"));
resolve(friendlyDisplay ? GeneralHelper_1.GeneralHelper.getRelativeDateTimeString(friendlyDisplay) : strFieldValue);
break;
case 'User':
case 'UserMulti':
titles = [];
users = fieldValue;
if (!users) {
resolve('');
}
for (var i = 0, len = users.length; i < len; i++) {
titles.push(users[i].title);
}
resolve(titles.join('\n'));
break;
case "Lookup":
case "LookupMulti":
lookupValues = fieldValue;
if (!lookupValues) {
resolve('');
}
lookupTexts = [];
for (var i = 0, len = lookupValues.length; i < len; i++) {
lookupTexts.push(lookupValues[i].lookupValue);
}
resolve(lookupTexts.join('\n'));
break;
case 'URL':
SPHelper.getFieldProperty(field.id.toString(), 'Format', context, true).then(function (format) {
isImage = format === 'Image';
if (isImage) {
resolve('');
}
resolve(SPHelper.getRowItemValueByName(listItem, "".concat(fieldName, ".desc")));
}).catch(function () { });
break;
case 'Taxonomy':
case 'TaxonomyFieldType':
case 'TaxonomyFieldTypeMulti':
terms = Array.isArray(fieldValue) ? fieldValue : [fieldValue];
if (!terms) {
resolve('');
}
termTexts = [];
for (var i = 0, len = terms.length; i < len; i++) {
termTexts.push(terms[i].Label);
}
resolve(termTexts.join('\n'));
break;
case 'Attachments':
resolve('');
break;
case 'Computed':
storedName = _this.getStoredFieldName(fieldName);
if (storedName === 'URL') {
resolve(_this.getRowItemValueByName(listItem, 'URL.desc') || strFieldValue);
}
resolve(strFieldValue);
break;
default:
resolve(strFieldValue);
}
});
};
/**
* Gets property of the Field by Field's ID and Property Name
* @param fieldId Field's ID
* @param propertyName Property name
* @param context SPFx context
* @param fromSchemaXml true if the field should be read from Field Schema Xml
*/
SPHelper.getFieldProperty = function (fieldId, propertyName, context, fromSchemaXml) {
return new Promise(function (resolve) {
var loadedViewFields = SPHelper._getLoadedViewFieldsFromStorage();
var viewId = SPHelper.getPageViewId(context);
if (!loadedViewFields) {
loadedViewFields = {};
}
if (!loadedViewFields[viewId]) {
loadedViewFields[viewId] = {};
}
var field = loadedViewFields[viewId][fieldId];
if (!field) {
field = {
Id: fieldId
};
}
var fieldRecord = field;
if (GeneralHelper_1.GeneralHelper.isDefined(fieldRecord[propertyName])) {
resolve(fieldRecord[propertyName]);
return;
}
sp_1.sp.setup({
spfxContext: context
});
if (fromSchemaXml) {
SPHelper.getFieldSchemaXmlById(fieldId, context.pageContext.list.title, context).then(function (schemaXml) {
var fieldValue;
var xml = GeneralHelper_1.GeneralHelper.parseXml(schemaXml);
var fieldEls = xml.getElementsByTagName('Field');
if (fieldEls.length) {
var fieldEl = fieldEls[0];
fieldValue = fieldEl.getAttribute(propertyName);
if (!GeneralHelper_1.GeneralHelper.isDefined(fieldValue)) {
fieldValue = fieldEl.textContent;
}
}
if (!GeneralHelper_1.GeneralHelper.isDefined(fieldValue)) {
fieldValue = '';
}
fieldRecord[propertyName] = fieldValue;
SPHelper._updateFieldInSessionStorage(field, context);
}, function (error) {
resolve('');
});
}
else {
sp_1.sp.web.lists.getByTitle(context.pageContext.list.title).fields.getById(fieldId).select(propertyName).get().then(function (f) {
fieldRecord[propertyName] = f[propertyName];
loadedViewFields[viewId][field.Id] = field;
SPHelper._updateSessionStorageLoadedViewFields(loadedViewFields);
resolve(fieldRecord[propertyName]);
}, function (error) {
resolve('');
});
}
});
};
/**
* Asynchronously gets the Diplay Form Url for the Lookup field
* @param fieldId Field Id
* @param context SPFx Context
*/
SPHelper.getLookupFieldListDispFormUrl = function (fieldId, context) {
return new Promise(function (resolve, reject) {
var loadedViewFields = SPHelper._getLoadedViewFieldsFromStorage();
var viewId = SPHelper.getPageViewId(context);
if (!loadedViewFields) {
loadedViewFields = {};
}
if (!loadedViewFields[viewId]) {
loadedViewFields[viewId] = {};
}
var field = loadedViewFields[viewId][fieldId];
if (!field) {
field = {
Id: fieldId
};
}
if (GeneralHelper_1.GeneralHelper.isDefined(field.LookupDisplayUrl)) {
resolve(field.LookupDisplayUrl);
return;
}
sp_1.sp.setup({
spfxContext: context
});
sp_1.sp.web.lists.getByTitle(context.pageContext.list.title).fields.getById(fieldId).select('LookupWebId', 'LookupList').get().then(function (f) {
var lookupField = f;
sp_1.sp.site.openWebById(lookupField.LookupWebId).then(function (openedWeb) {
openedWeb.web.select('Url').get().then(function (w) {
field.LookupDisplayUrl = "".concat(w.Url, "/_layouts/15/listform.aspx?PageType=4&ListId=").concat(lookupField.LookupList);
SPHelper._updateFieldInSessionStorage(field, context);
resolve(field.LookupDisplayUrl);
}, function (error) {
reject(error);
});
}).catch(function () { });
}).catch(function () { });
});
};
/**
* Gets column's value for the row using List Item Accessor.
* This method works with private property _values of List Item Accessor to get such values as FriendlyDisplay text for Date, and more.
* @param listItem List Item Accessor
* @param itemName column name
*/
/* eslint-disable @typescript-eslint/no-explicit-any */
SPHelper.getRowItemValueByName = function (listItem, itemName) {
var _values = listItem._values;
if (_values) {
return _values.get(itemName);
}
else {
//
// TODO: here we should call make a POST request to _api/web/GetList(@listUrl)/RenderListDataAsStream with correct parameters to get correct data
// the parameters should contain view, folder, pagination data, etc.
// I hope that Dev team will expose this data in API before I implement that because it's pretty complicated and they already have it in place
//
return null;
}
};
/* eslint-enable @typescript-eslint/no-explicit-any */
/**
* Gets SchemaXml for the field by List Title and Field Id
* @param fieldId Field's Id
* @param listTitle List Title
* @param context Customizer's context
*/
SPHelper.getFieldSchemaXmlById = function (fieldId, listTitle, context) {
return new Promise(function (resolve) {
var loadedViewFields = SPHelper._getLoadedViewFieldsFromStorage();
var viewId = SPHelper.getPageViewId(context);
if (!loadedViewFields) {
loadedViewFields = {};
}
if (!loadedViewFields[viewId]) {
loadedViewFields[viewId] = {};
}
var field = loadedViewFields[viewId][fieldId];
if (!field) {
field = {
Id: fieldId
};
}
if (GeneralHelper_1.GeneralHelper.isDefined(field.SchemaXml)) {
resolve(field.SchemaXml);
return;
}
sp_1.sp.setup({
spfxContext: context
});
sp_1.sp.web.lists.getByTitle(listTitle).fields.getById(fieldId).select('SchemaXml').get().then(function (f) {
field.SchemaXml = f && f.SchemaXml;
loadedViewFields[viewId][field.Id] = field;
SPHelper._updateSessionStorageLoadedViewFields(loadedViewFields);
resolve(f ? f.SchemaXml : '');
}, function (error) {
resolve('');
});
});
};
/**
* Gets correct view id from the page
* @param context SPFx Context
*/
SPHelper.getPageViewId = function (context) {
var urlParams = new URLSearchParams(location.search);
var viewIdQueryParam = urlParams.get('viewid');
if (viewIdQueryParam && viewIdQueryParam.indexOf('{') !== 0) {
viewIdQueryParam = "{".concat(viewIdQueryParam, "}");
}
return viewIdQueryParam || context.pageContext.legacyPageContext.viewId;
};
/**
* Returns the user corresponding to the specified member identifier for the current site
* @param id user id
* @param context SPFx context
*/
SPHelper.getUserById = function (id, context) {
return tslib_1.__awaiter(this, void 0, void 0, function () {
return tslib_1.__generator(this, function (_a) {
sp_1.sp.setup({
spfxContext: context
});
return [2 /*return*/, sp_1.sp.web.getUserById(id).get()];
});
});
};
/**
* Returns user profile properties
* @param loginName User's login name
* @param context SPFx context
*/
SPHelper.getUserProperties = function (loginName, context) {
return tslib_1.__awaiter(this, void 0, void 0, function () {
var url;
return tslib_1.__generator(this, function (_a) {
url = context.pageContext.web.absoluteUrl;
url = GeneralHelper_1.GeneralHelper.trimSlash(url);
url += "/_api/SP.UserProfiles.PeopleManager/GetPropertiesFor(accountName=@v)?@v='" + encodeURIComponent(loginName) + "'";
return [2 /*return*/, context.spHttpClient.get(url, sp_http_1.SPHttpClient.configurations.v1)
.then(function (response) {
return response.json();
})
.then(function (value) {
return value;
})];
});
});
};
SPHelper.isTextFieldType = function (fieldType) {
if (!fieldType) {
return true;
}
var lowercasedFieldType = fieldType.toLowerCase();
return lowercasedFieldType === 'text' || lowercasedFieldType === 'note';
};
SPHelper._updateFieldInSessionStorage = function (field, context) {
var loadedViewFields = SPHelper._getLoadedViewFieldsFromStorage();
if (!loadedViewFields) {
loadedViewFields = {};
}
var viewId = SPHelper.getPageViewId(context);
if (!loadedViewFields[viewId]) {
loadedViewFields[viewId] = {};
}
loadedViewFields[viewId][field.Id] = field;
SPHelper._updateSessionStorageLoadedViewFields(loadedViewFields);
};
SPHelper._updateSessionStorageLoadedViewFields = function (loadedViewFields) {
try {
if (window.sessionStorage) {
window.sessionStorage.setItem(Constants.LoadedViewFieldsKey, JSON.stringify(loadedViewFields));
}
}
catch (_a) {
// do nothing, no need to stop fn execution
}
};
SPHelper._getLoadedViewFieldsFromStorage = function () {
try {
if (window.sessionStorage) {
var loadedViewFields = sessionStorage.getItem(Constants.LoadedViewFieldsKey);
if (loadedViewFields) {
return JSON.parse(loadedViewFields);
}
}
else {
return null;
}
}
catch (_a) {
return null;
}
};
return SPHelper;
}());
exports.SPHelper = SPHelper;
//# sourceMappingURL=SPHelper.js.map