@sap-ux/ui5-test-writer 0.7.106 → 0.7.108

package/dist/types.d.ts

@@ -81,17 +81,30 @@ export type ObjectPageNavigationParents = {
     parentOPName?: string;
     parentOPTableSection?: string;
 };
+export type SectionFormField = {
+    property: string;
+};
+export type TableColumn = {
+    header?: string;
+};
+export type TableColumnFeatureData = Record<string, TableColumn>;
 export type BodySubSectionFeatureData = {
     id: string;
+    navigationProperty?: string;
     isTable: boolean;
     custom: boolean;
     order: number;
+    fields: SectionFormField[];
+    tableColumns: TableColumnFeatureData;
 };
 export type BodySectionFeatureData = {
     id: string;
+    navigationProperty?: string;
     isTable: boolean;
     custom: boolean;
     order: number;
+    fields: SectionFormField[];
+    tableColumns: TableColumnFeatureData;
     subSections: BodySubSectionFeatureData[];
 };
 export type ObjectPageFeatures = {

package/dist/utils/modelUtils.d.ts

@@ -107,11 +107,4 @@ export declare function getSelectionFieldItems(selectionFieldsAgg: TreeAggregati
  * @returns An array of filter field descriptions.
  */
 export declare function getFilterFields(pageModel: TreeModel): TreeAggregations;
-/**
- * Retrieves the table columns aggregation from the given tree model.
- *
- * @param pageModel - The tree model containing table column definitions.
- * @returns The table columns aggregation object.
- */
-export declare function getTableColumns(pageModel: TreeModel): TreeAggregations;
 //# sourceMappingURL=modelUtils.d.ts.map

package/dist/utils/modelUtils.js

@@ -8,11 +8,11 @@ exports.getFPMFeatures = getFPMFeatures;
 exports.getAggregations = getAggregations;
 exports.getSelectionFieldItems = getSelectionFieldItems;
 exports.getFilterFields = getFilterFields;
-exports.getTableColumns = getTableColumns;
 const project_access_1 = require("@sap-ux/project-access");
 const page_1 = require("@sap/ux-specification/dist/types/src/common/page");
 const objectPageUtils_1 = require("./objectPageUtils");
 const listReportUtils_1 = require("./listReportUtils");
+const tableUtils_1 = require("./tableUtils");
 /**
  * Gets app features from the application model using ux-specification.
  *
@@ -74,39 +74,6 @@ async function getAppFeatures(basePath, fs, log, metadata, manifest) {
     }
     return featureData;
 }
-/**
- * Gets identifier of a column for OPA5 tests.
- * If the column is custom, the identifier is taken from the 'Key' entry in the schema keys.
- * If the column is not custom, the identifier is taken from the 'Value' entry in the schema keys.
- * If no such entry is found, undefined is returned.
- *
- * @param column - column module from ux specification
- * @param column.custom boolean indicating whether the column is custom
- * @param column.schema schema of the column
- * @param column.schema.keys keys of the column; expected to have an entry with the name 'Key' or 'Value'
- * @returns identifier of the column for OPA5 tests; can be the name or index
- */
-function getColumnIdentifier(column) {
-    const key = column.custom ? 'Key' : 'Value';
-    const keyEntry = column.schema.keys.find((entry) => entry.name === key);
-    return keyEntry?.value;
-}
-/**
- * Transforms column aggregations from the ux specification model into a map of columns for OPA5 tests.
- *
- * @param columnAggregations column aggregations from the ux specification model
- * @returns a map of columns for OPA5 tests
- */
-function transformTableColumns(columnAggregations) {
-    const columns = {};
-    Object.values(columnAggregations).forEach((columnAggregation, index) => {
-        columns[getColumnIdentifier(columnAggregation) ?? index] = {
-            header: columnAggregation.description
-            // TODO possibly more reliable properties could be used?
-        };
-    });
-    return columns;
-}
 /**
  * Retrieves table column data from the page model using ux-specification.
  *
@@ -117,8 +84,7 @@ function transformTableColumns(columnAggregations) {
 function getTableColumnData(pageModel, log) {
     let tableColumns = {};
     try {
-        const columnAggregations = getTableColumns(pageModel);
-        tableColumns = transformTableColumns(columnAggregations);
+        tableColumns = (0, tableUtils_1.extractTableColumnsFromNode)(pageModel.root);
     }
     catch (error) {
         log?.debug(error);
@@ -218,17 +184,4 @@ function getFilterFields(pageModel) {
     const selectionFieldsAggregations = getAggregations(selectionFields);
     return selectionFieldsAggregations;
 }
-/**
- * Retrieves the table columns aggregation from the given tree model.
- *
- * @param pageModel - The tree model containing table column definitions.
- * @returns The table columns aggregation object.
- */
-function getTableColumns(pageModel) {
-    const table = getAggregations(pageModel.root)['table'];
-    const tableAggregations = getAggregations(table);
-    const columns = tableAggregations['columns'];
-    const columnAggregations = getAggregations(columns);
-    return columnAggregations;
-}
 //# sourceMappingURL=modelUtils.js.map

package/dist/utils/objectPageUtils.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getObjectPageFeatures = getObjectPageFeatures;
 exports.getObjectPages = getObjectPages;
 const modelUtils_1 = require("./modelUtils");
+const tableUtils_1 = require("./tableUtils");
 const page_1 = require("@sap/ux-specification/dist/types/src/common/page");
 /**
  * Extracts feature data for object pages from the application model.
@@ -121,9 +122,12 @@ function extractObjectPageBodySectionsData(objectPage) {
             const subSections = extractBodySubSectionsData(section, sectionId);
             bodySections.push({
                 id: sectionId,
+                navigationProperty: getNavigationPropertyFromKey(sectionKey),
                 isTable: !!section.isTable,
                 custom: !!section.custom,
                 order: section?.order ?? -1, // put a negative order number to signal that order was not in spec
+                fields: section.custom || section.isTable ? [] : extractFormFields(section),
+                tableColumns: section.custom || !section.isTable ? {} : (0, tableUtils_1.extractTableColumnsFromNode)(section),
                 subSections
             });
         });
@@ -145,13 +149,50 @@ function extractBodySubSectionsData(section, parentSectionId) {
         const subSectionId = getSectionIdentifier(subSection) ?? `${parentSectionId}_${subSectionKey}`;
         subSections.push({
             id: subSectionId,
+            navigationProperty: getNavigationPropertyFromKey(subSectionKey),
             isTable: !!subSection.isTable,
             custom: !!subSection.custom,
-            order: subSection?.order ?? -1 // put a negative order number to signal that order was not in spec
+            order: subSection?.order ?? -1, // put a negative order number to signal that order was not in spec
+            fields: subSection.custom || subSection.isTable ? [] : extractFormFields(subSection),
+            tableColumns: subSection.custom || !subSection.isTable ? {} : (0, tableUtils_1.extractTableColumnsFromNode)(subSection)
         });
     });
     return subSections;
 }
+/**
+ * Extracts form field property paths from a body sub-section's form aggregation.
+ *
+ * @param subSection - body sub-section entry from the application model
+ * @returns array of form field property paths for use with iCheckField({ property })
+ */
+function extractFormFields(subSection) {
+    const fields = [];
+    const formAggregation = (0, modelUtils_1.getAggregations)(subSection)['form'];
+    if (!formAggregation) {
+        return fields;
+    }
+    const fieldsAggregation = (0, modelUtils_1.getAggregations)(formAggregation)['fields'];
+    const fieldItems = (0, modelUtils_1.getAggregations)(fieldsAggregation);
+    Object.values(fieldItems).forEach((field) => {
+        const property = field.schema?.keys?.find((key) => key.name === 'Value')?.value;
+        if (property) {
+            fields.push({ property });
+        }
+    });
+    return fields;
+}
+/**
+ * Extracts the OData navigation property from a spec model section key.
+ * Section keys for table sections follow the pattern `_NavProperty::@annotation`, so the
+ * navigation property is the part before `::` when it starts with an underscore.
+ *
+ * @param sectionKey - the key of the section in the spec model aggregations
+ * @returns navigation property (e.g. '_Booking'), or undefined for non-navigation sections
+ */
+function getNavigationPropertyFromKey(sectionKey) {
+    const prefix = sectionKey.split('::')[0];
+    return prefix.startsWith('_') ? prefix : undefined;
+}
 /**
  * Gets the identifier of a section for OPA5 tests.
  *

package/dist/utils/tableUtils.d.ts

@@ -0,0 +1,42 @@
+import type { TreeAggregation, TreeAggregations } from '@sap/ux-specification/dist/types/src/parser';
+import type { TableColumnFeatureData } from '../types';
+type ColumnModelItem = {
+    custom?: boolean;
+    description?: string;
+    schema: {
+        keys: {
+            name: string;
+            value: string;
+        }[];
+    };
+};
+export type ColumnAggregations = TreeAggregations & {
+    [key: string]: ColumnModelItem;
+};
+/**
+ * Gets the identifier of a column for OPA5 tests.
+ * Custom columns use the 'Key' entry; standard columns use the 'Value' entry from the schema keys.
+ *
+ * @param column - column item from ux specification
+ * @returns identifier of the column for OPA5 tests; undefined if no matching key entry is found
+ */
+export declare function getColumnIdentifier(column: ColumnModelItem): string | undefined;
+/**
+ * Transforms column aggregations from the ux specification model into a map of columns for OPA5 tests.
+ * Each column entry includes the column header label for display verification.
+ *
+ * @param columnAggregations - column aggregations from the ux specification model
+ * @returns a map of column identifiers to column state objects for use with iCheckColumns()
+ */
+export declare function transformTableColumns(columnAggregations: ColumnAggregations): TableColumnFeatureData;
+/**
+ * Extracts table column data from a spec model node that contains a 'table' aggregation.
+ * Covers both page-level nodes (List Report, FPM) via their root and section-level nodes
+ * (Object Page body sections) — both are TreeAggregation nodes that expose a 'table' aggregation.
+ *
+ * @param node - tree aggregation node that exposes a 'table' aggregation
+ * @returns a map of column identifiers to column state objects for use with iCheckColumns()
+ */
+export declare function extractTableColumnsFromNode(node: TreeAggregation): TableColumnFeatureData;
+export {};
+//# sourceMappingURL=tableUtils.d.ts.map

package/dist/utils/tableUtils.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getColumnIdentifier = getColumnIdentifier;
+exports.transformTableColumns = transformTableColumns;
+exports.extractTableColumnsFromNode = extractTableColumnsFromNode;
+const modelUtils_1 = require("./modelUtils");
+/**
+ * Gets the identifier of a column for OPA5 tests.
+ * Custom columns use the 'Key' entry; standard columns use the 'Value' entry from the schema keys.
+ *
+ * @param column - column item from ux specification
+ * @returns identifier of the column for OPA5 tests; undefined if no matching key entry is found
+ */
+function getColumnIdentifier(column) {
+    const key = column.custom ? 'Key' : 'Value';
+    return column.schema.keys.find((k) => k.name === key)?.value;
+}
+/**
+ * Transforms column aggregations from the ux specification model into a map of columns for OPA5 tests.
+ * Each column entry includes the column header label for display verification.
+ *
+ * @param columnAggregations - column aggregations from the ux specification model
+ * @returns a map of column identifiers to column state objects for use with iCheckColumns()
+ */
+function transformTableColumns(columnAggregations) {
+    const columns = {};
+    Object.values(columnAggregations).forEach((column, index) => {
+        const id = getColumnIdentifier(column) ?? String(index);
+        const state = {};
+        if (column.description) {
+            state['header'] = column.description;
+        }
+        columns[id] = state;
+    });
+    return columns;
+}
+/**
+ * Extracts table column data from a spec model node that contains a 'table' aggregation.
+ * Covers both page-level nodes (List Report, FPM) via their root and section-level nodes
+ * (Object Page body sections) — both are TreeAggregation nodes that expose a 'table' aggregation.
+ *
+ * @param node - tree aggregation node that exposes a 'table' aggregation
+ * @returns a map of column identifiers to column state objects for use with iCheckColumns()
+ */
+function extractTableColumnsFromNode(node) {
+    const tableAggregation = (0, modelUtils_1.getAggregations)(node)['table'];
+    if (!tableAggregation) {
+        return {};
+    }
+    const columnsAggregation = (0, modelUtils_1.getAggregations)(tableAggregation)['columns'];
+    if (!columnsAggregation) {
+        return {};
+    }
+    const columnItems = (0, modelUtils_1.getAggregations)(columnsAggregation);
+    return transformTableColumns(columnItems);
+}
+//# sourceMappingURL=tableUtils.js.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/ui5-test-writer",
   "description": "SAP UI5 tests writer",
-  "version": "0.7.106",
+  "version": "0.7.108",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -29,7 +29,7 @@
     "@sap-ux/annotation-converter": "0.10.21",
     "@sap-ux/ui5-application-writer": "1.8.7",
     "@sap-ux/logger": "0.8.5",
-    "@sap-ux/project-access": "1.35.21"
+    "@sap-ux/project-access": "1.36.1"
   },
   "devDependencies": {
     "@types/ejs": "3.1.5",

package/templates/v4/integration/ObjectPageJourney.js

@@ -74,8 +74,25 @@ sap.ui.define([
 <% section.subSections.forEach(function(subSection) { -%>
             //When.onThe<%- name%>.iGoToSection({ section: "<%- section.id %>", subSection: "<%- subSection.id %>" });
             Then.onThe<%- name%>.iCheckSubSection({ section: "<%- subSection.id %>" });
+<% if (subSection.fields && subSection.fields.length > 0) { -%>
+<% subSection.fields.forEach(function(field) { -%>
+            Then.onThe<%- name%>.onForm({ section: "<%- subSection.id %>" }).iCheckField({ property: "<%- field.property %>" });
 <% }) -%>
 <% } -%>
+<% if (subSection.tableColumns && Object.keys(subSection.tableColumns).length > 0 && subSection.navigationProperty) { -%>
+            Then.onThe<%- name%>.onTable({ property: "<%- subSection.navigationProperty %>" }).iCheckColumns(<%- JSON.stringify(subSection.tableColumns) %>);
+<% } -%>
+<% }) -%>
+<% } else { -%>
+<% if (section.fields && section.fields.length > 0) { -%>
+<% section.fields.forEach(function(field) { -%>
+            Then.onThe<%- name%>.onForm({ section: "<%- section.id %>" }).iCheckField({ property: "<%- field.property %>" });
+<% }) -%>
+<% } -%>
+<% if (section.tableColumns && Object.keys(section.tableColumns).length > 0 && section.navigationProperty) { -%>
+            Then.onThe<%- name%>.onTable({ property: "<%- section.navigationProperty %>" }).iCheckColumns(<%- JSON.stringify(section.tableColumns) %>);
+<% } -%>
+<% } -%>
 <% }) -%>
        });
 <% } -%>