@sap-ux/fe-fpm-writer 0.25.6 → 0.26.1

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

@@ -1,5 +1,6 @@
 import type { Editor } from 'mem-fs-editor';
-import type { BuildingBlock, BuildingBlockConfig } from './types';
+import { type BuildingBlock, type BuildingBlockConfig } from './types';
+import { type CodeSnippet } from '../prompts/types';
 /**
  * Generates a building block into the provided xml view file.
  *
@@ -9,4 +10,15 @@ import type { BuildingBlock, BuildingBlockConfig } from './types';
  * @returns {Editor} the updated memfs editor instance
  */
 export declare function generateBuildingBlock<T extends BuildingBlock>(basePath: string, config: BuildingBlockConfig<T>, fs?: Editor): Editor;
+/**
+ * Gets the serialized content of the updated view file.
+ *
+ * @param {string} basePath - The base path
+ * @param {BuildingBlockConfig} config - The building block configuration
+ * @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): {
+    [questionName: string]: CodeSnippet;
+};
 //# sourceMappingURL=index.d.ts.map

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.generateBuildingBlock = void 0;
+exports.getSerializedFileContent = 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");
@@ -36,6 +36,12 @@ const xpath = __importStar(require("xpath"));
 const xml_formatter_1 = __importDefault(require("xml-formatter"));
 const validate_1 = require("../common/validate");
 const templates_1 = require("../templates");
+const types_1 = require("../prompts/types");
+const PLACEHOLDERS = {
+    'id': 'REPLACE_WITH_BUILDING_BLOCK_ID',
+    'entitySet': 'REPLACE_WITH_ENTITY',
+    'qualifier': 'REPLACE_WITH_A_QUALIFIER'
+};
 /**
  * Generates a building block into the provided xml view file.
  *
@@ -105,20 +111,59 @@ function getOrAddMacrosNamespace(ui5XmlDocument) {
     return macrosNamespaceEntry ? macrosNamespaceEntry[0] : 'macros';
 }
 /**
- * Returns the template xml file document.
+ * Method converts object based metaPath to string.
+ *
+ * @param {BuildingBlockMetaPath} metaPath - object based metaPath.
+ * @param {boolean} usePlaceholders - apply placeholder values if value for attribute/property is not provided
+ * @returns {string} Resolved string metaPath.
+ */
+function getMetaPath(metaPath, usePlaceholders) {
+    if (!metaPath) {
+        return usePlaceholders ? `/${PLACEHOLDERS.entitySet}/${PLACEHOLDERS.qualifier}` : '';
+    }
+    const { entitySet, qualifier, bindingContextType = 'absolute' } = metaPath;
+    let entityPath = entitySet || (usePlaceholders ? PLACEHOLDERS.entitySet : '');
+    const lastIndex = entityPath.lastIndexOf('.');
+    entityPath = lastIndex >= 0 ? entityPath.substring?.(lastIndex + 1) : entityPath;
+    const qualifierOrPlaceholder = qualifier || (usePlaceholders ? PLACEHOLDERS.qualifier : '');
+    return bindingContextType === 'absolute' ? `/${entityPath}/${qualifierOrPlaceholder}` : qualifierOrPlaceholder;
+}
+/**
+ * Returns the content of the xml file document.
  *
  * @param {BuildingBlock} buildingBlockData - the building block data
  * @param {Document} viewDocument - the view xml file document
  * @param {Editor} fs - the memfs editor instance
- * @returns {Document} the template xml file document
+ * @param {boolean} usePlaceholders - apply placeholder values if value for attribute/property is not provided
+ * @returns {string} the template xml file content
  */
-function getTemplateDocument(buildingBlockData, viewDocument, fs) {
+function getTemplateContent(buildingBlockData, viewDocument, fs, usePlaceholders) {
     const templateFolderName = buildingBlockData.buildingBlockType;
     const templateFilePath = (0, templates_1.getTemplatePath)(`/building-block/${templateFolderName}/View.xml`);
-    const templateContent = (0, ejs_1.render)(fs.read(templateFilePath), {
-        macrosNamespace: getOrAddMacrosNamespace(viewDocument),
+    if (typeof buildingBlockData.metaPath === 'object' || buildingBlockData.metaPath === undefined) {
+        // Convert object based metapath to string
+        const metaPath = getMetaPath(buildingBlockData.metaPath, usePlaceholders);
+        buildingBlockData = { ...buildingBlockData, metaPath };
+    }
+    // Apply placeholders
+    if (!buildingBlockData.id) {
+        buildingBlockData.id = PLACEHOLDERS.id;
+    }
+    return (0, ejs_1.render)(fs.read(templateFilePath), {
+        macrosNamespace: viewDocument ? getOrAddMacrosNamespace(viewDocument) : 'macros',
         data: buildingBlockData
     }, {});
+}
+/**
+ * Returns the template xml file document.
+ *
+ * @param {BuildingBlock} buildingBlockData - the building block data
+ * @param {Document} viewDocument - the view xml file document
+ * @param {Editor} fs - the memfs editor instance
+ * @returns {Document} the template xml file document
+ */
+function getTemplateDocument(buildingBlockData, viewDocument, fs) {
+    const templateContent = getTemplateContent(buildingBlockData, viewDocument, fs);
     const errorHandler = (level, message) => {
         throw new Error(`Unable to parse template file with building block data. Details: [${level}] - ${message}`);
     };
@@ -160,4 +205,52 @@ function updateViewFile(basePath, viewPath, aggregationPath, viewDocument, templ
     }
     return fs;
 }
+/**
+ * Gets the properties for the file if the relative path is defined.
+ *
+ * @param {string} basePath - The base path
+ * @param {string} relativePath - The relative path to the file in the config
+ * @returns {FilePathProps} An object with file properties
+ */
+function getFilePathProps(basePath, relativePath) {
+    if (relativePath) {
+        return {
+            fileName: (0, path_1.parse)(relativePath).base,
+            relativePath,
+            fullPath: (0, path_1.join)(basePath, relativePath)
+        };
+    }
+    return {};
+}
+/**
+ * Gets the serialized content of the updated view file.
+ *
+ * @param {string} basePath - The base path
+ * @param {BuildingBlockConfig} config - The building block configuration
+ * @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) {
+    if (!config.buildingBlockData?.buildingBlockType) {
+        return {};
+    }
+    // Validate the base and view paths
+    if (!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 = getTemplateContent(config.buildingBlockData, xmlDocument, fs, true);
+    const filePathProps = getFilePathProps(basePath, config.viewOrFragmentPath);
+    return {
+        viewOrFragmentPath: {
+            content,
+            language: types_1.CodeSnippetLanguage.XML,
+            filePathProps
+        }
+    };
+}
+exports.getSerializedFileContent = getSerializedFileContent;
 //# sourceMappingURL=index.js.map

package/dist/building-block/prompts/questions/building-blocks.d.ts

@@ -0,0 +1,11 @@
+import type { Answers, Prompts, PromptsType } from '../../../prompts/types';
+export interface BuildingBlockTypePromptsAnswer extends Answers {
+    buildingBlockType: PromptsType;
+}
+/**
+ * Returns a list of prompts required to generate building blocks.
+ *
+ * @returns The list of prompts for building block types selection.
+ */
+export declare function getBuildingBlockTypePrompts(): Promise<Prompts<BuildingBlockTypePromptsAnswer>>;
+//# sourceMappingURL=building-blocks.d.ts.map

package/dist/building-block/prompts/questions/building-blocks.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getBuildingBlockTypePrompts = void 0;
+const i18n_1 = require("../../../i18n");
+const types_1 = require("../../types");
+/**
+ * Returns a list of prompts required to generate building blocks.
+ *
+ * @returns The list of prompts for building block types selection.
+ */
+async function getBuildingBlockTypePrompts() {
+    const t = (0, i18n_1.translate)(i18n_1.i18nNamespaces.buildingBlock, 'prompts.super.');
+    return {
+        questions: [
+            {
+                type: 'list',
+                name: 'buildingBlockType',
+                message: t('buildingBlockType.message'),
+                choices: [
+                    { name: t('buildingBlockType.choices.chart'), value: types_1.BuildingBlockType.Chart },
+                    { name: t('buildingBlockType.choices.filterBar'), value: types_1.BuildingBlockType.FilterBar },
+                    { name: t('buildingBlockType.choices.table'), value: types_1.BuildingBlockType.Table }
+                ]
+            }
+        ]
+    };
+}
+exports.getBuildingBlockTypePrompts = getBuildingBlockTypePrompts;
+//# sourceMappingURL=building-blocks.js.map

package/dist/building-block/prompts/questions/chart.d.ts

@@ -0,0 +1,12 @@
+import type { Answers } from 'inquirer';
+import type { PromptContext, Prompts } from '../../../prompts/types';
+import type { BuildingBlockConfig, Chart } from '../../types';
+export type ChartPromptsAnswer = BuildingBlockConfig<Chart> & Answers;
+/**
+ * Returns a list of prompts required to generate a chart building block.
+ *
+ * @param context - prompt context including data about project
+ * @returns Prompt with questions for chart.
+ */
+export declare function getChartBuildingBlockPrompts(context: PromptContext): Promise<Prompts<ChartPromptsAnswer>>;
+//# sourceMappingURL=chart.d.ts.map

package/dist/building-block/prompts/questions/chart.js

@@ -0,0 +1,127 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getChartBuildingBlockPrompts = void 0;
+const i18n_1 = require("../../../i18n");
+const utils_1 = require("../utils");
+const types_1 = require("../../types");
+const defaultAnswers = {
+    id: 'Chart',
+    bindingContextType: 'absolute'
+};
+/**
+ * Returns a list of prompts required to generate a chart building block.
+ *
+ * @param context - prompt context including data about project
+ * @returns Prompt with questions for chart.
+ */
+async function getChartBuildingBlockPrompts(context) {
+    const { project } = context;
+    const t = (0, i18n_1.translate)(i18n_1.i18nNamespaces.buildingBlock, 'prompts.chart.');
+    return {
+        questions: [
+            (0, utils_1.getViewOrFragmentPathPrompt)(context, t('viewOrFragmentPath.validate'), {
+                message: t('viewOrFragmentPath.message'),
+                guiOptions: {
+                    mandatory: true,
+                    dependantPromptNames: ['aggregationPath', 'buildingBlockData.filterBar']
+                }
+            }),
+            (0, utils_1.getBuildingBlockIdPrompt)(context, t('id.validation'), {
+                message: t('id.message'),
+                default: defaultAnswers.id,
+                guiOptions: {
+                    mandatory: true
+                }
+            }),
+            (0, utils_1.getBindingContextTypePrompt)({
+                message: t('bindingContextType'),
+                default: defaultAnswers.bindingContextType,
+                guiOptions: {
+                    mandatory: true,
+                    dependantPromptNames: ['buildingBlockData.metaPath.qualifier']
+                }
+            }),
+            ...(project && (0, utils_1.isCapProject)(project)
+                ? [
+                    await (0, utils_1.getCAPServicePrompt)(context, {
+                        message: t('service'),
+                        guiOptions: {
+                            mandatory: true,
+                            dependantPromptNames: []
+                        }
+                    })
+                ]
+                : []),
+            (0, utils_1.getEntityPrompt)(context, {
+                message: t('entity'),
+                guiOptions: {
+                    mandatory: true,
+                    dependantPromptNames: ['buildingBlockData.metaPath.qualifier']
+                }
+            }),
+            (0, utils_1.getAnnotationPathQualifierPrompt)(context, {
+                message: t('qualifier'),
+                guiOptions: {
+                    mandatory: true,
+                    placeholder: t('qualifierPlaceholder'),
+                    hint: t('valuesDependentOnEntityTypeInfo')
+                }
+            }, ["com.sap.vocabularies.UI.v1.Chart" /* UIAnnotationTerms.Chart */]),
+            (0, utils_1.getAggregationPathPrompt)(context, {
+                message: t('aggregation'),
+                guiOptions: {
+                    mandatory: true
+                }
+            }),
+            (0, utils_1.getFilterBarIdPrompt)(context, {
+                message: t('filterBar.message'),
+                type: 'list',
+                guiOptions: {
+                    placeholder: t('filterBar.placeholder'),
+                    creation: { placeholder: t('filterBar.inputPlaceholder') }
+                }
+            }),
+            {
+                type: 'checkbox',
+                name: 'buildingBlockData.personalization',
+                message: t('personalization.message'),
+                choices: [
+                    { name: t('personalization.choices.type'), value: 'Type' },
+                    { name: t('personalization.choices.item'), value: 'Item' },
+                    { name: t('personalization.choices.sort'), value: 'Sort' }
+                ],
+                guiOptions: {
+                    placeholder: t('personalization.placeholder'),
+                    selectType: 'static'
+                }
+            },
+            {
+                type: 'list',
+                name: 'buildingBlockData.selectionMode',
+                message: t('selectionMode.message'),
+                choices: [
+                    { name: t('selectionMode.choices.single'), value: 'Single' },
+                    { name: t('selectionMode.choices.multiple'), value: 'Multiple' }
+                ],
+                guiOptions: {
+                    selectType: 'static'
+                }
+            },
+            {
+                type: 'input',
+                name: 'buildingBlockData.selectionChange',
+                message: t('selectionChange'),
+                guiOptions: {
+                    placeholder: t('selectionChangePlaceholder')
+                }
+            }
+        ],
+        initialAnswers: {
+            buildingBlockData: {
+                buildingBlockType: types_1.BuildingBlockType.Chart
+            }
+        }
+    };
+}
+exports.getChartBuildingBlockPrompts = getChartBuildingBlockPrompts;
+//# sourceMappingURL=chart.js.map

package/dist/building-block/prompts/questions/filter-bar.d.ts

@@ -0,0 +1,12 @@
+import type { Answers } from 'inquirer';
+import type { Prompts, PromptContext } from '../../../prompts/types';
+import type { BuildingBlockConfig, FilterBar } from '../../types';
+export type FilterBarPromptsAnswer = BuildingBlockConfig<FilterBar> & Answers;
+/**
+ * Returns a list of prompts required to generate a filterbar building block.
+ *
+ * @param context - prompt context including data about project
+ * @returns Prompt with questions for filterbar.
+ */
+export declare function getFilterBarBuildingBlockPrompts(context: PromptContext): Promise<Prompts<FilterBarPromptsAnswer>>;
+//# sourceMappingURL=filter-bar.d.ts.map

package/dist/building-block/prompts/questions/filter-bar.js

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getFilterBarBuildingBlockPrompts = void 0;
+const i18n_1 = require("../../../i18n");
+const utils_1 = require("../utils");
+const types_1 = require("../../types");
+const defaultAnswers = {
+    id: 'FilterBar'
+};
+/**
+ * Returns a list of prompts required to generate a filterbar building block.
+ *
+ * @param context - prompt context including data about project
+ * @returns Prompt with questions for filterbar.
+ */
+async function getFilterBarBuildingBlockPrompts(context) {
+    const { project } = context;
+    const t = (0, i18n_1.translate)(i18n_1.i18nNamespaces.buildingBlock, 'prompts.filterBar.');
+    return {
+        questions: [
+            (0, utils_1.getViewOrFragmentPathPrompt)(context, t('viewOrFragmentPath.validate'), {
+                message: t('viewOrFragmentPath.message'),
+                guiOptions: {
+                    mandatory: true,
+                    dependantPromptNames: ['aggregationPath']
+                }
+            }),
+            (0, utils_1.getBuildingBlockIdPrompt)(context, t('id.validation'), {
+                message: t('id.message'),
+                default: defaultAnswers.id,
+                guiOptions: {
+                    mandatory: true
+                }
+            }),
+            ...(project && (0, utils_1.isCapProject)(project)
+                ? [
+                    await (0, utils_1.getCAPServicePrompt)(context, {
+                        message: t('service'),
+                        guiOptions: {
+                            mandatory: true,
+                            dependantPromptNames: []
+                        }
+                    })
+                ]
+                : []),
+            (0, utils_1.getAggregationPathPrompt)(context, {
+                message: t('aggregation'),
+                guiOptions: {
+                    mandatory: true
+                }
+            }),
+            (0, utils_1.getEntityPrompt)(context, {
+                message: t('entity'),
+                guiOptions: {
+                    mandatory: true,
+                    dependantPromptNames: ['buildingBlockData.metaPath.qualifier']
+                }
+            }),
+            (0, utils_1.getAnnotationPathQualifierPrompt)(context, {
+                message: t('qualifier'),
+                guiOptions: {
+                    mandatory: true,
+                    placeholder: t('qualifierPlaceholder'),
+                    hint: t('valuesDependentOnEntityTypeInfo')
+                }
+            }, ["com.sap.vocabularies.UI.v1.SelectionFields" /* UIAnnotationTerms.SelectionFields */]),
+            {
+                type: 'input',
+                name: 'buildingBlockData.filterChanged',
+                message: t('filterChanged')
+            },
+            {
+                type: 'input',
+                name: 'buildingBlockData.search',
+                message: t('search')
+            }
+        ],
+        initialAnswers: {
+            buildingBlockData: {
+                buildingBlockType: types_1.BuildingBlockType.FilterBar
+            }
+        }
+    };
+}
+exports.getFilterBarBuildingBlockPrompts = getFilterBarBuildingBlockPrompts;
+//# sourceMappingURL=filter-bar.js.map

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

@@ -0,0 +1,5 @@
+export * from './building-blocks';
+export * from './chart';
+export * from './filter-bar';
+export * from './table';
+//# sourceMappingURL=index.d.ts.map

package/dist/building-block/prompts/questions/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./building-blocks"), exports);
+__exportStar(require("./chart"), exports);
+__exportStar(require("./filter-bar"), exports);
+__exportStar(require("./table"), exports);
+//# sourceMappingURL=index.js.map

package/dist/building-block/prompts/questions/table.d.ts

@@ -0,0 +1,12 @@
+import type { Answers } from 'inquirer';
+import type { PromptContext, Prompts } from '../../../prompts/types';
+import type { BuildingBlockConfig, Table } from '../../types';
+export type TablePromptsAnswer = BuildingBlockConfig<Table> & Answers;
+/**
+ * Returns a list of prompts required to generate a table building block.
+ *
+ * @param context - prompt context including data about project
+ * @returns Prompt with questions for table.
+ */
+export declare function getTableBuildingBlockPrompts(context: PromptContext): Promise<Prompts<TablePromptsAnswer>>;
+//# sourceMappingURL=table.d.ts.map