@sap-ux/fe-fpm-writer 0.28.2 → 0.29.0

package/dist/building-block/index.js

@@ -38,11 +38,24 @@ const xml_formatter_1 = __importDefault(require("xml-formatter"));
 const validate_1 = require("../common/validate");
 const templates_1 = require("../templates");
 const types_2 = require("../prompts/types");
+const semver_1 = require("semver");
+const project_access_1 = require("@sap-ux/project-access");
 const PLACEHOLDERS = {
     'id': 'REPLACE_WITH_BUILDING_BLOCK_ID',
     'entitySet': 'REPLACE_WITH_ENTITY',
     'qualifier': 'REPLACE_WITH_A_QUALIFIER'
 };
+/**
+ * Gets manifest content.
+ *
+ * @param {string} basePath the base path
+ * @param {Editor} fs the memfs editor instance
+ * @returns {Manifest | undefined} the manifest content
+ */
+function getManifest(basePath, fs) {
+    const manifestPath = (0, path_1.join)(basePath, 'webapp/manifest.json');
+    return fs.readJSON(manifestPath);
+}
 /**
  * Generates a building block into the provided xml view file.
  *
@@ -62,7 +75,8 @@ function generateBuildingBlock(basePath, config, fs) {
     }
     // Read the view xml and template files and update contents of the view xml file
     const xmlDocument = getUI5XmlDocument(basePath, config.viewOrFragmentPath, fs);
-    const templateDocument = getTemplateDocument(config.buildingBlockData, xmlDocument, fs);
+    const manifest = getManifest(basePath, fs);
+    const templateDocument = getTemplateDocument(config.buildingBlockData, xmlDocument, fs, manifest);
     fs = updateViewFile(basePath, config.viewOrFragmentPath, config.aggregationPath, xmlDocument, templateDocument, fs);
     return fs;
 }
@@ -114,12 +128,12 @@ function getOrAddMacrosNamespace(ui5XmlDocument) {
 /**
  * Method returns default values for metadata path.
  *
- * @param {BuildingBlockType} type - building vlock type.
+ * @param {boolean} applyContextPath - whether to apply contextPath.
  * @param {boolean} usePlaceholders - apply placeholder values if value for attribute/property is not provided
  * @returns {MetadataPath} Default values for metadata path.
  */
-function getDefaultMetaPath(type, usePlaceholders) {
-    if (type === types_1.BuildingBlockType.Chart) {
+function getDefaultMetaPath(applyContextPath, usePlaceholders) {
+    if (applyContextPath) {
         return {
             metaPath: usePlaceholders ? `/${PLACEHOLDERS.qualifier}` : '',
             contextPath: usePlaceholders ? PLACEHOLDERS.entitySet : ''
@@ -132,21 +146,20 @@ function getDefaultMetaPath(type, usePlaceholders) {
 /**
  * Method converts object based metaPath to metadata path.
  *
- * @param {BuildingBlockType} type - building vlock type.
+ * @param {boolean} applyContextPath - whether to apply contextPath.
  * @param {BuildingBlockMetaPath} metaPath - object based metaPath.
  * @param {boolean} usePlaceholders - apply placeholder values if value for attribute/property is not provided
  * @returns {MetadataPath} Resolved metadata path information.
  */
-function getMetaPath(type, metaPath, usePlaceholders) {
+function getMetaPath(applyContextPath, metaPath, usePlaceholders) {
     if (!metaPath) {
-        return getDefaultMetaPath(type, usePlaceholders);
+        return getDefaultMetaPath(applyContextPath, usePlaceholders);
     }
     const { bindingContextType = 'absolute' } = metaPath;
     let { entitySet, qualifier } = metaPath;
     entitySet = entitySet || (usePlaceholders ? PLACEHOLDERS.entitySet : '');
     const qualifierOrPlaceholder = qualifier || (usePlaceholders ? PLACEHOLDERS.qualifier : '');
-    if (type === types_1.BuildingBlockType.Chart) {
-        // Special handling for chart - while runtime does not support approach without contextPath
+    if (applyContextPath) {
         const qualifierParts = qualifierOrPlaceholder.split('/');
         qualifier = qualifierParts.pop();
         return {
@@ -163,16 +176,22 @@ function getMetaPath(type, metaPath, usePlaceholders) {
  *
  * @param {BuildingBlock} buildingBlockData - the building block data
  * @param {Document} viewDocument - the view xml file document
+ * @param {Manifest} manifest - the manifest content
  * @param {Editor} fs - the memfs editor instance
  * @param {boolean} usePlaceholders - apply placeholder values if value for attribute/property is not provided
  * @returns {string} the template xml file content
  */
-function getTemplateContent(buildingBlockData, viewDocument, fs, usePlaceholders) {
+function getTemplateContent(buildingBlockData, viewDocument, manifest, fs, usePlaceholders) {
     const templateFolderName = buildingBlockData.buildingBlockType;
     const templateFilePath = (0, templates_1.getTemplatePath)(`/building-block/${templateFolderName}/View.xml`);
     if (typeof buildingBlockData.metaPath === 'object' || buildingBlockData.metaPath === undefined) {
+        // Special handling for chart - while runtime does not support approach without contextPath
+        // or for equal or below UI5 v1.96.0 contextPath is applied
+        const minUI5Version = manifest ? (0, semver_1.coerce)((0, project_access_1.getMinimumUI5Version)(manifest)) : undefined;
+        const applyContextPath = buildingBlockData.buildingBlockType === types_1.BuildingBlockType.Chart ||
+            !!(minUI5Version && (0, semver_1.lt)(minUI5Version, '1.97.0'));
         // Convert object based metapath to string
-        const metadataPath = getMetaPath(buildingBlockData.buildingBlockType, buildingBlockData.metaPath, usePlaceholders);
+        const metadataPath = getMetaPath(applyContextPath, buildingBlockData.metaPath, usePlaceholders);
         buildingBlockData = { ...buildingBlockData, metaPath: metadataPath.metaPath };
         if (!buildingBlockData.contextPath && metadataPath.contextPath) {
             buildingBlockData.contextPath = metadataPath.contextPath;
@@ -193,10 +212,11 @@ function getTemplateContent(buildingBlockData, viewDocument, fs, usePlaceholders
  * @param {BuildingBlock} buildingBlockData - the building block data
  * @param {Document} viewDocument - the view xml file document
  * @param {Editor} fs - the memfs editor instance
+ * @param  {Manifest} manifest - the manifest content
  * @returns {Document} the template xml file document
  */
-function getTemplateDocument(buildingBlockData, viewDocument, fs) {
-    const templateContent = getTemplateContent(buildingBlockData, viewDocument, fs);
+function getTemplateDocument(buildingBlockData, viewDocument, fs, manifest) {
+    const templateContent = getTemplateContent(buildingBlockData, viewDocument, manifest, fs);
     const errorHandler = (level, message) => {
         throw new Error(`Unable to parse template file with building block data. Details: [${level}] - ${message}`);
     };
@@ -275,7 +295,8 @@ function getSerializedFileContent(basePath, config, fs) {
     const xmlDocument = config.viewOrFragmentPath
         ? getUI5XmlDocument(basePath, config.viewOrFragmentPath, fs)
         : undefined;
-    const content = getTemplateContent(config.buildingBlockData, xmlDocument, fs, true);
+    const manifest = getManifest(basePath, fs);
+    const content = getTemplateContent(config.buildingBlockData, xmlDocument, manifest, fs, true);
     const filePathProps = getFilePathProps(basePath, config.viewOrFragmentPath);
     return {
         viewOrFragmentPath: {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/fe-fpm-writer",
   "description": "SAP Fiori elements flexible programming model writer",
-  "version": "0.28.2",
+  "version": "0.29.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -31,8 +31,8 @@
     "semver": "7.5.4",
     "xml-formatter": "2.6.1",
     "xpath": "0.0.33",
-    "@sap-ux/fiori-annotation-api": "0.1.39",
-    "@sap-ux/project-access": "1.27.0"
+    "@sap-ux/fiori-annotation-api": "0.1.40",
+    "@sap-ux/project-access": "1.27.1"
   },
   "devDependencies": {
     "@types/inquirer": "8.2.6",
@@ -42,7 +42,7 @@
     "@types/mem-fs-editor": "7.0.1",
     "@types/semver": "7.5.2",
     "@types/vinyl": "2.0.7",
-    "@sap-ux/ui-prompting": "0.1.7"
+    "@sap-ux/ui-prompting": "0.1.8"
   },
   "engines": {
     "node": ">=18.x"