@sap/ux-specification 1.120.36 → 1.120.38

package/dist/specification/src/sync/v4/generate/objectPage.js

@@ -3,6 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.addGroupedHeaderActions = addGroupedHeaderActions;
 exports.generateObjectPageSchemaV4 = generateObjectPageSchemaV4;
 const i18next_1 = __importDefault(require("i18next"));
 const extensionLogger_1 = require("../../../extensionLogger");
@@ -21,37 +22,56 @@ const CRITICAL_ACTION_TYPES = [
 ];
 const CUSTOM_ACTION_DEFINITION_DESCRIPTION = 'Custom Action';
 /**
- * V4 callback - adds a single header action to schema
- * @param {ConvertedMetadata} oDataServiceAVT - complete service information, as returned by annotation vocabularies tool
- * @param {ActionListType} action - item of the Ui.Identification collection and its original index
- * @param {ActionType} actionType - action classification for grouping
- * @param {Definition} appSchema Schema of the app
- * @param {EntityType} entityType - current entity type
- * @param {Definition} headerActions - list of header actions, to be enhanced
+ * V4 callback - adds a single header action to schema.
+ *
+ * @param oDataServiceAVT - Complete service information, as returned by annotation vocabularies tool.
+ * @param action - Item of the Ui.Identification collection and its original index.
+ * @param actionType - Action classification for grouping.
+ * @param appSchema - Schema of the app.
+ * @param entityType - Current entity type.
+ * @param headerActions - List of header actions, to be enhanced.
+ * @param index - The index of the action in the header actions list.
  */
 function addSingleHeaderActionV4(oDataServiceAVT, action, actionType, appSchema, entityType, headerActions, index) {
     const { actionName, namespace } = (0, common_1.getActionNameAndId)(action.item, oDataServiceAVT);
     const stableId = (0, StableIdHelper_1.getStableIdPartFromDataField)(action.item);
+    const actionEntityType = action.item['$Type'];
+    const isActionGroup = actionEntityType === "com.sap.vocabularies.UI.v1.DataFieldForActionGroup" /* UIAnnotationTypes.DataFieldForActionGroup */;
+    const actionDefinitionType = isActionGroup
+        ? ux_specification_types_1.DefinitionName.ObjectPageHeaderActionGroup
+        : ux_specification_types_1.DefinitionName.ObjectPageHeaderAction;
     //stableId is used as key in V4, as the DataFieldForAction:: prefix shall be present in manifest settings
     const convertedIdentification = action.item['fullyQualifiedName'].replace(`@${"com.sap.vocabularies.UI.v1.Identification" /* UIAnnotationTerms.Identification */}`, `/@${"com.sap.vocabularies.UI.v1.Identification" /* UIAnnotationTerms.Identification */}`);
-    const actionDefinitionKey = `ObjectPageHeaderAction<${(0, common_1.prepareRef)(stableId)}>`;
+    const actionDefinitionKey = `${actionDefinitionType}<${(0, common_1.prepareRef)(stableId)}>`;
     const headerAction = (appSchema.definitions[actionDefinitionKey] = {
         type: 'object',
-        $ref: `${common_1.DEFINITION_LINK_PREFIX}${ux_specification_types_1.DefinitionName.ObjectPageHeaderAction}`,
+        $ref: `${common_1.DEFINITION_LINK_PREFIX}${actionDefinitionType}`,
         description: (0, common_1.getDataFieldDescription)(action.item, entityType)
     });
     headerAction[ux_specification_types_1.SchemaTag.isViewNode] = true;
     headerAction[ux_specification_types_1.SchemaTag.dataType] = (0, common_1.determineDataType)(action.item);
     headerAction[ux_specification_types_1.SchemaTag.propertyIndex] = index;
-    //keys
-    headerAction[ux_specification_types_1.SchemaTag.keys] = [];
-    if (action.item[ux_specification_types_1.SchemaKeyName.semanticObject]) {
-        headerAction[ux_specification_types_1.SchemaTag.keys].push({
-            name: ux_specification_types_1.SchemaKeyName.semanticObject,
-            value: action.item[ux_specification_types_1.SchemaKeyName.semanticObject]
-        });
+    if (isActionGroup) {
+        headerAction['properties'] = {};
+        // add a warning message for all versions that don't support action groups
+        (0, common_1.addMessageToSchema)(headerAction, i18next_1.default.t('ACTION_GROUPS_ARENT_SUPPORTED'));
+        const subActions = (action.item['Actions'] ?? []).map((groupedAction, index) => ({
+            item: groupedAction,
+            index
+        }));
+        addGroupedHeaderActions(subActions, oDataServiceAVT, appSchema, entityType, headerAction, ux_specification_types_1.ActionType.Annotation);
+    }
+    else {
+        //keys
+        headerAction[ux_specification_types_1.SchemaTag.keys] = [];
+        if (action.item[ux_specification_types_1.SchemaKeyName.semanticObject]) {
+            headerAction[ux_specification_types_1.SchemaTag.keys].push({
+                name: ux_specification_types_1.SchemaKeyName.semanticObject,
+                value: action.item[ux_specification_types_1.SchemaKeyName.semanticObject]
+            });
+        }
+        headerAction[ux_specification_types_1.SchemaTag.keys].push({ name: ux_specification_types_1.SchemaKeyName.action, value: actionName });
     }
-    headerAction[ux_specification_types_1.SchemaTag.keys].push({ name: ux_specification_types_1.SchemaKeyName.action, value: actionName });
     if (namespace) {
         appSchema.definitions[actionDefinitionKey][ux_specification_types_1.SchemaTag.target] = namespace;
     }
@@ -64,13 +84,13 @@ function addSingleHeaderActionV4(oDataServiceAVT, action, actionType, appSchema,
     headerActions.properties[stableId][ux_specification_types_1.SchemaTag.propertyIndex] = index;
 }
 /**
- * Adds a given standard action to the app schema of the object page
- * @param {string} actionName  - name of the action
- * @param {Definition} appSchema - schema of the object page
- * @param {Definition} headerActions - list of header actions, to be enhanced
- * @param {number} index - index for propertyIndex
+ * Adds a given standard action to the app schema of the object page.
  *
- * @returns the new header action definition
+ * @param actionName - Name of the action.
+ * @param appSchema - Schema of the object page.
+ * @param headerActions - List of header actions, to be enhanced.
+ * @param index - Index for propertyIndex.
+ * @returns The new header action definition.
  */
 function addStandardHeaderAction(actionName, appSchema, headerActions, index) {
     const referenceKey = `${actionName}Action`;
@@ -94,12 +114,14 @@ function addStandardHeaderAction(actionName, appSchema, headerActions, index) {
     return headerAction;
 }
 /**
- * V4 callback - adds a single footer action to schema
- * @param {ActionListType} action - item of the Ui.Identification collection and its original index
- * @param {ActionType} actionType - action classification for grouping
- * @param {EntityType} entityType - current entity type
- * @param {Definition} appSchema - schema of the object page
- * @param {Definition} footerActions - list of footer actions, to be enhanced
+ * V4 callback - adds a single footer action to schema.
+ *
+ * @param action - Item of the Ui.Identification collection and its original index.
+ * @param actionType - Action classification for grouping.
+ * @param entityType - Current entity type.
+ * @param appSchema - Schema of the object page.
+ * @param footerActions - List of footer actions, to be enhanced.
+ * @param index - The index of the action in the footer actions list.
  */
 function addSingleFooterAction(action, actionType, entityType, appSchema, footerActions, index) {
     const actionId = (0, StableIdHelper_1.getStableIdPartFromDataField)(action.item);
@@ -120,15 +142,17 @@ function addSingleFooterAction(action, actionType, entityType, appSchema, footer
     };
 }
 /**
- * Distiguishes critical actions and others and returns two separate groups
- * @param {any} identification - UI.Identification annotation as present in AVT ConvertedMetadata
- * @returns two separate groups of items
+ * Distinguishes critical actions and others and returns two separate groups.
+ *
+ * @param identification - UI.Identification annotation as present in AVT ConvertedMetadata.
+ * @returns Two separate groups of items.
  */
 function groupByCriticality(identification) {
     const criticalActions = [];
     const unCriticalActions = [];
     identification.forEach((item, index) => {
         if ((!item['Determining'] && item.$Type === "com.sap.vocabularies.UI.v1.DataFieldForAction" /* UIAnnotationTypes.DataFieldForAction */) ||
+            item.$Type === "com.sap.vocabularies.UI.v1.DataFieldForActionGroup" /* UIAnnotationTypes.DataFieldForActionGroup */ ||
             item.$Type === "com.sap.vocabularies.UI.v1.DataFieldForIntentBasedNavigation" /* UIAnnotationTypes.DataFieldForIntentBasedNavigation */) {
             if (CRITICAL_ACTION_TYPES.includes(item['Criticality'])) {
                 criticalActions.push({ index, item });
@@ -140,22 +164,10 @@ function groupByCriticality(identification) {
     });
     return { criticalActions, unCriticalActions };
 }
-/**
- * Adds the critical header actions to schema
- * @param {ActionListType[]} criticalActions - list of critical actions
- * @param {ConvertedMetadata} oDataServiceAVT - complete service information, as returned by annotation vocabularies tool
- * @param {Definition} appSchema - schema of the object page
- * @param {EntityType} entityType - current entity type
- * @param {Definition} headerActions - list of all header actions
- */
-function addCriticalActions(criticalActions, oDataServiceAVT, appSchema, entityType, headerActions) {
-    for (let index = 0; index < criticalActions.length; index++) {
-        addSingleHeaderActionV4(oDataServiceAVT, criticalActions[index], ux_specification_types_1.ActionType.Criticality, appSchema, entityType, headerActions, index);
-    }
-}
 /**
  * Checks if one of the uncritical actions is marked by isCopyAction.
  * If so, adds this first to the schema and deletes it from the list.
+ *
  * @param {ActionListType[]} unCriticalActions - list of uncritical actions
  * @param {ConvertedMetadata} oDataServiceAVT - complete service information, as returned by annotation vocabularies tool
  * @param {Definition} appSchema - schema of the object page
@@ -174,22 +186,27 @@ function addCopyAction(unCriticalActions, oDataServiceAVT, appSchema, entityType
     }
 }
 /**
- * Adds the critical header actions to schema
- * @param {ActionListType[]} unCriticalActions - list of uncritical actions
- * @param {ConvertedMetadata} oDataServiceAVT - complete service information, as returned by annotation vocabularies tool
- * @param {Definition} appSchema - schema of the object page
- * @param {EntityType} entityType - current entity type
- * @param {Definition} headerActions - list of all header actions
- * @param {number} nextIndex - index for propertyIndex
+ * Adds a list of actions to the header actions in the application schema.
+ *
+ * @param {ActionListType[]} actions - The list of actions to be added.
+ * @param {ConvertedMetadata} oDataServiceAVT - The converted metadata service containing OData service annotations.
+ * @param {Definition} appSchema - The application schema definition where actions will be added.
+ * @param {EntityType} entityType - The entity type for which the actions are applicable.
+ * @param {Definition} headerActions - The definition where the header actions will be appended.
+ * @param {ActionType} actionType - The type of actions to be processed and added.
+ * @param {number} [startingIndex] - The starting index for assigning actions in the header actions definition.
+ * @returns {void} This function does not return a value.
  */
-function addUncriticalActions(unCriticalActions, oDataServiceAVT, appSchema, entityType, headerActions, nextIndex) {
-    for (const action of unCriticalActions) {
-        addSingleHeaderActionV4(oDataServiceAVT, action, ux_specification_types_1.ActionType.Annotation, appSchema, entityType, headerActions, nextIndex);
+function addGroupedHeaderActions(actions, oDataServiceAVT, appSchema, entityType, headerActions, actionType, startingIndex = 0) {
+    let nextIndex = startingIndex;
+    for (const action of actions) {
+        addSingleHeaderActionV4(oDataServiceAVT, action, actionType, appSchema, entityType, headerActions, nextIndex);
         nextIndex++;
     }
 }
 /**
- * Adds the critical header actions to schema
+ * Adds the critical header actions to schema.
+ *
  * @param {Definition} headerActions - list of all header actions
  */
 function addRelatedAppsButton(headerActions) {
@@ -207,6 +224,7 @@ function addRelatedAppsButton(headerActions) {
 }
 /**
  * Fills the annotationPath of the given schema definition, by checking first the EntitySet annotation, then the EntityType annotation.
+ *
  * @param {Definition} schemaDefinition - current definition in the schema
  * @param {EntitySet} entitySet - current entity set
  * @param {EntityType} entityType - current entity type
@@ -223,18 +241,19 @@ function setAnnotationPathFromEntitySetOrEntityType(schemaDefinition, entitySet,
     }
 }
 /**
- * Callback for adding a single action to headerActions of V4
- * @param {EntityType} entityType - current entity type
- * @param {Definition} appSchema - schema of the object page
- * @param {any} identification - UI.Identification annotation as present in AVT ConvertedMetadata
- * @param {Definition} headerActions - list of header actions, to be enhanced
- * @param {GenerateAppSchemaParameters} generateParameters - list of API input parameters
- * @param {SapUiAppPageV4} pageInManifest - current page in manifest
+ * Callback for adding a single action to headerActions of V4.
+ *
+ * @param entityType - current entity type
+ * @param appSchema - schema of the object page
+ * @param identification - UI.Identification annotation as present in AVT ConvertedMetadata
+ * @param headerActions - list of header actions, to be enhanced
+ * @param generateParameters - list of API input parameters
+ * @param pageInManifest - current page in manifest
  */
 function addHeaderActionCallBackV4(entityType, appSchema, identification, headerActions, generateParameters, pageInManifest) {
     //Build groups of action types
     const { criticalActions = [], unCriticalActions = [] } = identification ? groupByCriticality(identification) : {};
-    addCriticalActions(criticalActions, generateParameters.serviceAVT, appSchema, entityType, headerActions);
+    addGroupedHeaderActions(criticalActions, generateParameters.serviceAVT, appSchema, entityType, headerActions, ux_specification_types_1.ActionType.Criticality);
     if (generateParameters.entitySet) {
         const isDeletable = (0, utils_2.isEntityDeletable)(generateParameters.entitySet);
         const isUpdatable = (0, utils_2.isEntityUpdatable)(generateParameters.entitySet);
@@ -253,13 +272,14 @@ function addHeaderActionCallBackV4(entityType, appSchema, identification, header
     const nextIndex = criticalActions.length + 2;
     //Check if isCopyAction is defined, this gets rendered first after delete
     addCopyAction(unCriticalActions, generateParameters.serviceAVT, appSchema, entityType, headerActions, nextIndex);
-    addUncriticalActions(unCriticalActions, generateParameters.serviceAVT, appSchema, entityType, headerActions, nextIndex);
+    addGroupedHeaderActions(unCriticalActions, generateParameters.serviceAVT, appSchema, entityType, headerActions, ux_specification_types_1.ActionType.Annotation, nextIndex);
     // Add custom header actions
     addHeaderFooterCustomActionsOP(appSchema, pageInManifest, ux_specification_types_1.DefinitionName.CustomHeaderActionOP, generateParameters.logger);
     addRelatedAppsButton(headerActions);
 }
 /**
- * Callback for adding a single action to footerActions of V4
+ * Callback for adding a single action to footerActions of V4.
+ *
  * @param {EntityType} entityType - current entity type
  * @param {Definition} appSchema - schema of the object page
  * @param {Definition} footerActions - list of footer actions, to be enhanced
@@ -288,12 +308,13 @@ function addFooterActionCallBackV4(entityType, appSchema, footerActions, identif
     }
 }
 /**
- * Object Page specific enhancements to addCustomColumnDefinition
- * @param {object} appSchema - app schema of the object page
- * @param {SapUiAppPageV4} v4Page Current page in manifest
- * @param {string} lineItemId - identifier of the current table in schema
- * @param {string} facetIdInManifest - identifier of the current object page section in manifest
- * @param {ExtensionLogger} logger - logger for exceptions
+ * Object Page specific enhancements to addCustomColumnDefinition.
+ *
+ * @param appSchema - app schema of the object page
+ * @param v4Page Current page in manifest
+ * @param lineItemId - identifier of the current table in schema
+ * @param facetIdInManifest - identifier of the current object page section in manifest
+ * @param logger - logger for exceptions
  */
 function addCustomColumnsOP(appSchema, v4Page, lineItemId, facetIdInManifest, logger) {
     // Create type specific copy of 'TableCustomColumnOP'
@@ -321,12 +342,13 @@ function addCustomColumnsOP(appSchema, v4Page, lineItemId, facetIdInManifest, lo
     }
 }
 /**
- * Object Page specific enhancements to addCustomColumnDefinition
- * @param {object} appSchema - app schema of the object page
- * @param {SapUiAppPageV4} v4Page Current page in manifest
- * @param {string} lineItemId - identifier of the current table in schema
- * @param {string} facetIdInManifest - identifier of the current object page section in manifest
- * @param {ExtensionLogger} logger - logger for exceptions
+ * Object Page specific enhancements to addCustomColumnDefinition.
+ *
+ * @param appSchema - app schema of the object page
+ * @param v4Page Current page in manifest
+ * @param lineItemId - identifier of the current table in schema
+ * @param facetIdInManifest - identifier of the current object page section in manifest
+ * @param logger - logger for exceptions
  */
 function addTableCustomActionsOP(appSchema, v4Page, lineItemId, facetIdInManifest, logger) {
     // Create type specific copy of 'TableCustomActionOP'
@@ -353,11 +375,12 @@ function addTableCustomActionsOP(appSchema, v4Page, lineItemId, facetIdInManifes
     (0, utils_1.addEnumForActionAnchor)(appSchema, schemaIdForActions, positionId);
 }
 /**
- * Object Page specific custom action enhancements to header and footer
- * @param {object} appSchema - app schema of the object page
- * @param {SapUiAppPageV4} v4Page  - current page in manifest
- * @param {DefinitionName} customActionDefinitionKey - custom action key used in definitions
- * @param {ExtensionLogger} logger - logger for exceptions
+ * Object Page specific custom action enhancements to header and footer.
+ *
+ * @param appSchema - app schema of the object page
+ * @param v4Page  - current page in manifest
+ * @param customActionDefinitionKey - custom action key used in definitions
+ * @param logger - logger for exceptions
  */
 function addHeaderFooterCustomActionsOP(appSchema, v4Page, customActionDefinitionKey, logger) {
     const customActionDefinition = appSchema.definitions[customActionDefinitionKey];
@@ -384,14 +407,13 @@ function addHeaderFooterCustomActionsOP(appSchema, v4Page, customActionDefinitio
  * Adds a table definition to the application schema based on the provided configuration.
  * This method defines the properties and annotations required for the table in the schema.
  *
- * @param {AddTableDefinitionProps} params - The parameters for adding the table definition.
- * @param {string} params.tableType - The type of the table to be added. For example, AnalyticalTable or ResponsiveTable.
- * @param {string} params.facetKey - The key identifying the facet for which the table is being defined.
- * @param {FacetConfig} params.facet - The configuration object defining the properties of the facet.
- * @param {Definition} params.appSchema - The overall application schema where the table definition should be added.
- * @param {string} params.lineItemId - Optional ID for the line item, defaults to a generated schema facet key.
- * @param {FacetConfig} params.lineItemFacet - The current line item facet configuration.
- * @returns {void}
+ * @param params - The parameters for adding the table definition.
+ * @param params.tableType - The type of the table to be added. For example, AnalyticalTable or ResponsiveTable.
+ * @param params.facetKey - The key identifying the facet for which the table is being defined.
+ * @param params.facet - The configuration object defining the properties of the facet.
+ * @param params.appSchema - The overall application schema where the table definition should be added.
+ * @param params.lineItemId - Optional ID for the line item, defaults to a generated schema facet key.
+ * @param params.lineItemFacet - The current line item facet configuration.
  */
 function addTableDefinition({ tableType, facetKey, facet, appSchema, lineItemId, lineItemFacet }) {
     const index = facetKey.lastIndexOf('::');
@@ -408,12 +430,13 @@ function addTableDefinition({ tableType, facetKey, facet, appSchema, lineItemId,
     tableDefinition[ux_specification_types_1.SchemaTag.target] = lineItemFacet.namespace;
 }
 /**
- * Object Page specific enhancements to handleFormIdentification
- * @param {object} appSchema - app schema of the object page
- * @param {SapUiAppPageV4} v4Page - current page in manifest
- * @param {string} formItemId - identifier of the current form in schema
- * @param {string} facetIdInManifest - identifier of the current object page section in manifest
- * @param {ExtensionLogger} logger - logger for exceptions
+ * Object Page specific enhancements to handleFormIdentification.
+ *
+ * @param appSchema - app schema of the object page
+ * @param v4Page - current page in manifest
+ * @param formItemId - identifier of the current form in schema
+ * @param facetIdInManifest - identifier of the current object page section in manifest
+ * @param logger - logger for exceptions
  */
 function addFormCustomActionsOP(appSchema, v4Page, formItemId, facetIdInManifest, logger) {
     const customActionDefinitionKey = `${ux_specification_types_1.DefinitionName.CustomFormActionOP}<${formItemId}>`;
@@ -435,14 +458,15 @@ function addFormCustomActionsOP(appSchema, v4Page, formItemId, facetIdInManifest
     }
 }
 /**
- * Adds definitions for line items in object page sections to the app schema
- * @param {FacetConfig} facet - the given facet from the UI annotations
- * @param {string} facetKey - key of the facet, as used in annotation
- * @param {Definition} appSchema - app schema of the object page
- * @param {object} lineItemFacet - current lineItem facet
- * @param {ConvertedMetadata} oDataServiceAVT - complete service information, as returned by annotation vocabularies tool
- * @param {SapUiAppPageV4} v4Page Current page in manifest
- * @param {ExtensionLogger} logger - logger for exceptions
+ * Adds definitions for line items in object page sections to the app schema.
+ *
+ * @param facet - the given facet from the UI annotations
+ * @param facetKey - key of the facet, as used in annotation
+ * @param appSchema - app schema of the object page
+ * @param lineItemFacet - current lineItem facet
+ * @param oDataServiceAVT - complete service information, as returned by annotation vocabularies tool
+ * @param v4Page Current page in manifest
+ * @param logger - logger for exceptions
  */
 function handleLineItem(facet, facetKey, appSchema, lineItemFacet, oDataServiceAVT, v4Page, logger) {
     const lineItemId = (0, common_1.getFacetKeyInSchema)(facetKey);
@@ -481,15 +505,14 @@ function handleLineItem(facet, facetKey, appSchema, lineItemFacet, oDataServiceA
 /**
  * Handles the creation and modification of a section table within the application schema.
  *
- * @param {FacetConfig} facet - The facet configuration object containing details for the section.
- * @param {string} facetKey - The unique key for identifying the facet in the schema.
- * @param {Definition} appSchema - The overall application schema where the section table is defined.
- * @param {FacetConfig} lineItemFacet - The facet configuration specific to line item processing.
- * @param {GenerateAppSchemaParameters} generateParameters - Parameters required for generating the application schema.
- * @param {Object} v4Page - The OData V4 page object containing details about the target application page.
- * @param {Definition} [sections] - The sections definition object where the section table might be added as a reference.
- *
- * @return {Definition} The updated definition of the section table included or modified in the application schema.
+ * @param facet - The facet configuration object containing details for the section.
+ * @param facetKey - The unique key for identifying the facet in the schema.
+ * @param appSchema - The overall application schema where the section table is defined.
+ * @param lineItemFacet - The facet configuration specific to line item processing.
+ * @param generateParameters - Parameters required for generating the application schema.
+ * @param v4Page - The OData V4 page object containing details about the target application page.
+ * @param [sections] - The sections definition object where the section table might be added as a reference.
+ * @returns The updated definition of the section table included or modified in the application schema.
  */
 function handleSectionTable(facet, facetKey, appSchema, lineItemFacet, generateParameters, v4Page, sections) {
     if (sections) {
@@ -510,7 +533,8 @@ function handleSectionTable(facet, facetKey, appSchema, lineItemFacet, generateP
     return sectionTable;
 }
 /**
- * Adds definitions for Identification and Form facet items in object page sections to the app schema
+ * Adds definitions for Identification and Form facet items in object page sections to the app schema.
+ *
  * @param {FacetConfig} facet - current facet
  * @param {v4.SapUiAppPageV4} v4Page Current page in manifest
  * @param {string} facetKey - facet key
@@ -547,7 +571,8 @@ function handleFormIdentification(facet, v4Page, facetKey, sections, appSchema,
     }
 }
 /**
- * Adds definitions for header sections (DataPoint, Chart) in object page sections to the app schema
+ * Adds definitions for header sections (DataPoint, Chart) in object page sections to the app schema.
+ *
  * @param {FacetConfig} facet - current facet
  * @param {string} facetKey - facet key
  * @param {object} sections - schema of current sections definition
@@ -566,11 +591,13 @@ function handleHeaderFacet(facet, facetKey, sections, appSchema, facetDefinition
     sectionFacet[ux_specification_types_1.SchemaTag.isViewNode] = true;
 }
 /**
- * Adds definitions for Chart items in object page sections to the app schema
+ * Adds definitions for Chart items in object page sections to the app schema.
+ *
  * @param {FacetConfig | Chart | object} facet - current facet.
  * @param {string} facetKey - facet key.
  * @param {object} appSchema - app specific schema of the object page that gets enhanced.
  * @param {EntityType} entityType - current entity type
+ * @returns {Definition} - the new chart definition
  */
 function handleChartActions(facet, facetKey, appSchema, entityType) {
     const actions = (0, common_1.parseSchemaDefinition)(ux_specification_types_1.DefinitionName.ObjectPageToolBarActions, facetKey, appSchema);
@@ -599,11 +626,13 @@ function handleChartActions(facet, facetKey, appSchema, entityType) {
     return actions;
 }
 /**
- * Adds definitions for Chart items in object page sections to the app schema
- * @param {FacetConfig | Chart | object} facet - current facet.
- * @param {string} facetKey - facet key.
- * @param {object} appSchema - app specific schema of the object page that gets enhanced.
- * @param {EntityType} entityType - current entity type
+ * Adds definitions for Chart items in object page sections to the app schema.
+ *
+ * @param facet - current facet.
+ * @param facetKey - facet key.
+ * @param appSchema - app specific schema of the object page that gets enhanced.
+ * @param entityType - current entity type
+ * @returns - the new chart definition
  */
 function handleChart(facet, facetKey, appSchema, entityType) {
     const chart = (0, common_1.parseSchemaDefinition)(ux_specification_types_1.DefinitionName.ObjectPageChart, facetKey, appSchema);
@@ -620,13 +649,16 @@ function handleChart(facet, facetKey, appSchema, entityType) {
     return { chart, chartActions };
 }
 /**
- * Adds definitions for Chart section in object page sections to the app schema
+ * Adds definitions for Chart section in object page sections to the app schema.
+ *
  * @param {FacetConfig} facet - current facet.
  * @param {string} facetKey - facet key.
  * @param {object} appSchema - app specific schema of the object page that gets enhanced.
  * @param {object} sections - schema of current sections definition.
  * @param {EntityType} entityType - current entity type
  * @param {boolean} isPVHeaderFacet - whether the facet is a Presentation Variant header facet
+ * @param namespace - the namespace of the facet
+ * @returns - the new chart definition
  */
 function handleSectionChart(facet, facetKey, appSchema, sections, entityType = facet.entityType, isPVHeaderFacet = false, namespace) {
     const definition = isPVHeaderFacet
@@ -653,11 +685,12 @@ function handleSectionChart(facet, facetKey, appSchema, sections, entityType = f
     return { parentChartRef, chart, chartActions };
 }
 /**
- * Extracts the key and type of the visualization
- * @param {boolean} hasTarget - whether the facet has a target
- * @param {object} facetTarget - target of the facet
- * @param {GenerateSchemaParameters} generateParameters - list of API input parameters
- * @returns {object} - key and type of the visualization
+ * Extracts the key and type of the visualization.
+ *
+ * @param hasTarget - whether the facet has a target
+ * @param facetTarget - target of the facet
+ * @param generateParameters - list of API input parameters
+ * @returns - key and type of the visualization
  */
 function getVisualizationKeyAndType(hasTarget, facetTarget, generateParameters) {
     const alias = hasTarget ? facetTarget.fullyQualifiedName : facetTarget.targetString;
@@ -668,21 +701,23 @@ function getVisualizationKeyAndType(hasTarget, facetTarget, generateParameters)
     return { key, type };
 }
 /**
- * Returns the target of the visualization
- * @param {GenerateSchemaParameters} generateParameters - list of API input parameters
+ * Returns the target of the visualization.
+ *
+ * @param generateParameters - list of API input parameters
  * @param navigationPath - navigation path of the target
  * @param visualizationType - type of the visualization
- * @returns {EntityTypeAnnotationsBase_UI} - target of the visualization
+ * @returns - target of the visualization
  */
 function getTargetFromNavigation(generateParameters, navigationPath, visualizationType) {
     const navigationProp = generateParameters.entityType.navigationProperties.find((prop) => prop.name === navigationPath);
     return navigationProp.targetType?.annotations?.UI[visualizationType];
 }
 /**
- * Returns the properties of the visualization
- * @param {FacetConfig} facet - the given facet from the UI annotations
- * @param {string} facetKey - key of the facet, as used in annotation
- * @param {GenerateSchemaParameters} generateParameters - list of API input parameters
+ * Returns the properties of the visualization.
+ *
+ * @param facet - the given facet from the UI annotations
+ * @param facetKey - key of the facet, as used in annotation
+ * @param generateParameters - list of API input parameters
  * @returns {VisualizationProps | undefined} - properties of the visualization
  */
 function getVisualizationProps(facet, facetKey, generateParameters) {
@@ -701,7 +736,8 @@ function getVisualizationProps(facet, facetKey, generateParameters) {
     return { key, type, target, namespace, navigationPath };
 }
 /**
- * Helper function to add property reference to the sections
+ * Helper function to add property reference to the sections.
+ *
  * @param {Definition} sections Definition to add property reference
  * @param {string} propertyName Property name to be added
  * @param {DefinitionName} definition - Key of the visualization
@@ -712,20 +748,28 @@ function addPropertyRef(sections, propertyName, definition, link) {
         $ref: (0, common_1.getFacetDefinitionLink)(definition, link || propertyName)
     };
 }
+/**
+ * Generates the property and navigation keys for a section based on the facet key and visualization properties.
+ *
+ * @param facetKey - The key of the facet.
+ * @param props - The visualization properties containing key, type, target, namespace, and navigationPath.
+ * @returns An object containing the navigationKey and propertyKey for the section.
+ */
 function getSectionPropertyRef(facetKey, props) {
     const propertyKey = `${facetKey}<${props.key}>`;
     const navigationKey = props.navigationPath ? `${props.navigationPath}::${props.key}` : props.key;
     return { propertyKey, navigationKey };
 }
 /**
- * Adds LineItem definition of object page section to the app schema
- * @param {FacetConfig} facet - the given facet from the UI annotations
- * @param {string} facetKey - key of the facet, as used in annotation
- * @param {Definition} appSchema - app schema of the object page
- * @param {object} sections - schema of current sections definition.
- * @param {VisualizationProps} props - visualization properties
- * @param {GenerateSchemaParameters} generateParameters - list of API input parameters
- * @param {SapUiAppPageV4} v4Page Current page in manifest
+ * Adds LineItem definition of object page section to the app schema.
+ *
+ * @param facet - the given facet from the UI annotations
+ * @param facetKey - key of the facet, as used in annotation
+ * @param appSchema - app schema of the object page
+ * @param sections - schema of current sections definition.
+ * @param props - visualization properties
+ * @param generateParameters - list of API input parameters
+ * @param v4Page Current page in manifest
  */
 function addPVLineItemSection(facet, facetKey, appSchema, sections, props, generateParameters, v4Page) {
     const { propertyKey, navigationKey } = getSectionPropertyRef(facetKey, props);
@@ -741,7 +785,8 @@ function addPVLineItemSection(facet, facetKey, appSchema, sections, props, gener
     delete sectionTable[ux_specification_types_1.SchemaTag.isViewNode];
 }
 /**
- * Adds Chart definition of object page (header) section to the app schema
+ * Adds Chart definition of object page (header) section to the app schema.
+ *
  * @param {FacetConfig} facet - the given facet from the UI annotations
  * @param {string} facetKey - key of the facet, as used in annotation
  * @param {Definition} appSchema - app schema of the object page
@@ -771,14 +816,15 @@ function addPVChartSection(facet, facetKey, appSchema, sections, props, isPVHead
     }
 }
 /**
- * Adds definitions for (selection) presentation variants in object page sections to the app schema
- * @param {FacetConfig} facet - the given facet from the UI annotations
- * @param {string} facetKey - key of the facet, as used in annotation
- * @param {Definition} appSchema - app schema of the object page
- * @param {object} sections - schema of current sections definition.
- * @param {SectionType} sectionPrefix - prefix to distinguish Section and HeaderSection
- * @param {GenerateSchemaParameters} generateParameters - list of API input parameters
- * @param {SapUiAppPageV4} v4Page Current page in manifest
+ * Adds definitions for (selection) presentation variants in object page sections to the app schema.
+ *
+ * @param facet - the given facet from the UI annotations
+ * @param facetKey - key of the facet, as used in annotation
+ * @param appSchema - app schema of the object page
+ * @param sections - schema of current sections definition.
+ * @param sectionPrefix - prefix to distinguish Section and HeaderSection
+ * @param generateParameters - list of API input parameters
+ * @param v4Page Current page in manifest
  */
 function handleSectionPresentationVariant(facet, facetKey, appSchema, sections, sectionPrefix, generateParameters, v4Page) {
     if (!facet?.target) {
@@ -803,6 +849,7 @@ function handleSectionPresentationVariant(facet, facetKey, appSchema, sections,
 }
 /**
  * Method checks if passed facet contains any collection facet.
+ *
  * @param {FacetConfig} facet - facet to check
  * @returns {boolean} Passed facet contains at least one collection facet
  */
@@ -817,7 +864,8 @@ function containsCollectionFacet(facet) {
     return false;
 }
 /**
- * Object Page specific enhancements to addCustomColumnDefinition
+ * Object Page specific enhancements to addCustomColumnDefinition.
+ *
  * @param {object} appSchema - app schema of the object page
  * @param {string} id - identifier of the current section facet
  * @param {string[]} featureToggles - supported features
@@ -852,10 +900,11 @@ function createCustomSubSectionReference(appSchema, id, featureToggles) {
 }
 /**
  * Method applies custom action definitions to custom sections.
- * @param {Definition} appSchema - app schema of the object page
- * @param {SapUiAppPageV4} v4Page Current page in manifest
- * @param {DefinitionName} customSectionRef - reference to custom section definition
- * @param {ExtensionLogger} logger - logger for exceptions
+ *
+ * @param appSchema - app schema of the object page
+ * @param v4Page Current page in manifest
+ * @param customSectionRef - reference to custom section definition
+ * @param logger - logger for exceptions
  */
 function applyCustomActionsToCustomSections(appSchema, v4Page, customSectionRef, logger) {
     // add specific definitions for custom sections and custom actions from manifest
@@ -893,12 +942,14 @@ function applyCustomActionsToCustomSections(appSchema, v4Page, customSectionRef,
 }
 /**
  * Common method updates schema for custom sections or custom subsections.
- * @param {Definition} sections - sections definition
- * @param {Definition} appSchema - app schema of the object page
- * @param {GenerateSchemaParameters} generateParameters - list of API input parameters
- * @param {SapUiAppPageV4} v4Page Current page in manifest
- * @param {FacetConfig} facet - the given facet from the UI annotations
- * @param {string} facetKey - key of the facet, as used in annotation
+ *
+ * @param sections - sections definition
+ * @param  appSchema - app schema of the object page
+ * @param generateParameters - list of API input parameters
+ * @param v4Page Current page in manifest
+ * @param customSectionDefinitionName - The name of the custom section definition to be applied.
+ * @param facet - the given facet from the UI annotations
+ * @param facetKey - key of the facet, as used in annotation
  */
 function applyCustomSections(sections, appSchema, generateParameters, v4Page, customSectionDefinitionName, facet, facetKey) {
     let isMergedSections = false;
@@ -950,15 +1001,16 @@ function applyCustomSections(sections, appSchema, generateParameters, v4Page, cu
     }
 }
 /**
- * Adds definitions for collections in object page sections to the app schema
- * @param {FacetConfig} facet - the given facet from the UI annotations
- * @param {string} facetKey - key of the facet, as used in annotation
- * @param {Definition} appSchema - app schema of the object page
- * @param {Definition} sections - schema of current sections definition.
- * @param {SectionType} sectionPrefix - prefix to distinguish Section and HeaderSection
- * @param {GenerateSchemaParameters} generateParameters - list of API input parameters
- * @param {SapUiAppPageV4} v4Page Current page in manifest
- * @param {number} level Collection level in tree
+ * Adds definitions for collections in object page sections to the app schema.
+ *
+ * @param facet - the given facet from the UI annotations
+ * @param facetKey - key of the facet, as used in annotation
+ * @param appSchema - app schema of the object page
+ * @param sections - schema of current sections definition.
+ * @param sectionPrefix - prefix to distinguish Section and HeaderSection
+ * @param generateParameters - list of API input parameters
+ * @param v4Page Current page in manifest
+ * @param level Collection level in tree
  */
 function handleCollection(facet, facetKey, appSchema, sections, sectionPrefix, generateParameters, v4Page, level) {
     const isCustomSubSectionsSupported = level === 0;
@@ -992,14 +1044,15 @@ function handleCollection(facet, facetKey, appSchema, sections, sectionPrefix, g
 }
 /**
  * Creates a section definition in app schema.
- * @param {GenerateSchemaParameters} generateParameters - list of API input parameters
- * @param {FacetConfigs} facets - list of all facets
- * @param {string} facetKey - facet key
- * @param {object} sections - schema of current sections definition
- * @param {object} appSchema - app specific schema of the object page that gets enhanced.
- * @param {SectionType} sectionPrefix - prefix to distinguish Section and HeaderSection
- * @param {SapUiAppPageV4} v4Page Current page in manifest
- * @param {number} [level=0] Section level in tree
+ *
+ * @param generateParameters - list of API input parameters
+ * @param facets - list of all facets
+ * @param facetKey - facet key
+ * @param sections - schema of current sections definition
+ * @param appSchema - app specific schema of the object page that gets enhanced.
+ * @param sectionPrefix - prefix to distinguish Section and HeaderSection
+ * @param v4Page Current page in manifest
+ * @param [level] Section level in tree
  */
 function addSection(generateParameters, facets, facetKey, sections, appSchema, sectionPrefix, v4Page, level = 0) {
     const facet = facets[facetKey];
@@ -1050,10 +1103,11 @@ function addSection(generateParameters, facets, facetKey, sections, appSchema, s
     }
 }
 /**
- * Derives the sections from the UI.Facets annotation and adds them to the schema
- * @param {GenerateAppSchemaParameters} generateParameters - list of API input parameters
- * @param {object} appSchema - application specific JSON schema of the object page
- * @param {SapUiAppPageV4} v4Page - current page
+ * Derives the sections from the UI.Facets annotation and adds them to the schema.
+ *
+ * @param generateParameters - list of API input parameters
+ * @param appSchema - application specific JSON schema of the object page
+ * @param v4Page - current page
  */
 function addSections(generateParameters, appSchema, v4Page) {
     // Get facet annotations
@@ -1070,11 +1124,12 @@ function addSections(generateParameters, appSchema, v4Page) {
     applyCustomSections(sections, appSchema, generateParameters, v4Page, ux_specification_types_1.DefinitionName.ObjectPageCustomSectionFragment);
 }
 /**
- * Derives the header sections from the UI.HeaderFacets annotation and adds them to the schema
- * @param {GenerateAppSchemaParameters} generateParameters - list of API input parameters
- * @param {object} appSchema - application specific JSON schema of the object page
- * @param {EntityType} entityType - current entity type
- * @param {SapUiAppPageV4} v4Page - current page in manifest
+ * Derives the header sections from the UI.HeaderFacets annotation and adds them to the schema.
+ *
+ * @param generateParameters - list of API input parameters
+ * @param appSchema - application specific JSON schema of the object page
+ * @param entityType - current entity type
+ * @param v4Page - current page in manifest
  */
 function addHeaderSections(generateParameters, appSchema, entityType, v4Page) {
     // Get facet annotations
@@ -1099,10 +1154,11 @@ function addHeaderSections(generateParameters, appSchema, entityType, v4Page) {
     delete appSchema.definitions[ux_specification_types_1.DefinitionName.ObjectPageHeaderSectionAddress];
 }
 /**
- * Add Object Page Header to app-specific schema
- * @param {GenerateAppSchemaParameters} generateParameters - list of API input parameters
- * @param {Definition} appSchema Schema of the object page
- * @param {SapUiAppPageV4} v4Page - current page in manifest
+ * Add Object Page Header to app-specific schema.
+ *
+ * @param generateParameters - list of API input parameters
+ * @param appSchema Schema of the object page
+ * @param v4Page - current page in manifest
  */
 function addHeader(generateParameters, appSchema, v4Page) {
     const entityType = generateParameters.entityType;
@@ -1119,11 +1175,11 @@ function addHeader(generateParameters, appSchema, v4Page) {
 /**
  * Generates an app specific schema out of the generic schema.
  * Generic types are replaced by information from the app specific annotations.
+ *
  * @param {GenerateAppSchemaParameters} generateParameters - list of API input parameters
  * @param {object} genericSchema  - generic JSON schema of an object page
  * @param {string} contextPath - contextPath of the given page
  * @param {object} genericMacrosSchema - generic JSON schema of custom page
- *
  * @returns the app specific JSON schema
  */
 function generateObjectPageSchemaV4(generateParameters, genericSchema, contextPath, genericMacrosSchema) {