@openui5/ts-types 1.109.0 → 1.111.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.109.0
1
+ // For Library Version: 1.111.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -40,7 +40,7 @@ declare namespace sap {
40
40
  * Settings for the new rule. For detailed information about its properties see {@link topic:eaeea19a991d46f29e6d8d8827317d0e
41
41
  * Rule Property Values}
42
42
  */
43
- oRule: object
43
+ oRule: sap.ui.support.RuleConfiguration
44
44
  ): string;
45
45
  /**
46
46
  * Main method to perform analysis of a given running application.
@@ -109,19 +109,13 @@ declare namespace sap {
109
109
  const RuleAnalyzer: RuleAnalyzer;
110
110
 
111
111
  /**
112
- * Overview: The CoreFacade interface gives access to the Metadata, Models, UI areas and Components of the
113
- * Core object.
112
+ * The CoreFacade interface allows rule developers to access the metadata, models, UI areas and components
113
+ * of the Core.
114
114
  *
115
- * Usage: The CoreFacade is passed to all rule check functions as an object. This helps rule developers
116
- * to access the core state.
115
+ * Usage: The CoreFacade is passed as second argument to all rule check functions.
117
116
  */
118
117
  class CoreFacade {
119
- constructor(
120
- /**
121
- * Core object as available in core plugins
122
- */
123
- oCore: object
124
- );
118
+ constructor();
125
119
 
126
120
  /**
127
121
  * Gets the Components from the Core object.
@@ -147,17 +141,14 @@ declare namespace sap {
147
141
  *
148
142
  * Overview:
149
143
  *
150
- * `ExecutionScope` is the third parameter of a rule check function. It provides access to internal UI5
151
- * objects available for inspection. The `getElements` API method allows the user to select a specific subset
152
- * of elements valid for their case. It accepts one query object argument.
144
+ * The ExecutionScope provides access to internal UI5 objects available for inspection. The `getElements`
145
+ * API method allows the user to select a specific subset of elements valid for their case. It accepts one
146
+ * query object argument.
153
147
  *
154
- * Usage:
155
- *
156
- * When a rule is executed, three parameters are passed: `oIssueManager`, `oCoreFacade` and `oScope`.
148
+ * Usage: The ExecutionScope is passed as third argument to all rule check functions.
157
149
  *
158
- * An `ExecutionScope` instance is passed to every call of a rule check function. When you analyze your
159
- * application, available objects are collected depending on the settings passed to the Support Assistant
160
- * at the moment when you start it.
150
+ * When you analyze your application, available objects are collected depending on the settings passed to
151
+ * the Support Assistant at the moment when you start it.
161
152
  */
162
153
  class ExecutionScope {
163
154
  constructor();
@@ -221,197 +212,30 @@ declare namespace sap {
221
212
  getType(): string;
222
213
  }
223
214
  /**
224
- * The IssueManager is used to store and export issues to the Support Assistant. Overview: The IssueManager
225
- * is used to store and export issues found by the Support Assistant. Usage: The IssueManager can be used
226
- * as a static class and add issues using the `addIssue` method of both the IssueManager or the IssueManagerFacade.
215
+ * The IssueManagerFacade allows rule developers to add new issues.
216
+ *
217
+ * Usage: The IssueManagerFacade is passed as first argument to all rule check functions.
227
218
  */
228
- class IssueManager {
219
+ class IssueManagerFacade {
229
220
  constructor();
230
221
 
231
222
  /**
232
- * Adds an issue to the list of issues found.
233
- */
234
- static addIssue(
235
- /**
236
- * The issue to be added in the IssueManager
237
- */
238
- oIssue: object
239
- ): void;
240
- /**
241
- * Clears all issues in the IssueManager.
242
- */
243
- static clearIssues(): void;
244
- /**
245
- * Converts issues to view model format.
246
- *
247
- * @returns viewModel Issues in ViewModel format
248
- */
249
- static convertToViewModel(
250
- /**
251
- * The issues to convert
252
- */
253
- oIssues: any[]
254
- ): any[];
255
- /**
256
- * Creates an instance of the IssueManagerFacade.
257
- *
258
- * @returns New IssueManagerFacade
259
- */
260
- static createIssueManagerFacade(
261
- /**
262
- * Given rule
263
- */
264
- oRule: object
265
- ): /* was: sap.ui.support.IssueManagerFacade */ any;
266
- /**
267
- * Converts the issues inside the IssueManager.
268
- *
269
- * @returns viewModel Issues in ViewModel format
270
- */
271
- static getIssuesModel(): object[];
272
- /**
273
- * Gets issues in TreeTable format.
274
- *
275
- * @returns All the issues in TreeTable usable model
276
- */
277
- static getIssuesViewModel(
278
- /**
279
- * All the issues after they have been grouped with `groupIssues`
280
- */
281
- issuesModel: object
282
- ): object;
283
- /**
284
- * Gets rules and issues, and converts each rule to a ruleViewModel - parameters should be converted as
285
- * specified beforehand.
286
- *
287
- * @returns rulesViewModel All the rules with issues, selected flag and issueCount properties The issues
288
- * are in ViewModel format.
223
+ * Adds issue
289
224
  */
290
- static getRulesViewModel(
291
- /**
292
- * All the rules from _mRulesets
293
- */
294
- rules: object,
225
+ addIssue(
295
226
  /**
296
- * The rule ID's of the selected rules.
227
+ * Issue object to be added
297
228
  */
298
- selectedRulesIDs: any[],
299
- /**
300
- * The issues to map to the rulesViewModel The issues passes should be grouped and in ViewModel format.
301
- */
302
- issues: any[]
303
- ): object;
304
- /**
305
- * Gets rules and converts them into treeTable format.
306
- *
307
- * @returns TreeTableModel Rules in treeTable usable format The rules are in a TreeTable format.
308
- */
309
- static getTreeTableViewModel(
310
- /**
311
- * Deserialized rules found within the current state
312
- */
313
- oRules: object
314
- ): object;
315
- /**
316
- * Groups all issues by library and rule ID.
317
- *
318
- * @returns groupedIssues Grouped issues by library and rule id
319
- */
320
- static groupIssues(
321
- /**
322
- * The issues to group. Must be in a ViewModel format
323
- */
324
- oIssues: any[]
325
- ): any[];
326
- /**
327
- * Cycles through issues stored in the IssueManager and executes the given callback function.
328
- */
329
- static walkIssues(
330
- /**
331
- * Callback function to be used in the same fashion as Array.prototype.forEach
332
- */
333
- fnCallback: Function
334
- ): void;
335
- }
229
+ oIssue: {
230
+ severity: sap.ui.support.Severity;
336
231
 
337
- class RuleSet {
338
- /**
339
- * Creates a RuleSet.
340
- *
341
- * The RuleSet can store multiple rules concerning namespaces. Usage: The RuleSet is an interface used to
342
- * create, update and delete rulesets.
343
- */
344
- constructor(
345
- /**
346
- * Name of the initiated
347
- */
348
- oSettings: object
349
- );
232
+ details: string;
350
233
 
351
- /**
352
- * Clears all rulesets inside the RuleSet.
353
- */
354
- static clearAllRuleSets(): void;
355
- /**
356
- * Loads the previous selection of the user - which rules are selected to be run by the Rule Analyzer. The
357
- * method applies the settings to the currently loaded rules.
358
- */
359
- static loadSelectionOfRules(
360
- /**
361
- * The current loaded libraries and their rules
362
- */
363
- aLibraries: Object[]
364
- ): void;
365
- /**
366
- * Stores which rules are selected to be run by the analyzer on the next check
367
- */
368
- static storeSelectionOfRules(
369
- /**
370
- * The data for the libraries and their rules
371
- */
372
- aLibraries: Object[]
373
- ): void;
374
- /**
375
- * Adds rules to RuleSet.
376
- *
377
- * @returns sRuleVerificationStatus Verification status
378
- */
379
- addRule(
380
- /**
381
- * Settings object with rule information
382
- */
383
- oSettings: object
384
- ): string;
385
- /**
386
- * Gets all rules from the RuleSet.
387
- *
388
- * @returns All rules within the current RuleSet
389
- */
390
- getRules(): object;
391
- /**
392
- * Remove rule from RuleSet.
393
- */
394
- removeRule(
395
- /**
396
- * Rule object that will be removed
397
- */
398
- oRule: object
234
+ context: {
235
+ id: string;
236
+ };
237
+ }
399
238
  ): void;
400
- /**
401
- * Updates rules from the RuleSet.
402
- *
403
- * @returns sRuleVerification Rule Verification status
404
- */
405
- updateRule(
406
- /**
407
- * Rule ID
408
- */
409
- sRuleId: string,
410
- /**
411
- * Rule settings
412
- */
413
- ORuleSettings: object
414
- ): string;
415
239
  }
416
240
  /**
417
241
  * @SINCE 1.50
@@ -536,149 +360,6 @@ declare namespace sap {
536
360
  */
537
361
  Accessibility = "undefined",
538
362
  }
539
- /**
540
- * Overview: Channel constants which can be used to subscribe to the {@link sap.ui.support.WindowCommunicationBus}
541
- *
542
- * Usage: These channels are used for communication with Main.
543
- */
544
- enum WCBChannels {
545
- /**
546
- * Progress of current loading process
547
- */
548
- CURRENT_LOADING_PROGRESS = "undefined",
549
- /**
550
- * Posts information about which rule to be deleted.
551
- */
552
- DELETE_RULE = "undefined",
553
- /**
554
- * Ensure SupportAssistant iframe is open.
555
- */
556
- ENSURE_FRAME_OPENED = "undefined",
557
- /**
558
- * Upload external modules.
559
- */
560
- EXTERNAL_MODULE_UPLOADED = "undefined",
561
- /**
562
- * Gets components.
563
- */
564
- GET_AVAILABLE_COMPONENTS = "undefined",
565
- /**
566
- * Gets the issues.
567
- */
568
- GET_ISSUES = "undefined",
569
- /**
570
- * Get non loaded libraries with rules names
571
- */
572
- GET_NON_LOADED_RULE_SETS = "undefined",
573
- /**
574
- * Get rules model.
575
- */
576
- GET_RULES_MODEL = "undefined",
577
- /**
578
- * Highlight element in TreeTable.
579
- */
580
- HIGHLIGHT_ELEMENT = "undefined",
581
- /**
582
- * Loads all rule sets.
583
- */
584
- LOAD_RULESETS = "undefined",
585
- /**
586
- * Notifies after the analysis has finished.
587
- */
588
- ON_ANALYZE_FINISH = "undefined",
589
- /**
590
- * Notifies that the analysis has started.
591
- */
592
- ON_ANALYZE_STARTED = "undefined",
593
- /**
594
- * State change in the core.
595
- */
596
- ON_CORE_STATE_CHANGE = "undefined",
597
- /**
598
- * Downloads a report.
599
- */
600
- ON_DOWNLOAD_REPORT_REQUEST = "undefined",
601
- /**
602
- * Notifies when the rulesets have to be loaded.
603
- */
604
- ON_INIT_ANALYSIS_CTRL = "undefined",
605
- /**
606
- * Provides the current progress status of the analysis.
607
- */
608
- ON_PROGRESS_UPDATE = "undefined",
609
- /**
610
- * Shows a report.
611
- */
612
- ON_SHOW_REPORT_REQUEST = "undefined",
613
- /**
614
- * Open given URL.
615
- */
616
- OPEN_URL = "undefined",
617
- /**
618
- * Posts information about the application under test.
619
- */
620
- POST_APPLICATION_INFORMATION = "undefined",
621
- /**
622
- * Posts components.
623
- */
624
- POST_AVAILABLE_COMPONENTS = "undefined",
625
- /**
626
- * Posts available libraries.
627
- */
628
- POST_AVAILABLE_LIBRARIES = "undefined",
629
- /**
630
- * Posts a message.
631
- */
632
- POST_MESSAGE = "undefined",
633
- /**
634
- * Posts information about the UI and it's iframe.
635
- */
636
- POST_UI_INFORMATION = "undefined",
637
- /**
638
- * Request issues.
639
- */
640
- REQUEST_ISSUES = "undefined",
641
- /**
642
- * Request rules model.
643
- */
644
- REQUEST_RULES_MODEL = "undefined",
645
- /**
646
- * Resize SupportAssistant iframe.
647
- */
648
- RESIZE_FRAME = "undefined",
649
- /**
650
- * Hides SupportAssistant iframe.
651
- */
652
- TOGGLE_FRAME_HIDDEN = "undefined",
653
- /**
654
- * Notifies onmouseenter event on the TreeTable.
655
- */
656
- TREE_ELEMENT_MOUSE_ENTER = "undefined",
657
- /**
658
- * Notifies onmouseout event on the TreeTable.
659
- */
660
- TREE_ELEMENT_MOUSE_OUT = "undefined",
661
- /**
662
- * Updates support rules in IssueManager.
663
- */
664
- UPDATE_SUPPORT_RULES = "undefined",
665
- /**
666
- * Verifies rule creation.
667
- */
668
- VERIFY_CREATE_RULE = "undefined",
669
- /**
670
- * Verifies rule creation after it's finished.
671
- */
672
- VERIFY_RULE_CREATE_RESULT = "undefined",
673
- /**
674
- * Verifies rule update after it's finished.
675
- */
676
- VERIFY_RULE_UPDATE_RESULT = "undefined",
677
- /**
678
- * Verifies rule update.
679
- */
680
- VERIFY_UPDATE_RULE = "undefined",
681
- }
682
363
  /**
683
364
  * Analysis result which is created after analysis with the SupportAssistant.
684
365
  */
@@ -712,6 +393,31 @@ declare namespace sap {
712
393
  */
713
394
  issues: Object[];
714
395
  };
396
+
397
+ /**
398
+ * Support Assistant rule configuration
399
+ */
400
+ type RuleConfiguration = {
401
+ id: string;
402
+
403
+ async: boolean;
404
+
405
+ title: string;
406
+
407
+ resolution: string;
408
+
409
+ minversion: string;
410
+
411
+ categories: sap.ui.support.Categories[];
412
+
413
+ audiences: sap.ui.support.Audiences[];
414
+
415
+ description: string;
416
+
417
+ resolutionurls: string;
418
+
419
+ check: string;
420
+ };
715
421
  }
716
422
  }
717
423
 
@@ -727,9 +433,5 @@ declare namespace sap {
727
433
  "sap/ui/support/supportRules/History": undefined;
728
434
 
729
435
  "sap/ui/support/supportRules/IssueManager": undefined;
730
-
731
- "sap/ui/support/supportRules/RuleSet": undefined;
732
-
733
- "sap/ui/support/supportRules/WCBChannels": undefined;
734
436
  }
735
437
  }
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.109.0
1
+ // For Library Version: 1.111.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1047,6 +1047,13 @@ declare namespace sap {
1047
1047
  */
1048
1048
  menu?: sap.ui.unified.Menu;
1049
1049
 
1050
+ /**
1051
+ * @SINCE 1.110
1052
+ *
1053
+ * The menu that can be opened by the header element of this column.
1054
+ */
1055
+ headerMenu?: sap.ui.core.IColumnHeaderMenu | string;
1056
+
1050
1057
  /**
1051
1058
  * @SINCE 1.33.0
1052
1059
  *
@@ -1316,7 +1323,7 @@ declare namespace sap {
1316
1323
  | `{${string}}`;
1317
1324
 
1318
1325
  /**
1319
- * @EXPERIMENTAL (since 1.28) - This feature has a limited functionality.
1326
+ * @deprecated (since 1.110) - this feature has a limited functionality and should not be used anymore.
1320
1327
  *
1321
1328
  * Enables or disables grouping. If grouping is enabled, the table is grouped by the column which is defined
1322
1329
  * in the `groupBy` association.
@@ -2213,7 +2220,7 @@ declare namespace sap {
2213
2220
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
2214
2221
  * of the syntax of the settings object.
2215
2222
  * See:
2216
- * http://scn.sap.com/docs/DOC-44986
2223
+ * https://github.com/SAP/odata-vocabularies/blob/main/docs/v2-annotations.md
2217
2224
  * {@link topic:08197fa68e4f479cbe30f639cc1cd22c sap.ui.table}
2218
2225
  * {@link fiori:/analytical-table-alv/ Analytical Table}
2219
2226
  */
@@ -2230,7 +2237,7 @@ declare namespace sap {
2230
2237
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
2231
2238
  * of the syntax of the settings object.
2232
2239
  * See:
2233
- * http://scn.sap.com/docs/DOC-44986
2240
+ * https://github.com/SAP/odata-vocabularies/blob/main/docs/v2-annotations.md
2234
2241
  * {@link topic:08197fa68e4f479cbe30f639cc1cd22c sap.ui.table}
2235
2242
  * {@link fiori:/analytical-table-alv/ Analytical Table}
2236
2243
  */
@@ -3138,6 +3145,13 @@ declare namespace sap {
3138
3145
  * @returns Value of property `hAlign`
3139
3146
  */
3140
3147
  getHAlign(): sap.ui.core.HorizontalAlign;
3148
+ /**
3149
+ * @SINCE 1.110
3150
+ *
3151
+ * ID of the element which is the current target of the association {@link #getHeaderMenu headerMenu}, or
3152
+ * `null`.
3153
+ */
3154
+ getHeaderMenu(): sap.ui.core.ID;
3141
3155
  /**
3142
3156
  * Gets current value of property {@link #getHeaderSpan headerSpan}.
3143
3157
  *
@@ -3576,6 +3590,20 @@ declare namespace sap {
3576
3590
  */
3577
3591
  sHAlign?: sap.ui.core.HorizontalAlign
3578
3592
  ): this;
3593
+ /**
3594
+ * @SINCE 1.110
3595
+ *
3596
+ * Sets the associated {@link #getHeaderMenu headerMenu}.
3597
+ *
3598
+ * @returns Reference to `this` in order to allow method chaining
3599
+ */
3600
+ setHeaderMenu(
3601
+ /**
3602
+ * ID of an element which becomes the new target of this headerMenu association; alternatively, an element
3603
+ * instance may be given
3604
+ */
3605
+ oHeaderMenu: sap.ui.core.ID | sap.ui.core.IColumnHeaderMenu
3606
+ ): this;
3579
3607
  /**
3580
3608
  * Sets a new value for property {@link #getHeaderSpan headerSpan}.
3581
3609
  *
@@ -4375,7 +4403,16 @@ declare namespace sap {
4375
4403
  /**
4376
4404
  * Parameters to pass along with the event
4377
4405
  */
4378
- mParameters?: object
4406
+ mParameters?: {
4407
+ /**
4408
+ * The item which was pressed.
4409
+ */
4410
+ item?: sap.ui.table.RowActionItem;
4411
+ /**
4412
+ * The table row to which the pressed item belongs to.
4413
+ */
4414
+ row?: sap.ui.table.Row;
4415
+ }
4379
4416
  ): this;
4380
4417
  /**
4381
4418
  * Gets current value of property {@link #getIcon icon}.
@@ -6181,7 +6218,12 @@ declare namespace sap {
6181
6218
  /**
6182
6219
  * Parameters to pass along with the event
6183
6220
  */
6184
- mParameters?: object
6221
+ mParameters?: {
6222
+ /**
6223
+ * busy state
6224
+ */
6225
+ busy?: boolean;
6226
+ }
6185
6227
  ): this;
6186
6228
  /**
6187
6229
  * @SINCE 1.21.0
@@ -6388,7 +6430,16 @@ declare namespace sap {
6388
6430
  /**
6389
6431
  * Parameters to pass along with the event
6390
6432
  */
6391
- mParameters?: object
6433
+ mParameters?: {
6434
+ /**
6435
+ * The column instance on which the custom filter button was pressed.
6436
+ */
6437
+ column?: sap.ui.table.Column;
6438
+ /**
6439
+ * Filter value.
6440
+ */
6441
+ value?: string;
6442
+ }
6392
6443
  ): this;
6393
6444
  /**
6394
6445
  * Fires event {@link #event:filter filter} to attached listeners.
@@ -6424,7 +6475,12 @@ declare namespace sap {
6424
6475
  /**
6425
6476
  * Parameters to pass along with the event
6426
6477
  */
6427
- mParameters?: object
6478
+ mParameters?: {
6479
+ /**
6480
+ * First visible row
6481
+ */
6482
+ firstVisibleRow?: int;
6483
+ }
6428
6484
  ): this;
6429
6485
  /**
6430
6486
  * Fires event {@link #event:group group} to attached listeners.
@@ -6749,7 +6805,7 @@ declare namespace sap {
6749
6805
  */
6750
6806
  getEnableCustomFilter(): boolean;
6751
6807
  /**
6752
- * @EXPERIMENTAL (since 1.28) - This feature has a limited functionality.
6808
+ * @deprecated (since 1.110) - this feature has a limited functionality and should not be used anymore.
6753
6809
  *
6754
6810
  * Gets current value of property {@link #getEnableGrouping enableGrouping}.
6755
6811
  *
@@ -7581,7 +7637,7 @@ declare namespace sap {
7581
7637
  bEnableCustomFilter?: boolean
7582
7638
  ): this;
7583
7639
  /**
7584
- * @EXPERIMENTAL (since 1.28) - This feature has a limited functionality.
7640
+ * @deprecated (since 1.110) - this feature has a limited functionality and should not be used anymore.
7585
7641
  *
7586
7642
  * Sets a new value for property {@link #getEnableGrouping enableGrouping}.
7587
7643
  *
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.109.0
1
+ // For Library Version: 1.111.0
2
2
 
3
3
  declare namespace sap {
4
4
  interface IUI5DefineDependencyNames {