@cap-js/change-tracking 1.0.8 → 1.1.1

package/lib/localization.js

@@ -1,49 +1,32 @@
 const cds = require("@sap/cds/lib");
 const LOG = cds.log("change-log");
-const { getNameFromPathVal, getDBEntity } = require("./entity-helper");
+const { formatOptions } = require("./format-options");
+const { getNameFromPathVal, getDBEntity, splitPath } = require("./entity-helper");
 
 const MODIF_I18N_MAP = {
-    create: "{i18n>ChangeLog.modification.create}",
-    update: "{i18n>ChangeLog.modification.update}",
-    delete: "{i18n>ChangeLog.modification.delete}",
+    create: "ChangeLog.modification.create",
+    update: "ChangeLog.modification.update",
+    delete: "ChangeLog.modification.delete",
 };
 
-const _getLocalization = function (locale, i18nKey) {
-    //
-    //
-    //
-    //
-    //     REVISIT!
-    //     REVISIT!
-    //     REVISIT!
-    //     REVISIT!
-    //     REVISIT!
-    //
-    //
-    //
-    //
-    return JSON.parse(cds.localize(cds.model, locale, JSON.stringify(i18nKey)));
-};
-
-const _localizeModification = function (change, locale) {
+const _localizeModification = function (change) {
     if (change.modification && MODIF_I18N_MAP[change.modification]) {
-        change.modification = _getLocalization(locale, MODIF_I18N_MAP[change.modification]);
+        change.modification = cds.i18n.labels.for(MODIF_I18N_MAP[change.modification]);
     }
 };
 
-const _localizeDefaultObjectID = function (change, locale) {
+const _localizeDefaultObjectID = function (change) {
     if (!change.objectID) {
         change.objectID = change.entity ? change.entity : "";
     }
     if (change.objectID && change.serviceEntityPath && !change.parentObjectID && change.parentKey) {
-        const path = change.serviceEntityPath.split('/');
+        const path = splitPath(change.serviceEntityPath);
         const parentNodePathVal = path[path.length - 2];
         const parentEntityName = getNameFromPathVal(parentNodePathVal);
         const dbEntity = getDBEntity(parentEntityName);
         try {
-            const labelI18nKey = dbEntity['@Common.Label'] || dbEntity['@title'];
-            const labelI18nValue = labelI18nKey ? _getLocalization(locale, labelI18nKey) : null;
-            change.parentObjectID = labelI18nValue ? labelI18nValue : dbEntity.name;
+            const labelI18nKey = getTranslationKey(dbEntity['@Common.Label'] || dbEntity['@title']);
+            change.parentObjectID = cds.i18n.labels.for(labelI18nKey) || labelI18nKey || dbEntity.name;
         } catch (e) {
             LOG.error("Failed to localize parent object id", e);
             throw new Error("Failed to localize parent object id", e);
@@ -51,13 +34,11 @@ const _localizeDefaultObjectID = function (change, locale) {
     }
 };
 
-const _localizeEntityType = function (change, locale) {
+const _localizeEntityType = function (change) {
     if (change.entity) {
         try {
             const labelI18nKey = _getLabelI18nKeyOnEntity(change.serviceEntity);
-            const labelI18nValue = labelI18nKey ? _getLocalization(locale, labelI18nKey) : null;
-
-            change.entity = labelI18nValue ? labelI18nValue : change.entity;
+            change.entity = labelI18nKey || change.entity;
         } catch (e) {
             LOG.error("Failed to localize entity type", e);
             throw new Error("Failed to localize entity type", e);
@@ -66,9 +47,7 @@ const _localizeEntityType = function (change, locale) {
     if (change.serviceEntity) {
         try {
             const labelI18nKey = _getLabelI18nKeyOnEntity(change.serviceEntity);
-            const labelI18nValue = labelI18nKey ? _getLocalization(locale, labelI18nKey) : null;
-
-            change.serviceEntity = labelI18nValue ? labelI18nValue : change.serviceEntity;
+            change.serviceEntity = labelI18nKey || change.serviceEntity;
         } catch (e) {
             LOG.error("Failed to localize service entity", e);
             throw new Error("Failed to localize service entity", e);
@@ -76,7 +55,13 @@ const _localizeEntityType = function (change, locale) {
     }
 };
 
-const _localizeAttribute = function (change, locale) {
+const getTranslationKey = (value) => {
+    if (typeof value != 'string') return value;
+    const result = value.match(/(?<=\{@?(i18n>)).*(?=\})/g)
+    return result ? result[0] : value
+}
+
+const _localizeAttribute = function (change) {
     if (change.attribute && change.serviceEntity) {
         try {
             const serviceEntity = cds.model.definitions[change.serviceEntity];
@@ -85,8 +70,7 @@ const _localizeAttribute = function (change, locale) {
                 const element = serviceEntity.elements[change.attribute];
                 if (element.isAssociation) labelI18nKey = _getLabelI18nKeyOnEntity(element.target);
             }
-            const labelI18nValue = labelI18nKey ? _getLocalization(locale, labelI18nKey) : null;
-            change.attribute = labelI18nValue ? labelI18nValue : change.attribute;
+            change.attribute = labelI18nKey || change.attribute;
         } catch (e) {
             LOG.error("Failed to localize change attribute", e);
             throw new Error("Failed to localize change attribute", e);
@@ -98,16 +82,44 @@ const _getLabelI18nKeyOnEntity = function (entityName, /** optinal */ attribute)
     let def = cds.model.definitions[entityName];
     if (attribute) def = def?.elements[attribute]
     if (!def) return "";
-    return def['@Common.Label'] || def['@title'] || def['@UI.HeaderInfo.TypeName'];
+    const i18nKey = getTranslationKey(def['@Common.Label'] || def['@title'] || def['@UI.HeaderInfo.TypeName']);
+    return cds.i18n.labels.for(i18nKey) || i18nKey;
+};
+
+const parseTime = (time, locale, options) => {
+    const timeParts = time.split(':');
+    const date = new Date();
+    date.setHours(parseInt(timeParts[0], 10), parseInt(timeParts[1], 10), parseInt(timeParts[2], 10));
+    return date.toLocaleTimeString(locale, options);
+};
+
+const _localizeValue = (change, locale) => {
+    if (change.valueDataType !== 'cds.Date' && change.valueDataType !== 'cds.DateTime' && change.valueDataType !== 'cds.Timestamp' && change.valueDataType !== 'cds.Time') {
+        return;
+    }
+    const normalizedLocale = locale.replaceAll('_', '-');
+    const options = formatOptions[change.valueDataType]?.[normalizedLocale]
+        ?? formatOptions[change.valueDataType]?.['en']
+
+    if (change.valueDataType === 'cds.Time') {
+        if (change.valueChangedFrom) change.valueChangedFrom = parseTime(change.valueChangedFrom, normalizedLocale, options);
+        if (change.valueChangedTo) change.valueChangedTo = parseTime(change.valueChangedTo, normalizedLocale, options);
+    } else {
+        const formatter = change.valueDataType === 'cds.Date' ? 'toLocaleDateString' : 'toLocaleString';
+        if (change.valueChangedFrom) change.valueChangedFrom = new Date(change.valueChangedFrom)[formatter](normalizedLocale, options);
+        if (change.valueChangedTo) change.valueChangedTo = new Date(change.valueChangedTo)[formatter](normalizedLocale, options);
+    }
+
 };
 
 const localizeLogFields = function (data, locale) {
     if (!locale) return
     for (const change of data) {
-        _localizeModification(change, locale);
-        _localizeAttribute(change, locale);
-        _localizeEntityType(change, locale);
-        _localizeDefaultObjectID(change, locale);
+        _localizeModification(change);
+        _localizeAttribute(change);
+        _localizeEntityType(change);
+        _localizeDefaultObjectID(change);
+        _localizeValue(change, locale);
     }
 };
 module.exports = {

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@cap-js/change-tracking",
-  "version": "1.0.8",
+  "version": "1.1.1",
   "description": "CDS plugin providing out-of-the box support for automatic capturing, storing, and viewing of the change records of modeled entities.",
   "repository": "cap-js/change-tracking",
   "author": "SAP SE (https://www.sap.com)",
-  "license": "SEE LICENSE IN LICENSE",
+  "license": "Apache-2.0",
   "main": "cds-plugin.js",
   "files": [
     "lib",
@@ -18,23 +18,23 @@
     "test": "npx jest --silent"
   },
   "peerDependencies": {
-    "@sap/cds": ">=8"
+    "@sap/cds": ">=8.5"
+  },
+  "engines": {
+    "node": ">=20.0.0"
   },
   "devDependencies": {
     "@cap-js/change-tracking": "file:.",
-    "@cap-js/sqlite": "^1",
-    "axios": "^1",
-    "chai": "^4.3.10",
-    "chai-as-promised": "^7.1.1",
-    "chai-subset": "^1.6.0",
-    "eslint": "^8",
-    "express": "^4",
-    "jest": "^29"
+    "@cap-js/attachments": "^2",
+    "@cap-js/sqlite": "^1 || ^2",
+    "@cap-js/cds-test": "*",
+    "express": "^4"
   },
   "cds": {
     "requires": {
       "change-tracking": {
-        "model": "@cap-js/change-tracking"
+        "model": "@cap-js/change-tracking",
+        "considerLocalizedValues": false
       }
     }
   }