@sap-ux/preview-middleware 0.16.58 → 0.16.60

package/dist/client/i18n.ts

@@ -0,0 +1,34 @@
+import ResourceBundle from 'sap/base/i18n/ResourceBundle';
+
+const BUNDLE_CACHE: Record<string, ResourceBundle> = {};
+
+export async function getResourceBundle(key: string): Promise<ResourceBundle> {
+    const cachedBundle = BUNDLE_CACHE[key];
+
+    if (cachedBundle) {
+        return cachedBundle;
+    }
+
+    const bundle = await ResourceBundle.create({
+        bundleUrl: '/preview/client/messagebundle.properties',
+        url: '/preview/client/messagebundle.properties',
+        supportedLocales: [''],
+        locale: '',
+        async: true
+    });
+    BUNDLE_CACHE[key] = bundle;
+    return bundle;
+}
+
+export class TextBundle {
+    constructor(private bundle: ResourceBundle) {}
+
+    getText(key: string, args?: string[]): string {
+        return this.bundle.getText(key, args) ?? key;
+    }
+}
+
+export async function getTextBundle(key = 'open.ux.preview.client'): Promise<TextBundle> {
+    const bundle = await getResourceBundle(key);
+    return new TextBundle(bundle);
+}

package/dist/client/manifest.json

@@ -2,4 +2,4 @@
     "sap.app": {
         "id": "open.ux.preview.client"
     }
-}
+}

package/dist/client/messagebundle.properties

@@ -0,0 +1,17 @@
+QUICK_ACTION_ADD_PAGE_CONTROLLER=Add controller to page
+QUICK_ACTION_SHOW_PAGE_CONTROLLER=Show page controller
+QUICK_ACTION_OP_ADD_HEADER_FIELD=Add Header Field
+
+V2_QUICK_ACTION_CHANGE_TABLE_COLUMNS=Change table columns
+
+V2_QUICK_ACTION_LR_ENABLE_CLEAR_FILTER_BAR=Enable clear filterbar button
+V2_QUICK_ACTION_LR_DISABLE_CLEAR_FILTER_BAR=Disable clear filterbar button
+
+
+V4_QUICK_ACTION_CHANGE_TABLE_COLUMNS=Change table columns
+
+V4_QUICK_ACTION_LR_ENABLE_CLEAR_FILTER_BAR=Enable clear filterbar button
+V4_QUICK_ACTION_LR_DISABLE_CLEAR_FILTER_BAR=Disable clear filterbar button
+
+ADP_SYNC_VIEWS_MESSAGE = Have in mind that synchronous views are detected for this application and controller extensions are not supported for such views. Controller extension functionality on these views will be disabled.
+ADP_REUSE_COMPONENTS_MESSAGE = Have in mind that reuse components are detected for some views in this application and controller extensions and adding fragments are not supported for such views. Controller extension and adding fragment functionality on these views will be disabled.

package/dist/client/thirdparty/@sap-ux-private/control-property-editor-common.js

@@ -8,7 +8,7 @@ sap.ui.define((function () { 'use strict';
 
 	(function (exports) {
 		Object.defineProperty(exports, "__esModule", { value: true });
-		exports.save = exports.redo = exports.undo = exports.appLoaded = exports.setSaveEnablement = exports.setUndoRedoEnablement = exports.setAppMode = exports.storageFileChanged = exports.reloadApplication = exports.showMessage = exports.changeStackModified = exports.propertyChangeFailed = exports.propertyChanged = exports.changeProperty = exports.outlineChanged = exports.deletePropertyChanges = exports.addExtensionPoint = exports.selectControl = exports.controlSelected = exports.iconsLoaded = exports.EXTERNAL_ACTION_PREFIX = exports.SCENARIO = exports.CHECKBOX_EDITOR_TYPE = exports.DROPDOWN_EDITOR_TYPE = exports.INPUT_EDITOR_TYPE = exports.STRING_VALUE_TYPE = exports.FLOAT_VALUE_TYPE = exports.INTEGER_VALUE_TYPE = exports.BOOLEAN_VALUE_TYPE = void 0;
+		exports.executeQuickAction = exports.updateQuickAction = exports.quickActionListChanged = exports.save = exports.redo = exports.undo = exports.appLoaded = exports.setSaveEnablement = exports.setUndoRedoEnablement = exports.setAppMode = exports.storageFileChanged = exports.reloadApplication = exports.showMessage = exports.changeStackModified = exports.propertyChangeFailed = exports.propertyChanged = exports.changeProperty = exports.outlineChanged = exports.deletePropertyChanges = exports.addExtensionPoint = exports.selectControl = exports.controlSelected = exports.iconsLoaded = exports.EXTERNAL_ACTION_PREFIX = exports.NESTED_QUICK_ACTION_KIND = exports.SIMPLE_QUICK_ACTION_KIND = exports.SCENARIO = exports.CHECKBOX_EDITOR_TYPE = exports.DROPDOWN_EDITOR_TYPE = exports.INPUT_EDITOR_TYPE = exports.STRING_VALUE_TYPE = exports.FLOAT_VALUE_TYPE = exports.INTEGER_VALUE_TYPE = exports.BOOLEAN_VALUE_TYPE = void 0;
 		exports.BOOLEAN_VALUE_TYPE = 'boolean';
 		exports.INTEGER_VALUE_TYPE = 'integer';
 		exports.FLOAT_VALUE_TYPE = 'float';
@@ -23,6 +23,8 @@ sap.ui.define((function () { 'use strict';
 		    FioriElementsFromScratch: 'FE_FROM_SCRATCH',
 		    UiAdaptation: 'UI_ADAPTATION'
 		};
+		exports.SIMPLE_QUICK_ACTION_KIND = 'simple';
+		exports.NESTED_QUICK_ACTION_KIND = 'nested';
 		/**
 		 * Create matcher.
 		 *
@@ -81,6 +83,9 @@ sap.ui.define((function () { 'use strict';
 		exports.undo = createExternalAction('undo');
 		exports.redo = createExternalAction('redo');
 		exports.save = createExternalAction('save');
+		exports.quickActionListChanged = createExternalAction('quick-action-list-changed');
+		exports.updateQuickAction = createExternalAction('update-quick-action');
+		exports.executeQuickAction = createExternalAction('execute-quick-action');
 		
 	} (api));
 

package/dist/client/utils/application.js

@@ -0,0 +1,34 @@
+"use strict";
+
+sap.ui.define([], function () {
+  "use strict";
+
+  /**
+   * Determines application type based on the manifest.json.
+   *
+   * @param manifest - Application Manifest.
+   * @returns Application type.
+   */
+  function getApplicationType(manifest) {
+    if (manifest['sap.ui.generic.app'] || manifest['sap.ovp']) {
+      return 'fe-v2';
+    } else if (manifest['sap.ui5']?.routing?.targets) {
+      let hasV4pPages = false;
+      Object.keys(manifest?.['sap.ui5']?.routing?.targets ?? []).forEach(target => {
+        if (manifest?.['sap.ui5']?.routing?.targets?.[target]?.name?.startsWith('sap.fe.templates.')) {
+          hasV4pPages = true;
+        }
+      });
+      if (hasV4pPages) {
+        return 'fe-v4';
+      }
+    }
+    return 'freestyle';
+  }
+  var __exports = {
+    __esModule: true
+  };
+  __exports.getApplicationType = getApplicationType;
+  return __exports;
+});
+//# sourceMappingURL=application.js.map

package/dist/client/utils/application.ts

@@ -0,0 +1,27 @@
+import type { Manifest } from 'sap/ui/rta/RuntimeAuthoring';
+
+export type ApplicationType = 'fe-v2' | 'fe-v4' | 'freestyle';
+
+/**
+ * Determines application type based on the manifest.json.
+ *
+ * @param manifest - Application Manifest.
+ * @returns Application type.
+ */
+export function getApplicationType(manifest: Manifest): ApplicationType {
+    if (manifest['sap.ui.generic.app'] || manifest['sap.ovp']) {
+        return 'fe-v2';
+    } else if (manifest['sap.ui5']?.routing?.targets) {
+        let hasV4pPages = false;
+        Object.keys(manifest?.['sap.ui5']?.routing?.targets ?? []).forEach((target) => {
+            if (manifest?.['sap.ui5']?.routing?.targets?.[target]?.name?.startsWith('sap.fe.templates.')) {
+                hasV4pPages = true;
+            }
+        });
+        if (hasV4pPages) {
+            return 'fe-v4';
+        }
+    }
+
+    return 'freestyle';
+}

package/dist/client/utils/core.js

@@ -0,0 +1,70 @@
+"use strict";
+
+sap.ui.define(["sap/ui/core/Component", "sap/ui/core/Element"], function (Component, Element) {
+  "use strict";
+
+  /**
+   * Gets Component by id.
+   *
+   * @param id - unique identifier for control
+   * @returns Component | undefined
+   */
+  function getComponent(id) {
+    if (Component?.getComponentById) {
+      return Component.getComponentById(id);
+    } else if (Component?.get) {
+      // Older version must be still supported until maintenance period.
+      return Component.get(id); // NOSONAR
+    } else {
+      // Older version must be still supported until maintenance period.
+      return sap.ui.getCore().getComponent(id); // NOSONAR
+    }
+  }
+
+  /**
+   * Returns control by its global ID.
+   *
+   * @param id Id of the control.
+   * @returns Control instance if it exists.
+   */
+  function getControlById(id) {
+    if (typeof Element.getElementById === 'function') {
+      return Element.getElementById(id);
+    } else {
+      return sap.ui.getCore().byId(id);
+    }
+  }
+
+  /**
+   * Checks wether this object is an instance of a ManagedObject.
+   *
+   * @param element An object.
+   * @returns True if element is an instance of a ManagedObject.
+   */
+  function isManagedObject(element) {
+    if (typeof element?.isA === 'function') {
+      return element.isA('sap.ui.base.ManagedObject');
+    }
+    return false;
+  }
+
+  /**
+   * Checks whether this object is an instance of the named type.
+   *
+   * @param type - Type to check for.
+   * @param element - Object to check
+   * @returns Whether this object is an instance of the given type.
+   */
+  function isA(type, element) {
+    return !!element?.isA(type);
+  }
+  var __exports = {
+    __esModule: true
+  };
+  __exports.getComponent = getComponent;
+  __exports.getControlById = getControlById;
+  __exports.isManagedObject = isManagedObject;
+  __exports.isA = isA;
+  return __exports;
+});
+//# sourceMappingURL=core.js.map

package/dist/client/utils/core.ts

@@ -0,0 +1,61 @@
+import Component from 'sap/ui/core/Component';
+import type { ID } from 'sap/ui/core/library';
+import type ManagedObject from 'sap/ui/base/ManagedObject';
+import Element from 'sap/ui/core/Element';
+
+/**
+ * Gets Component by id.
+ *
+ * @param id - unique identifier for control
+ * @returns Component | undefined
+ */
+export function getComponent<T extends Component = Component>(id: ID): T | undefined {
+    if (Component?.getComponentById) {
+        return Component.getComponentById(id) as T;
+    } else if (Component?.get) {
+        // Older version must be still supported until maintenance period.
+        return Component.get(id) as T; // NOSONAR
+    } else {
+        // Older version must be still supported until maintenance period.
+        return sap.ui.getCore().getComponent(id) as T; // NOSONAR
+    }
+}
+
+/**
+ * Returns control by its global ID.
+ *
+ * @param id Id of the control.
+ * @returns Control instance if it exists.
+ */
+export function getControlById<T extends Element = Element>(id: string): T | undefined {
+    if (typeof Element.getElementById === 'function') {
+        return Element.getElementById(id) as T;
+    } else {
+        return sap.ui.getCore().byId(id) as T;
+    }
+}
+
+/**
+ * Checks wether this object is an instance of a ManagedObject.
+ *
+ * @param element An object.
+ * @returns True if element is an instance of a ManagedObject.
+ */
+export function isManagedObject(element: object | undefined): element is ManagedObject {
+    if (typeof (element as unknown as { isA?: (_type: string) => boolean })?.isA === 'function') {
+        return (element as unknown as { isA: (_type: string) => boolean }).isA('sap.ui.base.ManagedObject');
+    }
+
+    return false;
+}
+
+/**
+ * Checks whether this object is an instance of the named type.
+ *
+ * @param type - Type to check for.
+ * @param element - Object to check
+ * @returns Whether this object is an instance of the given type.
+ */
+export function isA<T extends ManagedObject>(type: string, element: ManagedObject | undefined): element is T {
+    return !!element?.isA(type);
+}

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.58",
+  "version": "0.16.60",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -25,10 +25,10 @@
     "ejs": "3.1.10",
     "mem-fs": "2.1.0",
     "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.45",
-    "@sap-ux/control-property-editor-sources": "npm:@sap-ux/control-property-editor@0.4.30",
+    "@sap-ux/control-property-editor-sources": "npm:@sap-ux/control-property-editor@0.5.1",
+    "@sap-ux/logger": "0.6.0",
     "@sap-ux/project-access": "1.27.1"
   },
   "devDependencies": {
@@ -45,7 +45,7 @@
     "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.10.9",
+    "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@0.11.0",
     "@sap-ux/axios-extension": "1.16.5",
     "@sap-ux/store": "0.9.1",
     "@sap-ux/ui5-info": "0.8.1",

package/dist/client/cpe/outline/index.js

@@ -1,40 +0,0 @@
-'use strict';
-sap.ui.define([
-    'open/ux/preview/client/thirdparty/@sap-ux-private/control-property-editor-common',
-    './nodes',
-    'sap/base/Log',
-    '../../utils/error'
-], function (___sap_ux_private_control_property_editor_common, ___nodes, Log, ____utils_error) {
-    'use strict';
-    const outlineChanged = ___sap_ux_private_control_property_editor_common['outlineChanged'];
-    const showMessage = ___sap_ux_private_control_property_editor_common['showMessage'];
-    const transformNodes = ___nodes['transformNodes'];
-    const getError = ____utils_error['getError'];
-    async function initOutline(rta, sendAction) {
-        const outline = await rta.getService('outline');
-        const scenario = rta.getFlexSettings().scenario;
-        let hasSentWarning = false;
-        const reuseComponentsIds = new Set();
-        async function syncOutline() {
-            try {
-                const viewNodes = await outline.get();
-                const outlineNodes = await transformNodes(viewNodes, scenario, reuseComponentsIds);
-                sendAction(outlineChanged(outlineNodes));
-                if (reuseComponentsIds.size > 0 && scenario === 'ADAPTATION_PROJECT' && !hasSentWarning) {
-                    sendAction(showMessage({
-                        message: 'Have in mind that reuse components are detected for some views in this application and controller extensions and adding fragments are not supported for such views. Controller extension and adding fragment functionality on these views will be disabled.',
-                        shouldHideIframe: false
-                    }));
-                    hasSentWarning = true;
-                }
-            } catch (error) {
-                Log.error('Outline sync failed!', getError(error));
-            }
-        }
-        await syncOutline();
-        outline.attachEvent('update', syncOutline);
-    }
-    var __exports = { __esModule: true };
-    __exports.initOutline = initOutline;
-    return __exports;
-});

package/dist/client/cpe/outline/index.ts

@@ -1,37 +0,0 @@
-import type { ExternalAction } from '@sap-ux-private/control-property-editor-common';
-import { outlineChanged, showMessage } from '@sap-ux-private/control-property-editor-common';
-
-import type RuntimeAuthoring from 'sap/ui/rta/RuntimeAuthoring';
-import type OutlineService from 'sap/ui/rta/command/OutlineService';
-
-import { transformNodes } from './nodes';
-import Log from 'sap/base/Log';
-import { getError } from '../../utils/error';
-
-/**
- *
- * @param rta runtimeAuthoring object.
- * @param sendAction send action method.
- */
-export async function initOutline(rta: RuntimeAuthoring, sendAction: (action: ExternalAction) => void): Promise<void> {
-    const outline = await rta.getService<OutlineService>('outline');
-    const scenario = rta.getFlexSettings().scenario;
-    let hasSentWarning = false;
-    const reuseComponentsIds = new Set<string>();
-    async function syncOutline() {
-        try {
-            const viewNodes = await outline.get();
-            const outlineNodes = await transformNodes(viewNodes, scenario, reuseComponentsIds);
-            sendAction(outlineChanged(outlineNodes));
-            if(reuseComponentsIds.size > 0 && scenario === 'ADAPTATION_PROJECT' && !hasSentWarning) {
-                sendAction(showMessage({ message: 'Have in mind that reuse components are detected for some views in this application and controller extensions and adding fragments are not supported for such views. Controller extension and adding fragment functionality on these views will be disabled.', shouldHideIframe: false}));
-                hasSentWarning = true;
-            }
-
-        } catch (error) {
-            Log.error('Outline sync failed!', getError(error));
-        }
-    }
-    await syncOutline();
-    outline.attachEvent('update', syncOutline);
-}