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