@sap-ux/create 0.5.103 → 0.5.104

package/dist/common/index.d.ts

@@ -1,3 +1,4 @@
+export { promptYUIQuestions } from './prompts';
 /**
  * Run npm install command.
  *

package/dist/common/index.js

@@ -1,7 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.runNpmInstallCommand = void 0;
+exports.runNpmInstallCommand = exports.promptYUIQuestions = void 0;
 const child_process_1 = require("child_process");
+var prompts_1 = require("./prompts");
+Object.defineProperty(exports, "promptYUIQuestions", { enumerable: true, get: function () { return prompts_1.promptYUIQuestions; } });
 /**
  * Run npm install command.
  *

package/dist/common/prompts.d.ts

@@ -0,0 +1,22 @@
+import type { PromptObject } from 'prompts';
+import type { YUIQuestion } from '@sap-ux/inquirer-common';
+import type { Answers } from 'inquirer';
+/**
+ * Converts a YUI question to a simple prompts question.
+ *
+ * @param question YUI question to be converted
+ * @param answers previously given answers
+ * @returns question converted to prompts question
+ */
+export declare function convertQuestion<T extends Answers>(question: YUIQuestion<T> & {
+    choices?: unknown;
+}, answers: T): Promise<PromptObject>;
+/**
+ * Prompt a list of YeomanUI questions with the simple prompts module.
+ *
+ * @param questions list of questions
+ * @param useDefaults - if true, the default values are used for all prompts
+ * @returns the answers to the questions
+ */
+export declare function promptYUIQuestions<T extends Answers>(questions: YUIQuestion<T>[], useDefaults: boolean): Promise<T>;
+//# sourceMappingURL=prompts.d.ts.map

package/dist/common/prompts.js

@@ -0,0 +1,127 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.promptYUIQuestions = exports.convertQuestion = void 0;
+const prompts_1 = __importDefault(require("prompts"));
+const tracing_1 = require("../tracing");
+/**
+ * Checks if a property is a function.
+ *
+ * @param property property to be checked
+ * @returns true if the property is a function
+ */
+function isFunction(property) {
+    return typeof property === 'function';
+}
+const QUESTION_TYPE_MAP = {
+    input: 'text',
+    list: 'autocomplete',
+    checkbox: 'multiselect'
+};
+/**
+ * Enhances the new prompt with the choices from the original list question.
+ *
+ * @param listQuestion original list question
+ * @param prompt converted prompt
+ * @param answers previously given answers
+ */
+function enhanceListQuestion(listQuestion, prompt, answers) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const choices = (isFunction(listQuestion.choices) ? yield listQuestion.choices(answers) : listQuestion.choices);
+        const mapppedChoices = choices.map((choice) => ({
+            title: typeof choice === 'object' ? choice.name : `${choice}`,
+            value: typeof choice === 'object' ? choice.value : choice
+        }));
+        const initialValue = prompt.initial();
+        prompt.choices = mapppedChoices;
+        prompt.initial = () => mapppedChoices[initialValue]
+            ? initialValue
+            : mapppedChoices.findIndex((choice) => choice.value === initialValue);
+    });
+}
+/**
+ * Converts a YUI question to a simple prompts question.
+ *
+ * @param question YUI question to be converted
+ * @param answers previously given answers
+ * @returns question converted to prompts question
+ */
+function convertQuestion(question, answers) {
+    var _a, _b;
+    return __awaiter(this, void 0, void 0, function* () {
+        const prompt = {
+            type: (_b = QUESTION_TYPE_MAP[(_a = question.type) !== null && _a !== void 0 ? _a : 'input']) !== null && _b !== void 0 ? _b : question.type,
+            name: question.name,
+            message: isFunction(question.message) ? yield question.message(answers) : yield question.message,
+            validate: (value) => __awaiter(this, void 0, void 0, function* () { var _c; return isFunction(question.validate) ? yield question.validate(value, answers) : (_c = question.validate) !== null && _c !== void 0 ? _c : true; }),
+            initial: () => (isFunction(question.default) ? question.default(answers) : question.default)
+        };
+        if (question.choices) {
+            yield enhanceListQuestion(question, prompt, answers);
+        }
+        return prompt;
+    });
+}
+exports.convertQuestion = convertQuestion;
+/**
+ * Prompt a list of YeomanUI questions with the simple prompts module.
+ *
+ * @param questions list of questions
+ * @param useDefaults - if true, the default values are used for all prompts
+ * @returns the answers to the questions
+ */
+function promptYUIQuestions(questions, useDefaults) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const answers = {};
+        for (const question of questions) {
+            if (isFunction(question.when) ? question.when(answers) : question.when !== false) {
+                if (useDefaults) {
+                    answers[question.name] = isFunction(question.default) ? question.default(answers) : question.default;
+                }
+                else {
+                    answers[question.name] = yield promptSingleQuestion(answers, question);
+                }
+            }
+        }
+        return answers;
+    });
+}
+exports.promptYUIQuestions = promptYUIQuestions;
+/**
+ * Prompt a single YeomanUI question with the simple prompts module.
+ *
+ * @param answers previously given answers
+ * @param question question to be prompted
+ * @returns a promise with the answer of the question
+ */
+function promptSingleQuestion(answers, question) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const q = yield convertQuestion(question, answers);
+        const answer = yield (0, prompts_1.default)(q, {
+            onCancel: () => {
+                throw new Error('User canceled the prompt');
+            }
+        });
+        // prompts does not handle validation for autocomplete out of the box
+        if (q.type === 'autocomplete') {
+            const valid = yield q.validate(answer[question.name]);
+            if (valid !== true) {
+                (0, tracing_1.getLogger)().warn(valid);
+                return promptSingleQuestion(answers, question);
+            }
+        }
+        return answer[question.name];
+    });
+}
+//# sourceMappingURL=prompts.js.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/create",
   "description": "SAP Fiori tools module to add or remove features",
-  "version": "0.5.103",
+  "version": "0.5.104",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -29,8 +29,8 @@
     "diff": "5.1.0",
     "prompts": "2.4.2",
     "@sap-ux/adp-tooling": "0.11.0",
-    "@sap-ux/app-config-writer": "0.3.74",
     "@sap-ux/cap-config-writer": "0.3.4",
+    "@sap-ux/app-config-writer": "0.3.74",
     "@sap-ux/cards-editor-config-writer": "0.3.6",
     "@sap-ux/logger": "0.5.1",
     "@sap-ux/mockserver-config-writer": "0.5.5",
@@ -38,9 +38,11 @@
   },
   "devDependencies": {
     "@types/diff": "5.0.9",
+    "@types/inquirer": "8.2.6",
     "@types/mem-fs": "1.1.2",
     "@types/mem-fs-editor": "7.0.1",
     "@types/prompts": "2.4.4",
+    "@sap-ux/inquirer-common": "0.3.0",
     "@sap-ux/store": "0.5.0"
   },
   "scripts": {