@sap-ux/inquirer-common 0.2.8 → 0.3.1

package/dist/prompts/helpers.d.ts

@@ -5,26 +5,29 @@ import type { CommonPromptOptions, PromptDefaultValue, PromptSeverityMessage, YU
  *
  * @param question - the question to which the validate function will be applied
  * @param addMsgFunc - the additional messages function which will be applied to the question
+ * @param promptState - the runtime state of the prompts, this can be used to provide additional answers not defined by the prompt answers object
  * @returns the extended additional messages function
  */
-export declare function extendAdditionalMessages(question: YUIQuestion, addMsgFunc: PromptSeverityMessage): PromptSeverityMessage;
+export declare function extendAdditionalMessages(question: YUIQuestion, addMsgFunc: PromptSeverityMessage, promptState?: Answers): PromptSeverityMessage;
 /**
  * Extends a validate function. The extended function will be called first.
  *
  * @param question - the question to which the validate function will be applied
  * @param validateFunc - the validate function which will be applied to the question
+ * @param promptState - the runtime state of the prompts, this can be used to provide additional answers not defined by the prompt answers object
  * @returns the extended validate function
  */
-export declare function extendValidate<T extends Answers = Answers>(question: Question, validateFunc: NonNullable<Validator<T>>): NonNullable<Validator<T>>;
+export declare function extendValidate<T extends Answers = Answers>(question: Question, validateFunc: NonNullable<Validator<T>>, promptState?: Answers): NonNullable<Validator<T>>;
 /**
  * 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
+ * @param promptState - the runtime state of the prompts, this can be used to provide additional answers not defined by the prompt answers object
  * @returns the extended question
  */
-export declare function applyExtensionFunction<T extends Answers = Answers>(question: YUIQuestion, promptOption: CommonPromptOptions<T>, funcName: 'validate' | 'additionalMessages'): YUIQuestion;
+export declare function applyExtensionFunction<T extends Answers = Answers>(question: YUIQuestion, promptOption: CommonPromptOptions<T>, funcName: 'validate' | 'additionalMessages', promptState?: Answers): YUIQuestion;
 /**
  * Adds additional conditions to the provided questions.
  *
@@ -38,7 +41,8 @@ export declare function withCondition(questions: Question[], condition: (answers
  *
  * @param questions - array of prompts to be extended
  * @param promptOptions - the prompt options possibly containing function extensions
+ * @param promptState - the runtime state of the prompts, this can be used to provide additional answers not defined by the prompt answers object
  * @returns - the extended questions
  */
-export declare function extendWithOptions<T extends YUIQuestion = YUIQuestion>(questions: T[], promptOptions: Record<string, CommonPromptOptions & PromptDefaultValue<string | boolean>>): YUIQuestion[];
+export declare function extendWithOptions<T extends YUIQuestion = YUIQuestion>(questions: T[], promptOptions: Record<string, CommonPromptOptions & PromptDefaultValue<string | boolean>>, promptState?: Answers): YUIQuestion[];
 //# sourceMappingURL=helpers.d.ts.map

package/dist/prompts/helpers.js

@@ -1,17 +1,25 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.extendWithOptions = exports.withCondition = exports.applyExtensionFunction = exports.extendValidate = exports.extendAdditionalMessages = void 0;
+const cloneDeep_1 = __importDefault(require("lodash/cloneDeep"));
 /**
  * Extends an additionalMessages function.
  *
  * @param question - the question to which the validate function will be applied
  * @param addMsgFunc - the additional messages function which will be applied to the question
+ * @param promptState - the runtime state of the prompts, this can be used to provide additional answers not defined by the prompt answers object
  * @returns the extended additional messages function
  */
-function extendAdditionalMessages(question, addMsgFunc) {
+function extendAdditionalMessages(question, addMsgFunc, promptState) {
     const addMsgs = question.additionalMessages;
     return (value, previousAnswers) => {
-        const extMsg = addMsgFunc(value, previousAnswers);
+        // Allow non-prompt answer (derived answers) values to be passed to the additional messages function
+        // We clone as answers should never be mutatable in prompt functions
+        const combinedAnswers = Object.assign(Object.assign({}, (0, cloneDeep_1.default)(previousAnswers)), (0, cloneDeep_1.default)(promptState));
+        const extMsg = addMsgFunc(value, combinedAnswers);
         if (extMsg) {
             return extMsg; // Extended prompt message is returned first
         }
@@ -25,13 +33,15 @@ exports.extendAdditionalMessages = extendAdditionalMessages;
  *
  * @param question - the question to which the validate function will be applied
  * @param validateFunc - the validate function which will be applied to the question
+ * @param promptState - the runtime state of the prompts, this can be used to provide additional answers not defined by the prompt answers object
  * @returns the extended validate function
  */
-function extendValidate(question, validateFunc) {
+function extendValidate(question, validateFunc, promptState) {
     const validate = question.validate;
     return (value, previousAnswers) => {
-        // Cant use ReturnType<Validator<T>>
-        const extVal = validateFunc === null || validateFunc === void 0 ? void 0 : validateFunc(value, previousAnswers);
+        // Allow non-prompt answer (derived answers) values to be passed to the validate function
+        const combinedAnswers = Object.assign(Object.assign({}, (0, cloneDeep_1.default)(previousAnswers)), (0, cloneDeep_1.default)(promptState));
+        const extVal = validateFunc === null || validateFunc === void 0 ? void 0 : validateFunc(value, combinedAnswers);
         if (extVal !== true) {
             return extVal;
         }
@@ -45,15 +55,16 @@ exports.extendValidate = extendValidate;
  * @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
+ * @param promptState - the runtime state of the prompts, this can be used to provide additional answers not defined by the prompt answers object
  * @returns the extended question
  */
-function applyExtensionFunction(question, promptOption, funcName) {
+function applyExtensionFunction(question, promptOption, funcName, promptState) {
     let extendedFunc;
     if (funcName === 'validate' && promptOption.validate) {
-        extendedFunc = extendValidate(question, promptOption.validate);
+        extendedFunc = extendValidate(question, promptOption.validate, promptState);
     }
     if (funcName === 'additionalMessages' && promptOption.additionalMessages) {
-        extendedFunc = extendAdditionalMessages(question, promptOption.additionalMessages);
+        extendedFunc = extendAdditionalMessages(question, promptOption.additionalMessages, promptState);
     }
     question = Object.assign(question, { [funcName]: extendedFunc });
     return question;
@@ -99,9 +110,10 @@ exports.withCondition = withCondition;
  *
  * @param questions - array of prompts to be extended
  * @param promptOptions - the prompt options possibly containing function extensions
+ * @param promptState - the runtime state of the prompts, this can be used to provide additional answers not defined by the prompt answers object
  * @returns - the extended questions
  */
-function extendWithOptions(questions, promptOptions) {
+function extendWithOptions(questions, promptOptions, promptState) {
     questions.forEach((question) => {
         const promptOptKey = question.name;
         const promptOpt = promptOptions[question.name];
@@ -109,7 +121,7 @@ function extendWithOptions(questions, promptOptions) {
             const propsToExtend = Object.keys(promptOpt);
             for (const extProp of propsToExtend) {
                 if (extProp === 'validate' || extProp === 'additionalMessages') {
-                    question = applyExtensionFunction(question, promptOpt, extProp);
+                    question = applyExtensionFunction(question, promptOpt, extProp, promptState);
                 }
                 // Provided defaults will override built in defaults
                 const defaultOverride = promptOptions[promptOptKey].default;

package/dist/types.d.ts

@@ -1,5 +1,5 @@
 import { type IMessageSeverity } from '@sap-devx/yeoman-ui-types';
-import type { Answers, ConfirmQuestion as BaseConfirmQuestion, InputQuestion as BaseInputQuestion, ListQuestion as BaseListQuestion, CheckboxQuestion as BaseCheckBoxQuestion, ListChoiceOptions, PromptFunction, PromptModule, Question, Validator, AsyncDynamicQuestionProperty } from 'inquirer';
+import type { Answers, ConfirmQuestion as BaseConfirmQuestion, InputQuestion as BaseInputQuestion, ListQuestion as BaseListQuestion, CheckboxQuestion as BaseCheckBoxQuestion, NumberQuestion as BaseNumberQuestion, ListChoiceOptions, PromptFunction, PromptModule, Question, Validator, AsyncDynamicQuestionProperty } from 'inquirer';
 export interface UI5VersionChoice extends ListChoiceOptions {
     /**
      * UI5 semantic version
@@ -66,6 +66,10 @@ export interface CheckBoxQuestion<A extends Answers = Answers> extends BaseCheck
     guiOptions?: YUIQuestion['guiOptions'];
     additionalMessages?: YUIQuestion['additionalMessages'];
 }
+export interface NumberQuestion<A extends Answers = Answers> extends BaseNumberQuestion<A> {
+    name: YUIQuestion['name'];
+    guiOptions?: YUIQuestion['guiOptions'];
+}
 /**
  * Defines prompt/question default values and/or whether or not they should be shown.
  */

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/inquirer-common",
   "description": "Commonly used shared functionality and types to support inquirer modules.",
-  "version": "0.2.8",
+  "version": "0.3.1",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -24,12 +24,14 @@
     "chalk": "4.1.2",
     "figures": "3.2.0",
     "semver": "7.5.4",
+    "lodash": "4.17.21",
     "@sap-ux/ui5-info": "0.5.0"
   },
   "devDependencies": {
     "@sap-devx/yeoman-ui-types": "1.14.4",
     "@types/inquirer": "8.2.6",
-    "@types/semver": "7.5.4"
+    "@types/semver": "7.5.4",
+    "@types/lodash": "4.14.202"
   },
   "engines": {
     "node": ">=18.x"