@cap-js/change-tracking 1.1.4 → 2.0.0-beta.2

package/lib/entity-helper.js

@@ -1,217 +0,0 @@
-const cds = require('@sap/cds');
-const LOG = cds.log('change-log');
-
-const getNameFromPathVal = function (pathVal) {
-	return /^(.+?)\(/.exec(pathVal)?.[1] || '';
-};
-
-const getUUIDFromPathVal = function (pathVal) {
-	const regRes = /\((.+?)\)/.exec(pathVal);
-	return regRes ? regRes[1] : '';
-};
-
-const getEntityByContextPath = function (aPath, hasComp = false) {
-	if (hasComp) return cds.model.definitions[aPath[aPath.length - 1]];
-	let entity = cds.model.definitions[aPath[0]];
-	for (let each of aPath.slice(1)) {
-		entity = entity.elements[each]?._target;
-	}
-	return entity;
-};
-
-const getObjIdElementNamesInArray = function (elements) {
-	if (Array.isArray(elements))
-		return elements.map((e) => {
-			const splitted = (e['='] || e).split('.');
-			splitted.shift();
-			return splitted.join('.');
-		});
-	else return [];
-};
-
-const getCurObjFromDbQuery = async function (entityName, whereXpr) {
-	if (!Object.keys(whereXpr)) return {};
-	// REVISIT: This always reads all elements -> should read required ones only!
-	const obj = await SELECT.one.from(entityName).where(whereXpr);
-	return obj || {};
-};
-
-const getCurObjFromReqData = function (reqData, nodePathVal, pathVal) {
-	const pathVals = splitPath(pathVal);
-	const rootNodePathVal = pathVals[0];
-	let curReqObj = reqData || {};
-
-	if (nodePathVal === rootNodePathVal) return curReqObj;
-	else pathVals.shift();
-
-	let parentSrvObjName = getNameFromPathVal(rootNodePathVal);
-
-	for (const subNodePathVal of pathVals) {
-		const srvObjName = getNameFromPathVal(subNodePathVal);
-		const curSrvObjUUID = getUUIDFromPathVal(subNodePathVal);
-		const associationName = _getAssociationName(parentSrvObjName, srvObjName);
-		if (curReqObj) {
-			let associationData = curReqObj[associationName];
-			if (!Array.isArray(associationData)) associationData = [associationData];
-			curReqObj = associationData?.find((x) => x?.ID === curSrvObjUUID) || {};
-		}
-		if (subNodePathVal === nodePathVal) return curReqObj || {};
-		parentSrvObjName = srvObjName;
-	}
-
-	return curReqObj;
-
-	function _getAssociationName(entity, target) {
-		const source = cds.model.definitions[entity];
-		const assocs = source.associations;
-		for (const each in assocs) {
-			if (assocs[each].target === target) return each;
-		}
-	}
-};
-
-async function getObjectId(reqData, entityName, fields, curObj) {
-	let all = [],
-		{ curObjFromReqData: req_data = {}, curObjFromDbQuery: db_data = {} } = curObj;
-	let entity = cds.model.definitions[entityName];
-	if (!fields?.length) fields = entity['@changelog']?.map?.((k) => k['='] || k) || [];
-	for (let field of fields) {
-		let path = field.split('.');
-		if (path.length > 1) {
-			let current = entity,
-				_db_data = db_data;
-			while (path.length > 1) {
-				let assoc = current.elements[path[0]];
-				if (!assoc?.isAssociation) break;
-				let foreignKey = assoc.keys?.[0]?.$generatedFieldName;
-				let IDval = req_data[foreignKey] && current.name === entityName ? req_data[foreignKey] : _db_data[foreignKey];
-				if (!IDval) {
-					_db_data = {};
-				} else
-					try {
-						// REVISIT: This always reads all elements -> should read required ones only!
-						let ID = assoc.keys?.[0]?.ref[0] || 'ID';
-						const isComposition = hasComposition(assoc._target, current);
-						// Peer association and composition are distinguished by the value of isComposition.
-						if (isComposition) {
-							// This function can recursively retrieve the desired information from reqData without having to read it from db.
-							_db_data = _getCompositionObjFromReq(reqData, IDval);
-							// When multiple layers of child nodes are deleted at the same time, the deep layer of child nodes will lose the information of the upper nodes, so data needs to be extracted from the db.
-							const entityKeys = reqData ? Object.keys(reqData).filter((item) => !Object.keys(assoc._target.keys).some((ele) => item === ele)) : [];
-							if (!_db_data || JSON.stringify(_db_data) === '{}' || entityKeys.length === 0) {
-								_db_data = IDval ? await getCurObjFromDbQuery(assoc._target, { [ID]: IDval }) : {};
-							}
-						} else {
-							_db_data = IDval ? await getCurObjFromDbQuery(assoc._target, { [ID]: IDval }) : {};
-						}
-					} catch (e) {
-						LOG.error('Failed to generate object Id for an association entity.', e);
-						throw new Error('Failed to generate object Id for an association entity.', e);
-					}
-				current = assoc._target;
-				path.shift();
-			}
-			field = path.join('_');
-			let obj = current.name === entityName && req_data[field] ? req_data[field] : _db_data[field];
-			if (obj) all.push(obj);
-		} else {
-			let e = entity.elements[field];
-			if (e?.isAssociation) field = e.keys?.[0]?.$generatedFieldName;
-			let obj = req_data[field] || db_data[field];
-			if (obj) all.push(obj);
-		}
-	}
-	return all.join(', ');
-}
-
-const getDBEntity = (entity) => {
-	if (typeof entity === 'string') entity = cds.model.definitions[entity];
-	let proto = Reflect.getPrototypeOf(entity);
-	if (proto instanceof cds.entity) return proto;
-};
-
-const getValueEntityType = function (entityName, fields) {
-	const types = [],
-		entity = cds.model.definitions[entityName];
-	for (let field of fields) {
-		let current = entity,
-			path = field.split('.');
-		if (path.length > 1) {
-			for (;;) {
-				let target = current.elements[path[0]]?._target;
-				if (target) current = target;
-				else break;
-				path.shift();
-			}
-			field = path.join('_');
-		}
-		let e = current.elements[field];
-		if (e) types.push(e.type);
-	}
-	return types.join(', ');
-};
-
-const hasComposition = function (parentEntity, subEntity) {
-	if (!parentEntity.compositions) {
-		return false;
-	}
-
-	const compositions = Object.values(parentEntity.compositions);
-
-	for (const composition of compositions) {
-		if (composition.target === subEntity.name) {
-			return true;
-		}
-	}
-
-	return false;
-};
-
-const _getCompositionObjFromReq = function (obj, targetID) {
-	if (obj?.ID === targetID) {
-		return obj;
-	}
-
-	for (const key in obj) {
-		if (typeof obj[key] === 'object' && obj[key] !== null) {
-			const result = _getCompositionObjFromReq(obj[key], targetID);
-			if (result) {
-				return result;
-			}
-		}
-	}
-
-	return null;
-};
-
-function splitPath(path) {
-	let result = [];
-	let buf = '';
-	let paren = 0;
-	for (let i = 0; i < path.length; i++) {
-		const c = path[i];
-		if (c === '(') paren++;
-		if (c === ')') paren--;
-		if (c === '/' && paren === 0) {
-			result.push(buf);
-			buf = '';
-		} else {
-			buf += c;
-		}
-	}
-	if (buf) result.push(buf);
-	return result;
-}
-
-module.exports = {
-	getCurObjFromReqData,
-	getCurObjFromDbQuery,
-	getObjectId,
-	getNameFromPathVal,
-	getUUIDFromPathVal,
-	getDBEntity,
-	getEntityByContextPath,
-	getObjIdElementNamesInArray,
-	getValueEntityType,
-	splitPath
-};

package/lib/format-options.js

@@ -1,66 +0,0 @@
-const formatOptions = {
-	'cds.Date': {
-		de: { day: '2-digit', month: '2-digit', year: 'numeric' },
-		en: { day: 'numeric', month: 'short', year: 'numeric' },
-		es: { day: '2-digit', month: 'short', year: 'numeric' },
-		fi: { year: 'numeric', month: '2-digit', day: '2-digit' },
-		fr: { day: '2-digit', month: 'short', year: 'numeric' },
-		it: { day: '2-digit', month: 'short', year: 'numeric' },
-		ja: { year: 'numeric', month: '2-digit', day: '2-digit' },
-		pl: { day: '2-digit', month: 'short', year: 'numeric' },
-		pt: { day: '2-digit', month: 'short', year: 'numeric' },
-		ru: { day: '2-digit', month: 'short', year: 'numeric' },
-		'zh-CN': { year: 'numeric', month: 'long', day: 'numeric' }
-	},
-	'cds.DateTime': {
-		de: { day: '2-digit', month: '2-digit', year: 'numeric', hour: '2-digit', minute: '2-digit', second: '2-digit' },
-		el: { day: 'numeric', month: 'short', year: 'numeric', hour: 'numeric', minute: '2-digit', second: '2-digit' },
-		en: { day: 'numeric', month: 'short', year: 'numeric', hour: '2-digit', minute: '2-digit', second: '2-digit' },
-		es: { day: '2-digit', month: 'short', year: 'numeric', hour: '2-digit', minute: '2-digit', second: '2-digit' },
-		es_MX: { day: '2-digit', month: 'short', year: 'numeric', hour: 'numeric', minute: '2-digit', second: '2-digit', hour12: true },
-		fi: { year: 'numeric', month: '2-digit', day: '2-digit', hour: 'numeric', minute: '2-digit', second: '2-digit' },
-		fr: { day: '2-digit', month: 'short', year: 'numeric', hour: '2-digit', minute: '2-digit', second: '2-digit' },
-		it: { day: '2-digit', month: 'short', year: 'numeric', hour: '2-digit', minute: '2-digit', second: '2-digit' },
-		ja: { year: 'numeric', month: '2-digit', day: '2-digit', hour: '2-digit', minute: '2-digit', second: '2-digit' },
-		pl: { day: '2-digit', month: 'short', year: 'numeric', hour: '2-digit', minute: '2-digit', second: '2-digit' },
-		pt: { day: '2-digit', month: 'short', year: 'numeric', hour: '2-digit', minute: '2-digit', second: '2-digit' },
-		ru: { day: '2-digit', month: 'short', year: 'numeric', hour: '2-digit', minute: '2-digit', second: '2-digit' },
-		'zh-CN': { year: 'numeric', month: 'long', day: 'numeric', hour: '2-digit', minute: '2-digit', second: '2-digit' }
-	},
-	'cds.Timestamp': {
-		cs: { day: 'numeric', month: 'short', year: 'numeric', hour: 'numeric', minute: '2-digit', second: '2-digit' },
-		de: { day: '2-digit', month: '2-digit', year: 'numeric', hour: '2-digit', minute: '2-digit', second: '2-digit' },
-		el: { day: 'numeric', month: 'short', year: 'numeric', hour: 'numeric', minute: '2-digit', second: '2-digit' },
-		en: { day: 'numeric', month: 'short', year: 'numeric', hour: '2-digit', minute: '2-digit', second: '2-digit' },
-		es: { day: '2-digit', month: 'short', year: 'numeric', hour: '2-digit', minute: '2-digit', second: '2-digit' },
-		es_MX: { day: '2-digit', month: 'short', year: 'numeric', hour: 'numeric', minute: '2-digit', second: '2-digit', hour12: true },
-		fi: { year: 'numeric', month: '2-digit', day: '2-digit', hour: 'numeric', minute: '2-digit', second: '2-digit' },
-		fr: { day: '2-digit', month: 'short', year: 'numeric', hour: '2-digit', minute: '2-digit', second: '2-digit' },
-		it: { day: '2-digit', month: 'short', year: 'numeric', hour: '2-digit', minute: '2-digit', second: '2-digit' },
-		ja: { year: 'numeric', month: '2-digit', day: '2-digit', hour: '2-digit', minute: '2-digit', second: '2-digit' },
-		pl: { day: '2-digit', month: 'short', year: 'numeric', hour: '2-digit', minute: '2-digit', second: '2-digit' },
-		pt: { day: '2-digit', month: 'short', year: 'numeric', hour: '2-digit', minute: '2-digit', second: '2-digit' },
-		ru: { day: '2-digit', month: 'short', year: 'numeric', hour: '2-digit', minute: '2-digit', second: '2-digit' },
-		'zh-CN': { year: 'numeric', month: 'long', day: 'numeric', hour: '2-digit', minute: '2-digit', second: '2-digit' }
-	},
-	'cds.Time': {
-		cs: { hour: 'numeric', minute: '2-digit', second: '2-digit' },
-		fi: { hour: 'numeric', minute: '2-digit', second: '2-digit' },
-		de: { hour: '2-digit', minute: '2-digit', second: '2-digit' },
-		el: { hour: 'numeric', minute: '2-digit', second: '2-digit' },
-		en: { hour: '2-digit', minute: '2-digit', second: '2-digit' },
-		es: { hour: '2-digit', minute: '2-digit', second: '2-digit' },
-		es_MX: { hour: 'numeric', minute: '2-digit', second: '2-digit', hour12: true },
-		fr: { hour: '2-digit', minute: '2-digit', second: '2-digit' },
-		it: { hour: '2-digit', minute: '2-digit', second: '2-digit' },
-		ja: { hour: '2-digit', minute: '2-digit', second: '2-digit' },
-		pl: { hour: '2-digit', minute: '2-digit', second: '2-digit' },
-		pt: { hour: '2-digit', minute: '2-digit', second: '2-digit' },
-		ru: { hour: '2-digit', minute: '2-digit', second: '2-digit' },
-		'zh-CN': { hour: '2-digit', minute: '2-digit', second: '2-digit' }
-	}
-};
-
-module.exports = {
-	formatOptions
-};

package/lib/template-processor.js

@@ -1,115 +0,0 @@
-//  Enhanced class based on cds v5.5.5 @sap/cds/libx/_runtime/common/utils/templateProcessor
-
-const DELIMITER = require('@sap/cds/libx/_runtime/common/utils/templateDelimiter');
-
-const _formatRowContext = (tKey, keyNames, row) => {
-	const keyValuePairs = keyNames.map((key) => `${key}=${row[key]}`);
-	const keyValuePairsSerialized = keyValuePairs.join(',');
-	return `${tKey}(${keyValuePairsSerialized})`;
-};
-
-const _processElement = (processFn, row, key, elements, isRoot, pathSegments, picked = {}) => {
-	const element = elements[key];
-	const { plain } = picked;
-
-	// do not change-track personal data
-	const isPersonalData = element && Object.keys(element).some((key) => key.startsWith('@PersonalData'));
-	if (plain && !isPersonalData) {
-		/**
-		 * @type import('../../types/api').templateProcessorProcessFnArgs
-		 */
-		const elementInfo = { row, key, element, plain, isRoot, pathSegments };
-		processFn(elementInfo);
-	}
-};
-
-function retrieveFirstKey(target) {
-	const keys = [];
-	for (const key of Object.keys(target.keys)) {
-		if (target.keys[key].type !== 'cds.Association' && key !== 'IsActiveEntity') {
-			keys.push(key);
-		}
-	}
-
-	//Revisit: For test 3.5
-	return keys.filter((k) => !k.startsWith('up_'))[0];
-}
-
-const _processRow = (processFn, row, template, tKey, tValue, isRoot, pathOptions) => {
-	const { template: subTemplate, picked } = tValue;
-	const key = tKey.split(DELIMITER).pop();
-	const { segments: pathSegments } = pathOptions;
-
-	if (!subTemplate && pathSegments) {
-		pathSegments.push(key);
-	}
-
-	_processElement(processFn, row, key, template.target.elements, isRoot, pathSegments, picked);
-
-	// process deep
-	if (subTemplate) {
-		let subRows = row && row[key];
-
-		subRows = Array.isArray(subRows) ? subRows : [subRows];
-
-		// Build entity path
-		subRows.forEach((subRow) => {
-			if (subRow && row && row._path) {
-				/** Enhancement by SME: Support CAP Change Histroy
-				 *  Construct path from root entity to current entity.
-				 */
-				const serviceNodeName = template.target.elements[key].target;
-				const serviceNode = template.target.elements[key]._target;
-				subRow._path = `${row._path}/${serviceNodeName}(${subRow[retrieveFirstKey(serviceNode)]})`;
-			}
-		});
-
-		_processComplex(processFn, subRows, subTemplate, key, pathOptions);
-	}
-};
-
-const _processComplex = (processFn, rows, template, tKey, pathOptions) => {
-	if (rows.length === 0) {
-		return;
-	}
-
-	const segments = pathOptions.segments;
-	let keyNames;
-
-	for (const row of rows) {
-		if (row == null) {
-			continue;
-		}
-
-		const args = { processFn, row, template, isRoot: false, pathOptions };
-
-		if (pathOptions.includeKeyValues) {
-			keyNames = keyNames || (template.target.keys && Object.keys(template.target.keys)) || [];
-			pathOptions.rowKeysGenerator(keyNames, row, template);
-			const pathSegment = _formatRowContext(tKey, keyNames, { ...row, ...pathOptions.extraKeys });
-			args.pathOptions.segments = segments ? [...segments, pathSegment] : [pathSegment];
-		}
-
-		templateProcessor(args);
-	}
-};
-
-/**
- * @param {import("../../types/api").TemplateProcessor} args
- */
-const templateProcessor = ({ processFn, row, template, isRoot = true, pathOptions = {} }) => {
-	const segments = pathOptions.segments && [...pathOptions.segments];
-
-	for (const [tKey, tValue] of template.elements) {
-		// When a managed association is marked with @changelog, both foreign key and assoc are in the template. Skip the association as only the foreign key has a change.
-		if (template.target.elements[tKey]?.type === 'cds.Association') {
-			continue;
-		}
-		if (segments) {
-			pathOptions.segments = [...segments];
-		}
-		_processRow(processFn, row, template, tKey, tValue, isRoot, pathOptions);
-	}
-};
-
-module.exports = { templateProcessor, retrieveFirstKey };