@sap-ux/preview-middleware 0.13.74 → 0.14.0

package/dist/base/config.d.ts

@@ -0,0 +1,143 @@
+import type { Logger } from '@sap-ux/logger';
+import { ToolsLogger } 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';
+export interface CustomConnector {
+    applyConnector: string;
+    writeConnector: string;
+    custom: boolean;
+}
+export interface FlexConnector {
+    connector: string;
+    layers: string[];
+    url?: string;
+}
+/**
+ * Internal structure used to fill the sandbox.html template
+ */
+export interface TemplateConfig {
+    basePath: string;
+    apps: Record<string, {
+        title: string;
+        description: string;
+        additionalInformation: string;
+        applicationType: 'URL';
+        url: string;
+        applicationDependencies?: {
+            manifest: boolean;
+        };
+    }>;
+    ui5: {
+        libs: string;
+        theme: string;
+        flex: (CustomConnector | FlexConnector)[];
+        bootstrapOptions: string;
+        resources: Record<string, string>;
+    };
+    init?: string;
+    flex?: {
+        [key: string]: unknown;
+        layer: UI5FlexLayer;
+        developerMode: boolean;
+        pluginScript?: string;
+    };
+    locateReuseLibsScript?: boolean;
+}
+/**
+ * Static settings
+ */
+export declare const PREVIEW_URL: {
+    readonly client: {
+        readonly url: "/preview/client";
+        readonly local: string;
+        readonly ns: "open.ux.preview.client";
+    };
+    readonly api: "/preview/api";
+};
+/**
+ * Default theme
+ */
+export declare const DEFAULT_THEME = "sap_horizon";
+/**
+ * Default path for mounting the local FLP.
+ */
+export declare const DEFAULT_PATH = "/test/flp.html";
+/**
+ * Default intent
+ */
+export declare const DEFAULT_INTENT: Readonly<Intent>;
+/**
+ * Default configuration for the FLP.
+ *
+ * @param config partial configuration
+ * @returns a full configuration with default values
+ */
+export declare function getFlpConfigWithDefaults(config?: Partial<FlpConfig>): {
+    path: string;
+    intent: Readonly<Intent>;
+    apps: App[];
+    libs: boolean | undefined;
+    theme: string | undefined;
+    init: string | undefined;
+};
+/**
+ * The developer mode is only supported for adaptation projects, therefore, notify the user if it is wrongly configured and then disable it.
+ *
+ * @param config configurations from the ui5.yaml
+ * @param logger logger instance
+ */
+export declare function sanitizeConfig(config: MiddlewareConfig, logger: ToolsLogger): void;
+/**
+ * Add an application to the local FLP preview.
+ *
+ * @param templateConfig configuration for the preview
+ * @param manifest manifest of the additional target app
+ * @param app configuration for the preview
+ * @param logger logger instance
+ */
+export declare function addApp(templateConfig: TemplateConfig, manifest: Manifest, app: App, logger: Logger): Promise<void>;
+/**
+ * Creates the configuration object for the sandbox.html template.
+ *
+ * @param config FLP configuration
+ * @param manifest application manifest
+ * @returns configuration object for the sandbox.html template
+ */
+export declare function createFlpTemplateConfig(config: FlpConfig, manifest: Manifest): TemplateConfig;
+/**
+ * Creates the configuration object for the test template.
+ *
+ * @param config test configuration
+ * @param id application id
+ * @returns configuration object for the test template
+ */
+export declare function createTestTemplateConfig(config: InternalTestConfig, id: string): {
+    id: string;
+    framework: "OPA5" | "QUnit" | "Testsuite";
+    basePath: string;
+    initPath: string;
+};
+export type PreviewUrls = {
+    path: string;
+    type: 'preview' | 'editor' | 'test';
+};
+/**
+ * Returns the preview paths.
+ *
+ * @param config configuration from the ui5.yaml
+ * @param logger logger instance
+ * @returns an array of preview paths
+ */
+export declare function getPreviewPaths(config: MiddlewareConfig, logger?: ToolsLogger): PreviewUrls[];
+/**
+ * Generates the preview files.
+ *
+ * @param basePath path to the application root
+ * @param config configuration from the ui5.yaml
+ * @param fs file system editor
+ * @param logger logger instance
+ * @returns a mem-fs editor with the preview files
+ */
+export declare function generatePreviewFiles(basePath: string, config: MiddlewareConfig, fs?: Editor, logger?: ToolsLogger): Promise<Editor>;
+//# sourceMappingURL=config.d.ts.map

package/dist/base/config.js

@@ -0,0 +1,343 @@
+"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");
+const ejs_1 = require("ejs");
+const path_1 = require("path");
+const project_access_1 = require("@sap-ux/project-access");
+const fs_1 = require("fs");
+const test_1 = require("./test");
+const mem_fs_editor_1 = require("mem-fs-editor");
+const mem_fs_1 = require("mem-fs");
+/**
+ * Static settings
+ */
+exports.PREVIEW_URL = {
+    client: {
+        url: '/preview/client',
+        local: (0, path_1.join)(__dirname, '../../dist/client'),
+        ns: 'open.ux.preview.client'
+    },
+    api: '/preview/api'
+};
+/**
+ * Default theme
+ */
+exports.DEFAULT_THEME = 'sap_horizon';
+/**
+ * Default path for mounting the local FLP.
+ */
+exports.DEFAULT_PATH = '/test/flp.html';
+/**
+ * Default intent
+ */
+exports.DEFAULT_INTENT = {
+    object: 'app',
+    action: 'preview'
+};
+/**
+ * SAPUI5 delivered namespaces from https://ui5.sap.com/#/api/sap
+ */
+const UI5_LIBS = [
+    'sap.apf',
+    'sap.base',
+    'sap.chart',
+    'sap.collaboration',
+    'sap.f',
+    'sap.fe',
+    'sap.fileviewer',
+    'sap.gantt',
+    'sap.landvisz',
+    'sap.m',
+    'sap.ndc',
+    'sap.ovp',
+    'sap.rules',
+    'sap.suite',
+    'sap.tnt',
+    'sap.ui',
+    'sap.uiext',
+    'sap.ushell',
+    'sap.uxap',
+    'sap.viz',
+    'sap.webanalytics',
+    'sap.zen'
+];
+/**
+ * Gets the UI5 libs dependencies from manifest.json.
+ *
+ * @param manifest application manifest
+ * @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 : {};
+    // add libs that should always be preloaded
+    libs['sap.m'] = {};
+    libs['sap.ui.core'] = {};
+    libs['sap.ushell'] = {};
+    return Object.keys(libs)
+        .filter((key) => {
+        return UI5_LIBS.some((substring) => {
+            return key === substring || key.startsWith(substring + '.');
+        });
+    })
+        .join(',');
+}
+/**
+ * Default configuration for the FLP.
+ *
+ * @param config partial configuration
+ * @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 : [],
+        libs: config.libs,
+        theme: config.theme,
+        init: config.init
+    };
+    if (!flpConfig.path.startsWith('/')) {
+        flpConfig.path = `/${flpConfig.path}`;
+    }
+    return flpConfig;
+}
+exports.getFlpConfigWithDefaults = getFlpConfigWithDefaults;
+/**
+ * The developer mode is only supported for adaptation projects, therefore, notify the user if it is wrongly configured and then disable it.
+ *
+ * @param config configurations from the ui5.yaml
+ * @param logger logger instance
+ */
+function sanitizeConfig(config, logger) {
+    if (config.rta && config.adp === undefined) {
+        config.rta.editors = config.rta.editors.filter((editor) => {
+            if (editor.developerMode) {
+                logger.error('developerMode is ONLY supported for SAP UI5 adaptation projects.');
+                logger.warn(`developerMode for ${editor.path} disabled`);
+            }
+            return !editor.developerMode;
+        });
+    }
+}
+exports.sanitizeConfig = sanitizeConfig;
+/**
+ * Retrieves the configuration settings for UI5 flexibility services.
+ *
+ * @returns An array of flexibility service configurations, each specifying a connector
+ *          and its options, such as the layers it applies to and its service URL, if applicable.
+ */
+function getFlexSettings() {
+    const localConnectorPath = 'custom.connectors.WorkspaceConnector';
+    return [
+        { connector: 'LrepConnector', layers: [], url: '/sap/bc/lrep' },
+        {
+            applyConnector: localConnectorPath,
+            writeConnector: localConnectorPath,
+            custom: true
+        },
+        {
+            connector: 'LocalStorageConnector',
+            layers: ['CUSTOMER', 'USER']
+        }
+    ];
+}
+/**
+ * Add an application to the local FLP preview.
+ *
+ * @param templateConfig configuration for the preview
+ * @param manifest manifest of the additional target app
+ * @param app configuration for the preview
+ * @param logger logger instance
+ */
+function addApp(templateConfig, manifest, app, logger) {
+    var _a, _b, _c, _d, _e, _f;
+    return __awaiter(this, void 0, void 0, function* () {
+        const id = manifest['sap.app'].id;
+        (_a = app.intent) !== null && _a !== void 0 ? _a : (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}`,
+            applicationType: 'URL',
+            url: app.target,
+            applicationDependencies: { manifest: true }
+        };
+    });
+}
+exports.addApp = addApp;
+/**
+ * Get the i18n text of the given property.
+ *
+ * @param projectRoot absolute path to the project root
+ * @param propertyValue value of the property
+ * @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;
+    });
+}
+/**
+ * Creates the configuration object for the sandbox.html template.
+ *
+ * @param config FLP configuration
+ * @param manifest application manifest
+ * @returns configuration object for the sandbox.html template
+ */
+function createFlpTemplateConfig(config, manifest) {
+    var _a, _b, _c, _d;
+    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 ns = id.replace(/\./g, '/');
+    return {
+        basePath: (_d = path_1.posix.relative(path_1.posix.dirname(config.path), '/')) !== null && _d !== void 0 ? _d : '.',
+        apps: {},
+        init: config.init ? ns + config.init : undefined,
+        ui5: {
+            libs: getUI5Libs(manifest),
+            theme: ui5Theme,
+            flex,
+            resources: {
+                [exports.PREVIEW_URL.client.ns]: exports.PREVIEW_URL.client.url
+            },
+            bootstrapOptions: ''
+        },
+        locateReuseLibsScript: config.libs
+    };
+}
+exports.createFlpTemplateConfig = createFlpTemplateConfig;
+/**
+ * Creates the configuration object for the test template.
+ *
+ * @param config test configuration
+ * @param id application id
+ * @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 : '.',
+        initPath: path_1.posix.relative(path_1.posix.dirname(config.path), config.init)
+    };
+}
+exports.createTestTemplateConfig = createTestTemplateConfig;
+/**
+ * Returns the preview paths.
+ *
+ * @param config configuration from the ui5.yaml
+ * @param logger logger instance
+ * @returns an array of preview paths
+ */
+function getPreviewPaths(config, logger = new logger_1.ToolsLogger()) {
+    var _a;
+    const urls = [];
+    // remove incorrect configurations
+    sanitizeConfig(config, logger);
+    // add flp preview url
+    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) {
+        config.rta.editors.forEach((editor) => {
+            urls.push({ path: editor.path, type: 'editor' });
+        });
+    }
+    // add test urls if configured
+    if (config.test) {
+        config.test.forEach((test) => {
+            const testConfig = (0, test_1.mergeTestConfigDefaults)(test);
+            urls.push({ path: testConfig.path, type: 'test' });
+        });
+    }
+    return urls;
+}
+exports.getPreviewPaths = getPreviewPaths;
+/**
+ * Generates the preview files.
+ *
+ * @param basePath path to the application root
+ * @param config configuration from the ui5.yaml
+ * @param fs file system editor
+ * @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)());
+        }
+        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 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));
+                }
+            }
+        }
+        return fs;
+    });
+}
+exports.generatePreviewFiles = generatePreviewFiles;
+//# sourceMappingURL=config.js.map

package/dist/base/flp.d.ts

@@ -4,56 +4,16 @@ import type { Editor as MemFsEditor } from 'mem-fs-editor';
 import type { Router } from 'express';
 import type { Logger, ToolsLogger } from '@sap-ux/logger';
 import type { MiddlewareUtils } from '@ui5/server';
-import type { Manifest, UI5FlexLayer } from '@sap-ux/project-access';
+import type { Manifest } from '@sap-ux/project-access';
 import { type AdpPreviewConfig, type CommonChangeProperties, type OperationType } from '@sap-ux/adp-tooling';
-import type { App, FlpConfig, MiddlewareConfig, RtaConfig, TestConfig } from '../types';
+import type { FlpConfig, MiddlewareConfig, RtaConfig, TestConfig } from '../types';
+import { type TemplateConfig } from './config';
 /**
  * Enhanced request handler that exposes a list of endpoints for the cds-plugin-ui5.
  */
 export type EnhancedRouter = Router & {
     getAppPages?: () => string[];
 };
-export interface CustomConnector {
-    applyConnector: string;
-    writeConnector: string;
-    custom: boolean;
-}
-export interface FlexConnector {
-    connector: string;
-    layers: string[];
-    url?: string;
-}
-/**
- * Internal structure used to fill the sandbox.html template
- */
-export interface TemplateConfig {
-    basePath: string;
-    apps: Record<string, {
-        title: string;
-        description: string;
-        additionalInformation: string;
-        applicationType: 'URL';
-        url: string;
-        applicationDependencies?: {
-            manifest: boolean;
-        };
-    }>;
-    ui5: {
-        libs: string;
-        theme: string;
-        flex: (CustomConnector | FlexConnector)[];
-        bootstrapOptions: string;
-        resources: Record<string, string>;
-    };
-    init?: string;
-    flex?: {
-        [key: string]: unknown;
-        layer: UI5FlexLayer;
-        developerMode: boolean;
-        pluginScript?: string;
-    };
-    locateReuseLibsScript?: boolean;
-}
 type OnChangeRequestHandler = (type: OperationType, change: CommonChangeProperties, fs: MemFsEditor, logger: Logger) => Promise<void>;
 /**
  * Class handling preview of a sandbox FLP.
@@ -119,13 +79,6 @@ export declare class FlpSandbox {
      * Add additional routes for apps also to be shown in the local FLP.
      */
     private addRoutesForAdditionalApps;
-    /**
-     * Retrieves the configuration settings for UI5 flexibility services.
-     *
-     * @returns An array of flexibility service configurations, each specifying a connector
-     *          and its options, such as the layers it applies to and its service URL, if applicable.
-     */
-    private getFlexSettings;
     /**
      * Create required routes for flex.
      */
@@ -155,29 +108,6 @@ export declare class FlpSandbox {
      * @param id application id from manifest
      */
     private addTestRoutes;
-    /**
-     * Add an application to the local FLP preview.
-     *
-     * @param manifest manifest of the additional target app
-     * @param app configuration for the preview
-     */
-    addApp(manifest: Manifest, app: App): Promise<void>;
-    /**
-     * Get the i18n text of the given property.
-     *
-     * @param projectRoot absolute path to the project root
-     * @param propertyValue value of the property
-     * @returns i18n text of the property
-     * @private
-     */
-    private getI18nTextFromProperty;
-    /**
-     * Gets the UI5 libs dependencies from manifest.json.
-     *
-     * @param manifest application manifest
-     * @returns UI5 libs that should preloaded
-     */
-    private getUI5Libs;
 }
 /**
  * Initialize the preview for an adaptation project.

package/dist/base/flp.js

@@ -17,10 +17,10 @@ const fs_1 = require("fs");
 const path_1 = require("path");
 const express_1 = require("express");
 const adp_tooling_1 = require("@sap-ux/adp-tooling");
-const project_access_1 = require("@sap-ux/project-access");
 const btp_utils_1 = require("@sap-ux/btp-utils");
 const flex_1 = require("./flex");
 const test_1 = require("./test");
+const config_1 = require("./config");
 const DEVELOPER_MODE_CONFIG = new Map([
     // Run application in design time mode
     // Adds bindingString to BindingInfo objects. Required to create and read PropertyBinding changes
@@ -30,60 +30,7 @@ const DEVELOPER_MODE_CONFIG = new Map([
     // Make sure that XML preprocessing results are correctly invalidated
     ['xx-viewCache', 'false']
 ]);
-/**
- * SAPUI5 delivered namespaces from https://ui5.sap.com/#/api/sap
- */
-const UI5_LIBS = [
-    'sap.apf',
-    'sap.base',
-    'sap.chart',
-    'sap.collaboration',
-    'sap.f',
-    'sap.fe',
-    'sap.fileviewer',
-    'sap.gantt',
-    'sap.landvisz',
-    'sap.m',
-    'sap.ndc',
-    'sap.ovp',
-    'sap.rules',
-    'sap.suite',
-    'sap.tnt',
-    'sap.ui',
-    'sap.uiext',
-    'sap.ushell',
-    'sap.uxap',
-    'sap.viz',
-    'sap.webanalytics',
-    'sap.zen'
-];
 const DEFAULT_LIVERELOAD_PORT = 35729;
-/**
- * Default theme
- */
-const DEFAULT_THEME = 'sap_horizon';
-/**
- * Default path for mounting the local FLP.
- */
-const DEFAULT_PATH = '/test/flp.html';
-/**
- * Default intent
- */
-const DEFAULT_INTENT = {
-    object: 'app',
-    action: 'preview'
-};
-/**
- * Static settings
- */
-const PREVIEW_URL = {
-    client: {
-        url: '/preview/client',
-        local: (0, path_1.join)(__dirname, '../../dist/client'),
-        ns: 'open.ux.preview.client'
-    },
-    api: '/preview/api'
-};
 /**
  * Class handling preview of a sandbox FLP.
  */
@@ -97,21 +44,10 @@ class FlpSandbox {
      * @param logger logger instance
      */
     constructor(config, project, utils, logger) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j;
         this.project = project;
         this.utils = utils;
         this.logger = logger;
-        this.config = {
-            path: (_b = (_a = config.flp) === null || _a === void 0 ? void 0 : _a.path) !== null && _b !== void 0 ? _b : DEFAULT_PATH,
-            intent: (_d = (_c = config.flp) === null || _c === void 0 ? void 0 : _c.intent) !== null && _d !== void 0 ? _d : DEFAULT_INTENT,
-            apps: (_f = (_e = config.flp) === null || _e === void 0 ? void 0 : _e.apps) !== null && _f !== void 0 ? _f : [],
-            libs: (_g = config.flp) === null || _g === void 0 ? void 0 : _g.libs,
-            theme: (_h = config.flp) === null || _h === void 0 ? void 0 : _h.theme,
-            init: (_j = config.flp) === null || _j === void 0 ? void 0 : _j.init
-        };
-        if (!this.config.path.startsWith('/')) {
-            this.config.path = `/${this.config.path}`;
-        }
+        this.config = (0, config_1.getFlpConfigWithDefaults)(config.flp);
         this.test = config.test;
         this.rta = config.rta;
         logger.debug(`Config: ${JSON.stringify({ flp: this.config, rta: this.rta, test: this.test })}`);
@@ -133,37 +69,22 @@ class FlpSandbox {
      * @param resources optional additional resource mappings
      */
     init(manifest, componentId, resources = {}) {
-        var _a, _b, _c, _d, _e, _f, _g;
-        var _h;
+        var _a, _b, _c;
+        var _d, _e;
         return __awaiter(this, void 0, void 0, function* () {
             this.createFlexHandler();
-            const flex = this.getFlexSettings();
-            const supportedThemes = (_b = (_a = manifest['sap.ui5']) === null || _a === void 0 ? void 0 : _a.supportedThemes) !== null && _b !== void 0 ? _b : [DEFAULT_THEME];
-            const ui5Theme = (_c = this.config.theme) !== null && _c !== void 0 ? _c : (supportedThemes.includes(DEFAULT_THEME) ? DEFAULT_THEME : supportedThemes[0]);
+            (_a = (_d = this.config).libs) !== null && _a !== void 0 ? _a : (_d.libs = yield this.hasLocateReuseLibsScript());
             const id = manifest['sap.app'].id;
-            const ns = id.replace(/\./g, '/');
-            this.templateConfig = {
-                basePath: (_d = path_1.posix.relative(path_1.posix.dirname(this.config.path), '/')) !== null && _d !== void 0 ? _d : '.',
-                apps: {},
-                init: this.config.init ? ns + this.config.init : undefined,
-                ui5: {
-                    libs: this.getUI5Libs(manifest),
-                    theme: ui5Theme,
-                    flex,
-                    resources: Object.assign(Object.assign({}, resources), { [PREVIEW_URL.client.ns]: PREVIEW_URL.client.url }),
-                    bootstrapOptions: ''
-                },
-                locateReuseLibsScript: (_e = this.config.libs) !== null && _e !== void 0 ? _e : (yield this.hasLocateReuseLibsScript())
-            };
-            yield this.addApp(manifest, {
+            this.templateConfig = (0, config_1.createFlpTemplateConfig)(this.config, manifest);
+            yield (0, config_1.addApp)(this.templateConfig, manifest, {
                 componentId,
-                target: (_f = resources[componentId !== null && componentId !== void 0 ? componentId : id]) !== null && _f !== void 0 ? _f : this.templateConfig.basePath,
+                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) {
-                (_g = (_h = this.rta).options) !== null && _g !== void 0 ? _g : (_h.options = {});
+                (_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);
@@ -255,7 +176,7 @@ class FlpSandbox {
      */
     addStandardRoutes() {
         // register static client sources
-        this.router.use(PREVIEW_URL.client.url, (0, express_1.static)(PREVIEW_URL.client.local));
+        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* () {
             // inform the user if a html file exists on the filesystem
@@ -304,7 +225,7 @@ class FlpSandbox {
                     };
                 }
                 if (manifest) {
-                    yield this.addApp(manifest, app);
+                    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 {
@@ -313,33 +234,12 @@ class FlpSandbox {
             }
         });
     }
-    /**
-     * Retrieves the configuration settings for UI5 flexibility services.
-     *
-     * @returns An array of flexibility service configurations, each specifying a connector
-     *          and its options, such as the layers it applies to and its service URL, if applicable.
-     */
-    getFlexSettings() {
-        const localConnectorPath = 'custom.connectors.WorkspaceConnector';
-        return [
-            { connector: 'LrepConnector', layers: [], url: '/sap/bc/lrep' },
-            {
-                applyConnector: localConnectorPath,
-                writeConnector: localConnectorPath,
-                custom: true
-            },
-            {
-                connector: 'LocalStorageConnector',
-                layers: ['CUSTOMER', 'USER']
-            }
-        ];
-    }
     /**
      * Create required routes for flex.
      */
     createFlexHandler() {
         const fs = (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
-        const api = `${PREVIEW_URL.api}/changes`;
+        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);
@@ -473,7 +373,6 @@ class FlpSandbox {
             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* () {
-                var _a;
                 this.logger.debug(`Serving test route: ${config.path}`);
                 const file = yield this.project.byPath(config.path);
                 if (file) {
@@ -481,12 +380,7 @@ class FlpSandbox {
                     next();
                 }
                 else {
-                    const templateConfig = {
-                        id,
-                        framework: config.framework,
-                        basePath: (_a = path_1.posix.relative(path_1.posix.dirname(config.path), '/')) !== null && _a !== void 0 ? _a : '.',
-                        initPath: path_1.posix.relative(path_1.posix.dirname(config.path), config.init)
-                    };
+                    const templateConfig = (0, config_1.createTestTemplateConfig)(config, id);
                     const html = (0, ejs_1.render)(htmlTemplate, templateConfig);
                     this.sendResponse(res, 'text/html', 200, html);
                 }
@@ -513,80 +407,6 @@ class FlpSandbox {
             })));
         }
     }
-    /**
-     * Add an application to the local FLP preview.
-     *
-     * @param manifest manifest of the additional target app
-     * @param app configuration for the preview
-     */
-    addApp(manifest, app) {
-        var _a, _b, _c, _d, _e, _f;
-        return __awaiter(this, void 0, void 0, function* () {
-            const id = manifest['sap.app'].id;
-            (_a = app.intent) !== null && _a !== void 0 ? _a : (app.intent = {
-                object: id.replace(/\./g, ''),
-                action: 'preview'
-            });
-            this.templateConfig.ui5.resources[id] = app.target;
-            this.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 this.getI18nTextFromProperty(app.local, manifest['sap.app'].title))) !== null && _d !== void 0 ? _d : id,
-                description: (_e = (yield this.getI18nTextFromProperty(app.local, manifest['sap.app'].description))) !== null && _e !== void 0 ? _e : '',
-                additionalInformation: `SAPUI5.Component=${(_f = app.componentId) !== null && _f !== void 0 ? _f : id}`,
-                applicationType: 'URL',
-                url: app.target,
-                applicationDependencies: { manifest: true }
-            };
-        });
-    }
-    /**
-     * Get the i18n text of the given property.
-     *
-     * @param projectRoot absolute path to the project root
-     * @param propertyValue value of the property
-     * @returns i18n text of the property
-     * @private
-     */
-    getI18nTextFromProperty(projectRoot, propertyValue) {
-        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) {
-                this.logger.warn('Failed to load i18n properties bundle');
-            }
-            return propertyI18nKey;
-        });
-    }
-    /**
-     * Gets the UI5 libs dependencies from manifest.json.
-     *
-     * @param manifest application manifest
-     * @returns UI5 libs that should preloaded
-     */
-    getUI5Libs(manifest) {
-        var _a, _b;
-        if ((_b = (_a = manifest['sap.ui5']) === null || _a === void 0 ? void 0 : _a.dependencies) === null || _b === void 0 ? void 0 : _b.libs) {
-            const libNames = Object.keys(manifest['sap.ui5'].dependencies.libs);
-            return libNames
-                .filter((key) => {
-                return UI5_LIBS.some((substring) => {
-                    return key === substring || key.startsWith(substring + '.');
-                });
-            })
-                .join(',');
-        }
-        else {
-            return 'sap.m,sap.ui.core,sap.ushell';
-        }
-    }
 }
 exports.FlpSandbox = FlpSandbox;
 /**

package/dist/base/index.d.ts

@@ -1,2 +1,3 @@
 export { FlpSandbox, initAdp } from './flp';
+export { generatePreviewFiles, getPreviewPaths } from './config';
 //# sourceMappingURL=index.d.ts.map

package/dist/base/index.js

@@ -1,7 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.initAdp = exports.FlpSandbox = void 0;
+exports.getPreviewPaths = exports.generatePreviewFiles = exports.initAdp = exports.FlpSandbox = void 0;
 var flp_1 = require("./flp");
 Object.defineProperty(exports, "FlpSandbox", { enumerable: true, get: function () { return flp_1.FlpSandbox; } });
 Object.defineProperty(exports, "initAdp", { enumerable: true, get: function () { return flp_1.initAdp; } });
+var config_1 = require("./config");
+Object.defineProperty(exports, "generatePreviewFiles", { enumerable: true, get: function () { return config_1.generatePreviewFiles; } });
+Object.defineProperty(exports, "getPreviewPaths", { enumerable: true, get: function () { return config_1.getPreviewPaths; } });
 //# sourceMappingURL=index.js.map

package/dist/index.d.ts

@@ -1,4 +1,4 @@
 export * from './ui5/middleware';
-export { FlpSandbox, initAdp } from './base';
+export { FlpSandbox, initAdp, generatePreviewFiles, getPreviewPaths } from './base';
 export { FlpConfig, RtaConfig, TestConfig, MiddlewareConfig } from './types';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -14,9 +14,11 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.initAdp = exports.FlpSandbox = void 0;
+exports.getPreviewPaths = exports.generatePreviewFiles = exports.initAdp = exports.FlpSandbox = void 0;
 __exportStar(require("./ui5/middleware"), exports);
 var base_1 = require("./base");
 Object.defineProperty(exports, "FlpSandbox", { enumerable: true, get: function () { return base_1.FlpSandbox; } });
 Object.defineProperty(exports, "initAdp", { enumerable: true, get: function () { return base_1.initAdp; } });
+Object.defineProperty(exports, "generatePreviewFiles", { enumerable: true, get: function () { return base_1.generatePreviewFiles; } });
+Object.defineProperty(exports, "getPreviewPaths", { enumerable: true, get: function () { return base_1.getPreviewPaths; } });
 //# sourceMappingURL=index.js.map

package/dist/types/index.d.ts

@@ -3,7 +3,7 @@ import type { UI5FlexLayer } from '@sap-ux/project-access';
 /**
  * Intent object consisting of an object and an action.
  */
-interface Intent {
+export interface Intent {
     object: string;
     action: string;
 }

package/dist/ui5/middleware.js

@@ -11,23 +11,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 const logger_1 = require("@sap-ux/logger");
 const flp_1 = require("../base/flp");
-/**
- * The developer mode is only supported for adaptation projects, therefore, notify the user if it is wrongly configured and then disable it.
- *
- * @param config configurations from the ui5.yaml
- * @param logger logger instance
- */
-function sanitizeConfig(config, logger) {
-    if (config.rta && config.adp === undefined) {
-        config.rta.editors = config.rta.editors.filter((editor) => {
-            if (editor.developerMode) {
-                logger.error('developerMode is ONLY supported for SAP UI5 adaptation projects.');
-                logger.warn(`developerMode for ${editor.path} disabled`);
-            }
-            return !editor.developerMode;
-        });
-    }
-}
+const config_1 = require("../base/config");
 /**
  * Create the router that is to be exposed as UI5 middleware.
  *
@@ -44,7 +28,7 @@ function createRouter({ resources, options, middlewareUtil }, logger) {
         // setting defaults
         const config = (_a = options.configuration) !== null && _a !== void 0 ? _a : {};
         (_b = config.flp) !== null && _b !== void 0 ? _b : (config.flp = {});
-        sanitizeConfig(config, logger);
+        (0, config_1.sanitizeConfig)(config, logger);
         // configure the FLP sandbox based on information from the manifest
         const flp = new flp_1.FlpSandbox(config, resources.rootProject, middlewareUtil, logger);
         if (config.adp) {
@@ -60,7 +44,7 @@ function createRouter({ resources, options, middlewareUtil }, logger) {
             }
         }
         // add exposed endpoints for cds-plugin-ui5
-        flp.router.getAppPages = () => [`${flp.config.path}#${flp.config.intent.object}-${flp.config.intent.action}`];
+        flp.router.getAppPages = () => (0, config_1.getPreviewPaths)(config).map(({ path }) => path);
         return flp.router;
     });
 }

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.13.74",
+  "version": "0.14.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",
-    "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@0.9.16",
     "@sap-ux/axios-extension": "1.14.2",
+    "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@0.9.16",
     "@sap-ux/store": "0.6.0",
-    "@sap-ux/ui5-info": "0.5.0",
-    "@sap-ux/i18n": "0.0.7"
+    "@sap-ux/i18n": "0.0.7",
+    "@sap-ux/ui5-info": "0.5.0"
   },
   "peerDependencies": {
     "express": "4"