@sap-ux/inquirer-common 0.4.6 → 0.4.7

package/dist/i18n.js

@@ -3,7 +3,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.t = exports.initI18nInquirerCommon = void 0;
+exports.initI18nInquirerCommon = initI18nInquirerCommon;
+exports.t = t;
 const i18next_1 = __importDefault(require("i18next"));
 const inquirer_common_i18n_json_1 = __importDefault(require("./translations/inquirer-common.i18n.json"));
 const inquirerCommonI18nNamespace = 'inquirer-common';
@@ -13,7 +14,6 @@ const inquirerCommonI18nNamespace = 'inquirer-common';
 async function initI18nInquirerCommon() {
     await i18next_1.default.init({ lng: 'en', fallbackLng: 'en' }, () => i18next_1.default.addResourceBundle('en', inquirerCommonI18nNamespace, inquirer_common_i18n_json_1.default));
 }
-exports.initI18nInquirerCommon = initI18nInquirerCommon;
 /**
  * Helper function facading the call to i18next. Unless a namespace option is provided the local namespace will be used.
  *
@@ -27,7 +27,6 @@ function t(key, options) {
     }
     return i18next_1.default.t(key, options);
 }
-exports.t = t;
 initI18nInquirerCommon().catch(() => {
     // Needed for lint
 });

package/dist/prompts/helpers.js

@@ -3,7 +3,11 @@ 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;
+exports.extendAdditionalMessages = extendAdditionalMessages;
+exports.extendValidate = extendValidate;
+exports.applyExtensionFunction = applyExtensionFunction;
+exports.withCondition = withCondition;
+exports.extendWithOptions = extendWithOptions;
 const cloneDeep_1 = __importDefault(require("lodash/cloneDeep"));
 /**
  * Extends an additionalMessages function.
@@ -27,7 +31,6 @@ function extendAdditionalMessages(question, addMsgFunc, promptState) {
         return typeof addMsgs === 'function' ? addMsgs(value, previousAnswers) : undefined;
     };
 }
-exports.extendAdditionalMessages = extendAdditionalMessages;
 /**
  * Extends a validate function. The extended function will be called first.
  *
@@ -48,7 +51,6 @@ function extendValidate(question, validateFunc, promptState) {
         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.
  *
@@ -69,7 +71,6 @@ function applyExtensionFunction(question, promptOption, funcName, promptState) {
     question = Object.assign(question, { [funcName]: extendedFunc });
     return question;
 }
-exports.applyExtensionFunction = applyExtensionFunction;
 /**
  * Adds additional conditions to the provided questions.
  *
@@ -104,7 +105,6 @@ function withCondition(questions, condition) {
     });
     return questions;
 }
-exports.withCondition = withCondition;
 /**
  * Updates questions with extensions for specific properties. Only `validate`, `default` and `additionalMessages` are currently supported.
  *
@@ -133,5 +133,4 @@ function extendWithOptions(questions, promptOptions, promptState) {
     });
     return questions;
 }
-exports.extendWithOptions = extendWithOptions;
 //# sourceMappingURL=helpers.js.map

package/dist/prompts/utility.d.ts

@@ -23,17 +23,18 @@ export declare function searchChoices(searchVal: string, searchList: ListChoiceO
  *
  * @param versions ui5Versions
  * @param includeSeparators Include a separator to visually identify groupings, if false then grouping info is included in each entry as additional name text
- * @param defaultChoice optional, provides an additional version choice entry that is added as the first entry in the version choices and sets as the default
+ * @param defaultChoice optional, provides an additional version choice entry that is added as the first entry in the version choices (if it does not already exist in the version list) and sets as the default
  * @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.
+ * Note, if the provided version is a snapshot version, the closest provided version is returned.
+ * Otherwise if the default choice is not found in the provided versions, it will still be 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
+ * @param defaultChoice - optional default choice to be used
+ * @returns The default UI5 version 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,7 +23,10 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDefaultUI5VersionChoice = exports.ui5VersionsGrouped = exports.searchChoices = exports.getUI5ThemesChoices = void 0;
+exports.getUI5ThemesChoices = getUI5ThemesChoices;
+exports.searchChoices = searchChoices;
+exports.ui5VersionsGrouped = ui5VersionsGrouped;
+exports.getDefaultUI5VersionChoice = getDefaultUI5VersionChoice;
 const ui5_info_1 = require("@sap-ux/ui5-info");
 const fuzzy = __importStar(require("fuzzy"));
 const semver_1 = require("semver");
@@ -42,7 +45,6 @@ function getUI5ThemesChoices(ui5Version) {
         value: theme.id
     }));
 }
-exports.getUI5ThemesChoices = getUI5ThemesChoices;
 /**
  * Finds the search value in the provided list using `fuzzy` search.
  *
@@ -60,14 +62,13 @@ function searchChoices(searchVal, searchList) {
             .map((el) => el.original)
         : searchList;
 }
-exports.searchChoices = searchChoices;
 /**
  * Creates a list of UI5 Versions prompt choices, adding additional maintenance info for use in prompts
  * and grouping according to maintenance status.
  *
  * @param versions ui5Versions
  * @param includeSeparators Include a separator to visually identify groupings, if false then grouping info is included in each entry as additional name text
- * @param defaultChoice optional, provides an additional version choice entry that is added as the first entry in the version choices and sets as the default
+ * @param defaultChoice optional, provides an additional version choice entry that is added as the first entry in the version choices (if it does not already exist in the version list) and sets as the default
  * @returns Array of ui5 version choices and separators if applicable, grouped by maintenance state
  */
 function ui5VersionsGrouped(versions, includeSeparators = false, defaultChoice) {
@@ -98,24 +99,52 @@ function ui5VersionsGrouped(versions, includeSeparators = false, defaultChoice)
     }
     const versionChoices = [...maintChoices, ...notMaintChoices];
     if (defaultChoice) {
-        versionChoices.unshift(defaultChoice);
+        const index = versionChoices.findIndex((choice) => choice.value === defaultChoice.value);
+        if (index === -1) {
+            // adds default choice to the top of the list
+            versionChoices.unshift(defaultChoice);
+        }
     }
     return versionChoices;
 }
-exports.ui5VersionsGrouped = ui5VersionsGrouped;
+/**
+ * Will either return the UI5 version that is the closest to the default choice version or simply the version that is passed to it.
+ *
+ * @param ui5Versions - UI5 versions ordered by version descending latest first
+ * @param useClosestVersion - whether to use the closest available version to the default choice
+ * @param defaultChoiceVersion - default version chosen
+ * @returns - ui5 version to be used as default
+ */
+function findDefaultUI5Version(ui5Versions, useClosestVersion, defaultChoiceVersion) {
+    let version;
+    if (useClosestVersion) {
+        version = ui5Versions.find((ui5Ver) => (0, semver_1.lte)(ui5Ver.version, defaultChoiceVersion));
+    }
+    else {
+        version = {
+            version: defaultChoiceVersion.version
+        };
+    }
+    return version;
+}
 /**
  * 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.
+ * Note, if the provided version is a snapshot version, the closest provided version is returned.
+ * Otherwise if the default choice is not found in the provided versions, it will still be 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
+ * @param defaultChoice - optional default choice to be used
+ * @returns The default UI5 version choice or the latest provided version
  */
 function getDefaultUI5VersionChoice(ui5Versions, defaultChoice) {
+    let useClosestVersion = false;
     if (defaultChoice) {
+        if (defaultChoice.value.toLowerCase().endsWith('snapshot')) {
+            useClosestVersion = true;
+        }
         const defaultChoiceVersion = (0, semver_1.coerce)(defaultChoice.value);
         if (defaultChoiceVersion !== null) {
-            const version = ui5Versions.find((ui5Ver) => (0, semver_1.lte)(ui5Ver.version, defaultChoiceVersion));
+            const version = findDefaultUI5Version(ui5Versions, useClosestVersion, 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 {
@@ -135,5 +164,4 @@ function getDefaultUI5VersionChoice(ui5Versions, defaultChoice) {
     }
     return undefined;
 }
-exports.getDefaultUI5VersionChoice = getDefaultUI5VersionChoice;
 //# sourceMappingURL=utility.js.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.4.6",
+  "version": "0.4.7",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",