mui-spfx-controls
Version:
SPFx component library built with MUI
306 lines • 15.8 kB
JavaScript
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 __asyncValues = (this && this.__asyncValues) || function (o) {
if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
var m = o[Symbol.asyncIterator], i;
return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
};
import { Logger } from '@pnp/logging';
import { FieldTypes } from '@pnp/sp/fields';
import { PermissionKind } from '@pnp/sp/security';
import { getSp } from '../config/pnp.config';
/**
* Service class for interacting with SharePoint lists.
*/
var ListService = /** @class */ (function () {
/**
* Initializes the ListService instance.
* @param {WebPartContext} context - The SharePoint WebPart context.
* @param {string} listId - The ID of the SharePoint list.
*/
function ListService(context, listId) {
this.sp = getSp(context);
this.list = this.sp.web.lists.getById(listId);
}
/**
* Checks if a field is visible and not hidden.
* @param {IFieldInfo} field - The field information.
* @returns {boolean} True if the field is not hidden, otherwise false.
*/
ListService.prototype.checkCustomFieldType = function (field) {
return !field.Hidden;
};
/**
* Retrieves the total item count of the list.
* @returns {Promise<number>} The total number of items in the list.
*/
ListService.prototype.getListSize = function () {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
return [2 /*return*/, this.list
.select('ItemCount')()
.then(function (response) { return response.ItemCount; })];
});
});
};
/**
* Fetches all lists available in the SharePoint site.
* @returns {Promise<IListInfo[]>} A list of SharePoint lists.
*/
ListService.prototype.getLists = function () {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
return [2 /*return*/, this.sp.web.lists()];
});
});
};
/**
* Retrieves fields from the specified list, optionally filtering by internal names.
* @param {string[]} [fieldInternalNames] - Optional array of field internal names to filter.
* @returns {Promise<IFieldInfo[]>} A list of field information objects.
*/
ListService.prototype.getListFields = function (fieldInternalNames) {
return __awaiter(this, void 0, void 0, function () {
var _this = this;
return __generator(this, function (_a) {
return [2 /*return*/, this.list
.fields()
.then(function (response) {
return response.filter(function (value) {
return fieldInternalNames
? _this.checkCustomFieldType(value) &&
fieldInternalNames.indexOf(value.InternalName) !== -1
: _this.checkCustomFieldType(value);
});
})];
});
});
};
/**
* Retrieves list items with specified fields, filters, and sorting options.
* @param {IFieldInfo[]} fields - The fields to include.
* @param {string} [filter] - Optional OData filter query.
* @param {string} [orderBy] - Optional sorting field.
* @param {number} [top] - Optional limit on number of records.
* @returns {Promise<any[]>} The list items.
*/
ListService.prototype.getListItems = function (fields, filter, orderBy, top) {
var _a, e_1, _b, _c;
return __awaiter(this, void 0, void 0, function () {
var selectFields, expandFields, totalItems, totalCount, _d, _e, _f, _g, _h, _j, items, e_1_1;
var _k, _l, _m, _o;
return __generator(this, function (_p) {
switch (_p.label) {
case 0:
selectFields = ['Id'];
expandFields = [];
totalItems = [];
fields.forEach(function (value) {
if (value.FieldTypeKind === FieldTypes.User) {
selectFields.push("".concat(value.InternalName, "/Id"), "".concat(value.InternalName, "/Title"), "".concat(value.InternalName, "/EMail"));
expandFields.push(value.InternalName);
}
else {
selectFields.push(value.InternalName);
}
});
return [4 /*yield*/, this.getListSize()];
case 1:
totalCount = _p.sent();
if (!top) return [3 /*break*/, 3];
_e = (_d = totalItems.push).apply;
_f = [totalItems];
return [4 /*yield*/, (_k = (_l = this.list.items)
.select.apply(_l, selectFields))
.expand.apply(_k, expandFields).filter(filter !== null && filter !== void 0 ? filter : '')
.orderBy(orderBy !== null && orderBy !== void 0 ? orderBy : '', false)
.top(top)()];
case 2:
_e.apply(_d, _f.concat([(_p.sent())]));
return [3 /*break*/, 14];
case 3:
_p.trys.push([3, 8, 9, 14]);
_g = true, _h = __asyncValues((_m = (_o = this.list.items)
.select.apply(_o, selectFields))
.expand.apply(_m, expandFields).filter(filter !== null && filter !== void 0 ? filter : '')
.orderBy(orderBy !== null && orderBy !== void 0 ? orderBy : '', false));
_p.label = 4;
case 4: return [4 /*yield*/, _h.next()];
case 5:
if (!(_j = _p.sent(), _a = _j.done, !_a)) return [3 /*break*/, 7];
_c = _j.value;
_g = false;
items = _c;
if (totalItems.length >= totalCount)
return [3 /*break*/, 7];
totalItems.push.apply(totalItems, items);
_p.label = 6;
case 6:
_g = true;
return [3 /*break*/, 4];
case 7: return [3 /*break*/, 14];
case 8:
e_1_1 = _p.sent();
e_1 = { error: e_1_1 };
return [3 /*break*/, 14];
case 9:
_p.trys.push([9, , 12, 13]);
if (!(!_g && !_a && (_b = _h.return))) return [3 /*break*/, 11];
return [4 /*yield*/, _b.call(_h)];
case 10:
_p.sent();
_p.label = 11;
case 11: return [3 /*break*/, 13];
case 12:
if (e_1) throw e_1.error;
return [7 /*endfinally*/];
case 13: return [7 /*endfinally*/];
case 14: return [2 /*return*/, totalItems];
}
});
});
};
/**
* Creates a new list item with specified values.
* @param {Record<string, any>} value - The values for the new item.
* @returns {Promise<Record<string, any>>} The created list item.
* @throws {Error} If the user lacks AddListItems permission.
*/
ListService.prototype.createListItem = function (value) {
return __awaiter(this, void 0, void 0, function () {
var userPermissions;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, this.list.getCurrentUserEffectivePermissions()];
case 1:
userPermissions = _a.sent();
if (!this.list.hasPermissions(userPermissions, PermissionKind.AddListItems)) {
throw new Error('Permission Error');
}
return [4 /*yield*/, this.list.items.add(value)];
case 2: return [2 /*return*/, _a.sent()];
}
});
});
};
/**
* Updates an existing list item by ID.
* @param {number} id - The ID of the list item.
* @param {Record<string, any>} newRow - The updated values.
* @returns {Promise<void>} Resolves when the update is successful.
* @throws {Error} If the user lacks EditListItems permission.
*/
ListService.prototype.updateListItem = function (id, newRow) {
return __awaiter(this, void 0, void 0, function () {
var userPermissions, excludedFields, resolveUserId, processedRow, _i, _a, key, value, userId;
var _this = this;
return __generator(this, function (_b) {
switch (_b.label) {
case 0: return [4 /*yield*/, this.list.getCurrentUserEffectivePermissions()];
case 1:
userPermissions = _b.sent();
if (!this.list.hasPermissions(userPermissions, PermissionKind.EditListItems)) {
throw new Error('Permission Error');
}
excludedFields = new Set([
'ID',
'Created',
'Modified',
'Author',
'Editor',
'GUID',
'Version',
'Attachments',
'odata.editLink',
'odata.id',
'odata.type',
'odata.metadata',
'odata.etag',
]);
resolveUserId = function (email) { return __awaiter(_this, void 0, void 0, function () {
var user, error_1;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
_a.trys.push([0, 2, , 3]);
return [4 /*yield*/, this.sp.web.siteUsers.getByEmail(email)()];
case 1:
user = _a.sent();
return [2 /*return*/, user.Id];
case 2:
error_1 = _a.sent();
Logger.error(error_1);
return [2 /*return*/, null];
case 3: return [2 /*return*/];
}
});
}); };
processedRow = {};
_i = 0, _a = Object.keys(newRow);
_b.label = 2;
case 2:
if (!(_i < _a.length)) return [3 /*break*/, 6];
key = _a[_i];
value = newRow[key];
if (!(!excludedFields.has(key) && key.indexOf('@odata.') !== -1)) return [3 /*break*/, 5];
if (!(value && typeof value === 'object' && 'EMail' in value)) return [3 /*break*/, 4];
return [4 /*yield*/, resolveUserId(value.EMail)];
case 3:
userId = _b.sent();
if (userId)
processedRow[key + 'Id'] = userId;
return [3 /*break*/, 5];
case 4:
processedRow[key] = value;
_b.label = 5;
case 5:
_i++;
return [3 /*break*/, 2];
case 6: return [4 /*yield*/, this.list.items.getById(id).update(processedRow)];
case 7:
_b.sent();
return [2 /*return*/];
}
});
});
};
return ListService;
}());
export { ListService };
//# sourceMappingURL=ListService.js.map