@sap-ux/create 0.5.114 → 0.6.0

package/README.md

@@ -21,6 +21,12 @@ npx sap-ux
 ## add
 Calling `sap-ux add` allows adding a feature to a project.
 
+### html
+Calling `sap-ux add html` will add html files for local preview and testing to the project. It will use the configuration from the `preview-middleware` from the `ui5.yaml` as default but also allows pointing to a different yaml e.g.:
+```sh
+sap-ux change add html ui5-test.yaml
+```
+
 ## change
 Calling `sap-ux change` allows changing a feature of a project.
 

package/dist/cli/add/cards-editor.js

@@ -44,7 +44,7 @@ function addCardsEditorConfig(basePath, simulate, skipInstall) {
         const logger = (0, tracing_1.getLogger)();
         try {
             logger.debug(`Called add cards-editor-config for path '${basePath}', simulate is '${simulate}'`);
-            (0, validation_1.validateBasePath)(basePath);
+            yield (0, validation_1.validateBasePath)(basePath);
             const fs = yield (0, cards_editor_config_writer_1.enableCardsEditor)(basePath);
             if (!simulate) {
                 yield new Promise((resolve) => fs.commit(resolve));

package/dist/cli/add/html.d.ts

@@ -0,0 +1,8 @@
+import type { Command } from 'commander';
+/**
+ * Adds a command to add the virtual html files hosted by the preview middleware to the file system.
+ *
+ * @param cmd - commander command for adding navigation inbounds config command
+ */
+export declare function addLocalHtmlFiles(cmd: Command): void;
+//# sourceMappingURL=html.d.ts.map

package/dist/cli/add/html.js

@@ -0,0 +1,70 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addLocalHtmlFiles = void 0;
+const tracing_1 = require("../../tracing");
+const validation_1 = require("../../validation");
+const preview_middleware_1 = require("@sap-ux/preview-middleware");
+const path_1 = require("path");
+const ui5_config_1 = require("@sap-ux/ui5-config");
+const mem_fs_editor_1 = require("mem-fs-editor");
+const mem_fs_1 = require("mem-fs");
+/**
+ * Adds a command to add the virtual html files hosted by the preview middleware to the file system.
+ *
+ * @param cmd - commander command for adding navigation inbounds config command
+ */
+function addLocalHtmlFiles(cmd) {
+    cmd.command('html [path]')
+        .option('-c, --config <string>', 'Path to project configuration file in YAML format', 'ui5.yaml')
+        .option('-s, --simulate', 'simulate only do not write config; sets also --verbose')
+        .option('-v, --verbose', 'show verbose information')
+        .action((path, options) => __awaiter(this, void 0, void 0, function* () {
+        if (options.verbose === true || options.simulate) {
+            (0, tracing_1.setLogLevelVerbose)();
+        }
+        yield addHtmlFiles(path || process.cwd(), !!options.simulate, options.config);
+    }));
+}
+exports.addLocalHtmlFiles = addLocalHtmlFiles;
+/**
+ * Adds the virtual html files hosted by the preview middleware to the file system.
+ *
+ * @param basePath - path to application root
+ * @param simulate - if true, do not write but just show what would be change; otherwise write
+ * @param yamlPath - path to the ui5*.yaml file
+ */
+function addHtmlFiles(basePath, simulate, yamlPath) {
+    var _a, _b;
+    return __awaiter(this, void 0, void 0, function* () {
+        const logger = (0, tracing_1.getLogger)();
+        try {
+            logger.debug(`Called add html for path '${basePath}', simulate is '${simulate}'`);
+            const ui5ConfigPath = (0, path_1.isAbsolute)(yamlPath) ? yamlPath : (0, path_1.join)(basePath, yamlPath);
+            yield (0, validation_1.validateBasePath)(basePath, ui5ConfigPath);
+            const fs = (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
+            const ui5Conf = yield ui5_config_1.UI5Config.newInstance(fs.read(ui5ConfigPath));
+            const preview = (_a = ui5Conf.findCustomMiddleware('fiori-tools-preview')) !== null && _a !== void 0 ? _a : ui5Conf.findCustomMiddleware('preview-middleware');
+            yield (0, preview_middleware_1.generatePreviewFiles)(basePath, (_b = preview === null || preview === void 0 ? void 0 : preview.configuration) !== null && _b !== void 0 ? _b : {}, fs, logger);
+            if (!simulate) {
+                yield new Promise((resolve) => fs.commit(resolve));
+            }
+            else {
+                yield (0, tracing_1.traceChanges)(fs);
+            }
+        }
+        catch (error) {
+            logger.error(`Error while executing add html '${error.message}'`);
+            logger.debug(error);
+        }
+    });
+}
+//# sourceMappingURL=html.js.map

package/dist/cli/add/index.js

@@ -7,6 +7,7 @@ const smartlinks_config_1 = require("./smartlinks-config");
 const cds_plugin_ui_1 = require("./cds-plugin-ui");
 const navigation_config_1 = require("./navigation-config");
 const cards_editor_1 = require("./cards-editor");
+const html_1 = require("./html");
 /**
  * Return 'create-fiori add *' commands. Commands include also the handler action.
  *
@@ -24,6 +25,8 @@ function getAddCommands() {
     (0, navigation_config_1.addInboundNavigationConfigCommand)(addCommands);
     // create-fiori add cards-editor
     (0, cards_editor_1.addCardsEditorConfigCommand)(addCommands);
+    // create-fiori add html
+    (0, html_1.addLocalHtmlFiles)(addCommands);
     return addCommands;
 }
 exports.getAddCommands = getAddCommands;

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

@@ -49,7 +49,7 @@ function addMockserverConfig(basePath, simulate, skipInstall, interactive) {
         const logger = (0, tracing_1.getLogger)();
         try {
             logger.debug(`Called add mockserver-config for path '${basePath}', simulate is '${simulate}', skip install is '${skipInstall}'`);
-            (0, validation_1.validateBasePath)(basePath);
+            yield (0, validation_1.validateBasePath)(basePath);
             const webappPath = yield (0, project_access_1.getWebappPath)(basePath);
             const config = { webappPath };
             if (interactive) {

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

@@ -41,7 +41,7 @@ function addInboundNavigationConfig(basePath, simulate) {
         const logger = (0, tracing_1.getLogger)();
         try {
             logger.debug(`Called add inbound navigation-config for path '${basePath}', simulate is '${simulate}'`);
-            (0, validation_1.validateBasePath)(basePath);
+            yield (0, validation_1.validateBasePath)(basePath);
             const { config, fs } = yield (0, app_config_writer_1.promptInboundNavigationConfig)(basePath);
             if (config) {
                 yield (0, app_config_writer_1.generateInboundNavigationConfig)(basePath, config, true, fs);

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

@@ -41,7 +41,7 @@ function addSmartLinksConfig(basePath, simulate) {
         const logger = (0, tracing_1.getLogger)();
         try {
             logger.debug(`Called add smartlinks-config for path '${basePath}', simulate is '${simulate}'`);
-            (0, validation_1.validateBasePath)(basePath);
+            yield (0, validation_1.validateBasePath)(basePath);
             const config = yield (0, app_config_writer_1.getSmartLinksTargetFromPrompt)(basePath, logger);
             const fs = yield (0, app_config_writer_1.generateSmartLinksConfig)(basePath, config, logger);
             yield (0, tracing_1.traceChanges)(fs);

package/dist/cli/remove/mockserver-config.js

@@ -45,7 +45,7 @@ function removeMockserverConfiguration(basePath, force) {
         const logger = (0, tracing_1.getLogger)();
         try {
             logger.debug(`Called remove mockserver-config for path '${basePath}', force is '${force}'`);
-            (0, validation_1.validateBasePath)(basePath);
+            yield (0, validation_1.validateBasePath)(basePath);
             const fs = (0, mockserver_config_writer_1.removeMockserverConfig)(basePath);
             yield (0, tracing_1.traceChanges)(fs);
             const hasDeletions = (0, validation_1.hasFileDeletes)(fs);

package/dist/validation/validation.d.ts

@@ -3,8 +3,9 @@ import type { Editor } from 'mem-fs-editor';
  * Validate base path of app, throw error if file is missing.
  *
  * @param basePath - base path of the app, where package.json and ui5.yaml resides
+ * @param ui5YamlPath - optional path to ui5.yaml file
  */
-export declare function validateBasePath(basePath: string): void;
+export declare function validateBasePath(basePath: string, ui5YamlPath?: string): Promise<void>;
 /**
  * Return if an instance of mem-fs editor recorded any deletion.
  *

package/dist/validation/validation.js

@@ -1,23 +1,36 @@
 "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());
+    });
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.hasFileDeletes = exports.validateBasePath = void 0;
+const project_access_1 = require("@sap-ux/project-access");
 const fs_1 = require("fs");
 const path_1 = require("path");
 /**
  * Validate base path of app, throw error if file is missing.
  *
  * @param basePath - base path of the app, where package.json and ui5.yaml resides
+ * @param ui5YamlPath - optional path to ui5.yaml file
  */
-function validateBasePath(basePath) {
-    const packageJsonPath = (0, path_1.join)(basePath, 'package.json');
-    if (!(0, fs_1.existsSync)(packageJsonPath)) {
-        throw Error(`Required file '${packageJsonPath}' does not exist.`);
-    }
-    const ui5YamlPath = (0, path_1.join)(basePath, 'ui5.yaml');
-    const webappPath = (0, path_1.join)(basePath, 'webapp');
-    if (!(0, fs_1.existsSync)(ui5YamlPath) && !(0, fs_1.existsSync)(webappPath)) {
-        throw Error(`There must be either a folder '${webappPath}' or a config file '${ui5YamlPath}'`);
-    }
+function validateBasePath(basePath, ui5YamlPath) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const packageJsonPath = (0, path_1.join)(basePath, 'package.json');
+        if (!(0, fs_1.existsSync)(packageJsonPath)) {
+            throw Error(`Required file '${packageJsonPath}' does not exist.`);
+        }
+        ui5YamlPath !== null && ui5YamlPath !== void 0 ? ui5YamlPath : (ui5YamlPath = (0, path_1.join)(basePath, 'ui5.yaml'));
+        const webappPath = yield (0, project_access_1.getWebappPath)(basePath);
+        if (!(0, fs_1.existsSync)(ui5YamlPath) && !(0, fs_1.existsSync)(webappPath)) {
+            throw Error(`There must be either a folder '${webappPath}' or a config file '${ui5YamlPath}'`);
+        }
+    });
 }
 exports.validateBasePath = validateBasePath;
 /**

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/create",
   "description": "SAP Fiori tools module to add or remove features",
-  "version": "0.5.114",
+  "version": "0.6.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -37,9 +37,10 @@
     "@sap-ux/inquirer-common": "0.3.1",
     "@sap-ux/logger": "0.5.1",
     "@sap-ux/mockserver-config-writer": "0.5.8",
+    "@sap-ux/preview-middleware": "0.14.0",
     "@sap-ux/project-access": "1.22.3",
-    "@sap-ux/system-access": "0.4.5",
-    "@sap-ux/ui5-config": "0.22.10"
+    "@sap-ux/ui5-config": "0.22.10",
+    "@sap-ux/system-access": "0.4.5"
   },
   "devDependencies": {
     "@types/diff": "5.0.9",