@sap/ux-specification 1.108.54 → 1.108.56

package/dist/specification/src/sync/common/utils.js

@@ -46,6 +46,7 @@ exports.getJSONPropertyByPath = getJSONPropertyByPath;
 exports.removeNamespaces = removeNamespaces;
 exports.replaceNamespaces = replaceNamespaces;
 exports.getRefType = getRefType;
+exports.compareTemplateNames = compareTemplateNames;
 const ux_specification_types_1 = require("@sap/ux-specification-types");
 const i18next_1 = __importDefault(require("i18next"));
 const deepmerge_1 = __importDefault(require("deepmerge"));
@@ -64,6 +65,7 @@ const arrayIncludes = (arr, target) => target.every((v) => arr.includes(v));
 exports.arrayIncludes = arrayIncludes;
 /**
  * Function returns annotation path for schema based on received params.
+ *
  * @param entityTypeName - Entity type name.
  * @param term - Annotation term.
  * @param qualifier - Annotation qualifier.
@@ -81,8 +83,10 @@ const createAnnotationPath = (entityTypeName, term, qualifier) => {
 };
 exports.createAnnotationPath = createAnnotationPath;
 /**
- * Parses, merges, and converts a list of annotation files with aid of tools from annotation-vocabularies-tools
+ * Parses, merges, and converts a list of annotation files with aid of tools from annotation-vocabularies-tools.
+ *
  * @param annotationFiles - The list of all annotation files, in JSON format
+ * @param logger - Logger instance used for logging errors or messages during processing
  * @returns the complete service information
  */
 function parseAndMergeAndConvert(annotationFiles, logger) {
@@ -112,10 +116,12 @@ function parseAndMergeAndConvert(annotationFiles, logger) {
 const getAnnotationPropertyValue = (annotationProperty) => annotationProperty?.value || annotationProperty?.path;
 exports.getAnnotationPropertyValue = getAnnotationPropertyValue;
 /**
- * Checks for Common.Label and overwrites the label from it if present
+ * Checks for Common.Label and overwrites the label from it if present.
+ *
  * @param {PropertyAnnotations} annotations - property annotations
  * @param {EntityType} entityType - entity type
  * @param {string} label - label, to be actualized
+ * @returns label, derived from Common.Label or from property value
  */
 function evaluateCommonLabel(annotations, entityType, label) {
     if (annotations?.Common?.Label) {
@@ -138,7 +144,8 @@ function evaluateCommonLabel(annotations, entityType, label) {
     return label;
 }
 /**
- * Determines the label for a property path
+ * Determines the label for a property path.
+ *
  * @param {PropertyPath} propertyPath - property path
  * @param {EntityType} entityType - entity type
  * @returns label, derived from Common.Label or from property value
@@ -151,9 +158,10 @@ function getLabelForPropertyPath(propertyPath, entityType) {
     return label;
 }
 /**
- * Determines the label for a LineItem record
- * @param {DataFieldAbstractType} field - Line item record
- * @param {EntityType} entityType - entity type
+ * Determines the label for a LineItem record.
+ *
+ * @param field - Line item record
+ * @param entityType - entity type
  * @returns label, derived from Common.Label or from property value
  */
 function getLabelForDataField(field, entityType) {
@@ -183,7 +191,8 @@ function getLabelForDataField(field, entityType) {
     return label;
 }
 /**
- * Function to resolve the dataField label
+ * Function to resolve the dataField label.
+ *
  * @param dataFieldLabel - Given dataField label; might be of type string, or an object in case of a path reference
  * @param entityType - the entity type as part of the AVT ConvertedMetadata
  * @returns undefined or the right string value
@@ -209,6 +218,14 @@ function getLabel(dataFieldLabel, entityType) {
         return undefined;
     }
 }
+/**
+ * Retrieves the title for a given data field.
+ *
+ * @param dataField - The data field object containing metadata.
+ * @param entityType - The entity type as part of the AVT ConvertedMetadata.
+ * @param dataFieldLabel - The label associated with the data field.
+ * @returns The title for the data field as a string.
+ */
 function getTitleForDataField(dataField, entityType, dataFieldLabel) {
     const propertyCommonLabel = getLabelForDataField(dataField, entityType);
     return (dataFieldLabel ||
@@ -216,9 +233,11 @@ function getTitleForDataField(dataField, entityType, dataFieldLabel) {
         (dataField.Value.$target ? dataField.Value.$target.name : dataField.Value.value || dataField.Value.path));
 }
 /**
- * Determines the description of a data field, e.g. for the column header
+ * Determines the description of a data field, e.g. for the column header.
+ *
  * @param dataFieldAbstract - the given record of the line item annotation
  * @param entityType - the entity type as part of the AVT ConvertedMetadata
+ * @returns the description of the data field
  */
 function getDataFieldDescription(dataFieldAbstract, entityType) {
     let title = '', propertyCommonLabel, dataField, actionName = '';
@@ -276,17 +295,21 @@ function getDataFieldDescription(dataFieldAbstract, entityType) {
     }
 }
 /**
- * Prepare string for reference use in schema
+ * Prepare string for reference use in schema.
+ *
  * @param refInput string to be character checked and replaced
  * @returns string with replaced characters
  */
 //@typescript-eslint/no-wrapper-object-types turned off tor prevent conversion String > string; String is used by AVT
+// eslint-disable-next-line @typescript-eslint/no-wrapper-object-types
 function prepareRef(refInput) {
     return refInput.replace('#', '::').replace(/\//g, ':2f');
 }
 /**
- * Return the page type for a given V2 page in manifest
+ * Return the page type for a given V2 page in manifest.
+ *
  * @param name - page component name
+ * @returns page type
  */
 function getPageTypeV2(name) {
     if (name) {
@@ -295,28 +318,34 @@ function getPageTypeV2(name) {
     }
 }
 /**
- * Return the page type for a given V4 page in manifest
- * @param name - page component name
+ * Return the page type for a given V4 page in manifest.
+ *
+ * @param v4Page - The V4 application page or routing target configuration
+ * @returns page type
  */
-function getPageTypeV4(v4App) {
-    if (v4App.name && v4App.name !== ux_specification_types_1.v4.FE_TEMPLATE_V4_CUSTOM_PAGE) {
-        const templatePart = `${ux_specification_types_1.v4.FE_TEMPLATE_V4}.`;
-        return v4App.name.split(templatePart)[1];
+function getPageTypeV4(v4Page) {
+    const pageType = 'name' in v4Page && typeof v4Page.name === 'string' ? convertTemplateNameToPageTypeV4(v4Page.name) : undefined;
+    if (pageType) {
+        return pageType;
     }
-    else if (v4App?.name === ux_specification_types_1.v4.FE_TEMPLATE_V4_CUSTOM_PAGE) {
-        return ux_specification_types_1.PageTypeV4.FPMCustomPage;
-    }
-    else if (v4App.viewId ||
-        v4App.viewName) {
+    if (('viewId' in v4Page && v4Page.viewId) || ('viewName' in v4Page && v4Page.viewName)) {
         return ux_specification_types_1.PageTypeV4.CustomPage;
     }
 }
+/**
+ * Retrieves the name of the target annotation based on the provided annotation object and a flag.
+ *
+ * @param targetAnnotation - The annotation object containing term and qualifier information.
+ * @param keyForRelatedFacetKeys - A flag indicating whether to construct the key for related facet keys without the '@' symbol.
+ * @returns The name of the target annotation as a string.
+ */
 function getTargetAnnotationName(targetAnnotation, keyForRelatedFacetKeys = false) {
     const termWithQualifier = `${targetAnnotation.term}#${targetAnnotation.qualifier}`;
     return `${!keyForRelatedFacetKeys ? '@' : ''}${targetAnnotation.qualifier ? termWithQualifier : targetAnnotation.term}`;
 }
 /**
- * Finds the alias for a given namespace in the references' section of the converted service metadata
+ * Finds the alias for a given namespace in the references' section of the converted service metadata.
+ *
  * @param {string} namespace - complete namespace, e.g. 'com.sap.vocabularies.UI.v1'
  * @param {ConvertedMetadata} oDataServiceAVT - combined service metadata, as returned by annotation vocabularies tools
  * @returns alias for the given namespace
@@ -343,6 +372,7 @@ function findAlias(namespace, oDataServiceAVT) {
 }
 /**
  * Method returns annotation from passed meta path.
+ *
  * @param metaPath - annotation meta path
  * @returns annotation name
  */
@@ -350,7 +380,8 @@ function getAnnotationFromMetaPath(metaPath) {
     return metaPath.substring(metaPath.lastIndexOf('.') + 1, metaPath.length);
 }
 /**
- * Determines the target annotation
+ * Determines the target annotation.
+ *
  * @param navigationParts - parts of the target annotation path
  * @param entityType - entity type
  * @param {ConvertedMetadata} oDataServiceAVT - complete service information, as returned by annotation vocabularies tool
@@ -363,10 +394,12 @@ function determineTargetAnnotation(navigationParts, entityType, oDataServiceAVT)
     return entityType?.annotations?.[alias]?.[annotation];
 }
 /**
- * Adjust key by considering navigation
+ * Adjust key by considering navigation.
+ *
  * @param key - given key
- * @param keyForRelatedFacetKeys - construct key for 'keyForRelatedFacetKeys' property(used to define custom sections) - we should not add '@' symbol there.
  * @param navigationParts - parts of the target annotation path
+ * @param keyForRelatedFacetKeys - construct key for 'keyForRelatedFacetKeys' property(used to define custom sections) - we should not add '@' symbol there.
+ * @returns adjusted key
  */
 function adjustKey(key, navigationParts, keyForRelatedFacetKeys) {
     const uiClass = navigationParts[navigationParts.length - 1].split('#')[0];
@@ -380,6 +413,17 @@ function adjustKey(key, navigationParts, keyForRelatedFacetKeys) {
     }
     return key;
 }
+/**
+ * Resolves the key and entity type of a reference facet, adjusting the key based on navigation and annotations.
+ *
+ * @param oDataServiceAVT - The converted metadata of the OData service.
+ * @param key - The initial key for the facet.
+ * @param entityType - The entity type associated with the facet.
+ * @param propertyValue - The property value of the facet's target.
+ * @param oDataVersion - The version of OData (v2 or v4).
+ * @param keyForRelatedFacetKeys - A flag indicating whether to construct the key for related facet keys without the '@' symbol.
+ * @returns An object containing the adjusted key, entity type, a flag to stop processing, and the namespace.
+ */
 function getKeyAndEntityTypeOfReferenceFacet(oDataServiceAVT, key, entityType, propertyValue, oDataVersion = ux_specification_types_1.FioriElementsVersion.v2, keyForRelatedFacetKeys = false) {
     let stopProcessing = false;
     let namespace;
@@ -409,12 +453,14 @@ function getKeyAndEntityTypeOfReferenceFacet(oDataServiceAVT, key, entityType, p
 }
 /**
  * Resolve page section(get key and label->description).
+ *
  * @param facetDefinition - the actual annotation record
+ * @param sourceEntityType - The source entity type to be used for resolving facets
+ * @param oDataServiceAVT - complete service information, as returned by annotation vocabularies tool
+ * @param logger - Logger class for logging messages
+ * @param oDataVersion - OData version
  * @param keyForRelatedFacetKeys - construct key for 'keyForRelatedFacetKeys' property(used to define custom sections) - we should not add '@' symbol there.
- * @param {FioriElementsVersion} oDataVersion - OData version
- * @param {ConvertedMetadata} oDataServiceAVT - complete service information, as returned by annotation vocabularies tool
- * @param {ExtensionLogger} logger - Logger class for logging messages
- * @returns {FacetSection} - object comprising the relevant facet information
+ * @returns - object comprising the relevant facet information
  */
 function getSectionFacet(facetDefinition, sourceEntityType, oDataServiceAVT, logger, oDataVersion = ux_specification_types_1.FioriElementsVersion.v2, keyForRelatedFacetKeys = false) {
     //Take facet ID as fallback
@@ -455,7 +501,8 @@ function getSectionFacet(facetDefinition, sourceEntityType, oDataServiceAVT, log
     }
 }
 /**
- * Decodes encoded path element and returns it in form as used in manifest settings
+ * Decodes encoded path element and returns it in form as used in manifest settings.
+ *
  * @param {string} pathElement - path of the property in the manifest
  * @param {string} targetAnnotation - target annotation (optional)
  * @param {string} targetAnnotationEncoded - target annotation in its encoded form, as used in manifest settings (optional)
@@ -474,6 +521,7 @@ function getDecodedPathElement(pathElement, targetAnnotation, targetAnnotationEn
 /**
  * Method prepares value as empty object or array based on passed path.
  * For array path should end with '[]'.
+ *
  * @param {string} path - path of the property in the manifest
  * @returns prepared value based on passed path
  */
@@ -488,12 +536,13 @@ exports.prepareValueForPath = prepareValueForPath;
  * Method find object by given path in format "sap.ui5/extends/extensions".
  * An empty object is created if the path element does not exist yet.
  * Exception: if an empty array is the next element  of the 'path' definition, an empty array is created instead of an empty object.
+ *
  * @param {object} manifest - manifest that is being modified during export
  * @param {string} path - path of the property in the manifest
  * @param {string} targetAnnotation - target annotation (optional)
  * @param {string} targetAnnotationEncoded - target annotation in its encoded form, as used in manifest settings
  * @param {boolean} value - specific value to apply for unexisting property for given path
- * @param {boolean} [readOnly=false] - indicates if the function should create object/array if existing value not found by given path
+ * @param {boolean} [readOnly] - indicates if the function should create object/array if existing value not found by given path
  * @returns returns section of the manifest based on path
  */
 const resolveManifestPath = (manifest, path, targetAnnotation, targetAnnotationEncoded, value, readOnly = false) => {
@@ -531,11 +580,12 @@ const resolveManifestPath = (manifest, path, targetAnnotation, targetAnnotationE
  * Finds the alias for a given namespace in the references' section of the converted service metadata.
  * An empty object is created if the path element does not exist yet.
  * Exception: if an empty array is the next element  of the 'path' definition, an empty array is created instead of an empty object.
+ *
  * @param {object} manifest - manifest that is being modified during export
  * @param {string} path - path of the property in the manifest
  * @param {string} targetAnnotation - target annotation (optional)
  * @param {string} targetAnnotationEncoded - target annotation in its encoded form, as used in manifest settings
- * @param {boolean} [readOnly=false] - indicates if the function should create object/array if existing value not found by given path
+ * @param {boolean} [readOnly] - indicates if the function should create object/array if existing value not found by given path
  * @returns returns section of the manifest based on path, generates an empty object in case it does not exists
  */
 const getManifestSectionByPathV4 = (manifest, path, targetAnnotation, targetAnnotationEncoded, readOnly = false) => {
@@ -544,6 +594,7 @@ const getManifestSectionByPathV4 = (manifest, path, targetAnnotation, targetAnno
 exports.getManifestSectionByPathV4 = getManifestSectionByPathV4;
 /**
  * Method sets value for passed path in manifest.
+ *
  * @param {object} manifest - manifest that is being modified during export
  * @param {string} path - path of the property in the manifest
  * @param {unknown} value - value to apply
@@ -554,6 +605,12 @@ const setManifestSectionByPathV4 = (manifest, path, value, targetAnnotation, tar
     resolveManifestPath(manifest, path, targetAnnotation, targetAnnotationEncoded, value);
 };
 exports.setManifestSectionByPathV4 = setManifestSectionByPathV4;
+/**
+ * Retrieves the schema key for a given line item record based on its type and properties.
+ *
+ * @param lineItemRecord - The line item record to process.
+ * @returns The schema key as a string, or undefined if no key is determined.
+ */
 function getSchemaKeyOfLineItemRecord(lineItemRecord) {
     let schemaKey, target, value;
     switch (lineItemRecord.$Type) {
@@ -602,7 +659,8 @@ function getSchemaKeyOfLineItemRecord(lineItemRecord) {
     return schemaKey;
 }
 /**
- * Determines if type of given annotation term is of UIAnnotationTerm
+ * Determines if type of given annotation term is of UIAnnotationTerm.
+ *
  * @param {string} path path in manifest
  * @param {string} alias for a given namespace
  * @param {EntityType} entityType - the entity type
@@ -632,10 +690,10 @@ function getUIAnnotationTerm(path, alias, entityType) {
     }
 }
 /**
- * Determines if type of given annotation term is of CommunicationAnnotationTerm
+ * Determines if type of given annotation term is of CommunicationAnnotationTerm.
+ *
  * @param {string} path path in manifest
  * @param {string} alias for a given namespace
- * @param {EntityType} entityType - the entity type
  * @returns Communication annotation term type
  */
 function getCommunicationAnnotationTerm(path, alias) {
@@ -650,7 +708,8 @@ function getCommunicationAnnotationTerm(path, alias) {
     }
 }
 /**
- * Determines the type of given annotation term
+ * Determines the type of given annotation term.
+ *
  * @param {string} path path in manifest
  * @param {string} alias for a given namespace
  * @param {EntityType} entityType - the entity type
@@ -660,11 +719,13 @@ function getAnnotationTerm(path, alias, entityType) {
     return getUIAnnotationTerm(path, alias, entityType) || getCommunicationAnnotationTerm(path, alias);
 }
 /**
- * Evaluates the target annotation of a reference facet and actualizes the facets for the config
- * @param {AnnotationTerm} annotationRecord - the actual annotation record
- * @param {FacetConfigs} facets - list of facets in config format, to be updated
- * @param {EntityType} entityType - the entity type
- * @param {ConvertedMetadata} oDataServiceAVT - complete service information, as returned by annotation vocabularies tool
+ * Evaluates the target annotation of a reference facet and actualizes the facets for the config.
+ *
+ * @param section - The section object in the app schema to be updated with annotation information.
+ * @param annotationRecord - the actual annotation record
+ * @param facets - list of facets in config format, to be updated
+ * @param entityType - the entity type
+ * @param oDataServiceAVT - complete service information, as returned by annotation vocabularies tool
  */
 function evaluateTargetAnnotation(section, annotationRecord, facets, entityType, oDataServiceAVT) {
     const alias = findAlias(ux_specification_types_1.UIVOCABULARY, oDataServiceAVT);
@@ -754,6 +815,7 @@ function evaluateTargetAnnotation(section, annotationRecord, facets, entityType,
 }
 /**
  * Method returns schema annotation path for passed fullyQualifiedName.
+ *
  * @param {EntityType} entityType entity type.
  * @param {string} fullyQualifiedName fully qualifier name.
  * @returns {TemplateType} Schema annotation path.
@@ -762,14 +824,15 @@ function getAnnotationPathUsingFullyQualifiedName(entityType, fullyQualifiedName
     return `/${entityType.fullyQualifiedName}/${fullyQualifiedName.split(entityType.fullyQualifiedName)[1]}`;
 }
 /**
- * Adds the information from facets to the config
- * @param {AnnotationTerm} annotationRecord - the actual annotation record
- * @param {ConvertedMetadata} oDataServiceAVT - complete service information, as returned by annotation vocabularies tool
- * @param {string} serviceName - name of the service of the app
- * @param {string} entityName - the entity (type) name
- * @param {FacetConfigs} facets - list of facets in config format, to be updated
- * @param {FioriElementsVersion} oDataVersion - OData version
- * @param {ExtensionLogger} logger - Logger class for logging messages
+ * Adds the information from facets to the config.
+ *
+ * @param annotationRecord - the actual annotation record
+ * @param oDataServiceAVT - complete service information, as returned by annotation vocabularies tool
+ * @param serviceName - name of the service of the app
+ * @param entityType - The entity type to be used for resolving facets
+ * @param facets - list of facets in config format, to be updated
+ * @param oDataVersion - OData version
+ * @param logger - Logger class for logging messages
  */
 function addFacetToConfig(annotationRecord, oDataServiceAVT, serviceName, entityType, facets, oDataVersion = ux_specification_types_1.FioriElementsVersion.v2, logger) {
     const section = getSectionFacet(annotationRecord, entityType, oDataServiceAVT, logger, oDataVersion, false);
@@ -804,11 +867,13 @@ function addFacetToConfig(annotationRecord, oDataServiceAVT, serviceName, entity
     }
 }
 /**
- * Retrieve header facet configurations that can be used to generate ObjectPage schemas
- * @param {QualifiedName} entityTypeName - the name of the actual entity type
- * @param {ConvertedMetadata} oDataServiceAVT - complete service information, as returned by annotation vocabularies tool
- * @param {FioriElementsVersion} oDataVersion - OData version
- * @param {ExtensionLogger} logger - Logger class for logging messages
+ * Retrieve header facet configurations that can be used to generate ObjectPage schemas.
+ *
+ * @param entityType - The entity type to be used for resolving facets
+ * @param oDataServiceAVT - complete service information, as returned by annotation vocabularies tool
+ * @param oDataVersion - OData version
+ * @param logger - Logger class for logging messages
+ * @returns - header facet configurations
  */
 function getObjectPageHeaderFacets(entityType, oDataServiceAVT, oDataVersion = ux_specification_types_1.FioriElementsVersion.v2, logger) {
     const facets = {};
@@ -828,11 +893,13 @@ function getObjectPageHeaderFacets(entityType, oDataServiceAVT, oDataVersion = u
     return facets;
 }
 /**
- * Retrieve facet configurations that can be used to generate ObjectPage schemas
- * @param {QualifiedName} entityTypeName - the name of the actual entity type
- * @param {ConvertedMetadata} oDataServiceAVT - complete service information, as returned by annotation vocabularies tool
+ * Retrieve facet configurations that can be used to generate ObjectPage schemas.
+ *
+ * @param entityType - The entity type to be used for resolving facets
+ * @param oDataServiceAVT - complete service information, as returned by annotation vocabularies tool
  * @param {FioriElementsVersion} oDataVersion - OData version
  * @param {ExtensionLogger} logger - Logger class for logging messages
+ * @returns - facet configurations
  */
 function getObjectPageFacets(entityType, oDataServiceAVT, oDataVersion = ux_specification_types_1.FioriElementsVersion.v2, logger) {
     const facets = {};
@@ -852,7 +919,8 @@ function getObjectPageFacets(entityType, oDataServiceAVT, oDataVersion = ux_spec
     return facets;
 }
 /**
- * Returns the version of Fiori elements (v2/v4) from a given manifest
+ * Returns the version of Fiori elements (v2/v4) from a given manifest.
+ *
  * @param manifest - the manifest.json file
  * @returns FioriElementsVersion
  */
@@ -865,7 +933,10 @@ function getFEVersionFromManifest(manifest) {
         const targets = manifest[ux_specification_types_1.ManifestSection.ui5]?.routing?.targets;
         const libs = manifest[ux_specification_types_1.ManifestSection.ui5]?.dependencies?.libs;
         if ((targets &&
-            Object.keys(targets).find((targetKey) => exports.V4_TEMPLATES.indexOf(targets[targetKey].name) > -1)) ||
+            Object.keys(targets).find((targetKey) => {
+                const name = typeof targets[targetKey].name === 'string' ? targets[targetKey].name : '';
+                return exports.V4_TEMPLATES.indexOf(name) > -1 || convertTemplateNameToPageTypeV4(name);
+            })) ||
             (libs && Object.keys(libs).find((lib) => exports.V4_LIBS.indexOf(lib) > -1))) {
             return ux_specification_types_1.FioriElementsVersion.v4;
         }
@@ -891,7 +962,8 @@ function getMainService(manifest) {
         : undefined;
 }
 /**
- * Returns the oData version of the service (if any) from a given manifest
+ * Returns the oData version of the service (if any) from a given manifest.
+ *
  * @param manifest - the manifest.json file
  * @returns the OData version
  */
@@ -904,10 +976,11 @@ function getODataVersionFromManifest(manifest) {
     return dataSource?.settings?.odataVersion === '4.0' ? ux_specification_types_1.OdataVersion.v4 : ux_specification_types_1.OdataVersion.v2;
 }
 /**
- * Determines the template type of a V2 app
+ * Determines the template type of a V2 app.
+ *
  * @param manifest - the manifest.json file
  * @param {ExtensionLogger} logger - Logger class for logging messages
- * @returns {TemplateType} the template type
+ * @returns the template type
  */
 function determineV2Template(manifest, logger) {
     let templateType;
@@ -951,7 +1024,8 @@ function determineV2Template(manifest, logger) {
     return templateType;
 }
 /**
- * Determines the template type of a single page
+ * Determines the template type of a single page.
+ *
  * @param v4Page - single page from routing targets
  * @returns {TemplateType | undefined} the template type
  */
@@ -980,7 +1054,8 @@ function determineV4PageTemplateType(v4Page) {
     return templateType;
 }
 /**
- * Determines the template type, based on the given manifest routing target entries of the app
+ * Determines the template type, based on the given manifest routing target entries of the app.
+ *
  * @param v4Pages - pages from routing targets
  * @returns {TemplateType | undefined} the template type
  */
@@ -996,7 +1071,8 @@ function determineV4TemplateFromPages(v4Pages) {
     return templateType;
 }
 /**
- * Determines the template type of a V4 app
+ * Determines the template type of a V4 app.
+ *
  * @param manifest - the manifest.json file
  * @param {ExtensionLogger} logger - Logger class for logging messages
  * @returns {TemplateType} the template type
@@ -1031,7 +1107,8 @@ function determineV4Template(manifest, logger) {
     return templateType;
 }
 /**
- * Determines the template type, based on the given manifest entries of the app
+ * Determines the template type, based on the given manifest entries of the app.
+ *
  * @param manifest - the manifest.json file
  * @param {FioriElementsVersion} fioriElementsVersion - OData or FE version
  * @param {ExtensionLogger} logger - Logger class for logging messages
@@ -1051,7 +1128,8 @@ function getTemplateTypeFromManifest(manifest, fioriElementsVersion, logger) {
     return templateType;
 }
 /**
- * Adds title to a section or header section in an app schema
+ * Adds title to a section or header section in an app schema.
+ *
  * @param facet - intermediate facet structure comprising annotation information
  * @param section - section in the app schema
  * @param facetKey - key of the facet
@@ -1067,7 +1145,8 @@ function addSectionTitle(facet, section, facetKey) {
     }
 }
 /**
- * Adds description to a section or header section in an app schema
+ * Adds description to a section or header section in an app schema.
+ *
  * @param facet - intermediate facet structure comprising annotation information
  * @param section - section in the app schema
  * @param facetKey - key of the facet
@@ -1084,7 +1163,8 @@ function addSectionDescription(facet, section, facetKey) {
     }
 }
 /**
- * Adds target title or description to a section or header section in an app schema
+ * Adds target title or description to a section or header section in an app schema.
+ *
  * @param facet - intermediate facet structure comprising annotation information
  * @param section - section in the app schema
  * @param facetKey - key of the facet
@@ -1106,10 +1186,10 @@ function addTargetTitleAndSectionDescription(facet, section, facetKey) {
     }
 }
 /**
- * Adds chart (S)PV header facet ID, in case chart has no title
+ * Adds chart (S)PV header facet ID, in case chart has no title.
+ *
  * @param facet - intermediate facet structure comprising annotation information
  * @param section - section in the app schema
- * @param facetKey - key of the facet
  */
 function addChartFacetID(facet, section) {
     if (facet?.ID && section.description?.startsWith('Chart#')) {
@@ -1118,7 +1198,10 @@ function addChartFacetID(facet, section) {
 }
 /**
  * Creates a default object for a new section or subsection, and adds the ID as title if present.
- * @param facet Facet configuration, to be analyzed
+ *
+ * @param appSchema - The application-specific JSON schema.
+ * @param facet - Facet configuration, to be analyzed.
+ * @param facetKey - The key of the facet.
  * @returns the new section object
  */
 function createDefaultSection(appSchema, facet, facetKey) {
@@ -1134,12 +1217,13 @@ function createDefaultSection(appSchema, facet, facetKey) {
 }
 /**
  * Retrieve page section data(so far id/key and label/description).
+ *
  * @param {EntityType} entityType The actual entityType
  * @param {ConvertedMetadata} oDataServiceAVT - complete service information, as returned by annotation vocabularies tool
  * @param {ExtensionLogger} logger - Logger class for logging messages
  * @param {FioriElementsVersion} oDataVersion - OData version
- * @param {boolean} [checkUnresolvableFacets=false] - Check and avoid facets and sections without ID and Target.
- * @returns {FacetSection[]} - Array of facets or sections
+ * @param {boolean} [checkUnresolvableFacets] - Check and avoid facets and sections without ID and Target.
+ * @returns - Array of facets or sections
  */
 function getObjectPageFacetSection(entityType, oDataServiceAVT, logger, oDataVersion = ux_specification_types_1.FioriElementsVersion.v2, checkUnresolvableFacets = false) {
     const alias = findAlias(ux_specification_types_1.UIVOCABULARY, oDataServiceAVT);
@@ -1162,7 +1246,8 @@ function getObjectPageFacetSection(entityType, oDataServiceAVT, logger, oDataVer
     }
 }
 /**
- * Cleans empty sub-structures from the export result for manifest
+ * Cleans empty sub-structures from the export result for manifest.
+ *
  * @param {object} manifest - manifest.json part of the export result
  * @param {string} path  - path in the manifest
  * @param {boolean} deletionRequest - if set to true, any manifest setting specified by entityPath gets deleted even if it comprises any unknown property
@@ -1208,8 +1293,9 @@ const deleteEmptyStructure = (manifest, path, deletionRequest, entityPathArray,
 exports.deleteEmptyStructure = deleteEmptyStructure;
 /**
  * Method which returns generic schema file name.
+ *
  * @param {SchemaType | PageTypeV2} schemaType Schema type or Page type.
- * @return {string} File name of generic schema.
+ * @returns {string} File name of generic schema.
  */
 const getGenericSchemaFileName = (schemaType) => {
     if (schemaType === ux_specification_types_1.SchemaType.FreestylePage) {
@@ -1223,9 +1309,11 @@ const getGenericSchemaFileName = (schemaType) => {
 };
 /**
  * Method which returns schema file name and path depending on passed schema or page type.
+ *
  * @param {SchemaType | PageTypeV2} schemaType Schema type or Page type.
  * @param {string} [pageId] target page id from manifest.json
- * @return {SchemaFilePath} File path info.
+ * @param viewId - The view ID for custom pages (optional).
+ * @returns {SchemaFilePath} File path info.
  */
 const getSchemaFilePath = (schemaType, pageId, viewId) => {
     const schemaFile = {
@@ -1275,6 +1363,7 @@ const getSchemaFilePath = (schemaType, pageId, viewId) => {
 exports.getSchemaFilePath = getSchemaFilePath;
 /**
  * Method which generates id of page according to passed parameters
+ *
  * @param appVersion - Fiori Elements version - V2 or V4
  * @param pageType - Page type
  * @param entitySet - Entity Set
@@ -1282,6 +1371,15 @@ exports.getSchemaFilePath = getSchemaFilePath;
  * @param pageName - Page name in manifest. Used if entitySet is empty
  * @returns {string} Generated page id
  */
+/**
+ * Generates a unique page ID based on the provided parameters.
+ *
+ * @param pageType - The type of the page (e.g., ListReport, ObjectPage, etc.).
+ * @param entitySet - The entity set associated with the page.
+ * @param viewId - The view ID for custom pages (optional).
+ * @param pageName - The name of the page in the manifest (used if entitySet is empty).
+ * @returns The generated page ID as a string.
+ */
 function generatePageId(pageType, entitySet, viewId, pageName) {
     if (pageType === ux_specification_types_1.PageTypeV2.CustomPage) {
         const names = viewId && viewId.split('.');
@@ -1299,6 +1397,7 @@ function generatePageId(pageType, entitySet, viewId, pageName) {
 }
 /**
  * Method finds matching objects against passed interface of 'additionalProperties' and returns array of matching object keys.
+ *
  * @param {Definition} appSchema - App-specific JSON schema.
  * @param {Definition} additionalProperties - Allowed additional properties.
  * @param {object} configObject -Container object to find matching childs.
@@ -1330,6 +1429,15 @@ function findMatchingKeysByAdditionalProperties(appSchema, additionalProperties,
     }
     return result;
 }
+/**
+ * Populates a given array with definitions from an application's schema that match certain conditions defined by the current configuration object and element reference.
+ *
+ * @param element - The element containing a reference ($ref) to a specific definition within the application schema.
+ * @param appSchema - The application's schema object containing all definitions.
+ * @param currentConfigObject - The current configuration object which is evaluated against the schema definitions.
+ * @param definitionArray - The array to which matching definitions are added based on the evaluation.
+ * This function does not return any value but modifies the definitionArray parameter by adding appropriate definitions.
+ */
 function fillArrayFromAnyOfReference(element, appSchema, currentConfigObject, definitionArray) {
     const $ref = element.$ref;
     if (!$ref) {
@@ -1357,7 +1465,8 @@ function fillArrayFromAnyOfReference(element, appSchema, currentConfigObject, de
     }
 }
 /**
- * Fills an array of next definitions from given references in the JSON schema
+ * Fills an array of next definitions from given references in the JSON schema.
+ *
  * @param propertyDefinition - Definition of the current property in schema
  * @param currentConfigObject - Current object in the config JSON. Evaluated to get the right value of a controlling property,
  *                              for making the right choice in case of multiple options (anyOf)
@@ -1383,7 +1492,8 @@ function fillArrayFromPropertyDefinition(propertyDefinition, currentConfigObject
 }
 /**
  * Determines the next definition to be handled, based on the definition array.
- * It also creates the Metadata instance for the next definition, to subsequently access metadata like the syncRule
+ * It also creates the Metadata instance for the next definition, to subsequently access metadata like the syncRule.
+ *
  * @param definitionArray - Array of definitions, as determined by fillArrayFromNextDefinition
  * @param appSchema - app-specific JSON schema
  * @param title - default title
@@ -1435,7 +1545,8 @@ function determineNextDefinitionFromDefinitionArray(definitionArray, appSchema,
     return nextDefinition;
 }
 /**
- * Recursive function to determine the next config part, next definition in the app schema and the title
+ * Recursive function to determine the next config part, next definition in the app schema and the title.
+ *
  * @param appSchema - app-specific JSON schema
  * @param title - default title
  * @param currentConfigObject - current part of the configuration that gets traversed
@@ -1443,6 +1554,7 @@ function determineNextDefinitionFromDefinitionArray(definitionArray, appSchema,
  * @param key - actual key
  * @param {MetadataInstanceInterface} factory - factory for creating metadata instances
  * @param pageType - page type
+ * @returns {NextDefinition} - Next target definition to process
  */
 function getNextTargetDefinition(appSchema, title, currentConfigObject, propertyDefinition, key, factory, pageType) {
     let nextDefinition;
@@ -1458,12 +1570,12 @@ function getNextTargetDefinition(appSchema, title, currentConfigObject, property
     return nextDefinition;
 }
 /**
- * Custom array merge function called by deepmerge's merge function
+ * Custom array merge function called by deepmerge's merge function.
  *
  * @param {*} target Target array
  * @param {*} source Source array
  * @param {*} options options object provided by deepmerge's merge function
- * @returns
+ * @returns {string[]} Combined array with unique elements from both target and source arrays.
  */
 const arrayCombineMerge = (target, source, options) => {
     const destination = target.slice();
@@ -1482,7 +1594,8 @@ const arrayCombineMerge = (target, source, options) => {
 };
 exports.arrayCombineMerge = arrayCombineMerge;
 /**
- * Converts an enum into a CSV
+ * Converts an enum into a CSV.
+ *
  * @param {object} manifestSection - manifestSection where the key exists
  * @param {object} configPart - Property as mentioned in config file
  * @param {string} key - Property to be exported to manifest
@@ -1494,7 +1607,8 @@ function convertEnumToCSV(manifestSection, configPart, key) {
     manifestSection[key] = field.join();
 }
 /**
- * Converts an action ID from the internal format (schema, config) to the stable ID representation
+ * Converts an action ID from the internal format (schema, config) to the stable ID representation.
+ *
  * @param actionId - the (unique) internal format of the action ID
  * @returns the converted action ID
  */
@@ -1505,7 +1619,8 @@ function convertActionKeyToStableId(actionId) {
     return (actionId.indexOf('??') > -1 ? actionId.split('??')[1] : actionId).replace(/@/g, '::');
 }
 /**
- * Method returns definition key for passed '$ref' property by removing 'definition' prefix
+ * Method returns definition key for passed '$ref' property by removing 'definition' prefix.
+ *
  * @param {string} $ref Definition reference.
  * @returns Definition key.
  */
@@ -1514,6 +1629,7 @@ function getDefinitionKey($ref) {
 }
 /**
  * Method returns definition $ref' property for passed definition key.
+ *
  * @param {string} key Definition key.
  * @returns Definition reference.
  */
@@ -1555,6 +1671,7 @@ function updatePropertyIndices(schema, order) {
 }
 /**
  * Method to get value for passed path in passed object.
+ *
  * @param obj Object to check.
  * @param paths Path for searching property/value.
  * @returns Found value for passed path.
@@ -1576,8 +1693,9 @@ function getJSONPropertyByPath(obj, paths) {
     return current;
 }
 /**
- * Method to remove namespaces
- * @param {string } [sId]
+ * Method to remove namespaces.
+ *
+ * @param sId - The string identifier to process and remove namespaces from.
  * @returns {string} modified string without namespace
  */
 function removeNamespaces(sId) {
@@ -1586,8 +1704,9 @@ function removeNamespaces(sId) {
     return sId;
 }
 /**
- * Method to replace namespaces with short hand form
- * @param {string } [sId]
+ * Method to replace namespaces with short hand form.
+ *
+ * @param {string } sId - The string identifier to process and replace namespaces with shorthand forms.
  * @returns {string} modified string with replaced namespaces
  */
 function replaceNamespaces(sId) {
@@ -1607,4 +1726,35 @@ function getRefType(element) {
         return reference.substring(exports.DEFINITION_LINK_PREFIX.length);
     }
 }
+/**
+ * Converts a template name string from 'manifest.json' to a corresponding `PageTypeV4` enum value.
+ *
+ * @param {string} templateName - The name of the template to convert.
+ * @returns {PageTypeV4 | undefined} The corresponding `PageTypeV4` enum value, or `undefined` if no match is found.
+ */
+function convertTemplateNameToPageTypeV4(templateName) {
+    if (templateName === ux_specification_types_1.v4.FE_TEMPLATE_V4_CUSTOM_PAGE) {
+        return ux_specification_types_1.PageTypeV4.FPMCustomPage;
+    }
+    if (templateName?.startsWith(`${ux_specification_types_1.v4.FE_NAMESPACE_V4}.`)) {
+        const pageType = templateName.split('.').at(-1);
+        if (pageType in ux_specification_types_1.PageTypeV4) {
+            return ux_specification_types_1.PageTypeV4[pageType];
+        }
+    }
+}
+/**
+ * Determines whether two template names match either directly or by resolving their corresponding page types.
+ *
+ * @param templateName1 The first template name to compare.
+ * @param templateName2 The second template name to compare.
+ * @returns Returns true if the template names match directly or their page types match; otherwise, false.
+ */
+function compareTemplateNames(templateName1, templateName2) {
+    if (templateName1 === templateName2) {
+        return true;
+    }
+    const pageType1 = convertTemplateNameToPageTypeV4(templateName1);
+    return pageType1 ? pageType1 === convertTemplateNameToPageTypeV4(templateName2) : false;
+}
 //# sourceMappingURL=utils.js.map