@ui5/manifest 1.49.2 → 1.50.1

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.
@@ -0,0 +1,3498 @@
1
+ /* eslint-disable */
2
+ /**
3
+ * This file was automatically generated by json-schema-to-typescript.
4
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
5
+ * and run json-schema-to-typescript to regenerate this file.
6
+ */
7
+
8
+ /**
9
+ * This interface was referenced by `undefined`'s JSON-Schema definition
10
+ * via the `patternProperty` "^[a-zA-Z0-9_\-]*$".
11
+ *
12
+ * This interface was referenced by `undefined`'s JSON-Schema definition
13
+ * via the `patternProperty` "^[a-zA-Z0-9_\-]*$".
14
+ *
15
+ * This interface was referenced by `undefined`'s JSON-Schema definition
16
+ * via the `patternProperty` "^[a-zA-Z0-9_\-]*$".
17
+ *
18
+ * This interface was referenced by `undefined`'s JSON-Schema definition
19
+ * via the `patternProperty` "^[a-zA-Z0-9_\-]*$".
20
+ *
21
+ * This interface was referenced by `undefined`'s JSON-Schema definition
22
+ * via the `patternProperty` "^[a-zA-Z0-9_\-]*$".
23
+ *
24
+ * This interface was referenced by `undefined`'s JSON-Schema definition
25
+ * via the `patternProperty` "^[a-zA-Z0-9_\-]*$".
26
+ *
27
+ * This interface was referenced by `undefined`'s JSON-Schema definition
28
+ * via the `patternProperty` "^[a-zA-Z0-9_\-]*$".
29
+ */
30
+ export type TerminologySetting =
31
+ | {
32
+ /**
33
+ * Represents the alternative for bundleUrl
34
+ */
35
+ bundleName: string;
36
+ /**
37
+ * Represents the list of supported locales
38
+ */
39
+ supportedLocales?: unknown[];
40
+ }
41
+ | {
42
+ /**
43
+ * Represents the URL for the resource bundle
44
+ */
45
+ bundleUrl: string;
46
+ /**
47
+ * Indicates whether url is relative to component (default) or manifest
48
+ */
49
+ bundleUrlRelativeTo?: "manifest" | "component";
50
+ /**
51
+ * Represents the list of supported locales
52
+ */
53
+ supportedLocales?: unknown[];
54
+ };
55
+ export type EnhanceWithSetting =
56
+ | {
57
+ /**
58
+ * Represents property url for model enhancement
59
+ */
60
+ bundleUrl: string;
61
+ /**
62
+ * Indicates whether url is relative to component (default) or manifest
63
+ */
64
+ bundleUrlRelativeTo?: "manifest" | "component";
65
+ /**
66
+ * Represents the fallback locale
67
+ */
68
+ fallbackLocale?: string;
69
+ /**
70
+ * Represents the list of supported locales
71
+ */
72
+ supportedLocales?: unknown[];
73
+ /**
74
+ * Represents terminologies with additional properties files
75
+ */
76
+ terminologies?: {
77
+ [k: string]: TerminologySetting;
78
+ };
79
+ }
80
+ | {
81
+ /**
82
+ * Represents the alternative for bundleUrl
83
+ */
84
+ bundleName: string;
85
+ /**
86
+ * Represents the fallback locale
87
+ */
88
+ fallbackLocale?: string;
89
+ /**
90
+ * Represents the list of supported locales
91
+ */
92
+ supportedLocales?: unknown[];
93
+ /**
94
+ * Represents terminologies with additional properties files
95
+ */
96
+ terminologies?: {
97
+ [k: string]: TerminologySetting;
98
+ };
99
+ };
100
+ export type EnhanceWithSetting1 =
101
+ | {
102
+ /**
103
+ * Represents property url for model enhancement
104
+ */
105
+ bundleUrl: string;
106
+ /**
107
+ * Indicates whether url is relative to component (default) or manifest
108
+ */
109
+ bundleUrlRelativeTo?: "manifest" | "component";
110
+ /**
111
+ * Represents the fallback locale
112
+ */
113
+ fallbackLocale?: string;
114
+ /**
115
+ * Represents the list of supported locales
116
+ */
117
+ supportedLocales?: unknown[];
118
+ /**
119
+ * Represents terminologies with additional properties files
120
+ */
121
+ terminologies?: {
122
+ [k: string]: TerminologySetting;
123
+ };
124
+ }
125
+ | {
126
+ /**
127
+ * Represents the alternative for bundleUrl
128
+ */
129
+ bundleName: string;
130
+ /**
131
+ * Represents the fallback locale
132
+ */
133
+ fallbackLocale?: string;
134
+ /**
135
+ * Represents the list of supported locales
136
+ */
137
+ supportedLocales?: unknown[];
138
+ /**
139
+ * Represents terminologies with additional properties files
140
+ */
141
+ terminologies?: {
142
+ [k: string]: TerminologySetting;
143
+ };
144
+ };
145
+ export type Version = string;
146
+ export type Tag = string[];
147
+ /**
148
+ * This interface was referenced by `undefined`'s JSON-Schema definition
149
+ * via the `patternProperty` "^[a-zA-Z0-9_\.\-]*$".
150
+ */
151
+ export type DataSource = DataSourceEnum | DataSourceCustom;
152
+ export type ObjectName = string;
153
+ export type ObjectType = "query" | "cdsprojectionview" | "view" | "inamodel";
154
+ /**
155
+ * Represents sapui5 attributes
156
+ */
157
+ export type JSONSchemaForSAPUI5Namespace = {
158
+ /**
159
+ * Represents SAPUI5 attributes format version. It is managed by namespace owner
160
+ */
161
+ _version?:
162
+ | "1.1.0"
163
+ | "1.2.0"
164
+ | "1.3.0"
165
+ | "1.4.0"
166
+ | "1.5.0"
167
+ | "1.6.0"
168
+ | "1.7.0"
169
+ | "1.8.0"
170
+ | "1.9.0"
171
+ | "1.10.0"
172
+ | "1.11.0"
173
+ | "1.12.0"
174
+ | "1.13.0"
175
+ | "1.14.0"
176
+ | "1.15.0"
177
+ | "1.16.0";
178
+ resources?: Resource;
179
+ /**
180
+ * Represents the explicit usage declaration for UI5 reuse components
181
+ */
182
+ componentUsages?: {
183
+ [k: string]: ComponentUsages;
184
+ };
185
+ /**
186
+ * 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
187
+ */
188
+ dependencies: {
189
+ /**
190
+ * Represents the minimum version of SAP UI5 that your component requires
191
+ */
192
+ minUI5Version: string;
193
+ /**
194
+ * Represents the id (namespace) of the libraries that should be loaded by UI5 Core to be used in your component
195
+ */
196
+ libs?: {
197
+ [k: string]: Lib;
198
+ };
199
+ /**
200
+ * Represents the id (namespace) of the components that should be loaded by UI5 Core to be used in your component
201
+ */
202
+ components?: {
203
+ [k: string]: Component;
204
+ };
205
+ };
206
+ /**
207
+ * Represents models which should be created/destroyed with the life-cycle of the component
208
+ */
209
+ models?: {
210
+ [k: string]: Model;
211
+ };
212
+ /**
213
+ * Represents relative path to the resource. Only relative path allowed, no '../'
214
+ */
215
+ resourceRoots?: {
216
+ [k: string]: ResourceRoot;
217
+ };
218
+ /**
219
+ * Represents the usage of validation handling by MessageManager for this component (enable/disable)
220
+ */
221
+ handleValidation?: boolean;
222
+ /**
223
+ * Represents the static configuration for components
224
+ */
225
+ config?: {
226
+ [k: string]: Config;
227
+ };
228
+ /**
229
+ * Represents the extension of an additional component
230
+ */
231
+ extends?: {
232
+ /**
233
+ * Represents the component name
234
+ */
235
+ component?: string;
236
+ /**
237
+ * Represents minimal version of the component
238
+ */
239
+ minVersion?: string;
240
+ /**
241
+ * Represents extensions of the component
242
+ */
243
+ extensions?: {
244
+ [k: string]: unknown;
245
+ };
246
+ };
247
+ /**
248
+ * Represents object with content density modes the app is supporting. Supported density modes are 'cozy' and 'compact'
249
+ */
250
+ contentDensities: {
251
+ /**
252
+ * Represents indicator whether compact mode is supported
253
+ */
254
+ compact: boolean;
255
+ /**
256
+ * Represents indicator whether cozy mode is supported
257
+ */
258
+ cozy: boolean;
259
+ };
260
+ /**
261
+ * Represents a name of the UI5 component
262
+ */
263
+ componentName?: string;
264
+ /**
265
+ * Enables the auto prefixing of IDs of ManagedObjects (e.g. Controls) which are created in context of the Component (e.g. createContent invocation)
266
+ */
267
+ autoPrefixId?: boolean;
268
+ /**
269
+ * Represents the identifier of an application variant. The value will be calculated and should not be set manually
270
+ */
271
+ appVariantId?: string;
272
+ /**
273
+ * Represents array of appVariantId hierarchy with origin layer and version, calculated attribute and filled automatically during variant merge
274
+ */
275
+ appVariantIdHierarchy?: {
276
+ /**
277
+ * Represents origin layer of the app variant id
278
+ */
279
+ layer: string;
280
+ /**
281
+ * Represents app variant id
282
+ */
283
+ appVariantId: string;
284
+ /**
285
+ * Represents version of the app variant id
286
+ */
287
+ version: string;
288
+ }[];
289
+ /**
290
+ * Represents a list of the services
291
+ */
292
+ services?: {
293
+ [k: string]: Service;
294
+ };
295
+ /**
296
+ * Represents UI5 library specific properties
297
+ */
298
+ library?: {
299
+ /**
300
+ * Setting to define i18n properties of a library. Can either be a boolean, string or object.
301
+ */
302
+ i18n?:
303
+ | boolean
304
+ | string
305
+ | {
306
+ /**
307
+ * Represents the URL for the resource bundle
308
+ */
309
+ bundleUrl: string;
310
+ /**
311
+ * Represents the list of supported locales
312
+ */
313
+ supportedLocales?: unknown[];
314
+ /**
315
+ * Represents the fallback locale
316
+ */
317
+ fallbackLocale?: string;
318
+ /**
319
+ * Represents terminologies with additional properties files
320
+ */
321
+ terminologies?: {
322
+ [k: string]: TerminologySetting;
323
+ };
324
+ /**
325
+ * Represents enhancement of UI5 resource bundle with additional properties files
326
+ */
327
+ enhanceWith?: EnhanceWithSetting3[];
328
+ }
329
+ | {
330
+ /**
331
+ * Represents the alternative for bundleUrl
332
+ */
333
+ bundleName: string;
334
+ /**
335
+ * Represents the fallback locale
336
+ */
337
+ fallbackLocale?: string;
338
+ /**
339
+ * Represents the list of supported locales
340
+ */
341
+ supportedLocales?: unknown[];
342
+ /**
343
+ * Represents terminologies with additional properties files
344
+ */
345
+ terminologies?: {
346
+ [k: string]: TerminologySetting;
347
+ };
348
+ /**
349
+ * Represents enhancement of UI5 resource bundle with additional properties files
350
+ */
351
+ enhanceWith?: EnhanceWithSetting4[];
352
+ };
353
+ /**
354
+ * Flag whether the library contains a CSS file or not.
355
+ */
356
+ css?: boolean | string;
357
+ /**
358
+ * Represents the content of a library. Content are controls, elements, types and interfaces.
359
+ */
360
+ content?: {
361
+ [k: string]: unknown;
362
+ };
363
+ };
364
+ /**
365
+ * Represents a list of UI5 shortcut commands
366
+ */
367
+ commands?: {
368
+ [k: string]: Command;
369
+ };
370
+ /**
371
+ * Represents an indicator whether app variant is flex extension point enabled
372
+ */
373
+ flexExtensionPointEnabled?: boolean;
374
+ [k: string]: unknown;
375
+ } & (
376
+ | {
377
+ /**
378
+ * Represents an Indicator whether an app is flex enabled
379
+ */
380
+ flexEnabled: true;
381
+ routing?: RoutingFlexEnabled;
382
+ rootView?: RootViewDefFlexEnabled;
383
+ [k: string]: unknown;
384
+ }
385
+ | {
386
+ /**
387
+ * Represents an Indicator whether an app is flex enabled
388
+ */
389
+ flexEnabled?: false;
390
+ routing?: Routing;
391
+ rootView?: RootViewDef;
392
+ [k: string]: unknown;
393
+ }
394
+ );
395
+ /**
396
+ * This interface was referenced by `undefined`'s JSON-Schema definition
397
+ * via the `patternProperty` "[\s\S]*".
398
+ */
399
+ export type Config =
400
+ | Config[]
401
+ | string
402
+ | boolean
403
+ | number
404
+ | {
405
+ [k: string]: unknown;
406
+ };
407
+ export type EnhanceWithSetting2 =
408
+ | {
409
+ /**
410
+ * Represents property url for model enhancement
411
+ */
412
+ bundleUrl: string;
413
+ /**
414
+ * Indicates whether url is relative to component (default) or manifest
415
+ */
416
+ bundleUrlRelativeTo?: "manifest" | "component";
417
+ /**
418
+ * Represents the fallback locale
419
+ */
420
+ fallbackLocale?: string;
421
+ /**
422
+ * Represents the list of supported locales
423
+ */
424
+ supportedLocales?: unknown[];
425
+ /**
426
+ * Represents terminologies with additional properties files
427
+ */
428
+ terminologies?: {
429
+ [k: string]: TerminologySetting;
430
+ };
431
+ }
432
+ | {
433
+ /**
434
+ * Represents the alternative for bundleUrl
435
+ */
436
+ bundleName: string;
437
+ /**
438
+ * Represents the fallback locale
439
+ */
440
+ fallbackLocale?: string;
441
+ /**
442
+ * Represents the list of supported locales
443
+ */
444
+ supportedLocales?: unknown[];
445
+ /**
446
+ * Represents terminologies with additional properties files
447
+ */
448
+ terminologies?: {
449
+ [k: string]: TerminologySetting;
450
+ };
451
+ };
452
+ /**
453
+ * This interface was referenced by `undefined`'s JSON-Schema definition
454
+ * via the `patternProperty` "^[a-zA-Z0-9_\.\-]*$".
455
+ */
456
+ export type ResourceRoot = string;
457
+ export type EnhanceWithSetting3 =
458
+ | {
459
+ /**
460
+ * Represents property url for model enhancement
461
+ */
462
+ bundleUrl: string;
463
+ /**
464
+ * Indicates whether url is relative to component (default) or manifest
465
+ */
466
+ bundleUrlRelativeTo?: "manifest" | "component";
467
+ /**
468
+ * Represents the fallback locale
469
+ */
470
+ fallbackLocale?: string;
471
+ /**
472
+ * Represents the list of supported locales
473
+ */
474
+ supportedLocales?: unknown[];
475
+ /**
476
+ * Represents terminologies with additional properties files
477
+ */
478
+ terminologies?: {
479
+ [k: string]: TerminologySetting;
480
+ };
481
+ }
482
+ | {
483
+ /**
484
+ * Represents the alternative for bundleUrl
485
+ */
486
+ bundleName: string;
487
+ /**
488
+ * Represents the fallback locale
489
+ */
490
+ fallbackLocale?: string;
491
+ /**
492
+ * Represents the list of supported locales
493
+ */
494
+ supportedLocales?: unknown[];
495
+ /**
496
+ * Represents terminologies with additional properties files
497
+ */
498
+ terminologies?: {
499
+ [k: string]: TerminologySetting;
500
+ };
501
+ };
502
+ export type EnhanceWithSetting4 =
503
+ | {
504
+ /**
505
+ * Represents property url for model enhancement
506
+ */
507
+ bundleUrl: string;
508
+ /**
509
+ * Indicates whether url is relative to component (default) or manifest
510
+ */
511
+ bundleUrlRelativeTo?: "manifest" | "component";
512
+ /**
513
+ * Represents the fallback locale
514
+ */
515
+ fallbackLocale?: string;
516
+ /**
517
+ * Represents the list of supported locales
518
+ */
519
+ supportedLocales?: unknown[];
520
+ /**
521
+ * Represents terminologies with additional properties files
522
+ */
523
+ terminologies?: {
524
+ [k: string]: TerminologySetting;
525
+ };
526
+ }
527
+ | {
528
+ /**
529
+ * Represents the alternative for bundleUrl
530
+ */
531
+ bundleName: string;
532
+ /**
533
+ * Represents the fallback locale
534
+ */
535
+ fallbackLocale?: string;
536
+ /**
537
+ * Represents the list of supported locales
538
+ */
539
+ supportedLocales?: unknown[];
540
+ /**
541
+ * Represents terminologies with additional properties files
542
+ */
543
+ terminologies?: {
544
+ [k: string]: TerminologySetting;
545
+ };
546
+ };
547
+ /**
548
+ * Represents the definition of each route
549
+ */
550
+ export type Route = RouteWithoutName & {
551
+ /**
552
+ * Represents the name of the route
553
+ */
554
+ name: string;
555
+ [k: string]: unknown;
556
+ };
557
+ /**
558
+ * Represents the root view definition being either the name of the view or the view definition object
559
+ */
560
+ export type RootViewDef =
561
+ | string
562
+ | {
563
+ /**
564
+ * Represents the name of the view
565
+ */
566
+ viewName: string;
567
+ /**
568
+ * Represents the type of the view. Possible Values: XML, JSON, JS, HTML, Template
569
+ */
570
+ type?: "XML" | "JSON" | "JS" | "HTML" | "Template";
571
+ /**
572
+ * Represents the id of the view
573
+ */
574
+ id?: string;
575
+ /**
576
+ * Configure the targets for asynchronous loading
577
+ */
578
+ async?: boolean;
579
+ [k: string]: unknown;
580
+ };
581
+ /**
582
+ * Represents a binding string to indicate, how the reuse component should be bound relative to the containing page or absolute
583
+ */
584
+ export type ComponentBindingDef = string;
585
+ /**
586
+ * Represents the card default grid size in columns and rows
587
+ */
588
+ export type DefaultSpanDef =
589
+ | {
590
+ /**
591
+ * Represents the number of the number of grid columns
592
+ */
593
+ cols: number;
594
+ /**
595
+ * Represents the number of the number of grid rows
596
+ */
597
+ rows: number;
598
+ /**
599
+ * Represents if user wants to show only header part of card in resizable layout
600
+ */
601
+ showOnlyHeader?: boolean;
602
+ /**
603
+ * 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)
604
+ */
605
+ minimumTitleRow?: number;
606
+ /**
607
+ * 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)
608
+ */
609
+ minimumSubTitleRow?: number;
610
+ }
611
+ | "auto";
612
+ /**
613
+ * Plot area is a parent property which defines multiple other properties for smoothness and marker size
614
+ */
615
+ export type LevelsDef = unknown[];
616
+ /**
617
+ * Represents general card attributes
618
+ */
619
+ export type JSONSchemaForSAPCARDNamespace = {
620
+ [k: string]: unknown;
621
+ };
622
+ /**
623
+ * The version number of the schema in major.minor.patch format.
624
+ */
625
+ export type Semanticversion = string;
626
+
627
+ export interface SAPJSONSchemaForWebApplicationManifestFile {
628
+ /**
629
+ * Represents Application Descriptor format version. It is managed by schema owner
630
+ */
631
+ _version:
632
+ | "1.1.0"
633
+ | "1.2.0"
634
+ | "1.3.0"
635
+ | "1.4.0"
636
+ | "1.5.0"
637
+ | "1.6.0"
638
+ | "1.7.0"
639
+ | "1.8.0"
640
+ | "1.9.0"
641
+ | "1.10.0"
642
+ | "1.11.0"
643
+ | "1.12.0"
644
+ | "1.13.0"
645
+ | "1.14.0"
646
+ | "1.15.0"
647
+ | "1.16.0"
648
+ | "1.17.0"
649
+ | "1.18.0"
650
+ | "1.19.0"
651
+ | "1.20.0"
652
+ | "1.21.0"
653
+ | "1.22.0"
654
+ | "1.23.0"
655
+ | "1.24.0"
656
+ | "1.25.0"
657
+ | "1.26.0"
658
+ | "1.27.0"
659
+ | "1.28.0"
660
+ | "1.29.0"
661
+ | "1.30.0"
662
+ | "1.31.0"
663
+ | "1.32.0"
664
+ | "1.33.0"
665
+ | "1.34.0"
666
+ | "1.35.0"
667
+ | "1.36.0"
668
+ | "1.37.0"
669
+ | "1.38.0"
670
+ | "1.39.0"
671
+ | "1.40.0"
672
+ | "1.41.0"
673
+ | "1.42.0"
674
+ | "1.43.0"
675
+ | "1.44.0"
676
+ | "1.45.0"
677
+ | "1.46.0"
678
+ | "1.47.0"
679
+ | "1.48.0"
680
+ | "1.49.0"
681
+ | "1.50.0"
682
+ | "1.50.1";
683
+ /**
684
+ * Represents the URL that the developer would prefer the user agent load when the user launches the web application
685
+ */
686
+ start_url?: string;
687
+ "sap.app": JSONSchemaForSAPAPPNamespace;
688
+ "sap.ui": JSONSchemaForSAPUINamespace;
689
+ "sap.ui5"?: JSONSchemaForSAPUI5Namespace;
690
+ "sap.platform.abap"?: JSONSchemaForSAPPLATFORMABAPNamespace;
691
+ "sap.platform.hcp"?: JSONSchemaForSAPPLATFORMHCPNamespace;
692
+ "sap.platform.cf"?: JSONSchemaForSAPPLATFORMCFNamespace;
693
+ "sap.platform.mobilecards"?: JSONSchemaForSAPPLATFORMMOBILECARDSNamespace;
694
+ "sap.fiori"?: JSONSchemaForSAPFIORINamespace;
695
+ "sap.ui.generic.app"?: JSONSchemaForSAPUIGENERICAPPNamespace;
696
+ "sap.fe"?: JSONSchemaForSAPFENamespace;
697
+ "sap.flp"?: JSONSchemaForSAPFLPNamespace;
698
+ "sap.ovp"?: JSONSchemaForSAPOVPNamespace;
699
+ "sap.insights"?: JSONSchemaForSAPInsightsNamespace;
700
+ "sap.wda"?: JSONSchemaForSAPWDANamespace;
701
+ "sap.apf"?: JSONSchemaForSAPAPFNamespace;
702
+ "sap.cloud.portal"?: JSONSchemaForSAPCLOUDPORTALNamespace;
703
+ "sap.gui"?: JSONSchemaForSAPGUINamespace;
704
+ "sap.integration"?: JSONSchemaForSAPINTEGRATIONNamespace;
705
+ "sap.wcf"?: JSONSchemaForSAPWCFNamespace;
706
+ "sap.ui.smartbusiness.app"?: JSONSchemaForSAPUISMARTBUSINESSAPPNamespace;
707
+ "sap.mobile"?: JSONSchemaForSAPMOBILENamespace;
708
+ "sap.copilot"?: JSONSchemaForSAPCOPILOTNamespace;
709
+ "sap.map"?: JSONSchemaForSAPMAPNamespace;
710
+ "sap.url"?: JSONSchemaForSAPURLNamespace;
711
+ "sap.platform.sfsf"?: JSONSchemaForSAPPLATFORMSFSFNamespace;
712
+ "sap.cloud"?: JSONSchemaForSAPCLOUDNamespace;
713
+ "sap.card"?: JSONSchemaForSAPCARDNamespace;
714
+ "sap.package"?: JSONSchemaForSAPPACKAGENamespace;
715
+ "sap.artifact"?: JSONSchemaForSAPARTIFACTNamespace;
716
+ }
717
+ /**
718
+ * Represents general application attributes
719
+ */
720
+ export interface JSONSchemaForSAPAPPNamespace {
721
+ /**
722
+ * Application attributes format version. It is managed by namespace owner
723
+ */
724
+ _version?:
725
+ | "1.1.0"
726
+ | "1.2.0"
727
+ | "1.3.0"
728
+ | "1.4.0"
729
+ | "1.5.0"
730
+ | "1.6.0"
731
+ | "1.7.0"
732
+ | "1.8.0"
733
+ | "1.9.0"
734
+ | "1.10.0"
735
+ | "1.11.0"
736
+ | "1.12.0"
737
+ | "1.13.0"
738
+ | "1.14.0"
739
+ | "1.15.0"
740
+ | "1.16.0"
741
+ | "1.17.0"
742
+ | "1.18.0";
743
+ /**
744
+ * Represents the template from which the app was generated
745
+ */
746
+ sourceTemplate?: {
747
+ /**
748
+ * Represents id of the template from which the app was generated
749
+ */
750
+ id: string;
751
+ /**
752
+ * Represents the version of the template from which the app was generated
753
+ */
754
+ version: string;
755
+ /**
756
+ * Represents an Id generated by SAP Fiori tools
757
+ */
758
+ toolsId?: string;
759
+ [k: string]: unknown;
760
+ };
761
+ /**
762
+ * Represents mandatory unique app identifier which must correspond to component 'id/namespace'
763
+ */
764
+ id: string;
765
+ /**
766
+ * Represents type of an application and can be application or component or library
767
+ */
768
+ type: "application" | "component" | "library" | "card";
769
+ /**
770
+ * Represents path inside the app to the properties file containing text symbols for the Descriptor or properties file specific settings (including supportedLocales, fallbackLocale, terminologies and enhanceWith)
771
+ */
772
+ i18n?:
773
+ | string
774
+ | {
775
+ /**
776
+ * Represents the alternative for bundleUrl
777
+ */
778
+ bundleName: string;
779
+ /**
780
+ * Represents the fallback locale
781
+ */
782
+ fallbackLocale?: string;
783
+ /**
784
+ * Represents the list of supported locales
785
+ */
786
+ supportedLocales?: unknown[];
787
+ /**
788
+ * Represents terminologies with additional properties files
789
+ */
790
+ terminologies?: {
791
+ [k: string]: TerminologySetting;
792
+ };
793
+ /**
794
+ * Represents enhancement of UI5 resource model with additional properties files
795
+ */
796
+ enhanceWith?: EnhanceWithSetting[];
797
+ }
798
+ | {
799
+ /**
800
+ * Represents the URL for the resource bundle
801
+ */
802
+ bundleUrl: string;
803
+ /**
804
+ * Indicates whether url is relative to component (default) or manifest
805
+ */
806
+ bundleUrlRelativeTo?: "manifest" | "component";
807
+ /**
808
+ * Represents the list of supported locales
809
+ */
810
+ supportedLocales?: unknown[];
811
+ /**
812
+ * Represents the fallback locale
813
+ */
814
+ fallbackLocale?: string;
815
+ /**
816
+ * Represents terminologies with additional properties files
817
+ */
818
+ terminologies?: {
819
+ [k: string]: TerminologySetting;
820
+ };
821
+ /**
822
+ * Represents enhancement of UI5 resource model with additional properties files
823
+ */
824
+ enhanceWith?: EnhanceWithSetting1[];
825
+ };
826
+ /**
827
+ * Represents mandatory version of the app
828
+ */
829
+ applicationVersion: {
830
+ version: Version;
831
+ [k: string]: unknown;
832
+ };
833
+ /**
834
+ * Represents array of relative paths to the nested manifest.json's (mandatory if it contains nested 'manifest.json')
835
+ */
836
+ embeds?: string[];
837
+ /**
838
+ * Represents relative path back to the manifest.json of an embedding component or library (mandatory for nested 'manifest.json')
839
+ */
840
+ embeddedBy?: string;
841
+ /**
842
+ * Represents a title (mandatory); to make this property language dependent (recommended), use a key in double curly brackets '{{key}}'
843
+ */
844
+ title: string;
845
+ /**
846
+ * Represents a subtitle to the title; to make this property language dependent (recommended), use a key in double curly brackets '{{key}}'
847
+ */
848
+ subTitle?: string;
849
+ /**
850
+ * Represents a shorter version of the title; to make this property language dependent (recommended), use a key in double curly brackets '{{key}}'
851
+ */
852
+ shortTitle?: string;
853
+ /**
854
+ * Represents additional information to the title; to make this property language dependent (recommended), use a key in double curly brackets '{{key}}'
855
+ */
856
+ info?: string;
857
+ /**
858
+ * Represents a description; to make this property language dependent (recommended), use a key in double curly brackets '{{key}}'
859
+ */
860
+ description?: string;
861
+ /**
862
+ * Represents array of keywords
863
+ */
864
+ tags?: {
865
+ keywords: Tag;
866
+ technicalAttributes?: string[];
867
+ [k: string]: unknown;
868
+ };
869
+ /**
870
+ * Represents application component hierarchy
871
+ */
872
+ ach?: string;
873
+ /**
874
+ * Represents used data sources with a unique key/alias
875
+ */
876
+ dataSources?: {
877
+ [k: string]: DataSource;
878
+ };
879
+ /**
880
+ * Represents array of directly used CDS views, which only to be added if directly used via INA protocol and not if used via OData service
881
+ */
882
+ cdsViews?: string[];
883
+ /**
884
+ * Represents reference to a file (naming convention is resources.json) which contains list with all resources which the app needs
885
+ */
886
+ resources?: "resources.json";
887
+ /**
888
+ * Represents a system alias
889
+ */
890
+ destination?: {
891
+ /**
892
+ * Represents an alias for the system
893
+ */
894
+ name: string;
895
+ };
896
+ /**
897
+ * Represents a collection of directly used open source libs (not when used via UI5 capsulation)
898
+ */
899
+ openSourceComponents?: OpenSource[];
900
+ /**
901
+ * Represents the name of the provider which owns the application
902
+ */
903
+ provider?: "sfsf";
904
+ /**
905
+ * Represents indicator whether the app is running offline. Possible values are true or false (default)
906
+ */
907
+ offline?: boolean;
908
+ /**
909
+ * Represents cross navigation for inbound and outbound targets
910
+ */
911
+ crossNavigation?: {
912
+ /**
913
+ * Represents scopes of a site
914
+ */
915
+ scopes?: {
916
+ /**
917
+ * Represents unique id of the site
918
+ *
919
+ * This interface was referenced by `undefined`'s JSON-Schema definition
920
+ * via the `patternProperty` "^[a-zA-Z0-9_\.\-]+$".
921
+ */
922
+ [k: string]: {
923
+ value: string;
924
+ [k: string]: unknown;
925
+ };
926
+ };
927
+ inbounds: Inbound;
928
+ outbounds?: Outbound;
929
+ [k: string]: unknown;
930
+ };
931
+ }
932
+ export interface DataSourceEnum {
933
+ /**
934
+ * Represents uri of the data source
935
+ */
936
+ uri: string;
937
+ /**
938
+ * Represents type of the data source. The supported types are OData, ODataAnnotation, INA, XML, JSON, FHIR, WebSocket, http
939
+ */
940
+ type?: "OData" | "ODataAnnotation" | "INA" | "XML" | "JSON" | "FHIR" | "WebSocket" | "http";
941
+ settings?: Setting;
942
+ customType?: false;
943
+ }
944
+ /**
945
+ * Represents data source type specific attributes (key, value pairs)
946
+ */
947
+ export interface Setting {
948
+ /**
949
+ * Represents version of OData: 2.0 is default
950
+ */
951
+ odataVersion?: "2.0" | "4.0";
952
+ /**
953
+ * Represents path to local meta data document or annotation uri
954
+ */
955
+ localUri?: string;
956
+ /**
957
+ * Represents array of annotation which references an existing data source of type ODataAnnotation
958
+ */
959
+ annotations?: string[];
960
+ /**
961
+ * Indicates that the client is unwilling to accept a response whose age is greater than the number of seconds specified in this field
962
+ */
963
+ maxAge?: number;
964
+ /**
965
+ * Dictionary of (catalog) objects offered by the datasource
966
+ */
967
+ objects?: {
968
+ /**
969
+ * A (catalog) object of an InA DataSource
970
+ */
971
+ [k: string]: {
972
+ objectName: ObjectName;
973
+ objectType: ObjectType;
974
+ packageName?: string;
975
+ schemaName?: string;
976
+ };
977
+ };
978
+ [k: string]: unknown;
979
+ }
980
+ export interface DataSourceCustom {
981
+ /**
982
+ * Represents the uri of the data source, should always be given in lower case
983
+ */
984
+ uri: string;
985
+ /**
986
+ * Represents type of the data source. The supported types are OData, ODataAnnotation, INA, XML, JSON, FHIR, WebSocket, http
987
+ */
988
+ type?: string;
989
+ settings?: Setting1;
990
+ /**
991
+ * Represents a custom data source type flag. So the type can be any string if its true, and only enum values if false
992
+ */
993
+ customType: true;
994
+ }
995
+ /**
996
+ * Represents data source type specific attributes (key, value pairs)
997
+ */
998
+ export interface Setting1 {
999
+ /**
1000
+ * Represents version of OData: 2.0 is default
1001
+ */
1002
+ odataVersion?: "2.0" | "4.0";
1003
+ /**
1004
+ * Represents path to local meta data document or annotation uri
1005
+ */
1006
+ localUri?: string;
1007
+ /**
1008
+ * Represents array of annotation which references an existing data source of type ODataAnnotation
1009
+ */
1010
+ annotations?: string[];
1011
+ /**
1012
+ * Indicates that the client is unwilling to accept a response whose age is greater than the number of seconds specified in this field
1013
+ */
1014
+ maxAge?: number;
1015
+ /**
1016
+ * Dictionary of (catalog) objects offered by the datasource
1017
+ */
1018
+ objects?: {
1019
+ /**
1020
+ * A (catalog) object of an InA DataSource
1021
+ */
1022
+ [k: string]: {
1023
+ objectName: ObjectName;
1024
+ objectType: ObjectType;
1025
+ packageName?: string;
1026
+ schemaName?: string;
1027
+ };
1028
+ };
1029
+ [k: string]: unknown;
1030
+ }
1031
+ export interface OpenSource {
1032
+ /**
1033
+ * Represents a name of the open source as appears on the web
1034
+ */
1035
+ name: string;
1036
+ /**
1037
+ * Represents a version of the open source (if part of app, version must be specified, if part of UI5 dist layer, version is empty)
1038
+ */
1039
+ version?: string;
1040
+ /**
1041
+ * Indicates, whether it is part of the app or not
1042
+ */
1043
+ packagedWithMySelf?: boolean;
1044
+ }
1045
+ /**
1046
+ * Represents cross navigation for inbound target
1047
+ */
1048
+ export interface Inbound {
1049
+ /**
1050
+ * This interface was referenced by `Inbound`'s JSON-Schema definition
1051
+ * via the `patternProperty` "^[\w\.\-]+$".
1052
+ */
1053
+ [k: string]: {
1054
+ /**
1055
+ * Represents semantic object
1056
+ */
1057
+ semanticObject: string;
1058
+ /**
1059
+ * Represents action an the semantic object
1060
+ */
1061
+ action: string;
1062
+ /**
1063
+ * Indicates to not expose this inbound as a tile or link
1064
+ */
1065
+ hideLauncher?: boolean;
1066
+ /**
1067
+ * Represents icon
1068
+ */
1069
+ icon?: string;
1070
+ /**
1071
+ * Represents a title; to make this property language dependent (recommended), use a key in double curly brackets '{{key}}'
1072
+ */
1073
+ title?: string;
1074
+ /**
1075
+ * Represents a subtitle; to make this property language dependent (recommended), use a key in double curly brackets '{{key}}'
1076
+ */
1077
+ subTitle?: string;
1078
+ /**
1079
+ * Represents a shorter version of the title; to make this property language dependent (recommended), use a key in double curly brackets '{{key}}'
1080
+ */
1081
+ shortTitle?: string;
1082
+ /**
1083
+ * Represents additional information to the title; to make this property language dependent (recommended), use a key in double curly brackets '{{key}}'
1084
+ */
1085
+ info?: string;
1086
+ /**
1087
+ * Represents the display mode of the tile
1088
+ */
1089
+ displayMode?: "ContentMode" | "HeaderMode";
1090
+ /**
1091
+ * Represents data source
1092
+ */
1093
+ indicatorDataSource?: {
1094
+ dataSource: string;
1095
+ path: string;
1096
+ /**
1097
+ * Represents refresh interval
1098
+ */
1099
+ refresh?: number;
1100
+ [k: string]: unknown;
1101
+ };
1102
+ deviceTypes?: DeviceType;
1103
+ signature?: SignatureDef;
1104
+ };
1105
+ }
1106
+ /**
1107
+ * Represents device types for which application is developed
1108
+ */
1109
+ export interface DeviceType {
1110
+ /**
1111
+ * Represents indicator whether desktop device is supported, default true
1112
+ */
1113
+ desktop?: boolean;
1114
+ /**
1115
+ * Represents indicator whether tablet device is supported, default true
1116
+ */
1117
+ tablet?: boolean;
1118
+ /**
1119
+ * Represents indicator whether phone device is supported, default true
1120
+ */
1121
+ phone?: boolean;
1122
+ }
1123
+ /**
1124
+ * Represents signature for inbound targets
1125
+ */
1126
+ export interface SignatureDef {
1127
+ parameters: {
1128
+ /**
1129
+ * This interface was referenced by `undefined`'s JSON-Schema definition
1130
+ * via the `patternProperty` "^[\w\.\-\/]+$".
1131
+ */
1132
+ [k: string]: {
1133
+ /**
1134
+ * Represents a default Value
1135
+ */
1136
+ defaultValue?:
1137
+ | {
1138
+ format?: "plain";
1139
+ value?: string;
1140
+ [k: string]: unknown;
1141
+ }
1142
+ | {
1143
+ format?: "reference";
1144
+ value?: string;
1145
+ [k: string]: unknown;
1146
+ }
1147
+ | {
1148
+ format?: null;
1149
+ value?: string;
1150
+ [k: string]: unknown;
1151
+ };
1152
+ /**
1153
+ * Represents a filter , only if input parameter matches filter
1154
+ */
1155
+ filter?: {
1156
+ /**
1157
+ * Represents a depending on format either a verbatim filter value, a regular expression or a reference
1158
+ */
1159
+ value: string;
1160
+ /**
1161
+ * Indicates how 'value' is to be interpreted: ('plain': the actual value must match the 'value' property directly| 'regexp': the 'value' represents a regexp which must be present in the actual value| 'reference' : the 'value' represents a reference to e.g. a UserDefault parameter (e.g. 'UserDefault.CostCenter'), the resolved parameter value is then directly compared with the actual value)
1162
+ */
1163
+ format?: "plain" | "regexp" | "reference";
1164
+ };
1165
+ /**
1166
+ * Represents a value to be used when creating a tile intent for this inbound
1167
+ */
1168
+ launcherValue?: {
1169
+ value?: string | string[];
1170
+ /**
1171
+ * 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
1172
+ */
1173
+ format?: "plain" | "array";
1174
+ /**
1175
+ * DEPRECATED - Indicates the administrator should be prompted to supply a value when creating a tile
1176
+ */
1177
+ prompt?: boolean;
1178
+ };
1179
+ required?: boolean;
1180
+ /**
1181
+ * Represents the parameter name in legacy ABAP application, e.g. 'RF05L-BUKRS' for parameter 'CompanyCode'
1182
+ */
1183
+ renameTo?: string;
1184
+ };
1185
+ };
1186
+ /**
1187
+ * Indicates how additional parameters to the declared signature are treated: ('ignored': parameters are not passed on to application | 'allowed': parameters are passed on to application | 'notallowed': additional parameters are not allowed)
1188
+ */
1189
+ additionalParameters: "ignored" | "allowed" | "notallowed";
1190
+ }
1191
+ /**
1192
+ * Describes intents that can be triggered from the application to navigate
1193
+ */
1194
+ export interface Outbound {
1195
+ /**
1196
+ * This interface was referenced by `Outbound`'s JSON-Schema definition
1197
+ * via the `patternProperty` "^[\w\.\-]+$".
1198
+ */
1199
+ [k: string]: {
1200
+ /**
1201
+ * Represents a business entity (e.g., 'Employee')
1202
+ */
1203
+ semanticObject: string;
1204
+ /**
1205
+ * Represents the action to perform on the business entity (e.g., 'display')
1206
+ */
1207
+ action: string;
1208
+ /**
1209
+ * Indicates whether the intent can contain additional context parameters that are not described in the outbound: ('notallowed': the intent must contain only the specified parameters | 'allowed': additional parameters might appear in the navigation intent)| 'ignored': technical meta-parameters for framework usage are added to the intent, these parameters should be ignored by target applications
1210
+ */
1211
+ additionalParameters?: "notallowed" | "ignored" | "allowed";
1212
+ /**
1213
+ * Represents parameters of navigation intents
1214
+ */
1215
+ parameters?: {
1216
+ /**
1217
+ * This interface was referenced by `undefined`'s JSON-Schema definition
1218
+ * via the `patternProperty` "^[\w\.\-\/]+$".
1219
+ */
1220
+ [k: string]: {
1221
+ /**
1222
+ * Describes parameters of navigation intents generated or triggered by the application
1223
+ */
1224
+ value?: {
1225
+ /**
1226
+ * Represents a verbatim value (when 'plain' format is used), a pattern (when 'regexp' format is used), a value coming from a UI5 model (when 'binding' format is used), or a User Default reference (when 'reference' format is used)
1227
+ */
1228
+ value?: string;
1229
+ /**
1230
+ * Indicates how 'value' is to be interpreted: 'plain': the 'value' is taken as a literal string value | 'reference': the 'value' is a reference to a parameter maintained in the Fiori Launchpad (e.g. 'UserDefault.CostCenter'); the parameter value is used on the outbound intent parameter| 'regexp': the 'value' matches the specified pattern| 'binding': the 'value' is a binding path; the value from the model at the specified binding path will be used on the outbound intent parameter
1231
+ */
1232
+ format?: "plain" | "regexp" | "reference" | "binding";
1233
+ };
1234
+ required?: boolean;
1235
+ };
1236
+ };
1237
+ };
1238
+ }
1239
+ /**
1240
+ * Represents general ui attributes
1241
+ */
1242
+ export interface JSONSchemaForSAPUINamespace {
1243
+ /**
1244
+ * Represents UI attributes format version. It is managed by namespace owner
1245
+ */
1246
+ _version?: "1.1.0" | "1.2.0" | "1.3.0" | "1.4.0" | "1.5.0";
1247
+ /**
1248
+ * Represents UI technology. The possible values are UI5 (default), WDA, NWBC, GUI, URL and WCF
1249
+ */
1250
+ technology: "UI5" | "WDA" | "NWBC" | "GUI" | "URL" | "WCF";
1251
+ /**
1252
+ * Represents icons which used in application
1253
+ */
1254
+ icons?: {
1255
+ /**
1256
+ * Represents icon of the app
1257
+ */
1258
+ icon?: string;
1259
+ /**
1260
+ * Represents ICO file to be used inside the browser and for desktop shortcuts
1261
+ */
1262
+ favIcon?: string;
1263
+ /**
1264
+ * Represents 57x57 pixel version for non-retina iPhones
1265
+ */
1266
+ phone?: string;
1267
+ /**
1268
+ * Represents 114x114 pixel version for non-retina iPhones
1269
+ */
1270
+ "phone@2"?: string;
1271
+ /**
1272
+ * Represents 72x72 pixel version for non-retina iPads
1273
+ */
1274
+ tablet?: string;
1275
+ /**
1276
+ * Represents 144x144 pixel version for non-retina iPads
1277
+ */
1278
+ "tablet@2"?: string;
1279
+ };
1280
+ /**
1281
+ * Represents device types on which application is running. Supported device types are desktop, tablet and phone
1282
+ */
1283
+ deviceTypes: DeviceType1 & {
1284
+ [k: string]: unknown;
1285
+ };
1286
+ /**
1287
+ * The property is Deprecated. Represents array of supported SAP themes such as sap_hcb, sap_bluecrystal
1288
+ */
1289
+ supportedThemes?: string[];
1290
+ /**
1291
+ * Indicates whether app should run in full screen mode: possible values: true or false
1292
+ */
1293
+ fullWidth?: boolean;
1294
+ [k: string]: unknown;
1295
+ }
1296
+ /**
1297
+ * Represents device types on which the app is running
1298
+ */
1299
+ export interface DeviceType1 {
1300
+ /**
1301
+ * Represents indicator whether desktop device is supported, default true
1302
+ */
1303
+ desktop?: boolean;
1304
+ /**
1305
+ * Represents indicator whether tablet device is supported, default true
1306
+ */
1307
+ tablet?: boolean;
1308
+ /**
1309
+ * Represents indicator whether phone device is supported, default true
1310
+ */
1311
+ phone?: boolean;
1312
+ }
1313
+ /**
1314
+ * Represents paths to JavaScript/CSS resources that your app needs (app internal), formerly called '.includes'
1315
+ */
1316
+ export interface Resource {
1317
+ js?: {
1318
+ uri: string;
1319
+ [k: string]: unknown;
1320
+ }[];
1321
+ css?: {
1322
+ uri: string;
1323
+ id?: string;
1324
+ [k: string]: unknown;
1325
+ }[];
1326
+ [k: string]: unknown;
1327
+ }
1328
+ /**
1329
+ * Represents component name for usage
1330
+ *
1331
+ * This interface was referenced by `undefined`'s JSON-Schema definition
1332
+ * via the `patternProperty` "^[a-zA-Z0-9_\.]*$".
1333
+ */
1334
+ export interface ComponentUsages {
1335
+ /**
1336
+ * Represents name of reuse component
1337
+ */
1338
+ name: string;
1339
+ /**
1340
+ * Represents component data for the Component
1341
+ */
1342
+ componentData?:
1343
+ | Config[]
1344
+ | string
1345
+ | boolean
1346
+ | number
1347
+ | {
1348
+ [k: string]: unknown;
1349
+ };
1350
+ /**
1351
+ * Represents settings for the Component
1352
+ */
1353
+ settings?:
1354
+ | Config[]
1355
+ | string
1356
+ | boolean
1357
+ | number
1358
+ | {
1359
+ [k: string]: unknown;
1360
+ };
1361
+ /**
1362
+ * Represents Indicator to lazy loading component usage, default true
1363
+ */
1364
+ lazy?: boolean;
1365
+ }
1366
+ /**
1367
+ * Represents sapui5 library name
1368
+ *
1369
+ * This interface was referenced by `undefined`'s JSON-Schema definition
1370
+ * via the `patternProperty` "^([a-z][a-z0-9]{0,39})(\.[a-z][a-z0-9]{0,39})*$".
1371
+ */
1372
+ export interface Lib {
1373
+ /**
1374
+ * Represents minimal version of ui5 library
1375
+ */
1376
+ minVersion?: string;
1377
+ /**
1378
+ * Represents Indicator to lazy loading lib
1379
+ */
1380
+ lazy?: boolean;
1381
+ [k: string]: unknown;
1382
+ }
1383
+ /**
1384
+ * Represents sapui5 component name
1385
+ *
1386
+ * This interface was referenced by `undefined`'s JSON-Schema definition
1387
+ * via the `patternProperty` "^([a-zA-Z_$][a-zA-Z0-9_$]{0,39}\.)*([a-zA-Z_$][a-zA-Z0-9_$]{0,39})$".
1388
+ */
1389
+ export interface Component {
1390
+ /**
1391
+ * Represents minimal version of ui5 component
1392
+ */
1393
+ minVersion?: string;
1394
+ /**
1395
+ * Represents Indicator to lazy loading component
1396
+ */
1397
+ lazy?: boolean;
1398
+ [k: string]: unknown;
1399
+ }
1400
+ /**
1401
+ * Represents sapui5 model name
1402
+ *
1403
+ * This interface was referenced by `undefined`'s JSON-Schema definition
1404
+ * via the `patternProperty` "^[a-zA-Z0-9_\.\-\|@]*$".
1405
+ */
1406
+ export interface Model {
1407
+ /**
1408
+ * Represents model class name
1409
+ */
1410
+ type?: string;
1411
+ /**
1412
+ * Represents string of key/alias from sap.app dataSources to reference an existing data source
1413
+ */
1414
+ dataSource?: string;
1415
+ /**
1416
+ * Represents URI for the model
1417
+ */
1418
+ uri?: string;
1419
+ /**
1420
+ * Indicates that the model will be immediately created after the manifest is loaded by Component Factory and before the Component instance is created
1421
+ */
1422
+ preload?: boolean;
1423
+ settings?: Ui5Setting;
1424
+ }
1425
+ export interface Ui5Setting {
1426
+ /**
1427
+ * Represents default binding mode and must be a string value from sap.ui.model.BindingMode. Possible values: Default, OneTime, OneWay, TwoWay
1428
+ */
1429
+ defaultBindingMode?: "Default" | "OneTime" | "OneWay" | "TwoWay";
1430
+ /**
1431
+ * Represents the alternative for bundleUrl
1432
+ */
1433
+ bundleName?: string;
1434
+ /**
1435
+ * Represents the URL for the resource bundle
1436
+ */
1437
+ bundleUrl?: string;
1438
+ /**
1439
+ * Indicates whether url is relative to component (default) or manifest
1440
+ */
1441
+ bundleUrlRelativeTo?: "manifest" | "component";
1442
+ /**
1443
+ * Represents the fallback locale
1444
+ */
1445
+ fallbackLocale?: string;
1446
+ /**
1447
+ * Represents the list of supported locales
1448
+ */
1449
+ supportedLocales?: unknown[];
1450
+ /**
1451
+ * Represents terminologies with additional properties files
1452
+ */
1453
+ terminologies?: {
1454
+ [k: string]: unknown;
1455
+ };
1456
+ /**
1457
+ * Represents enhancement of UI5 resource model with additional properties files
1458
+ */
1459
+ enhanceWith?: EnhanceWithSetting2[];
1460
+ [k: string]: unknown;
1461
+ }
1462
+ /**
1463
+ * Represents the definition of each service
1464
+ *
1465
+ * This interface was referenced by `undefined`'s JSON-Schema definition
1466
+ * via the `patternProperty` "[\s\S]*".
1467
+ */
1468
+ export interface Service {
1469
+ /**
1470
+ * Represents the name of the service factory
1471
+ */
1472
+ factoryName: string;
1473
+ /**
1474
+ * Indicates whether the service optional or not
1475
+ */
1476
+ optional?: boolean;
1477
+ [k: string]: unknown;
1478
+ }
1479
+ /**
1480
+ * Represents a UI5 shortcut command.
1481
+ *
1482
+ * This interface was referenced by `undefined`'s JSON-Schema definition
1483
+ * via the `patternProperty` "^[A-Za-z_][A-Za-z0-9_\-\|@]+$".
1484
+ */
1485
+ export interface Command {
1486
+ /**
1487
+ * A string describing a shortcut key combination that, when used by the user, will trigger the command.
1488
+ */
1489
+ shortcut?: string;
1490
+ }
1491
+ /**
1492
+ * Represents the configuration of routing
1493
+ */
1494
+ export interface RoutingFlexEnabled {
1495
+ /**
1496
+ * Represents the default properties defined for route and target
1497
+ */
1498
+ config?: {
1499
+ /**
1500
+ * Represents the router class
1501
+ */
1502
+ routerClass?: string;
1503
+ /**
1504
+ * Indicates whether the Views in routing are loaded asyncly
1505
+ */
1506
+ async?: boolean;
1507
+ /**
1508
+ * Represents information about targets to display when no route is matched
1509
+ */
1510
+ bypassed?: {
1511
+ /**
1512
+ * Represents one or multiple names of targets that are displayed when no route is matched
1513
+ */
1514
+ target: [] | [string | RouteTargetObject] | string | RouteTargetObject;
1515
+ };
1516
+ /**
1517
+ * Represents a prefix that is prepended in front of the viewName
1518
+ */
1519
+ viewPath?: string;
1520
+ [k: string]: unknown;
1521
+ } & Target;
1522
+ routes?:
1523
+ | Route[]
1524
+ | {
1525
+ [k: string]: RouteWithoutName;
1526
+ };
1527
+ /**
1528
+ * Represents the definition of targets
1529
+ */
1530
+ targets?: {
1531
+ /**
1532
+ * This interface was referenced by `undefined`'s JSON-Schema definition
1533
+ * via the `patternProperty` "[\s\S]*".
1534
+ */
1535
+ [k: string]:
1536
+ | (Target & {
1537
+ /**
1538
+ * Represents the name of a view that will be created
1539
+ */
1540
+ viewName: string;
1541
+ /**
1542
+ * Represents the id of the created view
1543
+ */
1544
+ viewId: string;
1545
+ /**
1546
+ * Represents a prefix that is prepended in front of the viewName
1547
+ */
1548
+ viewPath?: string;
1549
+ [k: string]: unknown;
1550
+ })
1551
+ | (Target &
1552
+ (
1553
+ | {
1554
+ /**
1555
+ * Represents the name of a view or component that will be created
1556
+ */
1557
+ name: string;
1558
+ /**
1559
+ * Represents the id of the created view or component
1560
+ */
1561
+ id: string;
1562
+ /**
1563
+ * Represents a prefix that is prepended in front of the view or component name
1564
+ */
1565
+ path?: string;
1566
+ /**
1567
+ * Represents the type of the type View or Component
1568
+ */
1569
+ type?: "View" | "Component";
1570
+ [k: string]: unknown;
1571
+ }
1572
+ | {
1573
+ /**
1574
+ * Represents the componentUsage of the component that will be created
1575
+ */
1576
+ usage: string;
1577
+ /**
1578
+ * Represents the id of the created view or component
1579
+ */
1580
+ id: string;
1581
+ /**
1582
+ * Represents the type of the type Component
1583
+ */
1584
+ type: "Component";
1585
+ [k: string]: unknown;
1586
+ }
1587
+ ));
1588
+ };
1589
+ [k: string]: unknown;
1590
+ }
1591
+ /**
1592
+ * Represents the definition of a target of a route as object.
1593
+ */
1594
+ export interface RouteTargetObject {
1595
+ /**
1596
+ * Represents the name of the routing target
1597
+ */
1598
+ name?: string;
1599
+ /**
1600
+ * The prefix of the routing target
1601
+ */
1602
+ prefix?: string;
1603
+ /**
1604
+ * Indicates whether this 'Component' target should propagate it's title to this component or not
1605
+ */
1606
+ propagateTitle?: boolean & string;
1607
+ [k: string]: unknown;
1608
+ }
1609
+ /**
1610
+ * Represents the definition of each target
1611
+ */
1612
+ export interface Target {
1613
+ /**
1614
+ * 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.
1615
+ */
1616
+ title?: string;
1617
+ /**
1618
+ * Represents the type of view that is going to be created
1619
+ */
1620
+ viewType?: "XML" | "JSON" | "JS" | "HTML" | "Template";
1621
+ /**
1622
+ * Represents the id of the view that contains the control specified by the 'controlId'
1623
+ */
1624
+ targetParent?: string;
1625
+ /**
1626
+ * Represents the id of the control where you want to place the view created by the target
1627
+ */
1628
+ controlId?: string;
1629
+ /**
1630
+ * Represents the name of an aggregation of the controlId that contains the views
1631
+ */
1632
+ controlAggregation?: string;
1633
+ /**
1634
+ * Whether the aggregation of the control should be cleared before adding the view
1635
+ */
1636
+ clearControlAggregation?: boolean;
1637
+ /**
1638
+ * Represents the name of another target which will also be displayed once this target is displayed
1639
+ */
1640
+ parent?: string;
1641
+ /**
1642
+ * Represents the level of the current view which is used to define the transition direction when navigate to this view
1643
+ */
1644
+ viewLevel?: number;
1645
+ /**
1646
+ * Represents the type of transition when navigating from previous view to this view
1647
+ */
1648
+ transition?: string | ("slide" | "flip" | "fade" | "show");
1649
+ /**
1650
+ * Represents the transition parameters that are passed to the event handlers
1651
+ */
1652
+ transitionParameters?: {
1653
+ [k: string]: unknown;
1654
+ };
1655
+ [k: string]: unknown;
1656
+ }
1657
+ /**
1658
+ * Represents the definition of route without the option 'name'. This is used when routes are defined in an object.
1659
+ *
1660
+ * This interface was referenced by `undefined`'s JSON-Schema definition
1661
+ * via the `patternProperty` "[\s\S]*".
1662
+ *
1663
+ * This interface was referenced by `undefined`'s JSON-Schema definition
1664
+ * via the `patternProperty` "[\s\S]*".
1665
+ */
1666
+ export interface RouteWithoutName {
1667
+ /**
1668
+ * Represents the url pattern that the route is matched against
1669
+ */
1670
+ pattern?: string;
1671
+ /**
1672
+ * Whether the route should be matched when another route is already matched
1673
+ */
1674
+ greedy?: boolean;
1675
+ /**
1676
+ * Represents one or multiple names of targets which are displayed when the route is matched
1677
+ */
1678
+ target?: [] | [string | RouteTargetObject] | string | RouteTargetObject;
1679
+ /**
1680
+ * Represents the name of the target where the 'title' information should be taken
1681
+ */
1682
+ titleTarget?: string;
1683
+ [k: string]: unknown;
1684
+ }
1685
+ /**
1686
+ * Represents the root view definition when flex is enabled (requires a view id)
1687
+ */
1688
+ export interface RootViewDefFlexEnabled {
1689
+ /**
1690
+ * Represents the name of the view
1691
+ */
1692
+ viewName: string;
1693
+ /**
1694
+ * Represents the type of the view. Possible Values: XML, JSON, JS, HTML, Template
1695
+ */
1696
+ type?: "XML" | "JSON" | "JS" | "HTML" | "Template";
1697
+ /**
1698
+ * Represents the id of the view
1699
+ */
1700
+ id: string;
1701
+ /**
1702
+ * Configure the targets for asynchronous loading
1703
+ */
1704
+ async?: boolean;
1705
+ [k: string]: unknown;
1706
+ }
1707
+ /**
1708
+ * Represents the configuration of routing
1709
+ */
1710
+ export interface Routing {
1711
+ /**
1712
+ * Represents the default properties defined for route and target
1713
+ */
1714
+ config?: {
1715
+ /**
1716
+ * Represents the router class
1717
+ */
1718
+ routerClass?: string;
1719
+ /**
1720
+ * Indicates whether the Views in routing are loaded asyncly
1721
+ */
1722
+ async?: boolean;
1723
+ /**
1724
+ * Indicates whether the targets which have type 'Component' should propagate their title to this component or not
1725
+ */
1726
+ propagateTitle?: boolean;
1727
+ /**
1728
+ * Represents information about targets to display when no route is matched
1729
+ */
1730
+ bypassed?: {
1731
+ /**
1732
+ * Represents one or multiple names of targets that are displayed when no route is matched
1733
+ */
1734
+ target: [] | [string | RouteTargetObject] | string | RouteTargetObject;
1735
+ };
1736
+ /**
1737
+ * Represents a prefix that is prepended in front of the viewName
1738
+ */
1739
+ viewPath?: string;
1740
+ [k: string]: unknown;
1741
+ } & Target;
1742
+ routes?:
1743
+ | Route[]
1744
+ | {
1745
+ [k: string]: RouteWithoutName;
1746
+ };
1747
+ /**
1748
+ * Represents the definition of targets
1749
+ */
1750
+ targets?: {
1751
+ /**
1752
+ * This interface was referenced by `undefined`'s JSON-Schema definition
1753
+ * via the `patternProperty` "[\s\S]*".
1754
+ */
1755
+ [k: string]:
1756
+ | (Target & {
1757
+ /**
1758
+ * Represents the name of a view that will be created
1759
+ */
1760
+ viewName: string;
1761
+ /**
1762
+ * Represents the id of the created view
1763
+ */
1764
+ viewId?: string;
1765
+ /**
1766
+ * Represents a prefix that is prepended in front of the viewName
1767
+ */
1768
+ viewPath?: string;
1769
+ [k: string]: unknown;
1770
+ })
1771
+ | (Target &
1772
+ (
1773
+ | {
1774
+ /**
1775
+ * Represents the name of a view or component that will be created
1776
+ */
1777
+ name: string;
1778
+ /**
1779
+ * Represents the id of the created view or component
1780
+ */
1781
+ id?: string;
1782
+ /**
1783
+ * Represents a prefix that is prepended in front of the view or component name
1784
+ */
1785
+ path?: string;
1786
+ /**
1787
+ * Represents the type of the type View or Component
1788
+ */
1789
+ type?: "View" | "Component";
1790
+ [k: string]: unknown;
1791
+ }
1792
+ | {
1793
+ /**
1794
+ * Represents the componentUsage of the component that will be created
1795
+ */
1796
+ usage: string;
1797
+ /**
1798
+ * Represents the id of the created view or component
1799
+ */
1800
+ id?: string;
1801
+ /**
1802
+ * Represents the type of the type Component
1803
+ */
1804
+ type: "Component";
1805
+ [k: string]: unknown;
1806
+ }
1807
+ ));
1808
+ };
1809
+ [k: string]: unknown;
1810
+ }
1811
+ /**
1812
+ * Represents ABAP platform specific attributes
1813
+ */
1814
+ export interface JSONSchemaForSAPPLATFORMABAPNamespace {
1815
+ /**
1816
+ * Represents attributes format version. It is managed by namespace owner
1817
+ */
1818
+ _version?: "1.1.0" | "1.2.0";
1819
+ /**
1820
+ * Represents the uri of the app in the ABAP system
1821
+ */
1822
+ uri?: string;
1823
+ /**
1824
+ * Represents the alternative uri of the app in the ABAP system for starting the application
1825
+ */
1826
+ uriNwbc?: string;
1827
+ }
1828
+ /**
1829
+ * Represents HANA Cloud Platform platform specific attributes
1830
+ */
1831
+ export interface JSONSchemaForSAPPLATFORMHCPNamespace {
1832
+ /**
1833
+ * Represents attributes format version. It is managed by namespace owner
1834
+ */
1835
+ _version?: "1.1.0" | "1.2.0" | "1.3.0";
1836
+ /**
1837
+ * Represents the uri of the app in the HANA Cloud Platform
1838
+ */
1839
+ uri?: string;
1840
+ /**
1841
+ * Represents the alternative uri of the app in the ABAP system for starting the application
1842
+ */
1843
+ uriNwbc?: string;
1844
+ /**
1845
+ * Represents the provider account of the HTML5 application
1846
+ */
1847
+ providerAccount?: string;
1848
+ /**
1849
+ * Represents the HTML5 application name
1850
+ */
1851
+ appName?: string;
1852
+ /**
1853
+ * Represents the version of the HTML5 application
1854
+ */
1855
+ appVersion?: string;
1856
+ /**
1857
+ * Indicates that HCP application is multi-version enabled
1858
+ */
1859
+ multiVersionApp?: boolean;
1860
+ }
1861
+ /**
1862
+ * Represents CF(Cloud Foundry) platform specific attributes
1863
+ */
1864
+ export interface JSONSchemaForSAPPLATFORMCFNamespace {
1865
+ /**
1866
+ * Represents attributes format version. It is managed by namespace owner
1867
+ */
1868
+ _version?: "1.1.0" | "1.2.0";
1869
+ /**
1870
+ * Represents the authorization scope of the application
1871
+ */
1872
+ oAuthScopes?: string[];
1873
+ [k: string]: unknown;
1874
+ }
1875
+ /**
1876
+ * Represents Mobile Cards platform specific attributes
1877
+ */
1878
+ export interface JSONSchemaForSAPPLATFORMMOBILECARDSNamespace {
1879
+ /**
1880
+ * Represents attributes format version. It is managed by namespace owner
1881
+ */
1882
+ _version?: "1.0.0";
1883
+ /**
1884
+ * Represents the compatibility of this app with the Mobile Cards platform.
1885
+ */
1886
+ compatible?: boolean;
1887
+ [k: string]: unknown;
1888
+ }
1889
+ /**
1890
+ * Represents SAP Fiori specific attributes
1891
+ */
1892
+ export interface JSONSchemaForSAPFIORINamespace {
1893
+ /**
1894
+ * Represents attributes format version. It is managed by namespace owner
1895
+ */
1896
+ _version?: "1.1.0" | "1.2.0" | "1.3.0";
1897
+ /**
1898
+ * Represents array of registration ids, i.e. for Fiori apps fiori id(s)
1899
+ */
1900
+ registrationIds: string[];
1901
+ /**
1902
+ * Represents architecture type of an application. The supported types are transactional or analytical or factsheet or reusecomponent or fpmwebdynpro or designstudio
1903
+ */
1904
+ archeType: "transactional" | "analytical" | "factsheet" | "reusecomponent" | "fpmwebdynpro" | "designstudio";
1905
+ /**
1906
+ * Indicator that app is an abstract (generic) app which may not be used directly, but needs to be specialized in the SAP Fiori launchpad content
1907
+ */
1908
+ abstract?: boolean;
1909
+ /**
1910
+ * Represents the release status for the developer adaptation in the cloud (relevant for SAP internal only). The supported types are released, deprecated, obsolete, no value means not released
1911
+ */
1912
+ cloudDevAdaptationStatus?: "released" | "deprecated" | "obsolete";
1913
+ }
1914
+ /**
1915
+ * Represents GENERIC APP specific attributes
1916
+ */
1917
+ export interface JSONSchemaForSAPUIGENERICAPPNamespace {
1918
+ _version?: "1.1.0" | "1.2.0" | "1.3.0" | "1.4.0" | "1.5.0" | "1.6.0";
1919
+ settings?: SettingDef;
1920
+ /**
1921
+ * Represents one ore more pages of an application. UI5 routing is created from the definitions in this section
1922
+ */
1923
+ pages?:
1924
+ | PagesArray[]
1925
+ | {
1926
+ [k: string]: PagesMap;
1927
+ };
1928
+ }
1929
+ /**
1930
+ * Represents global settings for the application controller
1931
+ */
1932
+ export interface SettingDef {
1933
+ [k: string]: unknown;
1934
+ }
1935
+ export interface PagesArray {
1936
+ /**
1937
+ * 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
1938
+ */
1939
+ navigationProperty?: string;
1940
+ /**
1941
+ * Represents the entity set that defines either the aggregation or the root object of the component
1942
+ */
1943
+ entitySet?: string;
1944
+ component: ComponentDef;
1945
+ navigation?: NavigationDef;
1946
+ embeddedComponents?: EmbeddedComponent;
1947
+ routingSpec?: RoutingSpecDef;
1948
+ /**
1949
+ * Represents the component to be loaded inside the canvas if sap.suite.ui.generic.template.Canvas is used as component name, and its settings
1950
+ */
1951
+ implementingComponent?:
1952
+ | {
1953
+ /**
1954
+ * Represents the name of the component to be loaded inside the canvas
1955
+ */
1956
+ componentName: string;
1957
+ binding?: ComponentBindingDef;
1958
+ settings?: ComponentSettingDef;
1959
+ pages?: ComponentPagesDef;
1960
+ }
1961
+ | {
1962
+ /**
1963
+ * Represents the reference to the name of the componentUsages defined in sap.ui5/componentUsages for the component to be loaded inside the canvas
1964
+ */
1965
+ componentUsage: string;
1966
+ binding?: ComponentBindingDef;
1967
+ settings?: ComponentSettingDef;
1968
+ pages?: ComponentPagesDef;
1969
+ };
1970
+ /**
1971
+ * Default layout used to open the corresponding page in FlexibleColumnLayout
1972
+ */
1973
+ defaultLayoutType?: string;
1974
+ /**
1975
+ * Default layout used to open the corresponding page in FlexibleColumnLayout when reached via external navigation
1976
+ */
1977
+ defaultLayoutTypeIfExternalNavigation?: string;
1978
+ pages?: PagesArray[];
1979
+ }
1980
+ /**
1981
+ * Represents the component and its settings that makes the page
1982
+ */
1983
+ export interface ComponentDef {
1984
+ /**
1985
+ * The name of the component
1986
+ */
1987
+ name: string;
1988
+ /**
1989
+ * Switch to create a route for a list (aggregation) if true and routing for an entity if not set or false
1990
+ */
1991
+ list?: boolean;
1992
+ settings?: ComponentSettingDef;
1993
+ }
1994
+ /**
1995
+ * Represents the settings specific to one component
1996
+ */
1997
+ export interface ComponentSettingDef {
1998
+ [k: string]: unknown;
1999
+ }
2000
+ /**
2001
+ * Represents the different navigation targets
2002
+ */
2003
+ export interface NavigationDef {
2004
+ display?: ActionPropDef;
2005
+ create?: ActionPropDef1;
2006
+ edit?: ActionPropDef2;
2007
+ }
2008
+ /**
2009
+ * Represents an action triggered by the user on UI: the navigation to display an object
2010
+ */
2011
+ export interface ActionPropDef {
2012
+ /**
2013
+ * Represents the path in the manifest to the target to which the navigation is bound
2014
+ */
2015
+ path: string;
2016
+ /**
2017
+ * Represents the pointer to a semantic object
2018
+ */
2019
+ target: string;
2020
+ refreshStrategyOnAppRestore?: RefreshStrategiesPropDef;
2021
+ }
2022
+ /**
2023
+ * Represents the refresh strategies configured for external display navigation while coming back to the source app
2024
+ */
2025
+ export interface RefreshStrategiesPropDef {
2026
+ /**
2027
+ * Represents the map of entity sets configured for refresh strategies
2028
+ */
2029
+ entitySets?: {
2030
+ [k: string]: unknown;
2031
+ };
2032
+ }
2033
+ /**
2034
+ * Represents an action triggered by the user on UI: the navigation to create an object
2035
+ */
2036
+ export interface ActionPropDef1 {
2037
+ /**
2038
+ * Represents the path in the manifest to the target to which the navigation is bound
2039
+ */
2040
+ path: string;
2041
+ /**
2042
+ * Represents the pointer to a semantic object
2043
+ */
2044
+ target: string;
2045
+ refreshStrategyOnAppRestore?: RefreshStrategiesPropDef;
2046
+ }
2047
+ /**
2048
+ * Represents an action triggered by the user on UI: the navigation to edit an object
2049
+ */
2050
+ export interface ActionPropDef2 {
2051
+ /**
2052
+ * Represents the path in the manifest to the target to which the navigation is bound
2053
+ */
2054
+ path: string;
2055
+ /**
2056
+ * Represents the pointer to a semantic object
2057
+ */
2058
+ target: string;
2059
+ refreshStrategyOnAppRestore?: RefreshStrategiesPropDef;
2060
+ }
2061
+ /**
2062
+ * Represent reuse components that should be appended at the end of the template component
2063
+ */
2064
+ export interface EmbeddedComponent {
2065
+ /**
2066
+ * This interface was referenced by `EmbeddedComponent`'s JSON-Schema definition
2067
+ * via the `patternProperty` "^[a-zA-Z0-9_.:-]+$".
2068
+ *
2069
+ * This interface was referenced by `EmbeddedComponent2`'s JSON-Schema definition
2070
+ * via the `patternProperty` "^[a-zA-Z0-9_.:-]+$".
2071
+ */
2072
+ [k: string]: {
2073
+ /**
2074
+ * Represents an unique id for the instance of the reuse component inside of the object page
2075
+ */
2076
+ id: string;
2077
+ /**
2078
+ * Represents the title for the content of the reuse component
2079
+ */
2080
+ title: string;
2081
+ /**
2082
+ * Represents an optional element binding for the ComponentContainer that hosts the reuse component
2083
+ */
2084
+ binding?: string;
2085
+ /**
2086
+ * Represents a map to populate the API of the reuse component
2087
+ */
2088
+ settings?: {
2089
+ [k: string]: unknown;
2090
+ };
2091
+ /**
2092
+ * Flag, whether the embedded component should be hidden by default
2093
+ */
2094
+ hiddenByDefault?: {
2095
+ [k: string]: unknown;
2096
+ };
2097
+ /**
2098
+ * Represents group title of reuse components
2099
+ */
2100
+ groupTitle?: string;
2101
+ /**
2102
+ * Represents a section that behaves a leading section for the group
2103
+ */
2104
+ leadingSectionIdOrPath?: string;
2105
+ [k: string]: unknown;
2106
+ } & (
2107
+ | {
2108
+ /**
2109
+ * Represents the name of the reuse component
2110
+ */
2111
+ componentName: string;
2112
+ [k: string]: unknown;
2113
+ }
2114
+ | {
2115
+ /**
2116
+ * Represents the reference to the name of the componentUsages defined in sap.ui5/componentUsages
2117
+ */
2118
+ componentUsage: string;
2119
+ [k: string]: unknown;
2120
+ }
2121
+ | {
2122
+ embeddedComponents: EmbeddedComponent1;
2123
+ [k: string]: unknown;
2124
+ }
2125
+ );
2126
+ }
2127
+ export interface EmbeddedComponent1 {
2128
+ /**
2129
+ * This interface was referenced by `EmbeddedComponent`'s JSON-Schema definition
2130
+ * via the `patternProperty` "^[a-zA-Z0-9_.:-]+$".
2131
+ *
2132
+ * This interface was referenced by `EmbeddedComponent2`'s JSON-Schema definition
2133
+ * via the `patternProperty` "^[a-zA-Z0-9_.:-]+$".
2134
+ */
2135
+ [k: string]: {
2136
+ /**
2137
+ * Represents an unique id for the instance of the reuse component inside of the object page
2138
+ */
2139
+ id: string;
2140
+ /**
2141
+ * Represents the title for the content of the reuse component
2142
+ */
2143
+ title: string;
2144
+ /**
2145
+ * Represents an optional element binding for the ComponentContainer that hosts the reuse component
2146
+ */
2147
+ binding?: string;
2148
+ /**
2149
+ * Represents a map to populate the API of the reuse component
2150
+ */
2151
+ settings?: {
2152
+ [k: string]: unknown;
2153
+ };
2154
+ /**
2155
+ * Flag, whether the embedded component should be hidden by default
2156
+ */
2157
+ hiddenByDefault?: {
2158
+ [k: string]: unknown;
2159
+ };
2160
+ /**
2161
+ * Represents group title of reuse components
2162
+ */
2163
+ groupTitle?: string;
2164
+ /**
2165
+ * Represents a section that behaves a leading section for the group
2166
+ */
2167
+ leadingSectionIdOrPath?: string;
2168
+ [k: string]: unknown;
2169
+ } & (
2170
+ | {
2171
+ /**
2172
+ * Represents the name of the reuse component
2173
+ */
2174
+ componentName: string;
2175
+ [k: string]: unknown;
2176
+ }
2177
+ | {
2178
+ /**
2179
+ * Represents the reference to the name of the componentUsages defined in sap.ui5/componentUsages
2180
+ */
2181
+ componentUsage: string;
2182
+ [k: string]: unknown;
2183
+ }
2184
+ | {
2185
+ embeddedComponents: EmbeddedComponent1;
2186
+ [k: string]: unknown;
2187
+ }
2188
+ );
2189
+ }
2190
+ /**
2191
+ * Represents the routing specification
2192
+ */
2193
+ export interface RoutingSpecDef {
2194
+ /**
2195
+ * Represents the name of the route
2196
+ */
2197
+ routeName: string;
2198
+ /**
2199
+ * Represents the switch to indicate, that this route is not related to the OData service
2200
+ */
2201
+ noOData?: boolean;
2202
+ /**
2203
+ * Represents the binding string to indicate, how the page should be bound relative to the predecessor page or absolute
2204
+ */
2205
+ binding?: string;
2206
+ /**
2207
+ * Represents the the title to be shown on the page
2208
+ */
2209
+ headerTitle?: string;
2210
+ /**
2211
+ * Represents the URL pointing to an icon, that will be shown in the navigation menu additional to the title to represent the page
2212
+ */
2213
+ typeImageUrl?: string;
2214
+ /**
2215
+ * Represents the switch to indicate, whether this route is reached via a 1:1 navigation or a 1:n navigation
2216
+ */
2217
+ noKey?: boolean;
2218
+ /**
2219
+ * Name of a semantic key field which can be used to identify an instance of this page. Only relevant if nKey is false.
2220
+ */
2221
+ semanticKey?: string;
2222
+ }
2223
+ export interface ComponentPagesDef {
2224
+ [k: string]: PagesMap;
2225
+ }
2226
+ /**
2227
+ * This interface was referenced by `ComponentPagesDef`'s JSON-Schema definition
2228
+ * via the `patternProperty` "^[a-zA-Z0-9_\.\-]+[\|]?[a-zA-Z0-9_\.\-]+$".
2229
+ *
2230
+ * This interface was referenced by `undefined`'s JSON-Schema definition
2231
+ * via the `patternProperty` "^[a-zA-Z0-9_\.\-]+[\|]?[a-zA-Z0-9_\.\-]+$".
2232
+ */
2233
+ export interface PagesMap {
2234
+ /**
2235
+ * 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
2236
+ */
2237
+ navigationProperty?: string;
2238
+ /**
2239
+ * Represents the entity set that defines either the aggregation or the root object of the component
2240
+ */
2241
+ entitySet?: string;
2242
+ component: ComponentDef1;
2243
+ navigation?: NavigationDef1;
2244
+ embeddedComponents?: EmbeddedComponent2;
2245
+ routingSpec?: RoutingSpecDef1;
2246
+ /**
2247
+ * Represents the component to be loaded inside the canvas if sap.suite.ui.generic.template.Canvas is used as component name, and its settings
2248
+ */
2249
+ implementingComponent?:
2250
+ | {
2251
+ /**
2252
+ * Represents the name of the component to be loaded inside the canvas
2253
+ */
2254
+ componentName: string;
2255
+ binding?: ComponentBindingDef;
2256
+ settings?: ComponentSettingDef;
2257
+ pages?: ComponentPagesDef;
2258
+ }
2259
+ | {
2260
+ /**
2261
+ * Represents the reference to the name of the componentUsages defined in sap.ui5/componentUsages for the component to be loaded inside the canvas
2262
+ */
2263
+ componentUsage: string;
2264
+ binding?: ComponentBindingDef;
2265
+ settings?: ComponentSettingDef;
2266
+ pages?: ComponentPagesDef;
2267
+ };
2268
+ /**
2269
+ * Default layout used to open the corresponding page in FlexibleColumnLayout
2270
+ */
2271
+ defaultLayoutType?: string;
2272
+ /**
2273
+ * Default layout used to open the corresponding page in FlexibleColumnLayout when reached via external navigation
2274
+ */
2275
+ defaultLayoutTypeIfExternalNavigation?: string;
2276
+ pages?: {
2277
+ [k: string]: PagesMap;
2278
+ };
2279
+ }
2280
+ /**
2281
+ * Represents the component and its settings that makes the page
2282
+ */
2283
+ export interface ComponentDef1 {
2284
+ /**
2285
+ * The name of the component
2286
+ */
2287
+ name: string;
2288
+ /**
2289
+ * Switch to create a route for a list (aggregation) if true and routing for an entity if not set or false
2290
+ */
2291
+ list?: boolean;
2292
+ settings?: ComponentSettingDef;
2293
+ }
2294
+ /**
2295
+ * Represents the different navigation targets
2296
+ */
2297
+ export interface NavigationDef1 {
2298
+ display?: ActionPropDef;
2299
+ create?: ActionPropDef1;
2300
+ edit?: ActionPropDef2;
2301
+ }
2302
+ /**
2303
+ * Represent reuse components that should be appended at the end of the template component
2304
+ */
2305
+ export interface EmbeddedComponent2 {
2306
+ /**
2307
+ * This interface was referenced by `EmbeddedComponent`'s JSON-Schema definition
2308
+ * via the `patternProperty` "^[a-zA-Z0-9_.:-]+$".
2309
+ *
2310
+ * This interface was referenced by `EmbeddedComponent2`'s JSON-Schema definition
2311
+ * via the `patternProperty` "^[a-zA-Z0-9_.:-]+$".
2312
+ */
2313
+ [k: string]: {
2314
+ /**
2315
+ * Represents an unique id for the instance of the reuse component inside of the object page
2316
+ */
2317
+ id: string;
2318
+ /**
2319
+ * Represents the title for the content of the reuse component
2320
+ */
2321
+ title: string;
2322
+ /**
2323
+ * Represents an optional element binding for the ComponentContainer that hosts the reuse component
2324
+ */
2325
+ binding?: string;
2326
+ /**
2327
+ * Represents a map to populate the API of the reuse component
2328
+ */
2329
+ settings?: {
2330
+ [k: string]: unknown;
2331
+ };
2332
+ /**
2333
+ * Flag, whether the embedded component should be hidden by default
2334
+ */
2335
+ hiddenByDefault?: {
2336
+ [k: string]: unknown;
2337
+ };
2338
+ /**
2339
+ * Represents group title of reuse components
2340
+ */
2341
+ groupTitle?: string;
2342
+ /**
2343
+ * Represents a section that behaves a leading section for the group
2344
+ */
2345
+ leadingSectionIdOrPath?: string;
2346
+ [k: string]: unknown;
2347
+ } & (
2348
+ | {
2349
+ /**
2350
+ * Represents the name of the reuse component
2351
+ */
2352
+ componentName: string;
2353
+ [k: string]: unknown;
2354
+ }
2355
+ | {
2356
+ /**
2357
+ * Represents the reference to the name of the componentUsages defined in sap.ui5/componentUsages
2358
+ */
2359
+ componentUsage: string;
2360
+ [k: string]: unknown;
2361
+ }
2362
+ | {
2363
+ embeddedComponents: EmbeddedComponent1;
2364
+ [k: string]: unknown;
2365
+ }
2366
+ );
2367
+ }
2368
+ /**
2369
+ * Represents the routing specification
2370
+ */
2371
+ export interface RoutingSpecDef1 {
2372
+ /**
2373
+ * Represents the name of the route
2374
+ */
2375
+ routeName: string;
2376
+ /**
2377
+ * Represents the switch to indicate, that this route is not related to the OData service
2378
+ */
2379
+ noOData?: boolean;
2380
+ /**
2381
+ * Represents the binding string to indicate, how the page should be bound relative to the predecessor page or absolute
2382
+ */
2383
+ binding?: string;
2384
+ /**
2385
+ * Represents the the title to be shown on the page
2386
+ */
2387
+ headerTitle?: string;
2388
+ /**
2389
+ * Represents the URL pointing to an icon, that will be shown in the navigation menu additional to the title to represent the page
2390
+ */
2391
+ typeImageUrl?: string;
2392
+ /**
2393
+ * Represents the switch to indicate, whether this route is reached via a 1:1 navigation or a 1:n navigation
2394
+ */
2395
+ noKey?: boolean;
2396
+ /**
2397
+ * Name of a semantic key field which can be used to identify an instance of this page. Only relevant if nKey is false.
2398
+ */
2399
+ semanticKey?: string;
2400
+ }
2401
+ /**
2402
+ * Represents specific attributes for Fiori Elements
2403
+ */
2404
+ export interface JSONSchemaForSAPFENamespace {
2405
+ [k: string]: unknown;
2406
+ }
2407
+ /**
2408
+ * Represents FLP specific attributes
2409
+ */
2410
+ export interface JSONSchemaForSAPFLPNamespace {
2411
+ /**
2412
+ * Represents attributes format version. It is managed by namespace owner
2413
+ */
2414
+ _version?: "1.1.0" | "1.2.0" | "1.3.0";
2415
+ /**
2416
+ * Represents size of the tile
2417
+ */
2418
+ tileSize?: "1x1" | "1x2";
2419
+ /**
2420
+ * Represents the type of FLP entry. It must be 'application' or 'tile' or 'plugin'
2421
+ */
2422
+ type: "application" | "tile" | "plugin";
2423
+ /**
2424
+ * Represents configuration parameters of the FLP entry
2425
+ */
2426
+ config?: {
2427
+ /**
2428
+ * Represents the configuration key and values
2429
+ *
2430
+ * This interface was referenced by `undefined`'s JSON-Schema definition
2431
+ * via the `patternProperty` "^[a-zA-Z0-9\_\.\-]*$".
2432
+ */
2433
+ [k: string]: {
2434
+ [k: string]: unknown;
2435
+ };
2436
+ };
2437
+ /**
2438
+ * Represents the original tile and target mapping which resulted in this app
2439
+ */
2440
+ origin?: {
2441
+ /**
2442
+ * Represents the original tile which resulted in this app
2443
+ */
2444
+ tileId?: string;
2445
+ /**
2446
+ * Represents the original target mapping which resulted in this app
2447
+ */
2448
+ targetMappingId?: string;
2449
+ };
2450
+ }
2451
+ /**
2452
+ * Represents OVP specific attributes
2453
+ */
2454
+ export interface JSONSchemaForSAPOVPNamespace {
2455
+ /**
2456
+ * Represents attributes format version. It is managed by namespace owner
2457
+ */
2458
+ _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";
2459
+ /**
2460
+ * Represents the name of global filter OData model, which contains entities definition that are relevant for global filters
2461
+ */
2462
+ globalFilterModel?: string;
2463
+ /**
2464
+ * Represents the entity to use as global filter in the smart filter bar control
2465
+ */
2466
+ globalFilterEntityType?: string;
2467
+ /**
2468
+ * Represents the entity set to use as global filter in the smart filter bar control
2469
+ */
2470
+ globalFilterEntitySet?: string;
2471
+ /**
2472
+ * Represents a switch to include basic search in the global filters
2473
+ */
2474
+ showBasicSearch?: boolean;
2475
+ /**
2476
+ * Represents a switch to disable the error page shown on load of overview page when no data is retreived from the backend
2477
+ */
2478
+ disableErrorPage?: boolean;
2479
+ /**
2480
+ * Represents a switch to activate smart variant management in the global filters
2481
+ */
2482
+ smartVariantRequired?: boolean;
2483
+ /**
2484
+ * Represents a switch to show smart filter bar in expanded or collapsed mode
2485
+ */
2486
+ bHeaderExpanded?: boolean;
2487
+ /**
2488
+ * Represents the layout of the card container
2489
+ */
2490
+ containerLayout?: "fixed" | "resizable";
2491
+ /**
2492
+ * Represents a switch to Enable or disable Relative or Normal date formating in ovp application
2493
+ */
2494
+ showDateInRelativeFormat?: boolean;
2495
+ /**
2496
+ * Represents a switch to Enable or Disable the Flexibility of Table cards
2497
+ */
2498
+ disableTableCardFlexibility?: boolean;
2499
+ /**
2500
+ * Represents the switch to activate live update in the global filters, else manual update will be required
2501
+ */
2502
+ enableLiveFilter?: boolean;
2503
+ refreshStrategyOnAppRestore?: RefreshStrategiesPropDef1;
2504
+ /**
2505
+ * Flag to enable/disable analytical parameter support for Smart filter bar
2506
+ */
2507
+ considerAnalyticalParameters?: boolean;
2508
+ /**
2509
+ * Time interval in minutes to auto refresh the card models
2510
+ */
2511
+ refreshIntervalInMinutes?: number;
2512
+ /**
2513
+ * Flag to enable/disable semantic date range control for Smart filter bar
2514
+ */
2515
+ useDateRangeType?: boolean;
2516
+ /**
2517
+ * Represents the object to store analytical chart settings
2518
+ */
2519
+ chartSettings?: {
2520
+ /**
2521
+ * Flag to enable data labels on analytical charts
2522
+ */
2523
+ showDataLabel?: boolean;
2524
+ [k: string]: unknown;
2525
+ };
2526
+ /**
2527
+ * Represents the object to store filter bar configuration
2528
+ */
2529
+ filterSettings?: {
2530
+ /**
2531
+ * Represents the object to store date type filter fields configuration
2532
+ */
2533
+ dateSettings?: {
2534
+ /**
2535
+ * Flag to enable DateTimeRange setting for date type filter fields with filter restriction interval
2536
+ */
2537
+ useDateRange?: boolean;
2538
+ /**
2539
+ * Represents the semantic date values selected for the date filter field
2540
+ */
2541
+ selectedValues?: string;
2542
+ /**
2543
+ * Flag to exclude values from the date picker
2544
+ */
2545
+ exclude?: boolean;
2546
+ /**
2547
+ * Represents the filter field definition for each field
2548
+ */
2549
+ fields?: {
2550
+ [k: string]: FilterFieldName;
2551
+ };
2552
+ [k: string]: unknown;
2553
+ };
2554
+ [k: string]: unknown;
2555
+ };
2556
+ /**
2557
+ * Represents the object to define data loading behaviour for an overview page application
2558
+ */
2559
+ dataLoadSettings?: {
2560
+ /**
2561
+ * Data load behaviour options on application launch
2562
+ */
2563
+ loadDataOnAppLaunch?: "always" | "never" | "ifAnyFilterExist";
2564
+ [k: string]: unknown;
2565
+ };
2566
+ cards: {
2567
+ [k: string]: Card;
2568
+ };
2569
+ resizableLayout?: {
2570
+ [k: string]: ResizableLayoutVariant;
2571
+ };
2572
+ }
2573
+ /**
2574
+ * Represents the refresh strategies configured for OVP while coming back to the source app
2575
+ */
2576
+ export interface RefreshStrategiesPropDef1 {
2577
+ /**
2578
+ * Represents the map of entity sets configured for refresh strategies
2579
+ */
2580
+ entitySets?: {
2581
+ [k: string]: unknown;
2582
+ };
2583
+ }
2584
+ /**
2585
+ * Represents the configuration object for each date filter field
2586
+ *
2587
+ * This interface was referenced by `undefined`'s JSON-Schema definition
2588
+ * via the `patternProperty` "^[a-zA-Z0-9_\.\-]*$".
2589
+ */
2590
+ export interface FilterFieldName {
2591
+ /**
2592
+ * Represents the configuration for setting default value for the date filter field
2593
+ */
2594
+ defaultValue?: {
2595
+ /**
2596
+ * Represents the default semantic date value to be set on the filter field
2597
+ */
2598
+ operation?: string;
2599
+ [k: string]: unknown;
2600
+ };
2601
+ /**
2602
+ * Represents the semantic date values selected for the date filter field
2603
+ */
2604
+ selectedValues?: string;
2605
+ /**
2606
+ * Represents the custom implementation for semantic date filter field
2607
+ */
2608
+ customDateRangeImplementation?: string;
2609
+ /**
2610
+ * Flag to exclude values from the date picker
2611
+ */
2612
+ exclude?: boolean;
2613
+ [k: string]: unknown;
2614
+ }
2615
+ /**
2616
+ * Represents the card attributes
2617
+ *
2618
+ * This interface was referenced by `undefined`'s JSON-Schema definition
2619
+ * via the `patternProperty` "^[a-zA-Z0-9_\.\-]+$".
2620
+ */
2621
+ export interface Card {
2622
+ /**
2623
+ * Represents the position of the card in the sequence
2624
+ */
2625
+ sequencePos?: number;
2626
+ /**
2627
+ * Represents the model for the card
2628
+ */
2629
+ model?: string;
2630
+ /**
2631
+ * Represents the card component path to use for this card
2632
+ */
2633
+ template: string;
2634
+ settings?: CardSetting;
2635
+ /**
2636
+ * Represents the card with view switch control
2637
+ *
2638
+ * @minItems 1
2639
+ */
2640
+ tabs?: [TabSetting, ...TabSetting[]];
2641
+ }
2642
+ /**
2643
+ * Represents the card specific properties - properties that are passed to the card
2644
+ */
2645
+ export interface CardSetting {
2646
+ /**
2647
+ * Represents the category of the card- used in the card header
2648
+ */
2649
+ category?: string;
2650
+ /**
2651
+ * Represents the user defined string in placeholder card
2652
+ */
2653
+ itemText?: string;
2654
+ /**
2655
+ * Represents language-dependent title of the card - used in the card header
2656
+ */
2657
+ title: string;
2658
+ /**
2659
+ * Represents language-dependent subtitle of the card - used in the card header
2660
+ */
2661
+ subTitle?: string;
2662
+ /**
2663
+ * Represents things like people, number of items
2664
+ */
2665
+ valueSelectionInfo?: string;
2666
+ /**
2667
+ * Represents the entity set that will be displayed in this card
2668
+ */
2669
+ entitySet?: string;
2670
+ /**
2671
+ * Represents the static content that will be displayed in this card
2672
+ */
2673
+ staticContent?: {
2674
+ [k: string]: unknown;
2675
+ }[];
2676
+ /**
2677
+ * Represents the flavor of the list to use in this card. The flavor can be bar chart, carousel or standard
2678
+ */
2679
+ listFlavor?: "standard" | "bar" | "carousel";
2680
+ /**
2681
+ * Represents the type of list to use for this card. The list can be extended to display more information or condensed to take up less space on the card
2682
+ */
2683
+ listType?: "extended" | "condensed";
2684
+ /**
2685
+ * Represents the sort key for the entity set
2686
+ */
2687
+ sortBy?: string;
2688
+ /**
2689
+ * Represents the sort order for the entity set
2690
+ */
2691
+ sortOrder?: "ascending" | "descending";
2692
+ /**
2693
+ * Represents the annotation path
2694
+ */
2695
+ annotationPath?: string;
2696
+ /**
2697
+ * Represents the selection annotation path
2698
+ */
2699
+ selectionAnnotationPath?: string;
2700
+ /**
2701
+ * Represents the chart annotation path
2702
+ */
2703
+ chartAnnotationPath?: string;
2704
+ /**
2705
+ * Represents the presentation annotation path
2706
+ */
2707
+ presentationAnnotationPath?: string;
2708
+ /**
2709
+ * Represents the data point annotation path
2710
+ */
2711
+ dataPointAnnotationPath?: string;
2712
+ /**
2713
+ * Represents the identification annotation path
2714
+ */
2715
+ identificationAnnotationPath?: string;
2716
+ /**
2717
+ * Represents the KPI annotation path
2718
+ */
2719
+ kpiAnnotationPath?: string;
2720
+ /**
2721
+ * Represents the selection presentation annotation path
2722
+ */
2723
+ selectionPresentationAnnotationPath?: string;
2724
+ /**
2725
+ * Represents the dynamic subtitle annotation path
2726
+ */
2727
+ dynamicSubtitleAnnotationPath?: string;
2728
+ /**
2729
+ * Represents the flag to indicate priority of number formatting over sap text
2730
+ */
2731
+ ignoreSapText?: boolean;
2732
+ /**
2733
+ * Represents the flag to enable/disable individual card's functionality to add them to insight
2734
+ */
2735
+ enableAddToInsights?: boolean;
2736
+ defaultSpan?: DefaultSpanDef;
2737
+ /**
2738
+ * Represents the cards for which authorization is required
2739
+ */
2740
+ requireAppAuthorization?: string;
2741
+ objectStreamCardsSettings?: ObjectStreamCardsSettingsDef;
2742
+ /**
2743
+ * Represents the flag to indicate the use of object number/smart field
2744
+ */
2745
+ enableLocaleCurrencyFormatting?: boolean;
2746
+ /**
2747
+ * Represents the configuration to alter the navigation mode in OVP Analytical Cards
2748
+ */
2749
+ navigation?: "dataPointNav" | "chartNav" | "headerNav" | "noHeaderNav";
2750
+ /**
2751
+ * Represents a switch to Show or Hide Filters in Cards Headers in OVP application
2752
+ */
2753
+ showFilterInHeader?: boolean;
2754
+ /**
2755
+ * Represents a switch to Show or Hide Sorting in Cards Headers in OVP application
2756
+ */
2757
+ showSortingInHeader?: boolean;
2758
+ /**
2759
+ * Flag for enabling images in a condensed list card
2760
+ */
2761
+ imageSupported?: boolean;
2762
+ /**
2763
+ * Flag for show line item detail in list and table card
2764
+ */
2765
+ showLineItemDetail?: boolean;
2766
+ /**
2767
+ * This property is responsible for showing and hiding text labels on the geo spots
2768
+ */
2769
+ showLabelText?: boolean;
2770
+ /**
2771
+ * This property is responsible for passing custom parameters present in the entity set to the navigating application
2772
+ */
2773
+ customParams?: string;
2774
+ /**
2775
+ * This property is responsible for setting specific chart settings
2776
+ */
2777
+ chartProperties?: {
2778
+ plotArea?: PlotAreaDef;
2779
+ timeAxis?: TimeAxisDef;
2780
+ };
2781
+ /**
2782
+ * Represents the configuration to customize the column stacked chart
2783
+ */
2784
+ colorPalette?:
2785
+ | {
2786
+ [k: string]: unknown;
2787
+ }[]
2788
+ | {
2789
+ [k: string]: unknown;
2790
+ };
2791
+ [k: string]: unknown;
2792
+ }
2793
+ /**
2794
+ * Represents the Object Stream properties - properties that are passed to the Object Stream cards
2795
+ */
2796
+ export interface ObjectStreamCardsSettingsDef {
2797
+ /**
2798
+ * Represents the flag to show first action in footer of the Quickview cards
2799
+ */
2800
+ showFirstActionInFooter?: boolean;
2801
+ /**
2802
+ * Represents the custom actions in the Quick View Cards
2803
+ *
2804
+ * @minItems 1
2805
+ */
2806
+ customActions?: [CustomActionsSetting, ...CustomActionsSetting[]];
2807
+ [k: string]: unknown;
2808
+ }
2809
+ /**
2810
+ * Represents the properties for the custom actions in the Quick View Cards
2811
+ */
2812
+ export interface CustomActionsSetting {
2813
+ /**
2814
+ * Text displayed for extended actions in Quick View
2815
+ */
2816
+ text?: string;
2817
+ /**
2818
+ * Name of the press handler for extended actions in Quick View
2819
+ */
2820
+ press?: string;
2821
+ /**
2822
+ * Position of extended actions in Quick View
2823
+ */
2824
+ position?: number;
2825
+ [k: string]: unknown;
2826
+ }
2827
+ /**
2828
+ * Plot area is a parent property which defines multiple other properties for smoothness and marker size
2829
+ */
2830
+ export interface PlotAreaDef {
2831
+ /**
2832
+ * Represents whether smoother curves are required or not
2833
+ */
2834
+ isSmoothed?: boolean;
2835
+ /**
2836
+ * Represents the size of the markers in scatter plots
2837
+ */
2838
+ markerSize?: number;
2839
+ /**
2840
+ * dataLabel is a parent property that defines other properties for type
2841
+ */
2842
+ dataLabel?: {
2843
+ /**
2844
+ * Defines whether to display percentage values or actual counts in the donut chart
2845
+ */
2846
+ type?: "value" | "percentage";
2847
+ };
2848
+ }
2849
+ /**
2850
+ * Represents the configuration to customize the time axis
2851
+ */
2852
+ export interface TimeAxisDef {
2853
+ levels?: LevelsDef;
2854
+ [k: string]: unknown;
2855
+ }
2856
+ /**
2857
+ * Represents the tab specific properties - properties that are passed to a particular tab in a card
2858
+ */
2859
+ export interface TabSetting {
2860
+ /**
2861
+ * Represents the annotation path
2862
+ */
2863
+ annotationPath?: string;
2864
+ /**
2865
+ * Represents the selection annotation path
2866
+ */
2867
+ selectionAnnotationPath?: string;
2868
+ /**
2869
+ * Represents the chart annotation path
2870
+ */
2871
+ chartAnnotationPath?: string;
2872
+ /**
2873
+ * Represents the presentation annotation path
2874
+ */
2875
+ presentationAnnotationPath?: string;
2876
+ /**
2877
+ * Represents the data point annotation path
2878
+ */
2879
+ dataPointAnnotationPath?: string;
2880
+ /**
2881
+ * Represents the identification annotation path
2882
+ */
2883
+ identificationAnnotationPath?: string;
2884
+ /**
2885
+ * Represents the dynamic subtitle annotation path
2886
+ */
2887
+ dynamicSubtitleAnnotationPath?: string;
2888
+ /**
2889
+ * Represents the drop down value to be shown
2890
+ */
2891
+ value?: string;
2892
+ /**
2893
+ * This property is responsible for setting specific chart settings
2894
+ */
2895
+ chartProperties?: {
2896
+ plotArea?: PlotAreaDef;
2897
+ timeAxis?: TimeAxisDef;
2898
+ };
2899
+ /**
2900
+ * Represents the configuration to customize the column stacked chart
2901
+ */
2902
+ colorPalette?:
2903
+ | {
2904
+ [k: string]: unknown;
2905
+ }[]
2906
+ | {
2907
+ [k: string]: unknown;
2908
+ };
2909
+ [k: string]: unknown;
2910
+ }
2911
+ /**
2912
+ * Represents the resizable layout variant
2913
+ *
2914
+ * This interface was referenced by `undefined`'s JSON-Schema definition
2915
+ * via the `patternProperty` "^cols_[0-9]+$".
2916
+ */
2917
+ export interface ResizableLayoutVariant {
2918
+ [k: string]: ResizableLayoutVariantCardProperties;
2919
+ }
2920
+ /**
2921
+ * Represents the card properties is a layout variant
2922
+ *
2923
+ * This interface was referenced by `ResizableLayoutVariant`'s JSON-Schema definition
2924
+ * via the `patternProperty` "^[a-zA-Z0-9_\.\-]+$".
2925
+ */
2926
+ export interface ResizableLayoutVariantCardProperties {
2927
+ /**
2928
+ * Represents the grid column
2929
+ */
2930
+ col: number;
2931
+ /**
2932
+ * Represents the grid row
2933
+ */
2934
+ row: number;
2935
+ /**
2936
+ * Represents the column span
2937
+ */
2938
+ colSpan: number;
2939
+ /**
2940
+ * Represents the row span
2941
+ */
2942
+ rowSpan: number;
2943
+ /**
2944
+ * Represents the visibility of the card
2945
+ */
2946
+ visible?: boolean;
2947
+ }
2948
+ /**
2949
+ * Represents Insights attributes
2950
+ */
2951
+ export interface JSONSchemaForSAPInsightsNamespace {
2952
+ _version?: "1.0.0" | "1.1.0" | "1.2.0" | "1.3.0" | "1.4.0";
2953
+ /**
2954
+ * Represents mandatory unique app identifier of the app containing self manifest.
2955
+ */
2956
+ parentAppId: string;
2957
+ /**
2958
+ * Represents the entity to use as global filter in the filter bar control
2959
+ */
2960
+ filterEntitySet?: string;
2961
+ /**
2962
+ * Represents the template name, from where manifest is generated
2963
+ */
2964
+ templateName?: string;
2965
+ /**
2966
+ * Represents the environment type of Insights card
2967
+ */
2968
+ cardType: "DT" | "RT";
2969
+ /**
2970
+ * Represents the state of original or copied card
2971
+ */
2972
+ isDtCardCopy?: boolean;
2973
+ /**
2974
+ * Represents the deleted state for a user
2975
+ */
2976
+ isDeletedForUser?: boolean;
2977
+ /**
2978
+ * Represents the visibility type of Insights card
2979
+ */
2980
+ visible?: boolean;
2981
+ /**
2982
+ * Represents the display order of Insights card
2983
+ */
2984
+ rank?: number;
2985
+ /**
2986
+ * Represents UI5 and card generator middleware version.
2987
+ */
2988
+ versions?: {
2989
+ /**
2990
+ * Represents the version of UI5 used to generate the card.
2991
+ */
2992
+ ui5?: string;
2993
+ /**
2994
+ * Represents the version of design time card generator
2995
+ */
2996
+ dtMiddleware?: string;
2997
+ [k: string]: unknown;
2998
+ };
2999
+ }
3000
+ /**
3001
+ * Represents WDA specific attributes
3002
+ */
3003
+ export interface JSONSchemaForSAPWDANamespace {
3004
+ /**
3005
+ * Represents attributes format version. It is managed by namespace owner
3006
+ */
3007
+ _version?: "1.1.0" | "1.2.0";
3008
+ /**
3009
+ * Represents ID of an application
3010
+ */
3011
+ applicationId: string;
3012
+ /**
3013
+ * Represents ID of an application configuration
3014
+ */
3015
+ configId?: string;
3016
+ /**
3017
+ * Represents SAP Screen Personas Flavor ID
3018
+ */
3019
+ flavorId?: string;
3020
+ /**
3021
+ * Indicates that WebDynpro Application requires Compatibility Mode, while uses legacy shell services. Possible values are true or false (default)
3022
+ */
3023
+ compatibilityMode?: boolean;
3024
+ }
3025
+ /**
3026
+ * Represents APF specific attributes
3027
+ */
3028
+ export interface JSONSchemaForSAPAPFNamespace {
3029
+ /**
3030
+ * Represents attributes format version. It is managed by namespace owner
3031
+ */
3032
+ _version?: "1.1.0" | "1.2.0";
3033
+ /**
3034
+ * Represents a switch to activate filter reduction so that filters in OData requests can be represented as ABAP select options
3035
+ */
3036
+ activateFilterReduction?: boolean;
3037
+ /**
3038
+ * Represents a switch to activate LREP as the persistence for configurations and texts
3039
+ */
3040
+ activateLrep?: boolean;
3041
+ /**
3042
+ * Represents a switch to use HEAD-Requests instead of GET-Requests when fetching the XSRF-Security-Token
3043
+ */
3044
+ useHeadRequestForXsrfToken?: boolean;
3045
+ }
3046
+ /**
3047
+ * Represents Cloud Portal specific attributes
3048
+ */
3049
+ export interface JSONSchemaForSAPCLOUDPORTALNamespace {
3050
+ [k: string]: unknown;
3051
+ }
3052
+ /**
3053
+ * Represents GUI specific attributes
3054
+ */
3055
+ export interface JSONSchemaForSAPGUINamespace {
3056
+ /**
3057
+ * Represents attributes format version. It is managed by namespace owner
3058
+ */
3059
+ _version?: "1.1.0" | "1.2.0";
3060
+ /**
3061
+ * Represents transaction of an application
3062
+ */
3063
+ transaction: string;
3064
+ /**
3065
+ * Represents SAP Screen Personas Flavor ID
3066
+ */
3067
+ flavorId?: string;
3068
+ }
3069
+ /**
3070
+ * Represents Application Integration specific attributes
3071
+ */
3072
+ export interface JSONSchemaForSAPINTEGRATIONNamespace {
3073
+ /**
3074
+ * Represents attributes format version. It is managed by namespace owner
3075
+ */
3076
+ _version?: "1.0.0";
3077
+ /**
3078
+ * Reference to the desired URL Template
3079
+ */
3080
+ urlTemplateId: string;
3081
+ /**
3082
+ * Represents configuration parameters which will be used by Template Engine to compile URL Template
3083
+ */
3084
+ parameters: {
3085
+ /**
3086
+ * Represents the name of the desired parameter
3087
+ */
3088
+ key: string;
3089
+ /**
3090
+ * Represents the actual value of the desired parameter
3091
+ */
3092
+ value: string;
3093
+ [k: string]: unknown;
3094
+ }[];
3095
+ [k: string]: unknown;
3096
+ }
3097
+ /**
3098
+ * Represents WCF Application specific attributes
3099
+ */
3100
+ export interface JSONSchemaForSAPWCFNamespace {
3101
+ /**
3102
+ * Represents attributes format version. It is managed by namespace owner
3103
+ */
3104
+ _version?: "1.1.0";
3105
+ /**
3106
+ * Represents the target technical id for a WCF Application
3107
+ */
3108
+ "wcf-target-id": string;
3109
+ }
3110
+ /**
3111
+ * Represents specific attributes for Smart Business
3112
+ */
3113
+ export interface JSONSchemaForSAPUISMARTBUSINESSAPPNamespace {
3114
+ [k: string]: unknown;
3115
+ }
3116
+ /**
3117
+ * Represents mobile specific attributes
3118
+ */
3119
+ export interface JSONSchemaForSAPMOBILENamespace {
3120
+ /**
3121
+ * Represents attributes format version. It is managed by namespace owner
3122
+ */
3123
+ _version?: "1.1.0";
3124
+ /**
3125
+ * Represents mobile specific attributes
3126
+ */
3127
+ definingRequests: {
3128
+ [k: string]: DefiningRequest;
3129
+ };
3130
+ [k: string]: unknown;
3131
+ }
3132
+ /**
3133
+ * This interface was referenced by `undefined`'s JSON-Schema definition
3134
+ * via the `patternProperty` "^[a-zA-Z0-9_\.\-]*".
3135
+ */
3136
+ export interface DefiningRequest {
3137
+ /**
3138
+ * Represents reference to dataSource under sap.app
3139
+ */
3140
+ dataSource: string;
3141
+ /**
3142
+ * Represents path to the title collection
3143
+ */
3144
+ path: string;
3145
+ /**
3146
+ * Represents indicator whether streams should be retrieved
3147
+ */
3148
+ retrieveStreams?: boolean;
3149
+ }
3150
+ /**
3151
+ * Represents specific attributes for SAP CoPilot
3152
+ */
3153
+ export interface JSONSchemaForSAPCOPILOTNamespace {
3154
+ /**
3155
+ * Represents SAP.COPILOT attributes format version. It is managed by namespace owner
3156
+ */
3157
+ _version?: "1.0.0" | "1.1.0";
3158
+ /**
3159
+ * Settings for the context analysis features of SAP CoPilot
3160
+ */
3161
+ contextAnalysis?: {
3162
+ /**
3163
+ * Enable/Disable the ability for SAP CoPilot to analyze your Application Screens and add the found objects to a Collection
3164
+ */
3165
+ allowAddingObjectsFromAppScreenToCollection?: boolean;
3166
+ /**
3167
+ * 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.
3168
+ */
3169
+ whitelistedEntityTypes?: string[];
3170
+ [k: string]: unknown;
3171
+ };
3172
+ /**
3173
+ * Settings for the Digital Assistant features of SAP CoPilot
3174
+ */
3175
+ digitalAssistant?: {
3176
+ /**
3177
+ * A list of Intent
3178
+ */
3179
+ intentDefinition?: {
3180
+ /**
3181
+ * This interface was referenced by `undefined`'s JSON-Schema definition
3182
+ * via the `patternProperty` "^[a-zA-Z0-9_\.\-]*$".
3183
+ */
3184
+ [k: string]: {
3185
+ /**
3186
+ * Represents the uri of the intent
3187
+ */
3188
+ uri?: string;
3189
+ /**
3190
+ * A list of the sap.app.dataSources used by the intent
3191
+ */
3192
+ dataSources?: string[];
3193
+ /**
3194
+ * Represents the uri of the translation file
3195
+ */
3196
+ i18n?: string;
3197
+ [k: string]: unknown;
3198
+ };
3199
+ };
3200
+ [k: string]: unknown;
3201
+ };
3202
+ [k: string]: unknown;
3203
+ }
3204
+ /**
3205
+ * Represents specific attributes for SAP.MAP
3206
+ */
3207
+ export interface JSONSchemaForSAPMAPNamespace {
3208
+ [k: string]: unknown;
3209
+ }
3210
+ /**
3211
+ * Represents specific attributes for SAP URL
3212
+ */
3213
+ export interface JSONSchemaForSAPURLNamespace {
3214
+ /**
3215
+ * Represents attributes format version. It is managed by namespace owner
3216
+ */
3217
+ _version?: "1.0.0";
3218
+ /**
3219
+ * Represents URI of an application
3220
+ */
3221
+ uri: string;
3222
+ }
3223
+ /**
3224
+ * Represents SFSF platform specific attributes
3225
+ */
3226
+ export interface JSONSchemaForSAPPLATFORMSFSFNamespace {
3227
+ /**
3228
+ * Represents attributes format version. It is managed by namespace owner
3229
+ */
3230
+ _version?: "1.0.0";
3231
+ /**
3232
+ * Represents the uri inside the SFSF app
3233
+ */
3234
+ uri?: string;
3235
+ /**
3236
+ * Represents the SFSF application name
3237
+ */
3238
+ appName: string;
3239
+ /**
3240
+ * Represents the version of the SFSF application
3241
+ */
3242
+ appVersion?: string;
3243
+ }
3244
+ /**
3245
+ * Represents cloud platform specific attributes
3246
+ */
3247
+ export interface JSONSchemaForSAPCLOUDNamespace {
3248
+ /**
3249
+ * Represents attributes format version. It is managed by namespace owner
3250
+ */
3251
+ _version?: "1.0.0" | "1.1.0" | "1.2.0";
3252
+ /**
3253
+ * Unique Business Service Identifier
3254
+ */
3255
+ service?: string;
3256
+ /**
3257
+ * Specify if the UI can be accessed from a different space than origin development space
3258
+ */
3259
+ public?: boolean;
3260
+ }
3261
+ /**
3262
+ * Represents general package attributes. Experimental, will be detailed in the future
3263
+ */
3264
+ export interface JSONSchemaForSAPPACKAGENamespace {
3265
+ /**
3266
+ * Represents SAP.PACKAGE attributes format version. It is managed by namespace owner
3267
+ */
3268
+ _version?: "1.0.0" | "1.1.0";
3269
+ /**
3270
+ * Represents mandatory unique package identifier
3271
+ */
3272
+ id: string;
3273
+ /**
3274
+ * Represents path inside the package to the properties file containing text symbols for the packages texts
3275
+ */
3276
+ i18n?: string;
3277
+ /**
3278
+ * Represents mandatory semantic version of the package information and optional the upgrade notification
3279
+ */
3280
+ packageVersion: {
3281
+ /**
3282
+ * Represents mandatory semantic version of the package
3283
+ */
3284
+ version: string;
3285
+ /**
3286
+ * Represents optional upgrade notification once the package is available. none - no notification, package will be installed automatically for any version. major - notification before a new major version is installed. major.minor - notification before a major and minor version is installed. all - notification before any new version is installed, including patches
3287
+ */
3288
+ upgradeNotification?: "none" | "major" | "major.minor" | "all";
3289
+ [k: string]: unknown;
3290
+ };
3291
+ /**
3292
+ * Represents type of an package and can be card, workflow, workspace-template
3293
+ */
3294
+ type?: "card" | "workflow" | "workspace-template";
3295
+ /**
3296
+ * Represents a title (mandatory); to make this property language dependent (recommended), use a key in double curly brackets '{{key}}'
3297
+ */
3298
+ title: string;
3299
+ /**
3300
+ * Represents a subtitle to the title; to make this property language dependent (recommended), use a key in double curly brackets '{{key}}'
3301
+ */
3302
+ subTitle?: string;
3303
+ /**
3304
+ * Represents a shorter version of the title; to make this property language dependent (recommended), use a key in double curly brackets '{{key}}'
3305
+ */
3306
+ shortTitle?: string;
3307
+ /**
3308
+ * Represents additional information to the title; to make this property language dependent (recommended), use a key in double curly brackets '{{key}}'
3309
+ */
3310
+ info?: string;
3311
+ /**
3312
+ * Represents a description; to make this property language dependent (recommended), use a key in double curly brackets '{{key}}'
3313
+ */
3314
+ description: string;
3315
+ /**
3316
+ * Represents icon name or source URL for the package
3317
+ */
3318
+ icon?: string;
3319
+ /**
3320
+ * Represents array of keywords used to find the package
3321
+ */
3322
+ tags?: {
3323
+ keywords: Tag;
3324
+ technicalAttributes?: string[];
3325
+ [k: string]: unknown;
3326
+ };
3327
+ vendor: Vendor;
3328
+ homepage?: Infolink;
3329
+ support: Infolink1;
3330
+ documentation?: Infolink2;
3331
+ contents?: Contentitem[];
3332
+ /**
3333
+ * Represents list of product ids that are allowed to consume this package. if not defined all products that are capable of installing this package are allowed
3334
+ */
3335
+ consumption?: string[];
3336
+ /**
3337
+ * Represents the products and service that the pacakge depends on
3338
+ */
3339
+ dependencies?: {
3340
+ /**
3341
+ * List of products that this package depends on
3342
+ */
3343
+ products?: string[];
3344
+ /**
3345
+ * List of services that this package depends on
3346
+ */
3347
+ services?: string[];
3348
+ [k: string]: unknown;
3349
+ };
3350
+ [k: string]: unknown;
3351
+ }
3352
+ /**
3353
+ * Represents the support information
3354
+ */
3355
+ export interface Vendor {
3356
+ /**
3357
+ * Represents the vendor id
3358
+ */
3359
+ id: string;
3360
+ /**
3361
+ * Represents the vendor name
3362
+ */
3363
+ name: string;
3364
+ /**
3365
+ * Represents the vendor line of business within the vendors organization if any
3366
+ */
3367
+ lineOfBusiness?: string;
3368
+ /**
3369
+ * Represents a target url
3370
+ */
3371
+ url: string;
3372
+ [k: string]: unknown;
3373
+ }
3374
+ /**
3375
+ * Represents the homepage information
3376
+ */
3377
+ export interface Infolink {
3378
+ /**
3379
+ * Represents a target url
3380
+ */
3381
+ url: string;
3382
+ /**
3383
+ * Represents a descriptive text for the target
3384
+ */
3385
+ text: string;
3386
+ [k: string]: unknown;
3387
+ }
3388
+ /**
3389
+ * Represents the support information
3390
+ */
3391
+ export interface Infolink1 {
3392
+ /**
3393
+ * Represents a target url
3394
+ */
3395
+ url: string;
3396
+ /**
3397
+ * Represents a descriptive text for the target
3398
+ */
3399
+ text: string;
3400
+ [k: string]: unknown;
3401
+ }
3402
+ /**
3403
+ * Represents the documentation information
3404
+ */
3405
+ export interface Infolink2 {
3406
+ /**
3407
+ * Represents a target url
3408
+ */
3409
+ url: string;
3410
+ /**
3411
+ * Represents a descriptive text for the target
3412
+ */
3413
+ text: string;
3414
+ [k: string]: unknown;
3415
+ }
3416
+ /**
3417
+ * Represents the artifacts contained in the package
3418
+ */
3419
+ export interface Contentitem {
3420
+ /**
3421
+ * Relative url to the artifact within the folder in this package
3422
+ */
3423
+ baseURL?: string;
3424
+ /**
3425
+ * Wraps the child manifest
3426
+ */
3427
+ manifest?: {
3428
+ /**
3429
+ * The artifacts manifest
3430
+ */
3431
+ "sap.artifact"?: {
3432
+ [k: string]: unknown;
3433
+ };
3434
+ [k: string]: unknown;
3435
+ };
3436
+ [k: string]: unknown;
3437
+ }
3438
+ /**
3439
+ * Represents general artifact attributes.
3440
+ */
3441
+ export interface JSONSchemaForSAPARTIFACTNamespace {
3442
+ /**
3443
+ * Represents SAP.ARTIFACT attributes format version. It is managed by namespace owner
3444
+ */
3445
+ _version?: "1.0.0" | "1.1.0";
3446
+ /**
3447
+ * Represents mandatory unique artifact identifier
3448
+ */
3449
+ id: string;
3450
+ /**
3451
+ * Represents path inside the artifact to the properties file containing text symbols for the artifacts texts
3452
+ */
3453
+ i18n?: string;
3454
+ /**
3455
+ * Represents mandatory semantic version of the artifact
3456
+ */
3457
+ artifactVersion: {
3458
+ version: Semanticversion;
3459
+ [k: string]: unknown;
3460
+ };
3461
+ /**
3462
+ * Represents type of an artifact and can be card, workflow, workspace-template
3463
+ */
3464
+ type: "card" | "workflow" | "workspace-template";
3465
+ /**
3466
+ * Represents a title (mandatory); to make this property language dependent (recommended), use a key in double curly brackets '{{key}}'
3467
+ */
3468
+ title: string;
3469
+ /**
3470
+ * Represents a subtitle to the title; to make this property language dependent (recommended), use a key in double curly brackets '{{key}}'
3471
+ */
3472
+ subTitle?: string;
3473
+ /**
3474
+ * Represents a shorter version of the title; to make this property language dependent (recommended), use a key in double curly brackets '{{key}}'
3475
+ */
3476
+ shortTitle?: string;
3477
+ /**
3478
+ * Represents additional information to the title; to make this property language dependent (recommended), use a key in double curly brackets '{{key}}'
3479
+ */
3480
+ info?: string;
3481
+ /**
3482
+ * Represents a description; to make this property language dependent (recommended), use a key in double curly brackets '{{key}}'
3483
+ */
3484
+ description: string;
3485
+ /**
3486
+ * Represents icon name or source URL for the artifact
3487
+ */
3488
+ icon?: string;
3489
+ /**
3490
+ * Represents array of keywords used to find the artifact
3491
+ */
3492
+ tags?: {
3493
+ keywords: Tag;
3494
+ technicalAttributes?: string[];
3495
+ [k: string]: unknown;
3496
+ };
3497
+ [k: string]: unknown;
3498
+ }