@openui5/ts-types 1.104.0 → 1.105.1

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

@@ -264,7 +264,7 @@ interface JQuery<TElement = HTMLElement> extends Iterable<TElement> {
   ): jQuery;
 }
 
-// For Library Version: 1.104.0
+// For Library Version: 1.105.1
 
 declare module "sap/base/assert" {
   /**
@@ -11201,7 +11201,7 @@ declare namespace sap {
             /**
              * Root DOM reference
              */
-            oDomRef: object
+            oDomRef: /* was Element */ global_Element
           ): this;
           /**
            * Sets the selected index if the used control supports selection.
@@ -13062,6 +13062,16 @@ declare namespace sap {
              * Object which defines the format options
              */
             oFormatOptions?: {
+              /**
+               * @since 1.105.0 specifies the first day of the week starting with `0` (which is Sunday); if not defined,
+               * the value taken from the locale is used
+               */
+              firstDayOfWeek?: int;
+              /**
+               * @since 1.105.0 minimal days at the beginning of the year which define the first calendar week; if not
+               * defined, the value taken from the locale is used
+               */
+              minimalDaysInFirstWeek?: int;
               /**
                * @since 1.34.0 contains pattern symbols (e.g. "yMMMd" or "Hms") which will be converted into the pattern
                * in the used locale, which matches the wanted symbols best. The symbols must be in canonical order, that
@@ -13140,6 +13150,16 @@ declare namespace sap {
              * Object which defines the format options
              */
             oFormatOptions?: {
+              /**
+               * @since 1.105.0 specifies the first day of the week starting with `0` (which is Sunday); if not defined,
+               * the value taken from the locale is used
+               */
+              firstDayOfWeek?: int;
+              /**
+               * @since 1.105.0 minimal days at the beginning of the year which define the first calendar week; if not
+               * defined, the value taken from the locale is used
+               */
+              minimalDaysInFirstWeek?: int;
               /**
                * @since 1.34.0 contains pattern symbols (e.g. "yMMMd" or "Hms") which will be converted into the pattern
                * in the used locale, which matches the wanted symbols best. The symbols must be in canonical order, that
@@ -13222,6 +13242,16 @@ declare namespace sap {
              * An object which defines the format options
              */
             oFormatOptions?: {
+              /**
+               * @since 1.105.0 specifies the first day of the week starting with `0` (which is Sunday); if not defined,
+               * the value taken from the locale is used
+               */
+              firstDayOfWeek?: int;
+              /**
+               * @since 1.105.0 minimal days at the beginning of the year which define the first calendar week; if not
+               * defined, the value taken from the locale is used
+               */
+              minimalDaysInFirstWeek?: int;
               /**
                * A string containing pattern symbols (e.g. "yMMMd" or "Hms") which will be converted into a pattern for
                * the used locale that matches the wanted symbols best. The symbols must be in canonical order, that is:
@@ -13301,6 +13331,16 @@ declare namespace sap {
              * Object which defines the format options
              */
             oFormatOptions?: {
+              /**
+               * @since 1.105.0 specifies the first day of the week starting with `0` (which is Sunday); if not defined,
+               * the value taken from the locale is used
+               */
+              firstDayOfWeek?: int;
+              /**
+               * @since 1.105.0 minimal days at the beginning of the year which define the first calendar week; if not
+               * defined, the value taken from the locale is used
+               */
+              minimalDaysInFirstWeek?: int;
               /**
                * @since 1.34.0 contains pattern symbols (e.g. "yMMMd" or "Hms") which will be converted into the pattern
                * in the used locale, which matches the wanted symbols best. The symbols must be in canonical order, that
@@ -15569,7 +15609,7 @@ declare namespace sap {
            * or after the lifecycle functions of the original controller. The event handler functions, such as `onButtonClick`,
            * are replacing the original controller's function.
            *
-           * When using an async extension provider you need to ensure that the view is loaded in async mode.
+           * When using an async extension provider, you need to ensure that the view is loaded in async mode.
            *
            * In both cases, return `undefined` if no controller extension shall be applied.
            */
@@ -15587,7 +15627,7 @@ declare namespace sap {
            * Views automatically prepend their own ID as a prefix to created Elements to make the IDs unique even
            * in the case of multiple view instances. This method helps to find an element by its local ID only.
            *
-           * If no view is connected or if the view doesn't contain an element with the given local ID, undefined
+           * If no view is connected or if the view doesn't contain an element with the given local ID, `undefined`
            * is returned.
            *
            * @returns Element by its (view local) ID
@@ -15597,11 +15637,11 @@ declare namespace sap {
              * View-local ID
              */
             sId: string
-          ): sap.ui.core.Element;
+          ): sap.ui.core.Element | undefined;
           /**
            * Converts a view local ID to a globally unique one by prepending the view ID.
            *
-           * If no view is connected, undefined is returned.
+           * If no view is connected, `undefined` is returned.
            *
            * @returns Prefixed ID
            */
@@ -15610,24 +15650,24 @@ declare namespace sap {
              * View-local ID
              */
             sId: string
-          ): string;
+          ): string | undefined;
           /**
            * @SINCE 1.23.0
            *
            * Gets the component of the controller's view
            *
-           * If there is no Component connected to the view or the view is not connected to the controller, undefined
+           * If there is no Component connected to the view or the view is not connected to the controller, `undefined`
            * is returned.
            *
            * @returns Component instance
            */
-          getOwnerComponent(): sap.ui.core.Component;
+          getOwnerComponent(): sap.ui.core.Component | undefined;
           /**
-           * Returns the view associated with this controller or undefined.
+           * Returns the view associated with this controller or `undefined`.
            *
            * @returns View connected to this controller.
            */
-          getView(): sap.ui.core.mvc.View;
+          getView(): sap.ui.core.mvc.View | undefined;
           /**
            * @SINCE 1.93
            *
@@ -15669,11 +15709,11 @@ declare namespace sap {
               /**
                * Whether the fragment content should be added to the `dependents` aggregation of the view
                */
-              addToDependents?: object;
+              addToDependents?: boolean;
               /**
                * Whether the IDs of the fragment content will be prefixed by the view ID
                */
-              autoPrefixId?: object;
+              autoPrefixId?: boolean;
               /**
                * the ID of the Fragment
                */
@@ -15683,7 +15723,7 @@ declare namespace sap {
                */
               type?: string;
             }
-          ): Promise<any>;
+          ): Promise<sap.ui.core.Control | sap.ui.core.Control[]>;
           /**
            * This method is called every time the View is rendered, after the HTML is placed in the DOM-Tree. It can
            * be used to apply additional changes to the DOM after the Renderer has finished. (Even though this method
@@ -16747,7 +16787,7 @@ declare namespace sap {
              * View local ID of the element
              */
             sId: string
-          ): sap.ui.core.Element;
+          ): sap.ui.core.Element | undefined;
           /**
            * Creates a clone of this view.
            *
@@ -16983,7 +17023,7 @@ declare namespace sap {
              * Prefixed ID
              */
             sId: string
-          ): string;
+          ): string | null;
           /**
            * Returns the info object which is also passed to the preprocessors
            * See:
@@ -16998,7 +17038,7 @@ declare namespace sap {
             bSync: boolean
           ): object;
           /**
-           * Returns user specific data object
+           * Returns user specific data object.
            *
            * @returns viewData
            */
@@ -19908,7 +19948,7 @@ declare namespace sap {
              * Name of the route
              */
             sName: string
-          ): sap.ui.core.routing.Route;
+          ): sap.ui.core.routing.Route | undefined;
           /**
            * @SINCE 1.75
            *
@@ -21468,7 +21508,7 @@ declare namespace sap {
             /**
              * The callback function which is called when the suggestions are available.
              */
-            fCallback: Function
+            fCallback: (p1: string, p2: string[]) => void
           ): void;
         }
         /**
@@ -21573,7 +21613,7 @@ declare namespace sap {
             /**
              * The callback function which is called when the suggestions are available.
              */
-            fnCallback: Function
+            fnCallback: (p1: string, p2: string[]) => void
           ): void;
         }
       }
@@ -25351,6 +25391,39 @@ declare namespace sap {
           OPEN = "1",
         }
       }
+      /**
+       * @SINCE 1.104
+       * @EXPERIMENTAL (since 1.104)
+       *
+       * Implementing this interface allows a control to be accessible via access keys.
+       */
+      interface IAccessKeySupport {
+        __implements__sap_ui_core_IAccessKeySupport: boolean;
+
+        /**
+         * @SINCE 1.104
+         * @EXPERIMENTAL (since 1.104)
+         *
+         * Returns a refence to DOM element to be focused during Access key navigation. If not implemented getFocusDomRef()
+         * method is used.
+         */
+        getAccessKeysFocusTarget?(): void;
+        /**
+         * @SINCE 1.104
+         * @EXPERIMENTAL (since 1.104)
+         *
+         * If implemented called when access keys feature is enabled and highlighting is over
+         */
+        onAccKeysHighlightEnd?(): void;
+        /**
+         * @SINCE 1.104
+         * @EXPERIMENTAL (since 1.104)
+         *
+         * If implemented called when access keys feature is enabled and highlighting is ongoing
+         */
+        onAccKeysHighlightStart?(): void;
+      }
+
       /**
        * @SINCE 1.89.0
        *
@@ -30903,7 +30976,10 @@ declare namespace sap {
         /**
          * @SINCE 1.99.0
          *
-         * Retrieves the configured IANA timezone ID
+         * **Note: Due to compatibility considerations, this function will always return the timezone of the browser/host
+         * system in this release**
+         *
+         * Retrieves the configured IANA timezone ID.
          *
          * @returns The configured IANA timezone ID, e.g. "America/New_York"
          */
@@ -31085,6 +31161,9 @@ declare namespace sap {
         /**
          * @SINCE 1.99.0
          *
+         * **Note: Due to compatibility considerations, this function has no effect in this release. The timezone
+         * configuration will always reflect the timezone of the browser/host system.**
+         *
          * Sets the timezone such that all date and time based calculations use this timezone.
          *
          * When the timezone has changed, the Core will fire its {@link sap.ui.core.Core#event:localizationChanged
@@ -37642,7 +37721,13 @@ declare namespace sap {
           /**
            * specifies the point of the reference element to which the given Content should be aligned
            */
-          at: sap.ui.core.Popup.Dock | Object,
+          at:
+            | sap.ui.core.Popup.Dock
+            | {
+                left: sap.ui.core.CSSSize;
+
+                top: sap.ui.core.CSSSize;
+              },
           /**
            * specifies the reference element to which the given content should be aligned as specified in the other
            * parameters
@@ -40477,6 +40562,10 @@ declare namespace sap {
          * ```
          *
          *
+         * **Note:** {@link topic:b11d853a8e784db6b2d210ef57b0f7d7 Requiring modules in XML} will result in side
+         * effects that might cause the XMLComposite to not work properly. We suggest you require the needed modules
+         * inside the JavaScript coding of the class extending the XMLComposite.
+         *
          * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
          * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
          * of the syntax of the settings object.
@@ -50699,7 +50788,8 @@ declare namespace sap {
             ): any;
             /**
              * Returns the changed properties of all changed entities in a map which are still pending. The key is the
-             * string name of the entity and the value is an object which contains the changed properties.
+             * string name of the entity, and the value is an object which contains the changed properties. The tree
+             * hierarchy changes for removed nodes are represented via an empty object.
              *
              * In contrast to the two related functions {@link #hasPendingChanges} and {@link #resetChanges}, only client
              * data changes are supported.
@@ -50771,11 +50861,11 @@ declare namespace sap {
             /**
              * Checks if there exist pending changes in the model.
              *
-             * By default, only client data changes triggered through: {@link #createEntry} {@link #setProperty} are
-             * taken into account.
+             * By default, only client data changes triggered through {@link #createEntry} or {@link #setProperty},
+             * and tree hierarchy changes are taken into account.
              *
-             * If `bAll` is set to `true`, also deferred requests triggered through: {@link #create} {@link #update}
-             * {@link #remove} are taken into account.
+             * If `bAll` is set to `true`, also deferred requests triggered through {@link #create}, {@link #update},
+             * and {@link #remove} are taken into account.
              *
              * @returns `true` if there are pending changes, `false` otherwise.
              */
@@ -51084,6 +51174,9 @@ declare namespace sap {
              * account. If `bAll` is set, also deferred requests triggered through {@link #create}, {@link #update}
              * or {@link #remove} are taken into account.
              *
+             * With a given `aPath` only specified entities are reset. Note that tree hierarchy changes are only affected
+             * if a given path is equal to the tree binding's resolved binding path.
+             *
              * If `bDeleteCreatedEntities` is set, the entity is completely removed, provided it has been created
              *
              * 	 - via {@link #createEntry} and it is not yet persisted in the back end, or
@@ -52434,26 +52527,44 @@ declare namespace sap {
             /**
              * @SINCE 1.41.0
              *
-             * Deletes the OData entity this context points to.
+             * Deletes the OData entity this context points to. The context is removed from the binding immediately,
+             * even if {@link sap.ui.model.odata.v4.SubmitMode.API} is used, and the request is only sent later when
+             * {@link sap.ui.model.odata.v4.ODataModel#submitBatch} is called. As long as the context is deleted on
+             * the client, but not yet on the server, {@link #isDeleted} returns `true`.
+             *
+             * Since 1.105 such a pending deletion is a pending change. It causes `hasPendingChanges` to return `true`
+             * for the context, the binding containing it, and the model. `resetChanges` in binding or model cancels
+             * the deletion and restores the context.
+             *
+             * The usage of a group ID with {@link sap.ui.model.odata.v4.SubmitMode.API} is possible since 1.105 - this
+             * is an experimental API.
              *
              * The context must not be used anymore after successful deletion.
+             * See:
+             * 	{#hasPendingChanges}
+             * 	{sap.ui.model.odata.v4.ODataContextBinding#hasPendingChanges}
+             * 	{sap.ui.model.odata.v4.ODataListBinding#hasPendingChanges}
+             * 	{sap.ui.model.odata.v4.ODataModel#hasPendingChanges}
+             * 	{sap.ui.model.odata.v4.ODataContextBinding#resetChanges}
+             * 	{sap.ui.model.odata.v4.ODataListBinding#resetChanges}
+             * 	{sap.ui.model.odata.v4.ODataModel#resetChanges}
              *
              * @returns A promise which is resolved without a result in case of success, or rejected with an instance
-             * of `Error` in case of failure, e.g. if the given context does not point to an entity, if it is not part
-             * of a list binding, if there are pending changes for the context's binding, if the resulting group ID
-             * has SubmitMode.API, or if the deletion on the server fails.  The error instance is flagged with `isConcurrentModification`
-             * in case a concurrent modification (e.g. by another user) of the entity between loading and deletion has
-             * been detected; this should be shown to the user who needs to decide whether to try deletion again. If
-             * the entity does not exist, we assume it has already been deleted by someone else and report success.
+             * of `Error` in case of failure, for example if:
+             * 	 the given context does not point to an entity,  the deletion on the server fails,  the deletion
+             * is canceled via `resetChanges` (in this case the error instance has the property `canceled` with value
+             * `true`).  The error instance has the property `isConcurrentModification` with value `true` in case
+             * a concurrent modification (e.g. by another user) of the entity between loading and deletion has been
+             * detected; this should be shown to the user who needs to decide whether to try deletion again. If the
+             * entity does not exist, we assume it has already been deleted by someone else and report success.
              */
             delete(
               /**
                * The group ID to be used for the DELETE request; if not specified, the update group ID for the context's
-               * binding is used, see {@link #getUpdateGroupId}; the resulting group ID must not have {@link sap.ui.model.odata.v4.SubmitMode.API}.
-               * Since 1.81, if this context is transient (see {@link #isTransient}), no group ID needs to be specified.
-               * Since 1.98.0, you can use `null` to prevent the DELETE request in case of a kept-alive context that is
-               * not in the collection and of which you know that it does not exist on the server anymore (for example,
-               * a draft after activation).
+               * binding is used, see {@link #getUpdateGroupId}. Since 1.81, if this context is transient (see {@link
+               * #isTransient}), no group ID needs to be specified. Since 1.98.0, you can use `null` to prevent the DELETE
+               * request in case of a kept-alive context that is not in the collection and of which you know that it does
+               * not exist on the server anymore (for example, a draft after activation).
                */
               sGroupId?: string,
               /**
@@ -52593,6 +52704,17 @@ declare namespace sap {
              * @returns Whether there are pending changes
              */
             hasPendingChanges(): boolean;
+            /**
+             * @SINCE 1.105
+             *
+             * Returns whether this context is deleted on the client, but not on the server yet. The result of this
+             * function can also be accessed via the "@$ui5.context.isDeleted" instance annotation at the entity.
+             * See:
+             * 	#delete
+             *
+             * @returns `true` if this context is deleted
+             */
+            isDeleted(): boolean;
             /**
              * @SINCE 1.77.0
              *
@@ -54193,6 +54315,9 @@ declare namespace sap {
                * of grand totals like in 1.84.0, using aggregates of aggregates and thus allowing to filter by aggregated
                * properties while grand totals are needed. Beware that methods like "average" or "countdistinct" are not
                * compatible with this approach, and it cannot be combined with group levels.
+               *  Since 1.105.0, either a recursive hierarchy or pure data aggregation is supported, but no mix; `hierarchyQualifier`
+               * is the leading property that decides between those two use cases - this is an **experimental API** and
+               * is only supported if the model uses the `autoExpandSelect` parameter!
                */
               oAggregation?: {
                 /**
@@ -54210,6 +54335,11 @@ declare namespace sap {
                  * situation"). (SQL suggestion: `CASE WHEN MIN(Unit) = MAX(Unit) THEN MIN(Unit) END`)
                  */
                 aggregate?: object;
+                /**
+                 * The number of initially expanded levels as a positive integer (@experimental as of version 1.105.0),
+                 * supported only if a `hierarchyQualifier` is given.
+                 */
+                expandTo?: number;
                 /**
                  * Tells whether the grand totals for aggregatable properties are displayed at the bottom only (since 1.86.0);
                  * `true` for bottom only, `false` for top and bottom, the default is top only
@@ -54229,6 +54359,12 @@ declare namespace sap {
                  * (since 1.93.0) with "$search".
                  */
                 groupLevels?: string[];
+                /**
+                 * The qualifier for the pair of "Org.OData.Aggregation.V1.RecursiveHierarchy" and "com.sap.vocabularies.Hierarchy.v1.RecursiveHierarchy"
+                 * annotations at this binding's entity type (@experimental as of version 1.105.0). If present, a recursive
+                 * hierarchy without data aggregation is defined, and the only other supported property is `expandTo`.
+                 */
+                hierarchyQualifier?: string;
                 /**
                  * Like the
                  * "5.1.7 System Query Option $search", but applied before data aggregation (since 1.93.0). Note that
@@ -59840,9 +59976,9 @@ declare namespace sap {
            */
           constructor(
             /**
-             * either the URL where to load the XML from or an XML
+             * Either the URL where to load the XML from or an XML document
              */
-            oData: object
+            oData: XMLDocument | string
           );
 
           /**
@@ -66373,7 +66509,15 @@ declare namespace sap {
            * `oListener` instance (if present) or on the `window` instance. A map with information about the entered
            * range set is provided as a single argument to the handler (see details above).
            */
-          fnFunction: Function,
+          fnFunction: (p1: {
+            from: number;
+
+            to: number;
+
+            unit: string;
+
+            name: string | undefined;
+          }) => void,
           /**
            * The object that wants to be notified when the event occurs (`this` context within the handler function).
            * If it is not specified, the handler function is called in the context of the `window`.
@@ -66424,7 +66568,15 @@ declare namespace sap {
            * size will be used.
            */
           iWidth?: int
-        ): object;
+        ): {
+          from: number;
+
+          to: number;
+
+          unit: string;
+
+          name: string | undefined;
+        };
         /**
          * Returns `true` if a range set with the given name is already initialized.
          *

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

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