@sapui5/ts-types 1.151.0 → 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 (67) hide show
  1. package/package.json +1 -1
  2. package/types/sap.apf.d.ts +1 -1
  3. package/types/sap.ca.ui.d.ts +1 -1
  4. package/types/sap.chart.d.ts +1 -1
  5. package/types/sap.collaboration.d.ts +1 -1
  6. package/types/sap.esh.search.ui.d.ts +18 -1
  7. package/types/sap.f.d.ts +1189 -292
  8. package/types/sap.fe.ariba.d.ts +1 -1
  9. package/types/sap.fe.base.d.ts +1 -1
  10. package/types/sap.fe.controls.d.ts +1 -1
  11. package/types/sap.fe.core.d.ts +61 -9
  12. package/types/sap.fe.ina.d.ts +1 -1
  13. package/types/sap.fe.macros.d.ts +40 -34
  14. package/types/sap.fe.navigation.d.ts +1 -1
  15. package/types/sap.fe.placeholder.d.ts +1 -1
  16. package/types/sap.fe.plugins.managecache.d.ts +1 -1
  17. package/types/sap.fe.templates.d.ts +12 -2
  18. package/types/sap.fe.test.d.ts +1 -1
  19. package/types/sap.fe.tools.d.ts +1 -1
  20. package/types/sap.feedback.ui.d.ts +1 -1
  21. package/types/sap.gantt.d.ts +14 -1
  22. package/types/sap.insights.d.ts +1 -1
  23. package/types/sap.m.d.ts +114 -3
  24. package/types/sap.makit.d.ts +1 -1
  25. package/types/sap.me.d.ts +1 -1
  26. package/types/sap.ndc.d.ts +1 -1
  27. package/types/sap.ovp.d.ts +1 -1
  28. package/types/sap.rules.ui.d.ts +1 -1
  29. package/types/sap.sac.df.d.ts +1 -1
  30. package/types/sap.suite.ui.commons.d.ts +915 -3
  31. package/types/sap.suite.ui.generic.template.d.ts +1 -1
  32. package/types/sap.suite.ui.microchart.d.ts +1 -1
  33. package/types/sap.tnt.d.ts +1 -1
  34. package/types/sap.ui.codeeditor.d.ts +1 -1
  35. package/types/sap.ui.commons.d.ts +1 -1
  36. package/types/sap.ui.comp.d.ts +4 -2
  37. package/types/sap.ui.core.d.ts +175 -12
  38. package/types/sap.ui.dt.d.ts +1 -1
  39. package/types/sap.ui.export.d.ts +7 -1
  40. package/types/sap.ui.fl.d.ts +1 -1
  41. package/types/sap.ui.generic.app.d.ts +1 -1
  42. package/types/sap.ui.generic.template.d.ts +1 -1
  43. package/types/sap.ui.geomap.d.ts +1 -1
  44. package/types/sap.ui.integration.d.ts +101 -325
  45. package/types/sap.ui.joule.frontend.d.ts +1 -1
  46. package/types/sap.ui.layout.d.ts +33 -7
  47. package/types/sap.ui.mdc.d.ts +26 -1
  48. package/types/sap.ui.richtexteditor.d.ts +1 -1
  49. package/types/sap.ui.rta.d.ts +3 -3
  50. package/types/sap.ui.suite.d.ts +1 -1
  51. package/types/sap.ui.support.d.ts +1 -1
  52. package/types/sap.ui.table.d.ts +1 -1
  53. package/types/sap.ui.testrecorder.d.ts +1 -1
  54. package/types/sap.ui.unified.d.ts +60 -1
  55. package/types/sap.ui.ux3.d.ts +1 -1
  56. package/types/sap.ui.vbm.d.ts +1 -1
  57. package/types/sap.ui.vk.d.ts +1 -1
  58. package/types/sap.ui.vtm.d.ts +1 -1
  59. package/types/sap.uiext.inbox.d.ts +1 -1
  60. package/types/sap.ushell.d.ts +63 -46
  61. package/types/sap.ushell_abap.d.ts +1 -1
  62. package/types/sap.uxap.d.ts +1 -1
  63. package/types/sap.viz.d.ts +1 -1
  64. package/types/sap.webanalytics.core.d.ts +1 -1
  65. package/types/sap.zen.commons.d.ts +1 -1
  66. package/types/sap.zen.crosstab.d.ts +1 -1
  67. package/types/sap.zen.dsh.d.ts +1 -1
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.151.0
1
+ // For Library Version: 1.152.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace suite {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.151.0
1
+ // For Library Version: 1.152.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace suite {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.151.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.151.0
1
+ // For Library Version: 1.152.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.151.0
1
+ // For Library Version: 1.152.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.151.0
1
+ // For Library Version: 1.152.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -24438,7 +24438,9 @@ declare namespace sap {
24438
24438
  }
24439
24439
  /**
24440
24440
  * SemanticGroupElement holds the semantically connected fields divided by a delimiter. **Note:** Semantically
24441
- * connected fields don't support the text arrangement async control functionality.
24441
+ * connected fields do not support the full range of text arrangement async control functionality. However,
24442
+ * the TextOnly type (com.sap.vocabularies.UI.v1.TextArrangementType/TextOnly) is supported, which displays
24443
+ * the specified description only.
24442
24444
  *
24443
24445
  * @since 1.88
24444
24446
  */
@@ -279,7 +279,7 @@ declare namespace sap {
279
279
  "sap/ui/thirdparty/qunit-2": undefined;
280
280
  }
281
281
  }
282
- // For Library Version: 1.151.0
282
+ // For Library Version: 1.152.0
283
283
 
284
284
  declare module "sap/base/assert" {
285
285
  /**
@@ -37925,6 +37925,30 @@ declare namespace sap {
37925
37925
  */
37926
37926
  sMimeType: string
37927
37927
  ): string;
37928
+ /**
37929
+ * Returns the HTML string for an icon URI.
37930
+ *
37931
+ * This method reuses the rendering logic from {@link sap.ui.core.RenderManager#icon} by calling it with
37932
+ * a lightweight DOM-building interface that mirrors the RenderManager's semantic API.
37933
+ *
37934
+ * @since 1.152
37935
+ *
37936
+ * @returns The HTML string for the icon, or empty string if the URI is not a valid icon URI
37937
+ */
37938
+ getIconHTML(
37939
+ /**
37940
+ * The icon URI (e.g. "sap-icon://accept")
37941
+ */
37942
+ sURI: sap.ui.core.URI,
37943
+ /**
37944
+ * Additional CSS classes to add to the icon element
37945
+ */
37946
+ aClasses?: string[],
37947
+ /**
37948
+ * Additional HTML attributes as key-value pairs
37949
+ */
37950
+ mAttributes?: object
37951
+ ): string;
37928
37952
  /**
37929
37953
  * Returns an info object for the icon with the given `iconName` and `collectionName`.
37930
37954
  *
@@ -48686,10 +48710,15 @@ declare namespace sap {
48686
48710
  */
48687
48711
  aClasses?: any[] | string,
48688
48712
  /**
48689
- * Additional attributes that will be added to the rendered tag. Currently the attributes `class` and `style`
48690
- * are not allowed
48713
+ * Additional attributes that will be added to the rendered tag. The attributes `class` and `style` are
48714
+ * not allowed. Use the `mStyles` parameter to set inline styles.
48691
48715
  */
48692
- mAttributes?: object
48716
+ mAttributes?: object,
48717
+ /**
48718
+ * A map of CSS property names and their values to be set as inline styles on the rendered tag. Example:
48719
+ * `{width: "16px", height: "16px"}`. This parameter is available since version 1.152.
48720
+ */
48721
+ mStyles?: object
48693
48722
  ): this;
48694
48723
  /**
48695
48724
  * Ends an open tag started with `openStart`.
@@ -65226,6 +65255,110 @@ declare namespace sap {
65226
65255
  */
65227
65256
  sDateTimeOffset: string
65228
65257
  ): Date;
65258
+ /**
65259
+ * Parses a filter string to a syntax tree. In this tree:
65260
+ * Paths are leaves with `id="PATH"` and the path in `value`. Literals are leaves with `id="VALUE"`
65261
+ * and the literal (as parsed) in `value`. Operations are nodes with the operator in `id`, the operator
65262
+ * including the surrounding required space in `value`, and `left` and `right` containing syntax trees for
65263
+ * the operands. `not` only uses `right`. Functions are nodes with `id="FUNCTION"`, the name in `value`,
65264
+ * and an array of `parameters`. If the type is known (especially for logical operators and functions),
65265
+ * it is given in `type`. If a function parameter may have different types (like Edm.Decimal or Edm.Double
65266
+ * in `round`), it has the property `ambiguous: true`. `at` always contains the position where this token
65267
+ * started (starting with 1).
65268
+ *
65269
+ * Example: `parseFilter("foo eq 'bar' and length(baz) ne 5")` results in
65270
+ * ```javascript
65271
+ *
65272
+ * {
65273
+ * id : "and", value : " and ", type : "Edm.Boolean", at : 14,
65274
+ * left : {
65275
+ * id : "eq", value : " eq ", type : "Edm.Boolean", at : 5,
65276
+ * left : {id : "PATH", value : "foo", at : 1},
65277
+ * right : {id : "VALUE", value : "'bar'", at : 8}
65278
+ * },
65279
+ * right : {
65280
+ * id : "ne", value : " ne ", type : "Edm.Boolean", at : 30,
65281
+ * left : {
65282
+ * id : "FUNCTION", value : "length", type : "Edm.Int32", at : 18,
65283
+ * parameters : [{id : "PATH", value : "baz", at : 25}]
65284
+ * },
65285
+ * right : {id : "VALUE", value : "5", at : 33}
65286
+ * }
65287
+ * }
65288
+ * ```
65289
+ *
65290
+ *
65291
+ * @since 1.152.0
65292
+ *
65293
+ * @returns The syntax tree
65294
+ */
65295
+ parseFilter(
65296
+ /**
65297
+ * The filter string
65298
+ */
65299
+ sFilter: string
65300
+ ): object;
65301
+ /**
65302
+ * Parses a system query option "$select" or "$expand" into an object representation.
65303
+ *
65304
+ * The value for "$select" is an array of strings.
65305
+ *
65306
+ * The value for "$expand" is an object with the path as key and the options object as value. Each option
65307
+ * itself becomes a property with the option name as key and the option value as value. If there are no
65308
+ * options, the value for the path is `null`.
65309
+ *
65310
+ * If `bParseFilter` is set, the value for "$filter" is a syntax tree as described in {@link #.parseFilter};
65311
+ * otherwise it is the string passed to it.
65312
+ *
65313
+ * The value for all other options is the string passed to them.
65314
+ *
65315
+ * **Example:**
65316
+ *
65317
+ *
65318
+ * ```javascript
65319
+ *
65320
+ * sOption = "$expand=SO_2_BP,SO_2_SOITEM($expand=SOITEM_2_PRODUCT($expand=PRODUCT_2_BP"
65321
+ * + ";$select=ID,Name);$select=*;$count=true;$orderby=Name desc)"
65322
+ * ```
65323
+ * is converted to
65324
+ * ```javascript
65325
+ *
65326
+ * {
65327
+ * "$expand" : {
65328
+ * "SO_2_BP" : null,
65329
+ * "SO_2_SOITEM" : {
65330
+ * "$count" : "true",
65331
+ * "$expand" : {
65332
+ * "SOITEM_2_PRODUCT" : {
65333
+ * "$expand" : {
65334
+ * "PRODUCT_2_BP" : null
65335
+ * },
65336
+ * "$select" : ["ID", "Name"]
65337
+ * }
65338
+ * },
65339
+ * "$orderby" : "Name desc",
65340
+ * "$select" : ["*"]
65341
+ * }
65342
+ * }
65343
+ * }
65344
+ * ```
65345
+ *
65346
+ *
65347
+ * @since 1.152.0
65348
+ *
65349
+ * @returns The option as an object with the option name as key and the parsed value as value
65350
+ */
65351
+ parseSystemQueryOption(
65352
+ /**
65353
+ * The option string
65354
+ */
65355
+ sOption: string,
65356
+ /**
65357
+ * Whether to parse the value of "$filter" into a syntax tree as described in {@link #.parseFilter}; by
65358
+ * default, the value remains a string
65359
+ */
65360
+ bParseFilter?: boolean
65361
+ ): object;
65229
65362
  /**
65230
65363
  * Parses an "Edm.TimeOfDay" value and returns the corresponding JavaScript `Date` value (UTC with a date
65231
65364
  * value of "1970-01-01").
@@ -65305,6 +65438,8 @@ declare namespace sap {
65305
65438
  static getMetadata(): sap.ui.base.Metadata;
65306
65439
  /**
65307
65440
  * Collapses the group node that this context points to.
65441
+ *
65442
+ * **Note:** It is unsafe to keep a reference to a context instance which is not {@link #isKeepAlive kept alive}.
65308
65443
  * See:
65309
65444
  * #expand
65310
65445
  * #isExpanded
@@ -65368,7 +65503,7 @@ declare namespace sap {
65368
65503
  * Such a deletion is not a pending change.
65369
65504
  *
65370
65505
  * When using data aggregation without `groupLevels`, single entities can be deleted (since 1.151.0, see
65371
- * {@link #isAggregated}). The same restrictions as for a recursive hierarchy apply.
65506
+ * {@link #isAggregated}). The group ID must not have {@link sap.ui.model.odata.v4.SubmitMode.API}.
65372
65507
  * See:
65373
65508
  * #hasPendingChanges
65374
65509
  * #resetChanges
@@ -65499,7 +65634,9 @@ declare namespace sap {
65499
65634
  *
65500
65635
  * @returns The context's index within the binding's collection. It is `undefined` if
65501
65636
  * it does not belong to a list binding, it is {@link #isKeepAlive kept alive}, but not in the collection
65502
- * currently.
65637
+ * currently. When collapsing a node's ancestor in a recursive hierarchy, the index becomes `undefined`.
65638
+ * After expanding, the index is only determined again when that node comes into view, so to say. Use {@link sap.ui.model.odata.v4.ODataListBinding#getAllCurrentContexts }
65639
+ * to try to determine the index again.
65503
65640
  */
65504
65641
  getIndex(): number | undefined;
65505
65642
  /**
@@ -66530,7 +66667,9 @@ declare namespace sap {
66530
66667
  * Since 1.151.0, if the operation returns an "Edm.Stream" and the group ID '$stream' is used, the promise
66531
66668
  * resolves with a partial `Response` object containing only:
66532
66669
  * `body`: The response's `ReadableStream` `headers`: The response's `Headers` The promise
66533
- * rejects if '$stream' is used with a wrong return type.
66670
+ * rejects with an `Error` instance if '$stream' is used with a wrong return type or the fetch request fails.
66671
+ * In the latter case, the error contains the following properties:
66672
+ * `status`: {number} HTTP status code `statusText`: {string} (optional) HTTP status text
66534
66673
  */
66535
66674
  invoke(
66536
66675
  /**
@@ -68254,7 +68393,8 @@ declare namespace sap {
68254
68393
  /**
68255
68394
  * Type-specific format options, since 1.81.0. The boolean format option "parseKeepsEmptyString" applies
68256
68395
  * to {@link sap.ui.model.odata.type.String} only and is ignored for all other types. All other format options
68257
- * are passed "as is".
68396
+ * are passed "as is". Since 1.152.0, "parseKeepsEmptyString" is automatically set based on the model parameter
68397
+ * of the same name unless you provide `parseKeepsEmptyString: false` in `mFormatOptions`.
68258
68398
  */
68259
68399
  mFormatOptions?: object
68260
68400
  ): sap.ui.model.odata.type.ODataType;
@@ -68594,7 +68734,8 @@ declare namespace sap {
68594
68734
  /**
68595
68735
  * Type-specific format options, since 1.81.0. The boolean format option "parseKeepsEmptyString" applies
68596
68736
  * to {@link sap.ui.model.odata.type.String} only and is ignored for all other types. All other format options
68597
- * are passed "as is".
68737
+ * are passed "as is". Since 1.152.0, "parseKeepsEmptyString" is automatically set based on the model parameter
68738
+ * of the same name unless you provide `parseKeepsEmptyString: false` in `mFormatOptions`.
68598
68739
  */
68599
68740
  mFormatOptions?: object
68600
68741
  ): Promise<sap.ui.model.odata.type.ODataType>;
@@ -68830,6 +68971,13 @@ declare namespace sap {
68830
68971
  * is called.
68831
68972
  */
68832
68973
  operationMode?: sap.ui.model.odata.OperationMode;
68974
+ /**
68975
+ * Whether the format option `parseKeepsEmptyString` is set to `true` for all instances of {@link sap.ui.model.odata.type.String }
68976
+ * that are created automatically during type detection; only the value `true` is allowed; see {@link #getParseKeepsEmptyString}.
68977
+ *
68978
+ * @since 1.152.0
68979
+ */
68980
+ parseKeepsEmptyString?: boolean;
68833
68981
  /**
68834
68982
  * Root URL of the service to request data from. The path part of the URL must end with a forward slash
68835
68983
  * according to OData V4 specification ABNF, rule "serviceRoot". You may append OData custom query options
@@ -69629,6 +69777,19 @@ declare namespace sap {
69629
69777
  * @deprecated As of version 1.37.0. calling this method is not supported
69630
69778
  */
69631
69779
  getOriginalProperty(): void;
69780
+ /**
69781
+ * Returns whether the `parseKeepsEmptyString` format option is set to `true` for all instances of {@link sap.ui.model.odata.type.String }
69782
+ * that are created automatically during {@link sap.ui.model.odata.v4.ODataMetaModel#requestUI5Type type detection }
69783
+ * (as defined by the `parseKeepsEmptyString` model parameter, see {@link #constructor}). Use this model
69784
+ * setting if your OData service cannot handle `null` values for string properties.
69785
+ * See:
69786
+ * #constructor
69787
+ *
69788
+ * @since 1.152.0
69789
+ *
69790
+ * @returns Whether the `parseKeepsEmptyString` model parameter is set
69791
+ */
69792
+ getParseKeepsEmptyString(): boolean;
69632
69793
  /**
69633
69794
  * Method not supported
69634
69795
  * See:
@@ -69818,9 +69979,9 @@ declare namespace sap {
69818
69979
  * The handler is called with an `Error` having a property `retryAfter` of type `Date`, which is the earliest
69819
69980
  * point in time when the request should be repeated. The handler has to return a promise. With this promise,
69820
69981
  * you can control the repetition of all pending requests including the failed HTTP request. If the promise
69821
- * is resolved, the requests are repeated; if it is rejected, the requests are not repeated. If it is rejected
69822
- * with the same `Error` reason as previously passed to the handler, then this reason is reported to the
69823
- * message model.
69982
+ * is resolved, the requests are repeated; if it is rejected, the requests are not repeated but fail with
69983
+ * same reason as the promise. If the promise is rejected with the same `Error` reason as previously passed
69984
+ * to the handler, this reason is reported to the message model.
69824
69985
  *
69825
69986
  * @since 1.134.0
69826
69987
  */
@@ -89175,6 +89336,8 @@ declare namespace sap {
89175
89336
 
89176
89337
  "sap/ui/model/xml/XMLTreeBinding": undefined;
89177
89338
 
89339
+ "sap/ui/performance/FetchInterceptor": undefined;
89340
+
89178
89341
  "sap/ui/performance/Measurement": undefined;
89179
89342
 
89180
89343
  "sap/ui/performance/trace/FESR": undefined;
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.151.0
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.151.0
1
+ // For Library Version: 1.152.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1158,6 +1158,12 @@ declare namespace sap {
1158
1158
  * Indicates if wrapping is enabled for this particular column.
1159
1159
  */
1160
1160
  wrap?: boolean;
1161
+ /**
1162
+ * Locks the cells of this column in the produced spreadsheet. Sheet protection is automatically enabled
1163
+ * when at least one column is read-only; all other columns remain editable. The column header receives
1164
+ * a translated read-only suffix so the lock state is visible and announced by screen readers. Since: 1.152.
1165
+ */
1166
+ readOnly?: boolean;
1161
1167
  };
1162
1168
 
1163
1169
  type SpreadsheetSettings = {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.151.0
1
+ // For Library Version: 1.152.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.151.0
1
+ // For Library Version: 1.152.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,3 +1,3 @@
1
- // For Library Version: 1.151.0
1
+ // For Library Version: 1.152.0
2
2
 
3
3
  declare namespace sap {}
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.151.0
1
+ // For Library Version: 1.152.0
2
2
 
3
3
  declare module "sap/ui/geomap/gen/sap_webcomponents/geomap/dist/SapGeomap" {
4
4
  /**