@sap-ux/fe-fpm-writer 0.36.1 → 0.37.0

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

@@ -63,9 +63,10 @@ export declare function getAggregationPathPrompt(context: PromptContext, propert
  *
  * @param obj - object to be converted to choices
  * @param sort - apply alphabetical sort(default is "true")
+ * @param defaultKey - default key to be checked in choices
  * @returns the list of choices.
  */
-export declare function transformChoices(obj: Record<string, string> | string[], sort?: boolean): PromptListChoices;
+export declare function transformChoices(obj: Record<string, string> | string[], sort?: boolean, defaultKey?: string): PromptListChoices;
 /**
  * Returns a Prompt for selecting existing filter bar ID or entering a new one.
  *

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

@@ -200,7 +200,9 @@ function getAggregationPathPrompt(context, properties = {}) {
             ? (answers) => {
                 const { viewOrFragmentPath } = answers;
                 if (viewOrFragmentPath) {
-                    const choices = transformChoices((0, xml_1.getXPathStringsForXmlFile)((0, path_1.join)(appPath, viewOrFragmentPath), fs), false);
+                    const { inputChoices, pageMacroDefinition } = (0, xml_1.getXPathStringsForXmlFile)((0, path_1.join)(appPath, viewOrFragmentPath), fs);
+                    const key = Object.keys(inputChoices).find((k) => k.endsWith(`/${pageMacroDefinition}`));
+                    const choices = transformChoices(inputChoices, false, key);
                     if (!choices.length) {
                         throw new Error('Failed while fetching the aggregation path.');
                     }
@@ -221,12 +223,19 @@ function getAggregationPathPrompt(context, properties = {}) {
  *
  * @param obj - object to be converted to choices
  * @param sort - apply alphabetical sort(default is "true")
+ * @param defaultKey - default key to be checked in choices
  * @returns the list of choices.
  */
-function transformChoices(obj, sort = true) {
+function transformChoices(obj, sort = true, defaultKey) {
     let choices = [];
     if (!Array.isArray(obj)) {
-        choices = Object.entries(obj).map(([key, value]) => ({ name: key, value }));
+        choices = Object.entries(obj).map(([key, value]) => {
+            // Add checked if value matches defaultKey example: `/mvc:View/macro:Page/`
+            if (key === defaultKey) {
+                return { name: key, value, checked: true };
+            }
+            return { name: key, value };
+        });
         if (sort) {
             choices = choices.sort((a, b) => a.name.localeCompare(b.name));
         }

package/dist/building-block/prompts/utils/xml.d.ts

@@ -13,9 +13,12 @@ export declare function isElementIdAvailable(fs: Editor, viewOrFragmentPath: str
  *
  * @param xmlFilePath - the xml file path
  * @param fs - the file system object for reading files
- * @returns the list of xpath strings.
+ * @returns the list of xpath strings & page macro definition if page macro has been added by user.
  */
-export declare function getXPathStringsForXmlFile(xmlFilePath: string, fs: Editor): Record<string, string>;
+export declare function getXPathStringsForXmlFile(xmlFilePath: string, fs: Editor): {
+    inputChoices: Record<string, string>;
+    pageMacroDefinition?: string;
+};
 /**
  * Method returns ids of specific macro element found in passed xml file.
  *

package/dist/building-block/prompts/utils/xml.js

@@ -37,10 +37,11 @@ const augmentXpathWithLocalNames = (path) => {
  *
  * @param xmlFilePath - the xml file path
  * @param fs - the file system object for reading files
- * @returns the list of xpath strings.
+ * @returns the list of xpath strings & page macro definition if page macro has been added by user.
  */
 function getXPathStringsForXmlFile(xmlFilePath, fs) {
     const result = {};
+    let pageMacroDefinition;
     try {
         const xmlContent = fs.read(xmlFilePath);
         const errorHandler = (level, message) => {
@@ -50,7 +51,7 @@ function getXPathStringsForXmlFile(xmlFilePath, fs) {
         const nodes = [{ parentNode: '', node: xmlDocument.firstChild }];
         // check macros namespace and page macro definition
         const macrosNamespace = getOrAddMacrosNamespace(xmlDocument);
-        const pageMacroDefinition = macrosNamespace ? `${macrosNamespace}:Page` : 'macros:Page';
+        pageMacroDefinition = macrosNamespace ? `${macrosNamespace}:Page` : 'macros:Page';
         let hasPageMacroChild = false;
         while (nodes && nodes.length > 0) {
             const { parentNode, node } = nodes.shift();
@@ -79,7 +80,7 @@ function getXPathStringsForXmlFile(xmlFilePath, fs) {
     catch (error) {
         throw new Error(`An error occurred while parsing the view or fragment xml. Details: ${getErrorMessage(error)}`);
     }
-    return result;
+    return { inputChoices: result, pageMacroDefinition };
 }
 /**
  * Returns the message property if the error is an instance of `Error` else a string representation of the error.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/fe-fpm-writer",
   "description": "SAP Fiori elements flexible programming model writer",
-  "version": "0.36.1",
+  "version": "0.37.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -41,7 +41,7 @@
     "@types/semver": "7.5.2",
     "@types/vinyl": "2.0.7",
     "@sap-ux/i18n": "0.3.2",
-    "@sap-ux/ui-prompting": "0.3.37"
+    "@sap-ux/ui-prompting": "0.4.0"
   },
   "engines": {
     "node": ">=20.x"