@openui5/ts-types 1.93.3 → 1.96.2

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,3 +1,3 @@
1
- // For Library Version: 1.93.3
1
+ // For Library Version: 1.96.2
2
2
 
3
3
  declare namespace sap {}
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.93.3
1
+ // For Library Version: 1.96.2
2
2
 
3
3
  declare namespace sap {
4
4
  interface IUI5DefineDependencyNames {
@@ -10,6 +10,8 @@ declare namespace sap {
10
10
 
11
11
  "sap/ui/fl/apply/_internal/changes/descriptor/app/SetTitle": undefined;
12
12
 
13
+ "sap/ui/fl/apply/_internal/changes/descriptor/fiori/SetAbstract": undefined;
14
+
13
15
  "sap/ui/fl/apply/_internal/changes/descriptor/fiori/SetRegistrationIds": undefined;
14
16
 
15
17
  "sap/ui/fl/apply/_internal/changes/descriptor/ovp/AddNewCard": undefined;
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.93.3
1
+ // For Library Version: 1.96.2
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -276,6 +276,152 @@ declare namespace sap {
276
276
  }
277
277
  }
278
278
 
279
+ namespace editor {
280
+ /**
281
+ * @EXPERIMENTAL (since 1.94)
282
+ *
283
+ * Facade of the {@link sap.ui.integration.editor.Editor} control.
284
+ */
285
+ interface EditorFacade {
286
+ __implements__sap_ui_integration_editor_EditorFacade: boolean;
287
+
288
+ /**
289
+ * @EXPERIMENTAL (since 1.94)
290
+ *
291
+ * Performs an HTTP request using the given configuration.
292
+ */
293
+ request(
294
+ /**
295
+ * The configuration of the request.
296
+ */
297
+ oConfiguration: {
298
+ /**
299
+ * The URL of the resource.
300
+ */
301
+ URL: string;
302
+ /**
303
+ * The mode of the request. Possible values are "cors", "no-cors", "same-origin".
304
+ */
305
+ mode?: string;
306
+ /**
307
+ * The HTTP method. Possible values are "GET", "POST".
308
+ */
309
+ method?: string;
310
+ /**
311
+ * The request parameters. If the method is "POST" the parameters will be put as key/value pairs into the
312
+ * body of the request.
313
+ */
314
+ parameters?: Object;
315
+ /**
316
+ * The expected Content-Type of the response. Possible values are "xml", "json", "text", "script", "html",
317
+ * "jsonp". Note: Complex Binding is not supported when a dataType is provided. Serialization of the response
318
+ * to an object is up to the developer.
319
+ */
320
+ dataType?: Object;
321
+ /**
322
+ * The HTTP headers of the request.
323
+ */
324
+ headers?: Object;
325
+ /**
326
+ * Indicates whether cross-site requests should be made using credentials.
327
+ */
328
+ withCredentials?: boolean;
329
+ }
330
+ ): Promise<any>;
331
+ }
332
+
333
+ interface $ExtensionSettings
334
+ extends sap.ui.base.$ManagedObjectSettings {
335
+ /**
336
+ * @EXPERIMENTAL (since 1.94)
337
+ *
338
+ * The formatters, which can be used in the manifest.
339
+ */
340
+ formatters?: object | sap.ui.base.ManagedObject.PropertyBindingInfo;
341
+ }
342
+
343
+ /**
344
+ * @SINCE 1.94
345
+ *
346
+ * Brings JavaScript capabilities for an {@link sap.ui.integration.editor.Editor} where custom logic can
347
+ * be implemented.
348
+ */
349
+ class Extension extends sap.ui.base.ManagedObject {
350
+ /**
351
+ * Constructor for a new `Extension`.
352
+ *
353
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
354
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
355
+ * of the syntax of the settings object.
356
+ */
357
+ constructor(
358
+ /**
359
+ * Initial settings for the new extension.
360
+ */
361
+ mSettings?: sap.ui.integration.editor.$ExtensionSettings
362
+ );
363
+ /**
364
+ * Constructor for a new `Extension`.
365
+ *
366
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
367
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
368
+ * of the syntax of the settings object.
369
+ */
370
+ constructor(
371
+ /**
372
+ * ID for the new extension, generated automatically if no ID is given.
373
+ */
374
+ sId?: string,
375
+ /**
376
+ * Initial settings for the new extension.
377
+ */
378
+ mSettings?: sap.ui.integration.editor.$ExtensionSettings
379
+ );
380
+
381
+ /**
382
+ * Creates a new subclass of class sap.ui.integration.editor.Extension with name `sClassName` and enriches
383
+ * it with the information contained in `oClassInfo`.
384
+ *
385
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.ManagedObject.extend}.
386
+ */
387
+ static extend<T extends Record<string, unknown>>(
388
+ /**
389
+ * Name of the class being created
390
+ */
391
+ sClassName: string,
392
+ /**
393
+ * Object literal with information about the class
394
+ */
395
+ oClassInfo?: sap.ClassInfo<T, sap.ui.integration.editor.Extension>,
396
+ /**
397
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
398
+ * used by this class
399
+ */
400
+ FNMetaImpl?: Function
401
+ ): Function;
402
+ /**
403
+ * Returns a metadata object for class sap.ui.integration.editor.Extension.
404
+ */
405
+ static getMetadata(): sap.ui.base.ManagedObjectMetadata;
406
+ /**
407
+ * Returns an interface to the editor, which uses this extension.
408
+ */
409
+ getEditor(): sap.ui.integration.widgets.CardFacade;
410
+ /**
411
+ * @EXPERIMENTAL (since 1.94)
412
+ *
413
+ * Gets current value of property {@link #getFormatters formatters}.
414
+ *
415
+ * The formatters, which can be used in the manifest.
416
+ */
417
+ getFormatters(): object;
418
+ /**
419
+ * Called when the editor is ready.
420
+ */
421
+ onEditorReady(): void;
422
+ }
423
+ }
424
+
279
425
  namespace widgets {
280
426
  /**
281
427
  * @EXPERIMENTAL (since 1.79)
@@ -413,6 +559,12 @@ declare namespace sap {
413
559
  * Refreshes the card by re-applying the manifest settings and triggering all data requests.
414
560
  */
415
561
  refresh(): void;
562
+ /**
563
+ * @SINCE 1.95
564
+ *
565
+ * Refreshes the card data by triggering all data requests.
566
+ */
567
+ refreshData(): void;
416
568
  /**
417
569
  * @SINCE 1.85
418
570
  * @EXPERIMENTAL (since 1.85)
@@ -471,6 +623,15 @@ declare namespace sap {
471
623
  withCredentials?: boolean;
472
624
  }
473
625
  ): Promise<any>;
626
+ /**
627
+ * Resolves the destination and returns its URL.
628
+ */
629
+ resolveDestination(
630
+ /**
631
+ * The destination's key used in the configuration.
632
+ */
633
+ sKey: string
634
+ ): Promise<any>;
474
635
  /**
475
636
  * Displays the loading placeholders on the whole card, or a particular area of the card. **Note:** Only
476
637
  * areas that contain binding will receive a loading placeholder.
@@ -621,6 +782,14 @@ declare namespace sap {
621
782
  */
622
783
  action?: (oEvent: sap.ui.base.Event) => void;
623
784
 
785
+ /**
786
+ * @EXPERIMENTAL (since 1.96)
787
+ *
788
+ * Fired when some configuration settings are changed as a result of user interaction. For example - filter
789
+ * value is changed.
790
+ */
791
+ configurationChange?: (oEvent: sap.ui.base.Event) => void;
792
+
624
793
  /**
625
794
  * @EXPERIMENTAL (since 1.72)
626
795
  *
@@ -797,6 +966,55 @@ declare namespace sap {
797
966
  */
798
967
  oListener?: object
799
968
  ): this;
969
+ /**
970
+ * @EXPERIMENTAL (since 1.96)
971
+ *
972
+ * Attaches event handler `fnFunction` to the {@link #event:configurationChange configurationChange} event
973
+ * of this `sap.ui.integration.widgets.Card`.
974
+ *
975
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
976
+ * otherwise it will be bound to this `sap.ui.integration.widgets.Card` itself.
977
+ *
978
+ * Fired when some configuration settings are changed as a result of user interaction. For example - filter
979
+ * value is changed.
980
+ */
981
+ attachConfigurationChange(
982
+ /**
983
+ * An application-specific payload object that will be passed to the event handler along with the event
984
+ * object when firing the event
985
+ */
986
+ oData: object,
987
+ /**
988
+ * The function to be called when the event occurs
989
+ */
990
+ fnFunction: (p1: sap.ui.base.Event) => void,
991
+ /**
992
+ * Context object to call the event handler with. Defaults to this `sap.ui.integration.widgets.Card` itself
993
+ */
994
+ oListener?: object
995
+ ): this;
996
+ /**
997
+ * @EXPERIMENTAL (since 1.96)
998
+ *
999
+ * Attaches event handler `fnFunction` to the {@link #event:configurationChange configurationChange} event
1000
+ * of this `sap.ui.integration.widgets.Card`.
1001
+ *
1002
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1003
+ * otherwise it will be bound to this `sap.ui.integration.widgets.Card` itself.
1004
+ *
1005
+ * Fired when some configuration settings are changed as a result of user interaction. For example - filter
1006
+ * value is changed.
1007
+ */
1008
+ attachConfigurationChange(
1009
+ /**
1010
+ * The function to be called when the event occurs
1011
+ */
1012
+ fnFunction: (p1: sap.ui.base.Event) => void,
1013
+ /**
1014
+ * Context object to call the event handler with. Defaults to this `sap.ui.integration.widgets.Card` itself
1015
+ */
1016
+ oListener?: object
1017
+ ): this;
800
1018
  /**
801
1019
  * Attaches event handler `fnFunction` to the {@link #event:manifestApplied manifestApplied} event of this
802
1020
  * `sap.ui.integration.widgets.Card`.
@@ -915,6 +1133,24 @@ declare namespace sap {
915
1133
  */
916
1134
  oListener?: object
917
1135
  ): this;
1136
+ /**
1137
+ * @EXPERIMENTAL (since 1.96)
1138
+ *
1139
+ * Detaches event handler `fnFunction` from the {@link #event:configurationChange configurationChange} event
1140
+ * of this `sap.ui.integration.widgets.Card`.
1141
+ *
1142
+ * The passed function and listener object must match the ones used for event registration.
1143
+ */
1144
+ detachConfigurationChange(
1145
+ /**
1146
+ * The function to be called, when the event occurs
1147
+ */
1148
+ fnFunction: (p1: sap.ui.base.Event) => void,
1149
+ /**
1150
+ * Context object on which the given function had to be called
1151
+ */
1152
+ oListener?: object
1153
+ ): this;
918
1154
  /**
919
1155
  * Detaches event handler `fnFunction` from the {@link #event:manifestApplied manifestApplied} event of
920
1156
  * this `sap.ui.integration.widgets.Card`.
@@ -980,6 +1216,31 @@ declare namespace sap {
980
1216
  type?: sap.ui.integration.CardActionType;
981
1217
  }
982
1218
  ): boolean;
1219
+ /**
1220
+ * @EXPERIMENTAL (since 1.96)
1221
+ *
1222
+ * Fires event {@link #event:configurationChange configurationChange} to attached listeners.
1223
+ */
1224
+ fireConfigurationChange(
1225
+ /**
1226
+ * Parameters to pass along with the event
1227
+ */
1228
+ mParameters?: {
1229
+ /**
1230
+ * Changed configuration settings.
1231
+ *
1232
+ * Example:
1233
+ * ```javascript
1234
+ *
1235
+ * {
1236
+ * "/sap.card/configuration/filters/shipper/value": "key3",
1237
+ * "/sap.card/configuration/filters/item/value": "key2",
1238
+ * }
1239
+ * ```
1240
+ */
1241
+ changes?: object;
1242
+ }
1243
+ ): this;
983
1244
  /**
984
1245
  * Fires event {@link #event:manifestApplied manifestApplied} to attached listeners.
985
1246
  */
@@ -1196,6 +1457,12 @@ declare namespace sap {
1196
1457
  * Refreshes the card by re-applying the manifest settings and triggering all data requests.
1197
1458
  */
1198
1459
  refresh(): void;
1460
+ /**
1461
+ * @SINCE 1.95
1462
+ *
1463
+ * Refreshes the card data by triggering all data requests.
1464
+ */
1465
+ refreshData(): void;
1199
1466
  /**
1200
1467
  * @SINCE 1.85
1201
1468
  * @EXPERIMENTAL (since 1.85)
@@ -1263,6 +1530,15 @@ declare namespace sap {
1263
1530
  withCredentials?: boolean;
1264
1531
  }
1265
1532
  ): Promise<any>;
1533
+ /**
1534
+ * Resolves the destination and returns its URL.
1535
+ */
1536
+ resolveDestination(
1537
+ /**
1538
+ * The destination's key used in the configuration.
1539
+ */
1540
+ sKey: string
1541
+ ): Promise<any>;
1266
1542
  /**
1267
1543
  * @SINCE 1.70
1268
1544
  * @EXPERIMENTAL (since 1.70)
@@ -1524,6 +1800,14 @@ declare namespace sap {
1524
1800
  */
1525
1801
  action?: (oEvent: sap.ui.base.Event) => void;
1526
1802
 
1803
+ /**
1804
+ * @EXPERIMENTAL (since 1.96)
1805
+ *
1806
+ * Fired when some card configuration settings are changed as a result of user interaction. For example
1807
+ * - filter value is changed.
1808
+ */
1809
+ cardConfigurationChange?: (oEvent: sap.ui.base.Event) => void;
1810
+
1527
1811
  /**
1528
1812
  * @EXPERIMENTAL (since 1.91)
1529
1813
  *
@@ -2186,6 +2470,55 @@ declare namespace sap {
2186
2470
  */
2187
2471
  oListener?: object
2188
2472
  ): this;
2473
+ /**
2474
+ * @EXPERIMENTAL (since 1.96)
2475
+ *
2476
+ * Attaches event handler `fnFunction` to the {@link #event:cardConfigurationChange cardConfigurationChange}
2477
+ * event of this `sap.ui.integration.Host`.
2478
+ *
2479
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
2480
+ * otherwise it will be bound to this `sap.ui.integration.Host` itself.
2481
+ *
2482
+ * Fired when some card configuration settings are changed as a result of user interaction. For example
2483
+ * - filter value is changed.
2484
+ */
2485
+ attachCardConfigurationChange(
2486
+ /**
2487
+ * An application-specific payload object that will be passed to the event handler along with the event
2488
+ * object when firing the event
2489
+ */
2490
+ oData: object,
2491
+ /**
2492
+ * The function to be called when the event occurs
2493
+ */
2494
+ fnFunction: (p1: sap.ui.base.Event) => void,
2495
+ /**
2496
+ * Context object to call the event handler with. Defaults to this `sap.ui.integration.Host` itself
2497
+ */
2498
+ oListener?: object
2499
+ ): this;
2500
+ /**
2501
+ * @EXPERIMENTAL (since 1.96)
2502
+ *
2503
+ * Attaches event handler `fnFunction` to the {@link #event:cardConfigurationChange cardConfigurationChange}
2504
+ * event of this `sap.ui.integration.Host`.
2505
+ *
2506
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
2507
+ * otherwise it will be bound to this `sap.ui.integration.Host` itself.
2508
+ *
2509
+ * Fired when some card configuration settings are changed as a result of user interaction. For example
2510
+ * - filter value is changed.
2511
+ */
2512
+ attachCardConfigurationChange(
2513
+ /**
2514
+ * The function to be called when the event occurs
2515
+ */
2516
+ fnFunction: (p1: sap.ui.base.Event) => void,
2517
+ /**
2518
+ * Context object to call the event handler with. Defaults to this `sap.ui.integration.Host` itself
2519
+ */
2520
+ oListener?: object
2521
+ ): this;
2189
2522
  /**
2190
2523
  * @EXPERIMENTAL (since 1.91)
2191
2524
  *
@@ -2248,6 +2581,24 @@ declare namespace sap {
2248
2581
  */
2249
2582
  oListener?: object
2250
2583
  ): this;
2584
+ /**
2585
+ * @EXPERIMENTAL (since 1.96)
2586
+ *
2587
+ * Detaches event handler `fnFunction` from the {@link #event:cardConfigurationChange cardConfigurationChange}
2588
+ * event of this `sap.ui.integration.Host`.
2589
+ *
2590
+ * The passed function and listener object must match the ones used for event registration.
2591
+ */
2592
+ detachCardConfigurationChange(
2593
+ /**
2594
+ * The function to be called, when the event occurs
2595
+ */
2596
+ fnFunction: (p1: sap.ui.base.Event) => void,
2597
+ /**
2598
+ * Context object on which the given function had to be called
2599
+ */
2600
+ oListener?: object
2601
+ ): this;
2251
2602
  /**
2252
2603
  * @EXPERIMENTAL (since 1.91)
2253
2604
  *
@@ -2300,6 +2651,35 @@ declare namespace sap {
2300
2651
  type?: sap.ui.integration.CardActionType;
2301
2652
  }
2302
2653
  ): boolean;
2654
+ /**
2655
+ * @EXPERIMENTAL (since 1.96)
2656
+ *
2657
+ * Fires event {@link #event:cardConfigurationChange cardConfigurationChange} to attached listeners.
2658
+ */
2659
+ fireCardConfigurationChange(
2660
+ /**
2661
+ * Parameters to pass along with the event
2662
+ */
2663
+ mParameters?: {
2664
+ /**
2665
+ * The card the changes are fired from.
2666
+ */
2667
+ card?: sap.ui.core.Control;
2668
+ /**
2669
+ * Changed configuration settings.
2670
+ *
2671
+ * Example:
2672
+ * ```javascript
2673
+ *
2674
+ * {
2675
+ * "/sap.card/configuration/filters/shipper/value": "key3",
2676
+ * "/sap.card/configuration/filters/item/value": "key2"
2677
+ * }
2678
+ * ```
2679
+ */
2680
+ changes?: object;
2681
+ }
2682
+ ): this;
2303
2683
  /**
2304
2684
  * @EXPERIMENTAL (since 1.91)
2305
2685
  *
@@ -2422,6 +2802,21 @@ declare namespace sap {
2422
2802
  fnResolveDestination: Function
2423
2803
  ): this;
2424
2804
  }
2805
+ /**
2806
+ * @SINCE 1.96
2807
+ *
2808
+ * Defines the layout type of the List card attributes.
2809
+ */
2810
+ enum AttributesLayoutType {
2811
+ /**
2812
+ * One column.
2813
+ */
2814
+ OneColumn = "OneColumn",
2815
+ /**
2816
+ * Two columns.
2817
+ */
2818
+ TwoColumns = "TwoColumns",
2819
+ }
2425
2820
  /**
2426
2821
  * @EXPERIMENTAL (since 1.64)
2427
2822
  *
@@ -2615,33 +3010,37 @@ declare namespace sap {
2615
3010
 
2616
3011
  "sap/ui/integration/designtime/editor/CardPreview": undefined;
2617
3012
 
2618
- "sap/ui/integration/designtime/editor/CardResourceBundles": undefined;
3013
+ "sap/ui/integration/editor/Editor": undefined;
3014
+
3015
+ "sap/ui/integration/editor/EditorResourceBundles": undefined;
2619
3016
 
2620
- "sap/ui/integration/designtime/editor/fields/BaseField": undefined;
3017
+ "sap/ui/integration/editor/Extension": undefined;
2621
3018
 
2622
- "sap/ui/integration/designtime/editor/fields/BooleanField": undefined;
3019
+ "sap/ui/integration/editor/fields/BaseField": undefined;
2623
3020
 
2624
- "sap/ui/integration/designtime/editor/fields/DateField": undefined;
3021
+ "sap/ui/integration/editor/fields/BooleanField": undefined;
2625
3022
 
2626
- "sap/ui/integration/designtime/editor/fields/DateTimeField": undefined;
3023
+ "sap/ui/integration/editor/fields/DateField": undefined;
2627
3024
 
2628
- "sap/ui/integration/designtime/editor/fields/DestinationField": undefined;
3025
+ "sap/ui/integration/editor/fields/DateTimeField": undefined;
2629
3026
 
2630
- "sap/ui/integration/designtime/editor/fields/IntegerField": undefined;
3027
+ "sap/ui/integration/editor/fields/DestinationField": undefined;
2631
3028
 
2632
- "sap/ui/integration/designtime/editor/fields/ListField": undefined;
3029
+ "sap/ui/integration/editor/fields/IntegerField": undefined;
2633
3030
 
2634
- "sap/ui/integration/designtime/editor/fields/NumberField": undefined;
3031
+ "sap/ui/integration/editor/fields/ListField": undefined;
2635
3032
 
2636
- "sap/ui/integration/designtime/editor/fields/Settings": undefined;
3033
+ "sap/ui/integration/editor/fields/NumberField": undefined;
2637
3034
 
2638
- "sap/ui/integration/designtime/editor/fields/StringField": undefined;
3035
+ "sap/ui/integration/editor/fields/StringField": undefined;
2639
3036
 
2640
- "sap/ui/integration/designtime/editor/fields/viz/ColorSelect": undefined;
3037
+ "sap/ui/integration/editor/fields/viz/ColorSelect": undefined;
2641
3038
 
2642
- "sap/ui/integration/designtime/editor/fields/viz/IconSelect": undefined;
3039
+ "sap/ui/integration/editor/fields/viz/IconSelect": undefined;
2643
3040
 
2644
- "sap/ui/integration/designtime/editor/fields/viz/ShapeSelect": undefined;
3041
+ "sap/ui/integration/editor/fields/viz/ShapeSelect": undefined;
3042
+
3043
+ "sap/ui/integration/editor/Settings": undefined;
2645
3044
 
2646
3045
  "sap/ui/integration/Extension": undefined;
2647
3046
 
@@ -2651,6 +3050,12 @@ declare namespace sap {
2651
3050
 
2652
3051
  "sap/ui/integration/services/Service": undefined;
2653
3052
 
3053
+ "sap/ui/integration/util/DataProvider": undefined;
3054
+
3055
+ "sap/ui/integration/util/DataProviderFactory": undefined;
3056
+
3057
+ "sap/ui/integration/util/RequestDataProvider": undefined;
3058
+
2654
3059
  "sap/ui/integration/widgets/Card": undefined;
2655
3060
  }
2656
3061
  }
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.93.3
1
+ // For Library Version: 1.96.2
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1575,6 +1575,24 @@ declare namespace sap {
1575
1575
  getActiveGridSettings(): void;
1576
1576
 
1577
1577
  isResponsive(): boolean;
1578
+ /**
1579
+ * Hook function for the Grid's onAfterRendering
1580
+ */
1581
+ onGridAfterRendering(
1582
+ /**
1583
+ * The grid
1584
+ */
1585
+ oGrid: sap.ui.layout.cssgrid.IGridConfigurable
1586
+ ): void;
1587
+ /**
1588
+ * Hook function for the Grid's resize. Will be called if the grid layout is responsive.
1589
+ */
1590
+ onGridResize(
1591
+ /**
1592
+ * The event passed by the resize handler
1593
+ */
1594
+ oEvent: jQuery.Event
1595
+ ): void;
1578
1596
  }
1579
1597
  /**
1580
1598
  * Add handlers for a sap.ui.layout.cssgrid.IGridConfigurable control lifecycle events. Applies the grid