@sap-ux/fe-fpm-writer 0.31.0 → 0.31.2

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

@@ -10,6 +10,13 @@ import { type CodeSnippet } from '../prompts/types';
  * @returns {Editor} the updated memfs editor instance
  */
 export declare function generateBuildingBlock<T extends BuildingBlock>(basePath: string, config: BuildingBlockConfig<T>, fs?: Editor): Promise<Editor>;
+/**
+ * Method returns the manifest content for the required dependency library.
+ *
+ * @param {Editor} fs - the memfs editor instance
+ * @returns {Promise<string>} Manifest content for the required dependency library.
+ */
+export declare function getManifestContent(fs: Editor): Promise<string>;
 /**
  * Gets the serialized content of the updated view file.
  *

package/dist/building-block/index.js

@@ -26,7 +26,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getSerializedFileContent = exports.generateBuildingBlock = void 0;
+exports.getSerializedFileContent = exports.getManifestContent = exports.generateBuildingBlock = void 0;
 const mem_fs_1 = require("mem-fs");
 const mem_fs_editor_1 = require("mem-fs-editor");
 const ejs_1 = require("ejs");
@@ -56,28 +56,29 @@ const PLACEHOLDERS = {
  * @returns {Editor} the updated memfs editor instance
  */
 async function generateBuildingBlock(basePath, config, fs) {
+    const { viewOrFragmentPath, aggregationPath, buildingBlockData, allowAutoAddDependencyLib = true } = config;
     // Validate the base and view paths
     if (!fs) {
         fs = (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
     }
     (0, validate_1.validateBasePath)(basePath, fs, []);
-    if (!fs.exists((0, path_1.join)(basePath, config.viewOrFragmentPath))) {
-        throw new Error(`Invalid view path ${config.viewOrFragmentPath}.`);
+    if (!fs.exists((0, path_1.join)(basePath, viewOrFragmentPath))) {
+        throw new Error(`Invalid view path ${viewOrFragmentPath}.`);
     }
     // Read the view xml and template files and update contents of the view xml file
-    const xmlDocument = getUI5XmlDocument(basePath, config.viewOrFragmentPath, fs);
+    const xmlDocument = getUI5XmlDocument(basePath, viewOrFragmentPath, fs);
     const { content: manifest } = await (0, utils_1.getManifest)(basePath, fs);
-    const templateDocument = getTemplateDocument(config.buildingBlockData, xmlDocument, fs, manifest);
-    fs = updateViewFile(basePath, config.viewOrFragmentPath, config.aggregationPath, xmlDocument, templateDocument, fs);
-    if (manifest && !(0, validate_1.validateDependenciesLibs)(manifest, ['sap.fe.macros'])) {
+    const templateDocument = getTemplateDocument(buildingBlockData, xmlDocument, fs, manifest);
+    fs = updateViewFile(basePath, viewOrFragmentPath, aggregationPath, xmlDocument, templateDocument, fs);
+    if (allowAutoAddDependencyLib && manifest && !(0, validate_1.validateDependenciesLibs)(manifest, ['sap.fe.macros'])) {
         // "sap.fe.macros" is missing - enhance manifest.json for missing "sap.fe.macros"
         const manifestPath = await (0, utils_1.getManifestPath)(basePath, fs);
-        const templatePath = (0, templates_1.getTemplatePath)('/building-block/common/manifest.json');
+        const manifestContent = await getManifestContent(fs);
         const content = fs.read(manifestPath);
         const tabInfo = (0, file_1.detectTabSpacing)(content);
         (0, file_1.extendJSON)(fs, {
             filepath: manifestPath,
-            content: (0, ejs_1.render)(fs.read(templatePath), { libraries: { 'sap.fe.macros': {} } }),
+            content: manifestContent,
             tabInfo: tabInfo
         });
     }
@@ -211,6 +212,18 @@ function getTemplateContent(buildingBlockData, viewDocument, manifest, fs, usePl
         data: buildingBlockData
     }, {});
 }
+/**
+ * Method returns the manifest content for the required dependency library.
+ *
+ * @param {Editor} fs - the memfs editor instance
+ * @returns {Promise<string>} Manifest content for the required dependency library.
+ */
+async function getManifestContent(fs) {
+    // "sap.fe.macros" is missing - enhance manifest.json for missing "sap.fe.macros"
+    const templatePath = (0, templates_1.getTemplatePath)('/building-block/common/manifest.json');
+    return (0, ejs_1.render)(fs.read(templatePath), { libraries: { 'sap.fe.macros': {} } });
+}
+exports.getManifestContent = getManifestContent;
 /**
  * Returns the template xml file document.
  *
@@ -289,7 +302,9 @@ function getFilePathProps(basePath, relativePath) {
  * @returns {{ [questionName: string]: CodeSnippet }} An object with serialized code snippet content and file props
  */
 async function getSerializedFileContent(basePath, config, fs) {
-    if (!config.buildingBlockData?.buildingBlockType) {
+    const snippets = {};
+    const { buildingBlockData, viewOrFragmentPath, allowAutoAddDependencyLib = true } = config;
+    if (!buildingBlockData?.buildingBlockType) {
         return {};
     }
     // Validate the base and view paths
@@ -297,19 +312,30 @@ async function getSerializedFileContent(basePath, config, fs) {
         fs = (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
     }
     // Read the view xml and template files and get content of the view xml file
-    const xmlDocument = config.viewOrFragmentPath
-        ? getUI5XmlDocument(basePath, config.viewOrFragmentPath, fs)
-        : undefined;
-    const { content: manifest } = await (0, utils_1.getManifest)(basePath, fs, false);
-    const content = getTemplateContent(config.buildingBlockData, xmlDocument, manifest, fs, true);
-    const filePathProps = getFilePathProps(basePath, config.viewOrFragmentPath);
-    return {
-        viewOrFragmentPath: {
-            content,
-            language: types_2.CodeSnippetLanguage.XML,
-            filePathProps
-        }
+    const xmlDocument = viewOrFragmentPath ? getUI5XmlDocument(basePath, viewOrFragmentPath, fs) : undefined;
+    const { content: manifest, path: manifestPath } = await (0, utils_1.getManifest)(basePath, fs, false);
+    const content = getTemplateContent(buildingBlockData, xmlDocument, manifest, fs, true);
+    const filePathProps = getFilePathProps(basePath, viewOrFragmentPath);
+    // Snippet for fragment xml
+    snippets['viewOrFragmentPath'] = {
+        content,
+        language: types_2.CodeSnippetLanguage.XML,
+        filePathProps
     };
+    // Snippet for manifest.json
+    if (allowAutoAddDependencyLib) {
+        const manifestContent = await getManifestContent(fs);
+        snippets['manifest'] = {
+            content: manifestContent,
+            language: types_2.CodeSnippetLanguage.JSON,
+            filePathProps: {
+                fileName: (0, path_1.parse)(manifestPath).base,
+                relativePath: (0, path_1.relative)(basePath, manifestPath),
+                fullPath: manifestPath
+            }
+        };
+    }
+    return snippets;
 }
 exports.getSerializedFileContent = getSerializedFileContent;
 //# sourceMappingURL=index.js.map

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

@@ -365,5 +365,12 @@ export interface BuildingBlockConfig<T extends BuildingBlock> {
      * The building block parameters.
      */
     buildingBlockData: T;
+    /**
+     * Allows updating the 'manifest.json' file with missing dependency libraries.
+     * Dependency libraries are listed under '"sap.ui5"/"dependencies"/"libs"', and 'sap.fe.macros' is required for Building Blocks.
+     *
+     * @default true
+     */
+    allowAutoAddDependencyLib?: boolean;
 }
 //# 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.31.0",
+  "version": "0.31.2",
   "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.2.2",
-    "@sap-ux/project-access": "1.27.2"
+    "@sap-ux/fiori-annotation-api": "0.2.3",
+    "@sap-ux/project-access": "1.27.3"
   },
   "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.9"
+    "@sap-ux/ui-prompting": "0.1.12"
   },
   "engines": {
     "node": ">=18.x"