@sap-ux/create 0.16.5 → 0.16.7

package/README.md

@@ -68,7 +68,7 @@ Command group for adding features to existing SAP Fiori applications. A subcomma
 
 Usage: `npx --yes @sap-ux/create@latest add [subcommand] [options]`
 
-The available subcommands are: `mockserver-config`, `smartlinks-config`, `eslint-config`, `cds-plugin-ui5`, `inbound-navigation`, `cards-editor`, `model`, `annotations`, `html`, `component-usages`, `deploy-config`, `variants-config` and `adp-cf-config`
+The available subcommands are: `mockserver-config`, `smartlinks-config`, `eslint-config`, `cds-plugin-ui5`, `inbound-navigation`, `cards-editor`, `model`, `annotations`, `html`, `component-usages`, `deploy-config`, `variants-config`, `adp-cf-config` and `flp-embedded-config`
 
 
 --------------------------------
@@ -271,6 +271,25 @@ Options:
 
 --------------------------------
 
+## [`add flp-embedded-config`](#add-flp-embedded-config)
+
+Add the necessary configuration for running a Fiori app in FLP Embedded Mode.
+Adds a `start-embedded` script to `package.json` and creates an `flp.yaml` file
+based on the existing `ui5.yaml`. Pre-existing files will be overridden.
+
+Example:
+
+`npx --yes @sap-ux/create@latest add flp-embedded-config --bspApplication my-bsp-app`
+
+Options:
+- `-b, --bspApplication <string>` _(required)_ - BSP application name of the deployed app
+- `-c, --config <string>` - Path (relative to project root) to the ui5.yaml to use as base for flp.yaml _(default: `ui5.yaml`)_
+- `--flp <string>` - FLP URL path used in the start-embedded script _(default: `sap/bc/ui5_ui5/ui2/ushell/shells/abap/Fiorilaunchpad.html`)_
+- `-s, --simulate` - Simulate only. Do not write files. Also sets `--verbose`.
+- `-v, --verbose` - Show verbose information.
+
+--------------------------------
+
 ## [`convert`](#convert)
 
 Command group for converting existing SAP Fiori applications. A subcommand is required.

package/dist/cli/add/flp-embedded-config.d.ts

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

package/dist/cli/add/flp-embedded-config.js

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addFlpEmbeddedConfigCommand = addFlpEmbeddedConfigCommand;
+const tracing_1 = require("../../tracing");
+const app_config_writer_1 = require("@sap-ux/app-config-writer");
+/**
+ * Add the "add flp-embedded-config" command to a passed command.
+ *
+ * @param cmd - commander command to attach the flp-embedded-config subcommand to
+ */
+function addFlpEmbeddedConfigCommand(cmd) {
+    cmd.command('flp-embedded-config [path]')
+        .description(`Add the necessary configuration for running a Fiori app in FLP Embedded Mode.
+Adds a \`start-embedded\` script to \`package.json\` and creates an \`flp.yaml\` file
+based on the existing \`ui5.yaml\`. Pre-existing files will be overridden.
+
+Example:
+    \`npx --yes @sap-ux/create@latest add flp-embedded-config --bspApplication my-bsp-app\``)
+        .requiredOption('-b, --bspApplication <string>', 'BSP application name of the deployed app')
+        .option('-c, --config <string>', 'Path (relative to project root) to the ui5.yaml to use as base for flp.yaml', 'ui5.yaml')
+        .option('--flp <string>', 'FLP URL path used in the start-embedded script', app_config_writer_1.DEFAULT_FLP_PATH)
+        .option('-s, --simulate', 'Simulate only. Do not write files. Also sets `--verbose`.')
+        .option('-v, --verbose', 'Show verbose information.')
+        .action(async (path, options) => {
+        if (options.verbose === true || options.simulate) {
+            (0, tracing_1.setLogLevelVerbose)();
+        }
+        // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
+        await runFlpEmbeddedConfig(path || process.cwd(), options);
+    });
+}
+/**
+ * Run the flp-embedded-config generation.
+ *
+ * @param basePath - project root (where package.json and ui5.yaml are)
+ * @param options - parsed CLI options
+ * @param options.bspApplication - BSP application name of the deployed app
+ * @param options.config - path to the ui5.yaml to use as base for flp.yaml
+ * @param options.flp - FLP URL path used in the start-embedded script
+ * @param options.simulate - if true, simulate only and do not write files
+ */
+async function runFlpEmbeddedConfig(basePath, options) {
+    const logger = (0, tracing_1.getLogger)();
+    try {
+        logger.debug(`Called add flp-embedded-config for path '${basePath}', bspApplication '${options.bspApplication}'`);
+        const fs = await (0, app_config_writer_1.generateFlpEmbeddedConfig)(basePath, options.bspApplication, options.flp, options.config, undefined, logger);
+        if (options.simulate) {
+            await (0, tracing_1.traceChanges)(fs);
+        }
+        else {
+            await new Promise((resolve, reject) => {
+                fs.commit((error) => {
+                    if (error) {
+                        reject(error);
+                    }
+                    else {
+                        logger.info(`FLP Embedded Mode configuration written.`);
+                        resolve();
+                    }
+                });
+            });
+        }
+    }
+    catch (error) {
+        logger.error(`Error while executing add flp-embedded-config: ${error.message}`);
+        logger.debug(error);
+    }
+}
+//# sourceMappingURL=flp-embedded-config.js.map

package/dist/cli/add/index.js

@@ -15,6 +15,7 @@ const deploy_config_1 = require("./deploy-config");
 const variants_config_1 = require("./variants-config");
 const adp_cf_config_1 = require("./adp-cf-config");
 const eslint_config_1 = require("./eslint-config");
+const flp_embedded_config_1 = require("./flp-embedded-config");
 /**
  * Return 'create-fiori add *' commands. Commands include also the handler action.
  *
@@ -35,6 +36,7 @@ function getAddCommands() {
     (0, deploy_config_1.addDeployConfigCommand)(addCommands);
     (0, variants_config_1.addAddVariantsConfigCommand)(addCommands);
     (0, adp_cf_config_1.addAdaptationProjectCFConfigCommand)(addCommands);
+    (0, flp_embedded_config_1.addFlpEmbeddedConfigCommand)(addCommands);
     return addCommands;
 }
 //# sourceMappingURL=index.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.16.5",
+  "version": "0.16.7",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -31,20 +31,20 @@
     "mem-fs": "2.1.0",
     "mem-fs-editor": "9.4.0",
     "prompts": "2.4.2",
-    "@sap-ux/abap-deploy-config-inquirer": "1.9.2",
-    "@sap-ux/abap-deploy-config-writer": "0.4.1",
-    "@sap-ux/adp-tooling": "0.19.3",
+    "@sap-ux/abap-deploy-config-inquirer": "1.9.3",
+    "@sap-ux/abap-deploy-config-writer": "0.4.2",
+    "@sap-ux/adp-tooling": "0.19.5",
     "@sap-ux/btp-utils": "1.2.0",
-    "@sap-ux/app-config-writer": "0.7.2",
-    "@sap-ux/cap-config-writer": "0.13.2",
+    "@sap-ux/app-config-writer": "0.7.3",
+    "@sap-ux/cap-config-writer": "0.13.3",
     "@sap-ux/logger": "0.9.0",
-    "@sap-ux/mockserver-config-writer": "0.10.1",
-    "@sap-ux/odata-service-writer": "0.32.1",
-    "@sap-ux/preview-middleware": "0.26.4",
-    "@sap-ux/project-access": "1.38.0",
+    "@sap-ux/mockserver-config-writer": "0.10.2",
+    "@sap-ux/odata-service-writer": "0.32.2",
+    "@sap-ux/preview-middleware": "0.26.6",
+    "@sap-ux/project-access": "1.38.1",
     "@sap-ux/system-access": "0.8.0",
-    "@sap-ux/ui5-config": "0.31.0",
-    "@sap-ux/flp-config-inquirer": "0.5.3",
+    "@sap-ux/ui5-config": "0.31.1",
+    "@sap-ux/flp-config-inquirer": "0.5.5",
     "@sap-ux/nodejs-utils": "0.3.0",
     "@sap-ux/axios-extension": "1.26.0"
   },
@@ -54,7 +54,7 @@
     "@types/mem-fs": "1.1.2",
     "@types/mem-fs-editor": "7.0.1",
     "@types/prompts": "2.4.9",
-    "@sap-ux/inquirer-common": "0.13.1",
+    "@sap-ux/inquirer-common": "0.13.2",
     "@sap-ux/store": "1.6.0"
   },
   "scripts": {