@sap-ux/create 0.14.61 → 0.14.63

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`, `cds-plugin-ui5`, `inbound-navigation`, `cards-editor`, `model`, `annotations`, `html`, `component-usages`, `deploy-config` and `variants-config`
+The available subcommands are: `mockserver-config`, `smartlinks-config`, `cds-plugin-ui5`, `inbound-navigation`, `cards-editor`, `model`, `annotations`, `html`, `component-usages`, `deploy-config`, `variants-config` and `adp-cf-config`
 
 
 --------------------------------
@@ -152,6 +152,9 @@ Options:
 
 Add a new OData service and SAPUI5 model to an existing adaptation project.
 
+
+This command is not supported for Cloud Foundry projects.
+
 Example:
 
 `npx --yes @sap-ux/create@latest add model`
@@ -165,6 +168,9 @@ Options:
 
 Adds an annotation to the OData Source of the base application in an adaptation project.
 
+
+This command is not supported for Cloud Foundry projects.
+
 Example:
 
 `npx --yes @sap-ux/create@latest add annotations`
@@ -235,6 +241,23 @@ Options:
 
 --------------------------------
 
+## [`add adp-cf-config`](#add-adp-cf-config)
+
+Configure an existing Cloud Foundry adaptation project for local preview by fetching reusable libraries, building the project, and configuring ui5.yaml file middlewares.
+
+
+**⚠️ Experimental**: This command is experimental and may be subject to breaking changes or even removal in future versions. Use with caution and be prepared to update your configuration or migrate to alternative solutions, if needed.
+
+Example:
+
+`npx --yes @sap-ux/create@latest add adp-cf-config`
+
+Options:
+- `-v, --verbose` - Show verbose information.
+- `-c, --config <string>` _(required)_ - Path to the project configuration file in YAML format. _(default: `ui5.yaml`)_
+
+--------------------------------
+
 ## [`convert`](#convert)
 
 Command group for converting existing SAP Fiori applications. A subcommand is required.
@@ -302,6 +325,9 @@ The available subcommands are: `data-source` and `inbound`
 
 Replace the OData Source of the base application in an adaptation project.
 
+
+This command is not supported for Cloud Foundry projects.
+
 Example:
 
 `npx --yes @sap-ux/create@latest change data-source`
@@ -316,6 +342,9 @@ Options:
 
 Replace the inbound FLP configurations of the base application in an adaptation project.
 
+
+This command is not supported for Cloud Foundry projects.
+
 Example:
 
 `npx --yes @sap-ux/create@latest change inbound`

package/dist/cli/add/adp-cf-config.d.ts

@@ -0,0 +1,8 @@
+import type { Command } from 'commander';
+/**
+ * Add the "adp-cf-config" sub-command.
+ *
+ * @param cmd - commander command for setting up CF adaptation project
+ */
+export declare function addAdaptationProjectCFConfigCommand(cmd: Command): void;
+//# sourceMappingURL=adp-cf-config.d.ts.map

package/dist/cli/add/adp-cf-config.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addAdaptationProjectCFConfigCommand = addAdaptationProjectCFConfigCommand;
+const tracing_1 = require("../../tracing");
+const validation_1 = require("../../validation");
+const adp_tooling_1 = require("@sap-ux/adp-tooling");
+const project_access_1 = require("@sap-ux/project-access");
+/**
+ * Add the "adp-cf-config" sub-command.
+ *
+ * @param cmd - commander command for setting up CF adaptation project
+ */
+function addAdaptationProjectCFConfigCommand(cmd) {
+    cmd.command('adp-cf-config [path]')
+        .description(`Configure an existing Cloud Foundry adaptation project for local preview by fetching reusable libraries, building the project, and configuring ui5.yaml file middlewares.\n
+            **⚠️ Experimental**: This command is experimental and may be subject to breaking changes or even removal in future versions. Use with caution and be prepared to update your configuration or migrate to alternative solutions, if needed.\n
+Example:
+    \`npx --yes @sap-ux/create@latest add adp-cf-config\``)
+        .option('-v, --verbose', 'Show verbose information.')
+        .option('-c, --config <string>', 'Path to the project configuration file in YAML format.', project_access_1.FileName.Ui5Yaml)
+        .action(async (path, options) => {
+        if (options.verbose === true) {
+            (0, tracing_1.setLogLevelVerbose)();
+        }
+        await setupAdaptationProjectCF(path ?? process.cwd(), options.config);
+    });
+}
+/**
+ * Setup a Cloud Foundry adaptation project.
+ *
+ * @param basePath - path to project root
+ * @param yamlPath - path to the project configuration file in YAML format
+ */
+async function setupAdaptationProjectCF(basePath, yamlPath) {
+    const logger = (0, tracing_1.getLogger)();
+    await (0, validation_1.validateBasePath)(basePath);
+    await (0, validation_1.validateAdpAppType)(basePath);
+    if (!(await (0, adp_tooling_1.isCFEnvironment)(basePath))) {
+        throw new Error('This command can only be used for Cloud Foundry adaptation projects.');
+    }
+    const cfConfig = (0, adp_tooling_1.loadCfConfig)(logger);
+    if (!(await (0, adp_tooling_1.isLoggedInCf)(cfConfig, logger))) {
+        throw new Error('You are not logged in to Cloud Foundry or your session has expired. Please run "cf login" first.');
+    }
+    try {
+        const fs = await (0, adp_tooling_1.generateCfConfig)(basePath, yamlPath, cfConfig, logger);
+        await (0, tracing_1.traceChanges)(fs);
+        await new Promise((resolve, reject) => {
+            fs.commit([], (err) => {
+                if (err) {
+                    reject(err);
+                }
+                else {
+                    resolve();
+                }
+            });
+        });
+    }
+    catch (error) {
+        logger.error(`Failed to setup CF adaptation project: ${error.message}`);
+        throw error;
+    }
+}
+//# sourceMappingURL=adp-cf-config.js.map

package/dist/cli/add/annotations-to-odata.js

@@ -17,6 +17,7 @@ let loginAttempts = 3;
 function addAnnotationsToOdataCommand(cmd) {
     cmd.command('annotations [path]')
         .description(`Adds an annotation to the OData Source of the base application in an adaptation project.\n
+            This command is not supported for Cloud Foundry projects.\n
 Example:
     \`npx --yes @sap-ux/create@latest add annotations\``)
         .option('-s, --simulate', 'Simulate only. Do not write or install.')
@@ -38,7 +39,10 @@ async function addAnnotationsToOdata(basePath, simulate, yamlPath) {
         if (!basePath) {
             basePath = process.cwd();
         }
-        await (0, validation_1.validateAdpProject)(basePath);
+        await (0, validation_1.validateAdpAppType)(basePath);
+        if (await (0, adp_tooling_1.isCFEnvironment)(basePath)) {
+            throw new Error('This command is not supported for Cloud Foundry projects.');
+        }
         const variant = await (0, adp_tooling_1.getVariant)(basePath);
         const { target, ignoreCertErrors = false } = await (0, adp_tooling_1.getAdpConfig)(basePath, yamlPath);
         const provider = await (0, system_access_1.createAbapServiceProvider)(target, {

package/dist/cli/add/component-usages.js

@@ -33,7 +33,10 @@ async function addComponentUsages(basePath, simulate) {
         if (!basePath) {
             basePath = process.cwd();
         }
-        await (0, validation_1.validateAdpProject)(basePath);
+        await (0, validation_1.validateAdpAppType)(basePath);
+        if (await (0, adp_tooling_1.isCFEnvironment)(basePath)) {
+            throw new Error('This command is not supported for CF projects.');
+        }
         const variant = await (0, adp_tooling_1.getVariant)(basePath);
         const answers = await (0, common_1.promptYUIQuestions)((0, adp_tooling_1.getPromptsForAddComponentUsages)(basePath, variant.layer), false);
         const fs = await (0, adp_tooling_1.generateChange)(basePath, "appdescr_ui5_addComponentUsages" /* ChangeType.ADD_COMPONENT_USAGES */, createComponentUsageData(variant, answers));

package/dist/cli/add/index.js

@@ -13,6 +13,7 @@ const html_1 = require("./html");
 const component_usages_1 = require("./component-usages");
 const deploy_config_1 = require("./deploy-config");
 const variants_config_1 = require("./variants-config");
+const adp_cf_config_1 = require("./adp-cf-config");
 /**
  * Return 'create-fiori add *' commands. Commands include also the handler action.
  *
@@ -31,6 +32,7 @@ function getAddCommands() {
     (0, component_usages_1.addComponentUsagesCommand)(addCommands);
     (0, deploy_config_1.addDeployConfigCommand)(addCommands);
     (0, variants_config_1.addAddVariantsConfigCommand)(addCommands);
+    (0, adp_cf_config_1.addAdaptationProjectCFConfigCommand)(addCommands);
     return addCommands;
 }
 //# sourceMappingURL=index.js.map

package/dist/cli/add/new-model.js

@@ -13,6 +13,7 @@ const validation_1 = require("../../validation/validation");
 function addNewModelCommand(cmd) {
     cmd.command('model [path]')
         .description(`Add a new OData service and SAPUI5 model to an existing adaptation project.\n
+            This command is not supported for Cloud Foundry projects.\n
 Example:
     \`npx --yes @sap-ux/create@latest add model\``)
         .option('-s, --simulate', 'Simulate only. Do not write or install.')
@@ -32,9 +33,12 @@ async function addNewModel(basePath, simulate) {
         if (!basePath) {
             basePath = process.cwd();
         }
-        await (0, validation_1.validateAdpProject)(basePath);
+        await (0, validation_1.validateAdpAppType)(basePath);
+        if (await (0, adp_tooling_1.isCFEnvironment)(basePath)) {
+            throw new Error('This command is not supported for Cloud Foundry projects.');
+        }
         const variant = await (0, adp_tooling_1.getVariant)(basePath);
-        const answers = await (0, common_1.promptYUIQuestions)((0, adp_tooling_1.getPromptsForNewModel)(basePath, variant.layer), false);
+        const answers = await (0, common_1.promptYUIQuestions)(await (0, adp_tooling_1.getPromptsForNewModel)(basePath, variant.layer), false);
         const fs = await (0, adp_tooling_1.generateChange)(basePath, "appdescr_ui5_addNewModel" /* ChangeType.ADD_NEW_MODEL */, createNewModelData(variant, answers));
         if (!simulate) {
             await new Promise((resolve) => fs.commit(resolve));

package/dist/cli/change/change-data-source.js

@@ -16,6 +16,7 @@ let loginAttempts = 3;
 function addChangeDataSourceCommand(cmd) {
     cmd.command('data-source [path]')
         .description(`Replace the OData Source of the base application in an adaptation project.\n
+            This command is not supported for Cloud Foundry projects.\n
 Example:
     \`npx --yes @sap-ux/create@latest change data-source\``)
         .option('-s, --simulate', 'Simulate only. Do not write or install.')
@@ -37,7 +38,10 @@ async function changeDataSource(basePath, simulate, yamlPath) {
         if (!basePath) {
             basePath = process.cwd();
         }
-        await (0, validation_1.validateAdpProject)(basePath);
+        await (0, validation_1.validateAdpAppType)(basePath);
+        if (await (0, adp_tooling_1.isCFEnvironment)(basePath)) {
+            throw new Error('This command is not supported for Cloud Foundry projects.');
+        }
         const variant = await (0, adp_tooling_1.getVariant)(basePath);
         const { target, ignoreCertErrors = false } = await (0, adp_tooling_1.getAdpConfig)(basePath, yamlPath);
         const provider = await (0, system_access_1.createAbapServiceProvider)(target, {

package/dist/cli/change/change-inbound.js

@@ -13,6 +13,7 @@ const validation_1 = require("../../validation");
 function addChangeInboundCommand(cmd) {
     cmd.command('inbound [path]')
         .description(`Replace the inbound FLP configurations of the base application in an adaptation project.\n
+            This command is not supported for Cloud Foundry projects.\n
 Example:
     \`npx --yes @sap-ux/create@latest change inbound\``)
         .option('-s, --simulate', 'Simulate only. Do not write or install.')
@@ -32,7 +33,10 @@ async function changeInbound(basePath, simulate) {
         if (!basePath) {
             basePath = process.cwd();
         }
-        await (0, validation_1.validateAdpProject)(basePath);
+        await (0, validation_1.validateAdpAppType)(basePath);
+        if (await (0, adp_tooling_1.isCFEnvironment)(basePath)) {
+            throw new Error('This command is not supported for Cloud Foundry projects.');
+        }
         await (0, validation_1.validateCloudAdpProject)(basePath);
         const variant = await (0, adp_tooling_1.getVariant)(basePath);
         const change = variant.content.find((change) => change.changeType === 'appdescr_app_removeAllInboundsExceptOne');

package/dist/validation/index.d.ts

@@ -1,2 +1,2 @@
-export { hasFileDeletes, validateBasePath, validateAdpProject, validateCloudAdpProject } from './validation';
+export { hasFileDeletes, validateBasePath, validateCloudAdpProject, validateAdpAppType } from './validation';
 //# sourceMappingURL=index.d.ts.map

package/dist/validation/index.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateCloudAdpProject = exports.validateAdpProject = exports.validateBasePath = exports.hasFileDeletes = void 0;
+exports.validateAdpAppType = exports.validateCloudAdpProject = exports.validateBasePath = exports.hasFileDeletes = void 0;
 var validation_1 = require("./validation");
 Object.defineProperty(exports, "hasFileDeletes", { enumerable: true, get: function () { return validation_1.hasFileDeletes; } });
 Object.defineProperty(exports, "validateBasePath", { enumerable: true, get: function () { return validation_1.validateBasePath; } });
-Object.defineProperty(exports, "validateAdpProject", { enumerable: true, get: function () { return validation_1.validateAdpProject; } });
 Object.defineProperty(exports, "validateCloudAdpProject", { enumerable: true, get: function () { return validation_1.validateCloudAdpProject; } });
+Object.defineProperty(exports, "validateAdpAppType", { enumerable: true, get: function () { return validation_1.validateAdpAppType; } });
 //# sourceMappingURL=index.js.map

package/dist/validation/validation.d.ts

@@ -14,11 +14,11 @@ export declare function validateBasePath(basePath: string, ui5YamlPath?: string)
  */
 export declare function hasFileDeletes(fs: Editor): boolean;
 /**
- * Validate if adaptation project is supported for command, throws an error if not supported.
+ * Validate if adaptation project is of type 'Fiori Adaptation', throws an error if not.
  *
  * @param basePath - path to the adaptation project
  */
-export declare function validateAdpProject(basePath: string): Promise<void>;
+export declare function validateAdpAppType(basePath: string): Promise<void>;
 /**
  * Validate if adaptation project is cloud, throws an error if not.
  *

package/dist/validation/validation.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateBasePath = validateBasePath;
 exports.hasFileDeletes = hasFileDeletes;
-exports.validateAdpProject = validateAdpProject;
+exports.validateAdpAppType = validateAdpAppType;
 exports.validateCloudAdpProject = validateCloudAdpProject;
 const node_path_1 = require("node:path");
 const node_fs_1 = require("node:fs");
@@ -36,17 +36,14 @@ function hasFileDeletes(fs) {
     return !!Object.keys(changedFiles).find((fileName) => changedFiles[fileName].state === 'deleted');
 }
 /**
- * Validate if adaptation project is supported for command, throws an error if not supported.
+ * Validate if adaptation project is of type 'Fiori Adaptation', throws an error if not.
  *
  * @param basePath - path to the adaptation project
  */
-async function validateAdpProject(basePath) {
+async function validateAdpAppType(basePath) {
     if ((await (0, project_access_1.getAppType)(basePath)) !== 'Fiori Adaptation') {
         throw new Error('This command can only be used for an adaptation project');
     }
-    if ((0, adp_tooling_1.isCFEnvironment)(basePath)) {
-        throw new Error('This command is not supported for CF projects.');
-    }
 }
 /**
  * Validate if adaptation project is cloud, throws an error if not.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/create",
   "description": "SAP Fiori tools module to add or remove features",
-  "version": "0.14.61",
+  "version": "0.14.63",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -24,25 +24,27 @@
     "!dist/**/*.map"
   ],
   "dependencies": {
+    "@sap/cf-tools": "3.3.0",
     "chalk": "4.1.2",
     "commander": "9.4.0",
     "diff": "5.2.2",
     "mem-fs": "2.1.0",
     "mem-fs-editor": "9.4.0",
     "prompts": "2.4.2",
-    "@sap-ux/abap-deploy-config-inquirer": "1.6.97",
-    "@sap-ux/abap-deploy-config-writer": "0.2.70",
-    "@sap-ux/adp-tooling": "0.18.61",
-    "@sap-ux/app-config-writer": "0.6.95",
-    "@sap-ux/cap-config-writer": "0.12.60",
+    "@sap-ux/abap-deploy-config-inquirer": "1.6.99",
+    "@sap-ux/abap-deploy-config-writer": "0.2.72",
+    "@sap-ux/adp-tooling": "0.18.63",
+    "@sap-ux/app-config-writer": "0.6.97",
+    "@sap-ux/cap-config-writer": "0.12.62",
     "@sap-ux/logger": "0.8.1",
-    "@sap-ux/mockserver-config-writer": "0.9.49",
-    "@sap-ux/odata-service-writer": "0.29.17",
-    "@sap-ux/preview-middleware": "0.23.118",
-    "@sap-ux/project-access": "1.35.2",
-    "@sap-ux/system-access": "0.6.50",
+    "@sap-ux/mockserver-config-writer": "0.9.50",
+    "@sap-ux/odata-service-writer": "0.29.18",
+    "@sap-ux/preview-middleware": "0.23.120",
+    "@sap-ux/project-access": "1.35.3",
+    "@sap-ux/system-access": "0.6.51",
     "@sap-ux/ui5-config": "0.29.16",
-    "@sap-ux/flp-config-inquirer": "0.4.120"
+    "@sap-ux/flp-config-inquirer": "0.4.122",
+    "@sap-ux/nodejs-utils": "0.2.14"
   },
   "devDependencies": {
     "@types/diff": "5.0.9",
@@ -50,8 +52,8 @@
     "@types/mem-fs": "1.1.2",
     "@types/mem-fs-editor": "7.0.1",
     "@types/prompts": "2.4.4",
-    "@sap-ux/inquirer-common": "0.11.3",
-    "@sap-ux/store": "1.5.5"
+    "@sap-ux/inquirer-common": "0.11.5",
+    "@sap-ux/store": "1.5.6"
   },
   "scripts": {
     "build": "tsc --build && node ./scripts/generate-readme.js",