@sap-ux/fiori-app-sub-generator 0.7.2 → 0.7.4

package/generators/fiori-app-generator/fioriAppGenerator.js

@@ -178,6 +178,7 @@ class FioriAppGenerator extends yeoman_generator_1.default {
                     projectName: this.state.project?.name,
                     targetFolder: this.state.project?.targetFolder,
                     service: this.state.service,
+                    entityRelatedConfig: this.state.entityRelatedConfig,
                     floorplan: this.state.floorplan,
                     promptSettings: generatorOptions.promptSettings?.['@sap/generator-fiori'],
                     promptExtension: generatorOptions.extensions

package/generators/fiori-app-generator/prompting.d.ts

@@ -1,5 +1,5 @@
 import type { Logger } from '@sap-ux/logger';
-import { type CapService, type ConnectedSystem, type OdataServicePromptOptions, OdataVersion } from '@sap-ux/odata-service-inquirer';
+import { type CapService, type ConnectedSystem, type OdataServicePromptOptions, OdataVersion, type EntityRelatedAnswers } from '@sap-ux/odata-service-inquirer';
 import type { UI5ApplicationAnswers, UI5ApplicationPromptOptions } from '@sap-ux/ui5-application-inquirer';
 import type { Question } from 'inquirer';
 import type { Adapter } from 'yeoman-environment';
@@ -16,6 +16,7 @@ type PromptUI5AppAnswersOptions = {
     projectName?: Project['name'];
     targetFolder?: Project['targetFolder'];
     service: Partial<Service>;
+    entityRelatedConfig?: Partial<EntityRelatedAnswers>;
     promptSettings?: UI5ApplicationPromptOptions;
     floorplan: Floorplan;
     promptExtension?: UI5ApplicationPromptOptions;
@@ -31,11 +32,12 @@ type PromptUI5AppAnswersOptions = {
  * @param param0.promptSettings
  * @param param0.floorplan
  * @param param0.promptExtension
+ * @param param0.entityRelatedConfig
  * @param yeomanUiStepConfig
  * @param adapter
  * @returns
  */
-export declare function promptUI5ApplicationAnswers({ service, projectName, targetFolder, promptSettings, floorplan, promptExtension }: PromptUI5AppAnswersOptions, yeomanUiStepConfig: YeomanUiStepConfig[], adapter: Adapter): Promise<{
+export declare function promptUI5ApplicationAnswers({ service, projectName, targetFolder, promptSettings, floorplan, promptExtension, entityRelatedConfig }: PromptUI5AppAnswersOptions, yeomanUiStepConfig: YeomanUiStepConfig[], adapter: Adapter): Promise<{
     ui5AppAnswers: UI5ApplicationAnswers;
     localUI5Version: string | undefined;
 }>;
@@ -49,21 +51,26 @@ export declare function promptUI5ApplicationAnswers({ service, projectName, targ
  * @returns {Promise<Service>}
  */
 export declare function promptOdataServiceAnswers(options: OdataServiceInquirerOptions, logger: Logger, adapter: Adapter, connectedSystem?: ConnectedSystem): Promise<Service>;
+export type Ui5PromptOptions = PromptUI5AppAnswersOptions & {
+    appGenStepConfigList: YeomanUiStepConfig[];
+};
 /**
  * Creates the `UIApplicationPromptOptions`.
  * Note that setting 'default', the default prompt value or function, or 'hide', whether the prompt should be shown,
  * to `undefined` should mean that the setting is ignored by the prompt.
  *
- * @param service
- * @param appGenStepConfigList
- * @param floorplan
- * @param projectName
- * @param targetFolder
- * @param promptSettings
- * @param extensions
+ * @param {object} ui5PromptOptions - Options for configuring the UI5 application prompt.
+ * @param {Partial<Service>} ui5PromptOptions.service - The service configuration.
+ * @param {YeomanUiStepConfig[]} ui5PromptOptions.appGenStepConfigList - The list of Yeoman UI step configurations.
+ * @param {Floorplan} ui5PromptOptions.floorplan - The selected floorplan type.
+ * @param {string} [ui5PromptOptions.projectName] - The name of the project.
+ * @param {string} [ui5PromptOptions.targetFolder] - The target folder for the project.
+ * @param {UI5ApplicationPromptOptions} [ui5PromptOptions.promptSettings] - Additional prompt settings.
+ * @param {UI5ApplicationPromptOptions} [ui5PromptOptions.promptExtension] - Extension prompt settings.
+ * @param {Partial<EntityRelatedAnswers>} [ui5PromptOptions.entityRelatedConfig] - Entity-related configuration.
  * @returns {Promise<UI5ApplicationPromptOptions>} prompt options that may be used to configure UI5 application prompting
  */
-export declare function createUI5ApplicationPromptOptions(service: Partial<Readonly<Service>>, appGenStepConfigList: YeomanUiStepConfig[], floorplan: Floorplan, projectName?: Project['name'], targetFolder?: Project['targetFolder'], promptSettings?: UI5ApplicationPromptOptions, extensions?: UI5ApplicationPromptOptions): Promise<UI5ApplicationPromptOptions>;
+export declare function createUI5ApplicationPromptOptions(ui5PromptOptions: Ui5PromptOptions): Promise<UI5ApplicationPromptOptions>;
 /**
  * Convienience type for the options of the `createOdataServicePromptOptions` function.
  */

package/generators/fiori-app-generator/prompting.js

@@ -67,11 +67,12 @@ exports.getViewQuestion = getViewQuestion;
  * @param param0.promptSettings
  * @param param0.floorplan
  * @param param0.promptExtension
+ * @param param0.entityRelatedConfig
  * @param yeomanUiStepConfig
  * @param adapter
  * @returns
  */
-async function promptUI5ApplicationAnswers({ service, projectName, targetFolder, promptSettings, floorplan, promptExtension }, yeomanUiStepConfig, adapter) {
+async function promptUI5ApplicationAnswers({ service, projectName, targetFolder, promptSettings, floorplan, promptExtension, entityRelatedConfig }, yeomanUiStepConfig, adapter) {
     let inquirerAdapter;
     // type `any` will be replaced when we can import ESM modules
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -82,7 +83,16 @@ async function promptUI5ApplicationAnswers({ service, projectName, targetFolder,
     else {
         inquirerAdapter = adapter;
     }
-    const promptOptions = await createUI5ApplicationPromptOptions(service, yeomanUiStepConfig, floorplan, projectName, targetFolder, promptSettings, promptExtension);
+    const promptOptions = await createUI5ApplicationPromptOptions({
+        service,
+        appGenStepConfigList: yeomanUiStepConfig,
+        floorplan,
+        projectName,
+        targetFolder,
+        promptSettings,
+        promptExtension,
+        entityRelatedConfig
+    });
     const ui5AppAnswers = await (0, ui5_application_inquirer_1.prompt)(inquirerAdapter, promptOptions, service.capService?.cdsUi5PluginInfo, (0, fiori_generator_shared_1.getHostEnvironment)() !== fiori_generator_shared_1.hostEnvironment.cli);
     // Get the (latest) version available from npm, instead of UI5 versions service in case of unpublished versions
     const localUI5Version = (await (0, ui5_info_1.getUI5Versions)({
@@ -136,21 +146,24 @@ async function promptOdataServiceAnswers(options, logger, adapter, connectedSyst
  * Note that setting 'default', the default prompt value or function, or 'hide', whether the prompt should be shown,
  * to `undefined` should mean that the setting is ignored by the prompt.
  *
- * @param service
- * @param appGenStepConfigList
- * @param floorplan
- * @param projectName
- * @param targetFolder
- * @param promptSettings
- * @param extensions
+ * @param {object} ui5PromptOptions - Options for configuring the UI5 application prompt.
+ * @param {Partial<Service>} ui5PromptOptions.service - The service configuration.
+ * @param {YeomanUiStepConfig[]} ui5PromptOptions.appGenStepConfigList - The list of Yeoman UI step configurations.
+ * @param {Floorplan} ui5PromptOptions.floorplan - The selected floorplan type.
+ * @param {string} [ui5PromptOptions.projectName] - The name of the project.
+ * @param {string} [ui5PromptOptions.targetFolder] - The target folder for the project.
+ * @param {UI5ApplicationPromptOptions} [ui5PromptOptions.promptSettings] - Additional prompt settings.
+ * @param {UI5ApplicationPromptOptions} [ui5PromptOptions.promptExtension] - Extension prompt settings.
+ * @param {Partial<EntityRelatedAnswers>} [ui5PromptOptions.entityRelatedConfig] - Entity-related configuration.
  * @returns {Promise<UI5ApplicationPromptOptions>} prompt options that may be used to configure UI5 application prompting
  */
-async function createUI5ApplicationPromptOptions(service, appGenStepConfigList, floorplan, projectName, targetFolder, promptSettings, extensions) {
+async function createUI5ApplicationPromptOptions(ui5PromptOptions) {
+    const { service, appGenStepConfigList, floorplan, projectName, targetFolder, promptSettings, promptExtension: extensions, entityRelatedConfig } = ui5PromptOptions;
     // prompt settings may be additionally provided e.g. set by adaptors
     const ui5VersionPromptOptions = {
         hide: promptSettings?.[ui5_application_inquirer_1.promptNames.ui5Version]?.hide ?? false,
         minUI5Version: promptSettings?.[ui5_application_inquirer_1.promptNames.ui5Version]?.minUI5Version ??
-            (0, utils_1.getMinSupportedUI5Version)(service.version ?? odata_service_inquirer_1.OdataVersion.v2, floorplan),
+            (0, utils_1.getMinSupportedUI5Version)(service.version ?? odata_service_inquirer_1.OdataVersion.v2, floorplan, entityRelatedConfig),
         includeSeparators: (0, fiori_generator_shared_1.getHostEnvironment)() !== fiori_generator_shared_1.hostEnvironment.cli,
         useAutocomplete: (0, fiori_generator_shared_1.getHostEnvironment)() === fiori_generator_shared_1.hostEnvironment.cli
     };

package/generators/types/constants.d.ts

@@ -49,6 +49,7 @@ export declare const generatorName = "SAP Fiori Application Generator";
 export declare const FPM_DEFAULT_PAGE_NAME = "Main";
 export declare const minSupportedUi5Version = "1.65.0";
 export declare const minSupportedUi5VersionV4 = "1.84.0";
+export declare const minUi5VersionForPageBuildingBlock = "1.136.0";
 export declare const defaultNavActionTile = "tile";
 export declare const defaultNavActionDisplay = "display";
 /**

package/generators/types/constants.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Features = exports.defaultNavActionDisplay = exports.defaultNavActionTile = exports.minSupportedUi5VersionV4 = exports.minSupportedUi5Version = exports.FPM_DEFAULT_PAGE_NAME = exports.generatorName = exports.MAIN_MODEL_NAME = exports.MAIN_DATASOURCE_NAME = exports.DEFAULT_SERVICE_PATH = exports.DEFAULT_CAP_HOST = exports.DEFAULT_HOST = exports.FIORI_STEPS = exports.STEP_FLP_CONFIG = exports.STEP_DEPLOY_CONFIG = exports.STEP_PROJECT_ATTRIBUTES = exports.STEP_ENTITY = exports.STEP_DATASOURCE_AND_SERVICE = exports.STEP_FLOORPLAN = exports.API_HUB_TYPE = exports.API_HUB_API_KEY = exports.SAP_CLIENT_KEY = exports.UI5_VERSION_PROPS = exports.PLATFORMS = exports.LEGACY_CAP_TYPE_JAVA = exports.LEGACY_CAP_TYPE_NODE = void 0;
+exports.Features = exports.defaultNavActionDisplay = exports.defaultNavActionTile = exports.minUi5VersionForPageBuildingBlock = exports.minSupportedUi5VersionV4 = exports.minSupportedUi5Version = exports.FPM_DEFAULT_PAGE_NAME = exports.generatorName = exports.MAIN_MODEL_NAME = exports.MAIN_DATASOURCE_NAME = exports.DEFAULT_SERVICE_PATH = exports.DEFAULT_CAP_HOST = exports.DEFAULT_HOST = exports.FIORI_STEPS = exports.STEP_FLP_CONFIG = exports.STEP_DEPLOY_CONFIG = exports.STEP_PROJECT_ATTRIBUTES = exports.STEP_ENTITY = exports.STEP_DATASOURCE_AND_SERVICE = exports.STEP_FLOORPLAN = exports.API_HUB_TYPE = exports.API_HUB_API_KEY = exports.SAP_CLIENT_KEY = exports.UI5_VERSION_PROPS = exports.PLATFORMS = exports.LEGACY_CAP_TYPE_JAVA = exports.LEGACY_CAP_TYPE_NODE = void 0;
 const i18n_1 = require("../utils/i18n");
 exports.LEGACY_CAP_TYPE_NODE = 'capNode';
 exports.LEGACY_CAP_TYPE_JAVA = 'capJava';
@@ -86,6 +86,8 @@ exports.FPM_DEFAULT_PAGE_NAME = 'Main';
 // App gen specific (not writer specific) supported UI5 versions
 exports.minSupportedUi5Version = '1.65.0';
 exports.minSupportedUi5VersionV4 = '1.84.0';
+// The minimum UI5 version required for page building block feature
+exports.minUi5VersionForPageBuildingBlock = '1.136.0';
 exports.defaultNavActionTile = 'tile';
 exports.defaultNavActionDisplay = 'display';
 /**

package/generators/utils/common.d.ts

@@ -1,7 +1,7 @@
 import type { Annotations, ServiceProvider } from '@sap-ux/axios-extension';
 import type { CapRuntime, CapService } from '@sap-ux/cap-config-writer';
 import type { Logger } from '@sap-ux/logger';
-import { DatasourceType, OdataVersion, type ConnectedSystem } from '@sap-ux/odata-service-inquirer';
+import { DatasourceType, OdataVersion, type ConnectedSystem, type EntityRelatedAnswers } from '@sap-ux/odata-service-inquirer';
 import type { CdsAnnotationsInfo, EdmxAnnotationsInfo } from '@sap-ux/odata-service-writer';
 import type { CapProjectType, CdsUi5PluginInfo, CdsVersionInfo } from '@sap-ux/project-access';
 import type { Editor } from 'mem-fs-editor';
@@ -41,13 +41,15 @@ export declare function buildSapClientParam(sapClient: string): string;
  */
 export declare function getRequiredOdataVersion(floorplan: Floorplan): OdataVersion | undefined;
 /**
- * Gets the min supported version of UI5 for the floorplan and odata version specified.
+ * Gets the minimum supported UI5 version for the specified OData version, floorplan, and entity configuration.
+ * For FPM floorplans with page building blocks, enforces a minimum version of 1.136.0.
  *
- * @param version - odata version
- * @param floorplan - floorplan value
- * @returns min supported version
+ * @param version - The OData version.
+ * @param floorplan - The floorplan type.
+ * @param entityRelatedConfig - entity related configuration.
+ * @returns The minimum supported UI5 version as a string.
  */
-export declare function getMinSupportedUI5Version(version: OdataVersion, floorplan: Floorplan): string;
+export declare function getMinSupportedUI5Version(version: OdataVersion, floorplan: Floorplan, entityRelatedConfig?: Partial<EntityRelatedAnswers>): string;
 /**
  * Generates a v4 uuid. While not strictly necessary to wrap uuid it means we can enforce
  * additional options or change implementation easily in future.

package/generators/utils/common.js

@@ -26,6 +26,7 @@ const odata_service_inquirer_1 = require("@sap-ux/odata-service-inquirer");
 const project_access_1 = require("@sap-ux/project-access");
 const path_1 = require("path");
 const uuid_1 = require("uuid");
+const types_1 = require("../types");
 const constants_1 = require("../types/constants");
 const external_1 = require("../types/external");
 const i18n_1 = require("./i18n");
@@ -78,13 +79,18 @@ function getRequiredOdataVersion(floorplan) {
     return supportedVers.length === 1 ? supportedVers[0] : undefined;
 }
 /**
- * Gets the min supported version of UI5 for the floorplan and odata version specified.
+ * Gets the minimum supported UI5 version for the specified OData version, floorplan, and entity configuration.
+ * For FPM floorplans with page building blocks, enforces a minimum version of 1.136.0.
  *
- * @param version - odata version
- * @param floorplan - floorplan value
- * @returns min supported version
+ * @param version - The OData version.
+ * @param floorplan - The floorplan type.
+ * @param entityRelatedConfig - entity related configuration.
+ * @returns The minimum supported UI5 version as a string.
  */
-function getMinSupportedUI5Version(version, floorplan) {
+function getMinSupportedUI5Version(version, floorplan, entityRelatedConfig) {
+    if (floorplan === types_1.FloorplanFE.FE_FPM && entityRelatedConfig?.addPageBuildingBlock) {
+        return types_1.minUi5VersionForPageBuildingBlock;
+    }
     let minUI5Version;
     if (floorplan && floorplan !== external_1.FloorplanFF.FF_SIMPLE) {
         const templateType = external_1.FloorplanAttributes[floorplan].templateType;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/fiori-app-sub-generator",
   "description": "A yeoman (sub) generator that can generate Fiori applications. Not for standalone use.",
-  "version": "0.7.2",
+  "version": "0.7.4",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -39,7 +39,7 @@
     "@sap-ux/fiori-generator-shared": "0.13.10",
     "@sap-ux/fiori-tools-settings": "0.2.0",
     "@sap-ux/launch-config": "0.10.19",
-    "@sap-ux/odata-service-inquirer": "2.6.1",
+    "@sap-ux/odata-service-inquirer": "2.7.1",
     "@sap-ux/odata-service-writer": "0.27.17",
     "@sap-ux/project-access": "1.30.12",
     "@sap-ux/store": "1.1.3",
@@ -62,8 +62,8 @@
     "mock-spawn": "0.2.6",
     "rimraf": "5.0.5",
     "yeoman-test": "6.3.0",
-    "@sap-ux/deploy-config-sub-generator": "0.3.61",
-    "@sap-ux/flp-config-sub-generator": "0.3.17",
+    "@sap-ux/deploy-config-sub-generator": "0.4.0",
+    "@sap-ux/flp-config-sub-generator": "0.3.18",
     "@sap-ux/inquirer-common": "0.7.36",
     "@sap-ux/jest-file-matchers": "0.2.4",
     "@sap-ux/logger": "0.7.0"