@cap-js/change-tracking 1.0.0

package/_i18n/i18n_it.properties

@@ -0,0 +1,51 @@
+## Change Table Fields Description##
+####################################
+#XTIT: Field Name
+Changes.ID=Cambiamenti ID
+#XTIT: Field Name
+Changes.entityID=ID oggetto
+#XTIT: Field Name
+Changes.parentEntityID=ID superiore oggetto
+#XTIT: Field Name
+Changes.parentKey=Chiave sovraordinata
+#XTIT: Field Name
+Changes.serviceEntityPath=Percorso di entità del servizio
+#XTIT: Field Name
+Changes.attribute=Campo
+#XTIT: Field Name
+Changes.keys=Cambia le chiavi
+#XTIT: Field Name
+Changes.modification=Tipo di modifica
+#XTIT: Field Name
+Changes.valueChangedFrom=Valore precedente
+#XTIT: Field Name
+Changes.valueChangedTo=Nuovo valore
+#XTIT: Field Name
+Changes.entity=Tipo di oggetto
+#XTIT: Field Name
+Changes.serviceEntity=Tipo oggetto prestazione
+#XTIT: Field Name
+Changes.valueDataType=Valutare il tipo di dati
+
+## Change Log Table Fields Description##
+########################################
+#XTIT: Field Name
+ChangeLog.entity=Entità
+#XTIT: Field Name
+ChangeLog.entityKey=Chiave entità
+#XTIT: Field Name
+ChangeLog.serviceEntity=Entità di servizio
+
+
+## Change Log Modifications##
+########################################
+#XFLD: Field label
+ChangeLog.modification.create=Creare
+#XFLD: Field label
+ChangeLog.modification.update=Aggiornare
+#XFLD: Field label
+ChangeLog.modification.delete=Cancellare
+
+## Change History Table##
+########################################
+ChangeHistory=Storico modifiche

package/_i18n/i18n_ja.properties

@@ -0,0 +1,47 @@
+## Change Table Fields Description##
+####################################
+#XTIT: Field Name
+Changes.ID=\u5909\u66F4 ID
+#XTIT: Field Name
+Changes.entityID=\u30AA\u30D6\u30B8\u30A7\u30AF\u30C8 ID
+#XTIT: Field Name
+Changes.parentEntityID=\u89AA\u30AA\u30D6\u30B8\u30A7\u30AF\u30C8 ID
+#XTIT: Field Name
+Changes.parentKey=\u89AA\u30AD\u30FC
+#XTIT: Field Name
+Changes.serviceEntityPath=\u30B5\u30FC\u30D3\u30B9\u30A8\u30F3\u30C6\u30A3\u30C6\u30A3\u30D1\u30B9
+#XTIT: Field Name
+Changes.attribute=\u30D5\u30A3\u30FC\u30EB\u30C9
+#XTIT: Field Name
+Changes.keys=\u5909\u66F4\u30AD\u30FC
+#XTIT: Field Name
+Changes.modification=\u5909\u66F4\u30BF\u30A4\u30D7
+#XTIT: Field Name
+Changes.valueChangedFrom=\u53E4\u3044\u5024
+#XTIT: Field Name
+Changes.valueChangedTo=\u65B0\u3057\u3044\u5024
+#XTIT: Field Name
+Changes.entity=\u30AA\u30D6\u30B8\u30A7\u30AF\u30C8\u30BF\u30A4\u30D7
+#XTIT: Field Name
+Changes.serviceEntity=\u30B5\u30FC\u30D3\u30B9\u30AA\u30D6\u30B8\u30A7\u30AF\u30C8\u30BF\u30A4\u30D7
+#XTIT: Field Name
+Changes.valueDataType=\u5024\u306E\u30C7\u30FC\u30BF\u578B
+
+## Change Log Table Fields Description##
+########################################
+#XTIT: Field Name
+ChangeLog.entity=\u30A8\u30F3\u30C6\u30A3\u30C6\u30A3
+#XTIT: Field Name
+ChangeLog.entityKey=\u30A8\u30F3\u30C6\u30A3\u30C6\u30A3\u30AD\u30FC
+#XTIT: Field Name
+ChangeLog.serviceEntity=\u30B5\u30FC\u30D3\u30B9\u30A8\u30F3\u30C6\u30A3\u30C6\u30A3
+
+
+## Change Log Modifications##
+########################################
+#XFLD: Field label
+ChangeLog.modification.create=\u4F5C\u6210
+#XFLD: Field label
+ChangeLog.modification.update=\u66F4\u65B0
+#XFLD: Field label
+ChangeLog.modification.delete=\u524A\u9664

package/_i18n/i18n_pl.properties

@@ -0,0 +1,51 @@
+## Change Table Fields Description##
+####################################
+#XTIT: Field Name
+Changes.ID=Identyfikator zmian
+#XTIT: Field Name
+Changes.entityID=Identyfikator obiektu
+#XTIT: Field Name
+Changes.parentEntityID=Identyfikator obiektu nadrz\u0119dnego
+#XTIT: Field Name
+Changes.parentKey=Klucz nadrz\u0119dny
+#XTIT: Field Name
+Changes.serviceEntityPath=\u015Acie\u017Cka encji us\u0142ugi
+#XTIT: Field Name
+Changes.attribute=Pole
+#XTIT: Field Name
+Changes.keys=Klucze zmian
+#XTIT: Field Name
+Changes.modification=Typ zmiany
+#XTIT: Field Name
+Changes.valueChangedFrom=Stara warto\u015B\u0107
+#XTIT: Field Name
+Changes.valueChangedTo=Nowa warto\u015B\u0107
+#XTIT: Field Name
+Changes.entity=Typ obiektu
+#XTIT: Field Name
+Changes.serviceEntity=Typ obiektu us\u0142ugi
+#XTIT: Field Name
+Changes.valueDataType=Typ danych warto\u015Bci
+
+## Change Log Table Fields Description##
+########################################
+#XTIT: Field Name
+ChangeLog.entity=Encja
+#XTIT: Field Name
+ChangeLog.entityKey=Klucz encji
+#XTIT: Field Name
+ChangeLog.serviceEntity=Encja us\u0142ugi
+
+
+## Change Log Modifications##
+########################################
+#XFLD: Field label
+ChangeLog.modification.create=Utw\u00F3rz
+#XFLD: Field label
+ChangeLog.modification.update=Aktualizuj
+#XFLD: Field label
+ChangeLog.modification.delete=Usu\u0144
+
+## Change History Table##
+########################################
+ChangeHistory=Historia zmian

package/_i18n/i18n_pt.properties

@@ -0,0 +1,51 @@
+## Change Table Fields Description##
+####################################
+#XTIT: Field Name
+Changes.ID=ID das altera\u00E7\u00F5es
+#XTIT: Field Name
+Changes.entityID=ID de objeto
+#XTIT: Field Name
+Changes.parentEntityID=ID do objeto superior
+#XTIT: Field Name
+Changes.parentKey=Chave superior
+#XTIT: Field Name
+Changes.serviceEntityPath=Caminho da entidade de servi\u00E7o
+#XTIT: Field Name
+Changes.attribute=Campo
+#XTIT: Field Name
+Changes.keys=Chaves de altera\u00E7\u00F5es
+#XTIT: Field Name
+Changes.modification=Tipo de altera\u00E7\u00E3o
+#XTIT: Field Name
+Changes.valueChangedFrom=Valor antigo
+#XTIT: Field Name
+Changes.valueChangedTo=Valor novo
+#XTIT: Field Name
+Changes.entity=Tipo de objeto
+#XTIT: Field Name
+Changes.serviceEntity=Tipo de objeto de servi\u00E7o
+#XTIT: Field Name
+Changes.valueDataType=Tipo de dados de valor
+
+## Change Log Table Fields Description##
+########################################
+#XTIT: Field Name
+ChangeLog.entity=Entidade
+#XTIT: Field Name
+ChangeLog.entityKey=Chave de entidade
+#XTIT: Field Name
+ChangeLog.serviceEntity=Entidade de servi\u00E7o
+
+
+## Change Log Modifications##
+########################################
+#XFLD: Field label
+ChangeLog.modification.create=Criar
+#XFLD: Field label
+ChangeLog.modification.update=Atualizar
+#XFLD: Field label
+ChangeLog.modification.delete=Eliminar
+
+## Change History Table##
+########################################
+ChangeHistory=Histórico de alterações

package/_i18n/i18n_ru.properties

@@ -0,0 +1,51 @@
+## Change Table Fields Description##
+####################################
+#XTIT: Field Name
+Changes.ID=\u0418\u0434. \u0438\u0437\u043C\u0435\u043D\u0435\u043D\u0438\u044F
+#XTIT: Field Name
+Changes.entityID=\u0418\u0434. \u043E\u0431\u044A\u0435\u043A\u0442\u0430
+#XTIT: Field Name
+Changes.parentEntityID=\u0418\u0434. \u0432\u044B\u0448\u0435\u0441\u0442\u043E\u044F\u0449\u0435\u0433\u043E \u043E\u0431\u044A\u0435\u043A\u0442\u0430
+#XTIT: Field Name
+Changes.parentKey=\u0412\u044B\u0448\u0435\u0441\u0442\u043E\u044F\u0449\u0438\u0439 \u043A\u043B\u044E\u0447
+#XTIT: Field Name
+Changes.serviceEntityPath=\u041F\u0443\u0442\u044C \u043A \u0441\u0443\u0449\u043D\u043E\u0441\u0442\u0438 \u0441\u0435\u0440\u0432\u0438\u0441\u0430
+#XTIT: Field Name
+Changes.attribute=\u041F\u043E\u043B\u0435
+#XTIT: Field Name
+Changes.keys=\u041A\u043B\u044E\u0447\u0438 \u0438\u0437\u043C\u0435\u043D\u0435\u043D\u0438\u0439
+#XTIT: Field Name
+Changes.modification=\u0422\u0438\u043F \u0438\u0437\u043C\u0435\u043D\u0435\u043D\u0438\u044F
+#XTIT: Field Name
+Changes.valueChangedFrom=\u0421\u0442\u0430\u0440\u043E\u0435 \u0437\u043D\u0430\u0447\u0435\u043D\u0438\u0435
+#XTIT: Field Name
+Changes.valueChangedTo=\u041D\u043E\u0432\u043E\u0435 \u0437\u043D\u0430\u0447\u0435\u043D\u0438\u0435
+#XTIT: Field Name
+Changes.entity=\u0422\u0438\u043F \u043E\u0431\u044A\u0435\u043A\u0442\u0430
+#XTIT: Field Name
+Changes.serviceEntity=\u0422\u0438\u043F \u043E\u0431\u044A\u0435\u043A\u0442\u0430 \u0441\u0435\u0440\u0432\u0438\u0441\u0430
+#XTIT: Field Name
+Changes.valueDataType=\u0422\u0438\u043F \u0434\u0430\u043D\u043D\u044B\u0445 \u0437\u043D\u0430\u0447\u0435\u043D\u0438\u044F
+
+## Change Log Table Fields Description##
+########################################
+#XTIT: Field Name
+ChangeLog.entity=\u0421\u0443\u0449\u043D\u043E\u0441\u0442\u044C
+#XTIT: Field Name
+ChangeLog.entityKey=\u041A\u043B\u044E\u0447 \u0441\u0443\u0449\u043D\u043E\u0441\u0442\u0438
+#XTIT: Field Name
+ChangeLog.serviceEntity=\u0421\u0443\u0449\u043D\u043E\u0441\u0442\u044C \u0441\u0435\u0440\u0432\u0438\u0441\u0430
+
+
+## Change Log Modifications##
+########################################
+#XFLD: Field label
+ChangeLog.modification.create=\u0421\u043E\u0437\u0434\u0430\u0442\u044C
+#XFLD: Field label
+ChangeLog.modification.update=\u041E\u0431\u043D\u043E\u0432\u0438\u0442\u044C
+#XFLD: Field label
+ChangeLog.modification.delete=\u0423\u0434\u0430\u043B\u0438\u0442\u044C
+
+## Change History Table##
+########################################
+ChangeHistory=История изменений

package/_i18n/i18n_zh_CN.properties

@@ -0,0 +1,51 @@
+## Change Table Fields Description##
+####################################
+#XTIT: Field Name
+Changes.ID=\u66F4\u6539\u6807\u8BC6
+#XTIT: Field Name
+Changes.entityID=\u5BF9\u8C61\u6807\u8BC6
+#XTIT: Field Name
+Changes.parentEntityID=\u7236\u5BF9\u8C61\u6807\u8BC6
+#XTIT: Field Name
+Changes.parentKey=\u7236\u53C2\u6570
+#XTIT: Field Name
+Changes.serviceEntityPath=\u670D\u52A1\u5B9E\u4F53\u8DEF\u5F84
+#XTIT: Field Name
+Changes.attribute=\u5B57\u6BB5
+#XTIT: Field Name
+Changes.keys=\u66F4\u6539\u53C2\u6570
+#XTIT: Field Name
+Changes.modification=\u66F4\u6539\u7C7B\u578B
+#XTIT: Field Name
+Changes.valueChangedFrom=\u65E7\u503C
+#XTIT: Field Name
+Changes.valueChangedTo=\u65B0\u503C
+#XTIT: Field Name
+Changes.entity=\u5BF9\u8C61\u7C7B\u578B
+#XTIT: Field Name
+Changes.serviceEntity=\u670D\u52A1\u5BF9\u8C61\u7C7B\u578B
+#XTIT: Field Name
+Changes.valueDataType=\u6570\u503C\u6570\u636E\u7C7B\u578B
+
+## Change Log Table Fields Description##
+########################################
+#XTIT: Field Name
+ChangeLog.entity=\u5B9E\u4F53
+#XTIT: Field Name
+ChangeLog.entityKey=\u5B9E\u4F53\u53C2\u6570
+#XTIT: Field Name
+ChangeLog.serviceEntity=\u670D\u52A1\u5B9E\u4F53
+
+
+## Change Log Modifications##
+########################################
+#XFLD: Field label
+ChangeLog.modification.create=\u521B\u5EFA
+#XFLD: Field label
+ChangeLog.modification.update=\u66F4\u65B0
+#XFLD: Field label
+ChangeLog.modification.delete=\u5220\u9664
+
+## Change History Table##
+########################################
+ChangeHistory=\u6539\u53d8\u5386\u53f2

package/cds-plugin.js

@@ -0,0 +1,60 @@
+const cds = require('@sap/cds')
+
+const isChangeTracked = (entity) => (
+  entity['@changelog']
+  || entity.elements && Object.values(entity.elements).some(e => e['@changelog'])
+)
+
+
+// Unfold @changelog annotations in loaded model
+cds.on('loaded', m => {
+
+  // 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
+  changes.on.pop() // remove ID -> filled in below
+
+  for (let name in m.definitions) {
+    const entity = m.definitions[name]
+    if (isChangeTracked(entity)) {
+
+      // Determine entity keys
+      const keys = [], { elements: elms } = entity
+      for (let e in elms) if (elms[e].key) keys.push(e)
+
+      // Add association to ChangeView...
+      const on = [...changes.on]; keys.forEach((k, i) => { i && on.push('||'); on.push({ ref: [k] }) })
+      const assoc = { ...changes, on }
+      const query = entity.projection || entity.query?.SELECT
+      if (query) {
+        (query.columns ??= ['*']).push({ as: 'changes', cast: assoc })
+      } else {
+        entity.elements.changes = assoc
+      }
+
+      // Add UI.Facet for Change History List
+      entity['@UI.Facets']?.push(facet)
+    }
+  }
+})
+
+// Add generic change tracking handlers
+cds.on('served', () => {
+  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)
+      }
+    }
+  }
+})

package/index.cds

@@ -0,0 +1,108 @@
+using { managed, cuid } from '@sap/cds/common';
+namespace sap.changelog;
+
+/**
+ * Used in cds-plugin.js as template for tracked entities
+ */
+aspect aspect @(UI.Facets: [{
+  $Type : 'UI.ReferenceFacet',
+  ID    : 'ChangeHistoryFacet',
+  Label : '{i18n>ChangeHistory}',
+  Target: 'changes/@UI.PresentationVariant',
+  //TODO: Use for lazy-loading once Fiori fixes bugs and v1.120 is released
+  //![@UI.PartOfPreview]: false
+}]) {
+  // Essentially: Association to many Changes on changes.changeLog.entityKey = ID;
+  changes : Association to many ChangeView on changes.entityKey = ID;
+  key ID  : UUID;
+}
+
+
+// This is a helper view to flatten the assoc path to the entityKey
+@readonly
+view ChangeView as
+  select from Changes {
+    *,
+    entityID            as objectID, // no clue why we have to rename this?
+    parentEntityID      as parentObjectID, // no clue why we have to rename this?
+    changeLog.entityKey as entityKey, // flattening assoc path -> this is the main reason for having this helper view
+    changeLog.createdAt as createdAt,
+    changeLog.createdBy as createdBy,
+  }
+  excluding {
+    entityID,
+    parentEntityID,
+  };
+
+/**
+ * Top-level changes entity, e.g. UPDATE Incident by, at, ...
+ */
+entity ChangeLog : managed, cuid {
+  serviceEntity : String @title: '{i18n>ChangeLog.serviceEntity}'; // definition name of target entity (on service level) - e.g. ProcessorsService.Incidents
+  entity        : String @title: '{i18n>ChangeLog.entity}'; // definition name of target entity (on db level) - e.g. sap.capire.incidents.Incidents
+  entityKey     : UUID   @title: '{i18n>ChangeLog.entityKey}'; // primary key of target entity, e.g. Incidents.ID
+  createdAt     : managed:createdAt @title: 'On';
+  createdBy     : managed:createdBy @title: 'By';
+  changes       : Composition of many Changes on changes.changeLog = $self;
+}
+
+
+/**
+ * Attribute-level Changes with simple capturing of one-level
+ * composition trees in parent... elements.
+ */
+entity Changes {
+
+  key ID                : UUID                     @UI.Hidden;
+      keys              : String                   @title: '{i18n>Changes.keys}';
+      attribute         : String                   @title: '{i18n>Changes.attribute}';
+      valueChangedFrom  : String                   @title: '{i18n>Changes.valueChangedFrom}';
+      valueChangedTo    : String                   @title: '{i18n>Changes.valueChangedTo}';
+
+      // Business meaningful object id
+      entityID          : String                   @title: '{i18n>Changes.entityID}';
+      entity            : String                   @title: '{i18n>Changes.entity}'; // similar to ChangeLog.entity, but could be nested entity in a composition tree
+      serviceEntity     : String                   @title: '{i18n>Changes.serviceEntity}'; // similar to ChangeLog.serviceEntity, but could be nested entity in a composition tree
+
+      // Business meaningful parent object id
+      parentEntityID    : String                   @title: '{i18n>Changes.parentEntityID}';
+      parentKey         : UUID                     @title: '{i18n>Changes.parentKey}';
+      serviceEntityPath : String                   @title: '{i18n>Changes.serviceEntityPath}';
+
+      @title: '{i18n>Changes.modification}'
+      modification      : String enum {
+        create = 'Create';
+        update = 'Edit';
+        delete = 'Delete';
+      };
+
+      valueDataType     : String                   @title: '{i18n>Changes.valueDataType}';
+      changeLog         : Association to ChangeLog @title: '{i18n>ChangeLog.ID}';
+}
+
+annotate ChangeView with @(UI: {
+  PresentationVariant: {
+    Visualizations: ['@UI.LineItem'],
+    RequestAtLeast: [
+      parentKey,
+      serviceEntity,
+      serviceEntityPath
+    ],
+    SortOrder     : [{
+      Property  : createdAt,
+      Descending: true
+    }],
+  },
+  LineItem           : [
+    { Value: modification, @HTML5.CssDefaults: {width:'9%'} },
+    { Value: createdAt, @HTML5.CssDefaults: {width:'12%'} },
+    { Value: createdBy, @HTML5.CssDefaults: {width:'9%'} },
+    { Value: entity, @HTML5.CssDefaults: {width:'11%'} },
+    { Value: objectID, @HTML5.CssDefaults: {width:'14%'} },
+    { Value: attribute, @HTML5.CssDefaults: {width:'9%'} },
+    { Value: valueChangedTo, @HTML5.CssDefaults: {width:'11%'} },
+    { Value: valueChangedFrom, @HTML5.CssDefaults: {width:'11%'} },
+    { Value: parentObjectID, @HTML5.CssDefaults: {width:'14%'}, ![@UI.Hidden]: true }
+  ],
+  DeleteHidden       : true,
+});