@ui5/manifest 1.4.0 → 1.17.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.
@@ -8,6 +8,181 @@
8
8
  export type Version = string;
9
9
  export type I18NKey = string;
10
10
  export type Tag = I18NKey[];
11
+ /**
12
+ * Represents sapui5 attributes
13
+ */
14
+ export type JSONSchemaForSAPUI5Namespace = {
15
+ /**
16
+ * Represents SAPUI5 attributes format version. It is managed by namespace owner
17
+ */
18
+ _version?: "1.1.0" | "1.2.0" | "1.3.0" | "1.4.0" | "1.5.0" | "1.6.0" | "1.7.0" | "1.8.0";
19
+ resources?: Resource;
20
+ /**
21
+ * Represents the explicit usage declaration for UI5 reuse components
22
+ */
23
+ componentUsages?: {
24
+ [k: string]: ComponentUsages;
25
+ };
26
+ /**
27
+ * Represents external dependences such as libraries or components, that will be loaded by UI5 Core in the initialization phase of your Component and can be used after it
28
+ */
29
+ dependencies: {
30
+ /**
31
+ * Represents the minimum version of SAP UI5 that your component requires
32
+ */
33
+ minUI5Version: string;
34
+ /**
35
+ * Represents ...
36
+ */
37
+ incompatibleLimitation?: boolean;
38
+ /**
39
+ * Represents the id (namespace) of the libraries that should be loaded by UI5 Core to be used in your component
40
+ */
41
+ libs?: {
42
+ [k: string]: Lib;
43
+ };
44
+ /**
45
+ * Represents the id (namespace) of the components that should be loaded by UI5 Core to be used in your component
46
+ */
47
+ components?: {
48
+ [k: string]: Component;
49
+ };
50
+ };
51
+ /**
52
+ * Represents models which should be created/destroyed with the life-cycle of the component
53
+ */
54
+ models?: {
55
+ [k: string]: Model;
56
+ };
57
+ /**
58
+ * Represents relative path to the resource. Only relative path allowed, no '../'
59
+ */
60
+ resourceRoots?: {
61
+ [k: string]: ResourceRoot;
62
+ };
63
+ /**
64
+ * Represents the usage of validation handling by MessageManager for this component (enable/disable)
65
+ */
66
+ handleValidation?: boolean;
67
+ /**
68
+ * Represents the static configuration for components
69
+ */
70
+ config?: {
71
+ [k: string]: Config;
72
+ };
73
+ /**
74
+ * Represents the extension of an additional component
75
+ */
76
+ extends?: {
77
+ /**
78
+ * Represents the component name
79
+ */
80
+ component?: string;
81
+ /**
82
+ * Represents minimal version of the component
83
+ */
84
+ minVersion?: string;
85
+ /**
86
+ * Represents extensions of the component
87
+ */
88
+ extensions?: {
89
+ [k: string]: unknown;
90
+ };
91
+ };
92
+ /**
93
+ * Represents object with content density modes the app is supporting. Supported density modes are 'cozy' and 'compact'
94
+ */
95
+ contentDensities: {
96
+ /**
97
+ * Represents indicator whether compact mode is supported
98
+ */
99
+ compact: boolean;
100
+ /**
101
+ * Represents indicator whether cozy mode is supported
102
+ */
103
+ cozy: boolean;
104
+ };
105
+ /**
106
+ * Represents a name of the UI5 component
107
+ */
108
+ componentName?: string;
109
+ /**
110
+ * Enables the auto prefixing of IDs of ManagedObjects (e.g. Controls) which are created in context of the Component (e.g. createContent invocation)
111
+ */
112
+ autoPrefixId?: boolean;
113
+ /**
114
+ * Represents the identifier of an application variant. The value will be calculated and should not be set manually
115
+ */
116
+ appVariantId?: string;
117
+ /**
118
+ * Represents array of appVariantId hierarchy with origin layer and version, calculated attribute and filled automatically during variant merge
119
+ */
120
+ appVariantIdHierarchy?: {
121
+ /**
122
+ * Represents origin layer of the app variant id
123
+ */
124
+ layer: string;
125
+ /**
126
+ * Represents app variant id
127
+ */
128
+ appVariantId: string;
129
+ /**
130
+ * Represents version of the app variant id
131
+ */
132
+ version: string;
133
+ }[];
134
+ /**
135
+ * Represents a list of the services
136
+ */
137
+ services?: {
138
+ [k: string]: Service;
139
+ };
140
+ /**
141
+ * Represents UI5 library specific properties
142
+ */
143
+ library?: {
144
+ /**
145
+ * Flag whether the library contains a i18n resource or not. If using a string instead of a boolean value an alternative name for the i18n resource could be defined.
146
+ */
147
+ i18n?: boolean | string;
148
+ /**
149
+ * Flag whether the library contains a CSS file or not.
150
+ */
151
+ css?: boolean | string;
152
+ /**
153
+ * Represents the content of a library. Content are controls, elements, types and interfaces.
154
+ */
155
+ content?: {
156
+ [k: string]: unknown;
157
+ };
158
+ };
159
+ /**
160
+ * Represents a list of UI5 shortcut commands
161
+ */
162
+ commands?: {
163
+ [k: string]: Command;
164
+ };
165
+ [k: string]: unknown;
166
+ } & (
167
+ | {
168
+ /**
169
+ * Represents an Indicator whether an app is flex enabled
170
+ */
171
+ flexEnabled: true;
172
+ routing?: RoutingFlexEnabled;
173
+ rootView?: RootViewDefFlexEnabled;
174
+ [k: string]: unknown;
175
+ }
176
+ | {
177
+ /**
178
+ * Represents an Indicator whether an app is flex enabled
179
+ */
180
+ flexEnabled?: false;
181
+ routing?: Routing;
182
+ rootView?: RootViewDef;
183
+ [k: string]: unknown;
184
+ }
185
+ );
11
186
  /**
12
187
  * This interface was referenced by `undefined`'s JSON-Schema definition
13
188
  * via the `patternProperty` "^[a-zA-Z0-9_\.\-]*$".
@@ -35,6 +210,26 @@ export type Route = RouteWithoutName & {
35
210
  name: string;
36
211
  [k: string]: unknown;
37
212
  };
213
+ /**
214
+ * Represents the root view definition being either the name of the view or the view definition object
215
+ */
216
+ export type RootViewDef =
217
+ | string
218
+ | {
219
+ /**
220
+ * Represents the name of the view
221
+ */
222
+ viewName: string;
223
+ /**
224
+ * Represents the type of the view. Possible Values: XML, JSON, JS, HTML, Template
225
+ */
226
+ type?: "XML" | "JSON" | "JS" | "HTML" | "Template";
227
+ /**
228
+ * Represents the id of the view
229
+ */
230
+ id?: string;
231
+ [k: string]: unknown;
232
+ };
38
233
  /**
39
234
  * Represents the card default grid size in columns and rows
40
235
  */
@@ -48,14 +243,107 @@ export type DefaultSpanDef =
48
243
  * Represents the number of the number of grid rows
49
244
  */
50
245
  rows: number;
246
+ /**
247
+ * Represents if user wants to show only header part of card in resizable layout
248
+ */
249
+ showOnlyHeader?: boolean;
250
+ /**
251
+ * If user wants to show more text in title then he/she can configure no of lines to be shown in title(Maximum allowed 3 lines)
252
+ */
253
+ minimumTitleRow?: number;
254
+ /**
255
+ * If user wants to show more text in title then he/she can configure no of lines to be shown in sub-title(Maximum allowed 2 lines)
256
+ */
257
+ minimumSubTitleRow?: number;
51
258
  }
52
259
  | "auto";
260
+ /**
261
+ * Plot area is a parent property which defines multiple other properties for smoothness and marker size
262
+ */
263
+ export type LevelsDef = unknown[];
264
+ /**
265
+ * Represents general card attributes
266
+ */
267
+ export type JSONSchemaForSAPCARDNamespace =
268
+ | ({
269
+ type?: "List";
270
+ [k: string]: unknown;
271
+ } & {
272
+ content?: ContentType;
273
+ [k: string]: unknown;
274
+ })
275
+ | ({
276
+ type?: "Analytical";
277
+ [k: string]: unknown;
278
+ } & {
279
+ content?: ContentType1;
280
+ [k: string]: unknown;
281
+ })
282
+ | ({
283
+ type?: "Timeline";
284
+ [k: string]: unknown;
285
+ } & {
286
+ content?: ContentType2;
287
+ [k: string]: unknown;
288
+ })
289
+ | ({
290
+ type?: "Table";
291
+ [k: string]: unknown;
292
+ } & {
293
+ content?: ContentType3;
294
+ [k: string]: unknown;
295
+ })
296
+ | ({
297
+ type?: "Object";
298
+ [k: string]: unknown;
299
+ } & {
300
+ content?: ContentType4;
301
+ [k: string]: unknown;
302
+ })
303
+ | ({
304
+ type?: "Component";
305
+ [k: string]: unknown;
306
+ } & {
307
+ content?: "null";
308
+ [k: string]: unknown;
309
+ });
310
+ export type SimpleBinding = string;
311
+ /**
312
+ * Represents state of an entity
313
+ */
314
+ export type State = "Error" | "Success" | "Warning" | "None" | "Information";
315
+ /**
316
+ * Represents identifier
317
+ */
318
+ export type Identifier =
319
+ | boolean
320
+ | {
321
+ url?: string;
322
+ target?: Target;
323
+ };
53
324
 
54
325
  export interface SAPJSONSchemaForWebApplicationManifestFile {
55
326
  /**
56
327
  * Represents Application Descriptor format version. It is managed by schema owner
57
328
  */
58
- _version: "1.1.0" | "1.2.0" | "1.3.0" | "1.4.0";
329
+ _version:
330
+ | "1.1.0"
331
+ | "1.2.0"
332
+ | "1.3.0"
333
+ | "1.4.0"
334
+ | "1.5.0"
335
+ | "1.6.0"
336
+ | "1.7.0"
337
+ | "1.8.0"
338
+ | "1.9.0"
339
+ | "1.10.0"
340
+ | "1.11.0"
341
+ | "1.12.0"
342
+ | "1.13.0"
343
+ | "1.14.0"
344
+ | "1.15.0"
345
+ | "1.16.0"
346
+ | "1.17.0";
59
347
  /**
60
348
  * Represents the URL that the developer would prefer the user agent load when the user launches the web application
61
349
  */
@@ -65,16 +353,26 @@ export interface SAPJSONSchemaForWebApplicationManifestFile {
65
353
  "sap.ui5"?: JSONSchemaForSAPUI5Namespace;
66
354
  "sap.platform.abap"?: JSONSchemaForSAPPLATFORMABAPNamespace;
67
355
  "sap.platform.hcp"?: JSONSchemaForSAPPLATFORMHCPNamespace;
356
+ "sap.platform.cf"?: JSONSchemaForSAPPLATFORMCFNamespace;
68
357
  "sap.fiori"?: JSONSchemaForSAPFIORINamespace;
69
358
  "sap.ui.generic.app"?: JSONSchemaForSAPUIGENERICAPPNamespace;
359
+ "sap.fe"?: JSONSchemaForSAPFENamespace;
70
360
  "sap.flp"?: JSONSchemaForSAPFLPNamespace;
71
361
  "sap.ovp"?: JSONSchemaForSAPOVPNamespace;
72
362
  "sap.wda"?: JSONSchemaForSAPWDANamespace;
73
363
  "sap.apf"?: JSONSchemaForSAPAPFNamespace;
74
364
  "sap.cloud.portal"?: JSONSchemaForSAPCLOUDPORTALNamespace;
75
365
  "sap.gui"?: JSONSchemaForSAPGUINamespace;
366
+ "sap.integration"?: JSONSchemaForSAPINTEGRATIONNamespace;
367
+ "sap.wcf"?: JSONSchemaForSAPWCFNamespace;
76
368
  "sap.ui.smartbusiness.app"?: JSONSchemaForSAPUISMARTBUSINESSAPPNamespace;
77
369
  "sap.mobile"?: JSONSchemaForSAPMOBILENamespace;
370
+ "sap.copilot"?: JSONSchemaForSAPCOPILOTNamespace;
371
+ "sap.map"?: JSONSchemaForSAPMAPNamespace;
372
+ "sap.url"?: JSONSchemaForSAPURLNamespace;
373
+ "sap.platform.sfsf"?: JSONSchemaForSAPPLATFORMSFSFNamespace;
374
+ "sap.cloud"?: JSONSchemaForSAPCLOUDNamespace;
375
+ "sap.card"?: JSONSchemaForSAPCARDNamespace;
78
376
  }
79
377
  /**
80
378
  * Represents general application attributes
@@ -83,7 +381,7 @@ export interface JSONSchemaForSAPAPPNamespace {
83
381
  /**
84
382
  * Application attributes format version. It is managed by namespace owner
85
383
  */
86
- _version?: "1.1.0" | "1.2.0" | "1.3.0" | "1.4.0";
384
+ _version?: "1.1.0" | "1.2.0" | "1.3.0" | "1.4.0" | "1.5.0" | "1.6.0" | "1.7.0" | "1.8.0" | "1.9.0";
87
385
  /**
88
386
  * Represents the template from which the app was generated
89
387
  */
@@ -105,7 +403,7 @@ export interface JSONSchemaForSAPAPPNamespace {
105
403
  /**
106
404
  * Represents type of an application and can be application or component or library
107
405
  */
108
- type: "application" | "component" | "library";
406
+ type: "application" | "component" | "library" | "card";
109
407
  /**
110
408
  * Represents path inside the app to the properties file containing text symbols for the Descriptor
111
409
  */
@@ -133,6 +431,14 @@ export interface JSONSchemaForSAPAPPNamespace {
133
431
  * Represents language-dependent additional information to the title
134
432
  */
135
433
  subTitle?: string;
434
+ /**
435
+ * Represents shorter version of the title (language-dependent )
436
+ */
437
+ shortTitle?: string;
438
+ /**
439
+ * Represents language-dependent additional information to the title
440
+ */
441
+ info?: string;
136
442
  /**
137
443
  * Represents language-dependent description
138
444
  */
@@ -142,6 +448,7 @@ export interface JSONSchemaForSAPAPPNamespace {
142
448
  */
143
449
  tags?: {
144
450
  keywords: Tag;
451
+ technicalAttributes?: string[];
145
452
  [k: string]: unknown;
146
453
  };
147
454
  /**
@@ -175,6 +482,10 @@ export interface JSONSchemaForSAPAPPNamespace {
175
482
  * Represents a collection of directly used open source libs (not when used via UI5 capsulation)
176
483
  */
177
484
  openSourceComponents?: OpenSource[];
485
+ /**
486
+ * Represents the name of the provider which owns the application
487
+ */
488
+ provider?: "sfsf";
178
489
  /**
179
490
  * Represents indicator whether the app is running offline. Possible values are true or false (default)
180
491
  */
@@ -191,7 +502,7 @@ export interface JSONSchemaForSAPAPPNamespace {
191
502
  * Represents unique id of the site
192
503
  *
193
504
  * This interface was referenced by `undefined`'s JSON-Schema definition
194
- * via the `patternProperty` "^[\w\.\-]+$".
505
+ * via the `patternProperty` "^[a-zA-Z0-9_\.\-]+$".
195
506
  */
196
507
  [k: string]: {
197
508
  value: string;
@@ -205,7 +516,7 @@ export interface JSONSchemaForSAPAPPNamespace {
205
516
  }
206
517
  /**
207
518
  * This interface was referenced by `undefined`'s JSON-Schema definition
208
- * via the `patternProperty` "^[\w\.\-]*$".
519
+ * via the `patternProperty` "^[a-zA-Z0-9_\.\-]*$".
209
520
  */
210
521
  export interface DataSource {
211
522
  /**
@@ -270,6 +581,10 @@ export interface Inbound {
270
581
  * Represents action an the semantic object
271
582
  */
272
583
  action: string;
584
+ /**
585
+ * Indicates to not expose this inbound as a tile or link
586
+ */
587
+ hideLauncher?: boolean;
273
588
  /**
274
589
  * Represents icon
275
590
  */
@@ -282,10 +597,18 @@ export interface Inbound {
282
597
  * Represents language-dependent additional information to the title and can overwrite subTitle from sap.app definition
283
598
  */
284
599
  subTitle?: I18NKey;
600
+ /**
601
+ * Represents shorter version of the title (language-dependent )
602
+ */
603
+ shortTitle?: I18NKey;
285
604
  /**
286
605
  * Represents language-dependent additional information to the title
287
606
  */
288
607
  info?: string;
608
+ /**
609
+ * Represents the display mode of the tile
610
+ */
611
+ displayMode?: "ContentMode" | "HeaderMode";
289
612
  /**
290
613
  * Represents data source
291
614
  */
@@ -326,7 +649,7 @@ export interface SignatureDef {
326
649
  parameters: {
327
650
  /**
328
651
  * This interface was referenced by `undefined`'s JSON-Schema definition
329
- * via the `patternProperty` "^[\w\.\-]+$".
652
+ * via the `patternProperty` "^[\w\.\-\/]+$".
330
653
  */
331
654
  [k: string]: {
332
655
  /**
@@ -355,6 +678,20 @@ export interface SignatureDef {
355
678
  */
356
679
  format?: "plain" | "regexp" | "reference";
357
680
  };
681
+ /**
682
+ * Represents a value to be used when creating a tile intent for this inbound
683
+ */
684
+ launcherValue?: {
685
+ value?: string | string[];
686
+ /**
687
+ * Indicates how 'value' is to be interpreted: 'plain': the 'value' is taken as a literal string value | 'array': the 'value' is an array of strings
688
+ */
689
+ format?: "plain" | "array";
690
+ /**
691
+ * DEPRECATED - Indicates the administrator should be prompted to supply a value when creating a tile
692
+ */
693
+ prompt?: boolean;
694
+ };
358
695
  required?: boolean;
359
696
  /**
360
697
  * Represents the parameter name in legacy ABAP application, e.g. 'RF05L-BUKRS' for parameter 'CompanyCode'
@@ -384,16 +721,33 @@ export interface Outbound {
384
721
  * Represents action an the semantic object
385
722
  */
386
723
  action: string;
724
+ /**
725
+ * Indicates whether additional context parameters are to be used: ('ignored': parameters are not used | 'allowed': parameters are passed on to application)
726
+ */
727
+ additionalParameters?: "ignored" | "allowed";
387
728
  /**
388
729
  * Represents parameters for outbound targets
389
730
  */
390
731
  parameters?: {
391
732
  /**
392
733
  * This interface was referenced by `undefined`'s JSON-Schema definition
393
- * via the `patternProperty` "^[\w\.\-]+$".
734
+ * via the `patternProperty` "^[\w\.\-\/]+$".
394
735
  */
395
736
  [k: string]: {
396
- [k: string]: unknown;
737
+ /**
738
+ * Represents a value to use in the outbound
739
+ */
740
+ value?: {
741
+ /**
742
+ * Represents a verbatim value (format : plain or not supplied) or a binding reference(format : binding)
743
+ */
744
+ value?: string;
745
+ /**
746
+ * Indicates how 'value' is to be interpreted: ('plain': the 'value' is taken as a literal string value| 'reference': the 'value' is a reference to e.g. a UserDefault parameter (e.g. 'UserDefault.CostCenter'), the resolved parameter value is used)
747
+ */
748
+ format?: "plain" | "binding";
749
+ };
750
+ required?: boolean;
397
751
  };
398
752
  };
399
753
  };
@@ -405,11 +759,11 @@ export interface JSONSchemaForSAPUINamespace {
405
759
  /**
406
760
  * Represents UI attributes format version. It is managed by namespace owner
407
761
  */
408
- _version?: "1.1.0" | "1.2.0" | "1.3.0" | "1.4.0";
762
+ _version?: "1.1.0" | "1.2.0" | "1.3.0" | "1.4.0" | "1.5.0";
409
763
  /**
410
- * Represents UI technology. The possible values are UI5 (default), WDA, NWBC and URL
764
+ * Represents UI technology. The possible values are UI5 (default), WDA, NWBC, GUI, URL and WCF
411
765
  */
412
- technology: "UI5" | "WDA" | "NWBC" | "GUI" | "URL";
766
+ technology: "UI5" | "WDA" | "NWBC" | "GUI" | "URL" | "WCF";
413
767
  /**
414
768
  * Represents icons which used in application
415
769
  */
@@ -446,7 +800,7 @@ export interface JSONSchemaForSAPUINamespace {
446
800
  [k: string]: unknown;
447
801
  };
448
802
  /**
449
- * Represents array of supported SAP themes such as sap_hcb, sap_bluecrystal
803
+ * The property is Deprecated. Represents array of supported SAP themes such as sap_hcb, sap_bluecrystal
450
804
  */
451
805
  supportedThemes?: string[];
452
806
  /**
@@ -473,198 +827,57 @@ export interface DeviceType1 {
473
827
  phone?: boolean;
474
828
  }
475
829
  /**
476
- * Represents sapui5 attributes
830
+ * Represents paths to JavaScript/CSS resources that your app needs (app internal), formerly called '.includes'
831
+ */
832
+ export interface Resource {
833
+ js?: {
834
+ uri: string;
835
+ [k: string]: unknown;
836
+ }[];
837
+ css?: {
838
+ uri: string;
839
+ id?: string;
840
+ [k: string]: unknown;
841
+ }[];
842
+ [k: string]: unknown;
843
+ }
844
+ /**
845
+ * Represents component name for usage
846
+ *
847
+ * This interface was referenced by `undefined`'s JSON-Schema definition
848
+ * via the `patternProperty` "^[a-zA-Z0-9_\.]*$".
477
849
  */
478
- export interface JSONSchemaForSAPUI5Namespace {
850
+ export interface ComponentUsages {
479
851
  /**
480
- * Represents SAPUI5 attributes format version. It is managed by namespace owner
852
+ * Represents name of reuse component
481
853
  */
482
- _version?: "1.1.0" | "1.2.0" | "1.3.0";
483
- resources?: Resource;
854
+ name: string;
484
855
  /**
485
- * Represents external dependences such as libraries or components, that will be loaded by UI5 Core in the initialization phase of your Component and can be used after it
856
+ * Represents component data for the Component
486
857
  */
487
- dependencies: {
488
- /**
489
- * Represents the minimum version of SAP UI5 that your component requires
490
- */
491
- minUI5Version: string;
492
- /**
493
- * Represents ...
494
- */
495
- incompatibleLimitation?: boolean;
496
- /**
497
- * Represents the id (namespace) of the libraries that should be loaded by UI5 Core to be used in your component
498
- */
499
- libs?: {
500
- [k: string]: Lib;
501
- };
502
- /**
503
- * Represents the id (namespace) of the components that should be loaded by UI5 Core to be used in your component
504
- */
505
- components?: {
506
- [k: string]: Component;
507
- };
508
- };
509
- /**
510
- * Represents models which should be created/destroyed with the life-cycle of the component
511
- */
512
- models?: {
513
- [k: string]: Model;
514
- };
515
- /**
516
- * Represents relative path to the resource. Only relative path allowed, no '../'
517
- */
518
- resourceRoots?: {
519
- [k: string]: ResourceRoot;
520
- };
521
- /**
522
- * Represents the name of the root view
523
- */
524
- rootView?:
858
+ componentData?:
859
+ | string[]
525
860
  | string
861
+ | boolean
862
+ | number
526
863
  | {
527
- /**
528
- * Represents the name of the view
529
- */
530
- viewName: string;
531
- /**
532
- * Represents the type of the view. Possible Values: XML, JSON, JS, HTML, Template
533
- */
534
- type?: "XML" | "JSON" | "JS" | "HTML" | "Template";
535
864
  [k: string]: unknown;
536
865
  };
537
866
  /**
538
- * Represents the usage of validation handling by MessageManager for this component (enable/disable)
539
- */
540
- handleValidation?: boolean;
541
- /**
542
- * Represents the static configuration for components
543
- */
544
- config?: {
545
- [k: string]: Config;
546
- };
547
- /**
548
- * Represents the configuration of routing
867
+ * Represents settings for the Component
549
868
  */
550
- routing?: {
551
- /**
552
- * Represents the default properties defined for route and target
553
- */
554
- config?: {
555
- /**
556
- * Represents the router class
557
- */
558
- routerClass?: string;
559
- /**
560
- * Indicates whether the Views in routing are loaded asyncly
561
- */
562
- async?: boolean;
563
- /**
564
- * Represents information about targets to display when no route is matched
565
- */
566
- bypassed?: {
567
- /**
568
- * Represents one or multiple names of targets that are displayed when no route is matched
569
- */
570
- target: string[] | string;
571
- };
572
- [k: string]: unknown;
573
- } & Target;
574
- routes?:
575
- | Route[]
576
- | {
577
- [k: string]: RouteWithoutName;
578
- };
579
- /**
580
- * Represents the definition of targets
581
- */
582
- targets?: {
583
- /**
584
- * This interface was referenced by `undefined`'s JSON-Schema definition
585
- * via the `patternProperty` "[\s\S]*".
586
- */
587
- [k: string]: Target & {
588
- /**
589
- * Represents the name of a view that will be created
590
- */
591
- viewName: string;
592
- [k: string]: unknown;
593
- } & {
594
- /**
595
- * Represents the id of the created view
596
- */
597
- viewID?: string;
869
+ settings?:
870
+ | string[]
871
+ | string
872
+ | boolean
873
+ | number
874
+ | {
598
875
  [k: string]: unknown;
599
876
  };
600
- };
601
- [k: string]: unknown;
602
- };
603
- /**
604
- * Represents the extension of an additional component
605
- */
606
- extends?: {
607
- /**
608
- * Represents the component name
609
- */
610
- component?: string;
611
- /**
612
- * Represents minimal version of the component
613
- */
614
- minVersion?: string;
615
- /**
616
- * Represents extensions of the component
617
- */
618
- extensions?: {
619
- [k: string]: unknown;
620
- };
621
- };
622
- /**
623
- * Represents object with content density modes the app is supporting. Supported density modes are 'cozy' and 'compact'
624
- */
625
- contentDensities: {
626
- /**
627
- * Represents indicator whether compact mode is supported
628
- */
629
- compact: boolean;
630
- /**
631
- * Represents indicator whether cozy mode is supported
632
- */
633
- cozy: boolean;
634
- };
635
- /**
636
- * Represents a name of the UI5 component
637
- */
638
- componentName?: string;
639
- /**
640
- * Enables the auto prefixing of IDs of ManagedObjects (e.g. Controls) which are created in context of the Component (e.g. createContent invocation)
641
- */
642
- autoPrefixId?: boolean;
643
- /**
644
- * Represents the identifier of an application variant. The value will be calculated and should not be set manually
645
- */
646
- appVariantId?: string;
647
877
  /**
648
- * Represents a list of the services
878
+ * Represents Indicator to lazy loading component usage, default true
649
879
  */
650
- services?: {
651
- [k: string]: Service;
652
- };
653
- }
654
- /**
655
- * Represents paths to JavaScript/CSS resources that your app needs (app internal), formerly called '.includes'
656
- */
657
- export interface Resource {
658
- js?: {
659
- uri: string;
660
- [k: string]: unknown;
661
- }[];
662
- css?: {
663
- uri: string;
664
- id?: string;
665
- [k: string]: unknown;
666
- }[];
667
- [k: string]: unknown;
880
+ lazy?: boolean;
668
881
  }
669
882
  /**
670
883
  * Represents sapui5 library name
@@ -678,7 +891,7 @@ export interface Lib {
678
891
  */
679
892
  minVersion?: string;
680
893
  /**
681
- * Represents ...
894
+ * Represents Indicator to lazy loading lib
682
895
  */
683
896
  lazy?: boolean;
684
897
  [k: string]: unknown;
@@ -687,7 +900,7 @@ export interface Lib {
687
900
  * Represents sapui5 component name
688
901
  *
689
902
  * This interface was referenced by `undefined`'s JSON-Schema definition
690
- * via the `patternProperty` "^([a-z_$][a-z0-9_$]{0,39}\.)*([a-zA-Z_$][a-zA-Z0-9_$]{0,39})$".
903
+ * via the `patternProperty` "^([a-zA-Z_$][a-zA-Z0-9_$]{0,39}\.)*([a-zA-Z_$][a-zA-Z0-9_$]{0,39})$".
691
904
  */
692
905
  export interface Component {
693
906
  /**
@@ -695,7 +908,7 @@ export interface Component {
695
908
  */
696
909
  minVersion?: string;
697
910
  /**
698
- * Represents ...
911
+ * Represents Indicator to lazy loading component
699
912
  */
700
913
  lazy?: boolean;
701
914
  [k: string]: unknown;
@@ -730,6 +943,170 @@ export interface Ui5Setting {
730
943
  * Represents default binding mode and must be a string value from sap.ui.model.BindingMode. Possible values: Default, OneTime, OneWay, TwoWay
731
944
  */
732
945
  defaultBindingMode?: "Default" | "OneTime" | "OneWay" | "TwoWay";
946
+ /**
947
+ * Represents enhancement of UI5 resource model with additional properties files
948
+ */
949
+ enhanceWith?: (
950
+ | {
951
+ /**
952
+ * Represents property url for model enhancement
953
+ */
954
+ bundleUrl: string;
955
+ /**
956
+ * Indicates whether url is relative to component (default) or manifest
957
+ */
958
+ bundleUrlRelativeTo?: "manifest" | "component";
959
+ }
960
+ | {
961
+ /**
962
+ * Represents the alternative for bundleUrl
963
+ */
964
+ bundleName: string;
965
+ }
966
+ )[];
967
+ [k: string]: unknown;
968
+ }
969
+ /**
970
+ * Represents the definition of each service
971
+ *
972
+ * This interface was referenced by `undefined`'s JSON-Schema definition
973
+ * via the `patternProperty` "[\s\S]*".
974
+ */
975
+ export interface Service {
976
+ /**
977
+ * Represents the name of the service factory
978
+ */
979
+ factoryName: string;
980
+ /**
981
+ * Indicates whether the service optional or not
982
+ */
983
+ optional?: boolean;
984
+ [k: string]: unknown;
985
+ }
986
+ /**
987
+ * Represents a UI5 shortcut command.
988
+ *
989
+ * This interface was referenced by `undefined`'s JSON-Schema definition
990
+ * via the `patternProperty` "^[A-Za-z_][A-Za-z0-9_\-\|\@]+$".
991
+ */
992
+ export interface Command {
993
+ /**
994
+ * A string describing a shortcut key combination that, when used by the user, will trigger the command.
995
+ */
996
+ shortcut?: string;
997
+ }
998
+ /**
999
+ * Represents the configuration of routing
1000
+ */
1001
+ export interface RoutingFlexEnabled {
1002
+ /**
1003
+ * Represents the default properties defined for route and target
1004
+ */
1005
+ config?: {
1006
+ /**
1007
+ * Represents the router class
1008
+ */
1009
+ routerClass?: string;
1010
+ /**
1011
+ * Indicates whether the Views in routing are loaded asyncly
1012
+ */
1013
+ async?: boolean;
1014
+ /**
1015
+ * Represents information about targets to display when no route is matched
1016
+ */
1017
+ bypassed?: {
1018
+ /**
1019
+ * Represents one or multiple names of targets that are displayed when no route is matched
1020
+ */
1021
+ target: [] | [string | RouteTargetObject] | string | RouteTargetObject;
1022
+ };
1023
+ /**
1024
+ * Represents a prefix that is prepended in front of the viewName
1025
+ */
1026
+ viewPath?: string;
1027
+ [k: string]: unknown;
1028
+ } & Target;
1029
+ routes?:
1030
+ | Route[]
1031
+ | {
1032
+ [k: string]: RouteWithoutName;
1033
+ };
1034
+ /**
1035
+ * Represents the definition of targets
1036
+ */
1037
+ targets?: {
1038
+ /**
1039
+ * This interface was referenced by `undefined`'s JSON-Schema definition
1040
+ * via the `patternProperty` "[\s\S]*".
1041
+ */
1042
+ [k: string]:
1043
+ | (Target & {
1044
+ /**
1045
+ * Represents the name of a view that will be created
1046
+ */
1047
+ viewName: string;
1048
+ /**
1049
+ * Represents the id of the created view
1050
+ */
1051
+ viewId: string;
1052
+ /**
1053
+ * Represents a prefix that is prepended in front of the viewName
1054
+ */
1055
+ viewPath?: string;
1056
+ [k: string]: unknown;
1057
+ })
1058
+ | (Target &
1059
+ (
1060
+ | {
1061
+ /**
1062
+ * Represents the name of a view or component that will be created
1063
+ */
1064
+ name: string;
1065
+ /**
1066
+ * Represents the id of the created view or component
1067
+ */
1068
+ id: string;
1069
+ /**
1070
+ * Represents a prefix that is prepended in front of the view or component name
1071
+ */
1072
+ path?: string;
1073
+ /**
1074
+ * Represents the type of the type View or Component
1075
+ */
1076
+ type?: "View" | "Component";
1077
+ [k: string]: unknown;
1078
+ }
1079
+ | {
1080
+ /**
1081
+ * Represents the componentUsage of the component that will be created
1082
+ */
1083
+ usage: string;
1084
+ /**
1085
+ * Represents the id of the created view or component
1086
+ */
1087
+ id: string;
1088
+ /**
1089
+ * Represents the type of the type Component
1090
+ */
1091
+ type: "Component";
1092
+ [k: string]: unknown;
1093
+ }
1094
+ ));
1095
+ };
1096
+ [k: string]: unknown;
1097
+ }
1098
+ /**
1099
+ * Represents the definition of a target of a route as object.
1100
+ */
1101
+ export interface RouteTargetObject {
1102
+ /**
1103
+ * Represents the name of the routing target
1104
+ */
1105
+ name?: string;
1106
+ /**
1107
+ * The prefix of the routing target
1108
+ */
1109
+ prefix?: string;
733
1110
  [k: string]: unknown;
734
1111
  }
735
1112
  /**
@@ -737,13 +1114,13 @@ export interface Ui5Setting {
737
1114
  */
738
1115
  export interface Target {
739
1116
  /**
740
- * Represents the type of view that is going to be created
1117
+ * Represents the information which is included as a parameter of the 'titleChanged' event fired on Router when this target is displayed. The title can be set with static text and can also be set with a valid property binding syntax which will be resolved under the scope of the view in the target where the title property is defined.
741
1118
  */
742
- viewType?: "XML" | "JSON" | "JS" | "HTML" | "Template";
1119
+ title?: string;
743
1120
  /**
744
- * Represents a prefix that is prepended in front of the viewName
1121
+ * Represents the type of view that is going to be created
745
1122
  */
746
- viewPath?: string;
1123
+ viewType?: "XML" | "JSON" | "JS" | "HTML" | "Template";
747
1124
  /**
748
1125
  * Represents the id of the view that contains the control specified by the 'controlId'
749
1126
  */
@@ -785,6 +1162,9 @@ export interface Target {
785
1162
  *
786
1163
  * This interface was referenced by `undefined`'s JSON-Schema definition
787
1164
  * via the `patternProperty` "[\s\S]*".
1165
+ *
1166
+ * This interface was referenced by `undefined`'s JSON-Schema definition
1167
+ * via the `patternProperty` "[\s\S]*".
788
1168
  */
789
1169
  export interface RouteWithoutName {
790
1170
  /**
@@ -798,24 +1178,129 @@ export interface RouteWithoutName {
798
1178
  /**
799
1179
  * Represents one or multiple names of targets which are displayed when the route is matched
800
1180
  */
801
- target?: string[] | string;
1181
+ target?: [] | [string | RouteTargetObject] | string | RouteTargetObject;
1182
+ /**
1183
+ * Represents the name of the target where the 'title' information should be taken
1184
+ */
1185
+ titleTarget?: string;
802
1186
  [k: string]: unknown;
803
1187
  }
804
1188
  /**
805
- * Represents the definition of each service
806
- *
807
- * This interface was referenced by `undefined`'s JSON-Schema definition
808
- * via the `patternProperty` "[\s\S]*".
1189
+ * Represents the root view definition when flex is enabled (requires a view id)
809
1190
  */
810
- export interface Service {
1191
+ export interface RootViewDefFlexEnabled {
811
1192
  /**
812
- * Represents the name of the service factory
1193
+ * Represents the name of the view
813
1194
  */
814
- factoryName: string;
1195
+ viewName: string;
815
1196
  /**
816
- * Indicates whether the service optional or not
1197
+ * Represents the type of the view. Possible Values: XML, JSON, JS, HTML, Template
817
1198
  */
818
- optional?: boolean;
1199
+ type?: "XML" | "JSON" | "JS" | "HTML" | "Template";
1200
+ /**
1201
+ * Represents the id of the view
1202
+ */
1203
+ id: string;
1204
+ [k: string]: unknown;
1205
+ }
1206
+ /**
1207
+ * Represents the configuration of routing
1208
+ */
1209
+ export interface Routing {
1210
+ /**
1211
+ * Represents the default properties defined for route and target
1212
+ */
1213
+ config?: {
1214
+ /**
1215
+ * Represents the router class
1216
+ */
1217
+ routerClass?: string;
1218
+ /**
1219
+ * Indicates whether the Views in routing are loaded asyncly
1220
+ */
1221
+ async?: boolean;
1222
+ /**
1223
+ * Represents information about targets to display when no route is matched
1224
+ */
1225
+ bypassed?: {
1226
+ /**
1227
+ * Represents one or multiple names of targets that are displayed when no route is matched
1228
+ */
1229
+ target: [] | [string | RouteTargetObject] | string | RouteTargetObject;
1230
+ };
1231
+ /**
1232
+ * Represents a prefix that is prepended in front of the viewName
1233
+ */
1234
+ viewPath?: string;
1235
+ [k: string]: unknown;
1236
+ } & Target;
1237
+ routes?:
1238
+ | Route[]
1239
+ | {
1240
+ [k: string]: RouteWithoutName;
1241
+ };
1242
+ /**
1243
+ * Represents the definition of targets
1244
+ */
1245
+ targets?: {
1246
+ /**
1247
+ * This interface was referenced by `undefined`'s JSON-Schema definition
1248
+ * via the `patternProperty` "[\s\S]*".
1249
+ */
1250
+ [k: string]:
1251
+ | (Target & {
1252
+ /**
1253
+ * Represents the name of a view that will be created
1254
+ */
1255
+ viewName: string;
1256
+ /**
1257
+ * Represents the id of the created view
1258
+ */
1259
+ viewId?: string;
1260
+ /**
1261
+ * Represents a prefix that is prepended in front of the viewName
1262
+ */
1263
+ viewPath?: string;
1264
+ [k: string]: unknown;
1265
+ })
1266
+ | (Target &
1267
+ (
1268
+ | {
1269
+ /**
1270
+ * Represents the name of a view or component that will be created
1271
+ */
1272
+ name: string;
1273
+ /**
1274
+ * Represents the id of the created view or component
1275
+ */
1276
+ id?: string;
1277
+ /**
1278
+ * Represents a prefix that is prepended in front of the view or component name
1279
+ */
1280
+ path?: string;
1281
+ /**
1282
+ * Represents the type of the type View or Component
1283
+ */
1284
+ type?: "View" | "Component";
1285
+ [k: string]: unknown;
1286
+ }
1287
+ | {
1288
+ /**
1289
+ * Represents the componentUsage of the component that will be created
1290
+ */
1291
+ usage: string;
1292
+ /**
1293
+ * Represents the id of the created view or component
1294
+ */
1295
+ id?: string;
1296
+ /**
1297
+ * Represents the type of the type Component
1298
+ */
1299
+ type: "Component";
1300
+ [k: string]: unknown;
1301
+ }
1302
+ ));
1303
+ };
819
1304
  [k: string]: unknown;
820
1305
  }
821
1306
  /**
@@ -868,6 +1353,20 @@ export interface JSONSchemaForSAPPLATFORMHCPNamespace {
868
1353
  */
869
1354
  multiVersionApp?: boolean;
870
1355
  }
1356
+ /**
1357
+ * Represents CF(Cloud Foundry) platform specific attributes
1358
+ */
1359
+ export interface JSONSchemaForSAPPLATFORMCFNamespace {
1360
+ /**
1361
+ * Represents attributes format version. It is managed by namespace owner
1362
+ */
1363
+ _version?: "1.1.0" | "1.2.0";
1364
+ /**
1365
+ * Represents the authorization scope of the application
1366
+ */
1367
+ oAuthScopes?: string[];
1368
+ [k: string]: unknown;
1369
+ }
871
1370
  /**
872
1371
  * Represents SAP Fiori specific attributes
873
1372
  */
@@ -889,12 +1388,16 @@ export interface JSONSchemaForSAPFIORINamespace {
889
1388
  * Represents GENERIC APP specific attributes
890
1389
  */
891
1390
  export interface JSONSchemaForSAPUIGENERICAPPNamespace {
892
- _version?: "1.1.0" | "1.2.0";
1391
+ _version?: "1.1.0" | "1.2.0" | "1.3.0";
893
1392
  settings?: SettingDef;
894
1393
  /**
895
1394
  * Represents one ore more pages of an application. UI5 routing is created from the definitions in this section
896
1395
  */
897
- pages?: Page[];
1396
+ pages?:
1397
+ | PagesArray[]
1398
+ | {
1399
+ [k: string]: PagesMap;
1400
+ };
898
1401
  }
899
1402
  /**
900
1403
  * Represents global settings for the application controller
@@ -902,7 +1405,7 @@ export interface JSONSchemaForSAPUIGENERICAPPNamespace {
902
1405
  export interface SettingDef {
903
1406
  [k: string]: unknown;
904
1407
  }
905
- export interface Page {
1408
+ export interface PagesArray {
906
1409
  /**
907
1410
  * Represents the navigation property that leads to this page. The navigation links of the previous page (the page that calls this one) are determined through this property
908
1411
  */
@@ -910,11 +1413,17 @@ export interface Page {
910
1413
  /**
911
1414
  * Represents the entity set that defines either the aggregation or the root object of the component
912
1415
  */
913
- entitySet: string;
1416
+ entitySet?: string;
914
1417
  component: ComponentDef;
915
1418
  navigation?: NavigationDef;
916
1419
  embeddedComponents?: EmbeddedComponent;
917
- pages?: Page[];
1420
+ routingSpec?: RoutingSpecDef;
1421
+ implementingComponent?: ImplementingComponentDef;
1422
+ /**
1423
+ * Default layout used to open the corresponding page in FlexibleColumnLayout
1424
+ */
1425
+ defaultLayoutType?: string;
1426
+ pages?: PagesArray[];
918
1427
  }
919
1428
  /**
920
1429
  * Represents the component and its settings that makes the page
@@ -990,6 +1499,9 @@ export interface EmbeddedComponent {
990
1499
  /**
991
1500
  * This interface was referenced by `EmbeddedComponent`'s JSON-Schema definition
992
1501
  * via the `patternProperty` "^[a-zA-Z0-9_\.\-\:]+$".
1502
+ *
1503
+ * This interface was referenced by `EmbeddedComponent2`'s JSON-Schema definition
1504
+ * via the `patternProperty` "^[a-zA-Z0-9_\.\-\:]+$".
993
1505
  */
994
1506
  [k: string]: {
995
1507
  /**
@@ -1010,6 +1522,20 @@ export interface EmbeddedComponent {
1010
1522
  settings?: {
1011
1523
  [k: string]: unknown;
1012
1524
  };
1525
+ /**
1526
+ * Flag, whether the embedded component should be hidden by default
1527
+ */
1528
+ hiddenByDefault?: {
1529
+ [k: string]: unknown;
1530
+ };
1531
+ /**
1532
+ * Represents group title of reuse components
1533
+ */
1534
+ groupTitle?: string;
1535
+ /**
1536
+ * Represents a section that behaves a leading section for the group
1537
+ */
1538
+ leadingSectionIdOrPath?: string;
1013
1539
  [k: string]: unknown;
1014
1540
  } & (
1015
1541
  | {
@@ -1019,6 +1545,13 @@ export interface EmbeddedComponent {
1019
1545
  componentName: string;
1020
1546
  [k: string]: unknown;
1021
1547
  }
1548
+ | {
1549
+ /**
1550
+ * Represents the reference to the name of the componentUsages defined in sap.ui5/componentUsages
1551
+ */
1552
+ componentUsage: string;
1553
+ [k: string]: unknown;
1554
+ }
1022
1555
  | {
1023
1556
  embeddedComponents: EmbeddedComponent1;
1024
1557
  [k: string]: unknown;
@@ -1029,6 +1562,172 @@ export interface EmbeddedComponent1 {
1029
1562
  /**
1030
1563
  * This interface was referenced by `EmbeddedComponent`'s JSON-Schema definition
1031
1564
  * via the `patternProperty` "^[a-zA-Z0-9_\.\-\:]+$".
1565
+ *
1566
+ * This interface was referenced by `EmbeddedComponent2`'s JSON-Schema definition
1567
+ * via the `patternProperty` "^[a-zA-Z0-9_\.\-\:]+$".
1568
+ */
1569
+ [k: string]: {
1570
+ /**
1571
+ * Represents an unique id for the instance of the reuse component inside of the object page
1572
+ */
1573
+ id: string;
1574
+ /**
1575
+ * Represents the title for the content of the reuse component
1576
+ */
1577
+ title: string;
1578
+ /**
1579
+ * Represents an optional element binding for the ComponentContainer that hosts the reuse component
1580
+ */
1581
+ binding?: string;
1582
+ /**
1583
+ * Represents a map to populate the API of the reuse component
1584
+ */
1585
+ settings?: {
1586
+ [k: string]: unknown;
1587
+ };
1588
+ /**
1589
+ * Flag, whether the embedded component should be hidden by default
1590
+ */
1591
+ hiddenByDefault?: {
1592
+ [k: string]: unknown;
1593
+ };
1594
+ /**
1595
+ * Represents group title of reuse components
1596
+ */
1597
+ groupTitle?: string;
1598
+ /**
1599
+ * Represents a section that behaves a leading section for the group
1600
+ */
1601
+ leadingSectionIdOrPath?: string;
1602
+ [k: string]: unknown;
1603
+ } & (
1604
+ | {
1605
+ /**
1606
+ * Represents the name of the reuse component
1607
+ */
1608
+ componentName: string;
1609
+ [k: string]: unknown;
1610
+ }
1611
+ | {
1612
+ /**
1613
+ * Represents the reference to the name of the componentUsages defined in sap.ui5/componentUsages
1614
+ */
1615
+ componentUsage: string;
1616
+ [k: string]: unknown;
1617
+ }
1618
+ | {
1619
+ embeddedComponents: EmbeddedComponent1;
1620
+ [k: string]: unknown;
1621
+ }
1622
+ );
1623
+ }
1624
+ /**
1625
+ * Represents the routing specification
1626
+ */
1627
+ export interface RoutingSpecDef {
1628
+ /**
1629
+ * Represents the name of the route
1630
+ */
1631
+ routeName: string;
1632
+ /**
1633
+ * Represents the switch to indicate, that this route is not related to the OData service
1634
+ */
1635
+ noOData?: boolean;
1636
+ /**
1637
+ * Represents the binding string to indicate, how the page should be bound relative to the predecessor page or absolute
1638
+ */
1639
+ binding?: string;
1640
+ /**
1641
+ * Represents the the title to be shown on the page
1642
+ */
1643
+ headerTitle?: string;
1644
+ /**
1645
+ * Represents the URL pointing to an icon, that will be shown in the navigation menu additional to the title to represent the page
1646
+ */
1647
+ typeImageUrl?: string;
1648
+ /**
1649
+ * Represents the switch to indicate, whether this route is reached via a 1:1 navigation or a 1:n navigation
1650
+ */
1651
+ noKey?: boolean;
1652
+ }
1653
+ /**
1654
+ * Represents the component to be loaded inside the canvas if sap.suite.ui.generic.template.Canvas is used as component name, and its settings
1655
+ */
1656
+ export interface ImplementingComponentDef {
1657
+ /**
1658
+ * Represents the name of the component to be loaded inside the canvas
1659
+ */
1660
+ componentName: string;
1661
+ /**
1662
+ * Represents a binding string to indicate, how the reuse component should be bound relative to the containing page or absolute
1663
+ */
1664
+ binding?: string;
1665
+ settings?: ComponentSettingDef;
1666
+ pages?: {
1667
+ [k: string]: PagesMap;
1668
+ };
1669
+ }
1670
+ /**
1671
+ * This interface was referenced by `undefined`'s JSON-Schema definition
1672
+ * via the `patternProperty` "^[a-zA-Z0-9_\.\-]+[\|]?[a-zA-Z0-9_\.\-]+$".
1673
+ *
1674
+ * This interface was referenced by `undefined`'s JSON-Schema definition
1675
+ * via the `patternProperty` "^[a-zA-Z0-9_\.\-]+[\|]?[a-zA-Z0-9_\.\-]+$".
1676
+ */
1677
+ export interface PagesMap {
1678
+ /**
1679
+ * Represents the navigation property that leads to this page. The navigation links of the previous page (the page that calls this one) are determined through this property
1680
+ */
1681
+ navigationProperty?: string;
1682
+ /**
1683
+ * Represents the entity set that defines either the aggregation or the root object of the component
1684
+ */
1685
+ entitySet?: string;
1686
+ component: ComponentDef1;
1687
+ navigation?: NavigationDef1;
1688
+ embeddedComponents?: EmbeddedComponent2;
1689
+ routingSpec?: RoutingSpecDef1;
1690
+ implementingComponent?: ImplementingComponentDef1;
1691
+ /**
1692
+ * Default layout used to open the corresponding page in FlexibleColumnLayout
1693
+ */
1694
+ defaultLayoutType?: string;
1695
+ pages?: {
1696
+ [k: string]: PagesMap;
1697
+ };
1698
+ }
1699
+ /**
1700
+ * Represents the component and its settings that makes the page
1701
+ */
1702
+ export interface ComponentDef1 {
1703
+ /**
1704
+ * The name of the component
1705
+ */
1706
+ name: string;
1707
+ /**
1708
+ * Switch to create a route for a list (aggregation) if true and routing for an entity if not set or false
1709
+ */
1710
+ list?: boolean;
1711
+ settings?: ComponentSettingDef;
1712
+ }
1713
+ /**
1714
+ * Represents the different navigation targets
1715
+ */
1716
+ export interface NavigationDef1 {
1717
+ display?: ActionPropDef;
1718
+ create?: ActionPropDef1;
1719
+ edit?: ActionPropDef2;
1720
+ }
1721
+ /**
1722
+ * Represent reuse components that should be appended at the end of the template component
1723
+ */
1724
+ export interface EmbeddedComponent2 {
1725
+ /**
1726
+ * This interface was referenced by `EmbeddedComponent`'s JSON-Schema definition
1727
+ * via the `patternProperty` "^[a-zA-Z0-9_\.\-\:]+$".
1728
+ *
1729
+ * This interface was referenced by `EmbeddedComponent2`'s JSON-Schema definition
1730
+ * via the `patternProperty` "^[a-zA-Z0-9_\.\-\:]+$".
1032
1731
  */
1033
1732
  [k: string]: {
1034
1733
  /**
@@ -1049,6 +1748,20 @@ export interface EmbeddedComponent1 {
1049
1748
  settings?: {
1050
1749
  [k: string]: unknown;
1051
1750
  };
1751
+ /**
1752
+ * Flag, whether the embedded component should be hidden by default
1753
+ */
1754
+ hiddenByDefault?: {
1755
+ [k: string]: unknown;
1756
+ };
1757
+ /**
1758
+ * Represents group title of reuse components
1759
+ */
1760
+ groupTitle?: string;
1761
+ /**
1762
+ * Represents a section that behaves a leading section for the group
1763
+ */
1764
+ leadingSectionIdOrPath?: string;
1052
1765
  [k: string]: unknown;
1053
1766
  } & (
1054
1767
  | {
@@ -1058,12 +1771,71 @@ export interface EmbeddedComponent1 {
1058
1771
  componentName: string;
1059
1772
  [k: string]: unknown;
1060
1773
  }
1774
+ | {
1775
+ /**
1776
+ * Represents the reference to the name of the componentUsages defined in sap.ui5/componentUsages
1777
+ */
1778
+ componentUsage: string;
1779
+ [k: string]: unknown;
1780
+ }
1061
1781
  | {
1062
1782
  embeddedComponents: EmbeddedComponent1;
1063
1783
  [k: string]: unknown;
1064
1784
  }
1065
1785
  );
1066
1786
  }
1787
+ /**
1788
+ * Represents the routing specification
1789
+ */
1790
+ export interface RoutingSpecDef1 {
1791
+ /**
1792
+ * Represents the name of the route
1793
+ */
1794
+ routeName: string;
1795
+ /**
1796
+ * Represents the switch to indicate, that this route is not related to the OData service
1797
+ */
1798
+ noOData?: boolean;
1799
+ /**
1800
+ * Represents the binding string to indicate, how the page should be bound relative to the predecessor page or absolute
1801
+ */
1802
+ binding?: string;
1803
+ /**
1804
+ * Represents the the title to be shown on the page
1805
+ */
1806
+ headerTitle?: string;
1807
+ /**
1808
+ * Represents the URL pointing to an icon, that will be shown in the navigation menu additional to the title to represent the page
1809
+ */
1810
+ typeImageUrl?: string;
1811
+ /**
1812
+ * Represents the switch to indicate, whether this route is reached via a 1:1 navigation or a 1:n navigation
1813
+ */
1814
+ noKey?: boolean;
1815
+ }
1816
+ /**
1817
+ * Represents the component to be loaded inside the canvas if sap.suite.ui.generic.template.Canvas is used as component name, and its settings
1818
+ */
1819
+ export interface ImplementingComponentDef1 {
1820
+ /**
1821
+ * Represents the name of the component to be loaded inside the canvas
1822
+ */
1823
+ componentName: string;
1824
+ /**
1825
+ * Represents a binding string to indicate, how the reuse component should be bound relative to the containing page or absolute
1826
+ */
1827
+ binding?: string;
1828
+ settings?: ComponentSettingDef;
1829
+ pages?: {
1830
+ [k: string]: PagesMap;
1831
+ };
1832
+ }
1833
+ /**
1834
+ * Represents specific attributes for Fiori Elements
1835
+ */
1836
+ export interface JSONSchemaForSAPFENamespace {
1837
+ [k: string]: unknown;
1838
+ }
1067
1839
  /**
1068
1840
  * Represents FLP specific attributes
1069
1841
  */
@@ -1071,7 +1843,7 @@ export interface JSONSchemaForSAPFLPNamespace {
1071
1843
  /**
1072
1844
  * Represents attributes format version. It is managed by namespace owner
1073
1845
  */
1074
- _version?: "1.1.0" | "1.2.0";
1846
+ _version?: "1.1.0" | "1.2.0" | "1.3.0";
1075
1847
  /**
1076
1848
  * Represents size of the tile
1077
1849
  */
@@ -1083,7 +1855,7 @@ export interface JSONSchemaForSAPFLPNamespace {
1083
1855
  /**
1084
1856
  * Represents configuration parameters of the FLP entry
1085
1857
  */
1086
- config: {
1858
+ config?: {
1087
1859
  /**
1088
1860
  * Represents the configuration key and values
1089
1861
  *
@@ -1094,6 +1866,19 @@ export interface JSONSchemaForSAPFLPNamespace {
1094
1866
  [k: string]: unknown;
1095
1867
  };
1096
1868
  };
1869
+ /**
1870
+ * Represents the original tile and target mapping which resulted in this app
1871
+ */
1872
+ origin?: {
1873
+ /**
1874
+ * Represents the original tile which resulted in this app
1875
+ */
1876
+ tileId?: string;
1877
+ /**
1878
+ * Represents the original target mapping which resulted in this app
1879
+ */
1880
+ targetMappingId?: string;
1881
+ };
1097
1882
  }
1098
1883
  /**
1099
1884
  * Represents OVP specific attributes
@@ -1102,7 +1887,7 @@ export interface JSONSchemaForSAPOVPNamespace {
1102
1887
  /**
1103
1888
  * Represents attributes format version. It is managed by namespace owner
1104
1889
  */
1105
- _version?: "1.1.0" | "1.2.0";
1890
+ _version?: "1.1.0" | "1.2.0" | "1.3.0";
1106
1891
  /**
1107
1892
  * Represents the name of global filter OData model, which contains entities definition that are relevant for global filters
1108
1893
  */
@@ -1111,15 +1896,59 @@ export interface JSONSchemaForSAPOVPNamespace {
1111
1896
  * Represents the entity to use as global filter in the smart filter bar control
1112
1897
  */
1113
1898
  globalFilterEntityType?: string;
1899
+ /**
1900
+ * Represents the entity set to use as global filter in the smart filter bar control
1901
+ */
1902
+ globalFilterEntitySet?: string;
1903
+ /**
1904
+ * Represents a switch to include basic search in the global filters
1905
+ */
1906
+ showBasicSearch?: boolean;
1907
+ /**
1908
+ * Represents a switch to disable the error page shown on load of overview page when no data is retreived from the backend
1909
+ */
1910
+ disableErrorPage?: boolean;
1911
+ /**
1912
+ * Represents a switch to activate smart variant management in the global filters
1913
+ */
1914
+ smartVariantRequired?: boolean;
1915
+ /**
1916
+ * Represents a switch to show smart filter bar in expanded or collapsed mode
1917
+ */
1918
+ bHeaderExpanded?: boolean;
1114
1919
  /**
1115
1920
  * Represents the layout of the card container
1116
1921
  */
1117
- containerLayout?: "easyScan" | "dashboard";
1922
+ containerLayout?: "fixed" | "resizable";
1923
+ /**
1924
+ * Represents a switch to Enable or disable Relative or Normal date formating in ovp application
1925
+ */
1926
+ showDateInRelativeFormat?: boolean;
1927
+ /**
1928
+ * Represents a switch to Enable or Disable the Flexibility of Table cards
1929
+ */
1930
+ disableTableCardFlexibility?: boolean;
1931
+ /**
1932
+ * Represents the switch to activate live update in the global filters, else manual update will be required
1933
+ */
1934
+ enableLiveFilter?: boolean;
1935
+ /**
1936
+ * Flag to enable/disable analytical parameter support for Smart filter bar
1937
+ */
1938
+ considerAnalyticalParameters?: boolean;
1939
+ /**
1940
+ * Time interval in minutes to auto refresh the card models
1941
+ */
1942
+ refreshIntervalInMinutes?: number;
1943
+ /**
1944
+ * Flag to enable/disable semantic date range control for Smart filter bar
1945
+ */
1946
+ useDateRangeType?: boolean;
1118
1947
  cards: {
1119
1948
  [k: string]: Card;
1120
1949
  };
1121
- dashboardLayout?: {
1122
- [k: string]: DashboardLayoutVariant;
1950
+ resizableLayout?: {
1951
+ [k: string]: ResizableLayoutVariant;
1123
1952
  };
1124
1953
  }
1125
1954
  /**
@@ -1157,14 +1986,22 @@ export interface CardSetting {
1157
1986
  * Represents the category of the card- used in the card header
1158
1987
  */
1159
1988
  category?: string;
1989
+ /**
1990
+ * Represents the user defined string in placeholder card
1991
+ */
1992
+ itemText?: string;
1160
1993
  /**
1161
1994
  * Represents language-dependent title of the card - used in the card header
1162
1995
  */
1163
- title?: string;
1996
+ title: string;
1164
1997
  /**
1165
1998
  * Represents language-dependent subtitle of the card - used in the card header
1166
1999
  */
1167
2000
  subTitle?: string;
2001
+ /**
2002
+ * Represents things like people, number of items
2003
+ */
2004
+ valueSelectionInfo?: string;
1168
2005
  /**
1169
2006
  * Represents the entity set that will be displayed in this card
1170
2007
  */
@@ -1215,6 +2052,18 @@ export interface CardSetting {
1215
2052
  * Represents the identification annotation path
1216
2053
  */
1217
2054
  identificationAnnotationPath?: string;
2055
+ /**
2056
+ * Represents the KPI annotation path
2057
+ */
2058
+ kpiAnnotationPath?: string;
2059
+ /**
2060
+ * Represents the selection presentation annotation path
2061
+ */
2062
+ selectionPresentationAnnotationPath?: string;
2063
+ /**
2064
+ * Represents the dynamic subtitle annotation path
2065
+ */
2066
+ dynamicSubtitleAnnotationPath?: string;
1218
2067
  /**
1219
2068
  * Represents the flag to indicate priority of number formatting over sap text
1220
2069
  */
@@ -1224,58 +2073,192 @@ export interface CardSetting {
1224
2073
  * Represents the cards for which authorization is required
1225
2074
  */
1226
2075
  requireAppAuthorization?: string;
1227
- [k: string]: unknown;
1228
- }
1229
- /**
1230
- * Represents the tab specific properties - properties that are passed to a particular tab in a card
1231
- */
1232
- export interface TabSetting {
2076
+ objectStreamCardsSettings?: ObjectStreamCardsSettingsDef;
1233
2077
  /**
1234
- * Represents the annotation path
2078
+ * Represents the flag to indicate the use of object number/smart field
1235
2079
  */
1236
- annotationPath?: string;
2080
+ enableLocaleCurrencyFormatting?: boolean;
1237
2081
  /**
1238
- * Represents the selection annotation path
2082
+ * Represents the configuration to alter the navigation mode in OVP Analytical Cards
1239
2083
  */
1240
- selectionAnnotationPath?: string;
2084
+ navigation?: "dataPointNav" | "chartNav" | "headerNav" | "noHeaderNav";
1241
2085
  /**
1242
- * Represents the chart annotation path
2086
+ * Represents a switch to Show or Hide Filters in Cards Headers in OVP application
1243
2087
  */
1244
- chartAnnotationPath?: string;
2088
+ showFilterInHeader?: boolean;
1245
2089
  /**
1246
- * Represents the presentation annotation path
2090
+ * Represents a switch to Show or Hide Sorting in Cards Headers in OVP application
1247
2091
  */
1248
- presentationAnnotationPath?: string;
2092
+ showSortingInHeader?: boolean;
1249
2093
  /**
1250
- * Represents the data point annotation path
2094
+ * Flag for enabling images in a condensed list card
1251
2095
  */
1252
- dataPointAnnotationPath?: string;
2096
+ imageSupported?: boolean;
1253
2097
  /**
1254
- * Represents the identification annotation path
2098
+ * Flag for show line item detail in list and table card
1255
2099
  */
1256
- identificationAnnotationPath?: string;
2100
+ showLineItemDetail?: boolean;
1257
2101
  /**
1258
- * Represents the drop down value to be shown
2102
+ * This property is responsible for showing and hiding text labels on the geo spots
1259
2103
  */
1260
- value?: string;
2104
+ showLabelText?: boolean;
2105
+ /**
2106
+ * This property is responsible for passing custom parameters present in the entity set to the navigating application
2107
+ */
2108
+ customParams?: string;
2109
+ /**
2110
+ * This property is responsible for setting specific chart settings
2111
+ */
2112
+ chartProperties?: {
2113
+ plotArea?: PlotAreaDef;
2114
+ timeAxis?: TimeAxisDef;
2115
+ };
2116
+ /**
2117
+ * Represents the configuration to customize the column stacked chart
2118
+ */
2119
+ colorPalette?:
2120
+ | {
2121
+ [k: string]: unknown;
2122
+ }[]
2123
+ | {
2124
+ [k: string]: unknown;
2125
+ };
1261
2126
  [k: string]: unknown;
1262
2127
  }
1263
2128
  /**
1264
- * Represents the dashboard layout variant
1265
- *
2129
+ * Represents the Object Stream properties - properties that are passed to the Object Stream cards
2130
+ */
2131
+ export interface ObjectStreamCardsSettingsDef {
2132
+ /**
2133
+ * Represents the flag to show first action in footer of the Quickview cards
2134
+ */
2135
+ showFirstActionInFooter?: boolean;
2136
+ /**
2137
+ * Represents the custom actions in the Quick View Cards
2138
+ *
2139
+ * @minItems 1
2140
+ */
2141
+ customActions?: [CustomActionsSetting, ...CustomActionsSetting[]];
2142
+ [k: string]: unknown;
2143
+ }
2144
+ /**
2145
+ * Represents the properties for the custom actions in the Quick View Cards
2146
+ */
2147
+ export interface CustomActionsSetting {
2148
+ /**
2149
+ * Text displayed for extended actions in Quick View
2150
+ */
2151
+ text?: string;
2152
+ /**
2153
+ * Name of the press handler for extended actions in Quick View
2154
+ */
2155
+ press?: string;
2156
+ /**
2157
+ * Position of extended actions in Quick View
2158
+ */
2159
+ position?: number;
2160
+ [k: string]: unknown;
2161
+ }
2162
+ /**
2163
+ * Plot area is a parent property which defines multiple other properties for smoothness and marker size
2164
+ */
2165
+ export interface PlotAreaDef {
2166
+ /**
2167
+ * Represents whether smoother curves are required or not
2168
+ */
2169
+ isSmoothed?: boolean;
2170
+ /**
2171
+ * Represents the size of the markers in scatter plots
2172
+ */
2173
+ markerSize?: number;
2174
+ /**
2175
+ * dataLabel is a parent property that defines other properties for type
2176
+ */
2177
+ dataLabel?: {
2178
+ /**
2179
+ * Defines whether to display percentage values or actual counts in the donut chart
2180
+ */
2181
+ type?: "value" | "percentage";
2182
+ };
2183
+ }
2184
+ /**
2185
+ * Represents the configuration to customize the time axis
2186
+ */
2187
+ export interface TimeAxisDef {
2188
+ levels?: LevelsDef;
2189
+ [k: string]: unknown;
2190
+ }
2191
+ /**
2192
+ * Represents the tab specific properties - properties that are passed to a particular tab in a card
2193
+ */
2194
+ export interface TabSetting {
2195
+ /**
2196
+ * Represents the annotation path
2197
+ */
2198
+ annotationPath?: string;
2199
+ /**
2200
+ * Represents the selection annotation path
2201
+ */
2202
+ selectionAnnotationPath?: string;
2203
+ /**
2204
+ * Represents the chart annotation path
2205
+ */
2206
+ chartAnnotationPath?: string;
2207
+ /**
2208
+ * Represents the presentation annotation path
2209
+ */
2210
+ presentationAnnotationPath?: string;
2211
+ /**
2212
+ * Represents the data point annotation path
2213
+ */
2214
+ dataPointAnnotationPath?: string;
2215
+ /**
2216
+ * Represents the identification annotation path
2217
+ */
2218
+ identificationAnnotationPath?: string;
2219
+ /**
2220
+ * Represents the dynamic subtitle annotation path
2221
+ */
2222
+ dynamicSubtitleAnnotationPath?: string;
2223
+ /**
2224
+ * Represents the drop down value to be shown
2225
+ */
2226
+ value?: string;
2227
+ /**
2228
+ * This property is responsible for setting specific chart settings
2229
+ */
2230
+ chartProperties?: {
2231
+ plotArea?: PlotAreaDef;
2232
+ timeAxis?: TimeAxisDef;
2233
+ };
2234
+ /**
2235
+ * Represents the configuration to customize the column stacked chart
2236
+ */
2237
+ colorPalette?:
2238
+ | {
2239
+ [k: string]: unknown;
2240
+ }[]
2241
+ | {
2242
+ [k: string]: unknown;
2243
+ };
2244
+ [k: string]: unknown;
2245
+ }
2246
+ /**
2247
+ * Represents the resizable layout variant
2248
+ *
1266
2249
  * This interface was referenced by `undefined`'s JSON-Schema definition
1267
2250
  * via the `patternProperty` "^cols_[0-9]+$".
1268
2251
  */
1269
- export interface DashboardLayoutVariant {
1270
- [k: string]: DashboardLayoutVariantCardProperties;
2252
+ export interface ResizableLayoutVariant {
2253
+ [k: string]: ResizableLayoutVariantCardProperties;
1271
2254
  }
1272
2255
  /**
1273
2256
  * Represents the card properties is a layout variant
1274
2257
  *
1275
- * This interface was referenced by `DashboardLayoutVariant`'s JSON-Schema definition
2258
+ * This interface was referenced by `ResizableLayoutVariant`'s JSON-Schema definition
1276
2259
  * via the `patternProperty` "^[a-zA-Z0-9_\.\-]+$".
1277
2260
  */
1278
- export interface DashboardLayoutVariantCardProperties {
2261
+ export interface ResizableLayoutVariantCardProperties {
1279
2262
  /**
1280
2263
  * Represents the grid column
1281
2264
  */
@@ -1317,6 +2300,10 @@ export interface JSONSchemaForSAPWDANamespace {
1317
2300
  * Represents SAP Screen Personas Flavor ID
1318
2301
  */
1319
2302
  flavorId?: string;
2303
+ /**
2304
+ * Indicates that WebDynpro Application requires Compatibility Mode, while uses legacy shell services. Possible values are true or false (default)
2305
+ */
2306
+ compatibilityMode?: boolean;
1320
2307
  }
1321
2308
  /**
1322
2309
  * Represents APF specific attributes
@@ -1325,7 +2312,7 @@ export interface JSONSchemaForSAPAPFNamespace {
1325
2312
  /**
1326
2313
  * Represents attributes format version. It is managed by namespace owner
1327
2314
  */
1328
- _version?: "1.1.0";
2315
+ _version?: "1.1.0" | "1.2.0";
1329
2316
  /**
1330
2317
  * Represents a switch to activate filter reduction so that filters in OData requests can be represented as ABAP select options
1331
2318
  */
@@ -1334,6 +2321,10 @@ export interface JSONSchemaForSAPAPFNamespace {
1334
2321
  * Represents a switch to activate LREP as the persistence for configurations and texts
1335
2322
  */
1336
2323
  activateLrep?: boolean;
2324
+ /**
2325
+ * Represents a switch to use HEAD-Requests instead of GET-Requests when fetching the XSRF-Security-Token
2326
+ */
2327
+ useHeadRequestForXsrfToken?: boolean;
1337
2328
  }
1338
2329
  /**
1339
2330
  * Represents Cloud Portal specific attributes
@@ -1358,6 +2349,47 @@ export interface JSONSchemaForSAPGUINamespace {
1358
2349
  */
1359
2350
  flavorId?: string;
1360
2351
  }
2352
+ /**
2353
+ * Represents Application Integration specific attributes
2354
+ */
2355
+ export interface JSONSchemaForSAPINTEGRATIONNamespace {
2356
+ /**
2357
+ * Represents attributes format version. It is managed by namespace owner
2358
+ */
2359
+ _version?: "1.0.0";
2360
+ /**
2361
+ * Reference to the desired URL Template
2362
+ */
2363
+ urlTemplateId: string;
2364
+ /**
2365
+ * Represents configuration parameters which will be used by Template Engine to compile URL Template
2366
+ */
2367
+ parameters: {
2368
+ /**
2369
+ * Represents the name of the desired parameter
2370
+ */
2371
+ key: string;
2372
+ /**
2373
+ * Represents the actual value of the desired parameter
2374
+ */
2375
+ value: string;
2376
+ [k: string]: unknown;
2377
+ }[];
2378
+ [k: string]: unknown;
2379
+ }
2380
+ /**
2381
+ * Represents WCF Application specific attributes
2382
+ */
2383
+ export interface JSONSchemaForSAPWCFNamespace {
2384
+ /**
2385
+ * Represents attributes format version. It is managed by namespace owner
2386
+ */
2387
+ _version?: "1.1.0";
2388
+ /**
2389
+ * Represents the target technical id for a WCF Application
2390
+ */
2391
+ "wcf-target-id": string;
2392
+ }
1361
2393
  /**
1362
2394
  * Represents specific attributes for Smart Business
1363
2395
  */
@@ -1398,3 +2430,655 @@ export interface DefiningRequest {
1398
2430
  */
1399
2431
  retrieveStreams?: boolean;
1400
2432
  }
2433
+ /**
2434
+ * Represents specific attributes for SAP CoPilot
2435
+ */
2436
+ export interface JSONSchemaForSAPCOPILOTNamespace {
2437
+ /**
2438
+ * Represents SAP.COPILOT attributes format version. It is managed by namespace owner
2439
+ */
2440
+ _version?: "1.0.0" | "1.1.0";
2441
+ /**
2442
+ * Settings for the context analysis features of SAP CoPilot
2443
+ */
2444
+ contextAnalysis?: {
2445
+ /**
2446
+ * Enable/Disable the ability for SAP CoPilot to analyze your Application Screens and add the found objects to a Collection
2447
+ */
2448
+ allowAddingObjectsFromAppScreenToCollection?: boolean;
2449
+ /**
2450
+ * A list of the whitelisted EntityTypes, prefixed with their namespace, that SAP CoPilot can display. The empty list is ignored, thus allowing all EntityTypes by default.
2451
+ */
2452
+ whitelistedEntityTypes?: string[];
2453
+ [k: string]: unknown;
2454
+ };
2455
+ /**
2456
+ * Settings for the Digital Assistant features of SAP CoPilot
2457
+ */
2458
+ digitalAssistant?: {
2459
+ /**
2460
+ * A list of Intent
2461
+ */
2462
+ intentDefinition?: {
2463
+ /**
2464
+ * This interface was referenced by `undefined`'s JSON-Schema definition
2465
+ * via the `patternProperty` "^[a-zA-Z0-9_\.\-]*$".
2466
+ */
2467
+ [k: string]: {
2468
+ /**
2469
+ * Represents the uri of the intent
2470
+ */
2471
+ uri?: string;
2472
+ /**
2473
+ * A list of the sap.app.dataSources used by the intent
2474
+ */
2475
+ dataSources?: string[];
2476
+ /**
2477
+ * Represents the uri of the translation file
2478
+ */
2479
+ i18n?: string;
2480
+ [k: string]: unknown;
2481
+ };
2482
+ };
2483
+ [k: string]: unknown;
2484
+ };
2485
+ [k: string]: unknown;
2486
+ }
2487
+ /**
2488
+ * Represents specific attributes for SAP.MAP
2489
+ */
2490
+ export interface JSONSchemaForSAPMAPNamespace {
2491
+ [k: string]: unknown;
2492
+ }
2493
+ /**
2494
+ * Represents specific attributes for SAP URL
2495
+ */
2496
+ export interface JSONSchemaForSAPURLNamespace {
2497
+ /**
2498
+ * Represents attributes format version. It is managed by namespace owner
2499
+ */
2500
+ _version?: "1.0.0";
2501
+ /**
2502
+ * Represents URI of an application
2503
+ */
2504
+ uri: string;
2505
+ }
2506
+ /**
2507
+ * Represents SFSF platform specific attributes
2508
+ */
2509
+ export interface JSONSchemaForSAPPLATFORMSFSFNamespace {
2510
+ /**
2511
+ * Represents attributes format version. It is managed by namespace owner
2512
+ */
2513
+ _version?: "1.0.0";
2514
+ /**
2515
+ * Represents the uri inside the SFSF app
2516
+ */
2517
+ uri?: string;
2518
+ /**
2519
+ * Represents the SFSF application name
2520
+ */
2521
+ appName: string;
2522
+ /**
2523
+ * Represents the version of the SFSF application
2524
+ */
2525
+ appVersion?: string;
2526
+ }
2527
+ /**
2528
+ * Represents cloud platform specific attributes
2529
+ */
2530
+ export interface JSONSchemaForSAPCLOUDNamespace {
2531
+ /**
2532
+ * Represents attributes format version. It is managed by namespace owner
2533
+ */
2534
+ _version?: "1.0.0" | "1.1.0";
2535
+ /**
2536
+ * Unique Business Service Identifier
2537
+ */
2538
+ service?: string;
2539
+ /**
2540
+ * Specify if the UI can be accessed from a different space than origin development space
2541
+ */
2542
+ public?: boolean;
2543
+ }
2544
+ /**
2545
+ * Represents list content attributes
2546
+ */
2547
+ export interface ContentType {
2548
+ data?: Data;
2549
+ item?: ContentTypeList;
2550
+ /**
2551
+ * Represents number of items
2552
+ */
2553
+ maxItems?: number | SimpleBinding;
2554
+ }
2555
+ /**
2556
+ * Represents request and response attributes
2557
+ */
2558
+ export interface Data {
2559
+ request?: Request;
2560
+ /**
2561
+ * The path from the JSON to be used as root
2562
+ */
2563
+ path?: string;
2564
+ /**
2565
+ * The data to be used directly. Without making requests.
2566
+ */
2567
+ json?:
2568
+ | {
2569
+ [k: string]: unknown;
2570
+ }
2571
+ | unknown[];
2572
+ service?: Service;
2573
+ /**
2574
+ * Represents interval in seconds, after which a new data request will be triggered.
2575
+ */
2576
+ updateInterval?: number | SimpleBinding;
2577
+ }
2578
+ /**
2579
+ * Represents request attributes
2580
+ */
2581
+ export interface Request {
2582
+ /**
2583
+ * The mode of the request
2584
+ */
2585
+ mode?: (("no-cors" | "same-origin" | "cors") | SimpleBinding) & string;
2586
+ /**
2587
+ * The URL to make the request to
2588
+ */
2589
+ url: string;
2590
+ /**
2591
+ * The HTTP method
2592
+ */
2593
+ method?: (("GET" | "POST") | SimpleBinding) & string;
2594
+ parameters?: Parameters;
2595
+ /**
2596
+ * Represents HTTP headers
2597
+ */
2598
+ headers?: {
2599
+ [k: string]: unknown;
2600
+ };
2601
+ /**
2602
+ * Indicates whether cross-site requests should be made using credentials.
2603
+ */
2604
+ withCredentials?: boolean | SimpleBinding;
2605
+ }
2606
+ /**
2607
+ * Represents the request parameters. If it is a POST request the parameters will be put as key/value pairs into the body of the request
2608
+ */
2609
+ export interface Parameters {
2610
+ [k: string]: unknown;
2611
+ }
2612
+ /**
2613
+ * The template for all items
2614
+ */
2615
+ export interface ContentTypeList {
2616
+ /**
2617
+ * The title of the item.
2618
+ */
2619
+ title?: Field | string;
2620
+ /**
2621
+ * The description of the item.
2622
+ */
2623
+ description?: Field | string;
2624
+ info?: {
2625
+ /**
2626
+ * The value of the field
2627
+ */
2628
+ value?: string;
2629
+ state?: State | SimpleBinding;
2630
+ };
2631
+ /**
2632
+ * The highlight of the item.
2633
+ */
2634
+ highlight?: (State | SimpleBinding) & string;
2635
+ icon?: Icon;
2636
+ /**
2637
+ * Defines actions that can be applied on the item.
2638
+ */
2639
+ actions?: Action[];
2640
+ }
2641
+ export interface Field {
2642
+ /**
2643
+ * Represents language-dependent label of the field
2644
+ */
2645
+ label?: string;
2646
+ /**
2647
+ * The value of the field
2648
+ */
2649
+ value?: string;
2650
+ }
2651
+ /**
2652
+ * Represents icon attributes
2653
+ */
2654
+ export interface Icon {
2655
+ /**
2656
+ * Represents icon name or source URL
2657
+ */
2658
+ src?: string;
2659
+ /**
2660
+ * Alternative text for the icon
2661
+ */
2662
+ alt?: string;
2663
+ /**
2664
+ * Represents the shape of the icon
2665
+ */
2666
+ shape?: (("Square" | "Circle") | SimpleBinding) & string;
2667
+ /**
2668
+ * Text inside icon
2669
+ */
2670
+ text?: string;
2671
+ /**
2672
+ * Background color of the icon
2673
+ */
2674
+ backgroundColor?: string;
2675
+ /**
2676
+ * Color of the icon
2677
+ */
2678
+ color?: string;
2679
+ }
2680
+ /**
2681
+ * Represents actions that can be applied on card elements
2682
+ */
2683
+ export interface Action {
2684
+ /**
2685
+ * The type of the action
2686
+ */
2687
+ type: ("Navigation" | SimpleBinding) & string;
2688
+ /**
2689
+ * Represents the state of the action
2690
+ */
2691
+ enabled?: boolean | SimpleBinding;
2692
+ service?: Service;
2693
+ /**
2694
+ * Represents the URL that will be used as navigation target if no service is provided
2695
+ */
2696
+ url?: string;
2697
+ parameters?: Parameters1;
2698
+ /**
2699
+ * Specifies where to open the 'url', if it is provided.
2700
+ */
2701
+ target?: (Target | SimpleBinding) & string;
2702
+ }
2703
+ /**
2704
+ * Represents parameters that are passed in the actions
2705
+ */
2706
+ export interface Parameters1 {
2707
+ [k: string]: unknown;
2708
+ }
2709
+ /**
2710
+ * Represents analytical content attributes
2711
+ */
2712
+ export interface ContentType1 {
2713
+ data?: Data;
2714
+ /**
2715
+ * Describes the type of the chart
2716
+ */
2717
+ chartType?: (("Line" | "StackedColumn" | "StackedBar" | "Donut") | SimpleBinding) & string;
2718
+ legend?: ContentTypeAnalytical;
2719
+ /**
2720
+ * Describes the plotArea properties
2721
+ */
2722
+ plotArea?: {
2723
+ dataLabel?: ContentTypeAnalytical1;
2724
+ categoryAxisText?: ContentTypeAnalytical2;
2725
+ valueAxisText?: ContentTypeAnalytical2;
2726
+ };
2727
+ /**
2728
+ * Represents title attributes
2729
+ */
2730
+ title?: {
2731
+ /**
2732
+ * Represents the visibility state of the title
2733
+ */
2734
+ visible?: boolean | SimpleBinding;
2735
+ /**
2736
+ * Represents title text
2737
+ */
2738
+ text?: string;
2739
+ /**
2740
+ * Represents the title alignment
2741
+ */
2742
+ alignment?: ("Left" | "Center" | "Right") | SimpleBinding;
2743
+ };
2744
+ /**
2745
+ * Represents the value set for measure axis
2746
+ */
2747
+ measureAxis?: string;
2748
+ /**
2749
+ * Represents the value set for dimension axis
2750
+ */
2751
+ dimensionAxis?: string;
2752
+ dimensions?: Field[];
2753
+ measures?: Field[];
2754
+ /**
2755
+ * Defines actions that can be applied on the content.
2756
+ */
2757
+ actions?: Action[];
2758
+ }
2759
+ /**
2760
+ * Represents chart legend attributes
2761
+ */
2762
+ export interface ContentTypeAnalytical {
2763
+ /**
2764
+ * Represent the visibility state of the legend
2765
+ */
2766
+ visible?: boolean | SimpleBinding;
2767
+ /**
2768
+ * Representation of where the legend will be positioned
2769
+ */
2770
+ position?: (("Top" | "Bottom" | "Left" | "Right") | SimpleBinding) & string;
2771
+ /**
2772
+ * Representation of how the legend will be aligned
2773
+ */
2774
+ alignment?: (("TopLeft" | "Center") | SimpleBinding) & string;
2775
+ }
2776
+ /**
2777
+ * Represents value attributes in the plot area
2778
+ */
2779
+ export interface ContentTypeAnalytical1 {
2780
+ /**
2781
+ * Represents the visibility state of the dataLabel
2782
+ */
2783
+ visible?: boolean | SimpleBinding;
2784
+ /**
2785
+ * Represents the visibility state of 'show total' indicator
2786
+ */
2787
+ showTotal?: boolean | SimpleBinding;
2788
+ }
2789
+ /**
2790
+ * Represents descriptive text of the axis
2791
+ */
2792
+ export interface ContentTypeAnalytical2 {
2793
+ /**
2794
+ * Represents the visibility state of the descriptive axis text
2795
+ */
2796
+ visible?: boolean | SimpleBinding;
2797
+ }
2798
+ /**
2799
+ * Represents time related content
2800
+ */
2801
+ export interface ContentType2 {
2802
+ data?: Data;
2803
+ item?: ContentTypeTimeline;
2804
+ /**
2805
+ * Represents number of items
2806
+ */
2807
+ maxItems?: number | SimpleBinding;
2808
+ }
2809
+ /**
2810
+ * Defines the timeline item
2811
+ */
2812
+ export interface ContentTypeTimeline {
2813
+ title?: Field1;
2814
+ description?: Field2;
2815
+ dateTime?: Field3;
2816
+ owner?: Field4;
2817
+ /**
2818
+ * The owner image of the timeline item.
2819
+ */
2820
+ ownerImage?: {
2821
+ value?: string;
2822
+ [k: string]: unknown;
2823
+ };
2824
+ icon?: Icon1;
2825
+ }
2826
+ /**
2827
+ * The title of the timeline item.
2828
+ */
2829
+ export interface Field1 {
2830
+ /**
2831
+ * Represents language-dependent label of the field
2832
+ */
2833
+ label?: string;
2834
+ /**
2835
+ * The value of the field
2836
+ */
2837
+ value?: string;
2838
+ }
2839
+ /**
2840
+ * The description of the timeline item.
2841
+ */
2842
+ export interface Field2 {
2843
+ /**
2844
+ * Represents language-dependent label of the field
2845
+ */
2846
+ label?: string;
2847
+ /**
2848
+ * The value of the field
2849
+ */
2850
+ value?: string;
2851
+ }
2852
+ /**
2853
+ * The dateTime value of the timeline item.
2854
+ */
2855
+ export interface Field3 {
2856
+ /**
2857
+ * Represents language-dependent label of the field
2858
+ */
2859
+ label?: string;
2860
+ /**
2861
+ * The value of the field
2862
+ */
2863
+ value?: string;
2864
+ }
2865
+ /**
2866
+ * The owner of the timeline item.
2867
+ */
2868
+ export interface Field4 {
2869
+ /**
2870
+ * Represents language-dependent label of the field
2871
+ */
2872
+ label?: string;
2873
+ /**
2874
+ * The value of the field
2875
+ */
2876
+ value?: string;
2877
+ }
2878
+ /**
2879
+ * Represents icon attributes
2880
+ */
2881
+ export interface Icon1 {
2882
+ /**
2883
+ * Represents icon name or source URL
2884
+ */
2885
+ src?: string;
2886
+ /**
2887
+ * Alternative text for the icon
2888
+ */
2889
+ alt?: string;
2890
+ shape?: (("Square" | "Circle") | SimpleBinding) & string;
2891
+ /**
2892
+ * Text inside icon
2893
+ */
2894
+ text?: string;
2895
+ /**
2896
+ * Background color of the icon
2897
+ */
2898
+ backgroundColor?: string;
2899
+ /**
2900
+ * Color of the icon
2901
+ */
2902
+ color?: string;
2903
+ }
2904
+ /**
2905
+ * Represents table content attributes
2906
+ */
2907
+ export interface ContentType3 {
2908
+ data?: Data;
2909
+ /**
2910
+ * The template for all rows
2911
+ */
2912
+ row?: {
2913
+ /**
2914
+ * Defines the columns attributes.
2915
+ */
2916
+ columns?: ContentTypeTable[];
2917
+ /**
2918
+ * Defines actions that can be applied on the item.
2919
+ */
2920
+ actions?: Action[];
2921
+ };
2922
+ /**
2923
+ * Represents number of items
2924
+ */
2925
+ maxItems?: number | SimpleBinding;
2926
+ }
2927
+ /**
2928
+ * Represents object item attributes
2929
+ */
2930
+ export interface ContentTypeTable {
2931
+ /**
2932
+ * Defines language-dependent title of the column.
2933
+ */
2934
+ title?: string;
2935
+ /**
2936
+ * Defines the width of the column.
2937
+ */
2938
+ width?: string;
2939
+ /**
2940
+ * Represents the text value of the column.
2941
+ */
2942
+ value?: string;
2943
+ icon?: Icon2;
2944
+ /**
2945
+ * Defines the state of the column.
2946
+ */
2947
+ state?: State | SimpleBinding;
2948
+ /**
2949
+ * Defines the URL string.
2950
+ */
2951
+ url?: string;
2952
+ /**
2953
+ * Specifies where to open the 'url', if it is provided.
2954
+ */
2955
+ target?: (Target | SimpleBinding) & string;
2956
+ identifier?: Identifier | SimpleBinding;
2957
+ progressIndicator?: ProgressIndicator;
2958
+ }
2959
+ /**
2960
+ * Represents icon attributes
2961
+ */
2962
+ export interface Icon2 {
2963
+ /**
2964
+ * Represents icon name or source URL
2965
+ */
2966
+ src?: string;
2967
+ /**
2968
+ * Alternative text for the icon
2969
+ */
2970
+ alt?: string;
2971
+ shape?: (("Square" | "Circle") | SimpleBinding) & string;
2972
+ /**
2973
+ * Text inside icon
2974
+ */
2975
+ text?: string;
2976
+ /**
2977
+ * Background color of the icon
2978
+ */
2979
+ backgroundColor?: string;
2980
+ /**
2981
+ * Color of the icon
2982
+ */
2983
+ color?: string;
2984
+ }
2985
+ /**
2986
+ * Represents progress indicator attributes
2987
+ */
2988
+ export interface ProgressIndicator {
2989
+ /**
2990
+ * Represents state color
2991
+ */
2992
+ state?: State | SimpleBinding;
2993
+ /**
2994
+ * Represents progress indicator percent value
2995
+ */
2996
+ percent?: number | SimpleBinding;
2997
+ /**
2998
+ * Represents progress indicator text
2999
+ */
3000
+ text?: string;
3001
+ }
3002
+ /**
3003
+ * Represents object content attributes
3004
+ */
3005
+ export interface ContentType4 {
3006
+ data?: Data;
3007
+ /**
3008
+ * Represents groups of information for an object
3009
+ */
3010
+ groups?: ContentTypeObject[];
3011
+ /**
3012
+ * Defines actions that can be applied on the content.
3013
+ */
3014
+ actions?: Action[];
3015
+ }
3016
+ /**
3017
+ * Represents a group of information for an object
3018
+ */
3019
+ export interface ContentTypeObject {
3020
+ /**
3021
+ * Defines language-dependent title of the object group.
3022
+ */
3023
+ title?: string;
3024
+ /**
3025
+ * Represents items of information.
3026
+ */
3027
+ items?: ContentTypeObject1[];
3028
+ }
3029
+ /**
3030
+ * Represents a single item of information. It can contain label, value and image
3031
+ */
3032
+ export interface ContentTypeObject1 {
3033
+ icon?: Icon3;
3034
+ /**
3035
+ * Defines the label of the item.
3036
+ */
3037
+ label?: string;
3038
+ /**
3039
+ * Represents the text, which is associated with the label.
3040
+ */
3041
+ value?: string;
3042
+ /**
3043
+ * Defines the type of the displayed information.
3044
+ */
3045
+ type?: (("phone" | "email" | "link" | "text") | SimpleBinding) & string;
3046
+ /**
3047
+ * Defines the URL string. Works only with items of type 'link'.
3048
+ */
3049
+ url?: string;
3050
+ /**
3051
+ * Specifies the target of the link - it works like the target property of the HTML 'a' tag. Works only with items of type 'link'.
3052
+ */
3053
+ target?: Target | SimpleBinding;
3054
+ /**
3055
+ * Represents the subject of the email. Works only with item of type 'email'.
3056
+ */
3057
+ emailSubject?: string;
3058
+ }
3059
+ /**
3060
+ * Represents icon attributes
3061
+ */
3062
+ export interface Icon3 {
3063
+ /**
3064
+ * Represents icon name or source URL
3065
+ */
3066
+ src?: string;
3067
+ /**
3068
+ * Alternative text for the icon
3069
+ */
3070
+ alt?: string;
3071
+ shape?: (("Square" | "Circle") | SimpleBinding) & string;
3072
+ /**
3073
+ * Text inside icon
3074
+ */
3075
+ text?: string;
3076
+ /**
3077
+ * Background color of the icon
3078
+ */
3079
+ backgroundColor?: string;
3080
+ /**
3081
+ * Color of the icon
3082
+ */
3083
+ color?: string;
3084
+ }