@sap-ux/fe-fpm-writer 0.18.1 → 0.18.3

package/dist/common/types.d.ts

@@ -62,7 +62,7 @@ export interface ViewVariant {
     /**
      * The annotationPath of a specific variant.
      */
-    annotationPath: string;
+    annotationPath?: string;
     /**
      * View title, is shown in the tab item.
      */

package/dist/view/index.js

@@ -9,6 +9,38 @@ const validate_1 = require("../common/validate");
 const defaults_1 = require("../common/defaults");
 const event_handler_1 = require("../common/event-handler");
 const templates_1 = require("../templates");
+/**
+ * Merge the new view into the list of existing views (if any).
+ *
+ * @param {CustomView & Partial<InternalCustomView>} config - config for the template, views property gets updated
+ * @param {Manifest} manifest - the application manifest
+ */
+function mergeViews(config, manifest) {
+    var _a, _b, _c, _d, _e;
+    const newViews = {
+        paths: [
+            {
+                'key': config.key,
+                'label': config.label,
+                'template': `${config.ns}.${config.name}`
+            }
+        ]
+    };
+    const existingViews = (_e = (_d = ((_c = (_b = (_a = manifest['sap.ui5']) === null || _a === void 0 ? void 0 : _a.routing) === null || _b === void 0 ? void 0 : _b.targets) === null || _c === void 0 ? void 0 : _c[config.target]).options) === null || _d === void 0 ? void 0 : _d.settings) === null || _e === void 0 ? void 0 : _e.views;
+    if (existingViews === null || existingViews === void 0 ? void 0 : existingViews.paths) {
+        const index = existingViews.paths.findIndex((entry) => entry.key === newViews.paths[0].key);
+        if (index > -1) {
+            existingViews.paths[index] = newViews.paths[0];
+        }
+        else {
+            existingViews.paths.push(newViews.paths[0]);
+        }
+        config.views = existingViews;
+    }
+    else {
+        config.views = newViews;
+    }
+}
 /**
  * Enhances the provided custom view configuration with default data.
  *
@@ -19,19 +51,14 @@ const templates_1 = require("../templates");
  * @returns enhanced configuration
  */
 function enhanceConfig(fs, data, manifestPath, manifest) {
-    var _a, _b, _c, _d, _e;
     const config = Object.assign({}, data);
     defaults_1.setCommonDefaults(config, manifestPath, manifest);
-    // Apply event handler
+    // apply event handler
     if (config.eventHandler) {
         config.eventHandler = event_handler_1.applyEventHandlerConfiguration(fs, config, config.eventHandler, true, config.typescript);
     }
-    // existing views
-    const existingViews = (_e = (_d = ((_c = (_b = (_a = manifest['sap.ui5']) === null || _a === void 0 ? void 0 : _a.routing) === null || _b === void 0 ? void 0 : _b.targets) === null || _c === void 0 ? void 0 : _c[data.target])
-        .options) === null || _d === void 0 ? void 0 : _d.settings) === null || _e === void 0 ? void 0 : _e.views;
-    if (existingViews) {
-        config.views = existingViews;
-    }
+    // fill config.views, merge new data into existing views
+    mergeViews(config, manifest);
     // generate view content
     if (typeof config.control === 'string') {
         config.content = config.control;
@@ -63,12 +90,14 @@ function generateCustomView(basePath, customView, fs) {
     const filledTemplate = ejs_1.render(fs.read(templates_1.getTemplatePath('view/manifest.json')), completeView, {});
     fs.extendJSON(manifestPath, JSON.parse(filledTemplate));
     // add fragment
-    const viewPath = path_1.join(completeView.path, `${completeView.name}.fragment.xml`);
-    if (completeView.control === true) {
-        fs.copyTpl(templates_1.getTemplatePath('view/ext/CustomViewWithTable.xml'), viewPath, completeView);
-    }
-    else if (!fs.exists(viewPath)) {
-        fs.copyTpl(templates_1.getTemplatePath('common/Fragment.xml'), viewPath, completeView);
+    if (customView.viewUpdate !== false) {
+        const viewPath = path_1.join(completeView.path, `${completeView.name}.fragment.xml`);
+        if (completeView.control === true) {
+            fs.copyTpl(templates_1.getTemplatePath('view/ext/CustomViewWithTable.xml'), viewPath, completeView);
+        }
+        else if (!fs.exists(viewPath)) {
+            fs.copyTpl(templates_1.getTemplatePath('common/Fragment.xml'), viewPath, completeView);
+        }
     }
     return fs;
 }

package/dist/view/types.d.ts

@@ -17,6 +17,10 @@ export interface CustomView extends CustomElement, EventHandler {
      * If set to true, a table macro control will be generated.
      */
     control?: string | true;
+    /**
+     * Indicates that the view shall be created or updated
+     */
+    viewUpdate?: boolean;
 }
 export interface InternalCustomView extends CustomView, InternalCustomElement {
     content: string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/fe-fpm-writer",
   "description": "SAP Fiori elements flexible programming model writer",
-  "version": "0.18.1",
+  "version": "0.18.3",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -20,7 +20,7 @@
     "!dist/**/*.map"
   ],
   "dependencies": {
-    "@xmldom/xmldom": "0.8.4",
+    "@xmldom/xmldom": "0.8.6",
     "ejs": "3.1.7",
     "mem-fs": "2.1.0",
     "mem-fs-editor": "9.4.0",
@@ -29,7 +29,7 @@
     "xpath": "0.0.32"
   },
   "devDependencies": {
-    "@sap-ux/project-access": "1.0.3",
+    "@sap-ux/project-access": "1.0.4",
     "@types/ejs": "3.1.0",
     "@types/mem-fs": "1.1.2",
     "@types/mem-fs-editor": "7.0.1",

package/templates/view/manifest.json

@@ -20,17 +20,16 @@
                             "views": {
                                 "paths": [
                                     <% if (locals.views?.paths) { %>
-                                        <% locals.views.paths.forEach ( (path) => { %>
-                                            <%- JSON.stringify(path) %>,
+                                        <% for (var i =0; i < locals.views.paths.length; i++) { %>
+                                            <%- JSON.stringify(locals.views.paths[i]) %>
+                                            <% if (i < locals.views.paths.length - 1) { %>
+                                            ,
+                                            <%
+                                            }  %>
                                     <%
-                                        } ) %>
+                                        }  %>
                                     <%
                                     } %>
-                                    {
-                                        "key": "<%- key %>",
-                                        "label": "<%- label %>",
-                                        "template": "<%- ns %>.<%- name %>"
-                                    }
                                 ]
                             }
                         }