@sapui5/ts-types 1.144.0 → 1.145.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sapui5/ts-types",
-  "version": "1.144.0",
+  "version": "1.145.0",
   "description": "SAPUI5 TypeScript Definitions",
   "homepage": "https://ui5.sap.com",
   "author": "SAP SE (https://www.sap.com)",

package/types/sap.apf.d.ts

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

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.144.0
+// For Library Version: 1.145.0
 
 declare namespace sap {
   namespace ca {

package/types/sap.chart.d.ts

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

package/types/sap.collaboration.d.ts

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

package/types/sap.esh.search.ui.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.144.1
+// For Library Version: 1.145.2
 
 declare namespace sap {
   namespace esh {
@@ -26,24 +26,16 @@ declare namespace sap {
               extends sap.m.$OverflowToolbarButtonSettings {}
 
             /**
-             * Describes the settings that can be provided to the SearchBasketBase constructor.
-             *
-             * @experimental As of version 1.144.0.
-             */
-            interface $SearchBasketBaseSettings
-              extends sap.ui.layout.$VerticalLayoutSettings {}
-
-            /**
-             * This is the SAPUI5 sample basket class, extending search basket base class 'SearchBasketBase'. Adds a
-             * custom header, footer and sap.m.Table is used for the basket items. Use in combination with control SearchCompositeControl
-             * by the Enterprise Search Team.
+             * This is the SAPUI5 sample basket class, making use of the sap.ui.table.Table extension SearchBasketSapUiTable.
+             * In addition, adds a custom header, footer (sap.ui.table.Table is used for the basket items). Use in combination
+             * with control SearchCompositeControl by the Enterprise Search Team.
              *
              * @since 1.144.0
              * @experimental As of version 1.144.0.
              */
             class CustomBasket extends sap.ui.layout.VerticalLayout {
               /**
-               * Constructs a new `SearchBasketBase` to be used as a search basket (extend this class).
+               * Constructs a new `CustomBasket` to be used as a search basket (extend this class).
                * See:
                * 	https://help.sap.com/viewer/691cb949c1034198800afde3e5be6570/2.0.05/en-US/ce86ef2fd97610149eaaaa0244ca4d36.html
                * 	https://help.sap.com/viewer/6522d0462aeb4909a79c3462b090ec51/1709%20002/en-US
@@ -76,28 +68,6 @@ declare namespace sap {
                 sId?: string
               );
             }
-            /**
-             * This is the SAPUI5 search basket base class to be used to extend it as a custom search basket. Add custom
-             * header, footer, buttons, etc. in your extended class. Use in combination with control SearchCompositeControl
-             * by the Enterprise Search Team.
-             *
-             * @since 1.144.0
-             * @experimental As of version 1.144.0.
-             */
-            class SearchBasketBase extends sap.ui.layout.VerticalLayout {
-              /**
-               * Constructs a new `SearchBasketBase` to be used as a search basket (extend this class).
-               * See:
-               * 	https://help.sap.com/viewer/691cb949c1034198800afde3e5be6570/2.0.05/en-US/ce86ef2fd97610149eaaaa0244ca4d36.html
-               * 	https://help.sap.com/viewer/6522d0462aeb4909a79c3462b090ec51/1709%20002/en-US
-               */
-              constructor(
-                /**
-                 * ID for the new control, generated automatically if no ID is given
-                 */
-                sId?: string
-              );
-            }
           }
 
           namespace resultview {
@@ -839,7 +809,24 @@ declare namespace sap {
             | `{${string}}`;
 
           /**
-           * Define your own rendering of result items (we recommend to use 'sap.m.GridContainer' and 'sap.m.GenericTile').
+           * Location of the basket. When creating your own basket (see function 'createAndRegisterBasket'), set this
+           * property to "CustomBasketLocation". By default the basket is a panel at the right of the result view.
+           *
+           * Values: - "SidePanelRight" (default): basket is a panel at the right of the result view - "CustomBasketLocation":
+           * basket is created by function 'createAndRegisterBasket' and can be placed anywhere in the UI
+           *
+           * @since 1.145.0
+           */
+          basketLocation?:
+            | string
+            | sap.ui.base.ManagedObject.PropertyBindingInfo;
+
+          /**
+           * Define your own view for the basket. The basket is displayed on a panel at the right/end of result views
+           * (by default, details see 'basketLocation'). There is buttons to show/hide it and add items to the basket
+           * (see config properties 'basketShowHideButton' and 'basketAddButton'). For the basket items collection,
+           * we recommend to use function 'createAndRegisterBasket' to create a table/list, so the selection (incl.
+           * 'add to basket') of result views with table/list is managed by SearchCompositeControl.
            *
            * @since 1.144.0
            */
@@ -936,17 +923,6 @@ declare namespace sap {
             | sap.ui.base.ManagedObject.PropertyBindingInfo
             | `{${string}}`;
 
-          /**
-           * A callback which is called whenever the selection of result view items changes.
-           *
-           * @since 1.113.0
-           * @deprecated As of version 1.137.0. this setting is ignored, subscribe to event 'selectionChanged'.
-           */
-          selectionChange?:
-            | Function
-            | sap.ui.base.ManagedObject.PropertyBindingInfo
-            | `{${string}}`;
-
           /**
            * An asynchronues callback which is called after the initialization of the search composite control.
            *
@@ -1636,6 +1612,26 @@ declare namespace sap {
            * @returns void
            */
           clearObjectSelection(): undefined;
+          /**
+           * Create an instance of a basket and register it for interaction with the result view (items/selection
+           * indicator). See property 'basketLocation' in search model configuration to define where the basket panel
+           * is located.
+           *
+           * @since 1.145.0
+           *
+           * @returns A basket control of type sap.m.Table or sap.m.List containing items of the search basket ('selected
+           * items')
+           */
+          createAndRegisterBasket(
+            /**
+             * The ID postfix for the basket instance
+             */
+            idPostfix: string,
+            /**
+             * The UI type table/list ("sapMList" | "sapMTable" | "sapUiTable")
+             */
+            type: "sapMList" | "sapMTable" | "sapUiTable"
+          ): object;
           /**
            * Create a NavigationTarget instance for filtering/search.
            *
@@ -1949,6 +1945,15 @@ declare namespace sap {
            * @returns Value of property `autoAdjustResultViewTypeInFolderMode`
            */
           getAutoAdjustResultViewTypeInFolderMode(): boolean;
+          /**
+           * Get the active/current search basket (see interfaceSearchBasketApi)
+           *
+           * @since 1.145.0
+           *
+           * @returns A control containing other controls. At least one of the controls is the basket-list/table,
+           * containg the 'selected items'.
+           */
+          getBasket(): object;
           /**
            * Gets current value of property {@link #getBasketAddButton basketAddButton}.
            *
@@ -2037,12 +2042,12 @@ declare namespace sap {
            */
           getBasketInit(): Function;
           /**
-           * Get items of the shopping basket ('selected items', JSON model) The model is read-only.
+           * Get items of the latest search basket ('selected items', JSON model) The model is read-only.
            *
            * @since 1.143.0
            * @experimental As of version 1.143.0.
            *
-           * @returns A JSON model containing items of the shopping basket ('selected items')
+           * @returns A JSON model containing items of the search basket ('selected items')
            */
           getBasketItems(): object;
           /**
@@ -2060,6 +2065,22 @@ declare namespace sap {
            * @returns Value of property `basketLinkByResultViewItemSelection`
            */
           getBasketLinkByResultViewItemSelection(): boolean;
+          /**
+           * Gets current value of property {@link #getBasketLocation basketLocation}.
+           *
+           * Location of the basket. When creating your own basket (see function 'createAndRegisterBasket'), set this
+           * property to "CustomBasketLocation". By default the basket is a panel at the right of the result view.
+           *
+           * Values: - "SidePanelRight" (default): basket is a panel at the right of the result view - "CustomBasketLocation":
+           * basket is created by function 'createAndRegisterBasket' and can be placed anywhere in the UI
+           *
+           * Default value is `"SidePanelRight"`.
+           *
+           * @since 1.145.0
+           *
+           * @returns Value of property `basketLocation`
+           */
+          getBasketLocation(): string;
           /**
            * Gets current value of property {@link #getBasketPanelResizable basketPanelResizable}.
            *
@@ -2132,7 +2153,11 @@ declare namespace sap {
           /**
            * Gets current value of property {@link #getCustomBasket customBasket}.
            *
-           * Define your own rendering of result items (we recommend to use 'sap.m.GridContainer' and 'sap.m.GenericTile').
+           * Define your own view for the basket. The basket is displayed on a panel at the right/end of result views
+           * (by default, details see 'basketLocation'). There is buttons to show/hide it and add items to the basket
+           * (see config properties 'basketShowHideButton' and 'basketAddButton'). For the basket items collection,
+           * we recommend to use function 'createAndRegisterBasket' to create a table/list, so the selection (incl.
+           * 'add to basket') of result views with table/list is managed by SearchCompositeControl.
            *
            * @since 1.144.0
            *
@@ -2641,6 +2666,15 @@ declare namespace sap {
            * @returns Value of property `searchBarTitle`
            */
           getSearchBarTitle(): string;
+          /**
+           * Get the basket model ('selected items', 'count' : JSON model) The model is managed by SearchCompositeControl,
+           * do not change it manually.
+           *
+           * @since 1.145.0
+           *
+           * @returns A JSON model containing items of the search basket ('selected items', 'count')
+           */
+          getSearchBasketModel(): object;
           /**
            * Gets current value of property {@link #getSearchInputLocation searchInputLocation}.
            *
@@ -2704,17 +2738,6 @@ declare namespace sap {
            * @returns Value of property `searchTermLengthLimit`
            */
           getSearchTermLengthLimit(): int;
-          /**
-           * Gets current value of property {@link #getSelectionChange selectionChange}.
-           *
-           * A callback which is called whenever the selection of result view items changes.
-           *
-           * @since 1.113.0
-           * @deprecated As of version 1.137.0. this setting is ignored, subscribe to event 'selectionChanged'.
-           *
-           * @returns Value of property `selectionChange`
-           */
-          getSelectionChange(): Function;
           /**
            * Gets current value of property {@link #getShowSelectionToggleButton showSelectionToggleButton}.
            *
@@ -3031,6 +3054,29 @@ declare namespace sap {
              */
             bBasketLinkByResultViewItemSelection?: boolean
           ): this;
+          /**
+           * Sets a new value for property {@link #getBasketLocation basketLocation}.
+           *
+           * Location of the basket. When creating your own basket (see function 'createAndRegisterBasket'), set this
+           * property to "CustomBasketLocation". By default the basket is a panel at the right of the result view.
+           *
+           * Values: - "SidePanelRight" (default): basket is a panel at the right of the result view - "CustomBasketLocation":
+           * basket is created by function 'createAndRegisterBasket' and can be placed anywhere in the UI
+           *
+           * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+           *
+           * Default value is `"SidePanelRight"`.
+           *
+           * @since 1.145.0
+           *
+           * @returns Reference to `this` in order to allow method chaining
+           */
+          setBasketLocation(
+            /**
+             * New value for property `basketLocation`
+             */
+            sBasketLocation?: string
+          ): this;
           /**
            * Sets a new value for property {@link #getBasketPanelResizable basketPanelResizable}.
            *
@@ -3130,7 +3176,11 @@ declare namespace sap {
           /**
            * Sets a new value for property {@link #getCustomBasket customBasket}.
            *
-           * Define your own rendering of result items (we recommend to use 'sap.m.GridContainer' and 'sap.m.GenericTile').
+           * Define your own view for the basket. The basket is displayed on a panel at the right/end of result views
+           * (by default, details see 'basketLocation'). There is buttons to show/hide it and add items to the basket
+           * (see config properties 'basketShowHideButton' and 'basketAddButton'). For the basket items collection,
+           * we recommend to use function 'createAndRegisterBasket' to create a table/list, so the selection (incl.
+           * 'add to basket') of result views with table/list is managed by SearchCompositeControl.
            *
            * When called with a value of `null` or `undefined`, the default value of the property will be restored.
            *
@@ -3988,24 +4038,6 @@ declare namespace sap {
              */
             iSearchTermLengthLimit?: int
           ): this;
-          /**
-           * Sets a new value for property {@link #getSelectionChange selectionChange}.
-           *
-           * A callback which is called whenever the selection of result view items changes.
-           *
-           * When called with a value of `null` or `undefined`, the default value of the property will be restored.
-           *
-           * @since 1.113.0
-           * @deprecated As of version 1.137.0. this setting is ignored, subscribe to event 'selectionChanged'.
-           *
-           * @returns Reference to `this` in order to allow method chaining
-           */
-          setSelectionChange(
-            /**
-             * New value for property `selectionChange`
-             */
-            fnSelectionChange: Function
-          ): this;
           /**
            * Sets a new value for property {@link #getShowSelectionToggleButton showSelectionToggleButton}.
            *
@@ -4159,8 +4191,6 @@ declare namespace sap {
 
     "sap/esh/search/ui/controls/basket/SearchBasketAddButton": undefined;
 
-    "sap/esh/search/ui/controls/basket/SearchBasketBase": undefined;
-
     "sap/esh/search/ui/controls/resultview/SearchShowDetailButton": undefined;
 
     "sap/esh/search/ui/controls/resultview/SearchText": undefined;

package/types/sap.f.d.ts

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

package/types/sap.fe.ariba.d.ts

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

package/types/sap.fe.base.d.ts

@@ -1,31 +1,303 @@
-// For Library Version: 1.144.0
+// For Library Version: 1.145.0
+
 
 declare namespace sap {
-  namespace fe {
-    /**
-     * Library providing the base functionality of the runtime for SAP Fiori elements for OData V4.
-     */
-    namespace base {
-      /**
-       * Describes the settings that can be provided to the BuildingBlockBase constructor.
-       */
-      interface $BuildingBlockBaseSettings
-        extends sap.ui.core.$ControlSettings {}
-
-      /**
-       * Base class for building blocks.
-       * This contains the low level functionality of having a content aggregation and handling the rendering
-       * of the content without an actual DOM element.
-       * The building block also defines a state object that can be used to store the state of the building block.
-       * Accessibility and classes information are forwarded to the content control.
-       */
-      class BuildingBlockBase extends sap.ui.core.Control {}
-    }
-  }
-
-  interface IUI5DefineDependencyNames {
-    "sap/fe/base/BuildingBlockBase": undefined;
-
-    "sap/fe/base/library": undefined;
-  }
+
+
+
+namespace fe {
+
+
+/**
+ * Library providing the base functionality of the runtime for SAP Fiori elements for OData V4.
+ */
+namespace base {
+
+
+
+namespace BindingToolkit {
+
+
+
+
+
+
+/**
+ * A binding expression that evaluates to type T.
+ *
+ * @experimental As of version 1.145.0.
+ */
+type BindingToolkitExpression = {
+}
+
+}
+
+namespace ClassSupport {
+
+
+
+
+
+
+/**
+ * Represents the state object of a building block.
+ *
+ * @experimental As of version 1.145.0.
+ */
+type BindingInfoHolder = {
+}
+
+/**
+ * Represents the state object of a building block.
+ *
+ * @experimental As of version 1.145.0.
+ */
+type ExtendWithObject = {
+}
+
+/**
+ * Returns the properties of a control.
+ *
+ * @experimental As of version 1.145.0.
+ */
+type PropertiesOf = {
+}
+
+/**
+ * Represents the state object of a building block.
+ *
+ * @experimental As of version 1.145.0.
+ */
+type StateOf = {
+}
+
+/**
+ * Definition of a UI5 aggregation metadata.
+ *
+ * @experimental As of version 1.145.0.
+ */
+type UI5AggregationMetadata = {
+}
+
+/**
+ * Definition of a UI5 association metadata.
+ *
+ * @experimental As of version 1.145.0.
+ */
+type UI5AssociationMetadata = {
+}
+
+/**
+ * Definition of a UI5 property metadata.
+ *
+ * @experimental As of version 1.145.0.
+ */
+type UI5PropertyMetadata = {
+}
+
+}
+/**
+ * Describes the settings that can be provided to the BuildingBlockBase constructor.
+ */
+interface $BuildingBlockBaseSettings extends sap.ui.core.$ControlSettings {
+/**
+ * The current state value of the component.
+ * This property holds the state data managed by the component, with the type
+ * determined by the generic parameter K.
+ */
+state? : /* was: sap.fe.base.ClassSupport.StateOf */ any | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`
+
+/**
+ * Optional content of generic type T.
+ * This property holds the main data or payload for the containing object.
+ * When undefined, it indicates that no content has been set or is available.
+ * The specific type and structure of the content depends on the generic type parameter T.
+ */
+content? : sap.ui.core.Element
+
+/**
+ * Association to controls / IDs that label this control (see WAI-ARIA attribute aria-labelledby).
+ */
+ariaLabelledBy? : sap.ui.core.Control | string
+
+
+}
+
+/**
+ * Collection of functions to support the manipulation of UI5 bindings
+ *
+ * @experimental As of version 1.145.0.
+ */
+interface BindingToolkit {
+
+
+}
+
+/**
+ * Collection of decorators to support the creation of UI5 classes.
+ */
+interface ClassSupport {
+
+/**
+ * Defines and configures the following aggregation in the control metadata.
+ *
+ * @experimental As of version 1.145.0.
+ *
+ * @returns The decorated property.
+ */
+aggregation(
+/**
+ * The aggregation definition
+ */
+aggregationDefinition: sap.fe.base.ClassSupport.UI5AggregationMetadata
+): PropertyDecorator
+/**
+ * Defines and configures the following association in the control metadata.
+ *
+ * @experimental As of version 1.145.0.
+ *
+ * @returns The decorated property
+ */
+association(
+/**
+ * The definition of the association.
+ */
+ui5AssociationMetadata: sap.fe.base.ClassSupport.UI5AssociationMetadata
+): PropertyDecorator
+/**
+ * Allows to define a property that holds the control state.
+ * Properties defined with this decorator are automatically bound to the control state when used in JSX.
+ * Arrays need to be bound using the `bindState` function.
+ *
+ *
+ * @experimental As of version 1.145.0.
+ *
+ * @returns A property decorator
+ */
+defineState(
+
+): PropertyDecorator
+/**
+ * Indicates that the following class should define a UI5 control of the specified name.
+ *
+ * @experimental As of version 1.145.0.
+ *
+ * @returns A class decorator that creates a UI5 class out of the TS class
+ */
+defineUI5Class(
+/**
+ * The fully qualified name of the UI5 class
+ */
+target: string,
+/**
+ * Additional inline metadata definition
+ */
+metadataDefinition?: Partial</* was: sap.fe.base.ClassSupport.UI5ControlMetadataDefinition */ any>
+): ClassDecorator
+/**
+ * Indicates that the property is declared as an event on the control metadata.
+ *
+ * @experimental As of version 1.145.0.
+ *
+ * @returns The decorated property
+ */
+event(
+
+): PropertyDecorator
+/**
+ * Defines in the metadata that this control implements a specific interface.
+ *
+ * @experimental As of version 1.144.0.
+ *
+ * @returns The decorated method
+ */
+implementInterface(
+/**
+ * The name of the implemented interface
+ */
+interfaceName: string
+): PropertyDecorator
+/**
+ * Defines the following property as a managed object in the control metadata.
+ *
+ * @experimental As of version 1.145.0.
+ *
+ * @returns The decorated property.
+ */
+property(
+/**
+ * The property definition
+ */
+attributeDefinition: sap.fe.base.ClassSupport.UI5PropertyMetadata
+): PropertyDecorator
+}
+
+/**
+ * Base class for building blocks.
+ * This contains the low-level functionality of having a content aggregation and handling the rendering
+ * of the content without an actual DOM element.
+ *
+ * The building block also defines a state object that can be used to store the state of the building block.
+ *
+ * Accessibility and classes information are forwarded to the content control.
+ *
+ * This class is not meant to be used directly, it's there for internal use only (and documentation)
+ */
+class BuildingBlockBase extends sap.ui.core.Control {
+
+
+/**
+ * Shorthand for the BindingToolkit.bindState function with the current state object.
+ *
+ * @experimental As of version 1.145.0.
+ *
+ * @returns The binding toolkit expression for the state
+ */
+bindState(
+/**
+ * A property in the state object
+ */
+path: 
+): /* was: sap.fe.base.BindingToolkit.BindingToolkitExpression */ any
+/**
+ * Framework hook for state change handling.
+ * Subclasses can override this method to react to state changes.
+ *
+ * @experimental As of version 1.145.0.
+ */
+onStateChange(
+/**
+ * List of changed property names
+ */
+_changedProps: string[]
+): void
+}
+
+
+}
+
+
+
+
+}
+
+interface IUI5DefineDependencyNames {
+
+"sap/fe/base/BindingToolkit" : undefined
+
+
+"sap/fe/base/BuildingBlockBase" : undefined
+
+
+"sap/fe/base/ClassSupport" : undefined
+
+
+"sap/fe/base/library" : undefined
+
+
+}
+
+
+
+
 }