@sapui5/ts-types 1.152.1 → 1.154.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.
Files changed (69) hide show
  1. package/package.json +1 -1
  2. package/types/index.d.ts +7 -6
  3. package/types/sap.apf.d.ts +1 -1
  4. package/types/sap.ca.ui.d.ts +1 -1
  5. package/types/sap.chart.d.ts +1 -1
  6. package/types/sap.collaboration.d.ts +1 -1
  7. package/types/sap.esh.search.ui.d.ts +90 -45
  8. package/types/sap.f.d.ts +1 -1
  9. package/types/sap.fe.ariba.d.ts +1 -1
  10. package/types/sap.fe.base.d.ts +1 -1
  11. package/types/sap.fe.controls.d.ts +1 -1
  12. package/types/sap.fe.core.d.ts +68 -1
  13. package/types/sap.fe.ina.d.ts +1 -1
  14. package/types/sap.fe.macros.d.ts +214 -21
  15. package/types/sap.fe.navigation.d.ts +1 -1
  16. package/types/sap.fe.placeholder.d.ts +1 -1
  17. package/types/sap.fe.plugins.managecache.d.ts +1 -1
  18. package/types/sap.fe.templates.d.ts +33 -12
  19. package/types/sap.fe.test.d.ts +15 -1
  20. package/types/sap.fe.tools.d.ts +1 -1
  21. package/types/sap.feedback.ui.d.ts +1 -1
  22. package/types/sap.gantt.d.ts +290 -24
  23. package/types/sap.html.d.ts +1495 -0
  24. package/types/sap.insights.d.ts +1 -1
  25. package/types/{mobile-1.152.0-d.ts → sap.m.d.ts} +1374 -41
  26. package/types/sap.makit.d.ts +1 -1
  27. package/types/sap.me.d.ts +1 -1
  28. package/types/sap.ndc.d.ts +1 -1
  29. package/types/sap.ovp.d.ts +1 -1
  30. package/types/sap.rules.ui.d.ts +1 -1
  31. package/types/sap.sac.df.d.ts +1 -1
  32. package/types/sap.suite.ui.commons.d.ts +14 -14
  33. package/types/sap.suite.ui.generic.template.d.ts +31 -1
  34. package/types/sap.suite.ui.microchart.d.ts +1 -1
  35. package/types/sap.tnt.d.ts +1 -1
  36. package/types/sap.ui.codeeditor.d.ts +1 -1
  37. package/types/{commons-1.152.0-d.ts → sap.ui.commons.d.ts} +1 -1
  38. package/types/sap.ui.comp.d.ts +41 -5
  39. package/types/{core-1.152.0-d.ts → sap.ui.core.d.ts} +1096 -422
  40. package/types/{dt-1.152.0-d.ts → sap.ui.dt.d.ts} +1 -1
  41. package/types/sap.ui.export.d.ts +14 -2
  42. package/types/sap.ui.fl.d.ts +1 -1
  43. package/types/sap.ui.generic.app.d.ts +1 -1
  44. package/types/sap.ui.generic.template.d.ts +1 -1
  45. package/types/sap.ui.geomap.d.ts +1 -1
  46. package/types/sap.ui.integration.d.ts +1 -1
  47. package/types/sap.ui.joule.frontend.d.ts +4 -296
  48. package/types/sap.ui.layout.d.ts +14 -7
  49. package/types/{mdc-1.152.0-d.ts → sap.ui.mdc.d.ts} +6960 -5788
  50. package/types/sap.ui.richtexteditor.d.ts +1 -1
  51. package/types/sap.ui.rta.d.ts +9 -1
  52. package/types/sap.ui.suite.d.ts +1 -1
  53. package/types/sap.ui.support.d.ts +1 -1
  54. package/types/sap.ui.table.d.ts +63 -1
  55. package/types/sap.ui.testrecorder.d.ts +1 -1
  56. package/types/sap.ui.unified.d.ts +1 -1
  57. package/types/{ux3-1.152.0-d.ts → sap.ui.ux3.d.ts} +1 -1
  58. package/types/sap.ui.vbm.d.ts +1 -1
  59. package/types/sap.ui.vk.d.ts +1 -1
  60. package/types/sap.ui.vtm.d.ts +1 -1
  61. package/types/sap.uiext.inbox.d.ts +1 -1
  62. package/types/sap.ushell.d.ts +127 -17
  63. package/types/sap.ushell_abap.d.ts +3 -1
  64. package/types/sap.uxap.d.ts +1 -1
  65. package/types/sap.viz.d.ts +1 -1
  66. package/types/sap.webanalytics.core.d.ts +1 -1
  67. package/types/sap.zen.commons.d.ts +1 -1
  68. package/types/sap.zen.crosstab.d.ts +1 -1
  69. package/types/sap.zen.dsh.d.ts +1 -1
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.152.0
1
+ // For Library Version: 1.154.0
2
2
 
3
3
  declare namespace sap {
4
4
  interface IUI5DefineDependencyNames {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.152.1
1
+ // For Library Version: 1.154.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -692,6 +692,7 @@ declare namespace sap {
692
692
  * title: 'Some random title',
693
693
  * modifiedBy: 'John Doe',
694
694
  * metaSheetName: 'Custom metadata',
695
+ * rtl: true,
695
696
  * metainfo: [
696
697
  * {
697
698
  * name: 'Grouped Properties',
@@ -1070,7 +1071,9 @@ declare namespace sap {
1070
1071
  */
1071
1072
  label?: string;
1072
1073
  /**
1073
- * Field name or array of field names in the data source feed.
1074
+ * Field name or array of field names in the data source feed. A field that references a to-many navigation
1075
+ * property (a 1:N association) is exported as multiple values within a single cell. The values are joined
1076
+ * by the `separator` and, if a `template` is provided, formatted per value. Since 1.152.
1074
1077
  */
1075
1078
  property?: string | string[];
1076
1079
  /**
@@ -1164,6 +1167,10 @@ declare namespace sap {
1164
1167
  * a translated read-only suffix so the lock state is visible and announced by screen readers. Since: 1.152.
1165
1168
  */
1166
1169
  readOnly?: boolean;
1170
+ /**
1171
+ * Separator that joins the values of a multi value column. Since 1.152.
1172
+ */
1173
+ separator?: string;
1167
1174
  };
1168
1175
 
1169
1176
  type SpreadsheetSettings = {
@@ -1203,6 +1210,11 @@ declare namespace sap {
1203
1210
  * The label of the metadata sheet. The sheet will not be shown unless metadata entries are provided
1204
1211
  */
1205
1212
  metaSheetName?: string;
1213
+ /**
1214
+ * Whether the exported datasheet uses a right-to-left layout. Defaults to the current UI5 RTL configuration.
1215
+ * @since 1.153
1216
+ */
1217
+ rtl?: boolean;
1206
1218
  /**
1207
1219
  * Metadata groups with key/value pairs.
1208
1220
  */
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.152.1
1
+ // For Library Version: 1.154.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.152.0
1
+ // For Library Version: 1.154.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,3 +1,3 @@
1
- // For Library Version: 1.152.0
1
+ // For Library Version: 1.154.0
2
2
 
3
3
  declare namespace sap {}
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.152.1
1
+ // For Library Version: 1.154.0
2
2
 
3
3
  declare module "sap/ui/geomap/gen/sap_webcomponents/geomap/dist/SapGeomap" {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.152.1
1
+ // For Library Version: 1.154.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.152.1
1
+ // For Library Version: 1.154.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -13,16 +13,9 @@ declare namespace sap {
13
13
  * at library load time. Applications only need to create a JouleConnector if they have app-specific custom
14
14
  * actions to register.
15
15
  *
16
- * @experimental As of version 1.151.
16
+ * @since 1.154
17
17
  */
18
18
  namespace frontend {
19
- /**
20
- * Channel version used for MessageBroker communication.
21
- *
22
- * @experimental As of version 1.151.
23
- */
24
- export const CHANNEL_VERSION: string;
25
-
26
19
  namespace util {
27
20
  /**
28
21
  * Helper utilities for implementing frontend actions with Joule. These functions provide reusable implementations
@@ -33,7 +26,7 @@ declare namespace sap {
33
26
  * metadata from control designtime files when available. This allows controls/libraries to provide Joule-specific
34
27
  * metadata (e.g., column names for SmartTable).
35
28
  *
36
- * @experimental As of version 1.151.
29
+ * @since 1.154
37
30
  */
38
31
  interface ActionHelpers {
39
32
  /**
@@ -286,138 +279,14 @@ declare namespace sap {
286
279
  ): object;
287
280
  }
288
281
  }
289
- /**
290
- * Factory module for creating generic frontend action definitions.
291
- *
292
- * This module provides a set of standard UI introspection actions that are automatically included by JouleConnector.
293
- * These actions use ActionHelpers to provide consistent UI scanning and manipulation capabilities.
294
- *
295
- * All actions return a standardized response envelope:
296
- * ```javascript
297
- *
298
- * {
299
- * status: "success"|"error", // Overall status
300
- * content: any // Raw data or {success, error/message} object
301
- * }
302
- * ```
303
- *
304
- *
305
- * @experimental As of version 1.151.
306
- */
307
- interface GenericActions {
308
- /**
309
- * Creates an array of generic frontend action definitions.
310
- *
311
- * The following actions are created: - com.sap.ui.unified.frontend.actions.describeUI - Describes UI as
312
- * a hierarchical tree - com.sap.ui.unified.frontend.actions.describeUIElement - Describes a specific UI
313
- * element by ID - com.sap.ui.unified.frontend.actions.setFields - Sets multiple field values in a single
314
- * call - com.sap.ui.unified.frontend.actions.executeAction - Executes an action on a control (e.g., press
315
- * a button)
316
- *
317
- *
318
- * @returns Array of frontend action definitions.
319
- */
320
- create(): object[];
321
- }
322
282
 
323
- /**
324
- * Class to facilitate communication between Applications and SAP Joule via SAP Fiori Launchpad for registering
325
- * frontend actions.
326
- *
327
- * Use this class when running in FLP environment. For a unified API that works in both FLP and standalone
328
- * environments, use {@link sap.ui.joule.frontend.JouleConnector} instead.
329
- *
330
- * @experimental As of version 1.151.
331
- */
332
- class FLPJouleBridge extends sap.ui.base.Object {
333
- /**
334
- * Constructor for FLPJouleBridge.
335
- */
336
- constructor(
337
- /**
338
- * The client ID to be used when connecting to the FLP MessageBroker. Must be unique across applications.
339
- */
340
- sClientId: string
341
- );
342
-
343
- /**
344
- * Creates a new subclass of class sap.ui.joule.frontend.FLPJouleBridge with name `sClassName` and enriches
345
- * it with the information contained in `oClassInfo`.
346
- *
347
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
348
- *
349
- *
350
- * @returns Created class / constructor function
351
- */
352
- static extend<T extends Record<string, unknown>>(
353
- /**
354
- * Name of the class being created
355
- */
356
- sClassName: string,
357
- /**
358
- * Object literal with information about the class
359
- */
360
- oClassInfo?: sap.ClassInfo<T, sap.ui.joule.frontend.FLPJouleBridge>,
361
- /**
362
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
363
- * used by this class
364
- */
365
- FNMetaImpl?: Function
366
- ): Function;
367
- /**
368
- * Returns a metadata object for class sap.ui.joule.frontend.FLPJouleBridge.
369
- *
370
- *
371
- * @returns Metadata object describing this class
372
- */
373
- static getMetadata(): sap.ui.base.Metadata;
374
- /**
375
- * Disconnects the FLPJouleBridge from the MessageBroker and unsubscribes from all channels. Must be called
376
- * to clean up resources when the bridge is no longer needed. It cannot be re-connected later.
377
- *
378
- *
379
- * @returns A Promise that resolves when the bridge has been disconnected.
380
- */
381
- disconnect(): Promise<void>;
382
- /**
383
- * Returns the client ID used by this bridge.
384
- *
385
- *
386
- * @returns The client ID.
387
- */
388
- getClientId(): string;
389
- /**
390
- * Checks if the bridge is currently connected.
391
- *
392
- *
393
- * @returns True if connected, false otherwise.
394
- */
395
- isConnected(): boolean;
396
- /**
397
- * Registers callback functions to handle frontend action requests from Joule.
398
- *
399
- *
400
- * @returns A Promise that resolves when the callback has been registered.
401
- */
402
- register(
403
- /**
404
- * An object containing callback functions for Joule frontend actions.
405
- */
406
- oJouleCallbacks: {
407
- /**
408
- * Callback that returns an array of frontend actions.
409
- */
410
- getFrontendActions: Function;
411
- }
412
- ): Promise<void>;
413
- }
414
283
  /**
415
284
  * Unified connector for SAP Joule frontend action integration.
416
285
  *
417
286
  * This is the main entry point for integrating frontend actions with SAP Joule. It automatically detects
418
287
  * the runtime environment (FLP or standalone) and uses the appropriate communication mechanism.
419
288
  *
420
- * @experimental As of version 1.151.
289
+ * @since 1.154
421
290
  */
422
291
  class JouleConnector extends sap.ui.base.Object {
423
292
  /**
@@ -487,13 +356,6 @@ declare namespace sap {
487
356
  * @returns The client ID.
488
357
  */
489
358
  getClientId(): string;
490
- /**
491
- * Returns the detected environment type.
492
- *
493
- *
494
- * @returns The environment type (FLP or STANDALONE).
495
- */
496
- getEnvironmentType(): sap.ui.joule.frontend.EnvironmentType;
497
359
  /**
498
360
  * Checks if the connector is currently connected to Joule.
499
361
  *
@@ -501,20 +363,6 @@ declare namespace sap {
501
363
  * @returns True if connected, false otherwise.
502
364
  */
503
365
  isConnected(): boolean;
504
- /**
505
- * Checks if running in FLP environment.
506
- *
507
- *
508
- * @returns True if in FLP, false otherwise.
509
- */
510
- isFLP(): boolean;
511
- /**
512
- * Checks if running in standalone mode.
513
- *
514
- *
515
- * @returns True if standalone, false otherwise.
516
- */
517
- isStandalone(): boolean;
518
366
  /**
519
367
  * Registers app-specific frontend actions with Joule.
520
368
  *
@@ -556,155 +404,15 @@ declare namespace sap {
556
404
  fnHandler: Function
557
405
  ): sap.ui.joule.frontend.JouleConnector;
558
406
  }
559
- /**
560
- * Connector for standalone (non-FLP) Joule integration.
561
- *
562
- * This class handles direct communication with the Joule webclient API when running outside of SAP Fiori
563
- * Launchpad. It supports both immediate registration (when Joule is already loaded) and pre-registration
564
- * (when Joule loads later).
565
- *
566
- * For a unified API that works in both FLP and standalone environments, use {@link sap.ui.joule.frontend.JouleConnector }
567
- * instead.
568
- *
569
- * @experimental As of version 1.151.
570
- */
571
- class StandaloneConnector extends sap.ui.base.Object {
572
- /**
573
- * Constructor for StandaloneConnector.
574
- */
575
- constructor(
576
- /**
577
- * The unique client ID for registration with Joule.
578
- */
579
- sClientId: string
580
- );
581
-
582
- /**
583
- * Creates a new subclass of class sap.ui.joule.frontend.StandaloneConnector with name `sClassName` and
584
- * enriches it with the information contained in `oClassInfo`.
585
- *
586
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
587
- *
588
- *
589
- * @returns Created class / constructor function
590
- */
591
- static extend<T extends Record<string, unknown>>(
592
- /**
593
- * Name of the class being created
594
- */
595
- sClassName: string,
596
- /**
597
- * Object literal with information about the class
598
- */
599
- oClassInfo?: sap.ClassInfo<
600
- T,
601
- sap.ui.joule.frontend.StandaloneConnector
602
- >,
603
- /**
604
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
605
- * used by this class
606
- */
607
- FNMetaImpl?: Function
608
- ): Function;
609
- /**
610
- * Returns a metadata object for class sap.ui.joule.frontend.StandaloneConnector.
611
- *
612
- *
613
- * @returns Metadata object describing this class
614
- */
615
- static getMetadata(): sap.ui.base.Metadata;
616
- /**
617
- * Disconnects from the Joule webclient and cleans up resources.
618
- *
619
- * @experimental As of version 1.151.
620
- */
621
- disconnect(): void;
622
- /**
623
- * Returns the client ID used by this connector.
624
- *
625
- * @experimental As of version 1.151.
626
- *
627
- * @returns The client ID.
628
- */
629
- getClientId(): string;
630
- /**
631
- * Checks if the connector is currently registered or pre-registered.
632
- *
633
- * @experimental As of version 1.151.
634
- *
635
- * @returns True if registered or pre-registered, false otherwise.
636
- */
637
- isConnected(): boolean;
638
- /**
639
- * Checks if direct registration was used (vs pre-registration).
640
- *
641
- *
642
- * @returns True if directly registered, false if pre-registered.
643
- */
644
- isDirectlyRegistered(): boolean;
645
- /**
646
- * Registers callbacks with the Joule webclient.
647
- *
648
- * If the Joule webclient is already loaded, registration happens immediately. Otherwise, the callbacks
649
- * are stored for pre-registration and will be picked up when the Joule webclient loads.
650
- *
651
- * @experimental As of version 1.151.
652
- */
653
- register(
654
- /**
655
- * An object containing callback functions for Joule frontend actions.
656
- */
657
- oJouleCallbacks: {
658
- /**
659
- * Callback that returns an array of frontend actions.
660
- */
661
- getFrontendActions: Function;
662
- }
663
- ): void;
664
- }
665
- /**
666
- * Environment types for Joule integration.
667
- *
668
- * This enum is part of the 'sap/ui/joule/frontend/library' module export and must be accessed by the property
669
- * 'EnvironmentType'.
670
- *
671
- * @experimental As of version 1.151.
672
- */
673
- enum EnvironmentType {
674
- /**
675
- * Running inside SAP Fiori Launchpad (FLP). Communication with Joule uses the FLP MessageBroker.
676
- */
677
- FLP = "undefined",
678
- /**
679
- * Running as a standalone application. Communication with Joule uses the direct webclient API.
680
- */
681
- STANDALONE = "undefined",
682
- }
683
- /**
684
- * Message names used in Joule FLP MessageBroker communication. These values are protocol-specific and must
685
- * match what Joule expects.
686
- *
687
- * This enum is part of the 'sap/ui/joule/frontend/library' module export and must be accessed by the property
688
- * 'MessageName'.
689
- *
690
- * @experimental As of version 1.151.
691
- */
692
- enum MessageName {}
693
407
  }
694
408
  }
695
409
  }
696
410
 
697
411
  interface IUI5DefineDependencyNames {
698
- "sap/ui/joule/frontend/FLPJouleBridge": undefined;
699
-
700
- "sap/ui/joule/frontend/GenericActions": undefined;
701
-
702
412
  "sap/ui/joule/frontend/JouleConnector": undefined;
703
413
 
704
414
  "sap/ui/joule/frontend/library": undefined;
705
415
 
706
- "sap/ui/joule/frontend/StandaloneConnector": undefined;
707
-
708
416
  "sap/ui/joule/frontend/util/ActionHelpers": undefined;
709
417
  }
710
418
  }
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.152.1
1
+ // For Library Version: 1.154.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -704,8 +704,11 @@ declare namespace sap {
704
704
  * The maximum amount of groups (`{@link sap.ui.layout.form.FormContainer FormContainers}`) per row that
705
705
  * is used before a new row is started.
706
706
  *
707
- * **Note:** If `{@link sap.ui.layout.form.SimpleFormLayout.ResponsiveGridLayout}` is used as `layout`,
708
- * this property is not used. Please use the properties `ColumnsL` and `ColumnsM` in this case.
707
+ * **Note:** If `{@link sap.ui.layout.form.SimpleFormLayout.ResponsiveGridLayout}` or `{@link sap.ui.layout.form.SimpleFormLayout.ColumnLayout}`
708
+ * is used as `layout`, this property is not used. Please use the properties `ColumnsL` and `ColumnsM` in
709
+ * this case.
710
+ *
711
+ * @deprecated As of version 1.93. use another `Layout`
709
712
  */
710
713
  maxContainerCols?:
711
714
  | int
@@ -4667,11 +4670,13 @@ declare namespace sap {
4667
4670
  * The maximum amount of groups (`{@link sap.ui.layout.form.FormContainer FormContainers}`) per row that
4668
4671
  * is used before a new row is started.
4669
4672
  *
4670
- * **Note:** If `{@link sap.ui.layout.form.SimpleFormLayout.ResponsiveGridLayout}` is used as `layout`,
4671
- * this property is not used. Please use the properties `ColumnsL` and `ColumnsM` in this case.
4673
+ * **Note:** If `{@link sap.ui.layout.form.SimpleFormLayout.ResponsiveGridLayout}` or `{@link sap.ui.layout.form.SimpleFormLayout.ColumnLayout}`
4674
+ * is used as `layout`, this property is not used. Please use the properties `ColumnsL` and `ColumnsM` in
4675
+ * this case.
4672
4676
  *
4673
4677
  * Default value is `2`.
4674
4678
  *
4679
+ * @deprecated As of version 1.93. use another `Layout`
4675
4680
  *
4676
4681
  * @returns Value of property `maxContainerCols`
4677
4682
  */
@@ -5267,13 +5272,15 @@ declare namespace sap {
5267
5272
  * The maximum amount of groups (`{@link sap.ui.layout.form.FormContainer FormContainers}`) per row that
5268
5273
  * is used before a new row is started.
5269
5274
  *
5270
- * **Note:** If `{@link sap.ui.layout.form.SimpleFormLayout.ResponsiveGridLayout}` is used as `layout`,
5271
- * this property is not used. Please use the properties `ColumnsL` and `ColumnsM` in this case.
5275
+ * **Note:** If `{@link sap.ui.layout.form.SimpleFormLayout.ResponsiveGridLayout}` or `{@link sap.ui.layout.form.SimpleFormLayout.ColumnLayout}`
5276
+ * is used as `layout`, this property is not used. Please use the properties `ColumnsL` and `ColumnsM` in
5277
+ * this case.
5272
5278
  *
5273
5279
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
5274
5280
  *
5275
5281
  * Default value is `2`.
5276
5282
  *
5283
+ * @deprecated As of version 1.93. use another `Layout`
5277
5284
  *
5278
5285
  * @returns Reference to `this` in order to allow method chaining
5279
5286
  */