Allow for lazy loading of change history (SAP UI5) (#42)

Author: mnkiefer

CHANGELOG.md

@@ -4,11 +4,16 @@ All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
-## Version 1.0.3 - TBD
+## Version 1.0.3 - 07.11.23
+
+### Added
+
+- Added note about using `SAPUI5 v1.120.0` or later for proper lazy loading of the *Change History* table.
 
 ### Changed
 
 - Support cases where parent/child entries are created simultaneously.
+- Allow for lazy loading of change history table (with SAP UI5 release 1.120.0).
 
 ## Version 1.0.2 - 31.10.23
 

README.md

@@ -8,23 +8,28 @@ The `@cap-js/change-tracking` package is a [CDS plugin](https://cap.cloud.sap/do
 2. [Add `@changelog` annotations to your CDS models](#annotations)
 3. [Et voilà:](#change-history-view)
 
-<img width="1300" alt="change-history-custom" src="_assets/changes.png">
+<img width="1300" alt="change-history-loading" src="_assets/change-history.gif">
 
 
 
 ### Table of Contents
 
-- [Preliminaries](#preliminaries)
-- [Setup](#setup)
-- [Annotations](#annotations)
-  - [Human-readable Types and Fields](#human-readable-types-and-fields)
-  - [Human-readable IDs](#human-readable-ids)
-  - [Human-readable Values](#human-readable-values)
-- [Test-drive locally](#test-drive-locally)
-- [Change History View](#change-history-view)
-- [Contributing](#contributing)
-- [Code of Conduct](#code-of-conduct)
-- [Licensing](#licensing)
+- [Change Tracking Plugin for SAP Cloud Application Programming Model (CAP)](#change-tracking-plugin-for-sap-cloud-application-programming-model-cap)
+    - [Table of Contents](#table-of-contents)
+  - [Preliminaries](#preliminaries)
+  - [Setup](#setup)
+  - [Annotations](#annotations)
+    - [Human-readable Types and Fields](#human-readable-types-and-fields)
+    - [Human-readable IDs](#human-readable-ids)
+    - [Human-readable Values](#human-readable-values)
+  - [Test-drive locally](#test-drive-locally)
+  - [Change History View](#change-history-view)
+  - [Customizations](#customizations)
+    - [Altered table view](#altered-table-view)
+    - [Disable lazy loading](#disable-lazy-loading)
+  - [Contributing](#contributing)
+  - [Code of Conduct](#code-of-conduct)
+  - [Licensing](#licensing)
 
 
 
@@ -162,13 +167,19 @@ With the steps above, we have successfully set up change tracking for our refere
 
 ## Change History View
 
+> [!IMPORTANT]
+> To ensure proper lazy loading of the Change History table, please use **SAPUI5 version 1.120.0** or higher.<br>
+> If you wish to *disable* this feature, please see the customization section on how to [disable lazy loading](#disable-lazy-loading).
+
 <img width="1300" alt="change-history" src="_assets/changes.png">
 
 If you have a Fiori Element application, the CDS plugin automatically provides and generates a view `sap.changelog.ChangeView`, the facet of which is automatically added to the Fiori Object Page of your change-tracked entities/elements. In the UI, this corresponds to the *Change History* table which serves to help you to view and search the stored change records of your modeled entities.
 
-### Customizations
+## Customizations
+
+### Altered table view
 
-The view can be easily adapted and configured to your own needs by simply changing or extending it. For example, let's assume we only want to show the first 5 columns in equal spacing, we would extend `srv/change-tracking.cds` as follows:
+The *Change History* view can be easily adapted and configured to your own needs by simply changing or extending it. For example, let's assume we only want to show the first 5 columns in equal spacing, we would extend `srv/change-tracking.cds` as follows:
 
 ```cds
 using from '@cap-js/change-tracking';
@@ -190,6 +201,24 @@ In the UI, the *Change History* table now contains 5 equally-spaced columns with
 
 For more information and examples on adding Fiori Annotations, see [Adding SAP Fiori Annotations](https://cap.cloud.sap/docs/advanced/fiori#fiori-annotations).
 
+### Disable lazy loading
+
+To disable the lazy loading feature of the *Change History* table, you can add the following annotation to your `srv/change-tracking.cds`:
+
+```cds
+using from '@cap-js/change-tracking';
+
+annotate sap.changelog.aspect @(UI.Facets: [{
+  $Type : 'UI.ReferenceFacet',
+  ID    : 'ChangeHistoryFacet',
+  Label : '{i18n>ChangeHistory}',
+  Target: 'changes/@UI.PresentationVariant',
+  ![@UI.PartOfPreview]
+}]);
+
+```
+
+The system now uses the SAPUI5 default setting `![@UI.PartOfPreview]: true`, such that the table will always shown when navigating to that respective Object page.
 
 ## Contributing
 

_assets/change-history.gif

@@ -9,8 +9,7 @@ aspect aspect @(UI.Facets: [{
   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
+  ![@UI.PartOfPreview]: false
 }]) {
   // Essentially: Association to many Changes on changes.changeLog.entityKey = ID;
   changes : Association to many ChangeView on changes.entityKey = ID;