@sap-ux/preview-middleware 0.16.86 → 0.16.88

package/dist/base/config.d.ts

@@ -2,6 +2,7 @@ import { ToolsLogger, type Logger } from '@sap-ux/logger';
 import type { App, FlpConfig, Intent, InternalTestConfig, MiddlewareConfig } from '../types';
 import { type Manifest, type UI5FlexLayer } from '@sap-ux/project-access';
 import { type Editor } from 'mem-fs-editor';
+import type { MergedAppDescriptor } from '@sap-ux/axios-extension';
 export interface CustomConnector {
     applyConnector: string;
     writeConnector: string;
@@ -23,9 +24,7 @@ export interface TemplateConfig {
         additionalInformation: string;
         applicationType: 'URL';
         url: string;
-        applicationDependencies?: {
-            manifest: boolean;
-        };
+        applicationDependencies?: MergedAppDescriptor;
     }>;
     ui5: {
         libs: string;
@@ -41,6 +40,10 @@ export interface TemplateConfig {
         developerMode: boolean;
         pluginScript?: string;
     };
+    features?: {
+        feature: string;
+        isEnabled: boolean;
+    }[];
     locateReuseLibsScript?: boolean;
 }
 /**
@@ -95,8 +98,9 @@ export declare function sanitizeConfig(config: MiddlewareConfig, logger: ToolsLo
  * @param manifest manifest of the additional target app
  * @param app configuration for the preview
  * @param logger logger instance
+ * @param descriptor descriptor of the additional target app
  */
-export declare function addApp(templateConfig: TemplateConfig, manifest: Partial<Manifest>, app: App, logger: Logger): Promise<void>;
+export declare function addApp(templateConfig: TemplateConfig, manifest: Partial<Manifest>, app: App, logger: Logger, descriptor?: MergedAppDescriptor): Promise<void>;
 /**
  * Creates the configuration object for the sandbox.html template.
  *

package/dist/base/config.js

@@ -156,22 +156,26 @@ function getFlexSettings() {
  * @param manifest manifest of the additional target app
  * @param app configuration for the preview
  * @param logger logger instance
+ * @param descriptor descriptor of the additional target app
  */
-async function addApp(templateConfig, manifest, app, logger) {
+async function addApp(templateConfig, manifest, app, logger, descriptor) {
     const id = manifest['sap.app']?.id ?? '';
     app.intent ??= {
         object: id.replace(/\./g, ''),
         action: 'preview'
     };
+    const appName = `${app.intent?.object}-${app.intent?.action}`;
     templateConfig.ui5.resources[id] = app.target;
-    templateConfig.apps[`${app.intent?.object}-${app.intent?.action}`] = {
+    templateConfig.apps[appName] = {
         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 }
+        url: app.target
     };
+    if (descriptor) {
+        templateConfig.apps[appName].applicationDependencies = descriptor;
+    }
 }
 /**
  * Get the i18n text of the given property.

package/dist/base/flp.d.ts

@@ -5,6 +5,7 @@ import type { Logger, ToolsLogger } from '@sap-ux/logger';
 import type { MiddlewareUtils } from '@ui5/server';
 import type { Manifest } from '@sap-ux/project-access';
 import { type AdpPreviewConfig, type CommonChangeProperties, type OperationType } from '@sap-ux/adp-tooling';
+import type { MergedAppDescriptor } from '@sap-ux/axios-extension';
 import type { FlpConfig, MiddlewareConfig, RtaConfig, TestConfig } from '../types';
 import { type TemplateConfig } from './config';
 /**
@@ -48,8 +49,9 @@ export declare class FlpSandbox {
      * @param manifest application manifest
      * @param componentId optional componentId e.g. for adaptation projects
      * @param resources optional additional resource mappings
+     * @param descriptor optional additional descriptor mappings
      */
-    init(manifest: Manifest, componentId?: string, resources?: Record<string, string>): Promise<void>;
+    init(manifest: Manifest, componentId?: string, resources?: Record<string, string>, descriptor?: MergedAppDescriptor): Promise<void>;
     /**
      * Generates the FLP sandbox for an editor.
      *

package/dist/base/flp.js

@@ -10,6 +10,7 @@ const path_1 = require("path");
 const express_1 = require("express");
 const adp_tooling_1 = require("@sap-ux/adp-tooling");
 const btp_utils_1 = require("@sap-ux/btp-utils");
+const feature_toggle_1 = require("@sap-ux/feature-toggle");
 const flex_1 = require("./flex");
 const test_1 = require("./test");
 const config_1 = require("./config");
@@ -68,8 +69,9 @@ class FlpSandbox {
      * @param manifest application manifest
      * @param componentId optional componentId e.g. for adaptation projects
      * @param resources optional additional resource mappings
+     * @param descriptor optional additional descriptor mappings
      */
-    async init(manifest, componentId, resources = {}) {
+    async init(manifest, componentId, resources = {}, descriptor) {
         this.createFlexHandler();
         this.config.libs ??= await this.hasLocateReuseLibsScript();
         const id = manifest['sap.app'].id;
@@ -79,7 +81,7 @@ class FlpSandbox {
             target: resources[componentId ?? id] ?? this.templateConfig.basePath,
             local: '.',
             intent: this.config.intent
-        }, this.logger);
+        }, this.logger, descriptor);
         this.addStandardRoutes();
         if (this.rta) {
             this.rta.options ??= {};
@@ -120,6 +122,7 @@ class FlpSandbox {
             developerMode: editor.developerMode === true,
             pluginScript: editor.pluginScript
         };
+        config.features = feature_toggle_1.FeatureToggleAccess.getAllFeatureToggles();
         if (editor.developerMode === true) {
             config.ui5.bootstrapOptions = serializeUi5Configuration(DEVELOPER_MODE_CONFIG);
         }
@@ -145,6 +148,7 @@ class FlpSandbox {
                         templatePreviewUrl = templatePreviewUrl.replace('?', `?sap-ui-layer=${rta.layer}&`);
                     }
                     const template = (0, fs_1.readFileSync)((0, path_1.join)(__dirname, '../../templates/flp/editor.html'), 'utf-8');
+                    const features = feature_toggle_1.FeatureToggleAccess.getAllFeatureToggles();
                     const envPort = process.env.FIORI_TOOLS_LIVERELOAD_PORT;
                     let livereloadPort = envPort ? parseInt(envPort, 10) : DEFAULT_LIVERELOAD_PORT;
                     livereloadPort = isNaN(livereloadPort) ? DEFAULT_LIVERELOAD_PORT : livereloadPort;
@@ -155,7 +159,8 @@ class FlpSandbox {
                         appName: rta.options?.appName,
                         scenario,
                         livereloadPort,
-                        livereloadUrl: envLivereloadUrl
+                        livereloadUrl: envLivereloadUrl,
+                        features: JSON.stringify(features)
                     });
                     this.sendResponse(res, 'text/html', 200, html);
                 });
@@ -455,9 +460,8 @@ async function initAdp(rootProject, config, flp, util, logger) {
             }
         }
         const descriptor = adp.descriptor;
-        descriptor.asyncHints.requests = [];
         const { name, manifest } = descriptor;
-        await flp.init(manifest, name, adp.resources);
+        await flp.init(manifest, name, adp.resources, descriptor);
         flp.router.use(adp.descriptor.url, adp.proxy.bind(adp));
         flp.addOnChangeRequestHandler(adp.onChangeRequest.bind(adp));
         flp.router.use((0, express_1.json)());

package/dist/client/adp/quick-actions/load.js

@@ -1,6 +1,6 @@
 "use strict";
 
-sap.ui.define([], function () {
+sap.ui.define(["../../cpe/feature-service"], function (____cpe_feature_service) {
   "use strict";
 
   function __ui5_require_async(path) {
@@ -20,15 +20,15 @@ sap.ui.define([], function () {
       });
     });
   }
+  const FeatureService = ____cpe_feature_service["FeatureService"];
   /**
    * Loads the appropriate Quick Action registries for the given application type.
-   * 
-   * @param appType - Application type. 
+   *
+   * @param appType - Application type.
    * @returns Quick Action registries.
    */
   async function loadDefinitions(appType) {
-    // eslint-disable-next-line fiori-custom/sap-no-localstorage
-    if (localStorage.getItem('com.sap.ux.control-property-editor.features.quick-actions') !== 'true') {
+    if (FeatureService.isFeatureEnabled('cpe.beta.quick-actions') === false) {
       return [];
     }
     if (appType === 'fe-v2') {

package/dist/client/adp/quick-actions/load.ts

@@ -1,15 +1,15 @@
+import { FeatureService } from '../../cpe/feature-service';
 import type { QuickActionDefinitionRegistry } from '../../cpe/quick-actions/registry';
 import type { ApplicationType } from '../../utils/application';
 
 /**
  * Loads the appropriate Quick Action registries for the given application type.
- * 
- * @param appType - Application type. 
+ *
+ * @param appType - Application type.
  * @returns Quick Action registries.
  */
 export async function loadDefinitions(appType: ApplicationType): Promise<QuickActionDefinitionRegistry<string>[]> {
-    // eslint-disable-next-line fiori-custom/sap-no-localstorage
-    if (localStorage.getItem('com.sap.ux.control-property-editor.features.quick-actions') !== 'true') {
+    if (FeatureService.isFeatureEnabled('cpe.beta.quick-actions') === false) {
         return [];
     }
     if (appType === 'fe-v2') {

package/dist/client/cpe/feature-service.js

@@ -0,0 +1,38 @@
+"use strict";
+
+sap.ui.define([], function () {
+  "use strict";
+
+  class FeatureService {
+    static features = {};
+    static #_ = (() => {
+      // eslint-disable-next-line fiori-custom/sap-no-dom-access, fiori-custom/sap-browser-api-warning
+      const bootstrapConfig = document.getElementById('sap-ui-bootstrap');
+      const features = bootstrapConfig?.getAttribute('data-open-ux-preview-features');
+      if (features) {
+        const featureToggles = JSON.parse(features);
+        for (const {
+          feature,
+          isEnabled
+        } of featureToggles) {
+          this.features[feature] = isEnabled;
+        }
+      }
+    })();
+    /**
+     * Checks if given feature is enabled.
+     *
+     * @param featureId - Id of the feature.
+     * @returns true if feature is enabled.
+     */
+    static isFeatureEnabled(featureId) {
+      return this.features[featureId] ?? false;
+    }
+  }
+  var __exports = {
+    __esModule: true
+  };
+  __exports.FeatureService = FeatureService;
+  return __exports;
+});
+//# sourceMappingURL=feature-service.js.map

package/dist/client/cpe/feature-service.ts

@@ -0,0 +1,25 @@
+export class FeatureService {
+    private static features: Record<string, boolean> = {};
+
+    static {
+        // eslint-disable-next-line fiori-custom/sap-no-dom-access, fiori-custom/sap-browser-api-warning
+        const bootstrapConfig = document.getElementById('sap-ui-bootstrap');
+        const features = bootstrapConfig?.getAttribute('data-open-ux-preview-features');
+        if (features) {
+            const featureToggles = JSON.parse(features) as { feature: string; isEnabled: boolean }[];
+            for (const { feature, isEnabled } of featureToggles) {
+                this.features[feature] = isEnabled;
+            }
+        }
+    }
+
+    /**
+     * Checks if given feature is enabled.
+     *
+     * @param featureId - Id of the feature.
+     * @returns true if feature is enabled.
+     */
+    public static isFeatureEnabled(featureId: string): boolean {
+        return this.features[featureId] ?? false;
+    }
+}

package/dist/client/flp/bootstrap.js

@@ -15,10 +15,16 @@ async function ushellBootstrap(fnCallback) {
         const response = await fetch(`${basePath}/resources/sap-ui-version.json`);
         const json = await response.json();
         const version = json?.libraries?.find((lib) => lib.name === 'sap.ui.core')?.version ?? '1.121.0';
-        const majorUi5Version = parseInt(version.split('.')[0], 10);
+        const [major, minor] = version.split('.');
+        const majorUi5Version = parseInt(major, 10);
+        const minorUi5Version = parseInt(minor, 10);
         if (majorUi5Version >= 2) {
             src = `${basePath}/resources/sap/ushell/bootstrap/sandbox2.js`;
         }
+
+        if (majorUi5Version === 1 && minorUi5Version < 72) {
+            removeAsyncHintsRequests();
+        }
     } catch (error) {
         console.warn('Failed to fetch sap-ui-version.json. Assuming it is a 1.x version.');
     }
@@ -33,6 +39,38 @@ async function ushellBootstrap(fnCallback) {
     }
 }
 
+/**
+ * For UI5 version 1.71 and below, we need to remove the asyncHints.requests
+ * to load the changes in an Adaptation project.
+ * This logic needs to be executed here to have a reliable check for
+ * UI5 version and remove the asyncHints.requests before the sandbox is loaded.
+ * The sandbox shell modifies the `window['sap-ushell-config']`.
+ */
+function removeAsyncHintsRequests() {
+    const obj = window['sap-ushell-config']['applications'];
+
+    if (!obj || typeof obj !== 'object') return;
+
+    const stack = [obj];
+
+    while (stack.length > 0) {
+        const current = stack.pop();
+
+        if (current.asyncHints) {
+            if (current.asyncHints.requests) {
+                current.asyncHints.requests = [];
+            }
+            return;
+        }
+
+        for (const key in current) {
+            if (typeof current[key] === 'object' && current[key] !== null) {
+                stack.push(current[key]);
+            }
+        }
+    }
+}
+
 // eslint-disable-next-line fiori-custom/sap-no-global-define
 window['sap-ui-config'] = {
     'xx-bootTask': ushellBootstrap

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.16.86",
+  "version": "0.16.88",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -27,8 +27,9 @@
     "mem-fs-editor": "9.4.0",
     "@sap-ux/logger": "0.6.0",
     "@sap-ux/btp-utils": "0.15.2",
-    "@sap-ux/adp-tooling": "0.12.59",
-    "@sap-ux/control-property-editor-sources": "npm:@sap-ux/control-property-editor@0.5.18",
+    "@sap-ux/feature-toggle": "0.2.2",
+    "@sap-ux/adp-tooling": "0.12.60",
+    "@sap-ux/control-property-editor-sources": "npm:@sap-ux/control-property-editor@0.5.20",
     "@sap-ux/project-access": "1.28.2"
   },
   "devDependencies": {
@@ -45,9 +46,9 @@
     "supertest": "6.3.3",
     "@sap-ux-private/playwright": "0.1.0",
     "dotenv": "16.3.1",
-    "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@0.11.14",
-    "@sap-ux/axios-extension": "1.16.6",
+    "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@0.11.16",
     "@sap-ux/store": "0.9.2",
+    "@sap-ux/axios-extension": "1.16.7",
     "@sap-ux/ui5-info": "0.8.1",
     "@sap-ux/i18n": "0.2.0"
   },

package/templates/flp/editor.html

@@ -20,6 +20,7 @@
                 scenario: '<%- scenario %>',
                 livereloadPort: <%- livereloadPort %>,
                 livereloadUrl: '<%- livereloadUrl %>',
+                features: <%- features %>
             });
         </script>
     </body>

package/templates/flp/sandbox.html

@@ -62,6 +62,7 @@
         data-sap-ui-xx-componentPreload="off"<%- ui5.bootstrapOptions %>
         data-sap-ui-oninit="module:open/ux/preview/client/flp/init"<% if (locals.init) { %>
         data-open-ux-preview-customInit='<%- init %>'<% } if (locals.flex) { %>
+        data-open-ux-preview-features='<%- JSON.stringify(features) %>'
         data-open-ux-preview-flex-settings='<%- JSON.stringify(flex) %>'<% } if (locals.locateReuseLibsScript) { %>
         data-open-ux-preview-libs-manifests='<%- JSON.stringify(Object.values(apps).map(app => app.url)) %>'<% } %>>
     </script>