@openui5/ts-types 1.108.25 → 1.108.27

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openui5/ts-types",
-  "version": "1.108.25",
+  "version": "1.108.27",
   "description": "OpenUI5 TypeScript Definitions",
   "homepage": "https://openui5.org",
   "author": "SAP SE (https://www.sap.com)",

package/types/sap.f.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.108.25
+// For Library Version: 1.108.27
 
 declare namespace sap {
   /**

package/types/sap.m.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.108.25
+// For Library Version: 1.108.27
 
 declare namespace sap {
   /**
@@ -647,6 +647,11 @@ declare namespace sap {
            */
           FNMetaImpl?: Function
         ): Function;
+        /**
+         *
+         * @returns The Engine instance
+         */
+        getInstance(): sap.m.p13n.Engine;
         /**
          * Returns a metadata object for class sap.m.p13n.Engine.
          *
@@ -1042,13 +1047,9 @@ declare namespace sap {
          */
         constructor(
           /**
-           * ID for the new control, generated automatically if no ID is given
+           * Initial settings for the new controller
            */
-          sId?: string,
-          /**
-           * Initial settings for the new control
-           */
-          mSettings?: {
+          mSettings: {
             /**
              * The control instance that is personalized by this controller
              */
@@ -1191,6 +1192,80 @@ declare namespace sap {
           sTitle?: string
         ): this;
       }
+      /**
+       * The `MetadataHelper` entity offers utility functionality for service metadata during the `Engine#register`
+       * process.
+       */
+      class MetadataHelper extends sap.ui.base.Object {
+        /**
+         * See:
+         * 	{@link topic:75c08fdebf784575947927e052712bab Personalization}
+         */
+        constructor(
+          /**
+           * Array of objects defining available items for personalization
+           */
+          aProperties: sap.m.p13n.MetadataObject[]
+        );
+
+        /**
+         * Creates a new subclass of class sap.m.p13n.MetadataHelper with name `sClassName` and enriches it with
+         * the information contained in `oClassInfo`.
+         *
+         * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
+         *
+         * @returns Created class / constructor function
+         */
+        static extend<T extends Record<string, unknown>>(
+          /**
+           * Name of the class being created
+           */
+          sClassName: string,
+          /**
+           * Object literal with information about the class
+           */
+          oClassInfo?: sap.ClassInfo<T, sap.m.p13n.MetadataHelper>,
+          /**
+           * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
+           * used by this class
+           */
+          FNMetaImpl?: Function
+        ): Function;
+        /**
+         * Returns a metadata object for class sap.m.p13n.MetadataHelper.
+         *
+         * @returns Metadata object describing this class
+         */
+        static getMetadata(): sap.ui.base.Metadata;
+        /**
+         * Gets a property path based on its key.
+         *
+         * @returns The property path based on its key
+         */
+        getPath(
+          /**
+           * The property key identifying a property entry
+           */
+          sKey: string
+        ): string;
+        /**
+         * Gets the array of properties.
+         *
+         * @returns Array of properties
+         */
+        getProperties(): sap.m.p13n.MetadataObject[];
+        /**
+         * Gets a single property.
+         *
+         * @returns A single property
+         */
+        getProperty(
+          /**
+           * The property key identifying a property entry
+           */
+          sKey: string
+        ): sap.m.p13n.MetadataObject;
+      }
       /**
        * @SINCE 1.97
        * @EXPERIMENTAL (since 1.97)
@@ -1587,17 +1662,20 @@ declare namespace sap {
          */
         constructor(
           /**
-           * ID for the new control, generated automatically if no ID is given
-           */
-          sId?: string,
-          /**
-           * Initial settings for the new control
+           * Initial settings for the new controller
            */
-          mSettings?: {
+          mSettings: {
             /**
              * The control instance that is personalized by this controller
              */
             control: sap.ui.core.Control;
+            /**
+             * By default the SelectionController tries to identify the existing item through the key by checking if
+             * there is an existing item with this id. This behaviour can be overruled by implementing this method which
+             * will provide the according item of the `targetAggregation` to return the according key associated to
+             * this item.
+             */
+            getKeyForItem?: Function;
             /**
              * The name of the aggregation that is now managed by this controller
              */
@@ -1897,13 +1975,9 @@ declare namespace sap {
          */
         constructor(
           /**
-           * ID for the new control, generated automatically if no ID is given
+           * Initial settings for the new controller
            */
-          sId?: string,
-          /**
-           * Initial settings for the new control
-           */
-          mSettings?: {
+          mSettings: {
             /**
              * The control instance that is personalized by this controller
              */
@@ -2081,6 +2155,25 @@ declare namespace sap {
         grouped: boolean;
       };
 
+      /**
+       * Personalization `GroupState` object type. This object describes the state processed by this controller
+       * when accessing it through the {@link sap.m.p13n.Engine Engine}.
+       */
+      type GroupState = {
+        /**
+         * The key for the group state
+         */
+        key: string;
+        /**
+         * Defines whether the item is grouped (if a group state is provided, it's grouped automatically)
+         */
+        grouped?: boolean;
+        /**
+         * Describes the index of the grouping
+         */
+        index?: int;
+      };
+
       /**
        * P13n `Item` object type.
        */
@@ -2099,6 +2192,57 @@ declare namespace sap {
         visible: boolean;
       };
 
+      /**
+       * @EXPERIMENTAL (since 1.104)
+       *
+       * Personalization `MetadataObject` type.
+       */
+      type MetadataObject = {
+        /**
+         * The unique key for the p13n metadata object
+         */
+        key: string;
+        /**
+         * Defines the text that will be displayed in the personalization popup
+         */
+        label: string;
+        /**
+         * Defines the technical path to apply binding-related updates
+         */
+        path: string;
+        /**
+         * Defines whether the metadata object is sortable
+         */
+        sortable?: boolean;
+        /**
+         * Defines whether the metadata object is groupable
+         */
+        groupable?: boolean;
+        /**
+         * Defines whether the metadata object is visible for selection
+         */
+        visible?: boolean;
+      };
+
+      /**
+       * Personalization `SelectionState` object type. This object describes the state processed by this controller
+       * when accessing it through the {@link sap.m.p13n.Engine Engine}.
+       */
+      type SelectionState = {
+        /**
+         * The key for the group state
+         */
+        key: string;
+        /**
+         * Defines whether the item is selected (if a selection state is provided, it's selected automatically)
+         */
+        visible?: boolean;
+        /**
+         * Describes the index of the selection item
+         */
+        index?: int;
+      };
+
       /**
        * P13n `SortItem` object type.
        */
@@ -2120,6 +2264,29 @@ declare namespace sap {
          */
         descending: boolean;
       };
+
+      /**
+       * Personalization `SortState` object type. This object describes the state processed by this controller
+       * when accessing it through the {@link sap.m.p13n.Engine Engine}.
+       */
+      type SortState = {
+        /**
+         * The key for the sort state
+         */
+        key: string;
+        /**
+         * Defines whether the item is sorted (if a sort state is provided, it's sorted automatically)
+         */
+        sorted?: boolean;
+        /**
+         * Defines whether the sorting is processed in a descending order (`false` is the default)
+         */
+        descending?: boolean;
+        /**
+         * Describes the index of the sorter
+         */
+        index?: int;
+      };
     }
 
     namespace PlanningCalendar {
@@ -91504,7 +91671,7 @@ declare namespace sap {
        * desktop devices, which overrides any configuration that has been provided by the application for the
        * property displayType. This means that the PDFViewer appears as a toolbar with a download button.
        *
-       * Default value is `false`.
+       * Default value is `true`.
        *
        * @returns Value of property `isTrustedSource`
        */
@@ -91729,7 +91896,7 @@ declare namespace sap {
        *
        * When called with a value of `null` or `undefined`, the default value of the property will be restored.
        *
-       * Default value is `false`.
+       * Default value is `true`.
        *
        * @returns Reference to `this` in order to allow method chaining
        */
@@ -139596,6 +139763,8 @@ declare namespace sap {
 
     "sap/m/p13n/GroupPanel": undefined;
 
+    "sap/m/p13n/MetadataHelper": undefined;
+
     "sap/m/p13n/modification/FlexModificationHandler": undefined;
 
     "sap/m/p13n/modification/LocalStorageModificationHandler": undefined;

package/types/sap.tnt.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.108.25
+// For Library Version: 1.108.27
 
 declare namespace sap {
   /**

package/types/sap.ui.codeeditor.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.108.25
+// For Library Version: 1.108.27
 
 declare namespace sap {
   namespace ui {

package/types/sap.ui.commons.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.108.25
+// For Library Version: 1.108.27
 
 declare namespace sap {
   namespace ui {

package/types/sap.ui.core.d.ts

@@ -264,7 +264,7 @@ interface JQuery<TElement = HTMLElement> extends Iterable<TElement> {
   ): jQuery;
 }
 
-// For Library Version: 1.108.25
+// For Library Version: 1.108.27
 
 declare module "sap/base/assert" {
   /**

package/types/sap.ui.dt.d.ts

@@ -1,3 +1,3 @@
-// For Library Version: 1.108.25
+// For Library Version: 1.108.27
 
 declare namespace sap {}

package/types/sap.ui.fl.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.108.25
+// For Library Version: 1.108.27
 
 declare namespace sap {
   namespace ui {

package/types/sap.ui.integration.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.108.25
+// For Library Version: 1.108.27
 
 declare namespace sap {
   namespace ui {

package/types/sap.ui.layout.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.108.25
+// For Library Version: 1.108.27
 
 declare namespace sap {
   namespace ui {

package/types/sap.ui.mdc.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.108.25
+// For Library Version: 1.108.27
 
 declare namespace sap {
   interface IUI5DefineDependencyNames {

package/types/sap.ui.rta.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.108.25
+// For Library Version: 1.108.27
 
 declare module "sap/ui/rta/api/startAdaptation" {
   /**

package/types/sap.ui.suite.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.108.25
+// For Library Version: 1.108.27
 
 declare namespace sap {
   namespace ui {

package/types/sap.ui.support.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.108.25
+// For Library Version: 1.108.27
 
 declare namespace sap {
   namespace ui {

package/types/sap.ui.table.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.108.25
+// For Library Version: 1.108.27
 
 declare namespace sap {
   namespace ui {

package/types/sap.ui.testrecorder.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.108.25
+// For Library Version: 1.108.27
 
 declare namespace sap {
   interface IUI5DefineDependencyNames {

package/types/sap.ui.unified.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.108.25
+// For Library Version: 1.108.27
 
 declare namespace sap {
   namespace ui {

package/types/sap.ui.ux3.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.108.25
+// For Library Version: 1.108.27
 
 declare namespace sap {
   namespace ui {

package/types/sap.ui.webc.common.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.108.25
+// For Library Version: 1.108.27
 
 declare namespace sap {
   namespace ui {

package/types/sap.ui.webc.fiori.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.108.25
+// For Library Version: 1.108.27
 
 declare namespace sap {
   namespace ui {

package/types/sap.ui.webc.main.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.108.25
+// For Library Version: 1.108.27
 
 declare namespace sap {
   namespace ui {

package/types/sap.uxap.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.108.25
+// For Library Version: 1.108.27
 
 declare namespace sap {
   /**