@openui5/types 1.114.0 → 1.115.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.114.0
1
+ // For Library Version: 1.115.0
2
2
 
3
3
  declare module "sap/ui/integration/library" {
4
4
  import { URI } from "sap/ui/core/library";
@@ -230,7 +230,7 @@ declare module "sap/ui/integration/ActionDefinition" {
230
230
  * Represents an action, which appears in the header of {@link sap.ui.integration.widgets.Card}. Useful
231
231
  * in `Component` card and `Extension`.
232
232
  */
233
- export default class ActionDefinition extends UI5Element {
233
+ class ActionDefinition extends UI5Element {
234
234
  /**
235
235
  * Constructor for a new `ActionDefinition`.
236
236
  *
@@ -548,6 +548,7 @@ declare module "sap/ui/integration/ActionDefinition" {
548
548
  bVisible?: boolean
549
549
  ): this;
550
550
  }
551
+ export default ActionDefinition;
551
552
 
552
553
  export interface $ActionDefinitionSettings extends $ElementSettings {
553
554
  /**
@@ -597,16 +598,18 @@ declare module "sap/ui/integration/ActionDefinition" {
597
598
  */
598
599
  press?: (oEvent: Event) => void;
599
600
  }
601
+
602
+ export interface $ActionDefinitionPressEventParameters {}
600
603
  }
601
604
 
602
605
  declare module "sap/ui/integration/widgets/Card" {
603
606
  import {
604
607
  CardBlockingMessageType,
605
- CardActionType,
606
608
  CardDataMode,
607
609
  CardDesign,
608
610
  CardPreviewMode,
609
611
  CardArea,
612
+ CardActionType,
610
613
  } from "sap/ui/integration/library";
611
614
 
612
615
  import IllustratedMessageType from "sap/m/IllustratedMessageType";
@@ -619,14 +622,14 @@ declare module "sap/ui/integration/widgets/Card" {
619
622
 
620
623
  import Event from "sap/ui/base/Event";
621
624
 
622
- import Control from "sap/ui/core/Control";
623
-
624
625
  import { URI, ID, MessageType } from "sap/ui/core/library";
625
626
 
626
627
  import Host from "sap/ui/integration/Host";
627
628
 
628
629
  import ElementMetadata from "sap/ui/core/ElementMetadata";
629
630
 
631
+ import Control from "sap/ui/core/Control";
632
+
630
633
  import {
631
634
  PropertyBindingInfo,
632
635
  AggregationBindingInfo,
@@ -694,8 +697,7 @@ declare module "sap/ui/integration/widgets/Card" {
694
697
  * - The dimensions of the card inside a layout of choice, using the `width` and `height` properties
695
698
  * - The behavior for the actions described in the manifest.json file, using the action event
696
699
  *
697
- * **You can learn more about integration cards in the {@link demo:sap/ui/integration/demokit/cardExplorer/index.html
698
- * Card Explorer}**
700
+ * **You can learn more about integration cards in the {@link demo:sap/ui/integration/demokit/cardExplorer/index.html Card Explorer}**
699
701
  *
700
702
  * When to use
701
703
  * - When you want to reuse the card across apps.
@@ -708,7 +710,7 @@ declare module "sap/ui/integration/widgets/Card" {
708
710
  * - When you have to use an application model. For such cases, use: {@link sap.f.Card sap.f.Card}.
709
711
  * - When you need complex behavior. For such cases, use: {@link sap.f.Card sap.f.Card}.
710
712
  */
711
- export default class Card extends CardBase {
713
+ class Card extends CardBase {
712
714
  /**
713
715
  * Constructor for a new `Card`.
714
716
  *
@@ -716,7 +718,7 @@ declare module "sap/ui/integration/widgets/Card" {
716
718
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
717
719
  * of the syntax of the settings object.
718
720
  * See:
719
- * {@link topic:5b46b03f024542ba802d99d67bc1a3f4 Cards}
721
+ * {@link https://ui5.sap.com/#/topic/5b46b03f024542ba802d99d67bc1a3f4 Cards}
720
722
  */
721
723
  constructor(
722
724
  /**
@@ -731,7 +733,7 @@ declare module "sap/ui/integration/widgets/Card" {
731
733
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
732
734
  * of the syntax of the settings object.
733
735
  * See:
734
- * {@link topic:5b46b03f024542ba802d99d67bc1a3f4 Cards}
736
+ * {@link https://ui5.sap.com/#/topic/5b46b03f024542ba802d99d67bc1a3f4 Cards}
735
737
  */
736
738
  constructor(
737
739
  /**
@@ -814,7 +816,7 @@ declare module "sap/ui/integration/widgets/Card" {
814
816
  /**
815
817
  * The function to be called when the event occurs
816
818
  */
817
- fnFunction: (p1: Event) => void,
819
+ fnFunction: (p1: Event<$CardActionEventParameters>) => void,
818
820
  /**
819
821
  * Context object to call the event handler with. Defaults to this `sap.ui.integration.widgets.Card` itself
820
822
  */
@@ -841,7 +843,7 @@ declare module "sap/ui/integration/widgets/Card" {
841
843
  /**
842
844
  * The function to be called when the event occurs
843
845
  */
844
- fnFunction: (p1: Event) => void,
846
+ fnFunction: (p1: Event<$CardActionEventParameters>) => void,
845
847
  /**
846
848
  * Context object to call the event handler with. Defaults to this `sap.ui.integration.widgets.Card` itself
847
849
  */
@@ -870,7 +872,7 @@ declare module "sap/ui/integration/widgets/Card" {
870
872
  /**
871
873
  * The function to be called when the event occurs
872
874
  */
873
- fnFunction: (p1: Event) => void,
875
+ fnFunction: (p1: Event<$CardConfigurationChangeEventParameters>) => void,
874
876
  /**
875
877
  * Context object to call the event handler with. Defaults to this `sap.ui.integration.widgets.Card` itself
876
878
  */
@@ -894,7 +896,7 @@ declare module "sap/ui/integration/widgets/Card" {
894
896
  /**
895
897
  * The function to be called when the event occurs
896
898
  */
897
- fnFunction: (p1: Event) => void,
899
+ fnFunction: (p1: Event<$CardConfigurationChangeEventParameters>) => void,
898
900
  /**
899
901
  * Context object to call the event handler with. Defaults to this `sap.ui.integration.widgets.Card` itself
900
902
  */
@@ -1077,7 +1079,7 @@ declare module "sap/ui/integration/widgets/Card" {
1077
1079
  /**
1078
1080
  * The function to be called, when the event occurs
1079
1081
  */
1080
- fnFunction: (p1: Event) => void,
1082
+ fnFunction: (p1: Event<$CardActionEventParameters>) => void,
1081
1083
  /**
1082
1084
  * Context object on which the given function had to be called
1083
1085
  */
@@ -1097,7 +1099,7 @@ declare module "sap/ui/integration/widgets/Card" {
1097
1099
  /**
1098
1100
  * The function to be called, when the event occurs
1099
1101
  */
1100
- fnFunction: (p1: Event) => void,
1102
+ fnFunction: (p1: Event<$CardConfigurationChangeEventParameters>) => void,
1101
1103
  /**
1102
1104
  * Context object on which the given function had to be called
1103
1105
  */
@@ -1176,24 +1178,7 @@ declare module "sap/ui/integration/widgets/Card" {
1176
1178
  /**
1177
1179
  * Parameters to pass along with the event
1178
1180
  */
1179
- mParameters?: {
1180
- /**
1181
- * The action source.
1182
- */
1183
- actionSource?: Control;
1184
- /**
1185
- * The manifest parameters related to the triggered action.
1186
- */
1187
- manifestParameters?: object;
1188
- /**
1189
- * The parameters related to the triggered action.
1190
- */
1191
- parameters?: object;
1192
- /**
1193
- * The type of the action.
1194
- */
1195
- type?: CardActionType | keyof typeof CardActionType;
1196
- }
1181
+ mParameters?: $CardActionEventParameters
1197
1182
  ): boolean;
1198
1183
  /**
1199
1184
  * @EXPERIMENTAL (since 1.96)
@@ -1207,21 +1192,7 @@ declare module "sap/ui/integration/widgets/Card" {
1207
1192
  /**
1208
1193
  * Parameters to pass along with the event
1209
1194
  */
1210
- mParameters?: {
1211
- /**
1212
- * Changed configuration settings.
1213
- *
1214
- * Example:
1215
- * ```javascript
1216
- *
1217
- * {
1218
- * "/sap.card/configuration/filters/shipper/value": "key3",
1219
- * "/sap.card/configuration/filters/item/value": "key2",
1220
- * }
1221
- * ```
1222
- */
1223
- changes?: object;
1224
- }
1195
+ mParameters?: $CardConfigurationChangeEventParameters
1225
1196
  ): this;
1226
1197
  /**
1227
1198
  * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
@@ -1432,7 +1403,7 @@ declare module "sap/ui/integration/widgets/Card" {
1432
1403
  * Preview mode of the `Card`. Helpful in scenarios when the end user is choosing or configuring a card.
1433
1404
  *
1434
1405
  * - When set to "MockData", the card data is loaded, using a data request, as configured in the "data/mockData"
1435
- * in the manifest. If such configuration is missing, then the Abstract mode will be used instead.
1406
+ * in the manifest. If such configuration is missing, then the Abstract mode will be used instead.
1436
1407
  * - When set to "Abstract", the card shows abstract placeholder without loading data.
1437
1408
  * - When set to "Off", the card displays real data.
1438
1409
  *
@@ -1501,8 +1472,8 @@ declare module "sap/ui/integration/widgets/Card" {
1501
1472
  * @EXPERIMENTAL (since 1.85) - Disclaimer: this aggregation is in a beta state - incompatible API changes
1502
1473
  * may be done before its official public release. Use at your own discretion.
1503
1474
  *
1504
- * Checks for the provided `sap.ui.integration.ActionDefinition` in the aggregation {@link #getActionDefinitions
1505
- * actionDefinitions}. and returns its index if found or -1 otherwise.
1475
+ * Checks for the provided `sap.ui.integration.ActionDefinition` in the aggregation {@link #getActionDefinitions actionDefinitions}.
1476
+ * and returns its index if found or -1 otherwise.
1506
1477
  *
1507
1478
  * @returns The index of the provided control in the aggregation if found, or -1 otherwise
1508
1479
  */
@@ -1791,7 +1762,7 @@ declare module "sap/ui/integration/widgets/Card" {
1791
1762
  * Preview mode of the `Card`. Helpful in scenarios when the end user is choosing or configuring a card.
1792
1763
  *
1793
1764
  * - When set to "MockData", the card data is loaded, using a data request, as configured in the "data/mockData"
1794
- * in the manifest. If such configuration is missing, then the Abstract mode will be used instead.
1765
+ * in the manifest. If such configuration is missing, then the Abstract mode will be used instead.
1795
1766
  * - When set to "Abstract", the card shows abstract placeholder without loading data.
1796
1767
  * - When set to "Off", the card displays real data.
1797
1768
  *
@@ -1911,6 +1882,8 @@ declare module "sap/ui/integration/widgets/Card" {
1911
1882
  */
1912
1883
  validateControls(): boolean;
1913
1884
  }
1885
+ export default Card;
1886
+
1914
1887
  /**
1915
1888
  * @EXPERIMENTAL (since 1.79)
1916
1889
  *
@@ -2043,8 +2016,8 @@ declare module "sap/ui/integration/widgets/Card" {
2043
2016
  * @EXPERIMENTAL (since 1.85) - Disclaimer: this aggregation is in a beta state - incompatible API changes
2044
2017
  * may be done before its official public release. Use at your own discretion.
2045
2018
  *
2046
- * Checks for the provided `sap.ui.integration.ActionDefinition` in the aggregation {@link #getActionDefinitions
2047
- * actionDefinitions}. and returns its index if found or -1 otherwise.
2019
+ * Checks for the provided `sap.ui.integration.ActionDefinition` in the aggregation {@link #getActionDefinitions actionDefinitions}.
2020
+ * and returns its index if found or -1 otherwise.
2048
2021
  *
2049
2022
  * @returns The index of the provided control in the aggregation if found, or -1 otherwise
2050
2023
  */
@@ -2344,7 +2317,7 @@ declare module "sap/ui/integration/widgets/Card" {
2344
2317
  * Preview mode of the `Card`. Helpful in scenarios when the end user is choosing or configuring a card.
2345
2318
  *
2346
2319
  * - When set to "MockData", the card data is loaded, using a data request, as configured in the "data/mockData"
2347
- * in the manifest. If such configuration is missing, then the Abstract mode will be used instead.
2320
+ * in the manifest. If such configuration is missing, then the Abstract mode will be used instead.
2348
2321
  * - When set to "Abstract", the card shows abstract placeholder without loading data.
2349
2322
  * - When set to "Off", the card displays real data.
2350
2323
  */
@@ -2382,7 +2355,7 @@ declare module "sap/ui/integration/widgets/Card" {
2382
2355
  * In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
2383
2356
  * one to handle the action by calling `oEvent.preventDefault()`.
2384
2357
  */
2385
- action?: (oEvent: Event) => void;
2358
+ action?: (oEvent: Event<$CardActionEventParameters>) => void;
2386
2359
 
2387
2360
  /**
2388
2361
  * @EXPERIMENTAL (since 1.96)
@@ -2390,7 +2363,9 @@ declare module "sap/ui/integration/widgets/Card" {
2390
2363
  * Fired when some configuration settings are changed as a result of user interaction. For example - filter
2391
2364
  * value is changed.
2392
2365
  */
2393
- configurationChange?: (oEvent: Event) => void;
2366
+ configurationChange?: (
2367
+ oEvent: Event<$CardConfigurationChangeEventParameters>
2368
+ ) => void;
2394
2369
 
2395
2370
  /**
2396
2371
  * @EXPERIMENTAL (since 1.72)
@@ -2415,6 +2390,50 @@ declare module "sap/ui/integration/widgets/Card" {
2415
2390
  */
2416
2391
  stateChanged?: (oEvent: Event) => void;
2417
2392
  }
2393
+
2394
+ export interface $CardActionEventParameters {
2395
+ /**
2396
+ * The action source.
2397
+ */
2398
+ actionSource?: Control;
2399
+
2400
+ /**
2401
+ * The manifest parameters related to the triggered action.
2402
+ */
2403
+ manifestParameters?: object;
2404
+
2405
+ /**
2406
+ * The parameters related to the triggered action.
2407
+ */
2408
+ parameters?: object;
2409
+
2410
+ /**
2411
+ * The type of the action.
2412
+ */
2413
+ type?: CardActionType | keyof typeof CardActionType;
2414
+ }
2415
+
2416
+ export interface $CardConfigurationChangeEventParameters {
2417
+ /**
2418
+ * Changed configuration settings.
2419
+ *
2420
+ * Example:
2421
+ * ```javascript
2422
+ *
2423
+ * {
2424
+ * "/sap.card/configuration/filters/shipper/value": "key3",
2425
+ * "/sap.card/configuration/filters/item/value": "key2",
2426
+ * }
2427
+ * ```
2428
+ */
2429
+ changes?: object;
2430
+ }
2431
+
2432
+ export interface $CardManifestAppliedEventParameters {}
2433
+
2434
+ export interface $CardManifestReadyEventParameters {}
2435
+
2436
+ export interface $CardStateChangedEventParameters {}
2418
2437
  }
2419
2438
 
2420
2439
  declare module "sap/ui/integration/Designtime" {
@@ -2434,7 +2453,7 @@ declare module "sap/ui/integration/Designtime" {
2434
2453
  * Brings JavaScript capabilities for an {@link sap.ui.integration.widgets.Card} where custom logic can
2435
2454
  * be implemented.
2436
2455
  */
2437
- export default class Designtime extends ManagedObject {
2456
+ class Designtime extends ManagedObject {
2438
2457
  /**
2439
2458
  * Constructor for a new `Designtime`.
2440
2459
  *
@@ -2442,8 +2461,8 @@ declare module "sap/ui/integration/Designtime" {
2442
2461
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
2443
2462
  * of the syntax of the settings object.
2444
2463
  *
2445
- * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.base.ManagedObject#constructor
2446
- * sap.ui.base.ManagedObject} can be used.
2464
+ * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.base.ManagedObject#constructor sap.ui.base.ManagedObject }
2465
+ * can be used.
2447
2466
  */
2448
2467
  constructor(
2449
2468
  /**
@@ -2458,8 +2477,8 @@ declare module "sap/ui/integration/Designtime" {
2458
2477
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
2459
2478
  * of the syntax of the settings object.
2460
2479
  *
2461
- * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.base.ManagedObject#constructor
2462
- * sap.ui.base.ManagedObject} can be used.
2480
+ * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.base.ManagedObject#constructor sap.ui.base.ManagedObject }
2481
+ * can be used.
2463
2482
  */
2464
2483
  constructor(
2465
2484
  /**
@@ -2508,6 +2527,7 @@ declare module "sap/ui/integration/Designtime" {
2508
2527
  */
2509
2528
  getCard(): CardFacade;
2510
2529
  }
2530
+ export default Designtime;
2511
2531
 
2512
2532
  export interface $DesigntimeSettings extends $ManagedObjectSettings {}
2513
2533
  }
@@ -2878,7 +2898,7 @@ declare module "sap/ui/integration/editor/Extension" {
2878
2898
  * Brings JavaScript capabilities for an {@link sap.ui.integration.editor.Editor} where custom logic can
2879
2899
  * be implemented.
2880
2900
  */
2881
- export default class Extension extends Extension1 {
2901
+ class Extension extends Extension1 {
2882
2902
  /**
2883
2903
  * Constructor for a new `Extension`.
2884
2904
  */
@@ -2913,6 +2933,7 @@ declare module "sap/ui/integration/editor/Extension" {
2913
2933
  */
2914
2934
  onEditorReady(): void;
2915
2935
  }
2936
+ export default Extension;
2916
2937
 
2917
2938
  export interface $ExtensionSettings extends $ExtensionSettings1 {}
2918
2939
  }
@@ -2926,21 +2947,21 @@ declare module "sap/ui/integration/Extension" {
2926
2947
 
2927
2948
  import Event from "sap/ui/base/Event";
2928
2949
 
2929
- import Control from "sap/ui/core/Control";
2930
-
2931
- import { CardActionType, CardMenuAction } from "sap/ui/integration/library";
2950
+ import { CardMenuAction, CardActionType } from "sap/ui/integration/library";
2932
2951
 
2933
2952
  import { CardFacade } from "sap/ui/integration/widgets/Card";
2934
2953
 
2935
2954
  import ManagedObjectMetadata from "sap/ui/base/ManagedObjectMetadata";
2936
2955
 
2956
+ import Control from "sap/ui/core/Control";
2957
+
2937
2958
  /**
2938
2959
  * @SINCE 1.75
2939
2960
  *
2940
2961
  * Brings JavaScript capabilities for an {@link sap.ui.integration.widgets.Card} where custom logic can
2941
2962
  * be implemented.
2942
2963
  */
2943
- export default class Extension extends ManagedObject {
2964
+ class Extension extends ManagedObject {
2944
2965
  /**
2945
2966
  * Constructor for a new `Extension`.
2946
2967
  *
@@ -3027,7 +3048,7 @@ declare module "sap/ui/integration/Extension" {
3027
3048
  /**
3028
3049
  * The function to be called when the event occurs
3029
3050
  */
3030
- fnFunction: (p1: Event) => void,
3051
+ fnFunction: (p1: Event<$ExtensionActionEventParameters>) => void,
3031
3052
  /**
3032
3053
  * Context object to call the event handler with. Defaults to this `sap.ui.integration.Extension` itself
3033
3054
  */
@@ -3054,7 +3075,7 @@ declare module "sap/ui/integration/Extension" {
3054
3075
  /**
3055
3076
  * The function to be called when the event occurs
3056
3077
  */
3057
- fnFunction: (p1: Event) => void,
3078
+ fnFunction: (p1: Event<$ExtensionActionEventParameters>) => void,
3058
3079
  /**
3059
3080
  * Context object to call the event handler with. Defaults to this `sap.ui.integration.Extension` itself
3060
3081
  */
@@ -3074,7 +3095,7 @@ declare module "sap/ui/integration/Extension" {
3074
3095
  /**
3075
3096
  * The function to be called, when the event occurs
3076
3097
  */
3077
- fnFunction: (p1: Event) => void,
3098
+ fnFunction: (p1: Event<$ExtensionActionEventParameters>) => void,
3078
3099
  /**
3079
3100
  * Context object on which the given function had to be called
3080
3101
  */
@@ -3120,28 +3141,7 @@ declare module "sap/ui/integration/Extension" {
3120
3141
  /**
3121
3142
  * Parameters to pass along with the event
3122
3143
  */
3123
- mParameters?: {
3124
- /**
3125
- * The card the action is fired from.
3126
- */
3127
- card?: Control;
3128
- /**
3129
- * The action configuration.
3130
- */
3131
- actionConfig?: object;
3132
- /**
3133
- * The action source.
3134
- */
3135
- actionSource?: Control;
3136
- /**
3137
- * The parameters related to the triggered action.
3138
- */
3139
- parameters?: object;
3140
- /**
3141
- * The type of the action.
3142
- */
3143
- type?: CardActionType | keyof typeof CardActionType;
3144
- }
3144
+ mParameters?: $ExtensionActionEventParameters
3145
3145
  ): boolean;
3146
3146
  /**
3147
3147
  * @deprecated (since 1.85) - This property is replaced by the `actions` aggregation of the card;
@@ -3197,6 +3197,7 @@ declare module "sap/ui/integration/Extension" {
3197
3197
  aFormatters?: Record<string, Function>
3198
3198
  ): this;
3199
3199
  }
3200
+ export default Extension;
3200
3201
 
3201
3202
  export interface $ExtensionSettings extends $ManagedObjectSettings {
3202
3203
  /**
@@ -3225,7 +3226,34 @@ declare module "sap/ui/integration/Extension" {
3225
3226
  * In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
3226
3227
  * one to handle the action by calling `oEvent.preventDefault()`.
3227
3228
  */
3228
- action?: (oEvent: Event) => void;
3229
+ action?: (oEvent: Event<$ExtensionActionEventParameters>) => void;
3230
+ }
3231
+
3232
+ export interface $ExtensionActionEventParameters {
3233
+ /**
3234
+ * The card the action is fired from.
3235
+ */
3236
+ card?: Control;
3237
+
3238
+ /**
3239
+ * The action configuration.
3240
+ */
3241
+ actionConfig?: object;
3242
+
3243
+ /**
3244
+ * The action source.
3245
+ */
3246
+ actionSource?: Control;
3247
+
3248
+ /**
3249
+ * The parameters related to the triggered action.
3250
+ */
3251
+ parameters?: object;
3252
+
3253
+ /**
3254
+ * The type of the action.
3255
+ */
3256
+ type?: CardActionType | keyof typeof CardActionType;
3229
3257
  }
3230
3258
  }
3231
3259
 
@@ -3234,9 +3262,7 @@ declare module "sap/ui/integration/Host" {
3234
3262
 
3235
3263
  import Event from "sap/ui/base/Event";
3236
3264
 
3237
- import Control from "sap/ui/core/Control";
3238
-
3239
- import { CardActionType, CardMenuAction } from "sap/ui/integration/library";
3265
+ import { CardMenuAction, CardActionType } from "sap/ui/integration/library";
3240
3266
 
3241
3267
  import Card from "sap/ui/integration/widgets/Card";
3242
3268
 
@@ -3244,6 +3270,8 @@ declare module "sap/ui/integration/Host" {
3244
3270
 
3245
3271
  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
3246
3272
 
3273
+ import Control from "sap/ui/core/Control";
3274
+
3247
3275
  /**
3248
3276
  * @SINCE 1.75
3249
3277
  * @EXPERIMENTAL (since 1.75)
@@ -3252,7 +3280,7 @@ declare module "sap/ui/integration/Host" {
3252
3280
  *
3253
3281
  * Examples may include, but are not limited to options like: share a card, remove a card.
3254
3282
  */
3255
- export default class Host extends UI5Element {
3283
+ class Host extends UI5Element {
3256
3284
  /**
3257
3285
  * Constructor for a new `Host`.
3258
3286
  *
@@ -3339,7 +3367,7 @@ declare module "sap/ui/integration/Host" {
3339
3367
  /**
3340
3368
  * The function to be called when the event occurs
3341
3369
  */
3342
- fnFunction: (p1: Event) => void,
3370
+ fnFunction: (p1: Event<$HostActionEventParameters>) => void,
3343
3371
  /**
3344
3372
  * Context object to call the event handler with. Defaults to this `sap.ui.integration.Host` itself
3345
3373
  */
@@ -3366,7 +3394,7 @@ declare module "sap/ui/integration/Host" {
3366
3394
  /**
3367
3395
  * The function to be called when the event occurs
3368
3396
  */
3369
- fnFunction: (p1: Event) => void,
3397
+ fnFunction: (p1: Event<$HostActionEventParameters>) => void,
3370
3398
  /**
3371
3399
  * Context object to call the event handler with. Defaults to this `sap.ui.integration.Host` itself
3372
3400
  */
@@ -3375,7 +3403,7 @@ declare module "sap/ui/integration/Host" {
3375
3403
  /**
3376
3404
  * @EXPERIMENTAL (since 1.96)
3377
3405
  *
3378
- * Attaches event handler `fnFunction` to the {@link #event:cardConfigurationChange cardConfigurationChange}
3406
+ * Attaches event handler `fnFunction` to the {@link #event:cardConfigurationChange cardConfigurationChange }
3379
3407
  * event of this `sap.ui.integration.Host`.
3380
3408
  *
3381
3409
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
@@ -3395,7 +3423,9 @@ declare module "sap/ui/integration/Host" {
3395
3423
  /**
3396
3424
  * The function to be called when the event occurs
3397
3425
  */
3398
- fnFunction: (p1: Event) => void,
3426
+ fnFunction: (
3427
+ p1: Event<$HostCardConfigurationChangeEventParameters>
3428
+ ) => void,
3399
3429
  /**
3400
3430
  * Context object to call the event handler with. Defaults to this `sap.ui.integration.Host` itself
3401
3431
  */
@@ -3404,7 +3434,7 @@ declare module "sap/ui/integration/Host" {
3404
3434
  /**
3405
3435
  * @EXPERIMENTAL (since 1.96)
3406
3436
  *
3407
- * Attaches event handler `fnFunction` to the {@link #event:cardConfigurationChange cardConfigurationChange}
3437
+ * Attaches event handler `fnFunction` to the {@link #event:cardConfigurationChange cardConfigurationChange }
3408
3438
  * event of this `sap.ui.integration.Host`.
3409
3439
  *
3410
3440
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
@@ -3419,7 +3449,9 @@ declare module "sap/ui/integration/Host" {
3419
3449
  /**
3420
3450
  * The function to be called when the event occurs
3421
3451
  */
3422
- fnFunction: (p1: Event) => void,
3452
+ fnFunction: (
3453
+ p1: Event<$HostCardConfigurationChangeEventParameters>
3454
+ ) => void,
3423
3455
  /**
3424
3456
  * Context object to call the event handler with. Defaults to this `sap.ui.integration.Host` itself
3425
3457
  */
@@ -3448,7 +3480,7 @@ declare module "sap/ui/integration/Host" {
3448
3480
  /**
3449
3481
  * The function to be called when the event occurs
3450
3482
  */
3451
- fnFunction: (p1: Event) => void,
3483
+ fnFunction: (p1: Event<$HostCardStateChangedEventParameters>) => void,
3452
3484
  /**
3453
3485
  * Context object to call the event handler with. Defaults to this `sap.ui.integration.Host` itself
3454
3486
  */
@@ -3472,7 +3504,7 @@ declare module "sap/ui/integration/Host" {
3472
3504
  /**
3473
3505
  * The function to be called when the event occurs
3474
3506
  */
3475
- fnFunction: (p1: Event) => void,
3507
+ fnFunction: (p1: Event<$HostCardStateChangedEventParameters>) => void,
3476
3508
  /**
3477
3509
  * Context object to call the event handler with. Defaults to this `sap.ui.integration.Host` itself
3478
3510
  */
@@ -3499,7 +3531,7 @@ declare module "sap/ui/integration/Host" {
3499
3531
  /**
3500
3532
  * The function to be called when the event occurs
3501
3533
  */
3502
- fnFunction: (p1: Event) => void,
3534
+ fnFunction: (p1: Event<$HostMessageEventParameters>) => void,
3503
3535
  /**
3504
3536
  * Context object to call the event handler with. Defaults to this `sap.ui.integration.Host` itself
3505
3537
  */
@@ -3521,7 +3553,7 @@ declare module "sap/ui/integration/Host" {
3521
3553
  /**
3522
3554
  * The function to be called when the event occurs
3523
3555
  */
3524
- fnFunction: (p1: Event) => void,
3556
+ fnFunction: (p1: Event<$HostMessageEventParameters>) => void,
3525
3557
  /**
3526
3558
  * Context object to call the event handler with. Defaults to this `sap.ui.integration.Host` itself
3527
3559
  */
@@ -3571,7 +3603,7 @@ declare module "sap/ui/integration/Host" {
3571
3603
  /**
3572
3604
  * The function to be called, when the event occurs
3573
3605
  */
3574
- fnFunction: (p1: Event) => void,
3606
+ fnFunction: (p1: Event<$HostActionEventParameters>) => void,
3575
3607
  /**
3576
3608
  * Context object on which the given function had to be called
3577
3609
  */
@@ -3580,7 +3612,7 @@ declare module "sap/ui/integration/Host" {
3580
3612
  /**
3581
3613
  * @EXPERIMENTAL (since 1.96)
3582
3614
  *
3583
- * Detaches event handler `fnFunction` from the {@link #event:cardConfigurationChange cardConfigurationChange}
3615
+ * Detaches event handler `fnFunction` from the {@link #event:cardConfigurationChange cardConfigurationChange }
3584
3616
  * event of this `sap.ui.integration.Host`.
3585
3617
  *
3586
3618
  * The passed function and listener object must match the ones used for event registration.
@@ -3591,7 +3623,9 @@ declare module "sap/ui/integration/Host" {
3591
3623
  /**
3592
3624
  * The function to be called, when the event occurs
3593
3625
  */
3594
- fnFunction: (p1: Event) => void,
3626
+ fnFunction: (
3627
+ p1: Event<$HostCardConfigurationChangeEventParameters>
3628
+ ) => void,
3595
3629
  /**
3596
3630
  * Context object on which the given function had to be called
3597
3631
  */
@@ -3611,7 +3645,7 @@ declare module "sap/ui/integration/Host" {
3611
3645
  /**
3612
3646
  * The function to be called, when the event occurs
3613
3647
  */
3614
- fnFunction: (p1: Event) => void,
3648
+ fnFunction: (p1: Event<$HostCardStateChangedEventParameters>) => void,
3615
3649
  /**
3616
3650
  * Context object on which the given function had to be called
3617
3651
  */
@@ -3630,7 +3664,7 @@ declare module "sap/ui/integration/Host" {
3630
3664
  /**
3631
3665
  * The function to be called, when the event occurs
3632
3666
  */
3633
- fnFunction: (p1: Event) => void,
3667
+ fnFunction: (p1: Event<$HostMessageEventParameters>) => void,
3634
3668
  /**
3635
3669
  * Context object on which the given function had to be called
3636
3670
  */
@@ -3652,28 +3686,7 @@ declare module "sap/ui/integration/Host" {
3652
3686
  /**
3653
3687
  * Parameters to pass along with the event
3654
3688
  */
3655
- mParameters?: {
3656
- /**
3657
- * The card the action is fired from.
3658
- */
3659
- card?: Control;
3660
- /**
3661
- * The action configuration.
3662
- */
3663
- actionConfig?: object;
3664
- /**
3665
- * The action source.
3666
- */
3667
- actionSource?: Control;
3668
- /**
3669
- * The parameters related to the triggered action.
3670
- */
3671
- parameters?: object;
3672
- /**
3673
- * The type of the action.
3674
- */
3675
- type?: CardActionType | keyof typeof CardActionType;
3676
- }
3689
+ mParameters?: $HostActionEventParameters
3677
3690
  ): boolean;
3678
3691
  /**
3679
3692
  * @EXPERIMENTAL (since 1.96)
@@ -3687,25 +3700,7 @@ declare module "sap/ui/integration/Host" {
3687
3700
  /**
3688
3701
  * Parameters to pass along with the event
3689
3702
  */
3690
- mParameters?: {
3691
- /**
3692
- * The card the changes are fired from.
3693
- */
3694
- card?: Control;
3695
- /**
3696
- * Changed configuration settings.
3697
- *
3698
- * Example:
3699
- * ```javascript
3700
- *
3701
- * {
3702
- * "/sap.card/configuration/filters/shipper/value": "key3",
3703
- * "/sap.card/configuration/filters/item/value": "key2"
3704
- * }
3705
- * ```
3706
- */
3707
- changes?: object;
3708
- }
3703
+ mParameters?: $HostCardConfigurationChangeEventParameters
3709
3704
  ): this;
3710
3705
  /**
3711
3706
  * @EXPERIMENTAL (since 1.107)
@@ -3719,12 +3714,7 @@ declare module "sap/ui/integration/Host" {
3719
3714
  /**
3720
3715
  * Parameters to pass along with the event
3721
3716
  */
3722
- mParameters?: {
3723
- /**
3724
- * The card the changes are fired from.
3725
- */
3726
- card?: Control;
3727
- }
3717
+ mParameters?: $HostCardStateChangedEventParameters
3728
3718
  ): this;
3729
3719
  /**
3730
3720
  * @EXPERIMENTAL (since 1.91)
@@ -3738,9 +3728,7 @@ declare module "sap/ui/integration/Host" {
3738
3728
  /**
3739
3729
  * Parameters to pass along with the event
3740
3730
  */
3741
- mParameters?: {
3742
- data?: object;
3743
- }
3731
+ mParameters?: $HostMessageEventParameters
3744
3732
  ): this;
3745
3733
  /**
3746
3734
  * @EXPERIMENTAL (since 1.75) - Disclaimer: this property is in a beta state - incompatible API changes
@@ -3886,6 +3874,7 @@ declare module "sap/ui/integration/Host" {
3886
3874
  fnResolveDestination?: (p1: string, p2: Card) => string | Promise<string>
3887
3875
  ): this;
3888
3876
  }
3877
+ export default Host;
3889
3878
 
3890
3879
  export interface $HostSettings extends $ElementSettings {
3891
3880
  /**
@@ -3919,7 +3908,7 @@ declare module "sap/ui/integration/Host" {
3919
3908
  * In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
3920
3909
  * one to handle the action by calling `oEvent.preventDefault()`.
3921
3910
  */
3922
- action?: (oEvent: Event) => void;
3911
+ action?: (oEvent: Event<$HostActionEventParameters>) => void;
3923
3912
 
3924
3913
  /**
3925
3914
  * @EXPERIMENTAL (since 1.96)
@@ -3927,7 +3916,9 @@ declare module "sap/ui/integration/Host" {
3927
3916
  * Fired when some card configuration settings are changed as a result of user interaction. For example
3928
3917
  * - filter value is changed.
3929
3918
  */
3930
- cardConfigurationChange?: (oEvent: Event) => void;
3919
+ cardConfigurationChange?: (
3920
+ oEvent: Event<$HostCardConfigurationChangeEventParameters>
3921
+ ) => void;
3931
3922
 
3932
3923
  /**
3933
3924
  * @EXPERIMENTAL (since 1.107)
@@ -3935,14 +3926,75 @@ declare module "sap/ui/integration/Host" {
3935
3926
  * Fired when the state of a card is changed. For example - the card is ready, new page is selected inside
3936
3927
  * the card, a filter is changed or data is refreshed.
3937
3928
  */
3938
- cardStateChanged?: (oEvent: Event) => void;
3929
+ cardStateChanged?: (
3930
+ oEvent: Event<$HostCardStateChangedEventParameters>
3931
+ ) => void;
3939
3932
 
3940
3933
  /**
3941
3934
  * @EXPERIMENTAL (since 1.91)
3942
3935
  *
3943
3936
  * Fired when a message from channels like navigator.serviceWorker is received.
3944
3937
  */
3945
- message?: (oEvent: Event) => void;
3938
+ message?: (oEvent: Event<$HostMessageEventParameters>) => void;
3939
+ }
3940
+
3941
+ export interface $HostActionEventParameters {
3942
+ /**
3943
+ * The card the action is fired from.
3944
+ */
3945
+ card?: Control;
3946
+
3947
+ /**
3948
+ * The action configuration.
3949
+ */
3950
+ actionConfig?: object;
3951
+
3952
+ /**
3953
+ * The action source.
3954
+ */
3955
+ actionSource?: Control;
3956
+
3957
+ /**
3958
+ * The parameters related to the triggered action.
3959
+ */
3960
+ parameters?: object;
3961
+
3962
+ /**
3963
+ * The type of the action.
3964
+ */
3965
+ type?: CardActionType | keyof typeof CardActionType;
3966
+ }
3967
+
3968
+ export interface $HostCardConfigurationChangeEventParameters {
3969
+ /**
3970
+ * The card the changes are fired from.
3971
+ */
3972
+ card?: Control;
3973
+
3974
+ /**
3975
+ * Changed configuration settings.
3976
+ *
3977
+ * Example:
3978
+ * ```javascript
3979
+ *
3980
+ * {
3981
+ * "/sap.card/configuration/filters/shipper/value": "key3",
3982
+ * "/sap.card/configuration/filters/item/value": "key2"
3983
+ * }
3984
+ * ```
3985
+ */
3986
+ changes?: object;
3987
+ }
3988
+
3989
+ export interface $HostCardStateChangedEventParameters {
3990
+ /**
3991
+ * The card the changes are fired from.
3992
+ */
3993
+ card?: Control;
3994
+ }
3995
+
3996
+ export interface $HostMessageEventParameters {
3997
+ data?: object;
3946
3998
  }
3947
3999
  }
3948
4000