@sap-ux/preview-middleware 0.16.112 → 0.16.114

package/dist/client/utils/fe-v4.ts

@@ -0,0 +1,81 @@
+import ManagedObject from 'sap/ui/base/ManagedObject';
+import TemplateComponent from 'sap/fe/core/TemplateComponent';
+import Component from 'sap/ui/core/Component';
+import AppComponent from 'sap/fe/core/AppComponent';
+import XMLView from 'sap/ui/core/mvc/XMLView';
+import type { Manifest } from 'sap/ui/rta/RuntimeAuthoring';
+import { isA } from './core';
+
+
+/**
+ * Gets app component of a v4 project.
+ *
+ * @param control - ManagedObject.
+ * @returns AppComponent.
+ */
+export function getAppComponent(control: ManagedObject): AppComponent | undefined {
+    const ownerComponent = Component.getOwnerComponentFor(control);
+    if (ownerComponent?.isA<TemplateComponent>('sap.fe.core.TemplateComponent')) {
+        return ownerComponent.getAppComponent();
+    }
+    return undefined;
+}
+
+/**
+ * Gets reference id of the app.
+ *
+ * @param control - ManagedObject.
+ * @returns string.
+ */
+export function getReference(control: ManagedObject): string {
+    const manifest = getAppComponent(control)?.getManifest() as Manifest;
+    return manifest?.['sap.app']?.id ?? '';
+}
+
+/**
+ * Determines the page type of v4 app.
+ *
+ * @param control - ManagedObject.
+ * @returns 'ObjectPage' | 'ListReport' | undefined.
+ */
+export function getV4PageType(control: ManagedObject): 'ObjectPage' | 'ListReport' | undefined {
+    const component = Component.getOwnerComponentFor(control);
+    if (!component?.isA<TemplateComponent>('sap.fe.core.TemplateComponent')) {
+        return undefined;
+    }
+    const view = component.getRootControl();
+    const name = (view as XMLView).getViewName();
+    if (name === 'sap.fe.templates.ObjectPage.ObjectPage') {
+        return 'ObjectPage';
+    }
+    if (name === 'sap.fe.templates.ListReport.ListReport') {
+        return 'ListReport';
+    }
+    return undefined;
+}
+
+/**
+ * Get the containing page name of a control.
+ *
+ * @param control - UI5 control instance.
+ * @returns Page name to which the control belongs.
+ */
+export function getPageName(control: ManagedObject): string | undefined {
+    const component = Component.getOwnerComponentFor(control);
+    if (!isA<TemplateComponent>('sap.fe.core.TemplateComponent', component)) {
+        return undefined;
+    }
+    const view = component.getRootControl();
+    return view.getId().split('::').pop();
+}
+
+export function getConfigMapControlIdMap(page: string | undefined, propertyPathSegments: string[]): string {
+    if (page && !propertyPathSegments.length) {
+        return page;
+    }
+
+    if (page) {
+        return `${page}-${propertyPathSegments.join('/')}`;
+    }
+    return propertyPathSegments.join('/');
+}

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.112",
+  "version": "0.16.114",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -25,12 +25,12 @@
     "ejs": "3.1.10",
     "mem-fs": "2.1.0",
     "mem-fs-editor": "9.4.0",
+    "@sap-ux/btp-utils": "0.16.0",
     "@sap-ux/logger": "0.6.0",
     "@sap-ux/feature-toggle": "0.2.2",
-    "@sap-ux/btp-utils": "0.16.0",
     "@sap-ux/adp-tooling": "0.12.75",
-    "@sap-ux/control-property-editor-sources": "npm:@sap-ux/control-property-editor@0.5.24",
-    "@sap-ux/project-access": "1.28.6"
+    "@sap-ux/project-access": "1.28.6",
+    "@sap-ux/control-property-editor-sources": "npm:@sap-ux/control-property-editor@0.5.25"
   },
   "devDependencies": {
     "@types/ejs": "3.1.2",
@@ -46,7 +46,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.11.25",
+    "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@0.11.28",
     "@sap-ux/axios-extension": "1.17.2",
     "@sap-ux/store": "0.9.3",
     "@sap-ux/ui5-info": "0.8.3",