@sap-ux/fe-fpm-writer 0.39.21 → 0.39.23

package/dist/action/index.js

@@ -104,6 +104,10 @@ async function generateCustomAction(basePath, actionConfig, fs) {
     // enhance manifest with action definition and controller reference
     const actions = enhanceManifestAndGetActionsElementReference(manifest, config.target);
     Object.assign(actions, JSON.parse((0, ejs_1.render)(fs.read((0, templates_1.getTemplatePath)(`action/manifest.action.json`)), config, {})));
+    if (config.target.menuId) {
+        // The action should be part of the menu
+        actions[config.target.menuId].menu.push(config.name);
+    }
     fs.writeJSON(manifestPath, manifest, undefined, (0, file_1.getJsonSpace)(fs, manifestPath, actionConfig.tabInfo));
     return fs;
 }

package/dist/action/types.d.ts

@@ -12,6 +12,7 @@ export interface CustomActionTarget {
     customSectionKey?: string;
     navProperty?: string;
     qualifier?: string;
+    menuId?: string;
 }
 export interface CustomAction extends CustomElement, EventHandler {
     target: CustomActionTarget;

package/dist/action-menu/index.d.ts

@@ -0,0 +1,12 @@
+import type { Editor } from 'mem-fs-editor';
+import { type ActionMenu } from './types';
+/**
+ * Add a custom page to an existing UI5 application.
+ *
+ * @param {string} basePath - the base path
+ * @param {ActionMenu} actionMenuConfig - the custom action configuration
+ * @param {Editor} [fs] - the memfs editor instance
+ * @returns {Promise<Editor>} the updated memfs editor instance
+ */
+export declare function generateActionMenu(basePath: string, actionMenuConfig: ActionMenu, fs?: Editor): Promise<Editor>;
+//# sourceMappingURL=index.d.ts.map

package/dist/action-menu/index.js

@@ -0,0 +1,79 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateActionMenu = generateActionMenu;
+const mem_fs_1 = require("mem-fs");
+const mem_fs_editor_1 = require("mem-fs-editor");
+const ejs_1 = require("ejs");
+const validate_1 = require("../common/validate");
+const templates_1 = require("../templates");
+const file_1 = require("../common/file");
+const utils_1 = require("../common/utils");
+const action_1 = require("../action");
+const types_1 = require("./types");
+/**
+ * Add a custom page to an existing UI5 application.
+ *
+ * @param {string} basePath - the base path
+ * @param {ActionMenu} actionMenuConfig - the custom action configuration
+ * @param {Editor} [fs] - the memfs editor instance
+ * @returns {Promise<Editor>} the updated memfs editor instance
+ */
+async function generateActionMenu(basePath, actionMenuConfig, fs) {
+    (0, validate_1.validateVersion)(actionMenuConfig.minUI5Version);
+    if (!fs) {
+        fs = (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
+    }
+    await (0, validate_1.validateBasePath)(basePath, fs);
+    const { path: manifestPath, content: manifest } = await (0, utils_1.getManifest)(basePath, fs);
+    if (actionMenuConfig.target.menuId) {
+        // add new action to existing menu
+        const actionsContainer = getExistingMenuItemsContainer(manifest, actionMenuConfig.target);
+        const actionsList = actionsContainer[actionMenuConfig.target.menuId].menu;
+        actionsList.push(...actionMenuConfig.settings.actions);
+    }
+    else {
+        // enhance manifest with action menu definition
+        const actionsContainer = (0, action_1.enhanceManifestAndGetActionsElementReference)(manifest, actionMenuConfig.target);
+        Object.assign(actionsContainer, JSON.parse((0, ejs_1.render)(fs.read((0, templates_1.getTemplatePath)(`action/manifest.action-menu.json`)), actionMenuConfig, {})));
+        for (const { key, position } of actionMenuConfig.positionUpdates ?? []) {
+            if (['__proto__', 'constructor', 'prototype'].includes(key)) {
+                // Prevent prototype pollution via special property names
+                continue;
+            }
+            const action = actionsContainer[key];
+            if (!action) {
+                continue;
+            }
+            action.position = position;
+            if (!position) {
+                delete action.position;
+            }
+        }
+    }
+    fs.writeJSON(manifestPath, manifest, undefined, (0, file_1.getJsonSpace)(fs, manifestPath, actionMenuConfig.tabInfo));
+    return fs;
+}
+/**
+ * Returns actions manifest entry for a given action menu target control.
+ *
+ * @param manifest - manifest content
+ * @param target - target control
+ * @returns - manifest node - container for a menu
+ */
+function getExistingMenuItemsContainer(manifest, target) {
+    const page = manifest['sap.ui5'].routing.targets[target.page];
+    if (target.control === types_1.TargetControl.header) {
+        return page.options.settings.content[target.control].actions;
+    }
+    else if (target.control === types_1.TargetControl.body && target.customSectionKey) {
+        return page.options.settings.content[target.control].sections[target.customSectionKey].actions;
+    }
+    else {
+        // Custom actions for other elements are defined in: 'options/settings/controlConfiguration/<element>/actions'
+        const controlPrefix = target.navProperty ? target.navProperty + '/' : '';
+        const controlSuffix = target.qualifier ? '#' + target.qualifier : '';
+        const controlId = `${controlPrefix}${target.control}${controlSuffix}`;
+        return page.options.settings.controlConfiguration[controlId].actions;
+    }
+}
+//# sourceMappingURL=index.js.map

package/dist/action-menu/types.d.ts

@@ -0,0 +1,28 @@
+import type { CustomElement, Position } from '../common/types';
+export declare enum TargetControl {
+    header = "header",
+    body = "body",
+    section = "@com.sap.vocabularies.UI.v1.FieldGroup",
+    table = "@com.sap.vocabularies.UI.v1.LineItem"
+}
+export interface ActionMenuTarget {
+    page: string;
+    control: TargetControl;
+    customSectionKey?: string;
+    navProperty?: string;
+    qualifier?: string;
+    menuId?: string;
+}
+export interface ActionMenu extends CustomElement {
+    target: ActionMenuTarget;
+    positionUpdates?: {
+        key: string;
+        position: Position | undefined;
+    }[];
+    settings: {
+        text: string;
+        actions: string[];
+        position?: Position;
+    };
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/action-menu/types.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TargetControl = void 0;
+var TargetControl;
+(function (TargetControl) {
+    TargetControl["header"] = "header";
+    TargetControl["body"] = "body";
+    TargetControl["section"] = "@com.sap.vocabularies.UI.v1.FieldGroup";
+    TargetControl["table"] = "@com.sap.vocabularies.UI.v1.LineItem";
+})(TargetControl || (exports.TargetControl = TargetControl = {}));
+//# sourceMappingURL=types.js.map

package/dist/index.d.ts

@@ -2,6 +2,8 @@ export { CustomPage, ObjectPage, ListReport } from './page/types';
 export { generateCustomPage, generateObjectPage, generateListReport } from './page';
 export { CustomAction, TargetControl } from './action/types';
 export { generateCustomAction } from './action';
+export { ActionMenu, TargetControl as ActionMenuTargetControl } from './action-menu/types';
+export { generateActionMenu } from './action-menu';
 export { CustomTableColumn } from './column/types';
 export { generateCustomColumn } from './column';
 export { CustomHeaderSection, CustomSection, CustomSubSection, RequestGroupId, DesignTime } from './section/types';

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.initI18n = exports.generateCustomField = exports.generateControllerExtension = exports.ControllerExtensionPageType = exports.PromptsAPI = exports.PromptsType = exports.getSerializedFileContent = exports.generateBuildingBlock = exports.BuildingBlockType = exports.validateVersion = exports.validateBasePath = exports.enableFPM = exports.generateCustomView = exports.generateCustomFilter = exports.generateCustomHeaderSection = exports.generateCustomSubSection = exports.generateCustomSection = exports.DesignTime = exports.RequestGroupId = exports.generateCustomColumn = exports.generateCustomAction = exports.TargetControl = exports.generateListReport = exports.generateObjectPage = exports.generateCustomPage = void 0;
+exports.initI18n = exports.generateCustomField = exports.generateControllerExtension = exports.ControllerExtensionPageType = exports.PromptsAPI = exports.PromptsType = exports.getSerializedFileContent = exports.generateBuildingBlock = exports.BuildingBlockType = exports.validateVersion = exports.validateBasePath = exports.enableFPM = exports.generateCustomView = exports.generateCustomFilter = exports.generateCustomHeaderSection = exports.generateCustomSubSection = exports.generateCustomSection = exports.DesignTime = exports.RequestGroupId = exports.generateCustomColumn = exports.generateActionMenu = exports.ActionMenuTargetControl = 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; } });
@@ -9,11 +9,15 @@ var types_1 = require("./action/types");
 Object.defineProperty(exports, "TargetControl", { enumerable: true, get: function () { return types_1.TargetControl; } });
 var action_1 = require("./action");
 Object.defineProperty(exports, "generateCustomAction", { enumerable: true, get: function () { return action_1.generateCustomAction; } });
+var types_2 = require("./action-menu/types");
+Object.defineProperty(exports, "ActionMenuTargetControl", { enumerable: true, get: function () { return types_2.TargetControl; } });
+var action_menu_1 = require("./action-menu");
+Object.defineProperty(exports, "generateActionMenu", { enumerable: true, get: function () { return action_menu_1.generateActionMenu; } });
 var column_1 = require("./column");
 Object.defineProperty(exports, "generateCustomColumn", { enumerable: true, get: function () { return column_1.generateCustomColumn; } });
-var types_2 = require("./section/types");
-Object.defineProperty(exports, "RequestGroupId", { enumerable: true, get: function () { return types_2.RequestGroupId; } });
-Object.defineProperty(exports, "DesignTime", { enumerable: true, get: function () { return types_2.DesignTime; } });
+var types_3 = require("./section/types");
+Object.defineProperty(exports, "RequestGroupId", { enumerable: true, get: function () { return types_3.RequestGroupId; } });
+Object.defineProperty(exports, "DesignTime", { enumerable: true, get: function () { return types_3.DesignTime; } });
 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; } });
@@ -27,16 +31,16 @@ Object.defineProperty(exports, "enableFPM", { enumerable: true, get: function ()
 var validate_1 = require("./common/validate");
 Object.defineProperty(exports, "validateBasePath", { enumerable: true, get: function () { return validate_1.validateBasePath; } });
 Object.defineProperty(exports, "validateVersion", { enumerable: true, get: function () { return validate_1.validateVersion; } });
-var types_3 = require("./building-block/types");
-Object.defineProperty(exports, "BuildingBlockType", { enumerable: true, get: function () { return types_3.BuildingBlockType; } });
+var types_4 = require("./building-block/types");
+Object.defineProperty(exports, "BuildingBlockType", { enumerable: true, get: function () { return types_4.BuildingBlockType; } });
 var building_block_1 = require("./building-block");
 Object.defineProperty(exports, "generateBuildingBlock", { enumerable: true, get: function () { return building_block_1.generateBuildingBlock; } });
 Object.defineProperty(exports, "getSerializedFileContent", { enumerable: true, get: function () { return building_block_1.getSerializedFileContent; } });
 var prompts_1 = require("./prompts");
 Object.defineProperty(exports, "PromptsType", { enumerable: true, get: function () { return prompts_1.PromptsType; } });
 Object.defineProperty(exports, "PromptsAPI", { enumerable: true, get: function () { return prompts_1.PromptsAPI; } });
-var types_4 = require("./controller-extension/types");
-Object.defineProperty(exports, "ControllerExtensionPageType", { enumerable: true, get: function () { return types_4.ControllerExtensionPageType; } });
+var types_5 = require("./controller-extension/types");
+Object.defineProperty(exports, "ControllerExtensionPageType", { enumerable: true, get: function () { return types_5.ControllerExtensionPageType; } });
 var controller_extension_1 = require("./controller-extension");
 Object.defineProperty(exports, "generateControllerExtension", { enumerable: true, get: function () { return controller_extension_1.generateControllerExtension; } });
 var field_1 = require("./field");

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/fe-fpm-writer",
   "description": "SAP Fiori elements flexible programming model writer",
-  "version": "0.39.21",
+  "version": "0.39.23",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -30,8 +30,8 @@
     "semver": "7.5.4",
     "xml-formatter": "2.6.1",
     "xpath": "0.0.33",
-    "@sap-ux/fiori-annotation-api": "0.7.14",
-    "@sap-ux/project-access": "1.32.9",
+    "@sap-ux/fiori-annotation-api": "0.7.15",
+    "@sap-ux/project-access": "1.32.10",
     "@sap-ux/logger": "0.7.1"
   },
   "devDependencies": {

package/templates/action/manifest.action-menu.json

@@ -0,0 +1,10 @@
+{
+    "<%- name %>": {
+        "text": "<%- settings.text %>",
+        "menu": <%- JSON.stringify(settings.actions) %><%if (settings.position) {%>,
+        "position": {
+            "placement": "<%- settings.position.placement %>"<%if (settings.position.anchor !== undefined) {%>,
+            "anchor": "<%- settings.position.anchor %>"<% } %>
+        }<% } %>
+    }
+}