@sap-ux/fiori-app-sub-generator 0.5.30 → 0.6.1

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

@@ -112,7 +112,7 @@ class FioriAppGenerator extends yeoman_generator_1.default {
                     capService: cachedService?.capService ?? this.state.service?.capService,
                     requiredOdataVersion: (0, utils_1.getRequiredOdataVersion)(this.state.floorplan),
                     allowNoDatasource: isFioriFreestyleTemplate,
-                    promptOptions: generatorOptions.promptSettings,
+                    promptOptions: generatorOptions.promptSettings?.['@sap/generator-fiori'],
                     showCollabDraftWarning: generatorOptions.showCollabDraftWarning,
                     workspaceFolders: generatorOptions.workspaceFolders
                 };
@@ -174,7 +174,7 @@ class FioriAppGenerator extends yeoman_generator_1.default {
                     targetFolder: this.state.project?.targetFolder,
                     service: this.state.service,
                     floorplan: this.state.floorplan,
-                    promptSettings: generatorOptions.promptSettings,
+                    promptSettings: generatorOptions.promptSettings?.['@sap/generator-fiori'],
                     promptExtension: generatorOptions.extensions
                 }, [this.yeomanUiStepConfig], this.env.adapter);
                 this.state.project = Object.assign(this.state.project ?? {}, ui5AppAnswers, {
@@ -194,10 +194,9 @@ class FioriAppGenerator extends yeoman_generator_1.default {
                 (0, subgenHelpers_1.addDeployGen)({
                     service: this.state.service,
                     projectName: this.state.project.name,
-                    promptSettings: generatorOptions.promptSettings,
                     targetFolder: this.state.project.targetFolder,
                     applicationType: this.state.floorplan === types_1.FloorplanFF.FF_SIMPLE ? 'FF' : 'FE' // Telemetry data
-                }, this.composeWith.bind(this), FioriAppGenerator.logger, this.appWizard);
+                }, this.composeWith.bind(this), FioriAppGenerator.logger, this.appWizard, generatorOptions.promptSettings?.['@sap-ux/deploy-config-sub-generator']);
             }
             if (this.state.project?.addFlpConfig) {
                 // Allows back nav where we have interdependent steps
@@ -211,7 +210,7 @@ class FioriAppGenerator extends yeoman_generator_1.default {
                     targetFolder: this.state.project.targetFolder,
                     title: this.state.project.title,
                     skipPrompt: !(0, utils_1.hasStep)(this.fioriSteps, types_1.STEP_FLP_CONFIG)
-                }, this.composeWith.bind(this), FioriAppGenerator.logger, generatorOptions.vscode, this.appWizard);
+                }, this.composeWith.bind(this), FioriAppGenerator.logger, generatorOptions.vscode, this.appWizard, generatorOptions.promptSettings?.['@sap-ux/flp-config-sub-generator']);
             }
         }
         catch (error) {

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

@@ -25,6 +25,8 @@ export interface FioriAppGeneratorOptions extends Generator.GeneratorOptions, Fi
     data?: Object;
     /**
      * Customer provided extensions used to customize existing questions
+     *
+     * @deprecated Use `promptSettings` instead.
      */
     extensions?: UI5ApplicationPromptOptions;
     /**
@@ -32,7 +34,7 @@ export interface FioriAppGeneratorOptions extends Generator.GeneratorOptions, Fi
      */
     floorplan?: Floorplan;
     /**
-     * Prompt settings to control visibility and default values of prompts
+     * Prompt settings to control visibility, default values and other prompt related settings.
      */
     promptSettings?: FioriAppGeneratorPromptSettings;
     /**

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

@@ -1,9 +1,9 @@
 import type { Logger } from '@sap-ux/logger';
-import { type CapService, type ConnectedSystem, OdataVersion } from '@sap-ux/odata-service-inquirer';
+import { type CapService, type ConnectedSystem, type OdataServicePromptOptions, OdataVersion } 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';
-import type { FioriAppGeneratorPromptSettings, Floorplan, Project, Service, YeomanUiStepConfig } from '../types';
+import type { Floorplan, Project, Service, YeomanUiStepConfig } from '../types';
 declare const viewNamePromptName = "viewName";
 export interface ViewNameAnswer {
     [viewNamePromptName]: string;
@@ -16,7 +16,7 @@ type PromptUI5AppAnswersOptions = {
     projectName?: Project['name'];
     targetFolder?: Project['targetFolder'];
     service: Partial<Service>;
-    promptSettings?: FioriAppGeneratorPromptSettings;
+    promptSettings?: UI5ApplicationPromptOptions;
     floorplan: Floorplan;
     promptExtension?: UI5ApplicationPromptOptions;
 };
@@ -63,7 +63,7 @@ export declare function promptOdataServiceAnswers(options: OdataServiceInquirerO
  * @param extensions
  * @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?: FioriAppGeneratorPromptSettings, extensions?: UI5ApplicationPromptOptions): Promise<UI5ApplicationPromptOptions>;
+export declare function createUI5ApplicationPromptOptions(service: Partial<Readonly<Service>>, appGenStepConfigList: YeomanUiStepConfig[], floorplan: Floorplan, projectName?: Project['name'], targetFolder?: Project['targetFolder'], promptSettings?: UI5ApplicationPromptOptions, extensions?: UI5ApplicationPromptOptions): Promise<UI5ApplicationPromptOptions>;
 /**
  * Convienience type for the options of the `createOdataServicePromptOptions` function.
  */
@@ -75,7 +75,7 @@ export interface OdataServiceInquirerOptions {
      * Note: only some of the allowed prompt options are currently supported.
      * Eventually all should be supported by merging the options with the prompt specific options.
      */
-    promptOptions?: FioriAppGeneratorPromptSettings;
+    promptOptions?: OdataServicePromptOptions;
     showCollabDraftWarning?: boolean;
     workspaceFolders?: string[];
 }

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

@@ -149,7 +149,8 @@ async function createUI5ApplicationPromptOptions(service, appGenStepConfigList,
     // prompt settings may be additionally provided e.g. set by adaptors
     const ui5VersionPromptOptions = {
         hide: promptSettings?.[ui5_application_inquirer_1.promptNames.ui5Version]?.hide ?? false,
-        minUI5Version: (0, utils_1.getMinSupportedUI5Version)(service.version ?? odata_service_inquirer_1.OdataVersion.v2, floorplan),
+        minUI5Version: promptSettings?.[ui5_application_inquirer_1.promptNames.ui5Version]?.minUI5Version ??
+            (0, utils_1.getMinSupportedUI5Version)(service.version ?? odata_service_inquirer_1.OdataVersion.v2, floorplan),
         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
     };
@@ -249,7 +250,7 @@ async function createUI5ApplicationPromptOptions(service, appGenStepConfigList,
  * @param options.requiredOdataVersion will trigger warnings in prompts if the OData version is not supported.
  * @param options.allowNoDatasource If true, the user will be able to select 'None' as the datasource type. Fiori Freestyle specific.
  * @param options.capService If provided, the user will not be prompted for the CAP project and the default datasource type will be set to CAP project.
- * @param options.promptOptions A limited set of prompt options that can be set by the caller.
+ * @param options.promptOptions Odata service inquirer prompt options that can be set by the caller.
  * @param options.showCollabDraftWarning If true, a warning will be shown in the prompt if the service is a collaborative draft service.
  * @returns
  */
@@ -265,27 +266,35 @@ function createOdataServicePromptOptions(options) {
     return {
         [odata_service_inquirer_1.promptNames.datasourceType]: {
             default: defaultDatasourceSelection,
-            includeNone: !!options.allowNoDatasource
+            includeNone: !!options.allowNoDatasource,
+            ...options.promptOptions?.datasourceType
         },
         [odata_service_inquirer_1.promptNames.metadataFilePath]: {
-            requiredOdataVersion: options.requiredOdataVersion
+            requiredOdataVersion: options.requiredOdataVersion,
+            ...options.promptOptions?.metadataFilePath
         },
         [odata_service_inquirer_1.promptNames.capProject]: {
             capSearchPaths: options.workspaceFolders ?? [],
-            defaultChoice: options.capService?.projectPath
+            defaultChoice: options.capService?.projectPath,
+            ...options.promptOptions?.capProject
         },
         [odata_service_inquirer_1.promptNames.capService]: {
-            defaultChoice: options.capService
+            defaultChoice: options.capService,
+            ...options.promptOptions?.capService
         },
         [odata_service_inquirer_1.promptNames.serviceUrl]: {
             requiredOdataVersion: options.requiredOdataVersion,
-            showCollaborativeDraftWarning: options.showCollabDraftWarning && isYUI
+            showCollaborativeDraftWarning: options.showCollabDraftWarning && isYUI,
+            ...options.promptOptions?.serviceUrl
         },
         [odata_service_inquirer_1.promptNames.serviceSelection]: {
             useAutoComplete: (0, fiori_generator_shared_1.getHostEnvironment)() === fiori_generator_shared_1.hostEnvironment.cli,
-            requiredOdataVersion: options.requiredOdataVersion ?? options.promptOptions?.serviceSelection?.requiredOdataVersion,
+            requiredOdataVersion: options.requiredOdataVersion,
             showCollaborativeDraftWarning: options.showCollabDraftWarning && isYUI,
-            serviceFilter: options.promptOptions?.serviceSelection?.serviceFilter
+            ...options.promptOptions?.serviceSelection
+        },
+        [odata_service_inquirer_1.promptNames.userSystemName]: {
+            ...options.promptOptions?.userSystemName
         },
         [odata_service_inquirer_1.promptNames.systemSelection]: {
             destinationFilters: {

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

@@ -1,27 +1,28 @@
-import type { AppWizard } from '@sap-devx/yeoman-ui-types';
-import { type ILogWrapper } from '@sap-ux/fiori-generator-shared';
 import type Generator from 'yeoman-generator';
-import { type FioriAppGeneratorPromptSettings, type Service } from '../types';
+import type { AppWizard } from '@sap-devx/yeoman-ui-types';
+import type { ILogWrapper } from '@sap-ux/fiori-generator-shared';
+import type { FLPConfigPromptOptions } from '@sap-ux/flp-config-sub-generator';
+import type { Service } from '../types';
+import type { DeployConfigSubGenPromptOptions } from '@sap-ux/deploy-config-sub-generator';
 /**
  * Add the '@sap/fiori:fiori-deployment' generator as a subgenerator.
  *
  * @param deployGenOpts
  * @param deployGenOpts.service - service object
  * @param deployGenOpts.projectName - project name
- * @param deployGenOpts.promptSettings - prompt settings for the deployment generator
  * @param deployGenOpts.targetFolder - target folder for the deployment configuration
  * @param deployGenOpts.applicationType - application type, used for telemetry (FF | FE)
  * @param composeWith - the composeWith function from the Yeoman generator
  * @param logger - logger instance
  * @param appWizard - instance of the AppWizard
+ * @param promptSettings - prompt settings for the deployment generator
  */
-export declare function addDeployGen({ service, projectName, promptSettings, targetFolder, applicationType }: {
+export declare function addDeployGen({ service, projectName, targetFolder, applicationType }: {
     service: Partial<Service>;
     projectName: string;
-    promptSettings?: FioriAppGeneratorPromptSettings;
     targetFolder: string;
     applicationType: string;
-}, composeWith: Generator['composeWith'], logger: ILogWrapper, appWizard?: AppWizard): void;
+}, composeWith: Generator['composeWith'], logger: ILogWrapper, appWizard?: AppWizard, promptSettings?: DeployConfigSubGenPromptOptions): void;
 /**
  * Add the '@sap/fiori:flp-config' generator as a subgenerator using `composeWith`.
  * Skipping the prompting (`skipPrompt`) will still write the config, but not ask for any input.
@@ -35,11 +36,12 @@ export declare function addDeployGen({ service, projectName, promptSettings, tar
  * @param logger
  * @param appWizard
  * @param vscode
+ * @param promptSettings - prompt settings for the flp generator used in the inquirer
  */
 export declare function addFlpGen({ projectName, targetFolder, title, skipPrompt }: {
     projectName: string;
     targetFolder: string;
     title: string;
     skipPrompt: boolean;
-}, composeWith: Generator['composeWith'], logger: ILogWrapper, appWizard?: AppWizard, vscode?: any): void;
+}, composeWith: Generator['composeWith'], logger: ILogWrapper, appWizard?: AppWizard, vscode?: any, promptSettings?: FLPConfigPromptOptions): void;
 //# sourceMappingURL=subgenHelpers.d.ts.map

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

@@ -2,23 +2,23 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.addDeployGen = addDeployGen;
 exports.addFlpGen = addFlpGen;
-const fiori_generator_shared_1 = require("@sap-ux/fiori-generator-shared");
 const path_1 = require("path");
 const types_1 = require("../types");
+const fiori_generator_shared_1 = require("@sap-ux/fiori-generator-shared");
 /**
  * Add the '@sap/fiori:fiori-deployment' generator as a subgenerator.
  *
  * @param deployGenOpts
  * @param deployGenOpts.service - service object
  * @param deployGenOpts.projectName - project name
- * @param deployGenOpts.promptSettings - prompt settings for the deployment generator
  * @param deployGenOpts.targetFolder - target folder for the deployment configuration
  * @param deployGenOpts.applicationType - application type, used for telemetry (FF | FE)
  * @param composeWith - the composeWith function from the Yeoman generator
  * @param logger - logger instance
  * @param appWizard - instance of the AppWizard
+ * @param promptSettings - prompt settings for the deployment generator
  */
-function addDeployGen({ service, projectName, promptSettings, targetFolder, applicationType }, composeWith, logger, appWizard) {
+function addDeployGen({ service, projectName, targetFolder, applicationType }, composeWith, logger, appWizard, promptSettings) {
     composeWith('@sap/fiori:deploy-config', {
         launchDeployConfigAsSubGenerator: true,
         appGenServiceHost: service.host,
@@ -32,7 +32,7 @@ function addDeployGen({ service, projectName, promptSettings, targetFolder, appl
         appWizard: appWizard,
         telemetryData: { appType: applicationType },
         logWrapper: logger,
-        subGenPromptOptions: promptSettings?.['@sap-ux/deploy-config-sub-generator']
+        subGenPromptOptions: promptSettings
     });
 }
 /**
@@ -48,14 +48,16 @@ function addDeployGen({ service, projectName, promptSettings, targetFolder, appl
  * @param logger
  * @param appWizard
  * @param vscode
+ * @param promptSettings - prompt settings for the flp generator used in the inquirer
  */
-function addFlpGen({ projectName, targetFolder, title, skipPrompt }, composeWith, logger, appWizard, vscode) {
+function addFlpGen({ projectName, targetFolder, title, skipPrompt }, composeWith, logger, appWizard, vscode, promptSettings) {
     let flpConfigOptions = {
         launchFlpConfigAsSubGenerator: true,
         appWizard,
         vscode,
         appRootPath: (0, path_1.join)(targetFolder, projectName),
-        logWrapper: logger
+        logWrapper: logger,
+        inquirerPromptOptions: promptSettings
     };
     if (skipPrompt) {
         flpConfigOptions = {

package/generators/types/common.d.ts

@@ -1,7 +1,7 @@
-import type { DatasourceType, OdataServicePromptOptions, OdataVersion, promptNames } from '@sap-ux/odata-service-inquirer';
+import type { DatasourceType, OdataServicePromptOptions, OdataVersion } from '@sap-ux/odata-service-inquirer';
 import type { UI5ApplicationPromptOptions } from '@sap-ux/ui5-application-inquirer';
-import type { AbapDeployConfigPromptOptions } from '@sap-ux/abap-deploy-config-inquirer';
-import type { CfDeployConfigPromptOptions } from '@sap-ux/cf-deploy-config-inquirer';
+import type { FLPConfigPromptOptions } from '@sap-ux/flp-config-sub-generator';
+import type { DeployConfigSubGenPromptOptions } from '@sap-ux/deploy-config-sub-generator';
 /**
  * package.json script entries (commands and tasks)
  */
@@ -16,9 +16,14 @@ export type WorkspaceFolder = {
     folderName: string;
     path: string;
 };
-export type FioriAppGeneratorPromptSettings = UI5ApplicationPromptOptions & Pick<OdataServicePromptOptions, promptNames.systemSelection | promptNames.serviceSelection> & {
-    '@sap-ux/deploy-config-sub-generator'?: AbapDeployConfigPromptOptions | CfDeployConfigPromptOptions;
-};
+export interface SubGeneratorPromptSettings {
+    '@sap-ux/deploy-config-sub-generator'?: DeployConfigSubGenPromptOptions;
+    '@sap-ux/flp-config-sub-generator'?: FLPConfigPromptOptions;
+}
+export interface FioriGeneratorPromptSettings {
+    '@sap/generator-fiori'?: OdataServicePromptOptions & UI5ApplicationPromptOptions;
+}
+export type FioriAppGeneratorPromptSettings = FioriGeneratorPromptSettings & SubGeneratorPromptSettings;
 /**
  * Custom environment type until yeoman-environment provides one
  */

package/generators/types/external.d.ts

@@ -4,7 +4,7 @@ import { TemplateType as FFTemplateType } from '@sap-ux/fiori-freestyle-writer';
 import { AppConfig, type Floorplan, FloorplanFE, FloorplanFF } from '@sap-ux/fiori-generator-shared';
 import type { CapRuntime, EntityRelatedAnswers } from '@sap-ux/odata-service-inquirer';
 import { OdataVersion } from '@sap-ux/odata-service-inquirer';
-import { type UI5ApplicationPromptOptions } from '@sap-ux/ui5-application-inquirer';
+import type { FioriGeneratorPromptSettings, SubGeneratorPromptSettings } from './common';
 import type { Answers } from 'inquirer';
 import { type ALPOptions, type Project, type Service } from './state';
 export { Floorplan, FloorplanFE, FloorplanFF, AppConfig };
@@ -94,9 +94,7 @@ export interface FioriGeneratorSettings {
      */
     showLayoutPrompts?: boolean;
 }
-export interface FioriGeneratorPromptExtension {
-    [generatorName: string]: UI5ApplicationPromptOptions;
-}
+export type FioriGeneratorPromptExtension = FioriGeneratorPromptSettings & SubGeneratorPromptSettings;
 export interface ConditionalStep extends Step {
     /**
      * Provide a function which returns true when a step should be added, answers to previous questions will be provided

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.5.30",
+  "version": "0.6.1",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -30,21 +30,21 @@
     "uuid": "11.0.5",
     "yeoman-generator": "5.10.0",
     "@sap-ux/annotation-generator": "0.3.46",
-    "@sap-ux/axios-extension": "1.22.3",
     "@sap-ux/btp-utils": "1.1.0",
-    "@sap-ux/cap-config-writer": "0.10.21",
     "@sap-ux/feature-toggle": "0.3.0",
+    "@sap-ux/axios-extension": "1.22.3",
+    "@sap-ux/cap-config-writer": "0.10.21",
     "@sap-ux/fiori-elements-writer": "2.5.14",
-    "@sap-ux/fiori-freestyle-writer": "2.4.25",
     "@sap-ux/fiori-generator-shared": "0.13.3",
+    "@sap-ux/fiori-freestyle-writer": "2.4.25",
     "@sap-ux/fiori-tools-settings": "0.2.0",
     "@sap-ux/launch-config": "0.10.14",
     "@sap-ux/odata-service-inquirer": "2.5.22",
     "@sap-ux/odata-service-writer": "0.27.12",
     "@sap-ux/project-access": "1.30.7",
     "@sap-ux/store": "1.1.2",
-    "@sap-ux/telemetry": "0.6.10",
     "@sap-ux/ui5-application-inquirer": "0.14.31",
+    "@sap-ux/telemetry": "0.6.10",
     "@sap-ux/ui5-info": "0.12.1"
   },
   "devDependencies": {
@@ -57,17 +57,16 @@
     "@types/yeoman-environment": "2.10.11",
     "@types/yeoman-generator": "5.2.14",
     "@types/yeoman-test": "4.0.6",
-    "jest-extended": "4.0.2",
-    "jest-mock": "29.7.0",
+    "jest-extended": "6.0.0",
+    "jest-mock": "30.0.1",
     "mock-spawn": "0.2.6",
     "rimraf": "5.0.5",
     "yeoman-test": "6.3.0",
-    "@sap-ux/abap-deploy-config-inquirer": "1.4.38",
-    "@sap-ux/cf-deploy-config-inquirer": "0.3.30",
-    "@sap-ux/flp-config-sub-generator": "0.2.55",
+    "@sap-ux/deploy-config-sub-generator": "0.3.47",
     "@sap-ux/inquirer-common": "0.7.27",
-    "@sap-ux/jest-file-matchers": "0.2.4",
-    "@sap-ux/logger": "0.7.0"
+    "@sap-ux/logger": "0.7.0",
+    "@sap-ux/flp-config-sub-generator": "0.3.0",
+    "@sap-ux/jest-file-matchers": "0.2.4"
   },
   "engines": {
     "node": ">=20.x"
@@ -78,7 +77,7 @@
     "watch": "tsc --watch",
     "lint": "eslint . --ext .ts",
     "lint:fix": "eslint . --ext .ts --fix",
-    "test": "jest --ci --forceExit --detectOpenHandles --colors --passWithNoTests",
+    "test": "jest --ci --forceExit --detectOpenHandles --colors",
     "test-u": "jest --ci --forceExit --detectOpenHandles --colors -u",
     "link": "pnpm link --global",
     "unlink": "pnpm unlink --global"