Skip to content

feat: format cds.Date, cds.Time, cds.DateTime and cds.Timestamp properties #125

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
+186 −95
Open

feat: format cds.Date, cds.Time, cds.DateTime and cds.Timestamp properties #125

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
143cf79
Format date properties
schiwekM Oct 7, 2024
d62adb4
Fixed tests
schiwekM Oct 22, 2024
465f5cd
Update fiori-draft-enabled.test.js
schiwekM Oct 22, 2024
b60eb68
Merge branch 'main' into feat-format-dates
schiwekM Nov 27, 2024
b499ae6
Merge branch 'main' into feat-format-dates
Sv7enNowitzki Jul 24, 2025
ebaaec8
feat: enhance date localization with locale-specific formatting options
Sv7enNowitzki Jul 24, 2025
feff82d
feat: implement locale-specific time, datetime and timetamp formattin…
Sv7enNowitzki Jul 24, 2025
223667a
fix: ut issue
Sv7enNowitzki Jul 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion index.cds
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,8 @@ annotate ChangeView with @(UI: {
RequestAtLeast: [
parentKey,
serviceEntity,
serviceEntityPath
serviceEntityPath,
valueDataType
],
SortOrder : [{
Property : createdAt,
Expand Down
54 changes: 54 additions & 0 deletions lib/format-options.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
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' },
'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' },
'en': { day: 'numeric', month: 'short', year: 'numeric', hour: '2-digit', minute: '2-digit', second: '2-digit', hour12: true },
'es': { day: '2-digit', month: 'short', year: 'numeric', hour: '2-digit', 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': {
'de': { day: '2-digit', month: '2-digit', year: 'numeric', hour: '2-digit', minute: '2-digit', second: '2-digit' },
'en': { day: 'numeric', month: 'short', year: 'numeric', hour: '2-digit', minute: '2-digit', second: '2-digit', hour12: true },
'es': { day: '2-digit', month: 'short', year: 'numeric', hour: '2-digit', 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': {
'de': { hour: '2-digit', minute: '2-digit', second: '2-digit', hour12: false },
'en': { hour: '2-digit', minute: '2-digit', second: '2-digit', hour12: true },
'es': { hour: '2-digit', minute: '2-digit', second: '2-digit', hour12: false },
'fr': { hour: '2-digit', minute: '2-digit', second: '2-digit', hour12: false },
'it': { hour: '2-digit', minute: '2-digit', second: '2-digit', hour12: false },
'ja': { hour: '2-digit', minute: '2-digit', second: '2-digit', hour12: false },
'pl': { hour: '2-digit', minute: '2-digit', second: '2-digit', hour12: false },
'pt': { hour: '2-digit', minute: '2-digit', second: '2-digit', hour12: false },
'ru': { hour: '2-digit', minute: '2-digit', second: '2-digit', hour12: false },
'zh-CN': { hour: '2-digit', minute: '2-digit', second: '2-digit', hour12: false }
}
};

module.exports = {
formatOptions
};
26 changes: 26 additions & 0 deletions lib/localization.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
const cds = require("@sap/cds/lib");
const LOG = cds.log("change-log");
const { getNameFromPathVal, getDBEntity } = require("./entity-helper");
const { formatOptions } = require("./format-options");

const MODIF_I18N_MAP = {
create: "{i18n>ChangeLog.modification.create}",
Expand Down Expand Up @@ -101,13 +102,38 @@ const _getLabelI18nKeyOnEntity = function (entityName, /** optinal */ attribute)
return def['@Common.Label'] || def['@title'] || def['@UI.HeaderInfo.TypeName'];
};

const _localizeValue = (change, locale) => {
const defaultLocale = 'en';
const normalizedLocale = locale ? locale.replaceAll('_', '-') : defaultLocale;

const options = formatOptions[change.valueDataType]?.[normalizedLocale] || formatOptions[change.valueDataType]?.[defaultLocale];

if (!options) return;

if (change.valueDataType === 'cds.Time') {
const parseTime = (time) => {
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(normalizedLocale, options);
};
if (change.valueChangedFrom) change.valueChangedFrom = parseTime(change.valueChangedFrom);
if (change.valueChangedTo) change.valueChangedTo = parseTime(change.valueChangedTo);
} 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);
_localizeValue(change, locale);
}
};
module.exports = {
Expand Down
12 changes: 6 additions & 6 deletions tests/integration/fiori-draft-enabled.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1509,7 +1509,7 @@ describe("change log integration test", () => {
expect(registryChange.objectID).to.equal("San Francisco-2");
expect(registryChange.entity).to.equal("Book Store Registry");
expect(registryChange.valueChangedFrom).to.equal("");
expect(registryChange.valueChangedTo).to.equal("2022-01-01");
expect(registryChange.valueChangedTo).to.equal("Jan 1, 2022");
expect(registryChange.parentKey).to.equal("01234567-89ab-cdef-0123-456789abcdef");
expect(registryChange.parentObjectID).to.equal("Murder on the Orient Express");
});
Expand Down Expand Up @@ -1540,8 +1540,8 @@ describe("change log integration test", () => {
const registryChange = registryChanges[0];
expect(registryChange.attribute).to.equal("Valid On");
expect(registryChange.modification).to.equal("Update");
expect(registryChange.valueChangedFrom).to.equal("2022-10-15");
expect(registryChange.valueChangedTo).to.equal("2022-01-01");
expect(registryChange.valueChangedFrom).to.equal("Oct 15, 2022");
expect(registryChange.valueChangedTo).to.equal("Jan 1, 2022");
expect(registryChange.parentKey).to.equal("5ab2a87b-3a56-4d97-a697-7af72334a384");
expect(registryChange.parentObjectID).to.equal("The Strand");
});
Expand All @@ -1566,8 +1566,8 @@ describe("change log integration test", () => {
const registryChange = registryChanges[0];
expect(registryChange.attribute).to.equal("Valid On");
expect(registryChange.modification).to.equal("Update");
expect(registryChange.valueChangedFrom).to.equal("2018-09-01");
expect(registryChange.valueChangedTo).to.equal("2022-01-01");
expect(registryChange.valueChangedFrom).to.equal("Sep 1, 2018");
expect(registryChange.valueChangedTo).to.equal("Jan 1, 2022");
expect(registryChange.parentKey).to.equal("8aaed432-8336-4b0d-be7e-3ef1ce7f13ea");
expect(registryChange.parentObjectID).to.equal("City Lights Books");
});
Expand All @@ -1588,7 +1588,7 @@ describe("change log integration test", () => {
const registryChange = registryChanges[0];
expect(registryChange.attribute).to.equal("Valid On");
expect(registryChange.modification).to.equal("Delete");
expect(registryChange.valueChangedFrom).to.equal("2018-09-01");
expect(registryChange.valueChangedFrom).to.equal("Sep 1, 2018");
expect(registryChange.valueChangedTo).to.equal("");
expect(registryChange.parentKey).to.equal("8aaed432-8336-4b0d-be7e-3ef1ce7f13ea");
expect(registryChange.parentObjectID).to.equal("City Lights Books");
Expand Down
Loading
Loading