@sap-ux/preview-middleware 0.19.6 → 0.19.8

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

@@ -114,19 +114,18 @@ sap.ui.define(["sap/ui/core/Component", "./core", "sap/ui/rta/command/CommandFac
    * @returns array with page descriptors
    */
   function getV4ApplicationPages(manifest) {
-    if (manifest['sap.ui5']?.routing?.targets) {
-      const targets = manifest['sap.ui5'].routing?.targets ?? {};
-      const result = Object.keys(targets).map(key => {
-        const entitySet = targets[key].options?.settings?.entitySet;
-        const id = targets[key].id;
-        return {
-          id,
-          entitySet
-        };
-      });
-      return result;
+    const result = [];
+    const targets = manifest['sap.ui5'].routing?.targets ?? {};
+    for (const target of Object.values(targets)) {
+      if (target.name === 'sap.fe.templates.ObjectPage') {
+        result.push({
+          id: target.id,
+          entitySet: target.options?.settings?.entitySet,
+          contextPath: target.options?.settings?.contextPath
+        });
+      }
     }
-    return [];
+    return result;
   }
   var __exports = {
     __esModule: true

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

@@ -138,15 +138,17 @@ export async function createManifestPropertyChange(
  * @param manifest - manifest object
  * @returns array with page descriptors
  */
-export function getV4ApplicationPages(manifest: Manifest): { id: string; entitySet: string | undefined }[] {
-    if (manifest['sap.ui5']?.routing?.targets) {
-        const targets = manifest['sap.ui5'].routing?.targets ?? {};
-        const result = Object.keys(targets).map((key) => {
-            const entitySet = targets[key].options?.settings?.entitySet;
-            const id = targets[key].id;
-            return { id, entitySet };
-        });
-        return result;
+export function getV4ApplicationPages(manifest: Manifest): { id: string; entitySet?: string; contextPath?: string }[] {
+    const result: { id: string; entitySet?: string; contextPath?: string }[] = [];
+    const targets = manifest['sap.ui5'].routing?.targets ?? {};
+    for (const target of Object.values(targets)) {
+        if (target.name === 'sap.fe.templates.ObjectPage') {
+            result.push({
+                id: target.id,
+                entitySet: target.options?.settings?.entitySet,
+                contextPath: target.options?.settings?.contextPath
+            });
+        }
     }
-    return [];
+    return result;
 }

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.19.6",
+  "version": "0.19.8",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -25,11 +25,11 @@
     "ejs": "3.1.10",
     "mem-fs": "2.1.0",
     "mem-fs-editor": "9.4.0",
-    "@sap-ux/adp-tooling": "0.13.21",
+    "@sap-ux/adp-tooling": "0.13.22",
     "@sap-ux/btp-utils": "1.0.2",
+    "@sap-ux/control-property-editor-sources": "npm:@sap-ux/control-property-editor@0.6.1",
     "@sap-ux/feature-toggle": "0.2.3",
     "@sap-ux/logger": "0.6.0",
-    "@sap-ux/control-property-editor-sources": "npm:@sap-ux/control-property-editor@0.6.1",
     "@sap-ux/project-access": "1.29.18",
     "@sap-ux/system-access": "0.5.34"
   },
@@ -49,11 +49,11 @@
     "nock": "13.4.0",
     "npm-run-all2": "6.2.0",
     "supertest": "6.3.3",
-    "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@0.13.9",
+    "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@0.13.10",
     "@sap-ux/axios-extension": "1.19.2",
+    "@sap-ux/i18n": "0.2.3",
     "@sap-ux/store": "1.0.0",
-    "@sap-ux/ui5-info": "0.9.1",
-    "@sap-ux/i18n": "0.2.3"
+    "@sap-ux/ui5-info": "0.9.1"
   },
   "peerDependencies": {
     "express": "4"

package/dist/client/adp/quick-actions/common/add-new-subpage.js

@@ -1,140 +0,0 @@
-"use strict";
-
-sap.ui.define(["sap/ui/core/Component", "sap/ui/dt/OverlayRegistry", "../../../cpe/quick-actions/utils", "../../../utils/core", "../../../utils/application", "../../dialog-factory", "../fe-v2/utils", "../../../utils/fe-v2", "../../../utils/fe-v4", "../../../i18n", "../simple-quick-action-base", "../dialog-enablement-validator"], function (Component, OverlayRegistry, _____cpe_quick_actions_utils, _____utils_core, _____utils_application, ____dialog_factory, ___fe_v2_utils, _____utils_fe_v2, _____utils_fe_v4, _____i18n, ___simple_quick_action_base, ___dialog_enablement_validator) {
-  "use strict";
-
-  const pageHasControlId = _____cpe_quick_actions_utils["pageHasControlId"];
-  const getControlById = _____utils_core["getControlById"];
-  const isA = _____utils_core["isA"];
-  const getApplicationType = _____utils_application["getApplicationType"];
-  const DialogFactory = ____dialog_factory["DialogFactory"];
-  const DialogNames = ____dialog_factory["DialogNames"];
-  const areManifestChangesSupported = ___fe_v2_utils["areManifestChangesSupported"];
-  const getV2ApplicationPages = _____utils_fe_v2["getV2ApplicationPages"];
-  const getV4ApplicationPages = _____utils_fe_v4["getV4ApplicationPages"];
-  const getTextBundle = _____i18n["getTextBundle"];
-  const SimpleQuickActionDefinitionBase = ___simple_quick_action_base["SimpleQuickActionDefinitionBase"];
-  const DIALOG_ENABLEMENT_VALIDATOR = ___dialog_enablement_validator["DIALOG_ENABLEMENT_VALIDATOR"];
-  const ADD_NEW_OBJECT_PAGE_ACTION = 'add-new-subpage';
-  const CONTROL_TYPES = ['sap.f.DynamicPage', 'sap.uxap.ObjectPageLayout'];
-
-  /**
-   * Quick Action for adding a custom page action.
-   */
-  class AddNewSubpage extends SimpleQuickActionDefinitionBase {
-    currentPageDescriptor = {
-      entitySet: '',
-      pageType: '',
-      navProperties: []
-    };
-    constructor(context) {
-      super(ADD_NEW_OBJECT_PAGE_ACTION, [], 'QUICK_ACTION_ADD_NEW_SUB_PAGE', context, [{
-        run: async () => {
-          const i18n = await getTextBundle();
-          if (this.currentPageDescriptor.navProperties.length === 0) {
-            return {
-              type: 'error',
-              message: i18n.getText('NO_SUB_PAGES_TO_ADD')
-            };
-          }
-          return undefined;
-        }
-      }, DIALOG_ENABLEMENT_VALIDATOR]);
-    }
-    getApplicationPages() {
-      if (this.appType === 'fe-v2') {
-        return getV2ApplicationPages(this.context.manifest);
-      } else if (this.appType === 'fe-v4') {
-        return getV4ApplicationPages(this.context.manifest);
-      }
-      return [];
-    }
-    prepareNavigationData(entityType, metaModel) {
-      const existingPages = this.getApplicationPages();
-      if (this.currentPageDescriptor.pageType === 'sap.suite.ui.generic.template.ObjectPage') {
-        // Navigation from Object Page
-        for (const navProp of entityType?.navigationProperty || []) {
-          const associationEnd = metaModel.getODataAssociationEnd(entityType, navProp.name);
-          if (associationEnd?.multiplicity !== '*') {
-            continue;
-          }
-          const entityContainer = metaModel.getODataEntityContainer();
-          if (!entityContainer?.entitySet?.length) {
-            continue;
-          }
-          const targetEntitySet = entityContainer.entitySet.find(item => item.entityType === associationEnd.type);
-          const pageExists = existingPages.some(page => page.entitySet === targetEntitySet?.name);
-          if (targetEntitySet && !pageExists) {
-            this.currentPageDescriptor.navProperties.push({
-              entitySet: targetEntitySet.name,
-              navProperty: navProp.name
-            });
-          }
-        }
-        return;
-      }
-
-      // navigation from LR or ALP (only OP based on current entitySet is possible)
-      const pageExists = existingPages.some(page => page.entitySet === this.currentPageDescriptor.entitySet);
-      if (!pageExists) {
-        this.currentPageDescriptor.navProperties.push({
-          entitySet: this.currentPageDescriptor.entitySet,
-          navProperty: this.currentPageDescriptor.entitySet
-        });
-      }
-    }
-    async initialize() {
-      if (!(await areManifestChangesSupported(this.context.manifest))) {
-        return Promise.resolve();
-      }
-      this.appType = getApplicationType(this.context.manifest);
-      const allControls = CONTROL_TYPES.flatMap(item => this.context.controlIndex[item] ?? []);
-      const control = allControls.find(c => pageHasControlId(this.context.view, c.controlId));
-      const pageType = this.context.view.getViewName().split('.view.')[0];
-      this.currentPageDescriptor.pageType = pageType;
-      const metaModel = this.context.rta.getRootControlInstance().getModel()?.getMetaModel();
-      if (!metaModel || !control) {
-        return Promise.resolve();
-      }
-      const modifiedControl = getControlById(control.controlId);
-      if (!modifiedControl) {
-        return Promise.resolve();
-      }
-      const component = Component.getOwnerComponentFor(modifiedControl);
-      if (!isA('sap.suite.ui.generic.template.lib.TemplateComponent', component)) {
-        return Promise.reject(new Error('Unexpected type of page owner component'));
-      }
-      const entitySetName = component.getEntitySet();
-      if (!entitySetName) {
-        return Promise.resolve();
-      }
-      this.currentPageDescriptor.entitySet = entitySetName;
-      const entitySet = metaModel.getODataEntitySet(entitySetName);
-      const entityType = metaModel.getODataEntityType(entitySet.entityType);
-      this.prepareNavigationData(entityType, metaModel);
-      this.control = modifiedControl;
-      return Promise.resolve();
-    }
-    async execute() {
-      const overlay = OverlayRegistry.getOverlay(this.control);
-      const appReference = this.context.flexSettings.projectId;
-      await DialogFactory.createDialog(overlay, this.context.rta, DialogNames.ADD_SUBPAGE, undefined, {
-        appType: this.appType,
-        appReference,
-        title: 'ADD_SUB_PAGE_DIALOG_TITLE',
-        pageDescriptor: this.currentPageDescriptor
-      }, {
-        actionName: this.type,
-        telemetryEventIdentifier: this.getTelemetryIdentifier()
-      });
-      return [];
-    }
-  }
-  var __exports = {
-    __esModule: true
-  };
-  __exports.ADD_NEW_OBJECT_PAGE_ACTION = ADD_NEW_OBJECT_PAGE_ACTION;
-  __exports.AddNewSubpage = AddNewSubpage;
-  return __exports;
-});
-//# sourceMappingURL=add-new-subpage.js.map

package/dist/client/adp/quick-actions/common/add-new-subpage.ts

@@ -1,168 +0,0 @@
-import Component from 'sap/ui/core/Component';
-import FlexCommand from 'sap/ui/rta/command/FlexCommand';
-import ObjectPageLayout from 'sap/uxap/ObjectPageLayout';
-import ODataModel from 'sap/ui/model/odata/v2/ODataModel';
-import OverlayRegistry from 'sap/ui/dt/OverlayRegistry';
-import TemplateComponent from 'sap/suite/ui/generic/template/lib/TemplateComponent';
-
-import { QuickActionContext, SimpleQuickActionDefinition } from '../../../cpe/quick-actions/quick-action-definition';
-import { pageHasControlId } from '../../../cpe/quick-actions/utils';
-import { getControlById, isA } from '../../../utils/core';
-import ODataMetaModel, { EntityContainer, EntitySet, EntityType } from 'sap/ui/model/odata/ODataMetaModel';
-import { ApplicationType, getApplicationType } from '../../../utils/application';
-import { DialogFactory, DialogNames } from '../../dialog-factory';
-import { areManifestChangesSupported } from '../fe-v2/utils';
-import { getV2ApplicationPages } from '../../../utils/fe-v2';
-import { getV4ApplicationPages } from '../../../utils/fe-v4';
-import { EnablementValidatorResult } from '../enablement-validator';
-import { getTextBundle } from '../../../i18n';
-import { SimpleQuickActionDefinitionBase } from '../simple-quick-action-base';
-import { DIALOG_ENABLEMENT_VALIDATOR } from '../dialog-enablement-validator';
-
-export const ADD_NEW_OBJECT_PAGE_ACTION = 'add-new-subpage';
-const CONTROL_TYPES = ['sap.f.DynamicPage', 'sap.uxap.ObjectPageLayout'];
-
-/**
- * Quick Action for adding a custom page action.
- */
-export class AddNewSubpage extends SimpleQuickActionDefinitionBase implements SimpleQuickActionDefinition {
-    private readonly currentPageDescriptor: {
-        pageType: string;
-        entitySet: string;
-        navProperties: { navProperty: string; entitySet: string }[]; // only navProperty with 1:n relationship and the entitySet
-    } = {
-        entitySet: '',
-        pageType: '',
-        navProperties: []
-    };
-
-    private appType: ApplicationType;
-
-    constructor(context: QuickActionContext) {
-        super(ADD_NEW_OBJECT_PAGE_ACTION, [], 'QUICK_ACTION_ADD_NEW_SUB_PAGE', context, [
-            {
-                run: async (): Promise<EnablementValidatorResult> => {
-                    const i18n = await getTextBundle();
-                    if (this.currentPageDescriptor.navProperties.length === 0) {
-                        return {
-                            type: 'error',
-                            message: i18n.getText('NO_SUB_PAGES_TO_ADD')
-                        };
-                    }
-                    return undefined;
-                }
-            },
-            DIALOG_ENABLEMENT_VALIDATOR
-        ]);
-    }
-
-    private getApplicationPages() {
-        if (this.appType === 'fe-v2') {
-            return getV2ApplicationPages(this.context.manifest);
-        } else if (this.appType === 'fe-v4') {
-            return getV4ApplicationPages(this.context.manifest);
-        }
-        return [];
-    }
-
-    private prepareNavigationData(entityType: EntityType, metaModel: ODataMetaModel): void {
-        const existingPages = this.getApplicationPages();
-        if (this.currentPageDescriptor.pageType === 'sap.suite.ui.generic.template.ObjectPage') {
-            // Navigation from Object Page
-            for (const navProp of entityType?.navigationProperty || []) {
-                const associationEnd = metaModel.getODataAssociationEnd(entityType, navProp.name);
-                if (associationEnd?.multiplicity !== '*') {
-                    continue;
-                }
-                const entityContainer = metaModel.getODataEntityContainer() as EntityContainer;
-                if (!entityContainer?.entitySet?.length) {
-                    continue;
-                }
-                const targetEntitySet = entityContainer.entitySet.find(
-                    (item) => item.entityType === associationEnd.type
-                );
-                const pageExists = existingPages.some((page) => page.entitySet === targetEntitySet?.name);
-                if (targetEntitySet && !pageExists) {
-                    this.currentPageDescriptor.navProperties.push({
-                        entitySet: targetEntitySet.name,
-                        navProperty: navProp.name
-                    });
-                }
-            }
-            return;
-        }
-
-        // navigation from LR or ALP (only OP based on current entitySet is possible)
-        const pageExists = existingPages.some((page) => page.entitySet === this.currentPageDescriptor.entitySet);
-        if (!pageExists) {
-            this.currentPageDescriptor.navProperties.push({
-                entitySet: this.currentPageDescriptor.entitySet,
-                navProperty: this.currentPageDescriptor.entitySet
-            });
-        }
-    }
-
-    async initialize(): Promise<void> {
-        if (!(await areManifestChangesSupported(this.context.manifest))) {
-            return Promise.resolve();
-        }
-
-        this.appType = getApplicationType(this.context.manifest);
-
-        const allControls = CONTROL_TYPES.flatMap((item) => this.context.controlIndex[item] ?? []);
-        const control = allControls.find((c) => pageHasControlId(this.context.view, c.controlId));
-
-        const pageType = this.context.view.getViewName().split('.view.')[0];
-        this.currentPageDescriptor.pageType = pageType;
-
-        const metaModel = (this.context.rta.getRootControlInstance().getModel() as ODataModel)?.getMetaModel();
-        if (!metaModel || !control) {
-            return Promise.resolve();
-        }
-
-        const modifiedControl = getControlById<ObjectPageLayout>(control.controlId);
-        if (!modifiedControl) {
-            return Promise.resolve();
-        }
-
-        const component = Component.getOwnerComponentFor(modifiedControl);
-        if (!isA<TemplateComponent>('sap.suite.ui.generic.template.lib.TemplateComponent', component)) {
-            return Promise.reject(new Error('Unexpected type of page owner component'));
-        }
-
-        const entitySetName = component.getEntitySet();
-        if (!entitySetName) {
-            return Promise.resolve();
-        }
-
-        this.currentPageDescriptor.entitySet = entitySetName;
-
-        const entitySet = metaModel.getODataEntitySet(entitySetName) as EntitySet;
-        const entityType = metaModel.getODataEntityType(entitySet.entityType) as EntityType;
-
-        this.prepareNavigationData(entityType, metaModel);
-
-        this.control = modifiedControl;
-
-        return Promise.resolve();
-    }
-
-    async execute(): Promise<FlexCommand[]> {
-        const overlay = OverlayRegistry.getOverlay(this.control!);
-        const appReference = this.context.flexSettings.projectId;
-        await DialogFactory.createDialog(
-            overlay,
-            this.context.rta,
-            DialogNames.ADD_SUBPAGE,
-            undefined,
-            {
-                appType: this.appType,
-                appReference,
-                title: 'ADD_SUB_PAGE_DIALOG_TITLE',
-                pageDescriptor: this.currentPageDescriptor
-            },
-            { actionName: this.type, telemetryEventIdentifier: this.getTelemetryIdentifier() }
-        );
-        return [];
-    }
-}