@sap-ux/ui5-test-writer 0.9.8 → 0.9.11

package/dist/fiori-elements-opa-writer.d.ts

@@ -31,19 +31,4 @@ export declare function generateOPAFiles(basePath: string, opaConfig: {
  * @returns the manifest object. An exception is thrown if the manifest cannot be read.
  */
 export declare function readManifest(fs: Editor, basePath: string): Manifest;
-/**
- * Generate a page object file for a Fiori elements for OData V4 application.
- * Note: this doesn't modify other existing files in the webapp/test folder.
- *
- * @param basePath - the absolute target path where the application will be generated
- * @param pageObjectParameters - parameters for the page
- * @param pageObjectParameters.targetKey - the key of the target in the manifest file corresponding to the page
- * @param pageObjectParameters.appID - the appID. If not specified, will be read from the manifest in sap.app/id
- * @param fs - an optional reference to a mem-fs editor
- * @returns Reference to a mem-fs-editor
- */
-export declare function generatePageObjectFile(basePath: string, pageObjectParameters: {
-    targetKey: string;
-    appID?: string;
-}, fs?: Editor): Promise<Editor>;
 //# sourceMappingURL=fiori-elements-opa-writer.d.ts.map

package/dist/fiori-elements-opa-writer.js

@@ -2,7 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateOPAFiles = generateOPAFiles;
 exports.readManifest = readManifest;
-exports.generatePageObjectFile = generatePageObjectFile;
 const node_path_1 = require("node:path");
 const node_fs_1 = require("node:fs");
 const mem_fs_1 = require("mem-fs");
@@ -443,32 +442,4 @@ function writePageObject(pageConfig, rootTemplateDirPath, testOutDirPath, fs) {
         globOptions: { dot: true }
     });
 }
-/**
- * Generate a page object file for a Fiori elements for OData V4 application.
- * Note: this doesn't modify other existing files in the webapp/test folder.
- *
- * @param basePath - the absolute target path where the application will be generated
- * @param pageObjectParameters - parameters for the page
- * @param pageObjectParameters.targetKey - the key of the target in the manifest file corresponding to the page
- * @param pageObjectParameters.appID - the appID. If not specified, will be read from the manifest in sap.app/id
- * @param fs - an optional reference to a mem-fs editor
- * @returns Reference to a mem-fs-editor
- */
-async function generatePageObjectFile(basePath, pageObjectParameters, fs) {
-    const editor = fs ?? (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
-    const manifest = readManifest(editor, basePath);
-    const { applicationType } = getAppTypeAndHideFilterBarFromManifest(manifest);
-    const pageConfig = createPageConfig(manifest, pageObjectParameters.targetKey, pageObjectParameters.appID);
-    if (pageConfig) {
-        const rootTemplateDirPath = (0, node_path_1.join)(__dirname, `../templates/${applicationType}`); // Only v4 is supported for the time being
-        const testOutDirPath = (0, node_path_1.join)(await (0, project_access_1.getWebappPath)(basePath), 'test');
-        writePageObject(pageConfig, rootTemplateDirPath, testOutDirPath, editor);
-    }
-    else {
-        throw new types_1.ValidationError((0, i18n_1.t)('error.cannotGeneratePageFile', {
-            targetKey: pageObjectParameters.targetKey
-        }));
-    }
-    return editor;
-}
 //# sourceMappingURL=fiori-elements-opa-writer.js.map

package/dist/types.d.ts

@@ -130,13 +130,17 @@ export type ListReportFeatures = {
     };
     deleteButton?: {
         enabled?: boolean | string;
-        visible: boolean;
+        visible?: boolean;
         dynamicPath?: string;
     };
     filterBarItems?: string[];
     tableColumns?: Record<string, Record<string, string | number | boolean>>;
     toolBarActions?: ActionButtonState[];
     isALP?: boolean;
+    semanticKey?: {
+        semanticKeyProperties?: string[];
+        missingFromFilterBar?: string[];
+    };
 };
 export interface ActionButtonState {
     label: string;

package/dist/utils/actionUtils.d.ts

@@ -95,6 +95,16 @@ export declare function analyzeDeleteRestrictions(restriction: DeleteRestriction
  * @returns ButtonState indicating visibility and enabled state based on the Updatable value
  */
 export declare function analyzeUpdateRestrictions(restriction: UpdateRestrictionsType | undefined): ButtonState;
+/**
+ * Checks the visibility and enabled state of create and delete buttons for a given entity set
+ * by analyzing OData Capabilities annotations in the converted metadata.
+ *
+ * @param convertedMetadata The already-converted OData metadata
+ * @param entitySetName The name of the entity set to check
+ * @returns ButtonVisibilityResult containing the state of create and delete buttons
+ * @throws {Error} If entity set is not found
+ */
+export declare function checkButtonVisibilityFromMetadata(convertedMetadata: ConvertedMetadata, entitySetName: string): ButtonVisibilityResult;
 /**
  * Checks the visibility and enabled state of create and delete buttons for a given entity set
  * by analyzing OData Capabilities annotations in the metadata.
@@ -115,6 +125,15 @@ export declare function checkButtonVisibility(metadataXml: string, entitySetName
  * @throws {Error} If metadata cannot be parsed or entity set is not found
  */
 export declare function checkEditVisibility(metadataXml: string, entitySetName: string): ButtonState;
+/**
+ * Safely checks button visibility from already-converted metadata, with error handling.
+ *
+ * @param convertedMetadata The already-converted OData metadata
+ * @param entitySetName The name of the entity set
+ * @param log Optional logger instance
+ * @returns Button visibility result or undefined if error occurs
+ */
+export declare function safeCheckButtonVisibilityFromMetadata(convertedMetadata: ConvertedMetadata, entitySetName: string, log?: Logger): ButtonVisibilityResult | undefined;
 /**
  * Safely checks button visibility with error handling.
  *

package/dist/utils/actionUtils.js

@@ -10,8 +10,10 @@ exports.analyzeRestrictionValue = analyzeRestrictionValue;
 exports.analyzeInsertRestrictions = analyzeInsertRestrictions;
 exports.analyzeDeleteRestrictions = analyzeDeleteRestrictions;
 exports.analyzeUpdateRestrictions = analyzeUpdateRestrictions;
+exports.checkButtonVisibilityFromMetadata = checkButtonVisibilityFromMetadata;
 exports.checkButtonVisibility = checkButtonVisibility;
 exports.checkEditVisibility = checkEditVisibility;
+exports.safeCheckButtonVisibilityFromMetadata = safeCheckButtonVisibilityFromMetadata;
 exports.safeCheckButtonVisibility = safeCheckButtonVisibility;
 exports.safeCheckEditVisibility = safeCheckEditVisibility;
 const edmx_parser_1 = require("@sap-ux/edmx-parser");
@@ -215,6 +217,27 @@ function analyzeUpdateRestrictions(restriction) {
     const value = restriction ? restriction['Updatable'] : undefined;
     return analyzeRestrictionValue(value);
 }
+/**
+ * Checks the visibility and enabled state of create and delete buttons for a given entity set
+ * by analyzing OData Capabilities annotations in the converted metadata.
+ *
+ * @param convertedMetadata The already-converted OData metadata
+ * @param entitySetName The name of the entity set to check
+ * @returns ButtonVisibilityResult containing the state of create and delete buttons
+ * @throws {Error} If entity set is not found
+ */
+function checkButtonVisibilityFromMetadata(convertedMetadata, entitySetName) {
+    const entitySet = convertedMetadata.entitySets.find((es) => es.name === entitySetName);
+    if (!entitySet) {
+        throw new Error(`Entity set '${entitySetName}' not found in metadata`);
+    }
+    const insertRestrictions = entitySet.annotations?.Capabilities?.InsertRestrictions;
+    const deleteRestrictions = entitySet.annotations?.Capabilities?.DeleteRestrictions;
+    return {
+        create: analyzeInsertRestrictions(insertRestrictions),
+        delete: analyzeDeleteRestrictions(deleteRestrictions)
+    };
+}
 /**
  * Checks the visibility and enabled state of create and delete buttons for a given entity set
  * by analyzing OData Capabilities annotations in the metadata.
@@ -226,17 +249,7 @@ function analyzeUpdateRestrictions(restriction) {
  */
 function checkButtonVisibility(metadataXml, entitySetName) {
     try {
-        const convertedMetadata = (0, annotation_converter_1.convert)((0, edmx_parser_1.parse)(metadataXml));
-        const entitySet = convertedMetadata.entitySets.find((es) => es.name === entitySetName);
-        if (!entitySet) {
-            throw new Error(`Entity set '${entitySetName}' not found in metadata`);
-        }
-        const insertRestrictions = entitySet.annotations?.Capabilities?.InsertRestrictions;
-        const deleteRestrictions = entitySet.annotations?.Capabilities?.DeleteRestrictions;
-        return {
-            create: analyzeInsertRestrictions(insertRestrictions),
-            delete: analyzeDeleteRestrictions(deleteRestrictions)
-        };
+        return checkButtonVisibilityFromMetadata((0, annotation_converter_1.convert)((0, edmx_parser_1.parse)(metadataXml)), entitySetName);
     }
     catch (error) {
         const errorMessage = error instanceof Error ? error.message : String(error);
@@ -267,6 +280,23 @@ function checkEditVisibility(metadataXml, entitySetName) {
         throw new Error(`Failed to analyze edit visibility: ${errorMessage}`);
     }
 }
+/**
+ * Safely checks button visibility from already-converted metadata, with error handling.
+ *
+ * @param convertedMetadata The already-converted OData metadata
+ * @param entitySetName The name of the entity set
+ * @param log Optional logger instance
+ * @returns Button visibility result or undefined if error occurs
+ */
+function safeCheckButtonVisibilityFromMetadata(convertedMetadata, entitySetName, log) {
+    try {
+        return checkButtonVisibilityFromMetadata(convertedMetadata, entitySetName);
+    }
+    catch (error) {
+        log?.debug(`Failed to check button visibility: ${error instanceof Error ? error.message : String(error)}`);
+        return undefined;
+    }
+}
 /**
  * Safely checks button visibility with error handling.
  *

package/dist/utils/listReportUtils.d.ts

@@ -1,6 +1,7 @@
 import type { Logger } from '@sap-ux/logger';
 import type { TreeAggregations, TreeModel } from '@sap/ux-specification/dist/types/src/parser';
 import type { ActionButtonsResult, ActionButtonState, ButtonState, FEV4ManifestTarget, ListReportFeatures } from '../types';
+import type { ConvertedMetadata } from '@sap-ux/vocabularies-types';
 import { safeCheckButtonVisibility } from './actionUtils';
 import type { PageWithModelV4 } from '@sap/ux-specification/dist/types/src/parser/application';
 import type { Manifest } from '@sap-ux/project-access';
@@ -20,13 +21,22 @@ export declare function buildButtonState(buttonState?: ButtonState): {
 /**
  * Safely checks action button states with error handling.
  *
- * @param metadata - The OData metadata XML content
+ * @param convertedMetadata - The already-converted OData metadata
  * @param entitySetName - The name of the entity set
  * @param actionNames - List of action names to check
  * @param log - Optional logger instance
  * @returns Array of action button states or empty array if error occurs
  */
-export declare function safeCheckActionButtonStates(metadata: string, entitySetName: string, actionNames: string[], log?: Logger): ActionButtonState[];
+export declare function safeCheckActionButtonStates(convertedMetadata: ConvertedMetadata, entitySetName: string, actionNames: string[], log?: Logger): ActionButtonState[];
+/**
+ * Safely gets semantic key properties with error handling.
+ *
+ * @param convertedMetadata - The already-converted OData metadata
+ * @param entitySetName - The name of the entity set
+ * @param log - Optional logger instance
+ * @returns Array of semantic key properties or undefined if error occurs
+ */
+export declare function safeGetSemanticKeyProperties(convertedMetadata: ConvertedMetadata, entitySetName: string, log?: Logger): string[] | undefined;
 /**
  * Returns true when a ListReport manifest target is configured as an Analytical List Page.
  * ALP targets have a `views.paths` array where at least one entry contains a `primary` array,
@@ -69,6 +79,16 @@ export declare function getToolBarActions(pageModel: TreeModel): TreeAggregation
  * @returns - an array of filter field names
  */
 export declare function getFilterFieldNames(pageModel: TreeModel, log?: Logger): string[];
+/**
+ * Checks the state of action buttons defined in UI.LineItem annotations for a given entity set.
+ *
+ * @param convertedMetadata The already-converted OData metadata
+ * @param entitySetName The name of the entity set to check
+ * @param actionNames Optional list of action names to filter (e.g., ['Check', 'deductDiscount']). If not provided, returns all actions.
+ * @returns ActionButtonsResult containing the list of action buttons and their states
+ * @throws {Error} If entity set is not found
+ */
+export declare function checkActionButtonStatesFromMetadata(convertedMetadata: ConvertedMetadata, entitySetName: string, actionNames?: string[]): ActionButtonsResult;
 /**
  * Checks the state of action buttons defined in UI.LineItem annotations for a given entity set.
  *
@@ -94,4 +114,36 @@ export declare function getToolBarActionNames(pageModel: TreeModel, log?: Logger
  * @returns An array of toolbar action descriptions.
  */
 export declare function getToolBarActionItems(toolBarActionsAgg: TreeAggregations): string[];
+/**
+ * Checks whether all SemanticKey properties for a given entity set appear as filter fields in the filter bar.
+ * Returns false if the semantic key is absent, empty, or no semantic key properties are present as filters.
+ *
+ * @param pageModel - The tree model containing filter bar definitions (from ux-specification)
+ * @param metadataXml - The OData metadata XML content as a string
+ * @param entitySetName - The name of the entity set to inspect
+ * @param log - optional logger instance
+ * @returns true if every SemanticKey property appears in the filter bar, false otherwise
+ */
+export declare function isSemanticKeyInFilterBar(pageModel: TreeModel, metadataXml: string, entitySetName: string, log?: Logger): boolean;
+/**
+ * Retrieves the SemanticKey PropertyPath values for a given entity set from already-converted metadata.
+ *
+ * @param convertedMetadata - The already-converted OData metadata
+ * @param entitySetName - The name of the entity set to inspect
+ * @param resolveLabels - when true, each property name is replaced with its Common.Label value (falls back to the property name when no label is defined). Use this when comparing against getFilterFieldNames(), which also returns labels.
+ * @returns An array of PropertyPath string values (or their labels) from the SemanticKey annotation, or an empty array if not found
+ * @throws {Error} If the entity set is not found
+ */
+export declare function getSemanticKeyPropertiesFromMetadata(convertedMetadata: ConvertedMetadata, entitySetName: string, resolveLabels?: boolean): string[];
+/**
+ * Retrieves the SemanticKey PropertyPath values for a given entity set from OData metadata XML.
+ * Returns the values of all PropertyPath entries in the SAP Common SemanticKey annotation on the entity type.
+ *
+ * @param metadataXml - The OData metadata XML content as a string
+ * @param entitySetName - The name of the entity set to inspect
+ * @param resolveLabels - when true, each property name is replaced with its Common.Label value (falls back to the property name when no label is defined). Use this when comparing against getFilterFieldNames(), which also returns labels.
+ * @returns An array of PropertyPath string values (or their labels) from the SemanticKey annotation, or an empty array if not found
+ * @throws {Error} If the metadata cannot be parsed or the entity set is not found
+ */
+export declare function getSemanticKeyProperties(metadataXml: string, entitySetName: string, resolveLabels?: boolean): string[];
 //# sourceMappingURL=listReportUtils.d.ts.map

package/dist/utils/listReportUtils.js

@@ -3,14 +3,19 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.safeCheckButtonVisibility = exports.safeCheckEditVisibility = exports.checkButtonVisibility = void 0;
 exports.buildButtonState = buildButtonState;
 exports.safeCheckActionButtonStates = safeCheckActionButtonStates;
+exports.safeGetSemanticKeyProperties = safeGetSemanticKeyProperties;
 exports.isALPManifestTarget = isALPManifestTarget;
 exports.isALPFromManifest = isALPFromManifest;
 exports.getListReportFeatures = getListReportFeatures;
 exports.getToolBarActions = getToolBarActions;
 exports.getFilterFieldNames = getFilterFieldNames;
+exports.checkActionButtonStatesFromMetadata = checkActionButtonStatesFromMetadata;
 exports.checkActionButtonStates = checkActionButtonStates;
 exports.getToolBarActionNames = getToolBarActionNames;
 exports.getToolBarActionItems = getToolBarActionItems;
+exports.isSemanticKeyInFilterBar = isSemanticKeyInFilterBar;
+exports.getSemanticKeyPropertiesFromMetadata = getSemanticKeyPropertiesFromMetadata;
+exports.getSemanticKeyProperties = getSemanticKeyProperties;
 const modelUtils_1 = require("./modelUtils");
 const edmx_parser_1 = require("@sap-ux/edmx-parser");
 const annotation_converter_1 = require("@sap-ux/annotation-converter");
@@ -35,21 +40,38 @@ function buildButtonState(buttonState) {
 /**
  * Safely checks action button states with error handling.
  *
- * @param metadata - The OData metadata XML content
+ * @param convertedMetadata - The already-converted OData metadata
  * @param entitySetName - The name of the entity set
  * @param actionNames - List of action names to check
  * @param log - Optional logger instance
  * @returns Array of action button states or empty array if error occurs
  */
-function safeCheckActionButtonStates(metadata, entitySetName, actionNames, log) {
+function safeCheckActionButtonStates(convertedMetadata, entitySetName, actionNames, log) {
     try {
-        return checkActionButtonStates(metadata, entitySetName, actionNames).actions;
+        return checkActionButtonStatesFromMetadata(convertedMetadata, entitySetName, actionNames).actions;
     }
     catch (error) {
         log?.debug(`Failed to check action button states: ${error instanceof Error ? error.message : String(error)}`);
         return [];
     }
 }
+/**
+ * Safely gets semantic key properties with error handling.
+ *
+ * @param convertedMetadata - The already-converted OData metadata
+ * @param entitySetName - The name of the entity set
+ * @param log - Optional logger instance
+ * @returns Array of semantic key properties or undefined if error occurs
+ */
+function safeGetSemanticKeyProperties(convertedMetadata, entitySetName, log) {
+    try {
+        return getSemanticKeyPropertiesFromMetadata(convertedMetadata, entitySetName, true);
+    }
+    catch (error) {
+        log?.debug(`Failed to get semantic key properties: ${error instanceof Error ? error.message : String(error)}`);
+        return undefined;
+    }
+}
 /**
  * Returns true when a ListReport manifest target is configured as an Analytical List Page.
  * ALP targets have a `views.paths` array where at least one entry contains a `primary` array,
@@ -89,20 +111,38 @@ function isALPFromManifest(manifest, targetKey) {
  * @returns feature data extracted from the List Report page model
  */
 function getListReportFeatures(listReportPage, log, metadata, manifest) {
-    const buttonVisibility = metadata && listReportPage.entitySet
-        ? (0, actionUtils_1.safeCheckButtonVisibility)(metadata, listReportPage.entitySet, log)
-        : undefined;
     const toolbarActions = getToolBarActionNames(listReportPage.model, log);
+    const filterBarItems = getFilterFieldNames(listReportPage.model, log);
+    let buttonVisibility;
+    let semanticKeyProperties;
+    let toolBarActions = [];
+    if (metadata && listReportPage.entitySet) {
+        const entitySetName = listReportPage.entitySet;
+        try {
+            const convertedMetadata = (0, annotation_converter_1.convert)((0, edmx_parser_1.parse)(metadata));
+            buttonVisibility = (0, actionUtils_1.safeCheckButtonVisibilityFromMetadata)(convertedMetadata, entitySetName, log);
+            semanticKeyProperties = safeGetSemanticKeyProperties(convertedMetadata, entitySetName, log);
+            toolBarActions = safeCheckActionButtonStates(convertedMetadata, entitySetName, toolbarActions, log);
+        }
+        catch (error) {
+            log?.debug(`Failed to parse metadata: ${error instanceof Error ? error.message : String(error)}`);
+        }
+    }
+    const missingKeys = semanticKeyProperties?.length && filterBarItems.length
+        ? semanticKeyProperties.filter((key) => !filterBarItems.includes(key))
+        : undefined;
     return {
         name: listReportPage.name,
         createButton: buildButtonState(buttonVisibility?.create),
         deleteButton: buildButtonState(buttonVisibility?.delete),
-        filterBarItems: getFilterFieldNames(listReportPage.model, log),
+        filterBarItems,
         tableColumns: (0, modelUtils_1.getTableColumnData)(listReportPage.model, log),
-        toolBarActions: metadata && listReportPage.entitySet
-            ? safeCheckActionButtonStates(metadata, listReportPage.entitySet, toolbarActions, log)
-            : [],
-        isALP: manifest ? isALPFromManifest(manifest, listReportPage.name) : false
+        toolBarActions,
+        isALP: manifest ? isALPFromManifest(manifest, listReportPage.name) : false,
+        semanticKey: {
+            semanticKeyProperties,
+            missingFromFilterBar: missingKeys?.length ? missingKeys : undefined
+        }
     };
 }
 /**
@@ -141,6 +181,34 @@ function getFilterFieldNames(pageModel, log) {
     }
     return filterBarItems;
 }
+/**
+ * Checks the state of action buttons defined in UI.LineItem annotations for a given entity set.
+ *
+ * @param convertedMetadata The already-converted OData metadata
+ * @param entitySetName The name of the entity set to check
+ * @param actionNames Optional list of action names to filter (e.g., ['Check', 'deductDiscount']). If not provided, returns all actions.
+ * @returns ActionButtonsResult containing the list of action buttons and their states
+ * @throws {Error} If entity set is not found
+ */
+function checkActionButtonStatesFromMetadata(convertedMetadata, entitySetName, actionNames) {
+    const entitySet = convertedMetadata.entitySets.find((es) => es.name === entitySetName);
+    if (!entitySet) {
+        throw new Error(`Entity set '${entitySetName}' not found in metadata`);
+    }
+    const entityType = entitySet.entityType;
+    if (!entityType) {
+        throw new Error(`Entity type not found for entity set '${entitySetName}'`);
+    }
+    const lineItemAnnotation = entityType.annotations?.UI?.LineItem;
+    if (!lineItemAnnotation || !Array.isArray(lineItemAnnotation)) {
+        return { actions: [], entityType: entityType.name };
+    }
+    const dataFieldForActions = lineItemAnnotation.filter((item) => item.$Type === 'com.sap.vocabularies.UI.v1.DataFieldForAction');
+    const actions = actionNames
+        ? findActionStates(dataFieldForActions, actionNames, convertedMetadata)
+        : extractAllActionStates(dataFieldForActions, convertedMetadata);
+    return { actions, entityType: entityType.name };
+}
 /**
  * Checks the state of action buttons defined in UI.LineItem annotations for a given entity set.
  *
@@ -152,24 +220,7 @@ function getFilterFieldNames(pageModel, log) {
  */
 function checkActionButtonStates(metadataXml, entitySetName, actionNames) {
     try {
-        const convertedMetadata = (0, annotation_converter_1.convert)((0, edmx_parser_1.parse)(metadataXml));
-        const entitySet = convertedMetadata.entitySets.find((es) => es.name === entitySetName);
-        if (!entitySet) {
-            throw new Error(`Entity set '${entitySetName}' not found in metadata`);
-        }
-        const entityType = entitySet.entityType;
-        if (!entityType) {
-            throw new Error(`Entity type not found for entity set '${entitySetName}'`);
-        }
-        const lineItemAnnotation = entityType.annotations?.UI?.LineItem;
-        if (!lineItemAnnotation || !Array.isArray(lineItemAnnotation)) {
-            return { actions: [], entityType: entityType.name };
-        }
-        const dataFieldForActions = lineItemAnnotation.filter((item) => item.$Type === 'com.sap.vocabularies.UI.v1.DataFieldForAction');
-        const actions = actionNames
-            ? findActionStates(dataFieldForActions, actionNames, convertedMetadata)
-            : extractAllActionStates(dataFieldForActions, convertedMetadata);
-        return { actions, entityType: entityType.name };
+        return checkActionButtonStatesFromMetadata((0, annotation_converter_1.convert)((0, edmx_parser_1.parse)(metadataXml)), entitySetName, actionNames);
     }
     catch (error) {
         const errorMessage = error instanceof Error ? error.message : String(error);
@@ -249,4 +300,70 @@ function extractItemDescriptions(aggregations) {
     }
     return [];
 }
+/**
+ * Checks whether all SemanticKey properties for a given entity set appear as filter fields in the filter bar.
+ * Returns false if the semantic key is absent, empty, or no semantic key properties are present as filters.
+ *
+ * @param pageModel - The tree model containing filter bar definitions (from ux-specification)
+ * @param metadataXml - The OData metadata XML content as a string
+ * @param entitySetName - The name of the entity set to inspect
+ * @param log - optional logger instance
+ * @returns true if every SemanticKey property appears in the filter bar, false otherwise
+ */
+function isSemanticKeyInFilterBar(pageModel, metadataXml, entitySetName, log) {
+    try {
+        const semanticKeys = getSemanticKeyProperties(metadataXml, entitySetName, true);
+        if (!semanticKeys.length) {
+            return false;
+        }
+        const filterFields = getFilterFieldNames(pageModel, log);
+        return semanticKeys.every((key) => filterFields.includes(key));
+    }
+    catch (error) {
+        log?.debug(`Failed to check semantic key in filter bar: ${error instanceof Error ? error.message : String(error)}`);
+        return false;
+    }
+}
+/**
+ * Retrieves the SemanticKey PropertyPath values for a given entity set from already-converted metadata.
+ *
+ * @param convertedMetadata - The already-converted OData metadata
+ * @param entitySetName - The name of the entity set to inspect
+ * @param resolveLabels - when true, each property name is replaced with its Common.Label value (falls back to the property name when no label is defined). Use this when comparing against getFilterFieldNames(), which also returns labels.
+ * @returns An array of PropertyPath string values (or their labels) from the SemanticKey annotation, or an empty array if not found
+ * @throws {Error} If the entity set is not found
+ */
+function getSemanticKeyPropertiesFromMetadata(convertedMetadata, entitySetName, resolveLabels = false) {
+    const entitySet = convertedMetadata.entitySets.find((es) => es.name === entitySetName);
+    if (!entitySet) {
+        throw new Error(`Entity set '${entitySetName}' not found in metadata`);
+    }
+    const semanticKey = entitySet.entityType.annotations?.Common?.SemanticKey;
+    if (!semanticKey) {
+        return [];
+    }
+    const propertyNames = semanticKey.map((entry) => entry.value).filter((v) => typeof v === 'string');
+    if (!resolveLabels) {
+        return propertyNames;
+    }
+    return propertyNames.map((propName) => {
+        const property = entitySet.entityType.entityProperties.find((p) => p.name === propName);
+        const label = property?.annotations?.Common?.Label;
+        const labelStr = label !== undefined && label !== null ? String(label) : '';
+        return labelStr || propName;
+    });
+}
+/**
+ * Retrieves the SemanticKey PropertyPath values for a given entity set from OData metadata XML.
+ * Returns the values of all PropertyPath entries in the SAP Common SemanticKey annotation on the entity type.
+ *
+ * @param metadataXml - The OData metadata XML content as a string
+ * @param entitySetName - The name of the entity set to inspect
+ * @param resolveLabels - when true, each property name is replaced with its Common.Label value (falls back to the property name when no label is defined). Use this when comparing against getFilterFieldNames(), which also returns labels.
+ * @returns An array of PropertyPath string values (or their labels) from the SemanticKey annotation, or an empty array if not found
+ * @throws {Error} If the metadata cannot be parsed or the entity set is not found
+ */
+function getSemanticKeyProperties(metadataXml, entitySetName, resolveLabels = false) {
+    return getSemanticKeyPropertiesFromMetadata((0, annotation_converter_1.convert)((0, edmx_parser_1.parse)(metadataXml)), entitySetName, resolveLabels);
+}
 //# sourceMappingURL=listReportUtils.js.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/ui5-test-writer",
   "description": "SAP UI5 tests writer",
-  "version": "0.9.8",
+  "version": "0.9.11",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -27,11 +27,11 @@
     "@sap/ux-specification": "1.144.0",
     "@sap-ux/edmx-parser": "0.10.0",
     "@sap-ux/annotation-converter": "0.10.21",
-    "@sap-ux/ui5-application-writer": "1.9.1",
-    "@sap-ux/logger": "0.9.0",
-    "@sap-ux/fiori-generator-shared": "0.15.3",
+    "@sap-ux/ui5-application-writer": "1.9.2",
     "@sap-ux/project-access": "1.38.1",
-    "@sap-ux/preview-middleware": "0.26.7"
+    "@sap-ux/preview-middleware": "0.26.8",
+    "@sap-ux/fiori-generator-shared": "0.15.4",
+    "@sap-ux/logger": "0.9.0"
   },
   "devDependencies": {
     "@types/ejs": "3.1.5",

package/templates/v4/integration/ListReportJourney.js

@@ -38,6 +38,32 @@ sap.ui.define([
             <%_ }); -%>
         });
 <%_ } -%>
+<%_ if (semanticKey && semanticKey.missingFromFilterBar && semanticKey.missingFromFilterBar.length > 0) { %>
+        opaTest("Add semantic key properties to filter bar", function (Given, When, Then) {
+            Then.onThe<%- startLR%>.onFilterBar().iOpenFilterAdaptation();
+            <%_ semanticKey.missingFromFilterBar.forEach(function(property) { _%>
+            When.onThe<%- startLR%>.onFilterBar().iAddAdaptationFilterField("<%- property %>");
+            <%_ }); -%>
+            Then.onThe<%- startLR%>.onFilterBar().iConfirmFilterAdaptation();
+            <%_ semanticKey.missingFromFilterBar.forEach(function(property) { _%>
+            Then.onThe<%- startLR%>.onFilterBar().iCheckFilterField("<%- property %>");
+            <%_ }); -%>
+            <%_ semanticKey.missingFromFilterBar.forEach(function(property) { _%>
+            // Then.onThe<%- startLR%>.onFilterBar().iChangeFilterField("<%- property %>");
+            <%_ }); -%>
+            // Then.onThe<%- startLR%>.onFilterBar().iExecuteSearch();
+            // Then.onThe<%- startLR%>.onTable().iCheckRows();
+            // Then.onThe<%- startLR%>.onTable().iSelectRows(0);
+            // Then.onThe<%- startLR%>.onTable().iCheckAction("<Action Name>", { enabled: true });
+        });
+<%_ } -%>
+
+        // Note: this test will only work if the ListReport page has a search field and shows data that matches the search term. Please ensure that the test data and search term are set up accordingly.
+        // opaTest("Perform a global search and check the result", function (Given, When, Then) {
+        //     When.onThe<%- startLR%>.onFilterBar().iChangeSearchField("Search Term");
+        //     When.onThe<%- startLR%>.onFilterBar().iExecuteSearch();
+        //     Then.onThe<%- startLR%>.onTable().iCheckRows();
+        // });
 
 <%_ if ((toolBarActions && toolBarActions.length > 0 ) || (tableColumns && Object.keys(tableColumns).length > 0)) { -%>
         opaTest("Check table columns and actions", function (Given, When, Then) {