@sap-ux/odata-service-inquirer 2.5.33 → 2.6.1

package/dist/prompts/edmx/questions.d.ts

@@ -1,7 +1,7 @@
 import type { Annotations } from '@sap-ux/axios-extension';
 import type { TemplateType } from '@sap-ux/fiori-elements-writer';
 import type { Question } from 'inquirer';
-import type { AlpTableConfigAnswers, AnnotationGenerationAnswers, EntityPromptOptions, EntitySelectionAnswers, TableConfigAnswers } from '../../types';
+import type { AlpTableConfigAnswers, AnnotationGenerationAnswers, EntityPromptOptions, EntitySelectionAnswers, TableConfigAnswers, PageBuildingBlockAnswers } from '../../types';
 /**
  * Get the questions that may be used to prompt for entity selection and related information, table types, layout options and annotation generation.
  *
@@ -13,5 +13,5 @@ import type { AlpTableConfigAnswers, AnnotationGenerationAnswers, EntityPromptOp
  *  If none are provided, or the odata version is not '2', the presentation variant qualifier prompt will not be shown.
  * @returns the prompts used to provide input for system selection and a reference to the answers object which will be populated with the user's responses once `inquirer.prompt` returns
  */
-export declare function getEntitySelectionQuestions(metadata: string, templateType: TemplateType, isCapService?: boolean, promptOptions?: EntityPromptOptions, annotations?: Annotations): Question<EntitySelectionAnswers & TableConfigAnswers & AnnotationGenerationAnswers & AlpTableConfigAnswers>[];
+export declare function getEntitySelectionQuestions(metadata: string, templateType: TemplateType, isCapService?: boolean, promptOptions?: EntityPromptOptions, annotations?: Annotations): Question<EntitySelectionAnswers & TableConfigAnswers & AnnotationGenerationAnswers & AlpTableConfigAnswers & PageBuildingBlockAnswers>[];
 //# sourceMappingURL=questions.d.ts.map

package/dist/prompts/edmx/questions.js

@@ -129,6 +129,9 @@ function getEntitySelectionQuestions(metadata, templateType, isCapService = fals
             default: 0
         });
     }
+    if (promptOptions?.displayPageBuildingBlockPrompt) {
+        entityQuestions.push(...getPageBuildingBlockQuestions());
+    }
     entityQuestions.push(...getAddAnnotationQuestions(metadata, templateType, odataVersion, isCapService));
     if (!promptOptions?.hideTableLayoutPrompts) {
         entityQuestions.push(...getTableLayoutQuestions(templateType, odataVersion, isCapService, convertedMetadata));
@@ -138,6 +141,36 @@ function getEntitySelectionQuestions(metadata, templateType, isCapService = fals
     }
     return entityQuestions;
 }
+/**
+ * Get the questions for page building block.
+ *
+ * @returns the page building block questions
+ */
+function getPageBuildingBlockQuestions() {
+    const pageBuildingBlockQuestions = [];
+    pageBuildingBlockQuestions.push({
+        type: 'confirm',
+        name: types_1.EntityPromptNames.addPageBuildingBlock,
+        message: (0, i18n_1.t)('prompts.pageBuildingBlock.message'),
+        default: false,
+        guiOptions: {
+            breadcrumb: true
+        }
+    });
+    // If the user wants to add a Page Building Block, ask for the title
+    pageBuildingBlockQuestions.push({
+        when: (answers) => answers.addPageBuildingBlock === true,
+        type: 'input',
+        name: types_1.EntityPromptNames.pageBuildingBlockTitle,
+        message: (0, i18n_1.t)('prompts.pageBuildingBlock.titleMessage'),
+        guiOptions: {
+            breadcrumb: true,
+            mandatory: true
+        },
+        validate: (input) => !!input
+    });
+    return pageBuildingBlockQuestions;
+}
 /**
  * Get the questions that may be used to prompt for table layout options.
  *

package/dist/translations/odata-service-inquirer.i18n.json

@@ -144,6 +144,10 @@
             "message": "Filter Entity",
             "noEntitiesError": "$t(errors.noRelevantEntities)"
         },
+        "pageBuildingBlock": {
+            "message": "Add a Page Building Block to the Application?",
+            "titleMessage": "Page Title"
+        },
         "tableType": {
             "message": "Table Type",
             "hint": "Defines the table type for the list report page.",

package/dist/types.d.ts

@@ -150,6 +150,8 @@ export declare const EntityPromptNames: {
     readonly mainEntity: "mainEntity";
     readonly navigationEntity: "navigationEntity";
     readonly filterEntitySet: "filterEntitySet";
+    readonly addPageBuildingBlock: "addPageBuildingBlock";
+    readonly pageBuildingBlockTitle: "pageBuildingBlockTitle";
     readonly tableType: "tableType";
     readonly hierarchyQualifier: "hierarchyQualifier";
     readonly addFEOPAnnotations: "addFEOPAnnotations";
@@ -166,6 +168,15 @@ export interface EntitySelectionAnswers {
     [EntityPromptNames.navigationEntity]?: NavigationEntityAnswer;
     [EntityPromptNames.filterEntitySet]?: EntityAnswer;
 }
+/**
+ * Answers related to the Page Building Block prompt.
+ */
+export interface PageBuildingBlockAnswers {
+    /** Indicates if the user wants to add a Page Building Block */
+    [EntityPromptNames.addPageBuildingBlock]?: boolean;
+    /** The title for the Page Building Block, required if addPageBuildingBlock is true */
+    [EntityPromptNames.pageBuildingBlockTitle]?: string;
+}
 export interface TableConfigAnswers {
     [EntityPromptNames.tableType]?: TableType;
     [EntityPromptNames.hierarchyQualifier]?: string;
@@ -184,7 +195,7 @@ export interface AlpTableConfigAnswers {
 /**
  * Convienience alias type for the entity related answers
  */
-export type EntityRelatedAnswers = EntitySelectionAnswers & TableConfigAnswers & AnnotationGenerationAnswers & AlpTableConfigAnswers;
+export type EntityRelatedAnswers = EntitySelectionAnswers & PageBuildingBlockAnswers & TableConfigAnswers & AnnotationGenerationAnswers & AlpTableConfigAnswers;
 export interface CapServiceChoice extends ListChoiceOptions {
     value: CapService;
 }
@@ -344,6 +355,10 @@ export type EntityPromptOptions = {
      * Hides the table layout related prompts when true, default is false.
      */
     hideTableLayoutPrompts?: boolean;
+    /**
+     * Used to determine if the display page building block prompt should be displayed.
+     */
+    displayPageBuildingBlockPrompt?: boolean;
 };
 export {};
 //# sourceMappingURL=types.d.ts.map

package/dist/types.js

@@ -74,6 +74,8 @@ exports.EntityPromptNames = {
     mainEntity: 'mainEntity',
     navigationEntity: 'navigationEntity',
     filterEntitySet: 'filterEntitySet',
+    addPageBuildingBlock: 'addPageBuildingBlock',
+    pageBuildingBlockTitle: 'pageBuildingBlockTitle',
     tableType: 'tableType',
     hierarchyQualifier: 'hierarchyQualifier',
     addFEOPAnnotations: 'addFEOPAnnotations',

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/odata-service-inquirer",
   "description": "Prompts module that can prompt users for inputs required for odata service writing",
-  "version": "2.5.33",
+  "version": "2.6.1",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -31,15 +31,15 @@
     "os-name": "4.0.1",
     "@sap-ux/axios-extension": "1.22.5",
     "@sap-ux/btp-utils": "1.1.0",
-    "@sap-ux/fiori-generator-shared": "0.13.9",
+    "@sap-ux/fiori-generator-shared": "0.13.10",
     "@sap-ux/guided-answers-helper": "0.4.0",
-    "@sap-ux/telemetry": "0.6.16",
-    "@sap-ux/inquirer-common": "0.7.35",
+    "@sap-ux/telemetry": "0.6.17",
+    "@sap-ux/inquirer-common": "0.7.36",
     "@sap-ux/logger": "0.7.0",
     "@sap-ux/nodejs-utils": "0.2.2",
     "@sap-ux/project-access": "1.30.12",
     "@sap-ux/project-input-validator": "0.6.17",
-    "@sap-ux/store": "1.1.2"
+    "@sap-ux/store": "1.1.3"
   },
   "devDependencies": {
     "@sap-ux/vocabularies-types": "0.13.0",
@@ -48,12 +48,12 @@
     "@types/inquirer": "8.2.6",
     "@types/lodash": "4.14.202",
     "jest-extended": "6.0.0",
-    "@sap-ux/fiori-generator-shared": "0.13.9",
-    "@sap-ux/fiori-elements-writer": "2.5.26",
-    "@sap-ux/fiori-freestyle-writer": "2.4.34",
+    "@sap-ux/fiori-generator-shared": "0.13.10",
+    "@sap-ux/fiori-elements-writer": "2.6.2",
+    "@sap-ux/fiori-freestyle-writer": "2.4.38",
     "@sap-ux/feature-toggle": "0.3.0",
     "@sap-ux/odata-service-writer": "0.27.17",
-    "@sap-ux/cap-config-writer": "0.10.27"
+    "@sap-ux/cap-config-writer": "0.12.1"
   },
   "engines": {
     "node": ">=20.x"