@sap-ux/preview-middleware 0.18.18 → 0.18.20

package/dist/client/i18n.js

@@ -1,58 +1,58 @@
-"use strict";
-
-sap.ui.define(["sap/base/i18n/ResourceBundle", "sap/ui/model/resource/ResourceModel"], function (ResourceBundle, ResourceModel) {
-  "use strict";
-
-  const BUNDLE_CACHE = {};
-  const MODEL_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;
-  }
-  async function getResourceModel() {
-    let key = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 'open.ux.preview.client';
-    const cachedModel = MODEL_CACHE[key];
-    if (cachedModel) {
-      return cachedModel;
-    }
-    const bundle = await getResourceBundle(key);
-    const model = new ResourceModel({
-      bundle
-    });
-    MODEL_CACHE[key] = model;
-    return model;
-  }
-  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.getResourceModel = getResourceModel;
-  __exports.TextBundle = TextBundle;
-  __exports.getTextBundle = getTextBundle;
-  return __exports;
+"use strict";
+
+sap.ui.define(["sap/base/i18n/ResourceBundle", "sap/ui/model/resource/ResourceModel"], function (ResourceBundle, ResourceModel) {
+  "use strict";
+
+  const BUNDLE_CACHE = {};
+  const MODEL_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;
+  }
+  async function getResourceModel() {
+    let key = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 'open.ux.preview.client';
+    const cachedModel = MODEL_CACHE[key];
+    if (cachedModel) {
+      return cachedModel;
+    }
+    const bundle = await getResourceBundle(key);
+    const model = new ResourceModel({
+      bundle
+    });
+    MODEL_CACHE[key] = model;
+    return model;
+  }
+  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.getResourceModel = getResourceModel;
+  __exports.TextBundle = TextBundle;
+  __exports.getTextBundle = getTextBundle;
+  return __exports;
 });
 //# sourceMappingURL=i18n.js.map

package/dist/client/messagebundle.properties

@@ -1,3 +1,4 @@
+CREATE_BUTTON_LABEL=Create
 CANCEL_BUTTON_LABEL=Cancel
 
 QUICK_ACTION_ADD_PAGE_CONTROLLER=Add Controller to Page
@@ -13,6 +14,7 @@ QUICK_ACTION_ENABLE_TABLE_FILTERING=Enable Table Filtering for Page Variants
 QUICK_ACTION_ENABLE_TABLE_EMPTY_ROW_MODE=Enable Empty Row Mode for Tables
 QUICK_ACTION_ENABLE_TABLES_AND_CHARTS_VARIANT_MANAGEMENT=Enable Variant Management in Tables and Charts
 QUICK_ACTION_ENABLE_TABLES_AND_VARIANT_MANAGEMENT=Enable Variant Management in Tables
+QUICK_ACTION_ADD_NEW_SUB_PAGE=Add Subpage
 
 V2_QUICK_ACTION_CHANGE_TABLE_COLUMNS=Change Table Columns
 V2_QUICK_ACTION_LR_ENABLE_CLEAR_FILTER_BAR=Enable "Clear" Button in Filter Bar
@@ -31,6 +33,8 @@ ADP_ADD_FRAGMENT_DIALOG_INDEX_LABEL = Index
 ADP_ADD_FRAGMENT_DIALOG_FRAGMENT_NAME_LABEL = Fragment Name
 ADP_ADD_FRAGMENT_DIALOG_COLUMN_FRAGMENT_NAME_LABEL = Column Fragment Name
 ADP_ADD_FRAGMENT_DIALOG_CELL_FRAGMENT_NAME_LABEL = Cell Fragment Name
+ADP_ADD_SUB_PAGE_DIALOG_PAGE_TYPE_LABEL = Page Type
+ADP_ADD_SUB_PAGE_DIALOG_NAVIGATION_LABEL = Navigation
 ADP_ADD_FRAGMENT_NOTIFICATION = Note: The "{0}.fragment.xml" fragment will be created once you save the change.
 ADP_ADD_FRAGMENT_WITH_TEMPLATE_NOTIFICATION = Note: The "{0}.fragment.xml" fragment will be created once you save the changes.
 ADP_ADD_TWO_FRAGMENTS_WITH_TEMPLATE_NOTIFICATION = Note: The "{0}.fragment.xml" and "{1}.fragment.xml" fragments will be created once you save the changes.
@@ -64,3 +68,5 @@ INVALID_BINDING_STRING_FORMAT=Invalid binding string. Supported value pattern is
 INVALID_BINDING_MODEL=Invalid binding model.
 INVALID_BINDING_MODEL_KEY=Invalid key in the binding string. Supported value pattern is {i18n>YOUR_KEY}. Check if the key already exists in i18n.properties.If not, add the key in the i18n.properties file and reload the editor for the new key to take effect.
 
+NO_SUB_PAGES_TO_ADD=This option has been disabled because there are no subpages to add
+ADD_SUB_PAGE_DIALOG_TITLE=Add Subpage

package/dist/client/utils/application.js

@@ -1,34 +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;
+"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/core.js

@@ -1,70 +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;
+"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/error.js

@@ -1,21 +1,21 @@
-"use strict";
-
-sap.ui.define([], function () {
-  "use strict";
-
-  /**
-   * Returns the Error if the error is an instance of `Error` otherwise a new Error instance with string representation of the error.
-   *
-   * @param error {unknown} - the error instance
-   * @returns {Error} the error
-   */
-  function getError(error) {
-    return error instanceof Error ? error : new Error(JSON.stringify(error));
-  }
-  var __exports = {
-    __esModule: true
-  };
-  __exports.getError = getError;
-  return __exports;
+"use strict";
+
+sap.ui.define([], function () {
+  "use strict";
+
+  /**
+   * Returns the Error if the error is an instance of `Error` otherwise a new Error instance with string representation of the error.
+   *
+   * @param error {unknown} - the error instance
+   * @returns {Error} the error
+   */
+  function getError(error) {
+    return error instanceof Error ? error : new Error(JSON.stringify(error));
+  }
+  var __exports = {
+    __esModule: true
+  };
+  __exports.getError = getError;
+  return __exports;
 });
 //# sourceMappingURL=error.js.map

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

@@ -0,0 +1,58 @@
+"use strict";
+
+sap.ui.define([], function () {
+  "use strict";
+
+  const OBJECT_PAGE_COMPONENT_NAME = 'sap.suite.ui.generic.template.ObjectPage';
+
+  /**
+   * Returns application object page definitions found in manifest
+   *
+   * @param manifest - manifest object
+   * @returns array with page descriptors
+   */
+  function getV2ApplicationPages(manifest) {
+    // do we need to distinguish both navigation source and target entitySets to differentiate alternative routes?
+    const rootEntry = manifest['sap.ui.generic.app'] || manifest['sap.ovp'];
+    if (rootEntry) {
+      const result = [];
+      const collectPageData = (pagesDefinitions, idPrefix) => {
+        if (!pagesDefinitions) {
+          return;
+        }
+        if (Array.isArray(pagesDefinitions)) {
+          pagesDefinitions.forEach((entry, idx) => {
+            const id = `${idPrefix}-${idx}`;
+            if (entry.component.name === OBJECT_PAGE_COMPONENT_NAME) {
+              result.push({
+                id,
+                entitySet: entry.entitySet
+              });
+            }
+            collectPageData(entry.pages, id);
+          });
+        } else {
+          const pageIds = Object.keys(pagesDefinitions);
+          for (const pageId of pageIds) {
+            if (pagesDefinitions[pageId].component.name === OBJECT_PAGE_COMPONENT_NAME) {
+              result.push({
+                id: pageId,
+                entitySet: pagesDefinitions[pageId].entitySet
+              });
+            }
+            collectPageData(pagesDefinitions[pageId].pages, idPrefix);
+          }
+        }
+      };
+      collectPageData(rootEntry.pages, 'page');
+      return result;
+    }
+    return [];
+  }
+  var __exports = {
+    __esModule: true
+  };
+  __exports.getV2ApplicationPages = getV2ApplicationPages;
+  return __exports;
+});
+//# sourceMappingURL=fe-v2.js.map

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

@@ -0,0 +1,63 @@
+import type { Manifest } from 'sap/ui/rta/RuntimeAuthoring';
+
+interface V2ManifestPageDefinition {
+    component: {
+        name: string;
+    };
+    entitySet: string;
+    pages?: Record<string, V2ManifestPageDefinition> | Array<V2ManifestPageDefinition>;
+}
+
+const OBJECT_PAGE_COMPONENT_NAME = 'sap.suite.ui.generic.template.ObjectPage';
+
+/**
+ * Returns application object page definitions found in manifest
+ *
+ * @param manifest - manifest object
+ * @returns array with page descriptors
+ */
+export function getV2ApplicationPages(manifest: Manifest): { id: string; entitySet: string | undefined }[] {
+    // do we need to distinguish both navigation source and target entitySets to differentiate alternative routes?
+    const rootEntry = manifest['sap.ui.generic.app'] || manifest['sap.ovp'];
+    if (rootEntry) {
+        const result: { id: string; entitySet: string | undefined }[] = [];
+
+        const collectPageData = <
+            T extends Record<string, V2ManifestPageDefinition> | Array<V2ManifestPageDefinition>
+        >(
+            pagesDefinitions: T | undefined,
+            idPrefix: string
+        ) => {
+            if (!pagesDefinitions) {
+                return;
+            }
+
+            if (Array.isArray(pagesDefinitions)) {
+                pagesDefinitions.forEach((entry, idx) => {
+                    const id = `${idPrefix}-${idx}`;
+                    if (entry.component.name === OBJECT_PAGE_COMPONENT_NAME) {
+                        result.push({
+                            id,
+                            entitySet: entry.entitySet
+                        });
+                    }
+                    collectPageData(entry.pages, id);
+                });
+            } else {
+                const pageIds = Object.keys(pagesDefinitions);
+                for (const pageId of pageIds) {
+                    if (pagesDefinitions[pageId].component.name === OBJECT_PAGE_COMPONENT_NAME) {
+                        result.push({
+                            id: pageId,
+                            entitySet: pagesDefinitions[pageId].entitySet
+                        });
+                    }
+                    collectPageData(pagesDefinitions[pageId].pages, idPrefix);
+                }
+            }
+        };
+        collectPageData(rootEntry.pages, 'page');
+        return result;
+    }
+    return [];
+}