@sap-ux/preview-middleware 0.15.8 → 0.16.2

package/dist/base/flp.js

@@ -1,13 +1,4 @@
 "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.initAdp = exports.FlpSandbox = void 0;
 const mem_fs_1 = require("mem-fs");
@@ -35,6 +26,15 @@ const DEFAULT_LIVERELOAD_PORT = 35729;
  * Class handling preview of a sandbox FLP.
  */
 class FlpSandbox {
+    project;
+    utils;
+    logger;
+    onChangeRequest;
+    templateConfig;
+    config;
+    rta;
+    test;
+    router;
     /**
      * Constructor setting defaults and keeping reference to workspace resources.
      *
@@ -68,35 +68,31 @@ class FlpSandbox {
      * @param componentId optional componentId e.g. for adaptation projects
      * @param resources optional additional resource mappings
      */
-    init(manifest, componentId, resources = {}) {
-        var _a, _b, _c;
-        var _d, _e;
-        return __awaiter(this, void 0, void 0, function* () {
-            this.createFlexHandler();
-            (_a = (_d = this.config).libs) !== null && _a !== void 0 ? _a : (_d.libs = yield this.hasLocateReuseLibsScript());
-            const id = manifest['sap.app'].id;
-            this.templateConfig = (0, config_1.createFlpTemplateConfig)(this.config, manifest);
-            yield (0, config_1.addApp)(this.templateConfig, manifest, {
-                componentId,
-                target: (_b = resources[componentId !== null && componentId !== void 0 ? componentId : id]) !== null && _b !== void 0 ? _b : this.templateConfig.basePath,
-                local: '.',
-                intent: this.config.intent
-            }, this.logger);
-            this.addStandardRoutes();
-            if (this.rta) {
-                (_c = (_e = this.rta).options) !== null && _c !== void 0 ? _c : (_e.options = {});
-                this.rta.options.baseId = componentId !== null && componentId !== void 0 ? componentId : id;
-                this.rta.options.appName = id;
-                this.addEditorRoutes(this.rta);
-            }
-            if (this.test) {
-                this.addTestRoutes(this.test.filter((config) => config.framework !== 'Testsuite'), id);
-                this.createTestSuite(this.test);
-            }
-            yield this.addRoutesForAdditionalApps();
-            this.logger.info(`Initialized for app ${id}`);
-            this.logger.debug(`Configured apps: ${JSON.stringify(this.templateConfig.apps)}`);
-        });
+    async init(manifest, componentId, resources = {}) {
+        this.createFlexHandler();
+        this.config.libs ??= await this.hasLocateReuseLibsScript();
+        const id = manifest['sap.app'].id;
+        this.templateConfig = (0, config_1.createFlpTemplateConfig)(this.config, manifest);
+        await (0, config_1.addApp)(this.templateConfig, manifest, {
+            componentId,
+            target: resources[componentId ?? id] ?? this.templateConfig.basePath,
+            local: '.',
+            intent: this.config.intent
+        }, this.logger);
+        this.addStandardRoutes();
+        if (this.rta) {
+            this.rta.options ??= {};
+            this.rta.options.baseId = componentId ?? id;
+            this.rta.options.appName = id;
+            this.addEditorRoutes(this.rta);
+        }
+        if (this.test) {
+            this.addTestRoutes(this.test.filter((config) => config.framework !== 'Testsuite'), id);
+            this.createTestSuite(this.test);
+        }
+        await this.addRoutesForAdditionalApps();
+        this.logger.info(`Initialized for app ${id}`);
+        this.logger.debug(`Configured apps: ${JSON.stringify(this.templateConfig.apps)}`);
     }
     /**
      * Generates the FLP sandbox for an editor.
@@ -106,18 +102,23 @@ class FlpSandbox {
      * @returns FLP sandbox html
      */
     generateSandboxForEditor(rta, editor) {
-        var _a;
         const defaultGenerator = editor.developerMode
             ? '@sap-ux/control-property-editor'
             : '@sap-ux/preview-middleware';
-        const config = Object.assign({}, this.templateConfig);
+        const config = { ...this.templateConfig };
         /* sap.ui.rta needs to be added to the list of preload libs for variants management and adaptation projects */
         if (!config.ui5.libs.includes('sap.ui.rta')) {
             const libs = config.ui5.libs.split(',');
             libs.push('sap.ui.rta');
             config.ui5.libs = libs.join(',');
         }
-        config.flex = Object.assign(Object.assign({ layer: rta.layer }, rta.options), { generator: (_a = editor.generator) !== null && _a !== void 0 ? _a : defaultGenerator, developerMode: editor.developerMode === true, pluginScript: editor.pluginScript });
+        config.flex = {
+            layer: rta.layer,
+            ...rta.options,
+            generator: editor.generator ?? defaultGenerator,
+            developerMode: editor.developerMode === true,
+            pluginScript: editor.pluginScript
+        };
         if (editor.developerMode === true) {
             config.ui5.bootstrapOptions = serializeUi5Configuration(DEVELOPER_MODE_CONFIG);
         }
@@ -130,16 +131,14 @@ class FlpSandbox {
      * @param rta runtime authoring configuration
      */
     addEditorRoutes(rta) {
-        var _a;
         const cpe = (0, path_1.dirname)(require.resolve('@sap-ux/control-property-editor-sources'));
         for (const editor of rta.editors) {
             let previewUrl = editor.path;
             if (editor.developerMode) {
                 previewUrl = `${previewUrl}.inner.html`;
-                (_a = editor.pluginScript) !== null && _a !== void 0 ? _a : (editor.pluginScript = 'open/ux/preview/client/cpe/init');
-                this.router.get(editor.path, (_req, res) => __awaiter(this, void 0, void 0, function* () {
-                    var _b, _c, _d, _e;
-                    const scenario = (_b = rta.options) === null || _b === void 0 ? void 0 : _b.scenario;
+                editor.pluginScript ??= 'open/ux/preview/client/cpe/init';
+                this.router.get(editor.path, async (_req, res) => {
+                    const scenario = rta.options?.scenario;
                     let templatePreviewUrl = `${previewUrl}?sap-ui-xx-viewCache=false&fiori-tools-rta-mode=forAdaptation&sap-ui-rta-skip-flex-validation=true&sap-ui-xx-condense-changes=true#${this.config.intent.object}-${this.config.intent.action}`;
                     if (scenario === 'ADAPTATION_PROJECT') {
                         templatePreviewUrl = templatePreviewUrl.replace('?', `?sap-ui-layer=${rta.layer}&`);
@@ -148,17 +147,17 @@ class FlpSandbox {
                     const envPort = process.env.FIORI_TOOLS_LIVERELOAD_PORT;
                     let livereloadPort = envPort ? parseInt(envPort, 10) : DEFAULT_LIVERELOAD_PORT;
                     livereloadPort = isNaN(livereloadPort) ? DEFAULT_LIVERELOAD_PORT : livereloadPort;
-                    const envLivereloadUrl = (0, btp_utils_1.isAppStudio)() ? yield (0, btp_utils_1.exposePort)(livereloadPort) : undefined;
+                    const envLivereloadUrl = (0, btp_utils_1.isAppStudio)() ? await (0, btp_utils_1.exposePort)(livereloadPort) : undefined;
                     const html = (0, ejs_1.render)(template, {
                         previewUrl: templatePreviewUrl,
-                        telemetry: (_d = (_c = rta.options) === null || _c === void 0 ? void 0 : _c.telemetry) !== null && _d !== void 0 ? _d : false,
-                        appName: (_e = rta.options) === null || _e === void 0 ? void 0 : _e.appName,
+                        telemetry: rta.options?.telemetry ?? false,
+                        appName: rta.options?.appName,
                         scenario,
                         livereloadPort,
                         livereloadUrl: envLivereloadUrl
                     });
                     this.sendResponse(res, 'text/html', 200, html);
-                }));
+                });
                 let path = (0, path_1.dirname)(editor.path);
                 if (!path.endsWith('/')) {
                     path = `${path}/`;
@@ -178,9 +177,9 @@ class FlpSandbox {
         // register static client sources
         this.router.use(config_1.PREVIEW_URL.client.url, (0, express_1.static)(config_1.PREVIEW_URL.client.local));
         // add route for the sandbox.html
-        this.router.get(this.config.path, ((_req, res, next) => __awaiter(this, void 0, void 0, function* () {
+        this.router.get(this.config.path, (async (_req, res, next) => {
             // inform the user if a html file exists on the filesystem
-            const file = yield this.project.byPath(this.config.path);
+            const file = await this.project.byPath(this.config.path);
             if (file) {
                 this.logger.info(`HTML file returned at ${this.config.path} is loaded from the file system.`);
                 next();
@@ -190,49 +189,44 @@ class FlpSandbox {
                 const html = (0, ejs_1.render)(template, this.templateConfig);
                 this.sendResponse(res, 'text/html', 200, html);
             }
-        })));
+        }));
     }
     /**
      * Try finding a locate-reuse-libs script in the project.
      *
      * @returns the location of the locate-reuse-libs script or undefined.
      */
-    hasLocateReuseLibsScript() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const files = yield this.project.byGlob('**/locate-reuse-libs.js');
-            return files.length > 0;
-        });
+    async hasLocateReuseLibsScript() {
+        const files = await this.project.byGlob('**/locate-reuse-libs.js');
+        return files.length > 0;
     }
     /**
      * Add additional routes for apps also to be shown in the local FLP.
      */
-    addRoutesForAdditionalApps() {
-        var _a, _b;
-        return __awaiter(this, void 0, void 0, function* () {
-            for (const app of this.config.apps) {
-                let manifest;
-                if (app.local) {
-                    manifest = JSON.parse((0, fs_1.readFileSync)((0, path_1.join)(app.local, 'webapp/manifest.json'), 'utf-8'));
-                    this.router.use(app.target, (0, express_1.static)((0, path_1.join)(app.local, 'webapp')));
-                    this.logger.info(`Serving additional application at ${app.target} from ${app.local}`);
-                }
-                else if (app.componentId) {
-                    manifest = {
-                        'sap.app': {
-                            id: app.componentId,
-                            title: app.intent ? `${app.intent.object}-${app.intent.action}` : app.componentId
-                        }
-                    };
-                }
-                if (manifest) {
-                    yield (0, config_1.addApp)(this.templateConfig, manifest, app, this.logger);
-                    this.logger.info(`Adding additional intent: ${(_a = app.intent) === null || _a === void 0 ? void 0 : _a.object}-${(_b = app.intent) === null || _b === void 0 ? void 0 : _b.action}`);
-                }
-                else {
-                    this.logger.info(`Invalid application config for route ${app.target} because neither componentId nor local folder provided.`);
-                }
+    async addRoutesForAdditionalApps() {
+        for (const app of this.config.apps) {
+            let manifest;
+            if (app.local) {
+                manifest = JSON.parse((0, fs_1.readFileSync)((0, path_1.join)(app.local, 'webapp/manifest.json'), 'utf-8'));
+                this.router.use(app.target, (0, express_1.static)((0, path_1.join)(app.local, 'webapp')));
+                this.logger.info(`Serving additional application at ${app.target} from ${app.local}`);
             }
-        });
+            else if (app.componentId) {
+                manifest = {
+                    'sap.app': {
+                        id: app.componentId,
+                        title: app.intent ? `${app.intent.object}-${app.intent.action}` : app.componentId
+                    }
+                };
+            }
+            if (manifest) {
+                await (0, config_1.addApp)(this.templateConfig, manifest, app, this.logger);
+                this.logger.info(`Adding additional intent: ${app.intent?.object}-${app.intent?.action}`);
+            }
+            else {
+                this.logger.info(`Invalid application config for route ${app.target} because neither componentId nor local folder provided.`);
+            }
+        }
     }
     /**
      * Create required routes for flex.
@@ -241,24 +235,24 @@ class FlpSandbox {
         const fs = (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
         const api = `${config_1.PREVIEW_URL.api}/changes`;
         this.router.use(api, (0, express_1.json)());
-        this.router.get(api, ((_req, res) => __awaiter(this, void 0, void 0, function* () {
-            const changes = yield (0, flex_1.readChanges)(this.project, this.logger);
+        this.router.get(api, (async (_req, res) => {
+            const changes = await (0, flex_1.readChanges)(this.project, this.logger);
             if (this.onChangeRequest) {
                 for (const change of Object.values(changes)) {
-                    yield this.onChangeRequest('read', change, fs, this.logger);
+                    await this.onChangeRequest('read', change, fs, this.logger);
                 }
             }
             this.sendResponse(res, 'application/json', 200, JSON.stringify(changes));
-        })));
-        this.router.post(api, ((req, res) => __awaiter(this, void 0, void 0, function* () {
+        }));
+        this.router.post(api, (async (req, res) => {
             try {
                 const change = req.body;
                 if (this.onChangeRequest) {
-                    yield this.onChangeRequest('write', change, fs, this.logger);
+                    await this.onChangeRequest('write', change, fs, this.logger);
                 }
                 const { success, message } = (0, flex_1.writeChange)(change, this.utils.getProject().getSourcePath(), fs, this.logger);
                 if (success) {
-                    fs.commit(() => this.sendResponse(res, 'text/plain', 200, message !== null && message !== void 0 ? message : ''));
+                    fs.commit(() => this.sendResponse(res, 'text/plain', 200, message ?? ''));
                 }
                 else {
                     this.sendResponse(res, 'text/plain', 400, 'INVALID_DATA');
@@ -267,12 +261,12 @@ class FlpSandbox {
             catch (error) {
                 this.sendResponse(res, 'text/plain', 500, error.message);
             }
-        })));
-        this.router.delete(api, ((req, res) => __awaiter(this, void 0, void 0, function* () {
+        }));
+        this.router.delete(api, (async (req, res) => {
             try {
                 const { success, message } = (0, flex_1.deleteChange)(req.body, this.utils.getProject().getSourcePath(), this.logger);
                 if (success) {
-                    this.sendResponse(res, 'text/plain', 200, message !== null && message !== void 0 ? message : '');
+                    this.sendResponse(res, 'text/plain', 200, message ?? '');
                 }
                 else {
                     this.sendResponse(res, 'text/plain', 400, 'INVALID_DATA');
@@ -281,7 +275,7 @@ class FlpSandbox {
             catch (error) {
                 this.sendResponse(res, 'text/plain', 500, error.message);
             }
-        })));
+        }));
     }
     /**
      * If it is part of TestConfig, create a test suite for the test configurations.
@@ -303,7 +297,7 @@ class FlpSandbox {
         const initTemplate = (0, fs_1.readFileSync)((0, path_1.join)(__dirname, '../../templates/test/testsuite.qunit.js'), 'utf-8');
         const config = (0, test_1.mergeTestConfigDefaults)(testsuiteConfig);
         this.logger.debug(`Add route for ${config.path}`);
-        this.router.get(config.path, ((_req, res) => __awaiter(this, void 0, void 0, function* () {
+        this.router.get(config.path, (async (_req, res) => {
             this.logger.debug(`Serving test route: ${config.path}`);
             const templateConfig = {
                 basePath: this.templateConfig.basePath,
@@ -311,7 +305,7 @@ class FlpSandbox {
             };
             const html = (0, ejs_1.render)(testsuite, templateConfig);
             this.sendResponse(res, 'text/html', 200, html);
-        })));
+        }));
         if (testsuiteConfig.init !== undefined) {
             this.logger.debug(`Skip serving testsuite init script in favor of provided script: ${testsuiteConfig.init}`);
             return;
@@ -325,9 +319,9 @@ class FlpSandbox {
             testPaths.push(path_1.posix.relative(path_1.posix.dirname(config.path), mergedConfig.path));
         }
         this.logger.debug(`Add route for ${config.init}`);
-        this.router.get(config.init, ((_req, res, next) => __awaiter(this, void 0, void 0, function* () {
-            const files = yield this.project.byGlob(config.init.replace('.js', '.[jt]s'));
-            if ((files === null || files === void 0 ? void 0 : files.length) > 0) {
+        this.router.get(config.init, (async (_req, res, next) => {
+            const files = await this.project.byGlob(config.init.replace('.js', '.[jt]s'));
+            if (files?.length > 0) {
                 this.logger.warn(`Script returned at ${config.path} is loaded from the file system.`);
                 next();
             }
@@ -339,7 +333,7 @@ class FlpSandbox {
                 const js = (0, ejs_1.render)(initTemplate, templateConfig);
                 this.sendResponse(res, 'application/javascript', 200, js);
             }
-        })));
+        }));
     }
     /**
      * Send a response with the given content type, status and body.
@@ -372,9 +366,9 @@ class FlpSandbox {
             const config = (0, test_1.mergeTestConfigDefaults)(testConfig);
             this.logger.debug(`Add route for ${config.path}`);
             // add route for the *.qunit.html
-            this.router.get(config.path, ((_req, res, next) => __awaiter(this, void 0, void 0, function* () {
+            this.router.get(config.path, (async (_req, res, next) => {
                 this.logger.debug(`Serving test route: ${config.path}`);
-                const file = yield this.project.byPath(config.path);
+                const file = await this.project.byPath(config.path);
                 if (file) {
                     this.logger.warn(`HTML file returned at ${config.path} is loaded from the file system.`);
                     next();
@@ -384,27 +378,27 @@ class FlpSandbox {
                     const html = (0, ejs_1.render)(htmlTemplate, templateConfig);
                     this.sendResponse(res, 'text/html', 200, html);
                 }
-            })));
+            }));
             if (testConfig.init !== undefined) {
                 this.logger.debug(`Skip serving test init script in favor of provided script: ${testConfig.init}`);
                 continue;
             }
             // add route for the init file
             this.logger.debug(`Add route for ${config.init}`);
-            this.router.get(config.init, ((_req, res, next) => __awaiter(this, void 0, void 0, function* () {
+            this.router.get(config.init, (async (_req, res, next) => {
                 this.logger.debug(`Serving test init script: ${config.init}`);
-                const files = yield this.project.byGlob(config.init.replace('.js', '.[jt]s'));
-                if ((files === null || files === void 0 ? void 0 : files.length) > 0) {
+                const files = await this.project.byGlob(config.init.replace('.js', '.[jt]s'));
+                if (files?.length > 0) {
                     this.logger.warn(`Script returned at ${config.path} is loaded from the file system.`);
                     next();
                 }
                 else {
-                    const testFiles = yield this.project.byGlob(config.pattern);
+                    const testFiles = await this.project.byGlob(config.pattern);
                     const templateConfig = { tests: (0, test_1.generateImportList)(ns, testFiles) };
                     const js = (0, ejs_1.render)(initTemplate, templateConfig);
                     this.sendResponse(res, 'application/javascript', 200, js);
                 }
-            })));
+            }));
         }
     }
 }
@@ -442,34 +436,35 @@ function serializeUi5Configuration(config) {
  * @param util middleware utilities provided by the UI5 CLI
  * @param logger logger instance
  */
-function initAdp(rootProject, config, flp, util, logger) {
-    var _a;
-    return __awaiter(this, void 0, void 0, function* () {
-        const appVariant = yield rootProject.byPath('/manifest.appdescr_variant');
-        if (appVariant) {
-            const adp = new adp_tooling_1.AdpPreview(config, rootProject, util, logger);
-            const variant = JSON.parse(yield appVariant.getString());
-            const layer = yield adp.init(variant);
-            if (flp.rta) {
-                flp.rta.layer = layer;
-                flp.rta.options = Object.assign(Object.assign({}, flp.rta.options), { projectId: variant.id, scenario: 'ADAPTATION_PROJECT' });
-                for (const editor of flp.rta.editors) {
-                    (_a = editor.pluginScript) !== null && _a !== void 0 ? _a : (editor.pluginScript = 'open/ux/preview/client/adp/init');
-                }
+async function initAdp(rootProject, config, flp, util, logger) {
+    const appVariant = await rootProject.byPath('/manifest.appdescr_variant');
+    if (appVariant) {
+        const adp = new adp_tooling_1.AdpPreview(config, rootProject, util, logger);
+        const variant = JSON.parse(await appVariant.getString());
+        const layer = await adp.init(variant);
+        if (flp.rta) {
+            flp.rta.layer = layer;
+            flp.rta.options = {
+                ...flp.rta.options,
+                projectId: variant.id,
+                scenario: 'ADAPTATION_PROJECT'
+            };
+            for (const editor of flp.rta.editors) {
+                editor.pluginScript ??= 'open/ux/preview/client/adp/init';
             }
-            const descriptor = adp.descriptor;
-            descriptor.asyncHints.requests = [];
-            const { name, manifest } = descriptor;
-            yield flp.init(manifest, name, adp.resources);
-            flp.router.use(adp.descriptor.url, adp.proxy.bind(adp));
-            flp.addOnChangeRequestHandler(adp.onChangeRequest.bind(adp));
-            flp.router.use((0, express_1.json)());
-            adp.addApis(flp.router);
         }
-        else {
-            throw new Error('ADP configured but no manifest.appdescr_variant found.');
-        }
-    });
+        const descriptor = adp.descriptor;
+        descriptor.asyncHints.requests = [];
+        const { name, manifest } = descriptor;
+        await flp.init(manifest, name, adp.resources);
+        flp.router.use(adp.descriptor.url, adp.proxy.bind(adp));
+        flp.addOnChangeRequestHandler(adp.onChangeRequest.bind(adp));
+        flp.router.use((0, express_1.json)());
+        adp.addApis(flp.router);
+    }
+    else {
+        throw new Error('ADP configured but no manifest.appdescr_variant found.');
+    }
 }
 exports.initAdp = initAdp;
 //# sourceMappingURL=flp.js.map

package/dist/base/test.js

@@ -28,9 +28,8 @@ const DEFAULTS = {
  * @returns merged test configuration
  */
 function mergeTestConfigDefaults(config) {
-    var _a;
-    const defaults = (_a = DEFAULTS[config.framework.toLowerCase()]) !== null && _a !== void 0 ? _a : {};
-    const merged = Object.assign(Object.assign({}, defaults), config);
+    const defaults = DEFAULTS[config.framework.toLowerCase()] ?? {};
+    const merged = { ...defaults, ...config };
     if (!merged.path.startsWith('/')) {
         merged.path = `/${merged.path}`;
     }