@sap-ux/ui5-application-inquirer 0.3.25 → 0.4.0

package/dist/index.js

@@ -19,6 +19,7 @@ const isNil_1 = __importDefault(require("lodash/isNil"));
 const prompts_1 = require("./prompts");
 const types_1 = require("./types");
 Object.defineProperty(exports, "promptNames", { enumerable: true, get: function () { return types_1.promptNames; } });
+const i18n_1 = require("./i18n");
 /**
  * Get the inquirer prompts for ui5 library inquirer.
  *
@@ -30,6 +31,8 @@ Object.defineProperty(exports, "promptNames", { enumerable: true, get: function
 function getPrompts(promptOptions, capCdsInfo, isYUI = false) {
     var _a, _b;
     return __awaiter(this, void 0, void 0, function* () {
+        // prompt texts must be loaded before the prompts are created, wait for the i18n bundle to be initialized
+        yield (0, i18n_1.initI18nUi5AppInquirer)();
         const filterOptions = {
             useCache: true,
             includeMaintained: true,
@@ -61,36 +64,55 @@ function prompt(adapter, promptOptions, capCdsInfo, isYUI = false) {
         const answers = yield adapter.prompt(ui5AppPrompts);
         // Apply default values to prompts in case they have not been executed
         if (promptOptions) {
-            Object.assign(answers, yield getDefaults(answers, promptOptions));
+            const defaultAnswers = applyPromptOptionDefaults(answers, ui5AppPrompts, promptOptions, capCdsInfo);
+            Object.assign(answers, defaultAnswers);
         }
         return answers;
     });
 }
 exports.prompt = prompt;
 /**
- * Return the default values for prompts that did not provide an answer.
- * This can be derived from user input, or a fallback default in case an answer was not provided due to the prompt not having been executed.
+ * Apply prompt option default values to prompt answers in case they have not been executed by the user selections.
+ * This can occur where some prompts are hidden by advanced option selections.
  *
- * @param answers - the answers from previous prompting, which if present will be used instead of defaults
- * @param promptOptions - the prompt options
- * @returns answer values
+ * @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 getDefaults(answers, promptOptions) {
+function applyPromptOptionDefaults(answers, ui5AppPrompts, promptOptions, capCdsInfo) {
     const defaultAnswers = {};
     Object.entries(promptOptions).forEach(([key, promptOpt]) => {
+        var _a;
         const promptKey = key;
-        // Do we have an answer, if not apply the default, either specified or fallback
-        const defaultProperty = promptOpt.default;
-        if ((0, isNil_1.default)(answers[promptKey]) && (defaultProperty !== null && defaultProperty !== void 0 ? defaultProperty : promptKey === types_1.promptNames.ui5Theme)) {
+        // Do we have an answer, if not apply the default
+        const defaultValueOrFunc = promptOpt.default;
+        // A prompt option for ui5Theme is not supported (as its dependant on the ui5Version) and is special cased
+        // `enableTypeScript` is dependent on the CdsUi5PluginInfo and is special cased
+        if ((0, isNil_1.default)(answers[promptKey]) &&
+            ((defaultValueOrFunc !== null && defaultValueOrFunc !== void 0 ? defaultValueOrFunc : promptKey === types_1.promptNames.ui5Theme) || promptOpt.advancedOption === true)) {
             let defaultValue;
-            if (typeof defaultProperty === 'function') {
-                defaultValue = defaultProperty(answers);
+            if (promptKey === types_1.promptNames.ui5Theme) {
+                defaultValue = (0, ui5_info_1.getDefaultUI5Theme)(answers.ui5Version);
             }
-            else if (defaultProperty) {
-                defaultValue = defaultProperty;
+            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 === null || enableTypeScriptOpts === void 0 ? void 0 : enableTypeScriptOpts.default) === 'function'
+                        ? enableTypeScriptOpts.default(Object.assign(Object.assign({}, answers), { capCdsInfo }))
+                        : defaultValueOrFunc;
             }
-            else if (promptKey === types_1.promptNames.ui5Theme) {
-                defaultValue = (0, ui5_info_1.getDefaultUI5Theme)(answers.ui5Version);
+            else if (defaultValueOrFunc !== undefined) {
+                defaultValue = getDefaultValue(answers, defaultValueOrFunc);
+            }
+            else if (promptOpt.advancedOption) {
+                // Apply the orginal default value if it was not answered
+                const originalDefault = (_a = ui5AppPrompts.find((prompt) => prompt.name === promptKey)) === null || _a === void 0 ? void 0 : _a.default;
+                defaultValue = getDefaultValue(answers, originalDefault);
             }
             Object.assign(defaultAnswers, {
                 [promptKey]: defaultValue
@@ -99,4 +121,21 @@ function getDefaults(answers, promptOptions) {
     });
     return defaultAnswers;
 }
+/**
+ * Get the default value for a prompt based on the provided default value or function.
+ * If a function is provided, it will be called with the current answers to determine the default value.
+ *
+ * @param answers the current answers provided to default functions
+ * @param promptDefault the default value or function to determine the default value
+ * @returns the default value for the prompt or undefined if no default value is provided
+ */
+function getDefaultValue(answers, promptDefault) {
+    if (typeof promptDefault === 'function') {
+        return promptDefault(answers);
+    }
+    if (promptDefault !== undefined) {
+        return promptDefault;
+    }
+    return undefined;
+}
 //# sourceMappingURL=index.js.map

package/dist/types.d.ts

@@ -1,3 +1,4 @@
+import type { CdsUi5PluginInfo } from '@sap-ux/cap-config-writer';
 import type { CommonPromptOptions, PromptDefaultValue, UI5VersionChoice, YUIQuestion } from '@sap-ux/inquirer-common';
 import type { AutocompleteQuestionOptions } from 'inquirer-autocomplete-prompt';
 export interface UI5ApplicationAnswers {
@@ -76,6 +77,19 @@ 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;
+};
 /**
  * These are boolean value prompt option keys
  */
@@ -85,7 +99,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 | promptNames.enableTypeScript;
+type DefaultValueConfirmPrompts = promptNames.enableCodeAssist | promptNames.enableEslint | promptNames.skipAnnotations;
 /**
  * Defines prompt/question default values and/or whether or not they should be shown.
  */
@@ -111,7 +125,7 @@ type booleanValuePromptOtions = Record<booleanValuePrompts, {
      * @returns
      */
     validatorCallback?: (answer: boolean, promptName: string) => void;
-} & UI5ApplicationCommonPromptOptions> & Record<DefaultValueConfirmPrompts, PromptDefaultValue<boolean>>;
+} & UI5ApplicationCommonPromptOptions> & Record<DefaultValueConfirmPrompts, PromptDefaultValue<boolean>> & Record<promptNames.enableTypeScript, EnableTypeScriptPromptOptions>;
 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.3.25",
+  "version": "0.4.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -23,7 +23,7 @@
     "inquirer-autocomplete-prompt": "2.0.1",
     "lodash": "4.17.21",
     "semver": "7.5.4",
-    "@sap-ux/inquirer-common": "0.2.8",
+    "@sap-ux/inquirer-common": "0.3.0",
     "@sap-ux/project-access": "1.22.0",
     "@sap-ux/project-input-validator": "0.2.3",
     "@sap-ux/ui5-info": "0.5.0"
@@ -35,7 +35,7 @@
     "@types/lodash": "4.14.202",
     "@types/semver": "7.5.4",
     "inquirer": "8.2.6",
-    "@sap-ux/cap-config-writer": "0.3.2"
+    "@sap-ux/cap-config-writer": "0.3.4"
   },
   "engines": {
     "node": ">=18.x"