@sap-ux/ui5-application-inquirer 0.13.0 → 0.14.0

package/dist/index.js

@@ -51,7 +51,7 @@ async function prompt(adapter, promptOptions, capCdsInfo, isYUI = false) {
     const answers = await adapter.prompt(ui5AppPrompts);
     // Apply default values to prompts in case they have not been executed
     if (promptOptions) {
-        const defaultAnswers = applyPromptOptionDefaults(answers, ui5AppPrompts, promptOptions, capCdsInfo);
+        const defaultAnswers = applyPromptOptionDefaults(answers, ui5AppPrompts, promptOptions);
         Object.assign(answers, defaultAnswers);
     }
     return answers;
@@ -63,10 +63,9 @@ async function prompt(adapter, promptOptions, capCdsInfo, isYUI = false) {
  * @param answers the answers from previous prompting, only answers without a value will be considered for defaulting
  * @param ui5AppPrompts the prompts that were used to prompt the user, will be used to apply default values if not answered or no default provided
  * @param promptOptions the prompt options which may provide default values or functions
- * @param capCdsInfo will be passed as additional answer to default functions that depend on it to determine the default value
  * @returns the default values for the unanswered prompts, based on the prompt options
  */
-function applyPromptOptionDefaults(answers, ui5AppPrompts, promptOptions, capCdsInfo) {
+function applyPromptOptionDefaults(answers, ui5AppPrompts, promptOptions) {
     const defaultAnswers = {};
     Object.entries(promptOptions).forEach(([key, promptOpt]) => {
         const promptKey = key;
@@ -80,16 +79,6 @@ function applyPromptOptionDefaults(answers, ui5AppPrompts, promptOptions, capCds
             if (promptKey === types_1.promptNames.ui5Theme) {
                 defaultValue = (0, ui5_info_1.getDefaultUI5Theme)(answers.ui5Version);
             }
-            else if (promptKey === types_1.promptNames.enableTypeScript) {
-                // TypeScript default value is dependent on the CdsUi5PluginInfo
-                const enableTypeScriptOpts = promptOpt;
-                // If an enableTypeScript default function is provided, use it to determine the default value
-                // otherwise override with the provided default value
-                defaultValue =
-                    typeof enableTypeScriptOpts?.default === 'function'
-                        ? enableTypeScriptOpts.default({ ...answers, capCdsInfo })
-                        : defaultValueOrFunc;
-            }
             else if (defaultValueOrFunc !== undefined) {
                 defaultValue = getDefaultValue(answers, defaultValueOrFunc);
             }

package/dist/prompts/prompt-helpers.js

@@ -64,12 +64,19 @@ function isVersionIncluded(version, minVersion) {
  * @param isCapProject if we are generating into a CAP project certain prompts may be removed
  * @returns the updated questions
  */
-function hidePrompts(prompts, promptOptions, isCapProject) {
+function hidePrompts(prompts, promptOptions, isCapProject = false) {
     const questions = [];
     if (promptOptions ?? isCapProject) {
         Object.keys(prompts).forEach((key) => {
             const promptKey = key;
-            if (!promptOptions?.[promptKey]?.hide &&
+            // Narrow the type as we are only dealing with `hide` options
+            const promptOpt = promptOptions?.[promptKey];
+            let hidePrompt = false;
+            if (typeof promptOpt?.hide === 'function') {
+                hidePrompt = promptOpt.hide(isCapProject);
+            }
+            if (!hidePrompt &&
+                !promptOpt?.hide &&
                 // Target directory is determined by the CAP project. `enableEsLint` and `targetFolder` are not available for CAP projects
                 !([types_1.promptNames.targetFolder, types_1.promptNames.enableEslint].includes(types_1.promptNames[promptKey]) && isCapProject)) {
                 questions.push(prompts[promptKey]);

package/dist/types.d.ts

@@ -1,4 +1,3 @@
-import type { CdsUi5PluginInfo } from '@sap-ux/project-access';
 import type { CommonPromptOptions, PromptDefaultValue, UI5VersionChoice, YUIQuestion } from '@sap-ux/inquirer-common';
 import type { AutocompleteQuestionOptions } from 'inquirer-autocomplete-prompt';
 export interface UI5ApplicationAnswers {
@@ -80,19 +79,6 @@ type UI5VersionPromptOptions = {
      */
     defaultChoice?: UI5VersionChoice;
 };
-/**
- * Options for the enable TypeScript prompt. This allows for a default value to be determined based on the answers provided
- * and additonal runtime cds information if available. This effectively constains the prompt options for the enable TypeScript prompt
- * to be a function that returns a boolean value since enable TypeScript prompt default is conditional.
- */
-type EnableTypeScriptPromptOptions = Omit<PromptDefaultValue<boolean>, 'default'> & {
-    /**
-     * Callback function to determine the default value for TypeScript
-     */
-    default?: (answers: UI5ApplicationAnswers & {
-        capCdsInfo?: CdsUi5PluginInfo;
-    }) => boolean;
-};
 type TargetFolderPromptOptions = {
     /**
      * The default target folder path to be used in combination with the prompt default function and the name prompt validation.
@@ -122,6 +108,9 @@ type NamePromptOptions = {
      */
     defaultValue?: string;
 };
+export type AddDeployPromptOptions = Omit<UI5ApplicationCommonPromptOptions, 'hide'> & {
+    hide?: boolean | ((isCap: boolean) => boolean);
+};
 /**
  * These are boolean value prompt option keys
  */
@@ -131,7 +120,7 @@ type stringValuePrompts = stringValuePromptType[keyof stringValuePromptType];
 type booleanValuePromptType = Pick<typeof promptNames, booleanPromptKeys>;
 type booleanValuePrompts = booleanValuePromptType[keyof booleanValuePromptType];
 type DefaultValueInputPrompts = promptNames.name | promptNames.description | promptNames.namespace | promptNames.ui5Version | promptNames.targetFolder;
-type DefaultValueConfirmPrompts = promptNames.enableCodeAssist | promptNames.enableEslint | promptNames.skipAnnotations;
+type DefaultValueConfirmPrompts = promptNames.enableTypeScript | promptNames.enableCodeAssist | promptNames.enableEslint | promptNames.skipAnnotations | promptNames.addDeployConfig;
 /**
  * Defines prompt/question default values and/or whether or not they should be shown.
  */
@@ -147,17 +136,9 @@ type stringValuePromptOptions = Record<stringValuePrompts, UI5ApplicationCommonP
  * Provide the correct type checking for boolean value prompts and validator callback options
  *
  */
-type booleanValuePromptOtions = Record<booleanValuePrompts, {
-    /**
-     * Callback function can be provided which will be executed on input validation.
-     * This may be used, for example, to trigger conditional steps in Yeoman UI.
-     *
-     * @param answer
-     * @param promptName
-     * @returns
-     */
+type booleanValuePromptOtions = Record<Exclude<booleanValuePrompts, typeof promptNames.addDeployConfig>, UI5ApplicationCommonPromptOptions> & Record<booleanValuePrompts, {
     validatorCallback?: (answer: boolean, promptName: string) => void;
-} & UI5ApplicationCommonPromptOptions> & Record<DefaultValueConfirmPrompts, PromptDefaultValue<boolean>> & Record<promptNames.enableTypeScript, EnableTypeScriptPromptOptions>;
+}> & Record<DefaultValueConfirmPrompts, PromptDefaultValue<boolean>> & Record<promptNames.addDeployConfig, AddDeployPromptOptions>;
 export type UI5ApplicationQuestion = YUIQuestion<UI5ApplicationAnswers> & Partial<Pick<AutocompleteQuestionOptions, 'source'>>;
 export type UI5ApplicationPromptOptions = Partial<stringValuePromptOptions & booleanValuePromptOtions>;
 export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/ui5-application-inquirer",
   "description": "Prompts module that can prompt users for inputs required for UI5 application writing",
-  "version": "0.13.0",
+  "version": "0.14.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -23,9 +23,9 @@
     "inquirer-autocomplete-prompt": "2.0.1",
     "lodash": "4.17.21",
     "semver": "7.5.4",
-    "@sap-ux/inquirer-common": "0.7.0",
-    "@sap-ux/project-access": "1.30.0",
-    "@sap-ux/project-input-validator": "0.6.0",
+    "@sap-ux/inquirer-common": "0.7.1",
+    "@sap-ux/project-access": "1.30.1",
+    "@sap-ux/project-input-validator": "0.6.1",
     "@sap-ux/ui5-info": "0.11.0"
   },
   "devDependencies": {
@@ -35,7 +35,7 @@
     "@types/lodash": "4.14.202",
     "@types/semver": "7.5.4",
     "inquirer": "8.2.6",
-    "@sap-ux/cap-config-writer": "0.10.0"
+    "@sap-ux/cap-config-writer": "0.10.1"
   },
   "engines": {
     "node": ">=20.x"