@sapui5/ts-types 1.144.1 → 1.146.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sapui5/ts-types",
-  "version": "1.144.1",
+  "version": "1.146.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.146.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.146.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.146.0
 
 declare namespace sap {
   /**

package/types/sap.collaboration.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.144.0
+// For Library Version: 1.146.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.146.1
 
 declare namespace sap {
   namespace esh {
@@ -26,27 +26,21 @@ 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
+               * 	https://help.sap.com/viewer/691cb949c1034198800afde3e5be6570/2.0.08/en-US/ce86ef2fd97610149eaaaa0244ca4d36.html
+               * SAP HANA Search Developer Guide
+               * 	https://help.sap.com/docs/SAP_S4HANA_ON-PREMISE/90b263323d0a4976bcda415e6bd20ea4/d93d53ef27074bbf9a4849c4a4c3e360.html
+               * Enterprise Search in SAP S/4HANA
                */
               constructor(
                 /**
@@ -66,30 +60,10 @@ declare namespace sap {
               /**
                * Constructs a new `SearchBasketAddButton` to display a button to add result items to the search basket.
                * 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
-              );
-            }
-            /**
-             * 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
+               * 	https://help.sap.com/viewer/691cb949c1034198800afde3e5be6570/2.0.08/en-US/ce86ef2fd97610149eaaaa0244ca4d36.html
+               * SAP HANA Search Developer Guide
+               * 	https://help.sap.com/docs/SAP_S4HANA_ON-PREMISE/90b263323d0a4976bcda415e6bd20ea4/d93d53ef27074bbf9a4849c4a4c3e360.html
+               * Enterprise Search in SAP S/4HANA
                */
               constructor(
                 /**
@@ -125,8 +99,10 @@ declare namespace sap {
               /**
                * Constructs a new `SearchShowDetailButton` to display a button to navigate to the detail of a result item.
                * See:
-               * 	https://help.sap.com/viewer/691cb949c1034198800afde3e5be6570/2.0.05/en-US/ce86ef2fd97610149eaaaa0244ca4d36.html
-               * 	https://help.sap.com/viewer/6522d0462aeb4909a79c3462b090ec51/1709%20002/en-US
+               * 	https://help.sap.com/viewer/691cb949c1034198800afde3e5be6570/2.0.08/en-US/ce86ef2fd97610149eaaaa0244ca4d36.html
+               * SAP HANA Search Developer Guide
+               * 	https://help.sap.com/docs/SAP_S4HANA_ON-PREMISE/90b263323d0a4976bcda415e6bd20ea4/d93d53ef27074bbf9a4849c4a4c3e360.html
+               * Enterprise Search in SAP S/4HANA
                */
               constructor(
                 /**
@@ -147,8 +123,10 @@ declare namespace sap {
                * Constructs a new `SearchText` to display an attribute (text only, no navigation) on custom grid control
                * tiles.
                * See:
-               * 	https://help.sap.com/viewer/691cb949c1034198800afde3e5be6570/2.0.05/en-US/ce86ef2fd97610149eaaaa0244ca4d36.html
-               * 	https://help.sap.com/viewer/6522d0462aeb4909a79c3462b090ec51/1709%20002/en-US
+               * 	https://help.sap.com/viewer/691cb949c1034198800afde3e5be6570/2.0.08/en-US/ce86ef2fd97610149eaaaa0244ca4d36.html
+               * SAP HANA Search Developer Guide
+               * 	https://help.sap.com/docs/SAP_S4HANA_ON-PREMISE/90b263323d0a4976bcda415e6bd20ea4/d93d53ef27074bbf9a4849c4a4c3e360.html
+               * Enterprise Search in SAP S/4HANA
                */
               constructor(
                 /**
@@ -216,8 +194,10 @@ declare namespace sap {
             /**
              * Constructs a new `SearchText` to display an attribute (with navigation) on custom grid control tiles.
              * See:
-             * 	https://help.sap.com/viewer/691cb949c1034198800afde3e5be6570/2.0.05/en-US/ce86ef2fd97610149eaaaa0244ca4d36.html
-             * 	https://help.sap.com/viewer/6522d0462aeb4909a79c3462b090ec51/1709%20002/en-US
+             * 	https://help.sap.com/viewer/691cb949c1034198800afde3e5be6570/2.0.08/en-US/ce86ef2fd97610149eaaaa0244ca4d36.html
+             * SAP HANA Search Developer Guide
+             * 	https://help.sap.com/docs/SAP_S4HANA_ON-PREMISE/90b263323d0a4976bcda415e6bd20ea4/d93d53ef27074bbf9a4849c4a4c3e360.html
+             * Enterprise Search in SAP S/4HANA
              */
             constructor(
               /**
@@ -599,6 +579,17 @@ declare namespace sap {
             | sap.ui.base.ManagedObject.PropertyBindingInfo
             | `{${string}}`;
 
+          /**
+           * A boolean which indicates whether the basket panel with selected items is initially opened or closed.
+           * This affects only the initial state of the basket panel.
+           *
+           * @since 1.146.0
+           */
+          basketPanelVisibility?:
+            | boolean
+            | sap.ui.base.ManagedObject.PropertyBindingInfo
+            | `{${string}}`;
+
           /**
            * Display a splitter bar to resize the right hand panel, containing the basket with selected items.
            *
@@ -734,7 +725,7 @@ declare namespace sap {
             | `{${string}}`;
 
           /**
-           * A boolean which indicates whether the facet panel is initially openend or closed. This affects only the
+           * A boolean which indicates whether the facet panel is initially opened or closed. This affects only the
            * initial state of the facet panel. This initial state of the facet panel can be overwritten by the user,
            * depending on the user's personalization settings.
            *
@@ -839,7 +830,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 +944,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.
            *
@@ -1180,8 +1177,10 @@ declare namespace sap {
           /**
            * Constructs a new `SearchCompositeControl` to interact with SAP Enterprise Search Services.
            * See:
-           * 	https://help.sap.com/viewer/691cb949c1034198800afde3e5be6570/2.0.05/en-US/ce86ef2fd97610149eaaaa0244ca4d36.html
-           * 	https://help.sap.com/viewer/6522d0462aeb4909a79c3462b090ec51/1709%20002/en-US
+           * 	https://help.sap.com/viewer/691cb949c1034198800afde3e5be6570/2.0.08/en-US/ce86ef2fd97610149eaaaa0244ca4d36.html
+           * SAP HANA Search Developer Guide
+           * 	https://help.sap.com/docs/SAP_S4HANA_ON-PREMISE/90b263323d0a4976bcda415e6bd20ea4/d93d53ef27074bbf9a4849c4a4c3e360.html
+           * Enterprise Search in SAP S/4HANA
            */
           constructor(
             /**
@@ -1192,8 +1191,10 @@ declare namespace sap {
           /**
            * Constructs a new `SearchCompositeControl` to interact with SAP Enterprise Search Services.
            * See:
-           * 	https://help.sap.com/viewer/691cb949c1034198800afde3e5be6570/2.0.05/en-US/ce86ef2fd97610149eaaaa0244ca4d36.html
-           * 	https://help.sap.com/viewer/6522d0462aeb4909a79c3462b090ec51/1709%20002/en-US
+           * 	https://help.sap.com/viewer/691cb949c1034198800afde3e5be6570/2.0.08/en-US/ce86ef2fd97610149eaaaa0244ca4d36.html
+           * SAP HANA Search Developer Guide
+           * 	https://help.sap.com/docs/SAP_S4HANA_ON-PREMISE/90b263323d0a4976bcda415e6bd20ea4/d93d53ef27074bbf9a4849c4a4c3e360.html
+           * Enterprise Search in SAP S/4HANA
            */
           constructor(
             /**
@@ -1636,6 +1637,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 +1970,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 +2067,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 +2090,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}.
            *
@@ -2072,6 +2118,15 @@ declare namespace sap {
            * @returns Value of property `basketPanelResizable`
            */
           getBasketPanelResizable(): boolean;
+          /**
+           * Get visibility status of basket panel
+           *
+           * @since 1.146.0
+           * @experimental As of version 1.143.0.
+           *
+           * @returns boolean The visibility status of basket panel
+           */
+          getBasketPanelVisibility(): undefined;
           /**
            * Gets current value of property {@link #getBasketPanelWidthInPercent basketPanelWidthInPercent}.
            *
@@ -2132,7 +2187,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
            *
@@ -2301,7 +2360,7 @@ declare namespace sap {
           /**
            * Gets current value of property {@link #getFacetVisibility facetVisibility}.
            *
-           * A boolean which indicates whether the facet panel is initially openend or closed. This affects only the
+           * A boolean which indicates whether the facet panel is initially opened or closed. This affects only the
            * initial state of the facet panel. This initial state of the facet panel can be overwritten by the user,
            * depending on the user's personalization settings.
            *
@@ -2641,6 +2700,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 +2772,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 +3088,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}.
            *
@@ -3050,6 +3130,15 @@ declare namespace sap {
              */
             bBasketPanelResizable?: boolean
           ): this;
+          /**
+           * Set visibility status of basket panel
+           *
+           * @since 1.146.0
+           * @experimental As of version 1.143.0.
+           *
+           * @returns boolean The visibility status of basket panel
+           */
+          setBasketPanelVisibility(): undefined;
           /**
            * Sets a new value for property {@link #getBasketPanelWidthInPercent basketPanelWidthInPercent}.
            *
@@ -3130,7 +3219,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.
            *
@@ -3393,7 +3486,7 @@ declare namespace sap {
           /**
            * Sets a new value for property {@link #getFacetVisibility facetVisibility}.
            *
-           * A boolean which indicates whether the facet panel is initially openend or closed. This affects only the
+           * A boolean which indicates whether the facet panel is initially opened or closed. This affects only the
            * initial state of the facet panel. This initial state of the facet panel can be overwritten by the user,
            * depending on the user's personalization settings.
            *
@@ -3988,24 +4081,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 +4234,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;