@sap/ux-specification 1.84.31 → 1.84.36

package/dist/src/sync/v4/export/controls/Table.d.ts

@@ -1,22 +1,59 @@
-import { Table as TableConfig, TableTypeV4, TableCreationModeType, SelectionMode, AnnotationPathAsObject, AnnotationPathWithKey } from '../../../../specification/v4';
+import type { TableSettings as TableSettingsIF, Table as TableInterface, TableCreationMode as TableCreationModeIF, ViewTableCreationMode as ViewTableCreationModeIF, QuickVariantSelectionV4 as QuickVariantSelectionV4IF, ALPChartView as ALPChartIF, LRChartView as LRChartViewIF, ALPTableView as ALPTableIF, LRTableView as LRTableViewIF, TableTypeV4, TableCreationModeType, ViewChartToolBar, SelectionMode, AnnotationPathAsObject, MultiTableModeV4 as MultiTableModeIF } from '../../../../specification/v4';
+import type { ToolBar } from './ToolBar';
+/**
+ * sync rule function for export of creationMode.name
+ * @param manifestSection - section in manifest comprising the table settings
+ * @param configObject - section in config.json describing the table settings
+ * @param key - key or property in config.json
+ * @param manifestKey - key or property in manifest
+ */
 export declare function exportCreationModeName(manifestSection: unknown, configObject: unknown, key: string, manifestKey: string): void;
+/**
+ * sync rule function for the deletion of creationMode.name
+ * @param manifestSection - section in manifest comprising the table settings
+ * @param manifestKey - key or property in manifest
+ */
 export declare function deleteCreationModeName(manifestSection: unknown, manifestKey: string): void;
+/**
+ * sync rule function for export of creationMode.createAtEnd
+ * @param manifestSection - section in manifest comprising the table settings
+ * @param configObject - section in config.json describing the table settings
+ * @param key - key or property in config.json
+ * @param manifestKey - key or property in manifest
+ */
 export declare function exportCreationModeCreateAtEnd(manifestSection: unknown, configObject: unknown, key: string, manifestKey: string): void;
+/**
+ * sync rule function for the deletion of creationMode.createAtEnd
+ * @param manifestSection - section in manifest comprising the table settings
+ * @param manifestKey - key or property in manifest
+ */
 export declare function deleteCreationModeCreateAtEnd(manifestSection: unknown, manifestKey: string): void;
-export declare class TableCreationMode {
+/**********************************
+ * Sync class for TableCreationMode
+ */
+export declare class TableCreationMode implements TableCreationModeIF {
     name?: TableCreationModeType;
     createAtEnd?: boolean;
 }
-export declare class QuickVariantSelectionV4 {
+/**********************************
+ * Sync class for TableCreationMode
+ */
+export declare class ViewTableCreationMode implements ViewTableCreationModeIF {
+    name?: TableCreationModeType;
+    createAtEnd?: boolean;
+}
+/****************************************
+ * Sync class for QuickVariantSelectionV4
+ */
+export declare class QuickVariantSelectionV4 implements QuickVariantSelectionV4IF {
     paths: AnnotationPathAsObject[];
     hideTableTitle?: boolean;
     showCounts?: boolean;
 }
-export declare class MultiTableModeV4 {
-    paths: AnnotationPathWithKey[];
-    showCounts?: boolean;
-}
-export declare class Table implements TableConfig {
+/****************************************
+ * Sync class for TableSettings
+ */
+export declare class TableSettings implements TableSettingsIF {
     type?: TableTypeV4;
     creationMode?: TableCreationMode;
     personalization?: boolean;
@@ -24,8 +61,68 @@ export declare class Table implements TableConfig {
     selectAll?: boolean;
     selectionLimit?: number;
     enableExport?: boolean;
+    quickVariantSelection?: QuickVariantSelectionV4;
     condensedTableLayout?: boolean;
+}
+/****************************************
+ * Sync class for ALPChartView (renamed due to indirection in app schema)
+ */
+export declare class ALPChart implements ALPChartIF {
+    annotationPath: string;
+    toolBar?: ViewChartToolBar;
+}
+/****************************************
+ * Sync class for view table settings
+ */
+export declare class TableViewSettings implements TableSettingsIF {
+    type?: TableTypeV4;
+    creationMode?: TableCreationMode;
+    personalization?: boolean;
+    selectionMode?: SelectionMode;
+    selectAll?: boolean;
+    selectionLimit?: number;
+    enableExport?: boolean;
     quickVariantSelection?: QuickVariantSelectionV4;
+    condensedTableLayout?: boolean;
+}
+/****************************************
+ * Sync class for ALPTableView (renamed due to indirection in app schema)
+ */
+export declare class ALPTable extends TableViewSettings implements ALPTableIF {
+    annotationPath: string;
+    initialLoad?: boolean;
+    toolBar?: ToolBar;
+}
+/****************************************
+ * Sync class for LRChartView
+ */
+export declare class LRChartView implements LRChartViewIF {
+    annotationPath: string;
+    entitySet?: string;
+    toolBar?: ViewChartToolBar;
+}
+/****************************************
+ * Sync class for LRTableView
+ */
+export declare class LRTableView extends TableViewSettings implements LRTableViewIF {
+    annotationPath: string;
+    keepPreviousPersonalization?: boolean;
+    entitySet?: string;
+    toolBar?: ToolBar;
+}
+/**
+ * LR mulit-view: own class for properties on views' level
+ */
+export declare class MultiTableModeV4 implements MultiTableModeIF {
+    [key: string]: LRTableView | LRChartView | boolean;
+    showCounts?: boolean;
+}
+/****************************************
+ * Sync class for Table
+ */
+export declare class Table extends TableSettings implements TableInterface {
+    annotationPath?: string;
     views?: MultiTableModeV4;
     initialLoad?: boolean;
+    toolBar?: ToolBar;
 }

package/dist/src/sync/v4/export/controls/Table.js

@@ -9,6 +9,72 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const common_1 = require("../../../common");
 const decorators_1 = require("../../../common/decoration/decorators");
 const application_1 = require("../../application");
+/**
+ * Special edition of the global function getManifestSectionByPathV4 that initializes the views array if empty
+ * @param manifest - manifest.json
+ * @param path - path to the views array in manifest
+ * @param key - key of the view
+ * @returns the paths array of the views
+ */
+const getManifestSectionByPathV4 = (manifest, path) => {
+    let manifestSection = manifest;
+    for (const element of path.split('/')) {
+        if (!manifestSection[element]) {
+            if (element === 'paths') {
+                manifestSection[element] = [];
+            }
+            else {
+                manifestSection[element] = {};
+            }
+        }
+        manifestSection = manifestSection[element];
+    }
+    return manifestSection;
+};
+/**
+ * Common function that calculates the path in manifest for table settings of a list report or ALP table view
+ * @param pageName - page name in manifest
+ * @param manifest - manifest (not used)
+ * @param targetAnnotationEncoded - encoded target annotation (not used)
+ * @param viewKey - view key (not used)
+ * @param targetAnnotation - target annotation, i.e. the line item (with or without qualifier)
+ * @returns - path as string
+ */
+const getTableSettingsPathForView = (pageName, manifest, targetAnnotationEncoded, viewKey, targetAnnotation) => {
+    const annotationEncoded = targetAnnotation.replace(/\//gi, '??');
+    return application_1.getControlConfigurationPath(pageName) + `/${annotationEncoded}/tableSettings`;
+};
+/**
+ * Common function for determining the path in manifest of a list report view's path
+ * @param pageName - page name in manifest
+ * @param manifest - manifest.json
+ * @param targetAnnotationEncoded - target annotation (not used here)
+ * @param viewKey - value of the key property of the view
+ * @returns the path to the entry in manifest
+ */
+function getSettingsPathForLRViewsPath(pageName, manifest, targetAnnotationEncoded, viewKey) {
+    const viewsPath = application_1.getSettingsPathForLRViewsPaths(pageName);
+    const manifestSection = getManifestSectionByPathV4(JSON.parse(JSON.stringify(manifest)), viewsPath);
+    let path;
+    for (let index = 0; index < manifestSection.length; index++) {
+        const view = manifestSection[index];
+        if (view && view[common_1.SchemaTag.key] === viewKey) {
+            path = `${viewsPath}/${index}`;
+            break;
+        }
+    }
+    if (!path) {
+        path = `${viewsPath}/[]`;
+    }
+    return path;
+}
+/**
+ * sync rule function for export of creationMode.name
+ * @param manifestSection - section in manifest comprising the table settings
+ * @param configObject - section in config.json describing the table settings
+ * @param key - key or property in config.json
+ * @param manifestKey - key or property in manifest
+ */
 function exportCreationModeName(manifestSection, configObject, key, manifestKey) {
     if (typeof manifestSection['creationMode'] === 'object') {
         manifestSection['creationMode'][manifestKey] = configObject[key];
@@ -18,6 +84,11 @@ function exportCreationModeName(manifestSection, configObject, key, manifestKey)
     }
 }
 exports.exportCreationModeName = exportCreationModeName;
+/**
+ * sync rule function for the deletion of creationMode.name
+ * @param manifestSection - section in manifest comprising the table settings
+ * @param manifestKey - key or property in manifest
+ */
 function deleteCreationModeName(manifestSection, manifestKey) {
     if (typeof manifestSection['creationMode'] === 'object' &&
         manifestSection['creationMode'][manifestKey] !== undefined) {
@@ -28,6 +99,26 @@ function deleteCreationModeName(manifestSection, manifestKey) {
     }
 }
 exports.deleteCreationModeName = deleteCreationModeName;
+/**
+ * sync rule deleting a view if the annotation path gets deleted
+ * @param manifestSection - manifest section of the given view
+ */
+function deleteView(manifestSection) {
+    Object.keys(manifestSection).forEach((key) => delete manifestSection[key]);
+}
+/**
+ * sync rule for preventing the deletion of a property
+ */
+function doNotDelete() {
+    return;
+}
+/**
+ * sync rule function for export of creationMode.createAtEnd
+ * @param manifestSection - section in manifest comprising the table settings
+ * @param configObject - section in config.json describing the table settings
+ * @param key - key or property in config.json
+ * @param manifestKey - key or property in manifest
+ */
 function exportCreationModeCreateAtEnd(manifestSection, configObject, key, manifestKey) {
     if (typeof manifestSection['creationMode'] === 'object') {
         manifestSection['creationMode'][manifestKey] = configObject[key];
@@ -41,6 +132,11 @@ function exportCreationModeCreateAtEnd(manifestSection, configObject, key, manif
     }
 }
 exports.exportCreationModeCreateAtEnd = exportCreationModeCreateAtEnd;
+/**
+ * sync rule function for the deletion of creationMode.createAtEnd
+ * @param manifestSection - section in manifest comprising the table settings
+ * @param manifestKey - key or property in manifest
+ */
 function deleteCreationModeCreateAtEnd(manifestSection, manifestKey) {
     if (typeof manifestSection['creationMode'] === 'object' &&
         manifestSection['creationMode'][manifestKey] !== undefined) {
@@ -48,6 +144,25 @@ function deleteCreationModeCreateAtEnd(manifestSection, manifestKey) {
     }
 }
 exports.deleteCreationModeCreateAtEnd = deleteCreationModeCreateAtEnd;
+/**
+ * sync rule for the import of creationMode, does an implicit conversion of the former string value to the new object representation
+ * @param tableSettings - table settings in manifest, to be analyzed
+ * @returns - object rpresenting the value(s) for the config file
+ */
+function importCreationMode(tableSettings) {
+    const value = tableSettings['creationMode'];
+    if (typeof value === 'object') {
+        return value;
+    }
+    else if (typeof value === 'string') {
+        return {
+            name: value
+        };
+    }
+}
+/**********************************
+ * Sync class for TableCreationMode
+ */
 class TableCreationMode {
 }
 __decorate([
@@ -77,6 +192,41 @@ __decorate([
     })
 ], TableCreationMode.prototype, "createAtEnd", void 0);
 exports.TableCreationMode = TableCreationMode;
+/**********************************
+ * Sync class for TableCreationMode
+ */
+class ViewTableCreationMode {
+}
+__decorate([
+    decorators_1.syncRule({
+        manifest: {
+            path: getTableSettingsPathForView,
+            export: (manifestSection, configObject, key, manifestKey) => {
+                exportCreationModeName(manifestSection, configObject, key, manifestKey);
+            },
+            delete: (manifestSection, configObject, key, manifestKey) => {
+                deleteCreationModeName(manifestSection, manifestKey);
+            }
+        }
+    })
+], ViewTableCreationMode.prototype, "name", void 0);
+__decorate([
+    decorators_1.syncRule({
+        manifest: {
+            path: getTableSettingsPathForView,
+            export: (manifestSection, configObject, key, manifestKey) => {
+                exportCreationModeCreateAtEnd(manifestSection, configObject, key, manifestKey);
+            },
+            delete: (manifestSection, configObject, key, manifestKey) => {
+                deleteCreationModeCreateAtEnd(manifestSection, manifestKey);
+            }
+        }
+    })
+], ViewTableCreationMode.prototype, "createAtEnd", void 0);
+exports.ViewTableCreationMode = ViewTableCreationMode;
+/****************************************
+ * Sync class for QuickVariantSelectionV4
+ */
 class QuickVariantSelectionV4 {
 }
 __decorate([
@@ -101,25 +251,32 @@ __decorate([
     })
 ], QuickVariantSelectionV4.prototype, "showCounts", void 0);
 exports.QuickVariantSelectionV4 = QuickVariantSelectionV4;
-class MultiTableModeV4 {
+/****************************************
+ * Sync class for TableSettings
+ */
+class TableSettings {
 }
 __decorate([
     decorators_1.syncRule({
         manifest: {
-            path: (entitySet) => application_1.getSettingsPathForPage(entitySet) + '/views'
+            path: (entitySet) => application_1.getTableSettingsPathForLR(entitySet)
         }
+    }),
+    decorators_1.validity({
+        since: '1.84.0'
     })
-], MultiTableModeV4.prototype, "paths", void 0);
+], TableSettings.prototype, "type", void 0);
 __decorate([
     decorators_1.syncRule({
         manifest: {
-            path: (entitySet) => application_1.getSettingsPathForPage(entitySet) + '/views'
+            path: application_1.getTableSettingsPathForLR,
+            import: importCreationMode
         }
+    }),
+    decorators_1.validity({
+        since: '1.84.0'
     })
-], MultiTableModeV4.prototype, "showCounts", void 0);
-exports.MultiTableModeV4 = MultiTableModeV4;
-class Table {
-}
+], TableSettings.prototype, "creationMode", void 0);
 __decorate([
     decorators_1.syncRule({
         manifest: {
@@ -127,30 +284,19 @@ __decorate([
         }
     }),
     decorators_1.validity({
-        since: '1.84.0'
+        since: '1.86.0'
     })
-], Table.prototype, "type", void 0);
+], TableSettings.prototype, "personalization", void 0);
 __decorate([
     decorators_1.syncRule({
         manifest: {
-            path: (entitySet) => application_1.getTableSettingsPathForLR(entitySet),
-            import: (tableSettings) => {
-                const value = tableSettings['creationMode'];
-                if (typeof value === 'object') {
-                    return value;
-                }
-                else if (typeof value === 'string') {
-                    return {
-                        name: value
-                    };
-                }
-            }
+            path: (entitySet) => application_1.getTableSettingsPathForLR(entitySet)
         }
     }),
     decorators_1.validity({
         since: '1.84.0'
     })
-], Table.prototype, "creationMode", void 0);
+], TableSettings.prototype, "selectionMode", void 0);
 __decorate([
     decorators_1.syncRule({
         manifest: {
@@ -158,9 +304,9 @@ __decorate([
         }
     }),
     decorators_1.validity({
-        since: '1.86.0'
+        since: '1.84.0'
     })
-], Table.prototype, "personalization", void 0);
+], TableSettings.prototype, "selectAll", void 0);
 __decorate([
     decorators_1.syncRule({
         manifest: {
@@ -170,7 +316,7 @@ __decorate([
     decorators_1.validity({
         since: '1.84.0'
     })
-], Table.prototype, "selectionMode", void 0);
+], TableSettings.prototype, "selectionLimit", void 0);
 __decorate([
     decorators_1.syncRule({
         manifest: {
@@ -180,7 +326,7 @@ __decorate([
     decorators_1.validity({
         since: '1.84.0'
     })
-], Table.prototype, "selectAll", void 0);
+], TableSettings.prototype, "enableExport", void 0);
 __decorate([
     decorators_1.syncRule({
         manifest: {
@@ -190,7 +336,7 @@ __decorate([
     decorators_1.validity({
         since: '1.84.0'
     })
-], Table.prototype, "selectionLimit", void 0);
+], TableSettings.prototype, "quickVariantSelection", void 0);
 __decorate([
     decorators_1.syncRule({
         manifest: {
@@ -200,27 +346,132 @@ __decorate([
     decorators_1.validity({
         since: '1.84.0'
     })
-], Table.prototype, "enableExport", void 0);
+], TableSettings.prototype, "condensedTableLayout", void 0);
+exports.TableSettings = TableSettings;
+/****************************************
+ * Sync class for ALPChartView (renamed due to indirection in app schema)
+ */
+class ALPChart {
+}
 __decorate([
     decorators_1.syncRule({
         manifest: {
-            path: (entitySet) => application_1.getTableSettingsPathForLR(entitySet)
+            path: (entitySet) => application_1.getSettingsPathForPage(entitySet) + '/views/paths/0/primary/0',
+            delete: deleteView
+        }
+    })
+], ALPChart.prototype, "annotationPath", void 0);
+exports.ALPChart = ALPChart;
+/****************************************
+ * Sync class for view table settings
+ */
+class TableViewSettings {
+}
+__decorate([
+    decorators_1.syncRule({
+        manifest: {
+            path: getTableSettingsPathForView
         }
     }),
     decorators_1.validity({
         since: '1.84.0'
     })
-], Table.prototype, "condensedTableLayout", void 0);
+], TableViewSettings.prototype, "type", void 0);
 __decorate([
     decorators_1.syncRule({
         manifest: {
-            path: (entitySet) => application_1.getTableSettingsPathForLR(entitySet)
+            path: getTableSettingsPathForView,
+            import: importCreationMode
         }
     }),
     decorators_1.validity({
         since: '1.84.0'
     })
-], Table.prototype, "quickVariantSelection", void 0);
+], TableViewSettings.prototype, "creationMode", void 0);
+__decorate([
+    decorators_1.syncRule({
+        manifest: {
+            path: getTableSettingsPathForView
+        }
+    }),
+    decorators_1.validity({
+        since: '1.86.0'
+    })
+], TableViewSettings.prototype, "personalization", void 0);
+__decorate([
+    decorators_1.syncRule({
+        manifest: {
+            path: getTableSettingsPathForView
+        }
+    }),
+    decorators_1.validity({
+        since: '1.84.0'
+    })
+], TableViewSettings.prototype, "selectionMode", void 0);
+__decorate([
+    decorators_1.syncRule({
+        manifest: {
+            path: getTableSettingsPathForView
+        }
+    }),
+    decorators_1.validity({
+        since: '1.84.0'
+    })
+], TableViewSettings.prototype, "selectAll", void 0);
+__decorate([
+    decorators_1.syncRule({
+        manifest: {
+            path: getTableSettingsPathForView
+        }
+    }),
+    decorators_1.validity({
+        since: '1.84.0'
+    })
+], TableViewSettings.prototype, "selectionLimit", void 0);
+__decorate([
+    decorators_1.syncRule({
+        manifest: {
+            path: getTableSettingsPathForView
+        }
+    }),
+    decorators_1.validity({
+        since: '1.84.0'
+    })
+], TableViewSettings.prototype, "enableExport", void 0);
+__decorate([
+    decorators_1.syncRule({
+        manifest: {
+            path: getTableSettingsPathForView
+        }
+    }),
+    decorators_1.validity({
+        since: '1.84.0'
+    })
+], TableViewSettings.prototype, "quickVariantSelection", void 0);
+__decorate([
+    decorators_1.syncRule({
+        manifest: {
+            path: getTableSettingsPathForView
+        }
+    }),
+    decorators_1.validity({
+        since: '1.84.0'
+    })
+], TableViewSettings.prototype, "condensedTableLayout", void 0);
+exports.TableViewSettings = TableViewSettings;
+/****************************************
+ * Sync class for ALPTableView (renamed due to indirection in app schema)
+ */
+class ALPTable extends TableViewSettings {
+}
+__decorate([
+    decorators_1.syncRule({
+        manifest: {
+            path: (entitySet) => application_1.getSettingsPathForPage(entitySet) + '/views/paths/0/secondary/0',
+            delete: doNotDelete
+        }
+    })
+], ALPTable.prototype, "annotationPath", void 0);
 __decorate([
     decorators_1.syncRule({
         manifest: {
@@ -230,7 +481,83 @@ __decorate([
     decorators_1.validity({
         since: '1.84.0'
     })
-], Table.prototype, "views", void 0);
+], ALPTable.prototype, "initialLoad", void 0);
+exports.ALPTable = ALPTable;
+/****************************************
+ * Sync class for LRChartView
+ */
+class LRChartView {
+}
+__decorate([
+    decorators_1.syncRule({
+        manifest: {
+            path: getSettingsPathForLRViewsPath,
+            delete: deleteView
+        }
+    })
+], LRChartView.prototype, "annotationPath", void 0);
+__decorate([
+    decorators_1.syncRule({
+        manifest: {
+            path: getSettingsPathForLRViewsPath
+        }
+    })
+], LRChartView.prototype, "entitySet", void 0);
+exports.LRChartView = LRChartView;
+/****************************************
+ * Sync class for LRTableView
+ */
+class LRTableView extends TableViewSettings {
+}
+__decorate([
+    decorators_1.syncRule({
+        manifest: {
+            path: getSettingsPathForLRViewsPath,
+            delete: deleteView
+        }
+    })
+], LRTableView.prototype, "annotationPath", void 0);
+__decorate([
+    decorators_1.syncRule({
+        manifest: {
+            path: getSettingsPathForLRViewsPath
+        }
+    })
+], LRTableView.prototype, "keepPreviousPersonalization", void 0);
+__decorate([
+    decorators_1.syncRule({
+        manifest: {
+            path: getSettingsPathForLRViewsPath
+        }
+    })
+], LRTableView.prototype, "entitySet", void 0);
+exports.LRTableView = LRTableView;
+/**
+ * LR mulit-view: own class for properties on views' level
+ */
+class MultiTableModeV4 {
+}
+__decorate([
+    decorators_1.syncRule({
+        manifest: {
+            path: (entitySet) => application_1.getSettingsPathForPage(entitySet) + '/views'
+        }
+    })
+], MultiTableModeV4.prototype, "showCounts", void 0);
+exports.MultiTableModeV4 = MultiTableModeV4;
+/****************************************
+ * Sync class for Table
+ */
+class Table extends TableSettings {
+}
+__decorate([
+    decorators_1.syncRule({
+        manifest: {
+            path: (entitySet) => application_1.getSettingsPathForPage(entitySet) + '/views/paths/0/secondary/0',
+            delete: doNotDelete
+        }
+    })
+], Table.prototype, "annotationPath", void 0);
 __decorate([
     decorators_1.syncRule({
         manifest: {