@openui5/ts-types-esm 1.108.2 → 1.110.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.108.2
1
+ // For Library Version: 1.110.0
2
2
 
3
3
  declare module "sap/ui/support/library" {
4
4
  /**
@@ -94,6 +94,31 @@ declare module "sap/ui/support/library" {
94
94
  */
95
95
  String = "String",
96
96
  }
97
+ /**
98
+ * Support Assistant rule configuration
99
+ */
100
+ export type RuleConfiguration = {
101
+ id: string;
102
+
103
+ async: boolean;
104
+
105
+ title: string;
106
+
107
+ resolution: string;
108
+
109
+ minversion: string;
110
+
111
+ categories: Array<Categories | keyof typeof Categories>;
112
+
113
+ audiences: Array<Audiences | keyof typeof Audiences>;
114
+
115
+ description: string;
116
+
117
+ resolutionurls: string;
118
+
119
+ check: string;
120
+ };
121
+
97
122
  /**
98
123
  * @SINCE 1.50
99
124
  *
@@ -162,10 +187,90 @@ declare module "sap/ui/support/supportRules/History" {
162
187
  };
163
188
  }
164
189
 
190
+ declare module "sap/ui/support/supportRules/ExecutionScope" {
191
+ /**
192
+ * @SINCE 1.48
193
+ *
194
+ * Allows to select the scope of analysis on an application.
195
+ *
196
+ * Overview:
197
+ *
198
+ * The ExecutionScope provides access to internal UI5 objects available for inspection. The `getElements`
199
+ * API method allows the user to select a specific subset of elements valid for their case. It accepts one
200
+ * query object argument.
201
+ *
202
+ * Usage: The ExecutionScope is passed as third argument to all rule check functions.
203
+ *
204
+ * When you analyze your application, available objects are collected depending on the settings passed to
205
+ * the Support Assistant at the moment when you start it.
206
+ */
207
+ export default class ExecutionScope {
208
+ constructor();
209
+
210
+ /**
211
+ *
212
+ * @returns Array of matched elements
213
+ */
214
+ getElements(
215
+ /**
216
+ * Object with specific filtering options
217
+ */
218
+ oConfig: {
219
+ /**
220
+ * Type name to filter by type
221
+ */
222
+ type: string;
223
+ /**
224
+ * Option to exclude elements that are not public aggregations
225
+ */
226
+ public: boolean;
227
+ /**
228
+ * Option to exclude elements that are clones of list bindings
229
+ */
230
+ cloned: boolean;
231
+ }
232
+ ): any[];
233
+ /**
234
+ * Gets elements by their type
235
+ *
236
+ * @returns Array of matched elements
237
+ */
238
+ getElementsByClassName(
239
+ /**
240
+ * Either string or function to be used when selecting a subset of elements
241
+ */
242
+ classNameSelector: string | Function
243
+ ): any[];
244
+ /**
245
+ * Gets the logged objects by object type
246
+ *
247
+ * @returns Array of logged objects
248
+ */
249
+ getLoggedObjects(
250
+ /**
251
+ * Type of logged objects
252
+ */
253
+ type: any
254
+ ): any[];
255
+ /**
256
+ * Returns all public elements, i.e. elements that are part of public API aggregations
257
+ *
258
+ * @returns Array of matched elements
259
+ */
260
+ getPublicElements(): any[];
261
+ /**
262
+ * Gets the type of the execution scope
263
+ *
264
+ * @returns The type of the execution scope. Possible values are `global`, `subtree` or `components`.
265
+ */
266
+ getType(): string;
267
+ }
268
+ }
269
+
165
270
  declare module "sap/ui/support/RuleAnalyzer" {
166
- import { AnalysisResult } from "sap/ui/support/supportRules/History";
271
+ import { RuleConfiguration, HistoryFormats } from "sap/ui/support/library";
167
272
 
168
- import { HistoryFormats } from "sap/ui/support/library";
273
+ import { AnalysisResult } from "sap/ui/support/supportRules/History";
169
274
 
170
275
  /**
171
276
  * The `sap.ui.support.RuleAnalyzer` namespace is the central entry point for the Support Assistant functionality.
@@ -196,7 +301,7 @@ declare module "sap/ui/support/RuleAnalyzer" {
196
301
  * Settings for the new rule. For detailed information about its properties see {@link topic:eaeea19a991d46f29e6d8d8827317d0e
197
302
  * Rule Property Values}
198
303
  */
199
- oRule: object
304
+ oRule: RuleConfiguration
200
305
  ): string;
201
306
  /**
202
307
  * Main method to perform analysis of a given running application.
@@ -277,173 +382,72 @@ declare namespace sap {
277
382
  * to check all aspects of an application.
278
383
  */
279
384
  namespace support {
280
- export const CoreFacade: undefined;
281
-
282
385
  /**
283
- * Creates a RuleSet. The RuleSet can store multiple rules concerning namespaces. Usage: The RuleSet is
284
- * an interface used to create, update and delete rulesets.
386
+ * The CoreFacade interface allows rule developers to access the metadata, models, UI areas and components
387
+ * of the Core.
388
+ *
389
+ * Usage: The CoreFacade is passed as second argument to all rule check functions.
285
390
  */
286
- namespace RuleSet {
287
- /**
288
- * Adds rules to RuleSet.
289
- *
290
- * @returns sRuleVerificationStatus Verification status
291
- */
292
- function addRule(
293
- /**
294
- * Settings object with rule information
295
- */
296
- oSettings: object
297
- ): string;
298
- /**
299
- * Clears all rulesets inside the RuleSet.
300
- */
301
- function clearAllRuleSets(): void;
302
- /**
303
- * Gets all rules from the RuleSet.
304
- *
305
- * @returns All rules within the current RuleSet
306
- */
307
- function getRules(): object;
391
+ class CoreFacade {
392
+ constructor();
393
+
308
394
  /**
309
- * Loads the previous selection of the user - which rules are selected to be run by the Rule Analyzer. The
310
- * method applies the settings to the currently loaded rules.
395
+ * Gets the Components from the Core object.
311
396
  */
312
- function loadSelectionOfRules(
313
- /**
314
- * The current loaded libraries and their rules
315
- */
316
- aLibraries: Object[]
317
- ): void;
397
+ getComponents(): void;
318
398
  /**
319
- * Remove rule from RuleSet.
399
+ * Gets the Metadata from the Core object.
320
400
  */
321
- function removeRule(
322
- /**
323
- * Rule object that will be removed
324
- */
325
- oRule: object
326
- ): void;
401
+ getMetadata(): void;
327
402
  /**
328
- * Stores which rules are selected to be run by the analyzer on the next check
403
+ * Gets the Models from the Core object.
329
404
  */
330
- function storeSelectionOfRules(
331
- /**
332
- * The data for the libraries and their rules
333
- */
334
- aLibraries: Object[]
335
- ): void;
405
+ getModels(): void;
336
406
  /**
337
- * Updates rules from the RuleSet.
338
- *
339
- * @returns sRuleVerification Rule Verification status
407
+ * Gets the UI areas from the Core object.
340
408
  */
341
- function updateRule(
342
- /**
343
- * Rule ID
344
- */
345
- sRuleId: string,
346
- /**
347
- * Rule settings
348
- */
349
- ORuleSettings: object
350
- ): string;
409
+ getUIAreas(): void;
351
410
  }
352
-
353
411
  /**
354
- * @SINCE 1.48
355
- *
356
- * Allows to select the scope of analysis on an application.
357
- *
358
- * Overview:
359
- *
360
- * `ExecutionScope` is the third parameter of a rule check function. It provides access to internal UI5
361
- * objects available for inspection. The `getElements` API method allows the user to select a specific subset
362
- * of elements valid for their case. It accepts one query object argument.
363
- *
364
- * Usage:
412
+ * The IssueManagerFacade allows rule developers to add new issues.
365
413
  *
366
- * When a rule is executed, three parameters are passed: `oIssueManager`, `oCoreFacade` and `oScope`.
367
- *
368
- * An `ExecutionScope` instance is passed to every call of a rule check function. When you analyze your
369
- * application, available objects are collected depending on the settings passed to the Support Assistant
370
- * at the moment when you start it.
414
+ * Usage: The IssueManagerFacade is passed as first argument to all rule check functions.
371
415
  */
372
- class ExecutionScope {
416
+ class IssueManagerFacade {
373
417
  constructor();
374
418
 
375
419
  /**
376
- *
377
- * @returns Array of matched elements
420
+ * Adds issue
378
421
  */
379
- static getElements(
422
+ addIssue(
380
423
  /**
381
- * Object with specific filtering options
424
+ * Issue object to be added
382
425
  */
383
- oConfig: {
384
- /**
385
- * Type name to filter by type
386
- */
387
- type: string;
388
- /**
389
- * Option to exclude elements that are not public aggregations
390
- */
391
- public: boolean;
392
- /**
393
- * Option to exclude elements that are clones of list bindings
394
- */
395
- cloned: boolean;
426
+ oIssue: {
427
+ severity: import("sap/ui/support/library").Severity;
428
+
429
+ details: string;
430
+
431
+ context: {
432
+ id: string;
433
+ };
396
434
  }
397
- ): any[];
398
- /**
399
- * Gets elements by their type
400
- *
401
- * @returns Array of matched elements
402
- */
403
- static getElementsByClassName(
404
- /**
405
- * Either string or function to be used when selecting a subset of elements
406
- */
407
- classNameSelector: string | Function
408
- ): any[];
409
- /**
410
- * Gets the logged objects by object type
411
- *
412
- * @returns Array of logged objects
413
- */
414
- static getLoggedObjects(
415
- /**
416
- * Type of logged objects
417
- */
418
- type: any
419
- ): any[];
420
- /**
421
- * Returns all public elements, i.e. elements that are part of public API aggregations
422
- *
423
- * @returns Array of matched elements
424
- */
425
- static getPublicElements(): any[];
426
- /**
427
- * Gets the type of the execution scope
428
- *
429
- * @returns The type of the execution scope. Possible values are `global`, `subtree` or `components`.
430
- */
431
- static getType(): string;
435
+ ): void;
432
436
  }
433
437
  }
434
438
  }
435
439
 
436
440
  interface IUI5DefineDependencyNames {
437
- "sap/ui/support/jQuery.sap.support": undefined;
438
-
439
441
  "sap/ui/support/library": undefined;
440
442
 
441
443
  "sap/ui/support/RuleAnalyzer": undefined;
442
444
 
445
+ "sap/ui/support/supportRules/CoreFacade": undefined;
446
+
443
447
  "sap/ui/support/supportRules/ExecutionScope": undefined;
444
448
 
445
449
  "sap/ui/support/supportRules/History": undefined;
446
450
 
447
- "sap/ui/support/supportRules/RuleSet": undefined;
451
+ "sap/ui/support/supportRules/IssueManager": undefined;
448
452
  }
449
453
  }
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.2
1
+ // For Library Version: 1.110.0
2
2
 
3
3
  declare module "sap/ui/table/library" {
4
4
  import TreeAutoExpandMode1 from "sap/ui/model/TreeAutoExpandMode";
@@ -191,8 +191,6 @@ declare module "sap/ui/table/AnalyticalColumn" {
191
191
  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
192
192
 
193
193
  /**
194
- * @EXPERIMENTAL (since 1.21)
195
- *
196
194
  * This column adds additional properties to the table column which are needed for the analytical binding
197
195
  * and table
198
196
  */
@@ -534,7 +532,7 @@ declare module "sap/ui/table/AnalyticalTable" {
534
532
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
535
533
  * of the syntax of the settings object.
536
534
  * See:
537
- * http://scn.sap.com/docs/DOC-44986
535
+ * https://github.com/SAP/odata-vocabularies/blob/main/docs/v2-annotations.md
538
536
  * {@link topic:08197fa68e4f479cbe30f639cc1cd22c sap.ui.table}
539
537
  * {@link fiori:/analytical-table-alv/ Analytical Table}
540
538
  */
@@ -551,7 +549,7 @@ declare module "sap/ui/table/AnalyticalTable" {
551
549
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
552
550
  * of the syntax of the settings object.
553
551
  * See:
554
- * http://scn.sap.com/docs/DOC-44986
552
+ * https://github.com/SAP/odata-vocabularies/blob/main/docs/v2-annotations.md
555
553
  * {@link topic:08197fa68e4f479cbe30f639cc1cd22c sap.ui.table}
556
554
  * {@link fiori:/analytical-table-alv/ Analytical Table}
557
555
  */
@@ -1244,7 +1242,12 @@ declare module "sap/ui/table/Column" {
1244
1242
 
1245
1243
  import Menu from "sap/ui/unified/Menu";
1246
1244
 
1247
- import { HorizontalAlign, CSSSize } from "sap/ui/core/library";
1245
+ import {
1246
+ HorizontalAlign,
1247
+ ID,
1248
+ CSSSize,
1249
+ IColumnHeaderMenu,
1250
+ } from "sap/ui/core/library";
1248
1251
 
1249
1252
  import ElementMetadata from "sap/ui/core/ElementMetadata";
1250
1253
 
@@ -1586,6 +1589,13 @@ declare module "sap/ui/table/Column" {
1586
1589
  * @returns Value of property `hAlign`
1587
1590
  */
1588
1591
  getHAlign(): HorizontalAlign | keyof typeof HorizontalAlign;
1592
+ /**
1593
+ * @SINCE 1.104
1594
+ *
1595
+ * ID of the element which is the current target of the association {@link #getHeaderMenu headerMenu}, or
1596
+ * `null`.
1597
+ */
1598
+ getHeaderMenu(): ID;
1589
1599
  /**
1590
1600
  * Gets current value of property {@link #getHeaderSpan headerSpan}.
1591
1601
  *
@@ -2024,6 +2034,20 @@ declare module "sap/ui/table/Column" {
2024
2034
  */
2025
2035
  sHAlign?: HorizontalAlign | keyof typeof HorizontalAlign
2026
2036
  ): this;
2037
+ /**
2038
+ * @SINCE 1.104
2039
+ *
2040
+ * Sets the associated {@link #getHeaderMenu headerMenu}.
2041
+ *
2042
+ * @returns Reference to `this` in order to allow method chaining
2043
+ */
2044
+ setHeaderMenu(
2045
+ /**
2046
+ * ID of an element which becomes the new target of this headerMenu association; alternatively, an element
2047
+ * instance may be given
2048
+ */
2049
+ oHeaderMenu: ID | IColumnHeaderMenu
2050
+ ): this;
2027
2051
  /**
2028
2052
  * Sets a new value for property {@link #getHeaderSpan headerSpan}.
2029
2053
  *
@@ -2519,6 +2543,13 @@ declare module "sap/ui/table/Column" {
2519
2543
  */
2520
2544
  menu?: Menu;
2521
2545
 
2546
+ /**
2547
+ * @SINCE 1.104
2548
+ *
2549
+ * The menu that can be opened by the header element of this column.
2550
+ */
2551
+ headerMenu?: IColumnHeaderMenu | string;
2552
+
2522
2553
  /**
2523
2554
  * @SINCE 1.33.0
2524
2555
  *
@@ -3588,6 +3619,8 @@ declare module "sap/ui/table/RowActionItem" {
3588
3619
 
3589
3620
  import Event from "sap/ui/base/Event";
3590
3621
 
3622
+ import Row from "sap/ui/table/Row";
3623
+
3591
3624
  import { URI } from "sap/ui/core/library";
3592
3625
 
3593
3626
  import ElementMetadata from "sap/ui/core/ElementMetadata";
@@ -3734,7 +3767,16 @@ declare module "sap/ui/table/RowActionItem" {
3734
3767
  /**
3735
3768
  * Parameters to pass along with the event
3736
3769
  */
3737
- mParameters?: object
3770
+ mParameters?: {
3771
+ /**
3772
+ * The item which was pressed.
3773
+ */
3774
+ item?: RowActionItem;
3775
+ /**
3776
+ * The table row to which the pressed item belongs to.
3777
+ */
3778
+ row?: Row;
3779
+ }
3738
3780
  ): this;
3739
3781
  /**
3740
3782
  * Gets current value of property {@link #getIcon icon}.
@@ -5662,7 +5704,12 @@ declare module "sap/ui/table/Table" {
5662
5704
  /**
5663
5705
  * Parameters to pass along with the event
5664
5706
  */
5665
- mParameters?: object
5707
+ mParameters?: {
5708
+ /**
5709
+ * busy state
5710
+ */
5711
+ busy?: boolean;
5712
+ }
5666
5713
  ): this;
5667
5714
  /**
5668
5715
  * @SINCE 1.21.0
@@ -5869,7 +5916,16 @@ declare module "sap/ui/table/Table" {
5869
5916
  /**
5870
5917
  * Parameters to pass along with the event
5871
5918
  */
5872
- mParameters?: object
5919
+ mParameters?: {
5920
+ /**
5921
+ * The column instance on which the custom filter button was pressed.
5922
+ */
5923
+ column?: Column;
5924
+ /**
5925
+ * Filter value.
5926
+ */
5927
+ value?: string;
5928
+ }
5873
5929
  ): this;
5874
5930
  /**
5875
5931
  * Fires event {@link #event:filter filter} to attached listeners.
@@ -5905,7 +5961,12 @@ declare module "sap/ui/table/Table" {
5905
5961
  /**
5906
5962
  * Parameters to pass along with the event
5907
5963
  */
5908
- mParameters?: object
5964
+ mParameters?: {
5965
+ /**
5966
+ * First visible row
5967
+ */
5968
+ firstVisibleRow?: int;
5969
+ }
5909
5970
  ): this;
5910
5971
  /**
5911
5972
  * Fires event {@link #event:group group} to attached listeners.
@@ -6230,7 +6291,7 @@ declare module "sap/ui/table/Table" {
6230
6291
  */
6231
6292
  getEnableCustomFilter(): boolean;
6232
6293
  /**
6233
- * @EXPERIMENTAL (since 1.28) - This feature has a limited functionality.
6294
+ * @deprecated (since 1.110) - this feature has a limited functionality and should not be used anymore.
6234
6295
  *
6235
6296
  * Gets current value of property {@link #getEnableGrouping enableGrouping}.
6236
6297
  *
@@ -7064,7 +7125,7 @@ declare module "sap/ui/table/Table" {
7064
7125
  bEnableCustomFilter?: boolean
7065
7126
  ): this;
7066
7127
  /**
7067
- * @EXPERIMENTAL (since 1.28) - This feature has a limited functionality.
7128
+ * @deprecated (since 1.110) - this feature has a limited functionality and should not be used anymore.
7068
7129
  *
7069
7130
  * Sets a new value for property {@link #getEnableGrouping enableGrouping}.
7070
7131
  *
@@ -7730,7 +7791,7 @@ declare module "sap/ui/table/Table" {
7730
7791
  enableColumnReordering?: boolean | PropertyBindingInfo | `{${string}}`;
7731
7792
 
7732
7793
  /**
7733
- * @EXPERIMENTAL (since 1.28) - This feature has a limited functionality.
7794
+ * @deprecated (since 1.110) - this feature has a limited functionality and should not be used anymore.
7734
7795
  *
7735
7796
  * Enables or disables grouping. If grouping is enabled, the table is grouped by the column which is defined
7736
7797
  * in the `groupBy` association.
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.2
1
+ // For Library Version: 1.110.0
2
2
 
3
3
  declare module "sap/ui/testrecorder/library" {}
4
4