@sapui5/ts-types 1.97.2 → 1.98.0

package/package.json

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

package/types/index.d.ts

@@ -37,12 +37,8 @@
 /// <reference path="./sap.fe.core.d.ts"/>
 /// <reference path="./sap.fe.macros.d.ts"/>
 /// <reference path="./sap.fe.navigation.d.ts"/>
-/// <reference path="./sap.fe.placeholder.d.ts"/>
-/// <reference path="./sap.fe.plugins.d.ts"/>
-/// <reference path="./sap.fe.semantics.d.ts"/>
 /// <reference path="./sap.fe.templates.d.ts"/>
 /// <reference path="./sap.fe.test.d.ts"/>
-/// <reference path="./sap.fe.tools.d.ts"/>
 /// <reference path="./sap.feedback.ui.d.ts"/>
 /// <reference path="./sap.landvisz.d.ts"/>
 /// <reference path="./sap.rules.ui.d.ts"/>

package/types/sap.apf.d.ts

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

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

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

package/types/sap.chart.d.ts

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

package/types/sap.collaboration.d.ts

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

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.97.0
+// For Library Version: 1.98.0
 
 declare namespace sap {
   namespace esh {
@@ -10,22 +10,94 @@ declare namespace sap {
         interface $SearchCompositeControlSettings
           extends sap.ui.core.$ControlSettings {
           /**
+           * @SINCE 1.93.0
+           *
            * An additional CSS class to add to this control
            */
           cssClass?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
 
           /**
-           * Defines the initial search term for the search input
+           * @SINCE 1.93.0
+           *
+           * Defines the initial search term for the search input.
            */
           searchTerm?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
 
           /**
+           * @SINCE 1.93.0
+           *
            * Defines if the search control will search for the given term right on control instantiation.
            */
           searchOnStart?:
             | boolean
             | sap.ui.base.ManagedObject.PropertyBindingInfo;
 
+          /**
+           * @SINCE 1.98.0
+           *
+           * Defines the filter root condition of a filter tree which shall be applied to the search request. This
+           * control only allows filter trees which have a the following structure: complex condition (root level)
+           * \ complex condition (attribute level) \ simple condition (attribute value level) Filter root conditions
+           * which do not follow this structure won't be accepted and an error will be thrown. Please see the below
+           * for a more in-depth example.
+           */
+          filterRootCondition?:
+            | object
+            | sap.ui.base.ManagedObject.PropertyBindingInfo;
+
+          /**
+           * @SINCE 1.93.0
+           *
+           * Configuration for the Enterprise Search Client API.
+           */
+          sinaConfiguration?:
+            | object
+            | sap.ui.base.ManagedObject.PropertyBindingInfo;
+
+          /**
+           * @SINCE 1.98.0
+           *
+           * The id of the data source in which it will search right after initialization.
+           */
+          dataSource?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
+
+          /**
+           * @SINCE 1.98.0
+           *
+           * Defines search result view types. Search result of single Business Object is switchable between different
+           * view types. Search result of All, Category (multiple Business Objects), or Apps is displayed in mandatory
+           * view type. It is not switchable. Possible values for the array items are "searchResultList", "searchResultTable"
+           * and "searchResultGrid". Note: The array is not allowed to have duplicates, and must contain the value
+           * of `fallbackResultViewType`.
+           */
+          resultViewTypes?:
+            | string[]
+            | sap.ui.base.ManagedObject.PropertyBindingInfo;
+
+          /**
+           * @SINCE 1.98.0
+           *
+           * Defines fallback search result view type. The compatible search result (search in Business Object) is
+           * displayed in fall back view type when there is no explicitly configured view type `resultViewType` nor
+           * historical stored view type. Possible value is "searchResultList", "searchResultTable" and "searchResultGrid".
+           * Note: The value must be contained by `resultViewTypes`.
+           */
+          fallbackResultViewType?:
+            | string
+            | sap.ui.base.ManagedObject.PropertyBindingInfo;
+
+          /**
+           * @SINCE 1.98.0
+           *
+           * select search result view type. Possible set-value is "searchResultList", "searchResultTable", and "searchResultGrid".
+           * Possible get-value is "searchResultList", "searchResultTable", "searchResultGrid" and "appSearchResult".
+           * "appSearchResult" is the view type mandatory for app search. It is not allowed to be set by user. setResultViewType()
+           * is working in attached event "searchFinished". Note: The value must be contained by `resultViewTypes`.
+           */
+          resultViewType?:
+            | string
+            | sap.ui.base.ManagedObject.PropertyBindingInfo;
+
           /**
            * Control instances which are part of this composite control.
            */
@@ -33,24 +105,37 @@ declare namespace sap {
             | sap.ui.core.Control[]
             | sap.ui.core.Control
             | sap.ui.base.ManagedObject.AggregationBindingInfo;
+
+          /**
+           * Event is fired when search is finished.
+           */
+          searchStarted?: (oEvent: sap.ui.base.Event) => void;
+
+          /**
+           * Event is fired when search is finished.
+           */
+          searchFinished?: (oEvent: sap.ui.base.Event) => void;
         }
 
         /**
          * @SINCE 1.93.0
          *
-         * This is the UI5 composite control by the Enterprise Search Team to make full use of the Enterprise Search
-         * Services. This composite control is a complete UI which includes a search input box including a suggestion
-         * dropdown, a result list which can have different styles including tiles and table, result facets and
-         * more. This control is ready to use with an enterprise search backend service but also allows deep modifications
-         * to match requirements of adopting applications.
+         * This is the SAPUI5 composite control by the Enterprise Search Team which helps to make full use of the
+         * Enterprise Search Engine features built into ABAP and HANA. It includes a search input box including
+         * a suggestion dropdown, a result list which can have different styles including tiles and table, result
+         * facets and more. This control is ready to use with an enterprise search backend service but also allows
+         * deep modifications to match requirements of adopting applications.
          */
         class SearchCompositeControl extends sap.ui.core.Control {
           /**
-           * Constructs a new `SearchCompositeControl` to interact with a SAP Enterprise Search Service.
+           * Constructs a new `SearchCompositeControl` to interact with SAP Enterprise Search Services.
            *
            * 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.
+           * 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(
             /**
@@ -59,11 +144,14 @@ declare namespace sap {
             mSettings?: sap.esh.search.ui.$SearchCompositeControlSettings
           );
           /**
-           * Constructs a new `SearchCompositeControl` to interact with a SAP Enterprise Search Service.
+           * Constructs a new `SearchCompositeControl` to interact with SAP Enterprise Search Services.
            *
            * 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.
+           * 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(
             /**
@@ -113,10 +201,148 @@ declare namespace sap {
              */
             oContent: sap.ui.core.Control
           ): this;
+          /**
+           * Attaches event handler `fnFunction` to the {@link #event:searchFinished searchFinished} event of this
+           * `sap.esh.search.ui.SearchCompositeControl`.
+           *
+           * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
+           * otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself.
+           *
+           * Event is fired when search is finished.
+           */
+          attachSearchFinished(
+            /**
+             * An application-specific payload object that will be passed to the event handler along with the event
+             * object when firing the event
+             */
+            oData: object,
+            /**
+             * The function to be called when the event occurs
+             */
+            fnFunction: (p1: sap.ui.base.Event) => void,
+            /**
+             * Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl`
+             * itself
+             */
+            oListener?: object
+          ): this;
+          /**
+           * Attaches event handler `fnFunction` to the {@link #event:searchFinished searchFinished} event of this
+           * `sap.esh.search.ui.SearchCompositeControl`.
+           *
+           * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
+           * otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself.
+           *
+           * Event is fired when search is finished.
+           */
+          attachSearchFinished(
+            /**
+             * The function to be called when the event occurs
+             */
+            fnFunction: (p1: sap.ui.base.Event) => void,
+            /**
+             * Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl`
+             * itself
+             */
+            oListener?: object
+          ): this;
+          /**
+           * Attaches event handler `fnFunction` to the {@link #event:searchStarted searchStarted} event of this `sap.esh.search.ui.SearchCompositeControl`.
+           *
+           * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
+           * otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself.
+           *
+           * Event is fired when search is finished.
+           */
+          attachSearchStarted(
+            /**
+             * An application-specific payload object that will be passed to the event handler along with the event
+             * object when firing the event
+             */
+            oData: object,
+            /**
+             * The function to be called when the event occurs
+             */
+            fnFunction: (p1: sap.ui.base.Event) => void,
+            /**
+             * Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl`
+             * itself
+             */
+            oListener?: object
+          ): this;
+          /**
+           * Attaches event handler `fnFunction` to the {@link #event:searchStarted searchStarted} event of this `sap.esh.search.ui.SearchCompositeControl`.
+           *
+           * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
+           * otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself.
+           *
+           * Event is fired when search is finished.
+           */
+          attachSearchStarted(
+            /**
+             * The function to be called when the event occurs
+             */
+            fnFunction: (p1: sap.ui.base.Event) => void,
+            /**
+             * Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl`
+             * itself
+             */
+            oListener?: object
+          ): this;
           /**
            * Destroys all the content in the aggregation {@link #getContent content}.
            */
           destroyContent(): this;
+          /**
+           * Detaches event handler `fnFunction` from the {@link #event:searchFinished searchFinished} event of this
+           * `sap.esh.search.ui.SearchCompositeControl`.
+           *
+           * The passed function and listener object must match the ones used for event registration.
+           */
+          detachSearchFinished(
+            /**
+             * The function to be called, when the event occurs
+             */
+            fnFunction: (p1: sap.ui.base.Event) => void,
+            /**
+             * Context object on which the given function had to be called
+             */
+            oListener?: object
+          ): this;
+          /**
+           * Detaches event handler `fnFunction` from the {@link #event:searchStarted searchStarted} event of this
+           * `sap.esh.search.ui.SearchCompositeControl`.
+           *
+           * The passed function and listener object must match the ones used for event registration.
+           */
+          detachSearchStarted(
+            /**
+             * The function to be called, when the event occurs
+             */
+            fnFunction: (p1: sap.ui.base.Event) => void,
+            /**
+             * Context object on which the given function had to be called
+             */
+            oListener?: object
+          ): this;
+          /**
+           * Fires event {@link #event:searchFinished searchFinished} to attached listeners.
+           */
+          fireSearchFinished(
+            /**
+             * Parameters to pass along with the event
+             */
+            mParameters?: object
+          ): this;
+          /**
+           * Fires event {@link #event:searchStarted searchStarted} to attached listeners.
+           */
+          fireSearchStarted(
+            /**
+             * Parameters to pass along with the event
+             */
+            mParameters?: object
+          ): this;
           /**
            * Gets content of aggregation {@link #getContent content}.
            *
@@ -124,12 +350,74 @@ declare namespace sap {
            */
           getContent(): sap.ui.core.Control[];
           /**
+           * @SINCE 1.93.0
+           *
            * Gets current value of property {@link #getCssClass cssClass}.
            *
            * An additional CSS class to add to this control
            */
           getCssClass(): string;
           /**
+           * @SINCE 1.98.0
+           *
+           * Gets current value of property {@link #getDataSource dataSource}.
+           *
+           * The id of the data source in which it will search right after initialization.
+           */
+          getDataSource(): string;
+          /**
+           * @SINCE 1.98.0
+           *
+           * Gets current value of property {@link #getFallbackResultViewType fallbackResultViewType}.
+           *
+           * Defines fallback search result view type. The compatible search result (search in Business Object) is
+           * displayed in fall back view type when there is no explicitly configured view type `resultViewType` nor
+           * historical stored view type. Possible value is "searchResultList", "searchResultTable" and "searchResultGrid".
+           * Note: The value must be contained by `resultViewTypes`.
+           *
+           * Default value is `"searchResultList"`.
+           */
+          getFallbackResultViewType(): string;
+          /**
+           * @SINCE 1.98.0
+           *
+           * Gets current value of property {@link #getFilterRootCondition filterRootCondition}.
+           *
+           * Defines the filter root condition of a filter tree which shall be applied to the search request. This
+           * control only allows filter trees which have a the following structure: complex condition (root level)
+           * \ complex condition (attribute level) \ simple condition (attribute value level) Filter root conditions
+           * which do not follow this structure won't be accepted and an error will be thrown. Please see the below
+           * for a more in-depth example.
+           */
+          getFilterRootCondition(): object;
+          /**
+           * @SINCE 1.98.0
+           *
+           * Gets current value of property {@link #getResultViewType resultViewType}.
+           *
+           * select search result view type. Possible set-value is "searchResultList", "searchResultTable", and "searchResultGrid".
+           * Possible get-value is "searchResultList", "searchResultTable", "searchResultGrid" and "appSearchResult".
+           * "appSearchResult" is the view type mandatory for app search. It is not allowed to be set by user. setResultViewType()
+           * is working in attached event "searchFinished". Note: The value must be contained by `resultViewTypes`.
+           */
+          getResultViewType(): string;
+          /**
+           * @SINCE 1.98.0
+           *
+           * Gets current value of property {@link #getResultViewTypes resultViewTypes}.
+           *
+           * Defines search result view types. Search result of single Business Object is switchable between different
+           * view types. Search result of All, Category (multiple Business Objects), or Apps is displayed in mandatory
+           * view type. It is not switchable. Possible values for the array items are "searchResultList", "searchResultTable"
+           * and "searchResultGrid". Note: The array is not allowed to have duplicates, and must contain the value
+           * of `fallbackResultViewType`.
+           *
+           * Default value is `["searchResultList", "searchResultTable"]`.
+           */
+          getResultViewTypes(): string[];
+          /**
+           * @SINCE 1.93.0
+           *
            * Gets current value of property {@link #getSearchOnStart searchOnStart}.
            *
            * Defines if the search control will search for the given term right on control instantiation.
@@ -138,13 +426,23 @@ declare namespace sap {
            */
           getSearchOnStart(): boolean;
           /**
+           * @SINCE 1.93.0
+           *
            * Gets current value of property {@link #getSearchTerm searchTerm}.
            *
-           * Defines the initial search term for the search input
+           * Defines the initial search term for the search input.
            *
-           * Default value is `"*"`.
+           * Default value is `empty string`.
            */
           getSearchTerm(): string;
+          /**
+           * @SINCE 1.93.0
+           *
+           * Gets current value of property {@link #getSinaConfiguration sinaConfiguration}.
+           *
+           * Configuration for the Enterprise Search Client API.
+           */
+          getSinaConfiguration(): object;
           /**
            * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getContent content}. and returns
            * its index if found or -1 otherwise.
@@ -186,6 +484,8 @@ declare namespace sap {
             vContent: int | string | sap.ui.core.Control
           ): sap.ui.core.Control;
           /**
+           * @SINCE 1.93.0
+           *
            * Sets a new value for property {@link #getCssClass cssClass}.
            *
            * An additional CSS class to add to this control
@@ -199,6 +499,101 @@ declare namespace sap {
             sCssClass: string
           ): this;
           /**
+           * @SINCE 1.98.0
+           *
+           * Sets a new value for property {@link #getDataSource dataSource}.
+           *
+           * The id of the data source in which it will search right after initialization.
+           *
+           * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+           */
+          setDataSource(
+            /**
+             * New value for property `dataSource`
+             */
+            sDataSource: string
+          ): this;
+          /**
+           * @SINCE 1.98.0
+           *
+           * Sets a new value for property {@link #getFallbackResultViewType fallbackResultViewType}.
+           *
+           * Defines fallback search result view type. The compatible search result (search in Business Object) is
+           * displayed in fall back view type when there is no explicitly configured view type `resultViewType` nor
+           * historical stored view type. Possible value is "searchResultList", "searchResultTable" and "searchResultGrid".
+           * Note: The value must be contained by `resultViewTypes`.
+           *
+           * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+           *
+           * Default value is `"searchResultList"`.
+           */
+          setFallbackResultViewType(
+            /**
+             * New value for property `fallbackResultViewType`
+             */
+            sFallbackResultViewType?: string
+          ): this;
+          /**
+           * @SINCE 1.98.0
+           *
+           * Sets a new value for property {@link #getFilterRootCondition filterRootCondition}.
+           *
+           * Defines the filter root condition of a filter tree which shall be applied to the search request. This
+           * control only allows filter trees which have a the following structure: complex condition (root level)
+           * \ complex condition (attribute level) \ simple condition (attribute value level) Filter root conditions
+           * which do not follow this structure won't be accepted and an error will be thrown. Please see the below
+           * for a more in-depth example.
+           *
+           * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+           */
+          setFilterRootCondition(
+            /**
+             * New value for property `filterRootCondition`
+             */
+            oFilterRootCondition: object
+          ): this;
+          /**
+           * @SINCE 1.98.0
+           *
+           * Sets a new value for property {@link #getResultViewType resultViewType}.
+           *
+           * select search result view type. Possible set-value is "searchResultList", "searchResultTable", and "searchResultGrid".
+           * Possible get-value is "searchResultList", "searchResultTable", "searchResultGrid" and "appSearchResult".
+           * "appSearchResult" is the view type mandatory for app search. It is not allowed to be set by user. setResultViewType()
+           * is working in attached event "searchFinished". Note: The value must be contained by `resultViewTypes`.
+           *
+           * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+           */
+          setResultViewType(
+            /**
+             * New value for property `resultViewType`
+             */
+            sResultViewType: string
+          ): this;
+          /**
+           * @SINCE 1.98.0
+           *
+           * Sets a new value for property {@link #getResultViewTypes resultViewTypes}.
+           *
+           * Defines search result view types. Search result of single Business Object is switchable between different
+           * view types. Search result of All, Category (multiple Business Objects), or Apps is displayed in mandatory
+           * view type. It is not switchable. Possible values for the array items are "searchResultList", "searchResultTable"
+           * and "searchResultGrid". Note: The array is not allowed to have duplicates, and must contain the value
+           * of `fallbackResultViewType`.
+           *
+           * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+           *
+           * Default value is `["searchResultList", "searchResultTable"]`.
+           */
+          setResultViewTypes(
+            /**
+             * New value for property `resultViewTypes`
+             */
+            sResultViewTypes?: string[]
+          ): this;
+          /**
+           * @SINCE 1.93.0
+           *
            * Sets a new value for property {@link #getSearchOnStart searchOnStart}.
            *
            * Defines if the search control will search for the given term right on control instantiation.
@@ -214,13 +609,15 @@ declare namespace sap {
             bSearchOnStart?: boolean
           ): this;
           /**
+           * @SINCE 1.93.0
+           *
            * Sets a new value for property {@link #getSearchTerm searchTerm}.
            *
-           * Defines the initial search term for the search input
+           * Defines the initial search term for the search input.
            *
            * When called with a value of `null` or `undefined`, the default value of the property will be restored.
            *
-           * Default value is `"*"`.
+           * Default value is `empty string`.
            */
           setSearchTerm(
             /**
@@ -228,6 +625,21 @@ declare namespace sap {
              */
             sSearchTerm?: string
           ): this;
+          /**
+           * @SINCE 1.93.0
+           *
+           * Sets a new value for property {@link #getSinaConfiguration sinaConfiguration}.
+           *
+           * Configuration for the Enterprise Search Client API.
+           *
+           * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+           */
+          setSinaConfiguration(
+            /**
+             * New value for property `sinaConfiguration`
+             */
+            oSinaConfiguration: object
+          ): this;
         }
       }
     }