@sap-ux/odata-service-inquirer 3.0.25 → 3.2.0

package/dist/prompts/datasources/sap-system/system-selection/prompt-helpers.d.ts

@@ -1,6 +1,6 @@
 import type { Destination } from '@sap-ux/btp-utils';
 import type { OdataVersion } from '@sap-ux/odata-service-writer';
-import { type BackendSystemKey, type BackendSystem } from '@sap-ux/store';
+import { type BackendSystemKey, type BackendSystem, type BackendSystemFilter } from '@sap-ux/store';
 import type { ListChoiceOptions } from 'inquirer';
 import type { ConnectedSystem, DestinationFilters } from '../../../../types.js';
 import type { ConnectionValidator } from '../../../connectionValidator.js';
@@ -42,9 +42,10 @@ export declare function connectWithDestination(destination: Destination, connect
  * @param destinationFilters the filters to apply to the destination choices
  * @param includeCloudFoundryAbapEnvChoice whether to include the Cloud Foundry ABAP environment choice in the list
  * @param hideNewSystem - if true it will prevent adding the 'New System' option to the list
+ * @param backendSystemFilter - optional store filter to apply when retrieving backend systems
  * @returns a list of choices for the system selection prompt
  */
-export declare function createSystemChoices(destinationFilters?: Partial<DestinationFilters>, includeCloudFoundryAbapEnvChoice?: boolean, hideNewSystem?: boolean): Promise<ListChoiceOptions<SystemSelectionAnswerType>[]>;
+export declare function createSystemChoices(destinationFilters?: Partial<DestinationFilters>, includeCloudFoundryAbapEnvChoice?: boolean, hideNewSystem?: boolean, backendSystemFilter?: BackendSystemFilter): Promise<ListChoiceOptions<SystemSelectionAnswerType>[]>;
 /**
  * Find the default selection index based on the default choice value.
  *

package/dist/prompts/datasources/sap-system/system-selection/prompt-helpers.js

@@ -143,9 +143,10 @@ function matchesFilters(destination, filters) {
  * @param destinationFilters the filters to apply to the destination choices
  * @param includeCloudFoundryAbapEnvChoice whether to include the Cloud Foundry ABAP environment choice in the list
  * @param hideNewSystem - if true it will prevent adding the 'New System' option to the list
+ * @param backendSystemFilter - optional store filter to apply when retrieving backend systems
  * @returns a list of choices for the system selection prompt
  */
-export async function createSystemChoices(destinationFilters, includeCloudFoundryAbapEnvChoice = false, hideNewSystem = false) {
+export async function createSystemChoices(destinationFilters, includeCloudFoundryAbapEnvChoice = false, hideNewSystem = false, backendSystemFilter) {
     let systemChoices = [];
     let newSystemChoice;
     // If this is BAS, return destinations, otherwise return stored backend systems
@@ -183,7 +184,7 @@ export async function createSystemChoices(destinationFilters, includeCloudFoundr
         }
     }
     else {
-        const backendSystems = await getAllBackendSystems(false);
+        const backendSystems = await getAllBackendSystems(false, backendSystemFilter);
         // Cache the backend systems
         PromptState.backendSystemsCache = backendSystems;
         systemChoices = backendSystems.map((system) => {

package/dist/prompts/datasources/sap-system/system-selection/questions.js

@@ -95,7 +95,7 @@ export async function getSystemSelectionQuestions(promptOptions, connectedSystem
 export async function getSystemConnectionQuestions(connectionValidator, promptOptions, cachedConnectedSystem) {
     const requiredOdataVersion = promptOptions?.serviceSelection?.requiredOdataVersion;
     const destinationFilters = promptOptions?.systemSelection?.destinationFilters;
-    const systemChoices = await createSystemChoices(destinationFilters, promptOptions?.systemSelection?.includeCloudFoundryAbapEnvChoice, promptOptions?.systemSelection?.hideNewSystem);
+    const systemChoices = await createSystemChoices(destinationFilters, promptOptions?.systemSelection?.includeCloudFoundryAbapEnvChoice, promptOptions?.systemSelection?.hideNewSystem, promptOptions?.systemSelection?.backendSystemFilter);
     let defaultChoiceIndex = findDefaultSystemSelectionIndex(systemChoices, promptOptions?.systemSelection?.defaultChoice);
     // Alternative connection path, will override default authentication path (catalog endpoints)
     let connectPath = promptOptions?.systemSelection?.connectPath;

package/dist/prompts/edmx/questions.js

@@ -1,4 +1,5 @@
 import { Severity } from '@sap-devx/yeoman-ui-types';
+import { PageTemplateType, MIN_UI5_VERSION_PAGE_BUILDING_BLOCK, MIN_UI5_VERSION_PAGE_BUILDING_BLOCK_FULL_LAYOUT } from '@sap-ux/fe-fpm-writer';
 import { searchChoices, getRecursiveHierarchyQualifierForEntitySet, findEntitySetByName } from '@sap-ux/inquirer-common';
 import { OdataVersion } from '@sap-ux/odata-service-writer';
 import { t } from '../../i18n.js';
@@ -150,43 +151,67 @@ export function getEntitySelectionQuestions(metadata, templateType, isCapService
     return entityQuestions;
 }
 /**
- * Get the questions for page building block.
+ * Get the questions for the page building block prompts.
  *
  * @returns the page building block questions
  */
 function getPageBuildingBlockQuestions() {
-    const pageBuildingBlockQuestions = [];
-    pageBuildingBlockQuestions.push({
-        type: 'confirm',
-        name: EntityPromptNames.addPageBuildingBlock,
-        message: t('prompts.pageBuildingBlock.message'),
-        default: false,
-        guiOptions: {
-            breadcrumb: true,
-            hint: t('prompts.pageBuildingBlock.tooltip')
+    return [
+        {
+            type: 'confirm',
+            name: EntityPromptNames.addPageBuildingBlock,
+            message: t('prompts.pageBuildingBlock.message'),
+            default: false,
+            guiOptions: {
+                breadcrumb: true,
+                hint: t('prompts.pageBuildingBlock.tooltip', {
+                    minUi5VersionForPageBuildingBlock: MIN_UI5_VERSION_PAGE_BUILDING_BLOCK
+                })
+            }
         },
-        additionalMessages: (addPageBuildingBlock) => {
-            if (addPageBuildingBlock) {
-                return {
-                    message: t('prompts.pageBuildingBlock.warning'),
-                    severity: Severity.warning
-                };
+        {
+            when: (answers) => answers.addPageBuildingBlock === true,
+            type: 'confirm',
+            name: EntityPromptNames.pageBuildingBlockLayout,
+            message: t('prompts.pageBuildingBlock.layoutMessage'),
+            default: true,
+            labelTrue: t('prompts.pageBuildingBlock.choiceBasic'),
+            labelFalse: t('prompts.pageBuildingBlock.choiceFull'),
+            filter: (val) => (val ? PageTemplateType.Basic : PageTemplateType.Full),
+            guiOptions: {
+                breadcrumb: t('prompts.pageBuildingBlock.layoutMessage')
+            },
+            additionalMessages: (input) => {
+                if (input === true) {
+                    return {
+                        message: t('prompts.pageBuildingBlock.basicLayoutWarning', {
+                            minUi5VersionForPageBuildingBlock: MIN_UI5_VERSION_PAGE_BUILDING_BLOCK
+                        }),
+                        severity: Severity.warning
+                    };
+                }
+                if (input === false) {
+                    return {
+                        message: t('prompts.pageBuildingBlock.fullLayoutWarning', {
+                            minUi5VersionForFullLayout: MIN_UI5_VERSION_PAGE_BUILDING_BLOCK_FULL_LAYOUT
+                        }),
+                        severity: Severity.warning
+                    };
+                }
             }
-        }
-    });
-    // If the user wants to add a Page Building Block, ask for the title
-    pageBuildingBlockQuestions.push({
-        when: (answers) => answers.addPageBuildingBlock === true,
-        type: 'input',
-        name: EntityPromptNames.pageBuildingBlockTitle,
-        message: t('prompts.pageBuildingBlock.titleMessage'),
-        guiOptions: {
-            breadcrumb: true,
-            mandatory: true
         },
-        validate: (input) => !!input
-    });
-    return pageBuildingBlockQuestions;
+        {
+            when: (answers) => answers.addPageBuildingBlock === true,
+            type: 'input',
+            name: EntityPromptNames.pageBuildingBlockTitle,
+            message: t('prompts.pageBuildingBlock.titleMessage'),
+            guiOptions: {
+                breadcrumb: true,
+                mandatory: true
+            },
+            validate: (input) => !!input
+        }
+    ];
 }
 /**
  * Get the questions that may be used to prompt for table layout options.

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

@@ -153,9 +153,13 @@
         },
         "pageBuildingBlock": {
             "message": "Add a Page Building Block to the Application?",
-            "tooltip": "The Page building block is supported from SAPUI5 version 1.136. By choosing this option, you will be restricting the minimum SAPUI5 versions available for the application to be 1.136 and above.",
-            "warning": "The Page building block is supported with SAPUI5 version 1.136 and above.",
-            "titleMessage": "Page Title"
+            "tooltip": "The Page building block is supported from SAPUI5 version {{ minUi5VersionForPageBuildingBlock }}. By choosing this option, you are restricting the minimum SAPUI5 version to {{ minUi5VersionForPageBuildingBlock }} and above.",
+            "titleMessage": "Page Title",
+            "layoutMessage": "Page Building Block Layout",
+            "choiceFull": "Full Layout",
+            "choiceBasic": "Basic Layout",
+            "basicLayoutWarning": "The Page building block is supported with SAPUI5 version {{ minUi5VersionForPageBuildingBlock }} and above.",
+            "fullLayoutWarning": "Full Layout is supported with SAPUI5 version {{ minUi5VersionForFullLayout }} and above."
         },
         "tableType": {
             "message": "Table Type",

package/dist/types.d.ts

@@ -4,10 +4,11 @@ import type { CapService } from '@sap-ux/cap-config-writer';
 import type { TableSelectionMode, TableType } from '@sap-ux/fiori-elements-writer';
 import type { CommonPromptOptions, YUIQuestion } from '@sap-ux/inquirer-common';
 import type { OdataVersion } from '@sap-ux/odata-service-writer';
-import type { BackendSystem } from '@sap-ux/store';
+import type { BackendSystem, BackendSystemFilter } from '@sap-ux/store';
 import type { ListChoiceOptions } from 'inquirer';
 import type { serviceUrlInternalPromptNames } from './prompts/datasources/service-url/types.js';
 import type { EntityAnswer, NavigationEntityAnswer } from './prompts/edmx/entity-helper.js';
+import type { PageTemplateType } from '@sap-ux/fe-fpm-writer';
 /**
  * This file contains types that are exported by the module and are needed for consumers using the APIs `prompt` and `getPrompts`.
  */
@@ -159,6 +160,7 @@ export declare const EntityPromptNames: {
     readonly navigationEntity: "navigationEntity";
     readonly filterEntitySet: "filterEntitySet";
     readonly addPageBuildingBlock: "addPageBuildingBlock";
+    readonly pageBuildingBlockLayout: "pageBuildingBlockLayout";
     readonly pageBuildingBlockTitle: "pageBuildingBlockTitle";
     readonly tableType: "tableType";
     readonly hierarchyQualifier: "hierarchyQualifier";
@@ -180,9 +182,9 @@ export interface EntitySelectionAnswers {
  * Answers related to the Page Building Block prompt.
  */
 export interface PageBuildingBlockAnswers {
-    /** Indicates if a Page Building Block should be addedn*/
     [EntityPromptNames.addPageBuildingBlock]?: boolean;
-    /** The title for the Page Building Block, required if addPageBuildingBlock is true */
+    /** The layout type for the page building block. This is only applicable if addPageBuildingBlock is true. */
+    [EntityPromptNames.pageBuildingBlockLayout]?: PageTemplateType;
     [EntityPromptNames.pageBuildingBlockTitle]?: string;
 }
 export interface TableConfigAnswers {
@@ -307,6 +309,11 @@ export type SystemSelectionPromptOptions = {
      * If true, the 'New System' option is not added to the system selection list. Default is false - the 'New System' option will be available.
      */
     hideNewSystem?: boolean;
+    /**
+     * Include systems specified by the backendSystemFilter see {@link BackendSystemFilter}.
+     * Defaults to { connectionType: ['abap_catalog', 'odata_service'] } if not provided.
+     */
+    backendSystemFilter?: BackendSystemFilter;
 };
 export type MetadataPromptOptions = {
     /**

package/dist/types.js

@@ -76,6 +76,7 @@ export const EntityPromptNames = {
     navigationEntity: 'navigationEntity',
     filterEntitySet: 'filterEntitySet',
     addPageBuildingBlock: 'addPageBuildingBlock',
+    pageBuildingBlockLayout: 'pageBuildingBlockLayout',
     pageBuildingBlockTitle: 'pageBuildingBlockTitle',
     tableType: 'tableType',
     hierarchyQualifier: 'hierarchyQualifier',

package/dist/utils/store.d.ts

@@ -1,4 +1,4 @@
-import { type BackendSystem, type BackendSystemKey, type Service } from '@sap-ux/store';
+import { type BackendSystem, type BackendSystemKey, type BackendSystemFilter, type Service } from '@sap-ux/store';
 /**
  *  Get the backend system service instance.
  *
@@ -9,7 +9,8 @@ export declare function getBackendSystemService(): Promise<Service<BackendSystem
  * Fetch all backend systems.
  *
  * @param includeSensitiveData - whether to include sensitive data
- * @returns backened systems
+ * @param backendSystemFilter - store filter for backend systems. Defaults to { connectionType: ['abap_catalog', 'odata_service'] } if not provided.
+ * @returns backend systems
  */
-export declare function getAllBackendSystems(includeSensitiveData?: boolean): Promise<BackendSystem[] | []>;
+export declare function getAllBackendSystems(includeSensitiveData?: boolean, backendSystemFilter?: BackendSystemFilter): Promise<BackendSystem[] | []>;
 //# sourceMappingURL=store.d.ts.map

package/dist/utils/store.js

@@ -16,17 +16,16 @@ export async function getBackendSystemService() {
  * Fetch all backend systems.
  *
  * @param includeSensitiveData - whether to include sensitive data
- * @returns backened systems
+ * @param backendSystemFilter - store filter for backend systems. Defaults to { connectionType: ['abap_catalog', 'odata_service'] } if not provided.
+ * @returns backend systems
  */
-export async function getAllBackendSystems(includeSensitiveData = false) {
+export async function getAllBackendSystems(includeSensitiveData = false, backendSystemFilter) {
     let backendSystems = [];
     try {
         const backendService = await getBackendSystemService();
         backendSystems = await backendService.getAll({
             includeSensitiveData,
-            backendSystemFilter: {
-                connectionType: ['abap_catalog', 'odata_service']
-            }
+            backendSystemFilter: backendSystemFilter ?? { connectionType: ['abap_catalog', 'odata_service'] }
         });
     }
     catch (error) {

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": "3.0.25",
+  "version": "3.2.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -33,10 +33,10 @@
     "@sap-devx/yeoman-ui-types": "1.25.0",
     "@sap-ux/axios-extension": "2.0.7",
     "@sap-ux/btp-utils": "2.0.5",
-    "@sap-ux/fiori-generator-shared": "1.1.0",
+    "@sap-ux/fiori-generator-shared": "1.2.0",
     "@sap-ux/guided-answers-helper": "1.0.1",
     "@sap-ux/telemetry": "1.0.18",
-    "@sap-ux/inquirer-common": "1.0.22",
+    "@sap-ux/inquirer-common": "1.0.23",
     "@sap-ux/logger": "1.0.3",
     "@sap-ux/nodejs-utils": "1.0.7",
     "@sap-ux/project-access": "2.1.6",
@@ -49,12 +49,13 @@
     "@types/inquirer-autocomplete-prompt": "2.0.2",
     "@types/inquirer": "8.2.6",
     "jest-extended": "7.0.0",
-    "@sap-ux/fiori-generator-shared": "1.1.0",
-    "@sap-ux/fiori-elements-writer": "3.0.57",
-    "@sap-ux/fiori-freestyle-writer": "3.0.51",
+    "@sap-ux/fe-fpm-writer": "1.3.0",
+    "@sap-ux/fiori-generator-shared": "1.2.0",
+    "@sap-ux/fiori-elements-writer": "3.1.0",
+    "@sap-ux/fiori-freestyle-writer": "3.0.53",
     "@sap-ux/feature-toggle": "1.0.5",
     "@sap-ux/odata-service-writer": "1.0.12",
-    "@sap-ux/cap-config-writer": "1.0.21"
+    "@sap-ux/cap-config-writer": "1.0.22"
   },
   "engines": {
     "node": ">=22.x"