@sap-ux/inquirer-common 0.2.2 → 0.2.4

package/dist/prompts/utility.d.ts

@@ -27,4 +27,13 @@ export declare function searchChoices(searchVal: string, searchList: ListChoiceO
  * @returns Array of ui5 version choices and separators if applicable, grouped by maintenance state
  */
 export declare function ui5VersionsGrouped(versions: UI5Version[], includeSeparators?: boolean, defaultChoice?: UI5VersionChoice): (UI5VersionChoice | Separator)[];
+/**
+ * Get the default UI5 version choice that should be selected based on the provided default choice.
+ * Note that if the default choice is not found in the provided versions, the closest provided version is returned.
+ *
+ * @param ui5Versions - UI5 versions ordered by version descending latest first
+ * @param [defaultChoice] - optional default choice to use if found in the provided versions, otherwise the closest provided version is returned
+ * @returns The default UI5 version choice that is closest to the provided default choice or the latest provided version
+ */
+export declare function getDefaultUI5VersionChoice(ui5Versions: UI5Version[], defaultChoice?: UI5VersionChoice): UI5VersionChoice | undefined;
 //# sourceMappingURL=utility.d.ts.map

package/dist/prompts/utility.js

@@ -23,11 +23,12 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ui5VersionsGrouped = exports.searchChoices = exports.getUI5ThemesChoices = void 0;
+exports.getDefaultUI5VersionChoice = exports.ui5VersionsGrouped = exports.searchChoices = exports.getUI5ThemesChoices = void 0;
 const fuzzy = __importStar(require("fuzzy"));
 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.
  *
@@ -102,4 +103,38 @@ function ui5VersionsGrouped(versions, includeSeparators = false, defaultChoice)
     return versionChoices;
 }
 exports.ui5VersionsGrouped = ui5VersionsGrouped;
+/**
+ * Get the default UI5 version choice that should be selected based on the provided default choice.
+ * Note that if the default choice is not found in the provided versions, the closest provided version is returned.
+ *
+ * @param ui5Versions - UI5 versions ordered by version descending latest first
+ * @param [defaultChoice] - optional default choice to use if found in the provided versions, otherwise the closest provided version is returned
+ * @returns The default UI5 version choice that is closest to the provided default choice or the latest provided version
+ */
+function getDefaultUI5VersionChoice(ui5Versions, defaultChoice) {
+    var _a;
+    if (defaultChoice) {
+        const defaultChoiceVersion = (0, semver_1.coerce)(defaultChoice.value);
+        if (defaultChoiceVersion !== null) {
+            const version = ui5Versions.find((ui5Ver) => (0, semver_1.lte)(ui5Ver.version, defaultChoiceVersion));
+            if (version) {
+                // if the versions are an exact match use the name (UI label) from the default choice as this may use a custom name
+                return {
+                    name: (0, semver_1.eq)(version.version, defaultChoice.value) ? defaultChoice.name : version.version,
+                    value: version.version
+                };
+            }
+        }
+    }
+    // defaultChoice was not coercable, not found or not provided, return the latest version from the ui5 versions provided
+    const defaultVersion = (_a = ui5Versions.find((ui5Ver) => ui5Ver.default && ui5Ver.version)) === null || _a === void 0 ? void 0 : _a.version;
+    if (defaultVersion) {
+        return {
+            name: defaultVersion,
+            value: defaultVersion
+        };
+    }
+    return undefined;
+}
+exports.getDefaultUI5VersionChoice = getDefaultUI5VersionChoice;
 //# sourceMappingURL=utility.js.map

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, 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 } from 'inquirer';
 export interface UI5VersionChoice extends ListChoiceOptions {
     /**
      * UI5 semantic version
@@ -62,4 +62,8 @@ export interface InputQuestion<A extends Answers = Answers> extends BaseInputQue
     name: YUIQuestion['name'];
     guiOptions?: YUIQuestion['guiOptions'];
 }
+export interface CheckBoxQuestion<A extends Answers = Answers> extends BaseCheckBoxQuestion<A> {
+    name: YUIQuestion['name'];
+    guiOptions?: YUIQuestion['guiOptions'];
+}
 //# 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.2",
+  "version": "0.2.4",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -23,11 +23,13 @@
     "i18next": "23.5.1",
     "chalk": "4.1.2",
     "figures": "3.2.0",
+    "semver": "7.5.4",
     "@sap-ux/ui5-info": "0.3.3"
   },
   "devDependencies": {
     "@sap-devx/yeoman-ui-types": "1.14.4",
-    "@types/inquirer": "8.2.6"
+    "@types/inquirer": "8.2.6",
+    "@types/semver": "7.5.4"
   },
   "engines": {
     "node": ">=18.x"