@sap-ux/preview-middleware 0.14.0 → 0.15.0

package/dist/base/config.d.ts

@@ -1,5 +1,4 @@
-import type { Logger } from '@sap-ux/logger';
-import { ToolsLogger } from '@sap-ux/logger';
+import { ToolsLogger, type Logger } from '@sap-ux/logger';
 import type { App, FlpConfig, Intent, InternalTestConfig, MiddlewareConfig } from '../types';
 import { type Manifest, type UI5FlexLayer } from '@sap-ux/project-access';
 import { type Editor } from 'mem-fs-editor';
@@ -96,7 +95,7 @@ export declare function sanitizeConfig(config: MiddlewareConfig, logger: ToolsLo
  * @param app configuration for the preview
  * @param logger logger instance
  */
-export declare function addApp(templateConfig: TemplateConfig, manifest: Manifest, app: App, logger: Logger): Promise<void>;
+export declare function addApp(templateConfig: TemplateConfig, manifest: Partial<Manifest>, app: App, logger: Logger): Promise<void>;
 /**
  * Creates the configuration object for the sandbox.html template.
  *
@@ -104,7 +103,7 @@ export declare function addApp(templateConfig: TemplateConfig, manifest: Manifes
  * @param manifest application manifest
  * @returns configuration object for the sandbox.html template
  */
-export declare function createFlpTemplateConfig(config: FlpConfig, manifest: Manifest): TemplateConfig;
+export declare function createFlpTemplateConfig(config: FlpConfig, manifest: Partial<Manifest>): TemplateConfig;
 /**
  * Creates the configuration object for the test template.
  *

package/dist/base/config.js

@@ -162,18 +162,18 @@ function getFlexSettings() {
  * @param logger logger instance
  */
 function addApp(templateConfig, manifest, app, logger) {
-    var _a, _b, _c, _d, _e, _f;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
     return __awaiter(this, void 0, void 0, function* () {
-        const id = manifest['sap.app'].id;
-        (_a = app.intent) !== null && _a !== void 0 ? _a : (app.intent = {
+        const id = (_b = (_a = manifest['sap.app']) === null || _a === void 0 ? void 0 : _a.id) !== null && _b !== void 0 ? _b : '';
+        (_c = app.intent) !== null && _c !== void 0 ? _c : (app.intent = {
             object: id.replace(/\./g, ''),
             action: 'preview'
         });
         templateConfig.ui5.resources[id] = app.target;
-        templateConfig.apps[`${(_b = app.intent) === null || _b === void 0 ? void 0 : _b.object}-${(_c = app.intent) === null || _c === void 0 ? void 0 : _c.action}`] = {
-            title: (_d = (yield getI18nTextFromProperty(app.local, manifest['sap.app'].title, logger))) !== null && _d !== void 0 ? _d : id,
-            description: (_e = (yield getI18nTextFromProperty(app.local, manifest['sap.app'].description, logger))) !== null && _e !== void 0 ? _e : '',
-            additionalInformation: `SAPUI5.Component=${(_f = app.componentId) !== null && _f !== void 0 ? _f : id}`,
+        templateConfig.apps[`${(_d = app.intent) === null || _d === void 0 ? void 0 : _d.object}-${(_e = app.intent) === null || _e === void 0 ? void 0 : _e.action}`] = {
+            title: (_g = (yield getI18nTextFromProperty(app.local, (_f = manifest['sap.app']) === null || _f === void 0 ? void 0 : _f.title, logger))) !== null && _g !== void 0 ? _g : id,
+            description: (_j = (yield getI18nTextFromProperty(app.local, (_h = manifest['sap.app']) === null || _h === void 0 ? void 0 : _h.description, logger))) !== null && _j !== void 0 ? _j : '',
+            additionalInformation: `SAPUI5.Component=${(_k = app.componentId) !== null && _k !== void 0 ? _k : id}`,
             applicationType: 'URL',
             url: app.target,
             applicationDependencies: { manifest: true }
@@ -216,14 +216,14 @@ function getI18nTextFromProperty(projectRoot, propertyValue, logger) {
  * @returns configuration object for the sandbox.html template
  */
 function createFlpTemplateConfig(config, manifest) {
-    var _a, _b, _c, _d;
+    var _a, _b, _c, _d, _e, _f;
     const flex = getFlexSettings();
     const supportedThemes = (_b = (_a = manifest['sap.ui5']) === null || _a === void 0 ? void 0 : _a.supportedThemes) !== null && _b !== void 0 ? _b : [exports.DEFAULT_THEME];
     const ui5Theme = (_c = config.theme) !== null && _c !== void 0 ? _c : (supportedThemes.includes(exports.DEFAULT_THEME) ? exports.DEFAULT_THEME : supportedThemes[0]);
-    const id = manifest['sap.app'].id;
+    const id = (_e = (_d = manifest['sap.app']) === null || _d === void 0 ? void 0 : _d.id) !== null && _e !== void 0 ? _e : '';
     const ns = id.replace(/\./g, '/');
     return {
-        basePath: (_d = path_1.posix.relative(path_1.posix.dirname(config.path), '/')) !== null && _d !== void 0 ? _d : '.',
+        basePath: (_f = path_1.posix.relative(path_1.posix.dirname(config.path), '/')) !== null && _f !== void 0 ? _f : '.',
         apps: {},
         init: config.init ? ns + config.init : undefined,
         ui5: {
@@ -287,6 +287,34 @@ function getPreviewPaths(config, logger = new logger_1.ToolsLogger()) {
     return urls;
 }
 exports.getPreviewPaths = getPreviewPaths;
+const TEMPLATE_PATH = (0, path_1.join)(__dirname, '../../templates');
+/**
+ * Generate test runners.
+ *
+ * @param configs array of test configurations
+ * @param manifest application manifest
+ * @param fs mem fs editor instance
+ * @param webappPath webapp path
+ * @param flpTemplConfig FLP configuration
+ */
+function generateTestRunners(configs, manifest, fs, webappPath, flpTemplConfig) {
+    for (const test of configs !== null && configs !== void 0 ? configs : []) {
+        const testConfig = (0, test_1.mergeTestConfigDefaults)(test);
+        if (['QUnit', 'OPA5'].includes(test.framework)) {
+            const testTemlpate = (0, fs_1.readFileSync)((0, path_1.join)(TEMPLATE_PATH, 'test/qunit.html'), 'utf-8');
+            const testTemplateConfig = createTestTemplateConfig(testConfig, manifest['sap.app'].id);
+            fs.write((0, path_1.join)(webappPath, testConfig.path), (0, ejs_1.render)(testTemlpate, testTemplateConfig));
+        }
+        else if (test.framework === 'Testsuite') {
+            const testTemlpate = (0, fs_1.readFileSync)((0, path_1.join)(TEMPLATE_PATH, 'test/testsuite.qunit.html'), 'utf-8');
+            const testTemplateConfig = {
+                basePath: flpTemplConfig.basePath,
+                initPath: testConfig.init
+            };
+            fs.write((0, path_1.join)(webappPath, testConfig.path), (0, ejs_1.render)(testTemlpate, testTemplateConfig));
+        }
+    }
+}
 /**
  * Generates the preview files.
  *
@@ -304,38 +332,45 @@ function generatePreviewFiles(basePath, config, fs, logger = new logger_1.ToolsL
         if (!fs) {
             fs = (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
         }
-        const templatePath = (0, path_1.join)(__dirname, '../../templates');
-        const webappPath = yield (0, project_access_1.getWebappPath)(basePath, fs);
-        const manifest = (yield fs.readJSON((0, path_1.join)(webappPath, 'manifest.json')));
         // generate FLP configuration
+        const flpTemplate = (0, fs_1.readFileSync)((0, path_1.join)(TEMPLATE_PATH, 'flp/sandbox.html'), 'utf-8');
         const flpConfig = getFlpConfigWithDefaults(config.flp);
-        const flpTemplate = (0, fs_1.readFileSync)((0, path_1.join)(templatePath, 'flp/sandbox.html'), 'utf-8');
-        const flpTemplConfig = createFlpTemplateConfig(flpConfig, manifest);
-        yield addApp(flpTemplConfig, manifest, {
-            target: flpTemplConfig.basePath,
-            local: '.',
-            intent: flpConfig.intent
-        }, logger);
-        fs.write((0, path_1.join)(webappPath, flpConfig.path), (0, ejs_1.render)(flpTemplate, flpTemplConfig));
-        // optional test files
-        if (config.test) {
-            for (const test of config.test) {
-                const testConfig = (0, test_1.mergeTestConfigDefaults)(test);
-                if (['QUnit', 'OPA5'].includes(test.framework)) {
-                    const testTemlpate = (0, fs_1.readFileSync)((0, path_1.join)(templatePath, 'test/qunit.html'), 'utf-8');
-                    const testTemplateConfig = createTestTemplateConfig(testConfig, manifest['sap.app'].id);
-                    fs.write((0, path_1.join)(webappPath, testConfig.path), (0, ejs_1.render)(testTemlpate, testTemplateConfig));
-                }
-                else if (test.framework === 'Testsuite') {
-                    const testTemlpate = (0, fs_1.readFileSync)((0, path_1.join)(templatePath, 'test/testsuite.qunit.html'), 'utf-8');
-                    const testTemplateConfig = {
-                        basePath: flpTemplConfig.basePath,
-                        initPath: testConfig.init
-                    };
-                    fs.write((0, path_1.join)(webappPath, testConfig.path), (0, ejs_1.render)(testTemlpate, testTemplateConfig));
+        const webappPath = yield (0, project_access_1.getWebappPath)(basePath, fs);
+        let manifest;
+        if (fs.exists((0, path_1.join)(webappPath, 'manifest.json'))) {
+            manifest = (yield fs.readJSON((0, path_1.join)(webappPath, 'manifest.json')));
+        }
+        let flpTemplConfig;
+        let flpPath;
+        if (manifest) {
+            flpTemplConfig = createFlpTemplateConfig(flpConfig, manifest);
+            flpPath = (0, path_1.join)(webappPath, flpConfig.path);
+            yield addApp(flpTemplConfig, manifest, {
+                target: flpTemplConfig.basePath,
+                local: '.',
+                intent: flpConfig.intent
+            }, logger);
+            generateTestRunners(config.test, manifest, fs, webappPath, flpTemplConfig);
+        }
+        else {
+            flpTemplConfig = createFlpTemplateConfig(flpConfig, {});
+            flpPath = (0, path_1.join)(basePath, flpConfig.path);
+        }
+        if (flpConfig.apps.length > 0) {
+            for (const app of flpConfig.apps) {
+                if (app.local) {
+                    const appPath = yield (0, project_access_1.getWebappPath)((0, path_1.join)(basePath, app.local), fs);
+                    if (fs.exists((0, path_1.join)(appPath, 'manifest.json'))) {
+                        const appManifest = (yield fs.readJSON((0, path_1.join)(appPath, 'manifest.json')));
+                        yield addApp(flpTemplConfig, appManifest, app, logger);
+                    }
+                    else {
+                        logger.warn(`Could not add route for ${app}`);
+                    }
                 }
             }
         }
+        fs.write(flpPath, (0, ejs_1.render)(flpTemplate, flpTemplConfig));
         return fs;
     });
 }

package/package.json

@@ -9,7 +9,7 @@
   "bugs": {
     "url": "https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Apreview-middleware"
   },
-  "version": "0.14.0",
+  "version": "0.15.0",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -26,9 +26,9 @@
     "mem-fs": "2.1.0",
     "mem-fs-editor": "9.4.0",
     "@sap-ux/logger": "0.5.1",
+    "@sap-ux/btp-utils": "0.14.4",
     "@sap-ux/adp-tooling": "0.11.7",
     "@sap-ux/control-property-editor-sources": "npm:@sap-ux/control-property-editor@0.4.23",
-    "@sap-ux/btp-utils": "0.14.4",
     "@sap-ux/project-access": "1.22.3"
   },
   "devDependencies": {
@@ -45,11 +45,11 @@
     "supertest": "6.3.3",
     "@sap-ux-private/playwright": "0.0.3",
     "dotenv": "16.3.1",
-    "@sap-ux/axios-extension": "1.14.2",
     "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@0.9.16",
+    "@sap-ux/axios-extension": "1.14.2",
     "@sap-ux/store": "0.6.0",
-    "@sap-ux/i18n": "0.0.7",
-    "@sap-ux/ui5-info": "0.5.0"
+    "@sap-ux/ui5-info": "0.5.0",
+    "@sap-ux/i18n": "0.0.7"
   },
   "peerDependencies": {
     "express": "4"