@sap-ux/fiori-app-sub-generator 0.1.0 → 0.2.0

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

@@ -174,7 +174,6 @@ class FioriAppGenerator extends yeoman_generator_1.default {
                     targetFolder: this.state.project?.targetFolder,
                     service: this.state.service,
                     floorplan: this.state.floorplan,
-                    hideUI5VersionPrompt: generatorOptions.hideUI5VersionPrompt,
                     promptSettings: generatorOptions.promptSettings,
                     promptExtension: generatorOptions.extensions
                 }, [this.yeomanUiStepConfig], this.env.adapter);

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

@@ -1,6 +1,7 @@
 import type { AppWizard, Severity } from '@sap-devx/yeoman-ui-types';
 import type Generator from 'yeoman-generator';
-import type { FioriGeneratorSettings, FioriStep, Floorplan, PromptExtension, FioriAppGeneratorPromptSettings, State, YeomanUiStepConfig } from '../types';
+import type { FioriGeneratorSettings, FioriStep, Floorplan, FioriAppGeneratorPromptSettings, State, YeomanUiStepConfig } from '../types';
+import type { UI5ApplicationPromptOptions } from '@sap-ux/ui5-application-inquirer';
 /**
  * Fiori generator specific options, for internal use only.
  * todo: Split this into FioriGenerator options (e.g. disableS4, disableGeneratorExtensions, data) that are explicitly root generator options
@@ -25,7 +26,7 @@ export interface FioriAppGeneratorOptions extends Generator.GeneratorOptions, Fi
     /**
      * Customer provided extensions used to customize existing questions
      */
-    extensions?: PromptExtension;
+    extensions?: UI5ApplicationPromptOptions;
     /**
      * The floorplan (app type) that will be created
      */

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

@@ -3,7 +3,7 @@ import { type CapService, type ConnectedSystem, OdataVersion } from '@sap-ux/oda
 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, PromptExtension, Service, YeomanUiStepConfig } from '../types';
+import type { FioriAppGeneratorPromptSettings, Floorplan, Project, Service, YeomanUiStepConfig } from '../types';
 declare const viewNamePromptName = "viewName";
 export interface ViewNameAnswer {
     [viewNamePromptName]: string;
@@ -17,16 +17,14 @@ type PromptUI5AppAnswersOptions = {
     targetFolder?: Project['targetFolder'];
     service: Partial<Service>;
     promptSettings?: FioriAppGeneratorPromptSettings;
-    hideUI5VersionPrompt?: boolean;
     floorplan: Floorplan;
-    promptExtension?: PromptExtension;
+    promptExtension?: UI5ApplicationPromptOptions;
 };
 /**
  * Creates the prompt options for UI5 application prompting and calls `prompt`.
  * The answers to the questions are returned.
  *
  * @param param0
- * @param param0.hideUI5VersionPrompt this will override the `hide` property of the ui5Version prompt setting if provided
  * @param param0.service
  * @param param0.projectName
  * @param param0.targetFolder
@@ -37,7 +35,7 @@ type PromptUI5AppAnswersOptions = {
  * @param adapter
  * @returns
  */
-export declare function promptUI5ApplicationAnswers({ service, projectName, targetFolder, promptSettings, hideUI5VersionPrompt, floorplan, promptExtension }: PromptUI5AppAnswersOptions, yeomanUiStepConfig: YeomanUiStepConfig[], adapter: Adapter): Promise<{
+export declare function promptUI5ApplicationAnswers({ service, projectName, targetFolder, promptSettings, floorplan, promptExtension }: PromptUI5AppAnswersOptions, yeomanUiStepConfig: YeomanUiStepConfig[], adapter: Adapter): Promise<{
     ui5AppAnswers: UI5ApplicationAnswers;
     localUI5Version: string | undefined;
 }>;
@@ -65,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?: PromptExtension): Promise<UI5ApplicationPromptOptions>;
+export declare function createUI5ApplicationPromptOptions(service: Partial<Readonly<Service>>, appGenStepConfigList: YeomanUiStepConfig[], floorplan: Floorplan, projectName?: Project['name'], targetFolder?: Project['targetFolder'], promptSettings?: FioriAppGeneratorPromptSettings, extensions?: UI5ApplicationPromptOptions): Promise<UI5ApplicationPromptOptions>;
 /**
  * Convienience type for the options of the `createOdataServicePromptOptions` function.
  */

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

@@ -61,7 +61,6 @@ exports.getViewQuestion = getViewQuestion;
  * The answers to the questions are returned.
  *
  * @param param0
- * @param param0.hideUI5VersionPrompt this will override the `hide` property of the ui5Version prompt setting if provided
  * @param param0.service
  * @param param0.projectName
  * @param param0.targetFolder
@@ -72,7 +71,7 @@ exports.getViewQuestion = getViewQuestion;
  * @param adapter
  * @returns
  */
-async function promptUI5ApplicationAnswers({ service, projectName, targetFolder, promptSettings, hideUI5VersionPrompt, floorplan, promptExtension }, yeomanUiStepConfig, adapter) {
+async function promptUI5ApplicationAnswers({ service, projectName, targetFolder, promptSettings, floorplan, promptExtension }, yeomanUiStepConfig, adapter) {
     let inquirerAdapter;
     // type `any` will be replaced when we can import ESM modules
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -83,14 +82,7 @@ async function promptUI5ApplicationAnswers({ service, projectName, targetFolder,
     else {
         inquirerAdapter = adapter;
     }
-    // Convert prompt related options to prompt settings
-    const pmptSettings = {
-        ...promptSettings,
-        [ui5_application_inquirer_1.promptNames.ui5Version]: {
-            hide: hideUI5VersionPrompt ?? false
-        }
-    };
-    const promptOptions = await createUI5ApplicationPromptOptions(service, yeomanUiStepConfig, floorplan, projectName, targetFolder, pmptSettings, promptExtension);
+    const promptOptions = await createUI5ApplicationPromptOptions(service, yeomanUiStepConfig, floorplan, projectName, targetFolder, promptSettings, promptExtension);
     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)({
@@ -182,7 +174,7 @@ async function createUI5ApplicationPromptOptions(service, appGenStepConfigList,
         };
     }
     // Add more prompt options as required
-    const promptOptions = (0, merge_1.default)({
+    const preMergedPromptOpts = {
         [ui5_application_inquirer_1.promptNames.name]: {
             defaultValue: projectName
         },
@@ -202,13 +194,14 @@ async function createUI5ApplicationPromptOptions(service, appGenStepConfigList,
             }
         },
         [ui5_application_inquirer_1.promptNames.enableTypeScript]: {
-            defaultValue: types_1.defaultPromptValues[ui5_application_inquirer_1.promptNames.enableTypeScript]
+            default: types_1.defaultPromptValues[ui5_application_inquirer_1.promptNames.enableTypeScript]
         },
         [ui5_application_inquirer_1.promptNames.enableVirtualEndpoints]: {
             hide: service.capService?.capType === 'Java'
         }
-    }, promptSettings);
-    // Configure the prompts which should be hidden behind the ad
+    };
+    const promptOptions = (0, merge_1.default)(preMergedPromptOpts, promptSettings);
+    // Configure the prompts which should be hidden behind the advanced option switch
     const advancedPrompts = [
         ui5_application_inquirer_1.promptNames.enableCodeAssist,
         ui5_application_inquirer_1.promptNames.skipAnnotations,

package/generators/types/external.d.ts

@@ -2,12 +2,11 @@ import type { IPrompt as Step } from '@sap-devx/yeoman-ui-types';
 import type { Annotations } from '@sap-ux/axios-extension';
 import { TemplateType as FETemplateType } from '@sap-ux/fiori-elements-writer';
 import { TemplateType as FFTemplateType } from '@sap-ux/fiori-freestyle-writer';
-import type { PromptSeverityMessage } from '@sap-ux/inquirer-common';
 import type { DeployConfig, FLPConfig } 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 { promptNames as ui5AppInquirerPromptNames } from '@sap-ux/ui5-application-inquirer';
-import type { Answers, Question } from 'inquirer';
+import { type UI5ApplicationPromptOptions } from '@sap-ux/ui5-application-inquirer';
+import type { Answers } from 'inquirer';
 import { type ALPOptions, type Project, type Service, type Floorplan, FloorplanFE, FloorplanFF } from './state';
 export { Floorplan, FloorplanFE, FloorplanFF };
 export type FloorplanKey = keyof typeof FloorplanFE | keyof typeof FloorplanFF;
@@ -132,12 +131,6 @@ export declare function capTypeConversion(capType?: string): CapRuntime;
  * NOTE: Only options specific to FE/FF generators should be passed as options, all other options should be provided via generator extensions
  */
 export interface FioriGeneratorSettings {
-    /**
-     * Toggles ui5 version prompting
-     *
-     * @deprecated Use extensions + prompt options (UI5ApplcationInquirer `ui5Version` options 'hide') to control this
-     */
-    hideUI5VersionPrompt?: boolean;
     /**
      * Toggles the generation of index.html and excludes the start-noflp script from package.json
      */
@@ -155,20 +148,8 @@ export interface FioriGeneratorSettings {
      */
     showLayoutPrompts?: boolean;
 }
-/**
- * Defines the currently allowed extension points for a Fiori Generator prompt
- * todo: Include open source inquirer prompt options (UI5ApplicationInquirer prompt options) also so extensions can directly use them
- *
- */
-export type PromptExtension = {
-    [key in ui5AppInquirerPromptNames]?: {
-        validate?: Question['validate'];
-        default?: Question['default'];
-        additionalMessages?: PromptSeverityMessage;
-    };
-};
 export interface FioriGeneratorPromptExtension {
-    [generatorName: string]: PromptExtension;
+    [generatorName: string]: UI5ApplicationPromptOptions;
 }
 export interface ConditionalStep extends Step {
     /**

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.1.0",
+  "version": "0.2.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -29,22 +29,22 @@
     "mem-fs-editor": "9.4.0",
     "uuid": "11.0.5",
     "yeoman-generator": "5.10.0",
-    "@sap-ux/annotation-generator": "0.3.32",
+    "@sap-ux/annotation-generator": "0.3.33",
     "@sap-ux/axios-extension": "1.21.0",
     "@sap-ux/btp-utils": "1.1.0",
-    "@sap-ux/cap-config-writer": "0.10.0",
+    "@sap-ux/cap-config-writer": "0.10.1",
     "@sap-ux/feature-toggle": "0.3.0",
-    "@sap-ux/fiori-elements-writer": "2.4.0",
-    "@sap-ux/fiori-freestyle-writer": "2.4.0",
-    "@sap-ux/fiori-generator-shared": "0.12.0",
+    "@sap-ux/fiori-elements-writer": "2.4.1",
+    "@sap-ux/fiori-freestyle-writer": "2.4.1",
+    "@sap-ux/fiori-generator-shared": "0.12.1",
     "@sap-ux/fiori-tools-settings": "0.2.0",
-    "@sap-ux/launch-config": "0.10.0",
-    "@sap-ux/odata-service-inquirer": "2.4.0",
-    "@sap-ux/odata-service-writer": "0.27.0",
-    "@sap-ux/project-access": "1.30.0",
+    "@sap-ux/launch-config": "0.10.1",
+    "@sap-ux/odata-service-inquirer": "2.4.1",
+    "@sap-ux/odata-service-writer": "0.27.1",
+    "@sap-ux/project-access": "1.30.1",
     "@sap-ux/store": "1.1.0",
-    "@sap-ux/telemetry": "0.6.0",
-    "@sap-ux/ui5-application-inquirer": "0.13.0",
+    "@sap-ux/telemetry": "0.6.1",
+    "@sap-ux/ui5-application-inquirer": "0.14.0",
     "@sap-ux/ui5-info": "0.11.0"
   },
   "devDependencies": {
@@ -62,9 +62,9 @@
     "mock-spawn": "0.2.6",
     "rimraf": "5.0.5",
     "yeoman-test": "6.3.0",
-    "@sap-ux/flp-config-sub-generator": "0.2.0",
-    "@sap-ux/inquirer-common": "0.7.0",
+    "@sap-ux/inquirer-common": "0.7.1",
     "@sap-ux/jest-file-matchers": "0.2.1",
+    "@sap-ux/flp-config-sub-generator": "0.2.1",
     "@sap-ux/logger": "0.7.0"
   },
   "engines": {