@sap-ux/create 0.7.67 → 0.8.1

package/README.md

@@ -31,6 +31,15 @@ Calling `sap-ux add annotations` allows adding an annotation to the OData Source
 ```sh
 sap-ux add annotations /path/to/adaptation-project
 ```
+### deploy-config
+Calling `sap-ux add deploy-config` will prompt for ABAP deployment configuration details and add/update the project files accordingly
+```sh
+sap-ux add deploy-config /path/to/project
+```
+#### deploy-config options: 
+`--target` abap | cf (cf deploy config inquirer not yet implemented)\
+`--base-file` e.g ui5.yaml\
+`--deploy-file` e.g. ui5-deploy.yaml
 
 ### model
 Calling `sap-ux add model` allows to add new OData Service and SAPUI5 Model to an existing adaptation project.  

package/dist/cli/add/deploy-config.d.ts

@@ -0,0 +1,8 @@
+import type { Command } from 'commander';
+/**
+ * Add the "add deploy config" command to a passed command.
+ *
+ * @param cmd - commander command for adding deploy config command
+ */
+export declare function addDeployConfigCommand(cmd: Command): void;
+//# sourceMappingURL=deploy-config.d.ts.map

package/dist/cli/add/deploy-config.js

@@ -0,0 +1,109 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addDeployConfigCommand = void 0;
+const project_access_1 = require("@sap-ux/project-access");
+const abap_deploy_config_writer_1 = require("@sap-ux/abap-deploy-config-writer");
+const tracing_1 = require("../../tracing");
+const validation_1 = require("../../validation");
+const abap_deploy_config_inquirer_1 = require("@sap-ux/abap-deploy-config-inquirer");
+const prompts_1 = require("prompts");
+const common_1 = require("../../common");
+/**
+ * Add the "add deploy config" command to a passed command.
+ *
+ * @param cmd - commander command for adding deploy config command
+ */
+function addDeployConfigCommand(cmd) {
+    cmd.command('deploy-config [path]')
+        .option('-t, --target <string>', 'target for deployment; ABAP or Cloud Foundry (not yet implemented)')
+        .option('-s, --simulate', 'simulate only do not write; sets also --verbose')
+        .option('-v, --verbose', 'show verbose information')
+        .option('-b, --base-file <string>', 'the base file config file of the project; default : ui5.yaml')
+        .option('-d, --deploy-file <string>', 'the name of the deploy config file to be written; default : ui5-deploy.yaml')
+        .action(async (path, options) => {
+        if (options.verbose === true || options.simulate) {
+            (0, tracing_1.setLogLevelVerbose)();
+        }
+        await addDeployConfig(path || process.cwd(), options.target, options.simulate, options.baseFile ?? project_access_1.FileName.Ui5Yaml, options.deployFile ?? project_access_1.FileName.UI5DeployYaml);
+    });
+}
+exports.addDeployConfigCommand = addDeployConfigCommand;
+/**
+ * Prompts the user to select the target for deployment.
+ *
+ * @param target - target for deployment
+ * @returns target
+ */
+async function getTarget(target) {
+    if (!target || (target !== 'abap' && target !== 'cf')) {
+        const question = {
+            name: 'target',
+            type: 'select',
+            message: 'Select the target for deployment',
+            choices: [
+                { title: 'ABAP', value: 'abap' }
+                // { title: 'Cloud Foundry', value: 'cf' }
+            ]
+        };
+        return (await (0, prompts_1.prompt)(question)).target;
+    }
+    else {
+        return target;
+    }
+}
+/**
+ * Adds a deploy config to an app or project.
+ *
+ * @param basePath - path to application root
+ * @param target - target for deployment (ABAP or Cloud Foundry)
+ * @param simulate - simulate only do not write
+ * @param baseFile - base file name
+ * @param deployFile - deploy file name
+ */
+async function addDeployConfig(basePath, target, simulate = false, baseFile, deployFile) {
+    const logger = (0, tracing_1.getLogger)();
+    try {
+        target = await getTarget(target);
+        if (target === 'cf') {
+            logger.info('Cloud Foundry deployment is not yet implemented.');
+            return;
+        }
+        else if (target === 'abap') {
+            logger.debug(`Called add deploy-config for path '${basePath}', simulate is '${simulate}'`);
+            await (0, validation_1.validateBasePath)(basePath);
+            const { prompts: abapPrompts, answers: abapAnswers } = await (0, abap_deploy_config_inquirer_1.getPrompts)({ useAutocomplete: true }, logger, false);
+            const answers = (0, abap_deploy_config_inquirer_1.reconcileAnswers)(await (0, common_1.promptYUIQuestions)(abapPrompts, false), abapAnswers);
+            const config = {
+                target: {
+                    url: answers.url,
+                    client: answers.client,
+                    scp: answers.scp,
+                    destination: answers.destination
+                },
+                app: {
+                    name: answers.ui5AbapRepo,
+                    package: answers.package,
+                    description: answers.description,
+                    transport: answers.transport
+                },
+                index: answers.index
+            };
+            logger.debug(`Adding deployment configuration : ${JSON.stringify(config, null, 2)}`);
+            const fs = await (0, abap_deploy_config_writer_1.generate)(basePath, config, {
+                baseFile,
+                deployFile
+            });
+            await (0, tracing_1.traceChanges)(fs);
+            if (!simulate) {
+                fs.commit(() => {
+                    logger.info(`Changes written.`);
+                });
+            }
+        }
+    }
+    catch (error) {
+        logger.error(`Error while executing add deploy-config '${error.message}'`);
+        logger.debug(error);
+    }
+}
+//# sourceMappingURL=deploy-config.js.map

package/dist/cli/add/index.js

@@ -11,6 +11,7 @@ const new_model_1 = require("./new-model");
 const annotations_to_odata_1 = require("./annotations-to-odata");
 const html_1 = require("./html");
 const component_usages_1 = require("./component-usages");
+const deploy_config_1 = require("./deploy-config");
 /**
  * Return 'create-fiori add *' commands. Commands include also the handler action.
  *
@@ -36,6 +37,8 @@ function getAddCommands() {
     (0, html_1.addAddHtmlFilesCmd)(addCommands);
     // create-fiori add component-usages
     (0, component_usages_1.addComponentUsagesCommand)(addCommands);
+    // create-fiori add deploy-config
+    (0, deploy_config_1.addDeployConfigCommand)(addCommands);
     return addCommands;
 }
 exports.getAddCommands = getAddCommands;

package/dist/common/prompts.d.ts

@@ -1,6 +1,10 @@
 import type { PromptObject } from 'prompts';
 import type { YUIQuestion } from '@sap-ux/inquirer-common';
 import type { Answers } from 'inquirer';
+type AutoCompleteCallbackFn = (answers: Answers, input: string) => Promise<Array<{
+    name: string;
+    value: unknown;
+}>>;
 /**
  * Converts a YUI question to a simple prompts question.
  *
@@ -10,13 +14,16 @@ import type { Answers } from 'inquirer';
  */
 export declare function convertQuestion<T extends Answers>(question: YUIQuestion<T> & {
     choices?: unknown;
+    source?: AutoCompleteCallbackFn;
 }, 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
+ * @param answers - previously given answers
  * @returns the answers to the questions
  */
-export declare function promptYUIQuestions<T extends Answers>(questions: YUIQuestion<T>[], useDefaults: boolean): Promise<T>;
+export declare function promptYUIQuestions<T extends Answers>(questions: YUIQuestion<T>[], useDefaults: boolean, answers?: T): Promise<T>;
+export {};
 //# sourceMappingURL=prompts.d.ts.map

package/dist/common/prompts.js

@@ -22,23 +22,42 @@ const QUESTION_TYPE_MAP = {
     checkbox: 'multiselect'
 };
 /**
- * Enhances the new prompt with the choices from the original list question.
+ * Map choices from inquirer format to prompts format.
  *
- * @param listQuestion original list question
- * @param prompt converted prompt
- * @param answers previously given answers
+ * @param choices choices to be mapped
+ * @returns mapped choices
  */
-async function enhanceListQuestion(listQuestion, prompt, answers) {
-    const choices = (isFunction(listQuestion.choices) ? await listQuestion.choices(answers) : listQuestion.choices);
-    const mapppedChoices = choices.map((choice) => ({
+function mapChoices(choices) {
+    return choices.map((choice) => ({
         title: typeof choice === 'object' ? choice.name : `${choice}`,
         value: typeof choice === 'object' ? choice.value : choice
     }));
+}
+/**
+ * Enhances the new prompt with the choices from the original list question.
+ *
+ * @param origChoices choices of the original list/autocomplete question
+ * @param prompt converted prompt
+ * @param answers previously given answers
+ * @param autoCompleteCb callback for autocomplete
+ */
+async function enhanceListQuestion(origChoices, prompt, answers, autoCompleteCb) {
+    const choices = (isFunction(origChoices) ? await origChoices(answers) : origChoices);
+    const mapppedChoices = mapChoices(choices);
     const initialValue = prompt.initial();
     prompt.choices = mapppedChoices;
     prompt.initial = () => mapppedChoices[initialValue]
         ? initialValue
         : mapppedChoices.findIndex((choice) => choice.value === initialValue);
+    if (autoCompleteCb) {
+        prompt.suggest = async (input, choices) => {
+            if (input) {
+                const newChoices = await autoCompleteCb(answers, input);
+                return mapChoices(newChoices);
+            }
+            return choices;
+        };
+    }
 }
 /**
  * Indicates if the question is optional.
@@ -71,8 +90,8 @@ async function convertQuestion(question, answers) {
         validate: async (value) => isFunction(question.validate) ? await question.validate(value, answers) : question.validate ?? true,
         initial: () => (isFunction(question.default) ? question.default(answers) : question.default)
     };
-    if (question.choices) {
-        await enhanceListQuestion(question, prompt, answers);
+    if (question.choices || question.source) {
+        await enhanceListQuestion(question.choices ?? question.source, prompt, answers, question.source);
     }
     return prompt;
 }
@@ -82,12 +101,13 @@ exports.convertQuestion = convertQuestion;
  *
  * @param questions list of questions
  * @param useDefaults - if true, the default values are used for all prompts
+ * @param answers - previously given answers
  * @returns the answers to the questions
  */
-async function promptYUIQuestions(questions, useDefaults) {
-    const answers = {};
+async function promptYUIQuestions(questions, useDefaults, answers) {
+    answers ??= {};
     for (const question of questions) {
-        if (isFunction(question.when) ? question.when(answers) : question.when !== false) {
+        if (isFunction(question.when) ? await question.when(answers) : question.when !== false) {
             if (useDefaults) {
                 answers[question.name] = isFunction(question.default) ? question.default(answers) : question.default;
             }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/create",
   "description": "SAP Fiori tools module to add or remove features",
-  "version": "0.7.67",
+  "version": "0.8.1",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -30,9 +30,11 @@
     "mem-fs": "2.1.0",
     "mem-fs-editor": "9.4.0",
     "prompts": "2.4.2",
+    "@sap-ux/abap-deploy-config-inquirer": "0.0.9",
+    "@sap-ux/abap-deploy-config-writer": "0.0.39",
     "@sap-ux/adp-tooling": "0.12.44",
     "@sap-ux/app-config-writer": "0.4.30",
-    "@sap-ux/cap-config-writer": "0.7.34",
+    "@sap-ux/cap-config-writer": "0.7.35",
     "@sap-ux/cards-editor-config-writer": "0.4.4",
     "@sap-ux/inquirer-common": "0.4.6",
     "@sap-ux/logger": "0.6.0",