@ui5/manifest 1.49.2 → 1.50.0

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