@sap-ux/fe-fpm-writer 0.29.4 → 0.29.6

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

@@ -9,7 +9,7 @@ import { type CodeSnippet } from '../prompts/types';
  * @param {Editor} [fs] - the memfs editor instance
  * @returns {Editor} the updated memfs editor instance
  */
-export declare function generateBuildingBlock<T extends BuildingBlock>(basePath: string, config: BuildingBlockConfig<T>, fs?: Editor): Editor;
+export declare function generateBuildingBlock<T extends BuildingBlock>(basePath: string, config: BuildingBlockConfig<T>, fs?: Editor): Promise<Editor>;
 /**
  * Gets the serialized content of the updated view file.
  *
@@ -18,7 +18,7 @@ export declare function generateBuildingBlock<T extends BuildingBlock>(basePath:
  * @param {Editor} [fs] - The memfs editor instance
  * @returns {{ [questionName: string]: CodeSnippet }} An object with serialized code snippet content and file props
  */
-export declare function getSerializedFileContent<T extends BuildingBlock>(basePath: string, config: BuildingBlockConfig<T>, fs?: Editor): {
+export declare function getSerializedFileContent<T extends BuildingBlock>(basePath: string, config: BuildingBlockConfig<T>, fs?: Editor): Promise<{
     [questionName: string]: CodeSnippet;
-};
+}>;
 //# sourceMappingURL=index.d.ts.map

package/dist/building-block/index.js

@@ -40,11 +40,22 @@ const templates_1 = require("../templates");
 const types_2 = require("../prompts/types");
 const semver_1 = require("semver");
 const project_access_1 = require("@sap-ux/project-access");
+const file_1 = require("../common/file");
 const PLACEHOLDERS = {
     'id': 'REPLACE_WITH_BUILDING_BLOCK_ID',
     'entitySet': 'REPLACE_WITH_ENTITY',
     'qualifier': 'REPLACE_WITH_A_QUALIFIER'
 };
+/**
+ * Gets manifest path.
+ *
+ * @param {string} basePath the base path
+ * @param {Editor} fs the memfs editor instance
+ * @returns {Manifest | undefined} path to manifest file
+ */
+async function getManifestPath(basePath, fs) {
+    return (0, path_1.join)(await (0, project_access_1.getWebappPath)(basePath, fs), 'manifest.json');
+}
 /**
  * Gets manifest content.
  *
@@ -52,8 +63,8 @@ const PLACEHOLDERS = {
  * @param {Editor} fs the memfs editor instance
  * @returns {Manifest | undefined} the manifest content
  */
-function getManifest(basePath, fs) {
-    const manifestPath = (0, path_1.join)(basePath, 'webapp/manifest.json');
+async function getManifest(basePath, fs) {
+    const manifestPath = await getManifestPath(basePath, fs);
     return fs.readJSON(manifestPath);
 }
 /**
@@ -64,20 +75,32 @@ function getManifest(basePath, fs) {
  * @param {Editor} [fs] - the memfs editor instance
  * @returns {Editor} the updated memfs editor instance
  */
-function generateBuildingBlock(basePath, config, fs) {
+async function generateBuildingBlock(basePath, config, fs) {
     // 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, ['sap.fe.templates', 'sap.fe.core']);
+    (0, validate_1.validateBasePath)(basePath, fs, []);
     if (!fs.exists((0, path_1.join)(basePath, config.viewOrFragmentPath))) {
         throw new Error(`Invalid view path ${config.viewOrFragmentPath}.`);
     }
     // Read the view xml and template files and update contents of the view xml file
     const xmlDocument = getUI5XmlDocument(basePath, config.viewOrFragmentPath, fs);
-    const manifest = getManifest(basePath, fs);
+    const manifest = await 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'])) {
+        // "sap.fe.macros" is missing - enhance manifest.json for missing "sap.fe.macros"
+        const manifestPath = await getManifestPath(basePath, fs);
+        const templatePath = (0, templates_1.getTemplatePath)('/building-block/common/manifest.json');
+        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': {} } }),
+            tabInfo: tabInfo
+        });
+    }
     return fs;
 }
 exports.generateBuildingBlock = generateBuildingBlock;
@@ -155,7 +178,7 @@ function getMetaPath(applyContextPath, metaPath, usePlaceholders) {
     if (!metaPath) {
         return getDefaultMetaPath(applyContextPath, usePlaceholders);
     }
-    const { bindingContextType = 'absolute' } = metaPath;
+    const { bindingContextType = 'absolute', alwaysAbsolutePath = true } = metaPath;
     let { entitySet, qualifier } = metaPath;
     entitySet = entitySet || (usePlaceholders ? PLACEHOLDERS.entitySet : '');
     const qualifierOrPlaceholder = qualifier || (usePlaceholders ? PLACEHOLDERS.qualifier : '');
@@ -168,7 +191,9 @@ function getMetaPath(applyContextPath, metaPath, usePlaceholders) {
         };
     }
     return {
-        metaPath: bindingContextType === 'absolute' ? `/${entitySet}/${qualifierOrPlaceholder}` : qualifierOrPlaceholder
+        metaPath: bindingContextType === 'absolute' || alwaysAbsolutePath
+            ? `/${entitySet}/${qualifierOrPlaceholder}`
+            : qualifierOrPlaceholder
     };
 }
 /**
@@ -283,7 +308,7 @@ function getFilePathProps(basePath, relativePath) {
  * @param {Editor} [fs] - The memfs editor instance
  * @returns {{ [questionName: string]: CodeSnippet }} An object with serialized code snippet content and file props
  */
-function getSerializedFileContent(basePath, config, fs) {
+async function getSerializedFileContent(basePath, config, fs) {
     if (!config.buildingBlockData?.buildingBlockType) {
         return {};
     }
@@ -295,7 +320,7 @@ function getSerializedFileContent(basePath, config, fs) {
     const xmlDocument = config.viewOrFragmentPath
         ? getUI5XmlDocument(basePath, config.viewOrFragmentPath, fs)
         : undefined;
-    const manifest = getManifest(basePath, fs);
+    const manifest = await getManifest(basePath, fs);
     const content = getTemplateContent(config.buildingBlockData, xmlDocument, manifest, fs, true);
     const filePathProps = getFilePathProps(basePath, config.viewOrFragmentPath);
     return {

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

@@ -23,6 +23,12 @@ export interface BuildingBlockMetaPath {
     entitySet: string;
     qualifier: string;
     bindingContextType?: BindingContextType;
+    /**
+     * Always generate absolute paths.
+     *
+     * @default true
+     */
+    alwaysAbsolutePath?: boolean;
 }
 /**
  * Represents a building block control.

package/dist/common/validate.d.ts

@@ -1,4 +1,5 @@
 import type { Editor } from 'mem-fs-editor';
+import type { Manifest } from './types';
 /**
  * Validate that the UI5 version requirement is valid.
  *
@@ -6,6 +7,14 @@ import type { Editor } from 'mem-fs-editor';
  * @returns true if the version is supported otherwise throws an error
  */
 export declare function validateVersion(ui5Version?: string): boolean;
+/**
+ * Validates the library dependencies - at least one of expected dependencies is present.
+ *
+ * @param {string} manifest - the manifest content
+ * @param {string[]} dependencies - expected dependencies
+ * @returns true if at least one of expected dependencies is presented in manifest.
+ */
+export declare function validateDependenciesLibs(manifest: Manifest, dependencies: string[]): boolean;
 /**
  * Validates the provided base path, checks at least one of expected dependencies is present.
  *

package/dist/common/validate.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getErrorMessage = exports.validateBasePath = exports.validateVersion = void 0;
+exports.getErrorMessage = exports.validateBasePath = exports.validateDependenciesLibs = exports.validateVersion = void 0;
 const path_1 = require("path");
 const mem_fs_1 = require("mem-fs");
 const mem_fs_editor_1 = require("mem-fs-editor");
@@ -19,6 +19,22 @@ function validateVersion(ui5Version) {
     return true;
 }
 exports.validateVersion = validateVersion;
+/**
+ * Validates the library dependencies - at least one of expected dependencies is present.
+ *
+ * @param {string} manifest - the manifest content
+ * @param {string[]} dependencies - expected dependencies
+ * @returns true if at least one of expected dependencies is presented in manifest.
+ */
+function validateDependenciesLibs(manifest, dependencies) {
+    const libs = manifest['sap.ui5']?.dependencies?.libs;
+    return dependencies.length
+        ? dependencies.some((dependency) => {
+            return libs?.[dependency] !== undefined;
+        })
+        : true;
+}
+exports.validateDependenciesLibs = validateDependenciesLibs;
 /**
  * Validates the provided base path, checks at least one of expected dependencies is present.
  *
@@ -37,13 +53,7 @@ function validateBasePath(basePath, fs, dependencies = ['sap.fe.templates']) {
     }
     else {
         const manifest = fs.readJSON(manifestPath);
-        const libs = manifest['sap.ui5']?.dependencies?.libs;
-        const valid = dependencies.length
-            ? dependencies.some((dependency) => {
-                return libs?.[dependency] !== undefined;
-            })
-            : true;
-        if (!valid) {
+        if (!validateDependenciesLibs(manifest, dependencies)) {
             if (dependencies.length === 1) {
                 throw new Error(`Dependency ${dependencies[0]} is missing in the manifest.json. Fiori elements FPM requires the SAP FE libraries.`);
             }

package/dist/prompts/api.d.ts

@@ -58,7 +58,7 @@ export declare class PromptsAPI {
      * @param answers The answers object
      * @returns The updated memfs editor instance
      */
-    submitAnswers<N extends SupportedPrompts['type']>(type: N, answers: NarrowPrompt<typeof type>['answers']): Editor;
+    submitAnswers<N extends SupportedPrompts['type']>(type: N, answers: NarrowPrompt<typeof type>['answers']): Promise<Editor>;
     /**
      * Method returns code snippet for passed answers and prompt type.
      *
@@ -66,9 +66,9 @@ export declare class PromptsAPI {
      * @param answers The answers object
      * @returns Code snippet content.
      */
-    getCodeSnippets<N extends SupportedPrompts['type']>(type: N, answers: NarrowPrompt<typeof type>['answers']): {
+    getCodeSnippets<N extends SupportedPrompts['type']>(type: N, answers: NarrowPrompt<typeof type>['answers']): Promise<{
         [questionName: string]: CodeSnippet;
-    };
+    }>;
     /**
      * Method checks if passed type of prompt supports generation and code preview.
      *

package/dist/prompts/api.js

@@ -134,7 +134,7 @@ class PromptsAPI {
      * @param answers The answers object
      * @returns The updated memfs editor instance
      */
-    submitAnswers(type, answers) {
+    async submitAnswers(type, answers) {
         const config = { type, answers };
         if (!this.isGenerationSupported(config)) {
             return this.context.fs;
@@ -151,7 +151,7 @@ class PromptsAPI {
      * @param answers The answers object
      * @returns Code snippet content.
      */
-    getCodeSnippets(type, answers) {
+    async getCodeSnippets(type, answers) {
         const config = { type, answers };
         if (!this.isGenerationSupported(config)) {
             return {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/fe-fpm-writer",
   "description": "SAP Fiori elements flexible programming model writer",
-  "version": "0.29.4",
+  "version": "0.29.6",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",

package/templates/building-block/common/manifest.json

@@ -0,0 +1,7 @@
+{
+    "sap.ui5": {
+        "dependencies": {
+            "libs": <%- JSON.stringify(libraries) %>
+        }
+    }
+}