@sap-ux/fe-fpm-writer 0.44.3 → 1.0.0

package/dist/action/index.d.ts

@@ -1,5 +1,5 @@
 import type { Editor } from 'mem-fs-editor';
-import type { CustomAction, CustomActionTarget } from './types';
+import type { CustomAction, CustomActionTarget } from './types.js';
 /**
  * Enhance the target object in the manifest with the required nested objects and return a reference to it.
  *

package/dist/action/index.js

@@ -1,17 +1,13 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.enhanceManifestAndGetActionsElementReference = enhanceManifestAndGetActionsElementReference;
-exports.generateCustomAction = generateCustomAction;
-const mem_fs_1 = require("mem-fs");
-const mem_fs_editor_1 = require("mem-fs-editor");
-const types_1 = require("./types");
-const ejs_1 = require("ejs");
-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");
-const file_1 = require("../common/file");
-const utils_1 = require("../common/utils");
+import { create as createStorage } from 'mem-fs';
+import { create } from 'mem-fs-editor';
+import { TargetControl } from './types.js';
+import { render } from 'ejs';
+import { validateVersion, validateBasePath } from '../common/validate.js';
+import { setCommonDefaults } from '../common/defaults.js';
+import { applyEventHandlerConfiguration, contextParameter, selectedContextsParameter } from '../common/event-handler.js';
+import { getTemplatePath } from '../templates.js';
+import { getJsonSpace } from '../common/file.js';
+import { getManifest } from '../common/utils.js';
 /**
  * Enhances the provided custom action configuration with default data.
  *
@@ -27,7 +23,7 @@ function enhanceConfig(data, manifestPath, manifest) {
         target: { ...data.target },
         settings: { ...data.settings }
     };
-    (0, defaults_1.setCommonDefaults)(config, manifestPath, manifest);
+    setCommonDefaults(config, manifestPath, manifest);
     // set default values for visibility and enabled
     config.settings.enabled = config.settings.enabled || true;
     config.settings.visible = config.settings.visible || true;
@@ -40,18 +36,18 @@ function enhanceConfig(data, manifestPath, manifest) {
  * @param {CustomActionTarget} target - target element
  * @returns Actions object of the given target element.
  */
-function enhanceManifestAndGetActionsElementReference(manifest, target) {
+export function enhanceManifestAndGetActionsElementReference(manifest, target) {
     const page = manifest['sap.ui5'].routing.targets[target.page];
     page.options = page.options || {};
     page.options.settings = page.options.settings || {};
-    if (target.control === types_1.TargetControl.header || target.control === types_1.TargetControl.footer) {
+    if (target.control === TargetControl.header || target.control === TargetControl.footer) {
         page.options.settings.content = page.options.settings.content || {};
         page.options.settings.content[target.control] = page.options.settings.content[target.control] || {};
         page.options.settings.content[target.control].actions =
             page.options.settings.content[target.control].actions || {};
         return page.options.settings.content[target.control].actions;
     }
-    else if (target.control === types_1.TargetControl.body && target.customSectionKey) {
+    else if (target.control === TargetControl.body && target.customSectionKey) {
         // condition for custom section actions
         // Custom actions for custom sections are defined similarly like for header/footer under content property
         // In: 'options/settings/content/body/sections/<customSection>/actions'
@@ -86,29 +82,29 @@ function enhanceManifestAndGetActionsElementReference(manifest, target) {
  * @param {Editor} [fs] - the memfs editor instance
  * @returns {Promise<Editor>} the updated memfs editor instance
  */
-async function generateCustomAction(basePath, actionConfig, fs) {
-    (0, validate_1.validateVersion)(actionConfig.minUI5Version);
+export async function generateCustomAction(basePath, actionConfig, fs) {
+    validateVersion(actionConfig.minUI5Version);
     if (!fs) {
-        fs = (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
+        fs = create(createStorage());
     }
-    await (0, validate_1.validateBasePath)(basePath, fs);
-    const { path: manifestPath, content: manifest } = await (0, utils_1.getManifest)(basePath, fs);
+    await validateBasePath(basePath, fs);
+    const { path: manifestPath, content: manifest } = await getManifest(basePath, fs);
     const config = enhanceConfig(actionConfig, manifestPath, manifest);
     // Apply event handler
     if (config.eventHandler) {
-        config.eventHandler = (0, event_handler_1.applyEventHandlerConfiguration)(fs, config, config.eventHandler, {
+        config.eventHandler = applyEventHandlerConfiguration(fs, config, config.eventHandler, {
             controllerSuffix: false,
             typescript: config.typescript
-        }, [event_handler_1.contextParameter, event_handler_1.selectedContextsParameter]);
+        }, [contextParameter, selectedContextsParameter]);
     }
     // 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, {})));
+    Object.assign(actions, JSON.parse(render(fs.read(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));
+    fs.writeJSON(manifestPath, manifest, undefined, getJsonSpace(fs, manifestPath, actionConfig.tabInfo));
     return fs;
 }
 //# sourceMappingURL=index.js.map

package/dist/action/types.d.ts

@@ -1,4 +1,4 @@
-import type { CustomElement, InternalCustomElement, Position, EventHandler } from '../common/types';
+import type { CustomElement, InternalCustomElement, Position, EventHandler } from '../common/types.js';
 export declare enum TargetControl {
     header = "header",
     body = "body",

package/dist/action/types.js

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

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

@@ -1,5 +1,5 @@
 import type { Editor } from 'mem-fs-editor';
-import { type ActionMenu } from './types';
+import { type ActionMenu } from './types.js';
 /**
  * Add a custom page to an existing UI5 application.
  *

package/dist/action-menu/index.js

@@ -1,15 +1,12 @@
-"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");
+import { create as createStorage } from 'mem-fs';
+import { create } from 'mem-fs-editor';
+import { render } from 'ejs';
+import { validateVersion, validateBasePath } from '../common/validate.js';
+import { getTemplatePath } from '../templates.js';
+import { getJsonSpace } from '../common/file.js';
+import { getManifest } from '../common/utils.js';
+import { enhanceManifestAndGetActionsElementReference } from '../action/index.js';
+import { TargetControl } from './types.js';
 /**
  * Add a custom page to an existing UI5 application.
  *
@@ -18,13 +15,13 @@ const types_1 = require("./types");
  * @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);
+export async function generateActionMenu(basePath, actionMenuConfig, fs) {
+    validateVersion(actionMenuConfig.minUI5Version);
     if (!fs) {
-        fs = (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
+        fs = create(createStorage());
     }
-    await (0, validate_1.validateBasePath)(basePath, fs);
-    const { path: manifestPath, content: manifest } = await (0, utils_1.getManifest)(basePath, fs);
+    await validateBasePath(basePath, fs);
+    const { path: manifestPath, content: manifest } = await getManifest(basePath, fs);
     if (actionMenuConfig.target.menuId) {
         // add new action to existing menu
         const actionsContainer = getExistingMenuItemsContainer(manifest, actionMenuConfig.target);
@@ -33,8 +30,8 @@ async function generateActionMenu(basePath, actionMenuConfig, fs) {
     }
     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, {})));
+        const actionsContainer = enhanceManifestAndGetActionsElementReference(manifest, actionMenuConfig.target);
+        Object.assign(actionsContainer, JSON.parse(render(fs.read(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
@@ -50,7 +47,7 @@ async function generateActionMenu(basePath, actionMenuConfig, fs) {
             }
         }
     }
-    fs.writeJSON(manifestPath, manifest, undefined, (0, file_1.getJsonSpace)(fs, manifestPath, actionMenuConfig.tabInfo));
+    fs.writeJSON(manifestPath, manifest, undefined, getJsonSpace(fs, manifestPath, actionMenuConfig.tabInfo));
     return fs;
 }
 /**
@@ -62,10 +59,10 @@ async function generateActionMenu(basePath, actionMenuConfig, fs) {
  */
 function getExistingMenuItemsContainer(manifest, target) {
     const page = manifest['sap.ui5'].routing.targets[target.page];
-    if (target.control === types_1.TargetControl.header) {
+    if (target.control === TargetControl.header) {
         return page.options.settings.content[target.control].actions;
     }
-    else if (target.control === types_1.TargetControl.body && target.customSectionKey) {
+    else if (target.control === TargetControl.body && target.customSectionKey) {
         return page.options.settings.content[target.control].sections[target.customSectionKey].actions;
     }
     else {

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

@@ -1,4 +1,4 @@
-import type { CustomElement, Position } from '../common/types';
+import type { CustomElement, Position } from '../common/types.js';
 export declare enum TargetControl {
     header = "header",
     body = "body",

package/dist/action-menu/types.js

@@ -1,11 +1,8 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TargetControl = void 0;
-var TargetControl;
+export 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 = {}));
+})(TargetControl || (TargetControl = {}));
 //# sourceMappingURL=types.js.map

package/dist/app/index.js

@@ -1,17 +1,13 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MIN_VERSION = void 0;
-exports.enableFPM = enableFPM;
-const mem_fs_1 = require("mem-fs");
-const mem_fs_editor_1 = require("mem-fs-editor");
-const node_path_1 = require("node:path");
-const semver_1 = require("semver");
-const project_access_1 = require("@sap-ux/project-access");
-const defaults_1 = require("../common/defaults");
-const templates_1 = require("../templates");
-const utils_1 = require("../common/utils");
-const file_1 = require("../common/file");
-exports.MIN_VERSION = '1.94.0';
+import { create as createStorage } from 'mem-fs';
+import { create } from 'mem-fs-editor';
+import { join } from 'node:path';
+import { lt, valid } from 'semver';
+import { getMinUI5VersionAsArray, getMinimumUI5Version } from '@sap-ux/project-access';
+import { FCL_ROUTER } from '../common/defaults.js';
+import { getTemplatePath } from '../templates.js';
+import { addExtensionTypes, getManifest } from '../common/utils.js';
+import { copyTpl } from '../common/file.js';
+export const MIN_VERSION = '1.94.0';
 /**
  * If a minUI5Version is set and it is smaller than the minimum required, increase it.
  *
@@ -20,13 +16,13 @@ exports.MIN_VERSION = '1.94.0';
  * @param {string} manifestPath - path to the manifest.json file
  */
 function adaptMinUI5Version(manifest, fs, manifestPath) {
-    const minUI5VersionArray = (0, project_access_1.getMinUI5VersionAsArray)(manifest, true);
+    const minUI5VersionArray = getMinUI5VersionAsArray(manifest, true);
     if (minUI5VersionArray?.length > 0) {
         let update = false;
         for (let index = 0; index < minUI5VersionArray.length; index++) {
             const minUI5Version = minUI5VersionArray[index];
-            if (minUI5Version && (0, semver_1.valid)(minUI5Version) && (0, semver_1.lt)(minUI5Version, exports.MIN_VERSION)) {
-                minUI5VersionArray[index] = exports.MIN_VERSION;
+            if (minUI5Version && valid(minUI5Version) && lt(minUI5Version, MIN_VERSION)) {
+                minUI5VersionArray[index] = MIN_VERSION;
                 update = true;
             }
         }
@@ -60,11 +56,11 @@ function adaptMinUI5Version(manifest, fs, manifestPath) {
  * @param {Editor} [fs] - the mem-fs editor instance
  * @returns {Promise<Editor>} the updated mem-fs editor instance
  */
-async function enableFPM(basePath, config = {}, fs) {
+export async function enableFPM(basePath, config = {}, fs) {
     if (!fs) {
-        fs = (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
+        fs = create(createStorage());
     }
-    const { path: manifestPath, content: manifest } = await (0, utils_1.getManifest)(basePath, fs);
+    const { path: manifestPath, content: manifest } = await getManifest(basePath, fs);
     // add FE libs is not yet added
     if (!manifest['sap.ui5']?.dependencies?.libs?.['sap.fe.templates']) {
         fs.extendJSON(manifestPath, {
@@ -81,7 +77,7 @@ async function enableFPM(basePath, config = {}, fs) {
     adaptMinUI5Version(manifest, fs, manifestPath);
     // add type extensions if required
     if (config.typescript) {
-        (0, utils_1.addExtensionTypes)(basePath, (0, project_access_1.getMinimumUI5Version)(manifest), fs);
+        addExtensionTypes(basePath, getMinimumUI5Version(manifest), fs);
     }
     // enable FCL if requested
     if (config.fcl) {
@@ -95,7 +91,7 @@ async function enableFPM(basePath, config = {}, fs) {
                 },
                 routing: {
                     config: {
-                        routerClass: defaults_1.FCL_ROUTER
+                        routerClass: FCL_ROUTER
                     }
                 }
             }
@@ -104,8 +100,8 @@ async function enableFPM(basePath, config = {}, fs) {
     // replace Component.js
     if (config.replaceAppComponent) {
         const ext = config.typescript ? 'ts' : 'js';
-        const componentTemplate = (0, templates_1.getTemplatePath)(`/app/Component.${ext}`);
-        (0, file_1.copyTpl)(fs, componentTemplate, (0, node_path_1.join)(basePath, `webapp/Component.${ext}`), manifest['sap.app']);
+        const componentTemplate = getTemplatePath(`/app/Component.${ext}`);
+        copyTpl(fs, componentTemplate, join(basePath, `webapp/Component.${ext}`), manifest['sap.app']);
     }
     return fs;
 }

package/dist/building-block/index.d.ts

@@ -1,6 +1,6 @@
 import type { Editor } from 'mem-fs-editor';
-import { type BuildingBlock, type BuildingBlockConfig } from './types';
-import { type CodeSnippet } from '../prompts/types';
+import { type BuildingBlock, type BuildingBlockConfig } from './types.js';
+import { type CodeSnippet } from '../prompts/types.js';
 /**
  * Generates a building block into the provided xml view file.
  *