@sapui5/ts-types 1.150.1 → 1.152.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 (68) hide show
  1. package/package.json +1 -1
  2. package/types/index.d.ts +1 -0
  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 +427 -157
  8. package/types/sap.f.d.ts +1189 -292
  9. package/types/sap.fe.ariba.d.ts +1 -1
  10. package/types/sap.fe.base.d.ts +2 -222
  11. package/types/sap.fe.controls.d.ts +1 -1
  12. package/types/sap.fe.core.d.ts +61 -9
  13. package/types/sap.fe.ina.d.ts +1 -1
  14. package/types/sap.fe.macros.d.ts +220 -85
  15. package/types/sap.fe.navigation.d.ts +3 -2
  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 +12 -2
  19. package/types/sap.fe.test.d.ts +3 -3
  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 +138 -1
  23. package/types/sap.insights.d.ts +1 -1
  24. package/types/sap.m.d.ts +246 -3
  25. package/types/sap.makit.d.ts +1 -1
  26. package/types/sap.me.d.ts +1 -1
  27. package/types/sap.ndc.d.ts +1 -1
  28. package/types/sap.ovp.d.ts +1 -1
  29. package/types/sap.rules.ui.d.ts +1 -1
  30. package/types/sap.sac.df.d.ts +1 -1
  31. package/types/sap.suite.ui.commons.d.ts +957 -1
  32. package/types/sap.suite.ui.generic.template.d.ts +1 -1
  33. package/types/sap.suite.ui.microchart.d.ts +1 -1
  34. package/types/sap.tnt.d.ts +178 -1
  35. package/types/sap.ui.codeeditor.d.ts +1 -1
  36. package/types/sap.ui.commons.d.ts +1 -1
  37. package/types/sap.ui.comp.d.ts +4 -2
  38. package/types/sap.ui.core.d.ts +561 -245
  39. package/types/sap.ui.dt.d.ts +1 -1
  40. package/types/sap.ui.export.d.ts +7 -1
  41. package/types/sap.ui.fl.d.ts +1 -1
  42. package/types/sap.ui.generic.app.d.ts +1 -1
  43. package/types/sap.ui.generic.template.d.ts +1 -1
  44. package/types/sap.ui.geomap.d.ts +10393 -8758
  45. package/types/sap.ui.integration.d.ts +130 -326
  46. package/types/sap.ui.joule.frontend.d.ts +710 -0
  47. package/types/sap.ui.layout.d.ts +33 -7
  48. package/types/sap.ui.mdc.d.ts +36 -8
  49. package/types/sap.ui.richtexteditor.d.ts +1 -1
  50. package/types/sap.ui.rta.d.ts +4 -4
  51. package/types/sap.ui.suite.d.ts +1 -1
  52. package/types/sap.ui.support.d.ts +1 -1
  53. package/types/sap.ui.table.d.ts +2 -2
  54. package/types/sap.ui.testrecorder.d.ts +1 -1
  55. package/types/sap.ui.unified.d.ts +160 -1
  56. package/types/sap.ui.ux3.d.ts +1 -1
  57. package/types/sap.ui.vbm.d.ts +1 -1
  58. package/types/sap.ui.vk.d.ts +1 -1
  59. package/types/sap.ui.vtm.d.ts +1 -1
  60. package/types/sap.uiext.inbox.d.ts +1 -1
  61. package/types/sap.ushell.d.ts +84 -47
  62. package/types/sap.ushell_abap.d.ts +1 -1
  63. package/types/sap.uxap.d.ts +1 -1
  64. package/types/sap.viz.d.ts +1 -1
  65. package/types/sap.webanalytics.core.d.ts +1 -1
  66. package/types/sap.zen.commons.d.ts +1 -1
  67. package/types/sap.zen.crosstab.d.ts +1 -1
  68. package/types/sap.zen.dsh.d.ts +1 -1
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.150.1
1
+ // For Library Version: 1.152.0
2
2
 
3
3
  declare namespace sap {
4
4
  /**
@@ -893,8 +893,8 @@ declare namespace sap {
893
893
  };
894
894
 
895
895
  /**
896
- * A target describing the intent: #-~?&/
897
- * **Note:** The intent shall not exceed 512 bytes when serialized as UTF-8.
896
+ * A target describing the intent: #-?&/ **Note:** The
897
+ * intent shall not exceed 512 bytes when serialized as UTF-8.
898
898
  */
899
899
  type Target = {
900
900
  /**
@@ -910,10 +910,6 @@ declare namespace sap {
910
910
  * The action part of the intent.
911
911
  */
912
912
  action?: string;
913
- /**
914
- * The contextRaw part of the intent without the '~' prefix.
915
- */
916
- contextRaw?: string;
917
913
  /**
918
914
  * The entire intent including parameters and appSpecificRoute.
919
915
  * **Note:** If set all other parameters are ignored.
@@ -2779,10 +2775,6 @@ declare namespace sap {
2779
2775
  * the action
2780
2776
  */
2781
2777
  action: string;
2782
- /**
2783
- * the raw context string
2784
- */
2785
- contextRaw: string;
2786
2778
  /**
2787
2779
  * the parameters
2788
2780
  */
@@ -2849,10 +2841,6 @@ declare namespace sap {
2849
2841
  * the action
2850
2842
  */
2851
2843
  action: string;
2852
- /**
2853
- * the raw context string
2854
- */
2855
- contextRaw: string;
2856
2844
  };
2857
2845
  /**
2858
2846
  * the parameters
@@ -5040,6 +5028,24 @@ declare namespace sap {
5040
5028
  * @returns The ToolArea.
5041
5029
  */
5042
5030
  getToolArea(): Promise<sap.ushell.services.FrameBoundExtension.ToolArea>;
5031
+ /**
5032
+ * Sets the image src for all avatar related spots. The image will not be scoped to the current application,
5033
+ * but will be applied through the rest of the user session.
5034
+ *
5035
+ * There is no validation on the user image. Ensure before calling this API that you set a valid image.
5036
+ *
5037
+ * If called with undefined the ushell defaults will be applied.
5038
+ *
5039
+ * @since 1.151.0
5040
+ *
5041
+ * @returns A promise that resolves when the image was set.
5042
+ */
5043
+ setAvatarImage(
5044
+ /**
5045
+ * The image src as URI or base64.
5046
+ */
5047
+ sImageSrc?: string
5048
+ ): Promise<any>;
5043
5049
  }
5044
5050
  /**
5045
5051
  * A service for handling groups, tiles and catalogs.
@@ -6477,7 +6483,7 @@ declare namespace sap {
6477
6483
  * @deprecated As of version 1.119. Please use {@link sap.ushell.services.NotificationsV2#executeBulkAction }
6478
6484
  * instead.
6479
6485
  *
6480
- * @returns Promise object that on success resolves to undefined or it is rejected with failed notifications
6486
+ * @returns Resolves to undefined on success or is rejected with failed notifications
6481
6487
  */
6482
6488
  executeBulkAction(
6483
6489
  /**
@@ -6488,7 +6494,7 @@ declare namespace sap {
6488
6494
  * The ID of the action that is being executed
6489
6495
  */
6490
6496
  sActionId: string
6491
- ): Promise<any>;
6497
+ ): jQuery.Promise;
6492
6498
  /**
6493
6499
  * Returns the notifications of the user sorted by type include the group headers and the notifications
6494
6500
  *
@@ -7328,7 +7334,7 @@ declare namespace sap {
7328
7334
  *
7329
7335
  * Do not mix the usage of a personalizer and a personalization container for one containerKey.
7330
7336
  *
7331
- * Fetching multiple Personalizer for the same container, but different items is not supported. Use {@link sap.ushell.services.Personalizer#getContainer }
7337
+ * Fetching multiple Personalizer for the same container, but different items is not supported. Use {@link sap.ushell.services.PersonalizationV2#getContainer }
7332
7338
  * instead for this scenario.
7333
7339
  *
7334
7340
  * @since 1.120.0
@@ -7374,6 +7380,44 @@ declare namespace sap {
7374
7380
  */
7375
7381
  protected constructor();
7376
7382
  }
7383
+ /**
7384
+ * The Unified Shell's session handler service. Manages the timeout of an FLP session:
7385
+ * - Announces user activity to the platform (via the UShell container service).
7386
+ * - Maintains user activity data in local storage to support multi-browser-tab use cases.
7387
+ * - Notifies the user once the session is about to end, offering the option to extend the session.
7388
+ *
7389
+ * **Note:** To retrieve a valid instance of this service, it is necessary to call {@link sap.ushell.Container#getServiceAsync}.
7390
+ *
7391
+ * ```javascript
7392
+ *
7393
+ * sap.ui.require(["sap/ushell/Container"], async function (Container) {
7394
+ * const SessionHandler = await Container.getServiceAsync("SessionHandler");
7395
+ * // do something with the SessionHandler service
7396
+ * });
7397
+ * ```
7398
+ *
7399
+ *
7400
+ * This service should be available in any FLP context (native, iframe, ...).
7401
+ *
7402
+ * @since 1.151.0
7403
+ */
7404
+ class SessionHandler extends sap.ushell.services.Service {
7405
+ /**
7406
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
7407
+ */
7408
+ protected constructor();
7409
+
7410
+ /**
7411
+ * Notifies the FLP that the user is currently active, so the FLP treats the session as active and defers
7412
+ * idle warnings / automatic sign-out.
7413
+ *
7414
+ * Intended for apps whose user activity the FLP cannot observe directly (e.g. content embedded in an iframe).
7415
+ * The app decides when the user is active and calls this to signal it.
7416
+ *
7417
+ * @since 1.151.0
7418
+ */
7419
+ notifyUserActivity(): void;
7420
+ }
7377
7421
  /**
7378
7422
  * The Unified Shell's internal navigation service (platform independent).
7379
7423
  *
@@ -7462,7 +7506,7 @@ declare namespace sap {
7462
7506
  * whether an transient appstate is sufficient
7463
7507
  */
7464
7508
  bTransient?: boolean
7465
- ): Promise<any>;
7509
+ ): jQuery.Promise;
7466
7510
  /**
7467
7511
  * Returns the current navigation context.
7468
7512
  *
@@ -7829,7 +7873,7 @@ declare namespace sap {
7829
7873
  *
7830
7874
  * @since 1.16.0
7831
7875
  *
7832
- * @returns the hash part of an URL, e.g. `"Object-name~AFE2==?PV1=PV2&PV4=V5&/display/detail/7?UU=HH` Returns
7876
+ * @returns the hash part of an URL, e.g. `"Object-name?PV1=PV2&PV4=V5&/display/detail/7?UU=HH` Returns
7833
7877
  * an empty string in case no shell hash was provided.
7834
7878
  */
7835
7879
  constructShellHash(
@@ -7860,8 +7904,8 @@ declare namespace sap {
7860
7904
  * should be treated as opaque) The URL has to comply with the Fiori-Wave 2 agreed upon format This
7861
7905
  * service shall be used to extract a hash part from an url. The result can be further broken up by parseShellHash
7862
7906
  *
7863
- * Examples http://a.b.c?defhij#SemanticObject-Action~Context?PV1=A&PV2=B&/appspecific
7864
- * returns : "#SemanticObject-Action~Context?PV1=A&PV2=B&/appspecific"
7907
+ * Examples http://a.b.c?defhij#SemanticObject-Action?PV1=A&PV2=B&/appspecific
7908
+ * returns : "#SemanticObject-Action?PV1=A&PV2=B&/appspecific"
7865
7909
  *
7866
7910
  * Note: the results when passing an illegal (non-compliant) url are undefined and subject to change w.o.
7867
7911
  * notice. Notably further checks may added. The design is deliberately restrictive and non-robust.
@@ -7873,7 +7917,7 @@ declare namespace sap {
7873
7917
  getShellHash(
7874
7918
  /**
7875
7919
  * a valid (Shell) url, e.g.
7876
- * `http://xx.b.c#Object-name~AFE2==?PV1=PV2&PV4=V5&/display/detail/7?UU=HH`
7920
+ * `http://xx.b.c#Object-name?PV1=PV2&PV4=V5&/display/detail/7?UU=HH`
7877
7921
  */
7878
7922
  sShellHashString: sap.ui.core.URI
7879
7923
  ): sap.ushell.services.Navigation.TargetIntent;
@@ -7959,9 +8003,8 @@ declare namespace sap {
7959
8003
  */
7960
8004
  parseShellHash(
7961
8005
  /**
7962
- * Hash part of a shell compliant URL `#SO-Action~Context?P1=a&P2=x&/route?RPV=1` the hash part of an URL,
7963
- *
7964
- * e.g. `"#Object-name~AFE2==?PV1=PV2&PV4=V5&/display/detail/7?UU=HH`
8006
+ * Hash part of a shell compliant URL `#SO-Action?P1=a&P2=x&/route?RPV=1` the hash part of an URL,
8007
+ * e.g. `"#Object-name?PV1=PV2&PV4=V5&/display/detail/7?UU=HH`
7965
8008
  */
7966
8009
  sHash: sap.ushell.services.Navigation.TargetIntent
7967
8010
  ): sap.ushell.services.URLParsing.DecomposedHash;
@@ -7976,7 +8019,7 @@ declare namespace sap {
7976
8019
  * ```javascript
7977
8020
  *
7978
8021
  * {
7979
- * shellPart : "Object-name~AFE2==?PV1=PV2&PV4=V5",
8022
+ * shellPart : "Object-name?PV1=PV2&PV4=V5",
7980
8023
  * appSpecificRoute : "display/detail/7?UU=HH"
7981
8024
  * }
7982
8025
  * ```
@@ -7984,8 +8027,8 @@ declare namespace sap {
7984
8027
  */
7985
8028
  splitHash(
7986
8029
  /**
7987
- * The hash part of a shell conformant URL. It has to have the following format: #SO-Action~Context?P1=a&P2=x&/route?RPV=1
7988
- * Here is an example for the hash part of an URL: "#Object-name~AFE2==?PV1=PV2&PV4=V5&/display/detail/7?UU=HH
8030
+ * The hash part of a shell conformant URL. It has to have the following format: #SO-Action?P1=a&P2=x&/route?RPV=1
8031
+ * Here is an example for the hash part of an URL: "#Object-name?PV1=PV2&PV4=V5&/display/detail/7?UU=HH
7989
8032
  */
7990
8033
  sHash: sap.ushell.services.Navigation.TargetIntent
7991
8034
  ): sap.ushell.services.URLParsing.SplitHash;
@@ -8177,7 +8220,7 @@ declare namespace sap {
8177
8220
  */
8178
8221
  type HashComparison = {
8179
8222
  /**
8180
- * The intent is the semantic object, action and contextRaw of the hash
8223
+ * The intent is the semantic object and action of the hash
8181
8224
  *
8182
8225
  * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
8183
8226
  */
@@ -8307,8 +8350,7 @@ declare namespace sap {
8307
8350
  * {
8308
8351
  * target: {
8309
8352
  * semanticObject: string,
8310
- * action: string,
8311
- * contextRaw: string
8353
+ * action: string
8312
8354
  * },
8313
8355
  * params: MapObject,
8314
8356
  * appStateKey: string
@@ -8321,7 +8363,7 @@ declare namespace sap {
8321
8363
  * @since 1.94.0
8322
8364
  * @ui5-protected Do not call from applications (only from related classes in the framework)
8323
8365
  *
8324
- * @returns the hash part of an URL, e.g. `"Object-name~AFE2==?PV1=PV2&PV4=V5&/display/detail/7?UU=HH` returns
8366
+ * @returns the hash part of an URL, e.g. `"Object-name?PV1=PV2&PV4=V5&/display/detail/7?UU=HH` returns
8325
8367
  * "" for an `undefined` object
8326
8368
  */
8327
8369
  constructShellHash(
@@ -8356,8 +8398,8 @@ declare namespace sap {
8356
8398
  * should be treated as opaque) The URL has to comply with the Fiori-Wave 2 agreed upon format This
8357
8399
  * service shall be used to extract a hash part from an url. The result can be further broken up by parseShellHash
8358
8400
  *
8359
- * Examples http://a.b.c?defhij#SemanticObject-Action~Context?PV1=A&PV2=B&/appspecific
8360
- * returns : "#SemanticObject-Action~Context?PV1=A&PV2=B&/appspecific"
8401
+ * Examples http://a.b.c?defhij#SemanticObject-Action?PV1=A&PV2=B&/appspecific
8402
+ * returns : "#SemanticObject-Action?PV1=A&PV2=B&/appspecific"
8361
8403
  *
8362
8404
  * Note: the results when passing an illegal (non-compliant) url are undefined and subject to change w.o.
8363
8405
  * notice. Notably further checks may added. The design is deliberately restrictive and non-robust.
@@ -8370,7 +8412,7 @@ declare namespace sap {
8370
8412
  getShellHash(
8371
8413
  /**
8372
8414
  * a valid (Shell) url, e.g.
8373
- * `http://xx.b.c#Object-name~AFE2==?PV1=PV2&PV4=V5&/display/detail/7?UU=HH`
8415
+ * `http://xx.b.c#Object-name?PV1=PV2&PV4=V5&/display/detail/7?UU=HH`
8374
8416
  */
8375
8417
  sShellHashString: string
8376
8418
  ): object;
@@ -8460,8 +8502,6 @@ declare namespace sap {
8460
8502
  *
8461
8503
  * action : string,
8462
8504
  *
8463
- * contextRaw : string,
8464
- *
8465
8505
  * params : MapObject,
8466
8506
  *
8467
8507
  * appSpecificRoute : string
@@ -8472,9 +8512,8 @@ declare namespace sap {
8472
8512
  */
8473
8513
  parseShellHash(
8474
8514
  /**
8475
- * Hash part of a shell compliant URL `#SO-Action~Context?P1=a&P2=x&/route?RPV=1` the hash part of an URL,
8476
- *
8477
- * e.g. `"#Object-name~AFE2==?PV1=PV2&PV4=V5&/display/detail/7?UU=HH`
8515
+ * Hash part of a shell compliant URL `#SO-Action?P1=a&P2=x&/route?RPV=1` the hash part of an URL,
8516
+ * e.g. `"#Object-name?PV1=PV2&PV4=V5&/display/detail/7?UU=HH`
8478
8517
  */
8479
8518
  sHash: string,
8480
8519
  /**
@@ -14715,12 +14754,6 @@ declare namespace sap {
14715
14754
 
14716
14755
  "sap/ushell/modules/Notifications/NotificationsProvider": undefined;
14717
14756
 
14718
- "sap/ushell/modules/ProductSwitch": undefined;
14719
-
14720
- "sap/ushell/modules/ProductSwitch/ProductSwitchAPI": undefined;
14721
-
14722
- "sap/ushell/modules/ProductSwitch/ProductSwitchProvider": undefined;
14723
-
14724
14757
  "sap/ushell/modules/Search": undefined;
14725
14758
 
14726
14759
  "sap/ushell/modules/Search/SearchAPI": undefined;
@@ -14837,6 +14870,8 @@ declare namespace sap {
14837
14870
 
14838
14871
  "sap/ushell/services/SearchableContent": undefined;
14839
14872
 
14873
+ "sap/ushell/services/SessionHandler": undefined;
14874
+
14840
14875
  "sap/ushell/services/ShellNavigation": undefined;
14841
14876
 
14842
14877
  "sap/ushell/services/ShellNavigationInternal": undefined;
@@ -14889,6 +14924,8 @@ declare namespace sap {
14889
14924
 
14890
14925
  "sap/ushell/ui5service/UserStatus": undefined;
14891
14926
 
14927
+ "sap/ushell/utils/LogError": undefined;
14928
+
14892
14929
  "sap/ushell/utils/UriParameters": undefined;
14893
14930
  }
14894
14931
  }
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.150.1
1
+ // For Library Version: 1.152.0
2
2
 
3
3
  declare namespace sap {
4
4
  interface IUI5DefineDependencyNames {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.150.0
1
+ // For Library Version: 1.152.0
2
2
 
3
3
  declare namespace sap {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.150.0
1
+ // For Library Version: 1.152.0
2
2
 
3
3
  declare namespace sap {
4
4
  /**
@@ -1,3 +1,3 @@
1
- // For Library Version: 1.150.0
1
+ // For Library Version: 1.152.0
2
2
 
3
3
  declare namespace sap {}
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.150.0
1
+ // For Library Version: 1.152.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace zen {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.150.0
1
+ // For Library Version: 1.152.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace zen {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.150.0
1
+ // For Library Version: 1.152.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace zen {