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

package/_i18n/i18n_ms.properties

@@ -40,11 +40,11 @@ ChangeLog.serviceEntity=Entiti Perkhidmatan
 ## Change Log Modifications##
 ########################################
 #XFLD: Field label
-ChangeLog.modification.create=Cipta
+Changes.modification.create=Cipta
 #XFLD: Field label
-ChangeLog.modification.update=Kemas kini
+Changes.modification.update=Kemas kini
 #XFLD: Field label
-ChangeLog.modification.delete=Padam
+Changes.modification.delete=Padam
 #XFLD: Field label
 ChangeLog.createdAt=Diubah pada
 #XFLD: Field label

package/_i18n/i18n_nl.properties

@@ -40,11 +40,11 @@ ChangeLog.serviceEntity=Service-entiteit
 ## Change Log Modifications##
 ########################################
 #XFLD: Field label
-ChangeLog.modification.create=Cre\u00EBren
+Changes.modification.create=Cre\u00EBren
 #XFLD: Field label
-ChangeLog.modification.update=Actualiseren
+Changes.modification.update=Actualiseren
 #XFLD: Field label
-ChangeLog.modification.delete=Verwijderen
+Changes.modification.delete=Verwijderen
 #XFLD: Field label
 ChangeLog.createdAt=Gewijzigd om
 #XFLD: Field label

package/_i18n/i18n_no.properties

@@ -40,11 +40,11 @@ ChangeLog.serviceEntity=Tjenesteentitet
 ## Change Log Modifications##
 ########################################
 #XFLD: Field label
-ChangeLog.modification.create=Opprett
+Changes.modification.create=Opprett
 #XFLD: Field label
-ChangeLog.modification.update=Oppdater
+Changes.modification.update=Oppdater
 #XFLD: Field label
-ChangeLog.modification.delete=Slett
+Changes.modification.delete=Slett
 #XFLD: Field label
 ChangeLog.createdAt=Endret kl.
 #XFLD: Field label

package/_i18n/i18n_pl.properties

@@ -40,11 +40,11 @@ ChangeLog.serviceEntity=Encja us\u0142ugi
 ## Change Log Modifications##
 ########################################
 #XFLD: Field label
-ChangeLog.modification.create=Utw\u00F3rz
+Changes.modification.create=Utw\u00F3rz
 #XFLD: Field label
-ChangeLog.modification.update=Aktualizuj
+Changes.modification.update=Aktualizuj
 #XFLD: Field label
-ChangeLog.modification.delete=Usu\u0144
+Changes.modification.delete=Usu\u0144
 #XFLD: Field label
 ChangeLog.createdAt=Zmieniono o
 #XFLD: Field label

package/_i18n/i18n_pt.properties

@@ -40,11 +40,11 @@ ChangeLog.serviceEntity=Entidade de servi\u00E7o
 ## Change Log Modifications##
 ########################################
 #XFLD: Field label
-ChangeLog.modification.create=Criar
+Changes.modification.create=Criar
 #XFLD: Field label
-ChangeLog.modification.update=Atualizar
+Changes.modification.update=Atualizar
 #XFLD: Field label
-ChangeLog.modification.delete=Excluir
+Changes.modification.delete=Excluir
 #XFLD: Field label
 ChangeLog.createdAt=Modificado em
 #XFLD: Field label

package/_i18n/i18n_ro.properties

@@ -40,11 +40,11 @@ ChangeLog.serviceEntity=Entitate serviciu
 ## Change Log Modifications##
 ########################################
 #XFLD: Field label
-ChangeLog.modification.create=Creare
+Changes.modification.create=Creare
 #XFLD: Field label
-ChangeLog.modification.update=Actualizare
+Changes.modification.update=Actualizare
 #XFLD: Field label
-ChangeLog.modification.delete=\u0218tergere
+Changes.modification.delete=\u0218tergere
 #XFLD: Field label
 ChangeLog.createdAt=Modificat la
 #XFLD: Field label

package/_i18n/i18n_ru.properties

@@ -40,11 +40,11 @@ ChangeLog.serviceEntity=\u0421\u0443\u0449\u043D\u043E\u0441\u0442\u044C \u0441\
 ## Change Log Modifications##
 ########################################
 #XFLD: Field label
-ChangeLog.modification.create=\u0421\u043E\u0437\u0434\u0430\u0442\u044C
+Changes.modification.create=\u0421\u043E\u0437\u0434\u0430\u0442\u044C
 #XFLD: Field label
-ChangeLog.modification.update=\u041E\u0431\u043D\u043E\u0432\u0438\u0442\u044C
+Changes.modification.update=\u041E\u0431\u043D\u043E\u0432\u0438\u0442\u044C
 #XFLD: Field label
-ChangeLog.modification.delete=\u0423\u0434\u0430\u043B\u0438\u0442\u044C
+Changes.modification.delete=\u0423\u0434\u0430\u043B\u0438\u0442\u044C
 #XFLD: Field label
 ChangeLog.createdAt=\u0412\u0440\u0435\u043C\u044F \u0438\u0437\u043C\u0435\u043D\u0435\u043D\u0438\u044F
 #XFLD: Field label

package/_i18n/i18n_sh.properties

@@ -40,11 +40,11 @@ ChangeLog.serviceEntity=Entitet usluga
 ## Change Log Modifications##
 ########################################
 #XFLD: Field label
-ChangeLog.modification.create=Kreiraj
+Changes.modification.create=Kreiraj
 #XFLD: Field label
-ChangeLog.modification.update=A\u017Euriraj
+Changes.modification.update=A\u017Euriraj
 #XFLD: Field label
-ChangeLog.modification.delete=Izbri\u0161i
+Changes.modification.delete=Izbri\u0161i
 #XFLD: Field label
 ChangeLog.createdAt=Promenjeno
 #XFLD: Field label

package/_i18n/i18n_sk.properties

@@ -40,11 +40,11 @@ ChangeLog.serviceEntity=Servisn\u00E1 entita
 ## Change Log Modifications##
 ########################################
 #XFLD: Field label
-ChangeLog.modification.create=Vytvori\u0165
+Changes.modification.create=Vytvori\u0165
 #XFLD: Field label
-ChangeLog.modification.update=Aktualiz\u00E1cia
+Changes.modification.update=Aktualiz\u00E1cia
 #XFLD: Field label
-ChangeLog.modification.delete=Odstr\u00E1ni\u0165
+Changes.modification.delete=Odstr\u00E1ni\u0165
 #XFLD: Field label
 ChangeLog.createdAt=Zmenen\u00E9 o
 #XFLD: Field label

package/_i18n/i18n_sl.properties

@@ -40,11 +40,11 @@ ChangeLog.serviceEntity=Entiteta storitve
 ## Change Log Modifications##
 ########################################
 #XFLD: Field label
-ChangeLog.modification.create=Ustvari
+Changes.modification.create=Ustvari
 #XFLD: Field label
-ChangeLog.modification.update=Posodobi
+Changes.modification.update=Posodobi
 #XFLD: Field label
-ChangeLog.modification.delete=Izbri\u0161i
+Changes.modification.delete=Izbri\u0161i
 #XFLD: Field label
 ChangeLog.createdAt=Spremenjeno ob
 #XFLD: Field label

package/_i18n/i18n_sv.properties

@@ -40,11 +40,11 @@ ChangeLog.serviceEntity=Tj\u00E4nstentitet
 ## Change Log Modifications##
 ########################################
 #XFLD: Field label
-ChangeLog.modification.create=Skapa
+Changes.modification.create=Skapa
 #XFLD: Field label
-ChangeLog.modification.update=Uppdatera
+Changes.modification.update=Uppdatera
 #XFLD: Field label
-ChangeLog.modification.delete=Radera
+Changes.modification.delete=Radera
 #XFLD: Field label
 ChangeLog.createdAt=\u00C4ndring kl.
 #XFLD: Field label

package/_i18n/i18n_th.properties

@@ -40,11 +40,11 @@ ChangeLog.serviceEntity=\u0E40\u0E2D\u0E19\u0E17\u0E34\u0E15\u0E35\u0E49\u0E01\u
 ## Change Log Modifications##
 ########################################
 #XFLD: Field label
-ChangeLog.modification.create=\u0E2A\u0E23\u0E49\u0E32\u0E07
+Changes.modification.create=\u0E2A\u0E23\u0E49\u0E32\u0E07
 #XFLD: Field label
-ChangeLog.modification.update=\u0E2D\u0E31\u0E1E\u0E40\u0E14\u0E17
+Changes.modification.update=\u0E2D\u0E31\u0E1E\u0E40\u0E14\u0E17
 #XFLD: Field label
-ChangeLog.modification.delete=\u0E25\u0E1A
+Changes.modification.delete=\u0E25\u0E1A
 #XFLD: Field label
 ChangeLog.createdAt=\u0E40\u0E1B\u0E25\u0E35\u0E48\u0E22\u0E19\u0E41\u0E1B\u0E25\u0E07\u0E40\u0E21\u0E37\u0E48\u0E2D
 #XFLD: Field label

package/_i18n/i18n_tr.properties

@@ -40,11 +40,11 @@ ChangeLog.serviceEntity=Servis birimi
 ## Change Log Modifications##
 ########################################
 #XFLD: Field label
-ChangeLog.modification.create=Olu\u015Ftur
+Changes.modification.create=Olu\u015Ftur
 #XFLD: Field label
-ChangeLog.modification.update=G\u00FCncelle
+Changes.modification.update=G\u00FCncelle
 #XFLD: Field label
-ChangeLog.modification.delete=Sil
+Changes.modification.delete=Sil
 #XFLD: Field label
 ChangeLog.createdAt=De\u011Fi\u015Fiklik saati
 #XFLD: Field label

package/_i18n/i18n_uk.properties

@@ -40,11 +40,11 @@ ChangeLog.serviceEntity=\u0421\u0443\u0442\u043D\u0456\u0441\u0442\u044C \u0441\
 ## Change Log Modifications##
 ########################################
 #XFLD: Field label
-ChangeLog.modification.create=\u0421\u0442\u0432\u043E\u0440\u0438\u0442\u0438
+Changes.modification.create=\u0421\u0442\u0432\u043E\u0440\u0438\u0442\u0438
 #XFLD: Field label
-ChangeLog.modification.update=\u041E\u043D\u043E\u0432\u0438\u0442\u0438
+Changes.modification.update=\u041E\u043D\u043E\u0432\u0438\u0442\u0438
 #XFLD: Field label
-ChangeLog.modification.delete=\u0412\u0438\u0434\u0430\u043B\u0438\u0442\u0438
+Changes.modification.delete=\u0412\u0438\u0434\u0430\u043B\u0438\u0442\u0438
 #XFLD: Field label
 ChangeLog.createdAt=\u0427\u0430\u0441 \u0437\u043C\u0456\u043D\u0438
 #XFLD: Field label

package/_i18n/i18n_vi.properties

@@ -40,11 +40,11 @@ ChangeLog.serviceEntity=Th\u1EF1c th\u1EC3 d\u1ECBch v\u1EE5
 ## Change Log Modifications##
 ########################################
 #XFLD: Field label
-ChangeLog.modification.create=Ta\u0323o
+Changes.modification.create=Ta\u0323o
 #XFLD: Field label
-ChangeLog.modification.update=C\u00E2\u0323p nh\u00E2\u0323t
+Changes.modification.update=C\u00E2\u0323p nh\u00E2\u0323t
 #XFLD: Field label
-ChangeLog.modification.delete=Xo\u0301a
+Changes.modification.delete=Xo\u0301a
 #XFLD: Field label
 ChangeLog.createdAt=Thay \u0111\u00F4\u0309i lu\u0301c
 #XFLD: Field label

package/_i18n/i18n_zh_CN.properties

@@ -40,11 +40,11 @@ ChangeLog.serviceEntity=\u670D\u52A1\u5B9E\u4F53
 ## Change Log Modifications##
 ########################################
 #XFLD: Field label
-ChangeLog.modification.create=\u521B\u5EFA
+Changes.modification.create=\u521B\u5EFA
 #XFLD: Field label
-ChangeLog.modification.update=\u66F4\u65B0
+Changes.modification.update=\u66F4\u65B0
 #XFLD: Field label
-ChangeLog.modification.delete=\u5220\u9664
+Changes.modification.delete=\u5220\u9664
 #XFLD: Field label
 ChangeLog.createdAt=\u66F4\u6539\u65F6\u95F4
 #XFLD: Field label

package/_i18n/i18n_zh_TW.properties

@@ -40,11 +40,11 @@ ChangeLog.serviceEntity=\u670D\u52D9\u5BE6\u9AD4
 ## Change Log Modifications##
 ########################################
 #XFLD: Field label
-ChangeLog.modification.create=\u5EFA\u7ACB
+Changes.modification.create=\u5EFA\u7ACB
 #XFLD: Field label
-ChangeLog.modification.update=\u66F4\u65B0
+Changes.modification.update=\u66F4\u65B0
 #XFLD: Field label
-ChangeLog.modification.delete=\u522A\u9664
+Changes.modification.delete=\u522A\u9664
 #XFLD: Field label
 ChangeLog.createdAt=\u66F4\u6539\u6642\u9593
 #XFLD: Field label

package/cds-plugin.js

@@ -1,266 +1,17 @@
 const cds = require('@sap/cds');
-const DEBUG = cds.debug('changelog');
 
-const isRoot = 'change-tracking-isRootEntity';
-const hasParent = 'change-tracking-parentEntity';
-
-const isChangeTracked = (entity) => {
-	if (entity.query?.SET?.op === 'union') return false; // REVISIT: should that be an error or warning?
-	if (entity['@changelog']) return true;
-	if (Object.values(entity.elements).some((e) => e['@changelog'])) return true;
-	return false;
-};
-
-// Add the appropriate Side Effects attribute to the custom action
-const addSideEffects = (actions, flag, element) => {
-	if (!flag && (element === undefined || element === null)) {
-		return;
-	}
-
-	for (const se of Object.values(actions)) {
-		const target = flag ? 'TargetProperties' : 'TargetEntities';
-		const sideEffectAttr = se[`@Common.SideEffects.${target}`];
-		const property = flag ? 'changes' : { '=': `${element}.changes` };
-		if (sideEffectAttr?.length >= 0) {
-			sideEffectAttr.findIndex((item) => (item['='] ? item['='] : item) === (property['='] ? property['='] : property)) === -1 && sideEffectAttr.push(property);
-		} else {
-			se[`@Common.SideEffects.${target}`] = [property];
-		}
-	}
-};
-
-function setChangeTrackingIsRootEntity(entity, csn, val = true) {
-	if (csn.definitions?.[entity.name]) {
-		csn.definitions[entity.name][isRoot] = val;
-	}
-}
-
-function checkAndSetRootEntity(parentEntity, entity, csn) {
-	if (entity[isRoot] === false) {
-		return entity;
-	}
-	if (parentEntity) {
-		return compositionRoot(parentEntity, csn);
-	} else {
-		setChangeTrackingIsRootEntity(entity, csn);
-		return { ...csn.definitions?.[entity.name], name: entity.name };
-	}
-}
-
-function processEntities(m) {
-	for (let name in m.definitions) {
-		compositionRoot({ ...m.definitions[name], name }, m);
-	}
-}
-
-function compositionRoot(entity, csn) {
-	if (!entity || entity.kind !== 'entity') {
-		return;
-	}
-	const parentEntity = compositionParent(entity, csn);
-	return checkAndSetRootEntity(parentEntity, entity, csn);
-}
-
-function compositionParent(entity, csn) {
-	if (!entity || entity.kind !== 'entity') {
-		return;
-	}
-	const parentAssociation = compositionParentAssociation(entity, csn);
-	return parentAssociation ?? null;
-}
-
-function compositionParentAssociation(entity, csn) {
-	if (!entity || entity.kind !== 'entity') {
-		return;
-	}
-	const elements = entity.elements ?? {};
-
-	// Add the change-tracking-isRootEntity attribute of the child entity
-	processCompositionElements(entity, csn, elements);
-
-	const hasChildFlag = entity[isRoot] !== false;
-	const hasParentEntity = entity[hasParent];
-
-	if (hasChildFlag || !hasParentEntity) {
-		// Find parent association of the entity
-		const parentAssociation = findParentAssociation(entity, csn, elements);
-		if (parentAssociation) {
-			const parentAssociationTarget = elements[parentAssociation]?.target;
-			if (hasChildFlag) setChangeTrackingIsRootEntity(entity, csn, false);
-			return {
-				...csn.definitions?.[parentAssociationTarget],
-				name: parentAssociationTarget
-			};
-		} else return;
-	}
-	return { ...csn.definitions?.[entity.name], name: entity.name };
-}
-
-function processCompositionElements(entity, csn, elements) {
-	for (const name in elements) {
-		const element = elements[name];
-		const target = element?.target;
-		const definition = csn.definitions?.[target];
-		if (element.type !== 'cds.Composition' || target === entity.name || !definition || definition[isRoot] === false) {
-			continue;
-		}
-		setChangeTrackingIsRootEntity({ ...definition, name: target }, csn, false);
-	}
-}
-
-function findParentAssociation(entity, csn, elements) {
-	return Object.keys(elements).find((name) => {
-		const element = elements[name];
-		const target = element?.target;
-		if (element.type === 'cds.Association' && target !== entity.name) {
-			const parentDefinition = csn.definitions?.[target] ?? {};
-			const parentElements = parentDefinition?.elements ?? {};
-			return !!Object.keys(parentElements).find((parentEntityName) => {
-				const parentElement = parentElements?.[parentEntityName] ?? {};
-				if (parentElement.type === 'cds.Composition') {
-					const isCompositionEntity = parentElement.target === entity.name;
-					// add parent information in the current entity
-					if (isCompositionEntity) {
-						csn.definitions[entity.name][hasParent] = {
-							associationName: name,
-							entityName: target
-						};
-					}
-					return isCompositionEntity;
-				}
-			});
-		}
-	});
-}
-
-/**
- * Returns an expression for the key of the given entity, which we can use as the right-hand-side of an ON condition.
- */
-function entityKey4(entity) {
-	const xpr = [];
-	for (let k in entity.elements) {
-		const e = entity.elements[k];
-		if (!e.key) continue;
-		if (xpr.length) xpr.push('||');
-		if (e.type === 'cds.Association') xpr.push({ ref: [k, e.keys?.[0]?.ref?.[0]] });
-		else xpr.push({ ref: [k] });
-	}
-	return xpr;
-}
-
-// Unfold @changelog annotations in loaded model
-function enhanceModel(m) {
-	if (m.meta?.flavor !== 'inferred') {
-		// In MTX scenarios with extensibility the runtime model for deployed apps is not
-		// inferred but xtended and the logic requires inferred.
-		DEBUG?.(`Skipping model enhancement because model flavour is '${m.meta?.flavor}' and not 'inferred'`);
-		return;
-	}
-	const _enhanced = 'sap.changelog.enhanced';
-	if (m.meta?.[_enhanced]) return; // already enhanced
-
-	// Get definitions from Dummy entity in our models
-	const { 'sap.changelog.aspect': aspect } = m.definitions;
-	if (!aspect) return; // some other model
-	const {
-		'@UI.Facets': [facet],
-		elements: { changes }
-	} = aspect;
-	if (changes.on.length > 2) changes.on.pop(); // remove ID -> filled in below
-
-	processEntities(m); // REVISIT: why is that required ?!?
-
-	for (let name in m.definitions) {
-		const entity = m.definitions[name];
-		if (entity.kind === 'entity' && !entity['@cds.autoexposed'] && isChangeTracked(entity)) {
-			if (!entity['@changelog.disable_assoc']) {
-				// Add association to ChangeView...
-				const keys = entityKey4(entity);
-				if (!keys.length) continue; // If no key attribute is defined for the entity, the logic to add association to ChangeView should be skipped.
-				const assoc = new cds.builtin.classes.Association({ ...changes, on: [...changes.on, ...keys] });
-
-				// --------------------------------------------------------------------
-				// PARKED: Add auto-exposed projection on ChangeView to service if applicable
-				// const namespace = name.match(/^(.*)\.[^.]+$/)[1]
-				// const service = m.definitions[namespace]
-				// if (service) {
-				//   const projection = {from:{ref:[assoc.target]}}
-				//   m.definitions[assoc.target = namespace + '.' + Changes] = {
-				//     '@cds.autoexposed':true, kind:'entity', projection
-				//   }
-				//   DEBUG?.(`\n
-				//     extend service ${namespace} with {
-				//       entity ${Changes} as projection on ${projection.from.ref[0]};
-				//     }
-				//   `.replace(/ {10}/g,''))
-				// }
-				// --------------------------------------------------------------------
-
-				DEBUG?.(
-					`\n
-          extend ${name} with {
-            changes : Association to many ${assoc.target} on ${assoc.on.map((x) => x.ref?.join('.') || x).join(' ')};
-          }
-        `.replace(/ {8}/g, '')
-				);
-				const query = entity.projection || entity.query?.SELECT;
-				if (query) (query.columns ??= ['*']).push({ as: 'changes', cast: assoc });
-				else if (entity.elements) entity.elements.changes = assoc;
-
-				// Add UI.Facet for Change History List
-				if (!entity['@changelog.disable_facet']) entity['@UI.Facets']?.push(facet);
-			}
-
-			if (entity.actions) {
-				const hasParentInfo = entity[hasParent];
-				const entityName = hasParentInfo?.entityName;
-				const parentEntity = entityName ? m.definitions[entityName] : null;
-				const isParentRootAndHasFacets = parentEntity?.[isRoot] && parentEntity?.['@UI.Facets'];
-				if (entity[isRoot] && entity['@UI.Facets']) {
-					// Add side effects for root entity
-					addSideEffects(entity.actions, true);
-				} else if (isParentRootAndHasFacets) {
-					// Add side effects for child entity
-					addSideEffects(entity.actions, false, hasParentInfo?.associationName);
-				}
-			}
-		}
-	}
-	(m.meta ??= {})[_enhanced] = true;
-}
-
-// Add generic change tracking handlers
-function addGenericHandlers() {
-	const { track_changes, _afterReadChangeView } = require('./lib/change-log');
-	for (const srv of cds.services) {
-		if (srv instanceof cds.ApplicationService) {
-			let any = false;
-			for (const entity of Object.values(srv.entities)) {
-				if (isChangeTracked(entity)) {
-					cds.db.before('CREATE', entity, track_changes);
-					cds.db.before('UPDATE', entity, track_changes);
-					cds.db.before('DELETE', entity, track_changes);
-					any = true;
-				}
-			}
-			if (any && srv.entities.ChangeView) {
-				srv.after('READ', srv.entities.ChangeView, _afterReadChangeView);
-			}
-		}
-	}
-}
-
-// Register plugin hooks
-cds.on('compile.for.runtime', (csn) => {
-	DEBUG?.('on', 'compile.for.runtime');
-	enhanceModel(csn);
-});
-cds.on('compile.to.edmx', (csn) => {
-	DEBUG?.('on', 'compile.to.edmx');
-	enhanceModel(csn);
-});
-cds.on('compile.to.dbx', (csn) => {
-	DEBUG?.('on', 'compile.to.dbx');
-	enhanceModel(csn);
-});
-cds.on('served', addGenericHandlers);
+const { enhanceModel } = require('./lib/model-enhancer.js');
+const { registerSessionVariableHandlers } = require('./lib/skipHandlers.js');
+const { deploySQLiteTriggers } = require('./lib/sqlite/register.js');
+const { registerPostgresCompilerHook, deployPostgresLabels } = require('./lib/postgres/register.js');
+const { registerH2CompilerHook } = require('./lib/h2/register.js');
+const { registerHDICompilerHook } = require('./lib/hana/register.js');
+
+cds.on('loaded', enhanceModel);
+cds.on('listening', registerSessionVariableHandlers);
+cds.once('served', deploySQLiteTriggers);
+cds.once('served', deployPostgresLabels);
+
+registerH2CompilerHook();
+registerPostgresCompilerHook();
+registerHDICompilerHook();