@sap-ux/preview-middleware 0.15.8 → 0.16.2

package/dist/base/config.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.generatePreviewFiles = exports.getPreviewPaths = exports.createTestTemplateConfig = exports.createFlpTemplateConfig = exports.addApp = exports.sanitizeConfig = exports.getFlpConfigWithDefaults = exports.DEFAULT_INTENT = exports.DEFAULT_PATH = exports.DEFAULT_THEME = exports.PREVIEW_URL = void 0;
 const logger_1 = require("@sap-ux/logger");
@@ -78,8 +69,7 @@ const UI5_LIBS = [
  * @returns UI5 libs that should preloaded
  */
 function getUI5Libs(manifest) {
-    var _a, _b, _c;
-    const libs = (_c = (_b = (_a = manifest['sap.ui5']) === null || _a === void 0 ? void 0 : _a.dependencies) === null || _b === void 0 ? void 0 : _b.libs) !== null && _c !== void 0 ? _c : {};
+    const libs = manifest['sap.ui5']?.dependencies?.libs ?? {};
     // add libs that should always be preloaded
     libs['sap.m'] = {};
     libs['sap.ui.core'] = {};
@@ -99,11 +89,10 @@ function getUI5Libs(manifest) {
  * @returns a full configuration with default values
  */
 function getFlpConfigWithDefaults(config = {}) {
-    var _a, _b, _c;
     const flpConfig = {
-        path: (_a = config.path) !== null && _a !== void 0 ? _a : exports.DEFAULT_PATH,
-        intent: (_b = config.intent) !== null && _b !== void 0 ? _b : exports.DEFAULT_INTENT,
-        apps: (_c = config.apps) !== null && _c !== void 0 ? _c : [],
+        path: config.path ?? exports.DEFAULT_PATH,
+        intent: config.intent ?? exports.DEFAULT_INTENT,
+        apps: config.apps ?? [],
         libs: config.libs,
         theme: config.theme,
         init: config.init
@@ -161,24 +150,21 @@ function getFlexSettings() {
  * @param app configuration for the preview
  * @param logger logger instance
  */
-function addApp(templateConfig, manifest, app, logger) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
-    return __awaiter(this, void 0, void 0, function* () {
-        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[`${(_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 }
-        };
-    });
+async function addApp(templateConfig, manifest, app, logger) {
+    const id = manifest['sap.app']?.id ?? '';
+    app.intent ??= {
+        object: id.replace(/\./g, ''),
+        action: 'preview'
+    };
+    templateConfig.ui5.resources[id] = app.target;
+    templateConfig.apps[`${app.intent?.object}-${app.intent?.action}`] = {
+        title: (await getI18nTextFromProperty(app.local, manifest['sap.app']?.title, logger)) ?? id,
+        description: (await getI18nTextFromProperty(app.local, manifest['sap.app']?.description, logger)) ?? '',
+        additionalInformation: `SAPUI5.Component=${app.componentId ?? id}`,
+        applicationType: 'URL',
+        url: app.target,
+        applicationDependencies: { manifest: true }
+    };
 }
 exports.addApp = addApp;
 /**
@@ -189,24 +175,21 @@ exports.addApp = addApp;
  * @param logger logger instance
  * @returns i18n text of the property
  */
-function getI18nTextFromProperty(projectRoot, propertyValue, logger) {
-    var _a, _b, _c, _d;
-    return __awaiter(this, void 0, void 0, function* () {
-        //i18n model format could be {{key}} or {i18n>key}
-        if (!projectRoot || !propertyValue || propertyValue.search(/{{\w+}}|{i18n>\w+}/g) === -1) {
-            return propertyValue;
-        }
-        const propertyI18nKey = propertyValue.replace(/i18n>|[{}]/g, '');
-        const projectAccess = yield (0, project_access_1.createProjectAccess)(projectRoot);
-        try {
-            const bundle = (yield projectAccess.getApplication('').getI18nBundles())['sap.app'];
-            return (_d = (_c = (_b = (_a = bundle[propertyI18nKey]) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.value) === null || _c === void 0 ? void 0 : _c.value) !== null && _d !== void 0 ? _d : propertyI18nKey;
-        }
-        catch (e) {
-            logger.warn('Failed to load i18n properties bundle');
-        }
-        return propertyI18nKey;
-    });
+async function getI18nTextFromProperty(projectRoot, propertyValue, logger) {
+    //i18n model format could be {{key}} or {i18n>key}
+    if (!projectRoot || !propertyValue || propertyValue.search(/{{\w+}}|{i18n>\w+}/g) === -1) {
+        return propertyValue;
+    }
+    const propertyI18nKey = propertyValue.replace(/i18n>|[{}]/g, '');
+    const projectAccess = await (0, project_access_1.createProjectAccess)(projectRoot);
+    try {
+        const bundle = (await projectAccess.getApplication('').getI18nBundles())['sap.app'];
+        return bundle[propertyI18nKey]?.[0]?.value?.value ?? propertyI18nKey;
+    }
+    catch (e) {
+        logger.warn('Failed to load i18n properties bundle');
+    }
+    return propertyI18nKey;
 }
 /**
  * Creates the configuration object for the sandbox.html template.
@@ -216,14 +199,13 @@ function getI18nTextFromProperty(projectRoot, propertyValue, logger) {
  * @returns configuration object for the sandbox.html template
  */
 function createFlpTemplateConfig(config, manifest) {
-    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 = (_e = (_d = manifest['sap.app']) === null || _d === void 0 ? void 0 : _d.id) !== null && _e !== void 0 ? _e : '';
+    const supportedThemes = manifest['sap.ui5']?.supportedThemes ?? [exports.DEFAULT_THEME];
+    const ui5Theme = config.theme ?? (supportedThemes.includes(exports.DEFAULT_THEME) ? exports.DEFAULT_THEME : supportedThemes[0]);
+    const id = manifest['sap.app']?.id ?? '';
     const ns = id.replace(/\./g, '/');
     return {
-        basePath: (_f = path_1.posix.relative(path_1.posix.dirname(config.path), '/')) !== null && _f !== void 0 ? _f : '.',
+        basePath: path_1.posix.relative(path_1.posix.dirname(config.path), '/') ?? '.',
         apps: {},
         init: config.init ? ns + config.init : undefined,
         ui5: {
@@ -247,11 +229,10 @@ exports.createFlpTemplateConfig = createFlpTemplateConfig;
  * @returns configuration object for the test template
  */
 function createTestTemplateConfig(config, id) {
-    var _a;
     return {
         id,
         framework: config.framework,
-        basePath: (_a = path_1.posix.relative(path_1.posix.dirname(config.path), '/')) !== null && _a !== void 0 ? _a : '.',
+        basePath: path_1.posix.relative(path_1.posix.dirname(config.path), '/') ?? '.',
         initPath: path_1.posix.relative(path_1.posix.dirname(config.path), config.init)
     };
 }
@@ -264,7 +245,6 @@ exports.createTestTemplateConfig = createTestTemplateConfig;
  * @returns an array of preview paths
  */
 function getPreviewPaths(config, logger = new logger_1.ToolsLogger()) {
-    var _a;
     const urls = [];
     // remove incorrect configurations
     sanitizeConfig(config, logger);
@@ -272,7 +252,7 @@ function getPreviewPaths(config, logger = new logger_1.ToolsLogger()) {
     const flpConfig = getFlpConfigWithDefaults(config.flp);
     urls.push({ path: `${flpConfig.path}#${flpConfig.intent.object}-${flpConfig.intent.action}`, type: 'preview' });
     // add editor urls
-    if ((_a = config.rta) === null || _a === void 0 ? void 0 : _a.editors) {
+    if (config.rta?.editors) {
         config.rta.editors.forEach((editor) => {
             urls.push({ path: editor.path, type: 'editor' });
         });
@@ -298,7 +278,7 @@ const TEMPLATE_PATH = (0, path_1.join)(__dirname, '../../templates');
  * @param flpTemplConfig FLP configuration
  */
 function generateTestRunners(configs, manifest, fs, webappPath, flpTemplConfig) {
-    for (const test of configs !== null && configs !== void 0 ? configs : []) {
+    for (const test of 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');
@@ -324,55 +304,53 @@ function generateTestRunners(configs, manifest, fs, webappPath, flpTemplConfig)
  * @param logger logger instance
  * @returns a mem-fs editor with the preview files
  */
-function generatePreviewFiles(basePath, config, fs, logger = new logger_1.ToolsLogger()) {
-    return __awaiter(this, void 0, void 0, function* () {
-        // remove incorrect configurations
-        sanitizeConfig(config, logger);
-        // create file system if not provided
-        if (!fs) {
-            fs = (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
-        }
-        // 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 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}`);
-                    }
+async function generatePreviewFiles(basePath, config, fs, logger = new logger_1.ToolsLogger()) {
+    // remove incorrect configurations
+    sanitizeConfig(config, logger);
+    // create file system if not provided
+    if (!fs) {
+        fs = (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
+    }
+    // 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 webappPath = await (0, project_access_1.getWebappPath)(basePath, fs);
+    let manifest;
+    if (fs.exists((0, path_1.join)(webappPath, 'manifest.json'))) {
+        manifest = (await 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);
+        await 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 = await (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 = (await fs.readJSON((0, path_1.join)(appPath, 'manifest.json')));
+                    await 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;
-    });
+    }
+    fs.write(flpPath, (0, ejs_1.render)(flpTemplate, flpTemplConfig));
+    return fs;
 }
 exports.generatePreviewFiles = generatePreviewFiles;
 //# sourceMappingURL=config.js.map

package/dist/base/flex.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.deleteChange = exports.writeChange = exports.readChanges = void 0;
 const fs_1 = require("fs");
@@ -19,22 +10,20 @@ const path_1 = require("path");
  * @param logger logger instance
  * @returns object with the file name as key and the file content as value
  */
-function readChanges(project, logger) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const changes = {};
-        const files = yield project.byGlob('/**/changes/*.*');
-        for (const file of files) {
-            try {
-                const change = JSON.parse(yield file.getString());
-                changes[`sap.ui.fl.${(0, path_1.parse)(file.getName()).name}`] = change;
-                logger.debug(`Read change from ${file.getPath()}`);
-            }
-            catch (error) {
-                logger.warn(error.message);
-            }
+async function readChanges(project, logger) {
+    const changes = {};
+    const files = await project.byGlob('/**/changes/*.*');
+    for (const file of files) {
+        try {
+            const change = JSON.parse(await file.getString());
+            changes[`sap.ui.fl.${(0, path_1.parse)(file.getName()).name}`] = change;
+            logger.debug(`Read change from ${file.getPath()}`);
         }
-        return changes;
-    });
+        catch (error) {
+            logger.warn(error.message);
+        }
+    }
+    return changes;
 }
 exports.readChanges = readChanges;
 /**
@@ -73,8 +62,7 @@ exports.writeChange = writeChange;
  * @returns object with success flag and optional message
  */
 function deleteChange(data, webappPath, logger) {
-    var _a;
-    const fileName = (_a = data.fileName) === null || _a === void 0 ? void 0 : _a.replace('sap.ui.fl.', '');
+    const fileName = data.fileName?.replace('sap.ui.fl.', '');
     if (fileName) {
         const path = (0, path_1.join)(webappPath, 'changes');
         if ((0, fs_1.existsSync)(path)) {