@sap-ux/preview-middleware 0.16.58 → 0.16.59

package/dist/client/cpe/quick-actions/registry.ts

@@ -0,0 +1,156 @@
+import NavContainer from 'sap/m/NavContainer';
+import FlexibleColumnLayout from 'sap/f/FlexibleColumnLayout';
+import { LayoutType } from 'sap/f/library';
+import Control from 'sap/ui/core/Control';
+import XMLView from 'sap/ui/core/mvc/XMLView';
+import Log from 'sap/base/Log';
+
+import { QuickActionActivationContext, QuickActionDefinitionGroup } from './quick-action-definition';
+
+import type { ControlTreeIndex } from '../types';
+import { getControlById } from '../../utils/core';
+import { getRootControlFromComponentContainer } from '../utils';
+
+const NAV_CONTAINER_CONTROL_TYPE = 'sap.m.NavContainer';
+const FLEXIBLE_COLUMN_LAYOUT_CONTROL_TYPE = 'sap.f.FlexibleColumnLayout';
+
+export interface ActivePage<T extends string> {
+    name: T;
+    view: XMLView;
+}
+
+/**
+ * Base class for Quick Action definition providers.
+ *
+ */
+export abstract class QuickActionDefinitionRegistry<T extends string> {
+    /**
+     * Mapping of page view name to page type name.
+     */
+    PAGE_NAME_MAP: Record<string, T> = {};
+
+    /**
+     * Provides a list of Quick Action definitions that are applicable for the given context.
+     *
+     * @param _context - Activation context.
+     */
+    getDefinitions(_context: QuickActionActivationContext): QuickActionDefinitionGroup[] {
+        throw new Error('Not implemented!');
+    }
+
+    /**
+     * Finds component container from the page control.
+     *
+     * @param page - Page control provided by containers.
+     * @returns ComponentContainer control.
+     */
+    protected getComponentContainerFromPage(page: Control): Control | undefined {
+        return page;
+    }
+
+    /**
+     * Returns a list of Active pages based on the provided control index.
+     *
+     * @param controlIndex - Control tree index.
+     * @returns A list of Active pages.
+     */
+    protected getActivePageContent(controlIndex: ControlTreeIndex): ActivePage<T>[] {
+        const views = this.getActiveViews(controlIndex);
+        const pages: ActivePage<T>[] = [];
+        for (const view of views) {
+            const name = view.getViewName();
+            const pageName = this.PAGE_NAME_MAP[name];
+            if (pageName) {
+                pages.push({
+                    name: pageName,
+                    view
+                });
+            } else {
+                Log.warning(`Could not find matching page for view of type "${name}".`);
+            }
+        }
+        return pages;
+    }
+
+    /**
+     * Get all the root views of currently active pages.
+     *
+     * @param controlIndex - Control index.
+     * @returns List of page root views.
+     */
+    private getActiveViews(controlIndex: ControlTreeIndex): XMLView[] {
+        const pages = this.getActivePages(controlIndex);
+        const views: XMLView[] = [];
+
+        for (const page of pages) {
+            if (page) {
+                const container = this.getComponentContainerFromPage(page);
+                if (container) {
+                    const rootControl = getRootControlFromComponentContainer(container);
+                    if (rootControl) {
+                        views.push(rootControl);
+                    }
+                }
+            }
+        }
+        return views;
+    }
+
+    /**
+     * Finds active page controls from the control tree index.
+     *
+     * @param controlIndex - Control tree index.
+     * @returns A list of page controls.
+     */
+    private getActivePages(controlIndex: ControlTreeIndex): (Control | undefined)[] {
+        const navContainerNode = controlIndex[NAV_CONTAINER_CONTROL_TYPE]?.[0];
+        if (navContainerNode) {
+            const control = getControlById(navContainerNode.controlId);
+            if (control instanceof NavContainer) {
+                return [control.getCurrentPage()];
+            }
+        }
+
+        const flexibleLayoutNode = controlIndex[FLEXIBLE_COLUMN_LAYOUT_CONTROL_TYPE]?.[0];
+        if (flexibleLayoutNode) {
+            const control = getControlById(flexibleLayoutNode.controlId);
+            if (control instanceof FlexibleColumnLayout) {
+                return this.getVisibleFlexibleColumnLayoutPages(control);
+            }
+        }
+
+        return [];
+    }
+
+    /**
+     * Finds the visible Flexible Column Layout pages.
+     * 
+     * @param control - Flexible Column Layout control.
+     * @returns A list of visible pages.
+     */
+
+    private getVisibleFlexibleColumnLayoutPages(control: FlexibleColumnLayout): (Control | undefined)[] {
+        const layout = control.getLayout();
+        switch (layout) {
+            case LayoutType.OneColumn:
+                return [control.getCurrentBeginColumnPage()];
+            case LayoutType.MidColumnFullScreen:
+                return [control.getCurrentMidColumnPage()];
+            case LayoutType.EndColumnFullScreen:
+                return [control.getCurrentEndColumnPage()];
+            case LayoutType.ThreeColumnsBeginExpandedEndHidden:
+            case LayoutType.ThreeColumnsMidExpanded:
+            case LayoutType.ThreeColumnsMidExpandedEndHidden:
+            case LayoutType.ThreeColumnsEndExpanded:
+                return [
+                    control.getCurrentBeginColumnPage(),
+                    control.getCurrentMidColumnPage(),
+                    control.getCurrentEndColumnPage()
+                ];
+            case LayoutType.TwoColumnsMidExpanded:
+            case LayoutType.TwoColumnsBeginExpanded:
+                return [control.getCurrentBeginColumnPage(), control.getCurrentMidColumnPage()];
+        }
+        return [];
+    }
+}

package/dist/client/cpe/quick-actions/utils.js

@@ -0,0 +1,94 @@
+"use strict";
+
+sap.ui.define(["../../utils/core"], function (____utils_core) {
+  "use strict";
+
+  const getControlById = ____utils_core["getControlById"];
+  const isA = ____utils_core["isA"];
+  /**
+   * Checks if control is visible in the page.
+   * 
+   * @param page - Page control.
+   * @param controlId - UI5 control id.
+   * @returns True if control is visible in the page.
+   */
+  function pageHasControlId(page, controlId) {
+    const controlDomElement = getControlById(controlId)?.getDomRef();
+    return !!controlDomElement && !!page?.getDomRef()?.contains(controlDomElement);
+  }
+
+  /**
+   * Checks if control is a child element of the rootControl.
+   * 
+   * @param control - UI5 Control to be tested.
+   * @param rootControl - UI5 root control.
+   * @returns True if control is the child of the specified rootControl.
+   */
+  function isDescendantOfPage(control, rootControl) {
+    let currentControl = control;
+    while (currentControl) {
+      if (currentControl === rootControl) {
+        return true;
+      }
+      // if parent is a reusable component, use oContainer to find the parent
+      if (isA('sap.ui.core.Component', currentControl) && currentControl?.oContainer) {
+        currentControl = currentControl.oContainer.getParent();
+      } else {
+        currentControl = currentControl.getParent();
+      }
+    }
+    return false;
+  }
+
+  /**
+   * Find all controls in page that match the provided types.
+   * 
+   * @param controlIndex - Control tree index.
+   * @param activePage - Active page control.
+   * @param controlTypes - Relevant control types.
+   * @returns A list of UI5 controls.
+   */
+  function getRelevantControlFromActivePage(controlIndex, activePage, controlTypes) {
+    const relevantControls = [];
+    for (const type of controlTypes) {
+      const controls = controlIndex[type] ?? [];
+      for (const control of controls) {
+        const ui5Control = getControlById(control.controlId);
+        const parent = ui5Control?.getParent();
+        const isActionApplicable = isDescendantOfPage(parent, activePage);
+        if (isActionApplicable && ui5Control) {
+          // if parent control added, discard adding child control.
+          // Relevant for cases where wrapper exists eg: sap.m.Table exist in sap.ui.comp.smarttable.SmartTable
+          const parentFound = relevantControls.findIndex(relevantControl => relevantControl.getId() === ui5Control.getParent()?.getId());
+          if (parentFound === -1) {
+            relevantControls.push(ui5Control);
+          }
+        }
+      }
+    }
+    return relevantControls;
+  }
+  function getParentContainer(control, type) {
+    let currentControl = control;
+    while (currentControl) {
+      if (isA(type, currentControl)) {
+        return currentControl;
+      }
+      // if parent is a reusable component, use oContainer to find the parent
+      if (isA('sap.ui.core.Component', currentControl) && currentControl?.oContainer) {
+        currentControl = currentControl.oContainer.getParent();
+      } else {
+        currentControl = currentControl.getParent();
+      }
+    }
+    return undefined;
+  }
+  var __exports = {
+    __esModule: true
+  };
+  __exports.pageHasControlId = pageHasControlId;
+  __exports.getRelevantControlFromActivePage = getRelevantControlFromActivePage;
+  __exports.getParentContainer = getParentContainer;
+  return __exports;
+});
+//# sourceMappingURL=utils.js.map

package/dist/client/cpe/quick-actions/utils.ts

@@ -0,0 +1,114 @@
+import UI5Element from 'sap/ui/core/Element';
+import Control from 'sap/ui/core/Control';
+import ManagedObject from 'sap/ui/base/ManagedObject';
+import { FEAppPage } from 'sap/ui/rta/RuntimeAuthoring';
+
+import { getControlById, isA } from '../../utils/core';
+
+import type { ControlTreeIndex } from '../types';
+import Component from 'sap/ui/core/Component';
+
+export interface FEAppPageInfo {
+    page: FEAppPage;
+    isInvisible: boolean;
+}
+export interface FEAppPagesMap {
+    [key: string]: FEAppPageInfo[];
+}
+
+/**
+ * Checks if control is visible in the page.
+ * 
+ * @param page - Page control.
+ * @param controlId - UI5 control id.
+ * @returns True if control is visible in the page.
+ */
+export function pageHasControlId(page: Control, controlId: string): boolean {
+    const controlDomElement = getControlById(controlId)?.getDomRef();
+    return !!controlDomElement && !!page?.getDomRef()?.contains(controlDomElement);
+}
+
+
+/**
+ * Checks if control is a child element of the rootControl.
+ * 
+ * @param control - UI5 Control to be tested.
+ * @param rootControl - UI5 root control.
+ * @returns True if control is the child of the specified rootControl.
+ */
+function isDescendantOfPage(control: ManagedObject | null | undefined, rootControl: ManagedObject) {
+    let currentControl = control;
+    while (currentControl) {
+        if (currentControl === rootControl) {
+            return true;
+        }
+        // if parent is a reusable component, use oContainer to find the parent
+        if (
+            isA<Component>('sap.ui.core.Component', currentControl) &&
+            (currentControl as unknown as { oContainer: Control })?.oContainer
+        ) {
+            currentControl = (currentControl as unknown as { oContainer: Control }).oContainer.getParent();
+        } else {
+            currentControl = currentControl.getParent();
+        }
+    }
+    return false;
+}
+
+/**
+ * Find all controls in page that match the provided types.
+ * 
+ * @param controlIndex - Control tree index.
+ * @param activePage - Active page control.
+ * @param controlTypes - Relevant control types.
+ * @returns A list of UI5 controls.
+ */
+export function getRelevantControlFromActivePage(
+    controlIndex: ControlTreeIndex,
+    activePage: Control,
+    controlTypes: string[]
+): UI5Element[] {
+    const relevantControls: UI5Element[] = [];
+    for (const type of controlTypes) {
+        const controls = controlIndex[type] ?? [];
+        for (const control of controls) {
+            const ui5Control = getControlById(control.controlId);
+            const parent = ui5Control?.getParent();
+            const isActionApplicable = isDescendantOfPage(parent, activePage);
+
+            if (isActionApplicable && ui5Control) {
+                // if parent control added, discard adding child control.
+                // Relevant for cases where wrapper exists eg: sap.m.Table exist in sap.ui.comp.smarttable.SmartTable
+                const parentFound = relevantControls.findIndex(
+                    (relevantControl) => relevantControl.getId() === ui5Control.getParent()?.getId()
+                );
+                if (parentFound === -1) {
+                    relevantControls.push(ui5Control);
+                }
+            }
+        }
+    }
+    return relevantControls;
+}
+
+export function getParentContainer<T extends ManagedObject>(
+    control: ManagedObject | null | undefined,
+    type: string
+): T | undefined {
+    let currentControl = control;
+    while (currentControl) {
+        if (isA<T>(type, currentControl)) {
+            return currentControl;
+        }
+        // if parent is a reusable component, use oContainer to find the parent
+        if (
+            isA<Component>('sap.ui.core.Component', currentControl) &&
+            (currentControl as unknown as { oContainer: Control })?.oContainer
+        ) {
+            currentControl = (currentControl as unknown as { oContainer: Control }).oContainer.getParent();
+        } else {
+            currentControl = currentControl.getParent();
+        }
+    }
+    return undefined;
+}

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

@@ -9,6 +9,7 @@ import {
 } from '@sap-ux-private/control-property-editor-common';
 import { ActionSenderFunction, SubscribeFunction } from './types';
 import RuntimeAuthoring from 'sap/ui/rta/RuntimeAuthoring';
+
 /**
  * A Class of RtaService
  */

package/dist/client/cpe/selection.js

@@ -7,9 +7,9 @@ sap.ui.define([
     './documentation',
     'sap/ui/dt/OverlayRegistry',
     'sap/ui/dt/OverlayUtil',
-    './ui5-utils',
+    '../utils/core',
     '../utils/error'
-], function (___sap_ux_private_control_property_editor_common, ___control_data, ___utils, Log, ___documentation, OverlayRegistry, OverlayUtil, ___ui5_utils, ___utils_error) {
+], function (___sap_ux_private_control_property_editor_common, ___control_data, ___utils, Log, ___documentation, OverlayRegistry, OverlayUtil, ___utils_core, ___utils_error) {
     'use strict';
     const controlSelected = ___sap_ux_private_control_property_editor_common['controlSelected'];
     const propertyChanged = ___sap_ux_private_control_property_editor_common['propertyChanged'];
@@ -18,7 +18,7 @@ sap.ui.define([
     const buildControlData = ___control_data['buildControlData'];
     const getRuntimeControl = ___utils['getRuntimeControl'];
     const getDocumentation = ___documentation['getDocumentation'];
-    const getComponent = ___ui5_utils['getComponent'];
+    const getComponent = ___utils_core['getComponent'];
     const getError = ___utils_error['getError'];
     function propertyChangeId(controlId, propertyName) {
         return [

package/dist/client/cpe/selection.ts

@@ -19,7 +19,7 @@ import Log from 'sap/base/Log';
 import { getDocumentation } from './documentation';
 import OverlayRegistry from 'sap/ui/dt/OverlayRegistry';
 import OverlayUtil from 'sap/ui/dt/OverlayUtil';
-import { getComponent } from './ui5-utils';
+import { getComponent } from '../utils/core';
 import { getError } from '../utils/error';
 
 export interface PropertyChangeParams {

package/dist/client/cpe/types.ts

@@ -1,4 +1,4 @@
-import type { ExternalAction } from '@sap-ux-private/control-property-editor-common';
+import type { ExternalAction, OutlineNode } from '@sap-ux-private/control-property-editor-common';
 import type RuntimeAuthoring from 'sap/ui/rta/RuntimeAuthoring';
 
 export interface UI5AdaptationOptions {
@@ -10,7 +10,7 @@ export type PropertyValue = boolean | object | number | string;
 
 export interface UI5ControlProperty {
     defaultValue: unknown;
-    enumValues: { [key: string]: string } | null;
+    enumValues: Record<string,string> | undefined;
     isArray: boolean;
     isDeprecated: boolean;
     isEnabled: boolean;
@@ -35,8 +35,12 @@ export interface UI5ControlData {
 export type ActionHandler = (action: ExternalAction) => Promise<void>;
 export type ActionSenderFunction = (action: ExternalAction) => void;
 export type SubscribeFunction = (handler: ActionHandler) => void;
+export type UnSubscribeFunction = (handler: ActionHandler) => void;
 
 export interface Service {
-    init(sendAction: ActionSenderFunction, subscribe: SubscribeFunction): void;
+    init(sendAction: ActionSenderFunction, subscribe: SubscribeFunction): void | Promise<void>;
 }
 
+export interface ControlTreeIndex {
+    [controlType: string]: OutlineNode[]
+}

package/dist/client/cpe/ui5-utils.js

@@ -1,23 +1,8 @@
 "use strict";
 
-sap.ui.define(["sap/ui/core/Component", "sap/ui/core/IconPool"], function (Component, IconPool) {
+sap.ui.define(["sap/ui/core/IconPool"], function (IconPool) {
   "use strict";
 
-  /**
-   * Gets Component by id.
-   *
-   * @param id - unique identifier for control
-   * @returns Component | undefined
-   */
-  function getComponent(id) {
-    if (Component?.get) {
-      return Component.get(id);
-    } else {
-      // Older version must be still supported until maintenance period.
-      return sap.ui.getCore().getComponent(id); // NOSONAR
-    }
-  }
-
   /**
    * Get ui5 icons.
    *
@@ -44,7 +29,6 @@ sap.ui.define(["sap/ui/core/Component", "sap/ui/core/IconPool"], function (Compo
   var __exports = {
     __esModule: true
   };
-  __exports.getComponent = getComponent;
   __exports.getIcons = getIcons;
   return __exports;
 });

package/dist/client/cpe/ui5-utils.ts

@@ -1,23 +1,6 @@
 import type { IconDetails } from '@sap-ux-private/control-property-editor-common';
-import Component from 'sap/ui/core/Component';
-import type { ID } from 'sap/ui/core/library';
 import IconPool from 'sap/ui/core/IconPool';
 
-/**
- * Gets Component by id.
- *
- * @param id - unique identifier for control
- * @returns Component | undefined
- */
-export function getComponent<T extends Component>(id: ID): T | undefined {
-    if (Component?.get) {
-        return Component.get(id) as T;
-    } else {
-        // Older version must be still supported until maintenance period.
-        return sap.ui.getCore().getComponent(id) as T; // NOSONAR
-    }
-}
-
 /**
  * Get ui5 icons.
  *

package/dist/client/cpe/utils.js

@@ -1,8 +1,10 @@
 "use strict";
 
-sap.ui.define([], function () {
+sap.ui.define(["sap/ui/core/ComponentContainer", "sap/ui/core/mvc/XMLView", "sap/ui/core/UIComponent", "../utils/core", "../utils/version"], function (ComponentContainer, XMLView, UIComponent, ___utils_core, ___utils_version) {
   "use strict";
 
+  const getComponent = ___utils_core["getComponent"];
+  const isLowerThanMinimalUi5Version = ___utils_version["isLowerThanMinimalUi5Version"];
   /**
    * Get runtime control.
    *
@@ -40,11 +42,58 @@ sap.ui.define([], function () {
       });
     });
   }
+
+  /**
+   * Function that checks if control is reuse component
+   *
+   * @param controlId id control
+   * @param ui5VersionInfo UI5 version information
+   * @returns boolean if control is from reused component view
+   */
+  function isReuseComponent(controlId, ui5VersionInfo) {
+    if (isLowerThanMinimalUi5Version(ui5VersionInfo, {
+      major: 1,
+      minor: 115
+    })) {
+      return false;
+    }
+    const component = getComponent(controlId);
+    if (!component) {
+      return false;
+    }
+    const manifest = component.getManifest();
+    if (!manifest) {
+      return false;
+    }
+    return manifest['sap.app']?.type === 'component';
+  }
+
+  /**
+   * Gets the root view of component for the provided ComponentContainer control.
+   *
+   * @param container ComponentContainer control.
+   * @returns XMLView which is the root control of the component if it exists.
+   */
+  function getRootControlFromComponentContainer(container) {
+    if (container instanceof ComponentContainer) {
+      const componentId = container.getComponent();
+      const component = getComponent(componentId);
+      if (component instanceof UIComponent) {
+        const rootControl = component.getRootControl();
+        if (rootControl instanceof XMLView) {
+          return rootControl;
+        }
+      }
+    }
+    return undefined;
+  }
   var __exports = {
     __esModule: true
   };
   __exports.getRuntimeControl = getRuntimeControl;
   __exports.getLibrary = getLibrary;
+  __exports.isReuseComponent = isReuseComponent;
+  __exports.getRootControlFromComponentContainer = getRootControlFromComponentContainer;
   return __exports;
 });
 //# sourceMappingURL=utils.js.map

package/dist/client/cpe/utils.ts

@@ -2,6 +2,14 @@ import type ManagedObject from 'sap/ui/base/ManagedObject';
 import type Control from 'sap/ui/core/Control';
 import type ElementOverlay from 'sap/ui/dt/ElementOverlay';
 import DataType from 'sap/ui/base/DataType';
+import type { Manifest } from 'sap/ui/rta/RuntimeAuthoring';
+import ComponentContainer from 'sap/ui/core/ComponentContainer';
+import XMLView from 'sap/ui/core/mvc/XMLView';
+import UIComponent from 'sap/ui/core/UIComponent';
+
+
+import { getComponent } from '../utils/core';
+import { isLowerThanMinimalUi5Version, Ui5VersionInfo } from '../utils/version';
 
 export interface PropertiesInfo {
     defaultValue: string;
@@ -14,6 +22,7 @@ export interface Properties {
     [key: string]: PropertiesInfo;
 }
 
+
 export interface ManagedObjectMetadataProperties {
     name: string;
     defaultValue: string | null;
@@ -60,3 +69,48 @@ export async function getLibrary(controlName: string): Promise<string> {
         });
     });
 }
+
+/**
+ * Function that checks if control is reuse component
+ *
+ * @param controlId id control
+ * @param ui5VersionInfo UI5 version information
+ * @returns boolean if control is from reused component view
+ */
+export function isReuseComponent(controlId: string, ui5VersionInfo: Ui5VersionInfo): boolean {
+    if (isLowerThanMinimalUi5Version(ui5VersionInfo, { major: 1, minor: 115 })) {
+        return false;
+    }
+
+    const component = getComponent(controlId);
+    if (!component) {
+        return false;
+    }
+
+    const manifest = component.getManifest() as Manifest;
+    if (!manifest) {
+        return false;
+    }
+
+    return manifest['sap.app']?.type === 'component';
+}
+
+/**
+ * Gets the root view of component for the provided ComponentContainer control.
+ *
+ * @param container ComponentContainer control.
+ * @returns XMLView which is the root control of the component if it exists.
+ */
+export function getRootControlFromComponentContainer(container: Control): XMLView | undefined {
+    if (container instanceof ComponentContainer) {
+        const componentId = container.getComponent();
+        const component = getComponent(componentId);
+        if (component instanceof UIComponent) {
+            const rootControl = component.getRootControl();
+            if (rootControl instanceof XMLView) {
+                return rootControl;
+            }
+        }
+    }
+    return undefined;
+}

package/dist/client/i18n.js

@@ -0,0 +1,43 @@
+"use strict";
+
+sap.ui.define(["sap/base/i18n/ResourceBundle"], function (ResourceBundle) {
+  "use strict";
+
+  const BUNDLE_CACHE = {};
+  async function getResourceBundle(key) {
+    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;
+  }
+  class TextBundle {
+    constructor(bundle) {
+      this.bundle = bundle;
+    }
+    getText(key, args) {
+      return this.bundle.getText(key, args) ?? key;
+    }
+  }
+  async function getTextBundle() {
+    let key = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 'open.ux.preview.client';
+    const bundle = await getResourceBundle(key);
+    return new TextBundle(bundle);
+  }
+  var __exports = {
+    __esModule: true
+  };
+  __exports.getResourceBundle = getResourceBundle;
+  __exports.TextBundle = TextBundle;
+  __exports.getTextBundle = getTextBundle;
+  return __exports;
+});
+//# sourceMappingURL=i18n.js.map