@sap-ux/fe-fpm-writer 0.18.9 → 0.19.1

package/dist/index.d.ts

@@ -4,8 +4,8 @@ export { CustomAction, TargetControl } from './action/types';
 export { generateCustomAction } from './action';
 export { CustomTableColumn } from './column/types';
 export { generateCustomColumn } from './column';
-export { CustomSection } from './section/types';
-export { generateCustomSection } from './section';
+export { CustomSection, CustomSubSection } from './section/types';
+export { generateCustomSection, generateCustomSubSection } from './section';
 export { CustomView } from './view/types';
 export { generateCustomView } from './view';
 export { enableFPM, FPMConfig } from './app';

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateControllerExtension = exports.ControllerExtensionPageType = exports.generateBuildingBlock = exports.BuildingBlockType = exports.validateVersion = exports.validateBasePath = exports.enableFPM = exports.generateCustomView = exports.generateCustomSection = exports.generateCustomColumn = exports.generateCustomAction = exports.TargetControl = exports.generateListReport = exports.generateObjectPage = exports.generateCustomPage = void 0;
+exports.generateControllerExtension = exports.ControllerExtensionPageType = exports.generateBuildingBlock = exports.BuildingBlockType = exports.validateVersion = exports.validateBasePath = exports.enableFPM = exports.generateCustomView = exports.generateCustomSubSection = exports.generateCustomSection = exports.generateCustomColumn = exports.generateCustomAction = exports.TargetControl = exports.generateListReport = exports.generateObjectPage = exports.generateCustomPage = void 0;
 var page_1 = require("./page");
 Object.defineProperty(exports, "generateCustomPage", { enumerable: true, get: function () { return page_1.generateCustomPage; } });
 Object.defineProperty(exports, "generateObjectPage", { enumerable: true, get: function () { return page_1.generateObjectPage; } });
@@ -13,6 +13,7 @@ var column_1 = require("./column");
 Object.defineProperty(exports, "generateCustomColumn", { enumerable: true, get: function () { return column_1.generateCustomColumn; } });
 var section_1 = require("./section");
 Object.defineProperty(exports, "generateCustomSection", { enumerable: true, get: function () { return section_1.generateCustomSection; } });
+Object.defineProperty(exports, "generateCustomSubSection", { enumerable: true, get: function () { return section_1.generateCustomSubSection; } });
 var view_1 = require("./view");
 Object.defineProperty(exports, "generateCustomView", { enumerable: true, get: function () { return view_1.generateCustomView; } });
 var app_1 = require("./app");

package/dist/section/index.d.ts

@@ -1,12 +1,13 @@
 import type { Editor } from 'mem-fs-editor';
-import type { CustomSection } from './types';
+import type { CustomSection, CustomSubSection } from './types';
 /**
  * Get the template folder for the given UI5 version.
  *
+ * @param folderName template folder name.
  * @param ui5Version required UI5 version.
  * @returns path to the template folder containing the manifest.json ejs template
  */
-export declare function getManifestRoot(ui5Version?: string): string;
+export declare function getManifestRoot(folderName: string, ui5Version?: string): string;
 /**
  * Add a custom section to an existing UI5 application.
  *
@@ -16,4 +17,13 @@ export declare function getManifestRoot(ui5Version?: string): string;
  * @returns {Promise<Editor>} the updated mem-fs editor instance
  */
 export declare function generateCustomSection(basePath: string, customSection: CustomSection, fs?: Editor): Editor;
+/**
+ * Add a custom sub section to an existing UI5 application.
+ *
+ * @param {string} basePath - the base path
+ * @param {CustomSubSection} customSubSection - the custom sub section configuration
+ * @param {Editor} [fs] - the mem-fs editor instance
+ * @returns {Promise<Editor>} the updated mem-fs editor instance
+ */
+export declare function generateCustomSubSection(basePath: string, customSubSection: CustomSubSection, fs?: Editor): Editor;
 //# sourceMappingURL=index.d.ts.map

package/dist/section/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateCustomSection = exports.getManifestRoot = void 0;
+exports.generateCustomSubSection = exports.generateCustomSection = exports.getManifestRoot = void 0;
 const mem_fs_1 = require("mem-fs");
 const mem_fs_editor_1 = require("mem-fs-editor");
 const path_1 = require("path");
@@ -14,16 +14,17 @@ const semver_1 = require("semver");
 /**
  * Get the template folder for the given UI5 version.
  *
+ * @param folderName template folder name.
  * @param ui5Version required UI5 version.
  * @returns path to the template folder containing the manifest.json ejs template
  */
-function getManifestRoot(ui5Version) {
+function getManifestRoot(folderName, ui5Version) {
     const minVersion = (0, semver_1.coerce)(ui5Version);
     if (!minVersion || (0, semver_1.gte)(minVersion, '1.86.0')) {
-        return (0, templates_1.getTemplatePath)('/section/1.86');
+        return (0, templates_1.getTemplatePath)(`/${folderName}/1.86`);
     }
     else {
-        return (0, templates_1.getTemplatePath)('/section/1.85');
+        return (0, templates_1.getTemplatePath)(`/${folderName}/1.85`);
     }
 }
 exports.getManifestRoot = getManifestRoot;
@@ -60,14 +61,15 @@ function enhanceConfig(fs, data, manifestPath, manifest) {
     return config;
 }
 /**
- * Add a custom section to an existing UI5 application.
+ * Add a custom section or sub section to an existing UI5 application.
  *
  * @param {string} basePath - the base path
  * @param {CustomSection} customSection - the custom section configuration
+ * @param {string} manifestTemplateRoot - path to the template folder containing the manifest.json ejs template
  * @param {Editor} [fs] - the mem-fs editor instance
  * @returns {Promise<Editor>} the updated mem-fs editor instance
  */
-function generateCustomSection(basePath, customSection, fs) {
+function generate(basePath, customSection, manifestTemplateRoot, fs) {
     (0, validate_1.validateVersion)(customSection.minUI5Version);
     if (!fs) {
         fs = (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
@@ -78,8 +80,7 @@ function generateCustomSection(basePath, customSection, fs) {
     // merge with defaults
     const completeSection = enhanceConfig(fs, customSection, manifestPath, manifest);
     // enhance manifest with section definition
-    const manifestRoot = getManifestRoot(customSection.minUI5Version);
-    const filledTemplate = (0, ejs_1.render)(fs.read((0, path_1.join)(manifestRoot, `manifest.json`)), completeSection, {});
+    const filledTemplate = (0, ejs_1.render)(fs.read((0, path_1.join)(manifestTemplateRoot, `manifest.json`)), completeSection, {});
     (0, file_1.extendJSON)(fs, {
         filepath: manifestPath,
         content: filledTemplate,
@@ -92,5 +93,30 @@ function generateCustomSection(basePath, customSection, fs) {
     }
     return fs;
 }
+/**
+ * Add a custom section to an existing UI5 application.
+ *
+ * @param {string} basePath - the base path
+ * @param {CustomSection} customSection - the custom section configuration
+ * @param {Editor} [fs] - the mem-fs editor instance
+ * @returns {Promise<Editor>} the updated mem-fs editor instance
+ */
+function generateCustomSection(basePath, customSection, fs) {
+    const manifestRoot = getManifestRoot('section', customSection.minUI5Version);
+    return generate(basePath, customSection, manifestRoot, fs);
+}
 exports.generateCustomSection = generateCustomSection;
+/**
+ * Add a custom sub section to an existing UI5 application.
+ *
+ * @param {string} basePath - the base path
+ * @param {CustomSubSection} customSubSection - the custom sub section configuration
+ * @param {Editor} [fs] - the mem-fs editor instance
+ * @returns {Promise<Editor>} the updated mem-fs editor instance
+ */
+function generateCustomSubSection(basePath, customSubSection, fs) {
+    const manifestRoot = getManifestRoot('subsection', customSubSection.minUI5Version);
+    return generate(basePath, customSubSection, manifestRoot, fs);
+}
+exports.generateCustomSubSection = generateCustomSubSection;
 //# sourceMappingURL=index.js.map

package/dist/section/types.d.ts

@@ -20,8 +20,14 @@ export interface CustomSection extends CustomElement, EventHandler {
 export interface CustomSectionDependencies {
     [key: string]: string;
 }
-export interface InternalCustomSection extends CustomSection, InternalCustomElement {
+export interface InternalCustomSection extends CustomSection, CustomSubSection, InternalCustomElement {
     content: string;
     dependencies?: CustomSectionDependencies;
 }
+export interface CustomSubSection extends CustomSection {
+    /**
+     * Id of parent section.
+     */
+    parentSection: string;
+}
 //# sourceMappingURL=types.d.ts.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/fe-fpm-writer",
   "description": "SAP Fiori elements flexible programming model writer",
-  "version": "0.18.9",
+  "version": "0.19.1",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -29,7 +29,7 @@
     "xpath": "0.0.32"
   },
   "devDependencies": {
-    "@sap-ux/project-access": "1.3.1",
+    "@sap-ux/project-access": "1.5.0",
     "@types/ejs": "3.1.0",
     "@types/mem-fs": "1.1.2",
     "@types/mem-fs-editor": "7.0.1",

package/templates/common/EventHandler.js

@@ -4,7 +4,7 @@ sap.ui.define([
     'use strict';
 
     return {
-        <%- (typeof eventHandlerFnName !== 'undefined' && eventHandlerFnName) || 'onPress' %>: function(oEvent) {
+        <%- eventHandlerFnName %>: function(oEvent) {
             MessageToast.show("Custom handler invoked.");
         }
     };

package/templates/common/EventHandler.ts

@@ -8,6 +8,6 @@ import MessageToast from 'sap/m/MessageToast';
  * @param this reference to the 'this' that the event handler is bound to.
  * @param <%- parameters.name %> <%- parameters.description %>
  */
-export function <%- (typeof eventHandlerFnName !== 'undefined' && eventHandlerFnName) || 'onPress' %>(this: ExtensionAPI, <%- parameters.name %>: <%- parameters.importType %>) {
+export function <%- eventHandlerFnName %>(this: ExtensionAPI, <%- parameters.name %>: <%- parameters.importType %>) {
     MessageToast.show("Custom handler invoked.");
 }

package/templates/subsection/1.85/manifest.json

@@ -0,0 +1,37 @@
+{
+    "sap.ui5": {
+        "routing": {
+            "targets": {
+                "<%- target %>": {
+                    "options": {
+                        "settings": {
+                            "content": {
+                                "body": {
+                                    "sections": {
+                                        "<%- parentSection %>": {
+                                            "subSections": {
+                                                "<%- name %>": {
+                                                    "name": "<%- ns %>.<%- name %>",
+                                                    "type": "XMLFragment",
+                                                    "position": {
+                                                        <% if (position.placement) { %> 
+                                                            "placement": "<%- position.placement %>", 
+                                                        <% } %>
+                                                        <% if (position.anchor) { %> 
+                                                            "anchor": "<%- position.anchor %>" 
+                                                        <% } %>
+                                                    },
+                                                    "title": "<%- title %>"
+                                                }
+                                            }
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        }
+    }
+}

package/templates/subsection/1.86/manifest.json

@@ -0,0 +1,36 @@
+{
+    "sap.ui5": {
+        "routing": {
+            "targets": {
+                "<%- target %>": {
+                    "options": {
+                        "settings": {
+                            "content": {
+                                "body": {
+                                    "sections": {
+                                        "<%- parentSection %>": {
+                                            "subSections": {
+                                                "<%- name %>": {
+                                                    "template": "<%- ns %>.<%- name %>",
+                                                    "position": {
+                                                        <% if (position.placement) { %> 
+                                                            "placement": "<%- position.placement %>", 
+                                                        <% } %>
+                                                        <% if (position.anchor) { %> 
+                                                            "anchor": "<%- position.anchor %>" 
+                                                        <% } %>
+                                                    },
+                                                    "title": "<%- title %>"
+                                                }
+                                            }
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        }
+    }
+}