@openui5/ts-types 1.108.1 → 1.109.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.1
1
+ // For Library Version: 1.109.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -11,78 +11,6 @@ declare namespace sap {
11
11
  * to check all aspects of an application.
12
12
  */
13
13
  namespace support {
14
- export const CoreFacade: undefined;
15
-
16
- /**
17
- * Creates a RuleSet. The RuleSet can store multiple rules concerning namespaces. Usage: The RuleSet is
18
- * an interface used to create, update and delete rulesets.
19
- */
20
- namespace RuleSet {
21
- /**
22
- * Adds rules to RuleSet.
23
- *
24
- * @returns sRuleVerificationStatus Verification status
25
- */
26
- function addRule(
27
- /**
28
- * Settings object with rule information
29
- */
30
- oSettings: object
31
- ): string;
32
- /**
33
- * Clears all rulesets inside the RuleSet.
34
- */
35
- function clearAllRuleSets(): void;
36
- /**
37
- * Gets all rules from the RuleSet.
38
- *
39
- * @returns All rules within the current RuleSet
40
- */
41
- function getRules(): object;
42
- /**
43
- * Loads the previous selection of the user - which rules are selected to be run by the Rule Analyzer. The
44
- * method applies the settings to the currently loaded rules.
45
- */
46
- function loadSelectionOfRules(
47
- /**
48
- * The current loaded libraries and their rules
49
- */
50
- aLibraries: Object[]
51
- ): void;
52
- /**
53
- * Remove rule from RuleSet.
54
- */
55
- function removeRule(
56
- /**
57
- * Rule object that will be removed
58
- */
59
- oRule: object
60
- ): void;
61
- /**
62
- * Stores which rules are selected to be run by the analyzer on the next check
63
- */
64
- function storeSelectionOfRules(
65
- /**
66
- * The data for the libraries and their rules
67
- */
68
- aLibraries: Object[]
69
- ): void;
70
- /**
71
- * Updates rules from the RuleSet.
72
- *
73
- * @returns sRuleVerification Rule Verification status
74
- */
75
- function updateRule(
76
- /**
77
- * Rule ID
78
- */
79
- sRuleId: string,
80
- /**
81
- * Rule settings
82
- */
83
- ORuleSettings: object
84
- ): string;
85
- }
86
14
  /**
87
15
  * The `sap.ui.support.RuleAnalyzer` namespace is the central entry point for the Support Assistant functionality.
88
16
  *
@@ -180,6 +108,38 @@ declare namespace sap {
180
108
  }
181
109
  const RuleAnalyzer: RuleAnalyzer;
182
110
 
111
+ /**
112
+ * Overview: The CoreFacade interface gives access to the Metadata, Models, UI areas and Components of the
113
+ * Core object.
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.
117
+ */
118
+ class CoreFacade {
119
+ constructor(
120
+ /**
121
+ * Core object as available in core plugins
122
+ */
123
+ oCore: object
124
+ );
125
+
126
+ /**
127
+ * Gets the Components from the Core object.
128
+ */
129
+ getComponents(): void;
130
+ /**
131
+ * Gets the Metadata from the Core object.
132
+ */
133
+ getMetadata(): void;
134
+ /**
135
+ * Gets the Models from the Core object.
136
+ */
137
+ getModels(): void;
138
+ /**
139
+ * Gets the UI areas from the Core object.
140
+ */
141
+ getUIAreas(): void;
142
+ }
183
143
  /**
184
144
  * @SINCE 1.48
185
145
  *
@@ -206,7 +166,7 @@ declare namespace sap {
206
166
  *
207
167
  * @returns Array of matched elements
208
168
  */
209
- static getElements(
169
+ getElements(
210
170
  /**
211
171
  * Object with specific filtering options
212
172
  */
@@ -230,7 +190,7 @@ declare namespace sap {
230
190
  *
231
191
  * @returns Array of matched elements
232
192
  */
233
- static getElementsByClassName(
193
+ getElementsByClassName(
234
194
  /**
235
195
  * Either string or function to be used when selecting a subset of elements
236
196
  */
@@ -241,7 +201,7 @@ declare namespace sap {
241
201
  *
242
202
  * @returns Array of logged objects
243
203
  */
244
- static getLoggedObjects(
204
+ getLoggedObjects(
245
205
  /**
246
206
  * Type of logged objects
247
207
  */
@@ -252,13 +212,206 @@ declare namespace sap {
252
212
  *
253
213
  * @returns Array of matched elements
254
214
  */
255
- static getPublicElements(): any[];
215
+ getPublicElements(): any[];
256
216
  /**
257
217
  * Gets the type of the execution scope
258
218
  *
259
219
  * @returns The type of the execution scope. Possible values are `global`, `subtree` or `components`.
260
220
  */
261
- static getType(): string;
221
+ getType(): string;
222
+ }
223
+ /**
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.
227
+ */
228
+ class IssueManager {
229
+ constructor();
230
+
231
+ /**
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.
289
+ */
290
+ static getRulesViewModel(
291
+ /**
292
+ * All the rules from _mRulesets
293
+ */
294
+ rules: object,
295
+ /**
296
+ * The rule ID's of the selected rules.
297
+ */
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
+ }
336
+
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
+ );
350
+
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
399
+ ): 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;
262
415
  }
263
416
  /**
264
417
  * @SINCE 1.50
@@ -383,6 +536,149 @@ declare namespace sap {
383
536
  */
384
537
  Accessibility = "undefined",
385
538
  }
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
+ }
386
682
  /**
387
683
  * Analysis result which is created after analysis with the SupportAssistant.
388
684
  */
@@ -420,16 +716,20 @@ declare namespace sap {
420
716
  }
421
717
 
422
718
  interface IUI5DefineDependencyNames {
423
- "sap/ui/support/jQuery.sap.support": undefined;
424
-
425
719
  "sap/ui/support/library": undefined;
426
720
 
427
721
  "sap/ui/support/RuleAnalyzer": undefined;
428
722
 
723
+ "sap/ui/support/supportRules/CoreFacade": undefined;
724
+
429
725
  "sap/ui/support/supportRules/ExecutionScope": undefined;
430
726
 
431
727
  "sap/ui/support/supportRules/History": undefined;
432
728
 
729
+ "sap/ui/support/supportRules/IssueManager": undefined;
730
+
433
731
  "sap/ui/support/supportRules/RuleSet": undefined;
732
+
733
+ "sap/ui/support/supportRules/WCBChannels": undefined;
434
734
  }
435
735
  }
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.1
1
+ // For Library Version: 1.109.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1929,8 +1929,6 @@ declare namespace sap {
1929
1929
  }
1930
1930
 
1931
1931
  /**
1932
- * @EXPERIMENTAL (since 1.21)
1933
- *
1934
1932
  * This column adds additional properties to the table column which are needed for the analytical binding
1935
1933
  * and table
1936
1934
  */
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.1
1
+ // For Library Version: 1.109.0
2
2
 
3
3
  declare namespace sap {
4
4
  interface IUI5DefineDependencyNames {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.1
1
+ // For Library Version: 1.109.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -546,6 +546,17 @@ declare namespace sap {
546
546
  | sap.ui.base.ManagedObject.PropertyBindingInfo
547
547
  | `{${string}}`;
548
548
 
549
+ /**
550
+ * @SINCE 1.109.0
551
+ *
552
+ * If set, the days are also displayed in this calendar type If not set, the dates are only displayed in
553
+ * the primary calendar type
554
+ */
555
+ secondaryCalendarType?:
556
+ | sap.ui.core.CalendarType
557
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
558
+ | `{${string}}`;
559
+
549
560
  /**
550
561
  * Date ranges for selected dates. If `singleSelection` is set, only the first entry is used.
551
562
  *
@@ -674,6 +685,17 @@ declare namespace sap {
674
685
  | sap.ui.base.ManagedObject.PropertyBindingInfo
675
686
  | `{${string}}`;
676
687
 
688
+ /**
689
+ * @SINCE 1.109.0
690
+ *
691
+ * If set, the days are also displayed in this calendar type If not set, the dates are only displayed in
692
+ * the primary calendar type
693
+ */
694
+ secondaryCalendarType?:
695
+ | sap.ui.core.CalendarType
696
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
697
+ | `{${string}}`;
698
+
677
699
  /**
678
700
  * Date ranges for selected dates. If `singleSelection` is set, only the first entry is used.
679
701
  */
@@ -3808,6 +3830,17 @@ declare namespace sap {
3808
3830
  * @returns Value of property `primaryCalendarType`
3809
3831
  */
3810
3832
  getPrimaryCalendarType(): sap.ui.core.CalendarType;
3833
+ /**
3834
+ * @SINCE 1.109.0
3835
+ *
3836
+ * Gets current value of property {@link #getSecondaryCalendarType secondaryCalendarType}.
3837
+ *
3838
+ * If set, the days are also displayed in this calendar type If not set, the dates are only displayed in
3839
+ * the primary calendar type
3840
+ *
3841
+ * @returns Value of property `secondaryCalendarType`
3842
+ */
3843
+ getSecondaryCalendarType(): sap.ui.core.CalendarType;
3811
3844
  /**
3812
3845
  * Gets content of aggregation {@link #getSelectedDates selectedDates}.
3813
3846
  *
@@ -4036,6 +4069,24 @@ declare namespace sap {
4036
4069
  */
4037
4070
  sPrimaryCalendarType?: sap.ui.core.CalendarType
4038
4071
  ): this;
4072
+ /**
4073
+ * @SINCE 1.109.0
4074
+ *
4075
+ * Sets a new value for property {@link #getSecondaryCalendarType secondaryCalendarType}.
4076
+ *
4077
+ * If set, the days are also displayed in this calendar type If not set, the dates are only displayed in
4078
+ * the primary calendar type
4079
+ *
4080
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
4081
+ *
4082
+ * @returns Reference to `this` in order to allow method chaining
4083
+ */
4084
+ setSecondaryCalendarType(
4085
+ /**
4086
+ * New value for property `secondaryCalendarType`
4087
+ */
4088
+ sSecondaryCalendarType?: sap.ui.core.CalendarType
4089
+ ): this;
4039
4090
  /**
4040
4091
  * Sets a new value for property {@link #getShowHeader showHeader}.
4041
4092
  *
@@ -4456,6 +4507,17 @@ declare namespace sap {
4456
4507
  * @returns Value of property `primaryCalendarType`
4457
4508
  */
4458
4509
  getPrimaryCalendarType(): sap.ui.core.CalendarType;
4510
+ /**
4511
+ * @SINCE 1.109.0
4512
+ *
4513
+ * Gets current value of property {@link #getSecondaryCalendarType secondaryCalendarType}.
4514
+ *
4515
+ * If set, the days are also displayed in this calendar type If not set, the dates are only displayed in
4516
+ * the primary calendar type
4517
+ *
4518
+ * @returns Value of property `secondaryCalendarType`
4519
+ */
4520
+ getSecondaryCalendarType(): sap.ui.core.CalendarType;
4459
4521
  /**
4460
4522
  * Gets content of aggregation {@link #getSelectedDates selectedDates}.
4461
4523
  *
@@ -4719,6 +4781,24 @@ declare namespace sap {
4719
4781
  */
4720
4782
  sPrimaryCalendarType?: sap.ui.core.CalendarType
4721
4783
  ): this;
4784
+ /**
4785
+ * @SINCE 1.109.0
4786
+ *
4787
+ * Sets a new value for property {@link #getSecondaryCalendarType secondaryCalendarType}.
4788
+ *
4789
+ * If set, the days are also displayed in this calendar type If not set, the dates are only displayed in
4790
+ * the primary calendar type
4791
+ *
4792
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
4793
+ *
4794
+ * @returns Reference to `this` in order to allow method chaining
4795
+ */
4796
+ setSecondaryCalendarType(
4797
+ /**
4798
+ * New value for property `secondaryCalendarType`
4799
+ */
4800
+ sSecondaryCalendarType?: sap.ui.core.CalendarType
4801
+ ): this;
4722
4802
  /**
4723
4803
  * Sets a new value for property {@link #getShowHeader showHeader}.
4724
4804
  *
@@ -20218,8 +20298,6 @@ declare namespace sap {
20218
20298
  interface IUI5DefineDependencyNames {
20219
20299
  "sap/ui/unified/Calendar": undefined;
20220
20300
 
20221
- "sap/ui/unified/calendar/CalendarUtils": undefined;
20222
-
20223
20301
  "sap/ui/unified/calendar/DatesRow": undefined;
20224
20302
 
20225
20303
  "sap/ui/unified/calendar/Header": undefined;
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.1
1
+ // For Library Version: 1.109.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.1
1
+ // For Library Version: 1.109.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.1
1
+ // For Library Version: 1.109.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {