@sap-ux/preview-middleware 1.0.19 → 1.0.22

package/README.md

@@ -71,7 +71,7 @@ Array of additional application configurations:
 | `framework`     | `string`   | mandatory        | `undefined`    | Currently `OPA5`, `QUnit` (only QUnit 2.3.2 provided as third-party module using [OpenUI5](https://github.com/SAP/openui5/blob/master/THIRDPARTY.txt)/SAPUI5) and `Testsuite` are supported. `Testsuite` will generate a testsuite for all configured frameworks that can be be used with a test runner (such as karma) |
 | `path`          | `string`   | optional         | `(calculated)` | The mount point to be used for test suite. By default, `/test/opaTests.qunit.html` is used for `OPA5`, `/test/unitTests.qunit.html` is used for `QUnit`, and `/test/testsuite.qunit.html` is used for `Testsuite`                                                                                                       |
 | `init`          | `string`   | optional         | `undefined`    | The mount point to be used for custom test runner script                                                                                                                                                                                                                                                                |
-| `pattern`       | `string`   | optional         | `(calculated)` | Optional glob pattern to find the tests. By default, `/test/**/*Journey.{js,ts}` is used for `OPA5` and `/test/**/*Test.{js,ts}` is used for `QUnit` (not applicable for `Testsuite`)                                                                                                                                   |
+| `pattern`       | `string`   | optional         | `(calculated)` | Optional glob pattern to find the tests. By default, `/test/**/*Journey{,.gen}.{js,ts}` is used for `OPA5` and `/test/**/*Test.{js,ts}` is used for `QUnit` (not applicable for `Testsuite`)                                                                                                                                   |
 
 
 ## [Usage](#usage)

package/dist/base/config.d.ts

@@ -157,9 +157,10 @@ export declare function remapResourcesForPath(config: TemplateConfig, newPagePat
  * @param config FLP configuration
  * @param manifest application manifest
  * @param resources additional resources
+ * @param isAdp whether this is an adaptation project
  * @returns configuration object for the sandbox.html template
  */
-export declare function createFlpTemplateConfig(config: FlpConfig, manifest: Partial<Manifest>, resources?: Record<string, string>): TemplateConfig;
+export declare function createFlpTemplateConfig(config: FlpConfig, manifest: Partial<Manifest>, resources?: Record<string, string>, isAdp?: boolean): TemplateConfig;
 /**
  * Creates the configuration object for the test template.
  *

package/dist/base/config.js

@@ -164,12 +164,13 @@ export function sanitizeRtaConfig(deprecatedRtaConfig, logger) {
 /**
  * Retrieves the configuration settings for UI5 flexibility services.
  *
+ * @param isAdp whether this is an adaptation project - LocalStorageConnector is omitted for ADP
  * @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() {
+function getFlexSettings(isAdp = false) {
     const localConnectorPath = 'open/ux/preview/client/flp/WorkspaceConnector';
-    return [
+    const connectors = [
         { connector: 'LrepConnector', layers: [], url: '/sap/bc/lrep' },
         {
             applyConnector: localConnectorPath,
@@ -177,6 +178,10 @@ function getFlexSettings() {
             custom: true
         }
     ];
+    if (!isAdp) {
+        connectors.push({ connector: 'LocalStorageConnector', layers: ['CUSTOMER', 'USER'] });
+    }
+    return connectors;
 }
 /**
  * Add an application to the local FLP preview.
@@ -278,10 +283,11 @@ export function remapResourcesForPath(config, newPagePath, appId) {
  * @param config FLP configuration
  * @param manifest application manifest
  * @param resources additional resources
+ * @param isAdp whether this is an adaptation project
  * @returns configuration object for the sandbox.html template
  */
-export function createFlpTemplateConfig(config, manifest, resources = {}) {
-    const flex = getFlexSettings();
+export function createFlpTemplateConfig(config, manifest, resources = {}, isAdp = false) {
+    const flex = getFlexSettings(isAdp);
     const supportedThemes = manifest['sap.ui5']?.supportedThemes ?? [DEFAULT_THEME];
     const ui5Theme = config.theme ?? (supportedThemes.includes(DEFAULT_THEME) ? DEFAULT_THEME : supportedThemes[0]);
     const id = manifest['sap.app']?.id ?? '';

package/dist/base/flp.d.ts

@@ -149,6 +149,16 @@ export declare class FlpSandbox {
      * @private
      */
     private addCardGeneratorMiddlewareRoute;
+    /**
+     * Extracts protocol and baseUrl from a request and calls getUi5Version.
+     * Handles both express Request and connect IncomingMessage (karma test runner).
+     *
+     * @param req - the incoming request
+     * @param baseUrl - the base path to include when fetching the UI5 version
+     * @returns the parsed UI5 version
+     * @private
+     */
+    private getUi5VersionFromRequest;
     /**
      * Read the UI5 version.
      * In case of an error, the default UI5 version '1.121.0' is returned.

package/dist/base/flp.js

@@ -80,7 +80,7 @@ export class FlpSandbox {
         this.createFlexHandler();
         this.flpConfig.libs ??= await this.hasLocateReuseLibsScript();
         const id = manifest['sap.app']?.id ?? '';
-        this.templateConfig = createFlpTemplateConfig(this.flpConfig, manifest, resources);
+        this.templateConfig = createFlpTemplateConfig(this.flpConfig, manifest, resources, adp !== undefined);
         this.adp = adp;
         this.manifest = manifest;
         await addApp(this.templateConfig, manifest, {
@@ -226,7 +226,7 @@ export class FlpSandbox {
      * @returns Promise that resolves when the application dependencies are set
      */
     async setApplicationDependencies() {
-        if (this.adp) {
+        if (this.adp && !this.adp.isCloudFoundry) {
             await this.adp.sync();
             const appName = getAppName(this.manifest, this.flpConfig.intent);
             this.templateConfig.apps[appName].applicationDependencies = this.adp.descriptor;
@@ -350,11 +350,7 @@ export class FlpSandbox {
         else {
             // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
             this.templateConfig.baseUrl = ('ui5-patched-router' in req && req['ui5-patched-router']?.baseUrl) || '';
-            const ui5Version = await this.getUi5Version(
-            //use protocol from request header referer as fallback for connect API (karma test runner)
-            'protocol' in req
-                ? req.protocol
-                : (req.headers.referer?.substring(0, req.headers.referer.indexOf(':')) ?? 'http'), req.headers.host, this.templateConfig.baseUrl);
+            const ui5Version = await this.getUi5VersionFromRequest(req, this.templateConfig.baseUrl);
             this.checkDeleteConnectors(ui5Version.major, ui5Version.minor, ui5Version.isCdn);
             if (ui5Version.major === 1 && ui5Version.minor < 120) {
                 this.removeFlexExtensionPointEnabled();
@@ -388,9 +384,37 @@ export class FlpSandbox {
         this.logger.debug(`Add route for ${previewGeneratorPath}`);
         this.router.get(previewGeneratorPath, async (req, res, next) => {
             this.templateConfig.enableCardGenerator = !!this.cardGenerator?.path;
+            if (this.templateConfig.enableCardGenerator) {
+                // check for min ui5 version of card generator feature
+                const baseUrl = 'ui5-patched-router' in req ? (req['ui5-patched-router']?.baseUrl ?? '') : '';
+                const ui5Version = await this.getUi5VersionFromRequest(req, baseUrl);
+                const minMinor = this.projectType === 'CAPNodejs' || this.projectType === 'CAPJava' ? 149 : 121;
+                if ((ui5Version.major === 1 && ui5Version.minor < minMinor) ||
+                    ui5Version.major >= 2 ||
+                    ui5Version.label?.includes('legacy-free')) {
+                    this.templateConfig.enableCardGenerator = false;
+                    this.logger.warn(`Feature cardGenerator disabled: UI5 version ${ui5Version.major}.${ui5Version.minor}.${ui5Version.patch} does not meet the minimum required version 1.${minMinor}.0 for project type '${this.projectType}'.`);
+                }
+            }
             await this.flpGetHandler(req, res, next);
         });
     }
+    /**
+     * Extracts protocol and baseUrl from a request and calls getUi5Version.
+     * Handles both express Request and connect IncomingMessage (karma test runner).
+     *
+     * @param req - the incoming request
+     * @param baseUrl - the base path to include when fetching the UI5 version
+     * @returns the parsed UI5 version
+     * @private
+     */
+    async getUi5VersionFromRequest(req, baseUrl = '') {
+        // use protocol from request header referer as fallback for connect API (karma test runner)
+        const protocol = 'protocol' in req
+            ? req.protocol
+            : (req.headers.referer?.substring(0, req.headers.referer.indexOf(':')) ?? 'http');
+        return this.getUi5Version(protocol, req.headers.host, baseUrl);
+    }
     /**
      * Read the UI5 version.
      * In case of an error, the default UI5 version '1.121.0' is returned.
@@ -425,6 +449,7 @@ export class FlpSandbox {
         }
         const [major, minor, patch] = version.split('.').map((versionPart) => Number.parseInt(versionPart, 10));
         const label = version.split(/-(.*)/s)?.[1];
+        // check for min ui5 version of flp.enhancedHomePage feature
         if (this.flpConfig.enhancedHomePage &&
             ((major < 2 && minor < 123) || major >= 2 || label?.includes('legacy-free'))) {
             this.flpConfig.enhancedHomePage = this.templateConfig.enhancedHomePage = false;
@@ -929,7 +954,7 @@ export class FlpSandbox {
         if ('cfBuildPath' in config) {
             const manifest = this.setupCfBuildMode(config.cfBuildPath);
             configureRta(this.rta, layer, variant.id, false, true);
-            await this.init(manifest, variant.reference);
+            await this.init(manifest, variant.reference, {}, adp);
             await this.setupAdpCommonHandlers(adp);
             return;
         }

package/dist/base/test.js

@@ -8,7 +8,7 @@ const DEFAULTS = {
     opa5: {
         path: '/test/opaTests.qunit.html',
         init: '/test/opaTests.qunit.js',
-        pattern: '/test/**/*Journey.{js,ts}',
+        pattern: '/test/**/*Journey{,.gen}.{js,ts}',
         framework: 'OPA5'
     },
     testsuite: {

package/dist/types/index.d.ts

@@ -98,7 +98,7 @@ export type TestConfigDefaults = {
     opa5: {
         path: '/test/opaTests.qunit.html';
         init: '/test/opaTests.qunit.js';
-        pattern: '/test/**/*Journey.{js,ts}';
+        pattern: '/test/**/*Journey{,.gen}.{js,ts}';
         framework: 'OPA5';
     };
     testsuite: {

package/package.json

@@ -10,7 +10,7 @@
   "bugs": {
     "url": "https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Apreview-middleware"
   },
-  "version": "1.0.19",
+  "version": "1.0.22",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -28,7 +28,7 @@
     "mem-fs-editor": "9.4.0",
     "qrcode": "1.5.4",
     "@sap/bas-sdk": "3.13.7",
-    "@sap-ux/adp-tooling": "1.0.15",
+    "@sap-ux/adp-tooling": "1.0.16",
     "@sap-ux/btp-utils": "2.0.2",
     "@sap-ux/control-property-editor-sources": "npm:@sap-ux/control-property-editor@1.0.5",
     "@sap-ux/feature-toggle": "1.0.2",
@@ -54,7 +54,7 @@
     "nock": "14.0.11",
     "npm-run-all2": "8.0.4",
     "supertest": "7.2.2",
-    "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@1.0.19",
+    "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@1.0.22",
     "@sap-ux-private/playwright": "1.0.2",
     "@sap-ux/axios-extension": "2.0.3",
     "@sap-ux/store": "2.0.1",