@sap-ux/ui5-application-inquirer 0.3.14 → 0.3.15

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { type CdsUi5PluginInfo } from '@sap-ux/cap-config-writer';
-import type { InquirerAdapter } from '@sap-ux/inquirer-common';
-import type { PromptDefaultValue, UI5ApplicationAnswers, UI5ApplicationPromptOptions, UI5ApplicationQuestion } from './types';
+import type { InquirerAdapter, PromptDefaultValue } from '@sap-ux/inquirer-common';
+import type { UI5ApplicationAnswers, UI5ApplicationPromptOptions, UI5ApplicationQuestion } from './types';
 import { promptNames } from './types';
 /**
  * Get the inquirer prompts for ui5 library inquirer.

package/dist/prompts/prompt-helpers.d.ts

@@ -1,4 +1,3 @@
-import type { Answers, Question } from 'inquirer';
 import { promptNames, type UI5ApplicationPromptOptions, type UI5ApplicationQuestion } from '../types';
 /**
  * Tests if a directory with the specified `appName` exists at the path specified by `targetPath`.
@@ -24,22 +23,6 @@ export declare function defaultAppName(targetPath: string): string;
  * @returns - true if the specified version is greater than or equal to the minimum version, or the version is not a coercible semver
  */
 export declare function isVersionIncluded(version: string, minVersion: string): boolean;
-/**
- * Adds additional conditions to the provided questions.
- *
- * @param questions the questions to which the condition will be added
- * @param condition function which returns true or false
- * @returns the passed questions reference
- */
-export declare function withCondition(questions: Question[], condition: (answers: Answers) => boolean): Question[];
-/**
- * Updates questions with extensions for specific properties. Only `validate`, `default` and `additionalMessages` are currently supported.
- *
- * @param questions - array of prompts to be extended
- * @param promptOptions - the prompt options possibly containing function extensions
- * @returns - the extended questions
- */
-export declare function extendWithOptions(questions: UI5ApplicationQuestion[], promptOptions: UI5ApplicationPromptOptions): UI5ApplicationQuestion[];
 /**
  * Will remove prompts from the specified prompts based on prompt options
  * and applicability in the case of CAP projects. Removing prompts is preferable to using `when()`

package/dist/prompts/prompt-helpers.js

@@ -1,13 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.hidePrompts = exports.extendWithOptions = exports.withCondition = exports.isVersionIncluded = exports.defaultAppName = exports.appPathExists = void 0;
-const inquirer_common_1 = require("@sap-ux/inquirer-common");
+exports.hidePrompts = exports.isVersionIncluded = exports.defaultAppName = exports.appPathExists = void 0;
+const ui5_info_1 = require("@sap-ux/ui5-info");
 const fs_1 = require("fs");
 const path_1 = require("path");
 const semver_1 = require("semver");
 const i18n_1 = require("../i18n");
 const types_1 = require("../types");
-const ui5_info_1 = require("@sap-ux/ui5-info");
 /**
  * Tests if a directory with the specified `appName` exists at the path specified by `targetPath`.
  *
@@ -55,105 +54,6 @@ function isVersionIncluded(version, minVersion) {
     return version === ui5_info_1.latestVersionString;
 }
 exports.isVersionIncluded = isVersionIncluded;
-/**
- * Adds additional conditions to the provided questions.
- *
- * @param questions the questions to which the condition will be added
- * @param condition function which returns true or false
- * @returns the passed questions reference
- */
-function withCondition(questions, condition) {
-    questions.forEach((question) => {
-        if (question.when !== undefined) {
-            if (typeof question.when === 'function') {
-                const when = question.when;
-                question.when = (answers) => {
-                    if (condition(answers)) {
-                        return when(answers);
-                    }
-                    else {
-                        return false;
-                    }
-                };
-            }
-            else {
-                const whenValue = question.when;
-                question.when = (answers) => {
-                    return condition(answers) && whenValue;
-                };
-            }
-        }
-        else {
-            question.when = condition;
-        }
-    });
-    return questions;
-}
-exports.withCondition = withCondition;
-/**
- * Extends a validate function.
- *
- * @param question - the question to which the validate function will be applied
- * @param validateFunc - the validate function which will be applied to the question
- * @returns the extended validate function
- */
-function extendValidate(question, validateFunc) {
-    const validate = question.validate;
-    return (value, previousAnswers) => {
-        const extVal = validateFunc(value, previousAnswers);
-        if (extVal !== true) {
-            return extVal;
-        }
-        return typeof validate === 'function' ? validate(value, previousAnswers) : true;
-    };
-}
-/**
- * Extend the existing prompt property function with the one specified in prompt options or add as new.
- *
- * @param question - the question to which the extending function will be applied
- * @param promptOption - prompt options, containing extending functions
- * @param funcName - the question property (function) name to extend
- * @returns the extended question
- */
-function applyExtensionFunction(question, promptOption, funcName) {
-    let extendedFunc;
-    if (funcName === 'validate' && promptOption.validate) {
-        extendedFunc = extendValidate(question, promptOption.validate);
-    }
-    if (funcName === 'additionalMessages' && promptOption.additionalMessages) {
-        extendedFunc = (0, inquirer_common_1.extendAdditionalMessages)(question, promptOption.additionalMessages);
-    }
-    question = Object.assign(question, { [funcName]: extendedFunc });
-    return question;
-}
-/**
- * Updates questions with extensions for specific properties. Only `validate`, `default` and `additionalMessages` are currently supported.
- *
- * @param questions - array of prompts to be extended
- * @param promptOptions - the prompt options possibly containing function extensions
- * @returns - the extended questions
- */
-function extendWithOptions(questions, promptOptions) {
-    questions.forEach((question) => {
-        const promptOptKey = question.name;
-        const promptOpt = promptOptions[promptOptKey];
-        if (promptOpt) {
-            const propsToExtend = Object.keys(promptOpt);
-            for (const extProp of propsToExtend) {
-                if (extProp === 'validate' || extProp === 'additionalMessages') {
-                    question = applyExtensionFunction(question, promptOpt, extProp);
-                }
-                // Provided defaults will override built in defaults
-                const defaultOverride = promptOptions[promptOptKey].default;
-                if (defaultOverride) {
-                    question.default = defaultOverride;
-                }
-            }
-        }
-    });
-    return questions;
-}
-exports.extendWithOptions = extendWithOptions;
 /**
  * Will remove prompts from the specified prompts based on prompt options
  * and applicability in the case of CAP projects. Removing prompts is preferable to using `when()`

package/dist/prompts/prompts.js

@@ -60,7 +60,7 @@ function getQuestions(ui5Versions, promptOptions, capCdsInfo, isYUI = false) {
     applyAdvancedOption(questions, promptOptions);
     // Apply extended `validate`, `additionalMessages` or override `default` prompt properties
     if (promptOptions) {
-        questions = (0, prompt_helpers_1.extendWithOptions)(questions, promptOptions);
+        questions = (0, inquirer_common_1.extendWithOptions)(questions, promptOptions);
     }
     return questions;
 }
@@ -413,6 +413,6 @@ function getNamePrompt(targetDir, isCapProject, appName, isYUI) {
  * @param promptOptions the prompt options which specify which prompts should be grouped as advanced options
  */
 function applyAdvancedOption(questions, promptOptions) {
-    (0, prompt_helpers_1.withCondition)(questions.filter(({ name }) => { var _a; return (_a = promptOptions === null || promptOptions === void 0 ? void 0 : promptOptions[name]) === null || _a === void 0 ? void 0 : _a.advancedOption; }), (answers) => { var _a; return (_a = answers.showAdvanced) !== null && _a !== void 0 ? _a : false; });
+    (0, inquirer_common_1.withCondition)(questions.filter(({ name }) => { var _a; return (_a = promptOptions === null || promptOptions === void 0 ? void 0 : promptOptions[name]) === null || _a === void 0 ? void 0 : _a.advancedOption; }), (answers) => { var _a; return (_a = answers.showAdvanced) !== null && _a !== void 0 ? _a : false; });
 }
 //# sourceMappingURL=prompts.js.map

package/dist/types.d.ts

@@ -1,5 +1,4 @@
-import type { PromptSeverityMessage, UI5VersionChoice, YUIQuestion, validate } from '@sap-ux/inquirer-common';
-import type { AsyncDynamicQuestionProperty } from 'inquirer';
+import type { CommonPromptOptions, PromptDefaultValue, UI5VersionChoice, YUIQuestion } from '@sap-ux/inquirer-common';
 import type { AutocompleteQuestionOptions } from 'inquirer-autocomplete-prompt';
 export interface UI5ApplicationAnswers {
     name?: string;
@@ -87,23 +86,17 @@ 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;
-export type PromptDefaultValue<T> = {
-    default?: AsyncDynamicQuestionProperty<T>;
-};
 /**
  * Defines prompt/question default values and/or whether or not they should be shown.
  */
-export type CommonPromptOptions = {
-    hide?: boolean;
+export type UI5ApplicationCommonPromptOptions = {
     advancedOption?: boolean;
-    validate?: validate<UI5ApplicationAnswers>;
-    additionalMessages?: PromptSeverityMessage;
-};
+} & CommonPromptOptions;
 /**
  * Provide the correct type checking for string value prompts and `ui5Version` options
  *
  */
-type stringValuePromptOptions = Record<stringValuePrompts, CommonPromptOptions> & Record<DefaultValueInputPrompts, PromptDefaultValue<string>> & Record<promptNames.ui5Version, UI5VersionPromptOptions>;
+type stringValuePromptOptions = Record<stringValuePrompts, UI5ApplicationCommonPromptOptions> & Record<DefaultValueInputPrompts, PromptDefaultValue<string>> & Record<promptNames.ui5Version, UI5VersionPromptOptions>;
 /**
  * Provide the correct type checking for boolean value prompts and validator callback options
  *
@@ -118,7 +111,7 @@ type booleanValuePromptOtions = Record<booleanValuePrompts, {
      * @returns
      */
     validatorCallback?: (answer: boolean, promptName: string) => void;
-} & CommonPromptOptions> & Record<DefaultValueConfirmPrompts, PromptDefaultValue<boolean>>;
+} & UI5ApplicationCommonPromptOptions> & Record<DefaultValueConfirmPrompts, PromptDefaultValue<boolean>>;
 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.14",
+  "version": "0.3.15",
   "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.6",
+    "@sap-ux/inquirer-common": "0.2.7",
     "@sap-ux/project-access": "1.19.14",
     "@sap-ux/project-input-validator": "0.2.3",
     "@sap-ux/ui5-info": "0.4.0"