@sap-ux/inquirer-common 0.2.6 → 0.2.8

package/dist/prompts/helpers.d.ts

@@ -1,4 +1,5 @@
-import type { PromptSeverityMessage, YUIQuestion } from '../types';
+import type { Answers, Question, Validator } from 'inquirer';
+import type { CommonPromptOptions, PromptDefaultValue, PromptSeverityMessage, YUIQuestion } from '../types';
 /**
  * Extends an additionalMessages function.
  *
@@ -7,4 +8,37 @@ import type { PromptSeverityMessage, YUIQuestion } from '../types';
  * @returns the extended additional messages function
  */
 export declare function extendAdditionalMessages(question: YUIQuestion, addMsgFunc: PromptSeverityMessage): 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
+ * @returns the extended validate function
+ */
+export declare function extendValidate<T extends Answers = Answers>(question: Question, validateFunc: NonNullable<Validator<T>>): 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
+ * @returns the extended question
+ */
+export declare function applyExtensionFunction<T extends Answers = Answers>(question: YUIQuestion, promptOption: CommonPromptOptions<T>, funcName: 'validate' | 'additionalMessages'): YUIQuestion;
+/**
+ * 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<T extends YUIQuestion = YUIQuestion>(questions: T[], promptOptions: Record<string, CommonPromptOptions & PromptDefaultValue<string | boolean>>): YUIQuestion[];
 //# sourceMappingURL=helpers.d.ts.map

package/dist/prompts/helpers.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.extendAdditionalMessages = void 0;
+exports.extendWithOptions = exports.withCondition = exports.applyExtensionFunction = exports.extendValidate = exports.extendAdditionalMessages = void 0;
 /**
  * Extends an additionalMessages function.
  *
@@ -20,4 +20,106 @@ function extendAdditionalMessages(question, addMsgFunc) {
     };
 }
 exports.extendAdditionalMessages = extendAdditionalMessages;
+/**
+ * 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
+ * @returns the extended validate function
+ */
+function extendValidate(question, validateFunc) {
+    const validate = question.validate;
+    return (value, previousAnswers) => {
+        // Cant use ReturnType<Validator<T>>
+        const extVal = validateFunc === null || validateFunc === void 0 ? void 0 : validateFunc(value, previousAnswers);
+        if (extVal !== true) {
+            return extVal;
+        }
+        return typeof validate === 'function' ? validate(value, previousAnswers) : true;
+    };
+}
+exports.extendValidate = extendValidate;
+/**
+ * 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 = extendAdditionalMessages(question, promptOption.additionalMessages);
+    }
+    question = Object.assign(question, { [funcName]: extendedFunc });
+    return question;
+}
+exports.applyExtensionFunction = applyExtensionFunction;
+/**
+ * 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;
+/**
+ * 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[question.name];
+        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;
 //# sourceMappingURL=helpers.js.map

package/dist/prompts/utility.d.ts

@@ -1,5 +1,5 @@
-import type { ListChoiceOptions } from 'inquirer';
 import { type UI5Version } from '@sap-ux/ui5-info';
+import type { ListChoiceOptions } from 'inquirer';
 import type { UI5VersionChoice } from '../types';
 import { Separator } from './separator';
 /**

package/dist/prompts/utility.js

@@ -24,11 +24,11 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getDefaultUI5VersionChoice = exports.ui5VersionsGrouped = exports.searchChoices = exports.getUI5ThemesChoices = void 0;
+const ui5_info_1 = require("@sap-ux/ui5-info");
 const fuzzy = __importStar(require("fuzzy"));
+const semver_1 = require("semver");
 const i18n_1 = require("../i18n");
-const ui5_info_1 = require("@sap-ux/ui5-info");
 const separator_1 = require("./separator");
-const semver_1 = require("semver");
 /**
  * Get the UI5 themes as prompt choices applicable for the specified UI5 version.
  *

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 } from 'inquirer';
+import type { Answers, ConfirmQuestion as BaseConfirmQuestion, InputQuestion as BaseInputQuestion, ListQuestion as BaseListQuestion, CheckboxQuestion as BaseCheckBoxQuestion, ListChoiceOptions, PromptFunction, PromptModule, Question, Validator, AsyncDynamicQuestionProperty } from 'inquirer';
 export interface UI5VersionChoice extends ListChoiceOptions {
     /**
      * UI5 semantic version
@@ -39,7 +39,6 @@ export interface GuiOptions {
     breadcrumb?: boolean | string;
 }
 export type PromptSeverityMessage = (input?: unknown, previousAnswers?: Answers) => IMessageSeverity | undefined;
-export type validate<T> = (input: any, answers?: T) => boolean | string | Promise<boolean | string>;
 export type YUIQuestion<A extends Answers = Answers> = Question<A> & {
     name: string;
     guiOptions?: GuiOptions;
@@ -67,4 +66,15 @@ export interface CheckBoxQuestion<A extends Answers = Answers> extends BaseCheck
     guiOptions?: YUIQuestion['guiOptions'];
     additionalMessages?: YUIQuestion['additionalMessages'];
 }
+/**
+ * Defines prompt/question default values and/or whether or not they should be shown.
+ */
+export type CommonPromptOptions<T extends Answers = Answers> = {
+    hide?: boolean;
+    validate?: Validator<T>;
+    additionalMessages?: PromptSeverityMessage;
+};
+export type PromptDefaultValue<T> = {
+    default?: AsyncDynamicQuestionProperty<T>;
+};
 //# sourceMappingURL=types.d.ts.map

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.6",
+  "version": "0.2.8",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -24,7 +24,7 @@
     "chalk": "4.1.2",
     "figures": "3.2.0",
     "semver": "7.5.4",
-    "@sap-ux/ui5-info": "0.4.0"
+    "@sap-ux/ui5-info": "0.5.0"
   },
   "devDependencies": {
     "@sap-devx/yeoman-ui-types": "1.14.4",