@sap/ux-specification 1.96.10 → 1.96.13

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.
Files changed (63) hide show
  1. package/CHANGELOG.md +83 -16
  2. package/dist/documentation/v2/v2-AnalyticalListPage.html +1 -1
  3. package/dist/documentation/v2/v2-ApplicationV2.html +1 -1
  4. package/dist/documentation/v2/v2-ListReport.html +1 -1
  5. package/dist/documentation/v2/v2-ObjectPage.html +1 -1
  6. package/dist/documentation/v2/v2-OverviewPage.html +1 -1
  7. package/dist/documentation/v4/v4-ApplicationV4.html +1 -1
  8. package/dist/documentation/v4/v4-ListReport.html +1 -1
  9. package/dist/documentation/v4/v4-ObjectPage.html +1 -1
  10. package/dist/index-min.js +1 -1
  11. package/dist/schemas/v2/AnalyticalListPageConfig.json +10 -10
  12. package/dist/schemas/v2/ListReportConfig.json +15 -15
  13. package/dist/schemas/v2/ObjectPageConfig.json +204 -20
  14. package/dist/schemas/v4/ListReportConfig.json +22 -2
  15. package/dist/schemas/v4/ObjectPageConfig.json +36 -0
  16. package/dist/specification/v2/index-min.js +1 -1
  17. package/dist/src/apiTypes.d.ts +5 -4
  18. package/dist/src/project.d.ts +1 -0
  19. package/dist/src/specification/v2/controls/Action.d.ts +6 -4
  20. package/dist/src/specification/v2/controls/Facets.d.ts +2 -1
  21. package/dist/src/specification/v2/controls/ObjectPageHeader.d.ts +3 -2
  22. package/dist/src/specification/v2/controls/ObjectPageSection.d.ts +44 -9
  23. package/dist/src/specification/v2/controls/ObjectPageTable.d.ts +5 -3
  24. package/dist/src/specification/v2/controls/Table.d.ts +7 -4
  25. package/dist/src/specification/v4/controls/ObjectPageSection.d.ts +22 -1
  26. package/dist/src/specification/v4/controls/Table.d.ts +4 -0
  27. package/dist/src/sync/common/appProvider.d.ts +1 -1
  28. package/dist/src/sync/common/decoration/control.d.ts +1 -1
  29. package/dist/src/sync/common/decoration/decorators.d.ts +2 -2
  30. package/dist/src/sync/common/generate/objectPage.d.ts +8 -9
  31. package/dist/src/sync/common/generate/utils.d.ts +62 -13
  32. package/dist/src/sync/common/import/utils.d.ts +9 -2
  33. package/dist/src/sync/common/importProject.d.ts +2 -3
  34. package/dist/src/sync/common/types.d.ts +65 -9
  35. package/dist/src/sync/common/utils.d.ts +30 -23
  36. package/dist/src/sync/v2/application.d.ts +3 -3
  37. package/dist/src/sync/v2/export/controls/Action.d.ts +12 -10
  38. package/dist/src/sync/v2/export/controls/FormAction.d.ts +9 -7
  39. package/dist/src/sync/v2/export/controls/ObjectPageFooterAction.d.ts +6 -4
  40. package/dist/src/sync/v2/export/controls/ObjectPageHeader.d.ts +3 -2
  41. package/dist/src/sync/v2/export/controls/ObjectPageHeaderAction.d.ts +6 -4
  42. package/dist/src/sync/v2/export/controls/ObjectPageSectionsV2.d.ts +26 -14
  43. package/dist/src/sync/v2/export/controls/ObjectPageTable.d.ts +5 -3
  44. package/dist/src/sync/v2/export/controls/ObjectPageToolBarAction.d.ts +6 -4
  45. package/dist/src/sync/v2/export/controls/Table.d.ts +6 -3
  46. package/dist/src/sync/v2/export/controls/TableColumn.d.ts +12 -10
  47. package/dist/src/sync/v2/export/export.d.ts +0 -1
  48. package/dist/src/sync/v2/export/manifest.d.ts +6 -0
  49. package/dist/src/sync/v2/export/pages/OverviewPage.d.ts +1 -1
  50. package/dist/src/sync/v2/generate/listReport.d.ts +3 -4
  51. package/dist/src/sync/v2/generate/utils.d.ts +11 -9
  52. package/dist/src/sync/v2/import/app/appProvider.d.ts +9 -0
  53. package/dist/src/sync/v2/types.d.ts +8 -3
  54. package/dist/src/sync/v4/application.d.ts +22 -10
  55. package/dist/src/sync/v4/export/controls/Table.d.ts +8 -2
  56. package/dist/src/sync/v4/export/types.d.ts +5 -5
  57. package/dist/src/sync/v4/generate/listReport.d.ts +2 -2
  58. package/dist/src/sync/v4/generate/objectPage.d.ts +1 -1
  59. package/dist/src/sync/v4/import/pages/objectPage.d.ts +13 -0
  60. package/dist/src/sync/v4/import/utils.d.ts +2 -1
  61. package/dist/src/sync/v4/types.d.ts +2 -0
  62. package/dist/src/sync/v4/utils/utils.d.ts +10 -11
  63. package/package.json +8 -8
@@ -1,5 +1,6 @@
1
1
  import type { DeprecatedProperties, SyncRule } from '../';
2
2
  import type { ExtensionLogger } from '../../../apiTypes';
3
+ import type { Definition } from 'typescript-json-schema';
3
4
  /**
4
5
  * Transfers the value of a single manifest setting to the config
5
6
  * @param syncRule - Metadata rule
@@ -22,11 +23,11 @@ export declare function importProperty(syncRule: SyncRule, manifestSection: {},
22
23
  */
23
24
  export declare function checkDeprecatedProperties(deprecatedProperties: DeprecatedProperties | undefined, manifestSection: {}, path: string, logger?: ExtensionLogger): void;
24
25
  /**
25
- * get title of the section (Facet ID)
26
+ * Determines the title of a section representation in the app schema, main aspect is checking the facet ID
26
27
  * @param schemaSection - Section in manifest.json
27
28
  * @param jsonSchema - app specific schema
28
29
  */
29
- export declare function getSectionTitle(schemaSection: object, jsonSchema: object): string;
30
+ export declare function getSectionTitle(schemaSection: Definition, jsonSchema: Definition): string | undefined;
30
31
  /**
31
32
  * Method returns target by resolving custom column reference name.
32
33
  * For example - 'TableCustomColumns<dummyTarget>' is resolved as 'dummyTarget'.
@@ -34,3 +35,9 @@ export declare function getSectionTitle(schemaSection: object, jsonSchema: objec
34
35
  * @returns {string | undefined} Resolved target.
35
36
  */
36
37
  export declare function getTargetFromCustomColumnRef(ref: string): string | undefined;
38
+ /**
39
+ * Removes part of a given config, if empty
40
+ * @param {object} config - config part
41
+ * @param {string} structure - part of config to be removed
42
+ */
43
+ export declare function removeEmptyStructure(config: object, structure: string): void;
@@ -1,8 +1,7 @@
1
- import type { ConverterOutput } from '@sap-ux/vocabularies-types';
2
- import type { EntitySet } from '@sap-ux/vocabularies-types/dist/Converter';
1
+ import type { ConvertedMetadata, EntitySet } from '@sap-ux/vocabularies-types';
3
2
  import type { ImportProjectParameters } from '../../apiTypes';
4
3
  import type { File } from './types';
5
- export declare function getEntitySetByEntitySetName(entitySetName: string, oDataServiceAVT: ConverterOutput): EntitySet;
4
+ export declare function getEntitySetByEntitySetName(entitySetName: string, oDataServiceAVT: ConvertedMetadata): EntitySet;
6
5
  /**
7
6
  * Import the schema and config files for a given project
8
7
  * @param {ImportProjectParameters} importParameters - files of the project: manifest, flex changes, odata files
@@ -1,6 +1,8 @@
1
1
  import type { Manifest } from '../../specification/common/webapp/manifest';
2
- import type { EntityType } from '@sap-ux/vocabularies-types';
2
+ import type { AnnotationTerm, EntityType } from '@sap-ux/vocabularies-types';
3
+ import type { CollectionFacet, ReferenceFacet, ReferenceURLFacet } from '@sap-ux/vocabularies-types/vocabularies/UI';
3
4
  import type { ManifestSettingsType } from '../../specification/common/types';
5
+ export declare type anyFacetType = AnnotationTerm<CollectionFacet> | AnnotationTerm<ReferenceFacet> | AnnotationTerm<ReferenceURLFacet>;
4
6
  export declare enum ExportArtifacts {
5
7
  flex = "flex",
6
8
  manifest = "manifest"
@@ -35,6 +37,7 @@ export interface ExportResults {
35
37
  }
36
38
  export declare enum SectionType {
37
39
  Section = "Section",
40
+ SubSection = "SubSection",
38
41
  HeaderSection = "HeaderSection"
39
42
  }
40
43
  export declare enum ArtifactType {
@@ -109,12 +112,13 @@ export interface FlexAdapter {
109
112
  importFlexValue?: importFlexValue;
110
113
  }
111
114
  export declare type ManifestPath = (pageKeys?: string[], manifest?: Manifest, ...pathParts: string[]) => string;
115
+ export declare type ExportHandlerFunction = (manifestSection: unknown, configObject: unknown, key: string, manifestKey?: string, ...pathParts: string[]) => unknown;
112
116
  export interface ManifestConverter {
113
117
  path: ManifestPath;
114
118
  key?: string;
115
119
  import?: ((manifestSection: unknown, sectionId?: string, propertyKey?: string, breadcrumbs?: string[]) => unknown) | boolean;
116
- export?: ((manifestSection: unknown, configObject: unknown, key: string, manifestKey?: string, ...pathParts: string[]) => unknown) | boolean;
117
- delete?: (manifestSection: unknown, configObject: unknown, key: string, manifestKey: string) => unknown;
120
+ export?: ExportHandlerFunction | boolean;
121
+ delete?: ((manifestSection: unknown, configObject: unknown, key: string, manifestKey: string, syncRuleKey?: string) => unknown) | boolean;
118
122
  }
119
123
  export interface SyncRule {
120
124
  flex?: FlexAdapter;
@@ -168,6 +172,7 @@ export declare enum FacetBase {
168
172
  DataPoint = "DataPoint",
169
173
  Address = "Address",
170
174
  Contact = "Contact",
175
+ PresentationVariant = "PresentationVariant",
171
176
  Unknown = ""
172
177
  }
173
178
  export interface FacetConfig {
@@ -178,6 +183,7 @@ export interface FacetConfig {
178
183
  entityType?: EntityType;
179
184
  annotationPath?: string;
180
185
  target?: object;
186
+ facets?: FacetConfigs;
181
187
  }
182
188
  export interface SubSectionConfig {
183
189
  base: FacetBase;
@@ -230,31 +236,67 @@ export declare enum DefinitionName {
230
236
  AnalyticalListPageFilterBar = "AnalyticalListPageFilterBar",
231
237
  AnnotationPathAsObject = "AnnotationPathAsObject",
232
238
  ChartToolBarAction = "ChartToolBarAction",
239
+ CommonHeaderFacetSettings = "CommonHeaderFacetSettings",
233
240
  CustomColumn = "TableCustomColumn",
234
241
  CustomColumnOP = "TableCustomColumnOP",
235
242
  CustomColumns = "TableCustomColumns",
243
+ CustomSections = "CustomSections",
244
+ FieldPath = "FieldPath",
245
+ Field = "Field",
236
246
  Fields = "Fields",
247
+ Fields4Dialog = "Fields4Dialog",
248
+ FilterBar = "FilterBar",
249
+ Footer = "Footer",
237
250
  FooterActions = "FooterActions",
238
251
  Form = "Form",
239
252
  FormAction = "FormAction",
240
253
  GenericActions = "GenericActions",
254
+ GenericColumnsOP = "GenericColumnsOP",
255
+ GenericFooter = "GenericFooter",
256
+ GenericSections = "GenericSections",
241
257
  HeaderActions = "HeaderActions",
258
+ HeaderSections = "HeaderSections",
242
259
  LineItems = "LineItems",
243
260
  LineItemsOfView = "LineItemsOfView",
244
261
  ListReportFilterBar = "ListReportFilterBar",
245
262
  LRTableView = "LRTableView",
246
263
  LRChartView = "LRChartView",
247
264
  MultiTableModeV4 = "MultiTableModeV4",
265
+ ObjectPageChart = "ObjectPageChart",
266
+ ObjectPageCustomSectionFragment = "ObjectPageCustomSectionFragment",
248
267
  ObjectPageFooter = "ObjectPageFooter",
249
268
  ObjectPageFooterAction = "ObjectPageFooterAction",
250
269
  ObjectPageFooterActions = "ObjectPageFooterActions",
251
270
  ObjectPageHeader = "ObjectPageHeader",
271
+ ObjectPageHeaderSectionForm = "ObjectPageHeaderSectionForm",
272
+ ObjectPageHeaderSectionChart = "ObjectPageHeaderSectionChart",
273
+ ObjectPageHeaderSectionDataPoint = "ObjectPageHeaderSectionDataPoint",
274
+ ObjectPageHeaderSectionContact = "ObjectPageHeaderSectionContact",
275
+ ObjectPageHeaderSectionAddress = "ObjectPageHeaderSectionAddress",
276
+ ObjectPageLayout = "ObjectPageLayout",
277
+ ObjectPagePresentationVariant = "ObjectPagePresentationVariant",
278
+ ObjectPageSectionAddress = "ObjectPageSectionAddress",
279
+ ObjectPageSectionChart = "ObjectPageSectionChart",
280
+ ObjectPageSectionContact = "ObjectPageSectionContact",
281
+ ObjectPageSectionDataPoint = "ObjectPageSectionDataPoint",
282
+ ObjectPageSectionForm = "ObjectPageSectionForm",
283
+ ObjectPageSectionPresentationVariant = "ObjectPageSectionPresentationVariant",
284
+ ObjectPageSectionTableV4 = "ObjectPageSectionTableV4",
285
+ ObjectPageSubSections = "ObjectPageSubSections",
252
286
  ObjectPageTable = "ObjectPageTable",
253
287
  ObjectPageTableColumn = "ObjectPageTableColumn",
288
+ ObjectPageToolBar = "ObjectPageToolBar",
254
289
  ObjectPageToolBarAction = "ObjectPageToolBarAction",
290
+ ObjectPageToolBarActions = "ObjectPageToolBarActions",
255
291
  Position = "Position",
256
292
  PositionOP = "PositionOP",
293
+ QuickVariant = "QuickVariant",
294
+ QuickVariantSelectionOP = "QuickVariantSelectionOP",
295
+ QuickVariantSelectionV4OP = "QuickVariantSelectionV4OP",
296
+ RelatedFacetKeys = "RelatedFacetKeys",
297
+ Sections = "Sections",
257
298
  Table = "Table",
299
+ TableSPV = "TableSPV",
258
300
  TableColumn = "TableColumn",
259
301
  ToolBarAction = "ToolBarAction",
260
302
  ToolBarLR = "ToolBar<LineItems>",
@@ -262,23 +304,37 @@ export declare enum DefinitionName {
262
304
  ViewTableColumn = "ViewTableColumn",
263
305
  ViewCustomColumn = "ViewTableCustomColumn",
264
306
  ViewChartToolBar = "ViewChartToolBar",
265
- ViewToolBarAction = "ViewToolBarAction"
307
+ ViewToolBarAction = "ViewToolBarAction",
308
+ ViewPosition = "ViewPosition"
309
+ }
310
+ export declare enum PropertyName {
311
+ actions = "actions",
312
+ annotationPath = "annotationPath",
313
+ chart = "chart",
314
+ defaultPath = "defaultPath",
315
+ defaultTemplateAnnotationPath = "defaultTemplateAnnotationPath",
316
+ sections = "sections",
317
+ table = "table",
318
+ views = "views"
266
319
  }
267
320
  export declare enum SchemaTag {
268
- hidden = "hidden",
269
- isViewNode = "isViewNode",
270
321
  annotationPath = "annotationPath",
271
322
  annotationType = "annotationType",
272
- dataType = "dataType",
273
- propertyIndex = "propertyIndex",
274
323
  artifactType = "artifactType",
275
- key = "key"
324
+ controlType = "controlType",
325
+ dataType = "dataType",
326
+ fullyQualifiedName = "fullyQualifiedName",
327
+ hidden = "hidden",
328
+ isViewNode = "isViewNode",
329
+ key = "key",
330
+ propertyIndex = "propertyIndex"
276
331
  }
277
332
  export declare const METADATAPATH = "webapp/localService/metadata.xml";
278
333
  export declare const MANIFESTPATH = "webapp/manifest.json";
279
334
  export declare const VOCWITHSLASH = "/@com.sap.vocabularies";
280
335
  export declare const VOCWITHCOLONS = "::@com.sap.vocabularies";
281
336
  export declare const UIVOCABULARY = "com.sap.vocabularies.UI.v1";
337
+ export declare const UIVOCABULARYDOT = "com.sap.vocabularies.UI.v1.";
282
338
  export declare const QUICKVARPATH = "/quickVariantSelection";
283
339
  export declare const QUICKVARPATHX = "/quickVariantSelectionX";
284
340
  export declare const DATESETTINGSPATH = "/filterSettings/dateSettings";
@@ -1,10 +1,13 @@
1
- import type { FacetConfigs, FileData, FacetConfig, FacetSection, SchemaFilePath } from './types';
2
- import type { AnnotationTerm, CollectionFacet, ConverterOutput, DataFieldAbstractTypes, EntityType, PropertyAnnotations, PropertyPath, ReferenceFacet, ReferenceURLFacet } from '@sap-ux/vocabularies-types';
1
+ import type { Definition } from 'typescript-json-schema';
2
+ import type { ExtensionLogger } from '../../apiTypes';
3
+ import type { FacetConfigs, FileData, FacetConfig, FacetSection, SchemaFilePath, anyFacetType } from './types';
3
4
  import type { Manifest } from '../../specification/common';
5
+ import type { MetadataInstanceInterface } from './decoration/factory';
6
+ import type { DataFieldAbstractTypes } from '@sap-ux/vocabularies-types/vocabularies/UI';
7
+ import type { ConvertedMetadata, EntityType, PropertyPath } from '@sap-ux/vocabularies-types';
4
8
  import { FioriElementsVersion, PageType, PageTypeV4 } from '../../specification/common';
5
9
  import { SchemaType } from '../../specification/schemaAccess';
6
- import type { ExtensionLogger } from '../../apiTypes';
7
- import type { MetadataInstanceInterface } from './decoration/factory';
10
+ import type { PropertyAnnotations } from '@sap-ux/vocabularies-types/vocabularies/Edm_Types';
8
11
  export declare enum TemplateType {
9
12
  ListReportObjectPageV2 = "ListReportObjectPageV2",
10
13
  ListReportObjectPageV4 = "ListReportObjectPageV4",
@@ -26,7 +29,7 @@ export declare const createAnnotationPath: (entityTypeName: string, term: string
26
29
  * @param annotationFiles - The list of all annotation files, in JSON format
27
30
  * @returns the complete service information
28
31
  */
29
- export declare function parseAndMergeAndConvert(annotationFiles: FileData[], logger: ExtensionLogger): ConverterOutput;
32
+ export declare function parseAndMergeAndConvert(annotationFiles: FileData[], logger: ExtensionLogger): ConvertedMetadata;
30
33
  export declare const getAnnotationPropertyValue: (annotationProperty: any) => string;
31
34
  /**
32
35
  * Checks for Common.Label and overwrites the label from it if present
@@ -52,9 +55,15 @@ export declare function getLabelForDataField(field: DataFieldAbstractTypes, enti
52
55
  /**
53
56
  * Determines the description of a data field, e.g. for the column header
54
57
  * @param dataFieldAbstract - the given record of the line item annotation
55
- * @param entityType - the entity type as part of the AVT ConverterOutput
58
+ * @param entityType - the entity type as part of the AVT ConvertedMetadata
56
59
  */
57
- export declare function getDatafieldDescription(dataFieldAbstract: DataFieldAbstractTypes, entityType: EntityType): string;
60
+ export declare function getDataFieldDescription(dataFieldAbstract: DataFieldAbstractTypes, entityType: EntityType): string;
61
+ /**
62
+ * Prepare string for reference use in schema
63
+ * @param refInput string to be character checked and replaced
64
+ * @returns string with replaced characters
65
+ */
66
+ export declare function prepareRef(refInput: string): string;
58
67
  /**
59
68
  * Return the page type for a given V2 page in manifest
60
69
  * @param name - page component name
@@ -68,20 +77,20 @@ export declare function getPageTypeV4(name: string): PageTypeV4 | undefined;
68
77
  /**
69
78
  * Finds the alias for a given namespace in the references' section of the converted service metadata
70
79
  * @param {string} namespace - complete namespace, e.g. 'com.sap.vocabularies.UI.v1'
71
- * @param {ConverterOutput} oDataServiceAVT - combined service metadata, as returned by annotation vocabularies tools
80
+ * @param {ConvertedMetadata} oDataServiceAVT - combined service metadata, as returned by annotation vocabularies tools
72
81
  * @returns alias for the given namespace
73
82
  */
74
- export declare function findAlias(namespace: string, oDataServiceAVT: ConverterOutput): string;
83
+ export declare function findAlias(namespace: string, oDataServiceAVT: ConvertedMetadata): string;
75
84
  /**
76
85
  * Resolve page section(get key and label->description).
77
86
  * @param facetDefinition - the actual annotation record
78
87
  * @param keyForRelatedFacetKeys - construct key for 'keyForRelatedFacetKeys' property(used to define custom sections) - we should not add '@' symbol there.
79
88
  * @param {FioriElementsVersion} oDataVersion - OData version
80
- * @param {ConverterOutput} oDataServiceAVT - complete service information, as returned by annotation vocabularies tool
89
+ * @param {ConvertedMetadata} oDataServiceAVT - complete service information, as returned by annotation vocabularies tool
81
90
  * @param {ExtensionLogger} logger - Logger class for logging messages
82
91
  * @returns {FacetSection} - object comprising the relevant facet information
83
92
  */
84
- export declare function getSectionFacet(facetDefinition: AnnotationTerm<CollectionFacet> | AnnotationTerm<ReferenceFacet> | AnnotationTerm<ReferenceURLFacet>, sourceEntityType: EntityType, oDataServiceAVT: ConverterOutput, logger?: ExtensionLogger, oDataVersion?: FioriElementsVersion, keyForRelatedFacetKeys?: boolean): FacetSection | undefined;
93
+ export declare function getSectionFacet(facetDefinition: anyFacetType, sourceEntityType: EntityType, oDataServiceAVT: ConvertedMetadata, logger?: ExtensionLogger, oDataVersion?: FioriElementsVersion, keyForRelatedFacetKeys?: boolean): FacetSection | undefined;
85
94
  /**
86
95
  * Finds the alias for a given namespace in the references' section of the converted service metadata.
87
96
  * An empty object is created if the path element does not exist yet.
@@ -98,19 +107,19 @@ export declare function getSchemaKeyOfLineItemRecord(lineItemRecord: DataFieldAb
98
107
  /**
99
108
  * Retrieve header facet configurations that can be used to generate ObjectPage schemas
100
109
  * @param {QualifiedName} entityTypeName - the name of the actual entity type
101
- * @param {ConverterOutput} oDataServiceAVT - complete service information, as returned by annotation vocabularies tool
110
+ * @param {ConvertedMetadata} oDataServiceAVT - complete service information, as returned by annotation vocabularies tool
102
111
  * @param {FioriElementsVersion} oDataVersion - OData version
103
112
  * @param {ExtensionLogger} logger - Logger class for logging messages
104
113
  */
105
- export declare function getObjectPageHeaderFacets(entityType: EntityType, oDataServiceAVT: ConverterOutput, oDataVersion?: FioriElementsVersion, logger?: ExtensionLogger): FacetConfigs | undefined;
114
+ export declare function getObjectPageHeaderFacets(entityType: EntityType, oDataServiceAVT: ConvertedMetadata, oDataVersion?: FioriElementsVersion, logger?: ExtensionLogger): FacetConfigs | undefined;
106
115
  /**
107
116
  * Retrieve facet configurations that can be used to generate ObjectPage schemas
108
117
  * @param {QualifiedName} entityTypeName - the name of the actual entity type
109
- * @param {ConverterOutput} oDataServiceAVT - complete service information, as returned by annotation vocabularies tool
118
+ * @param {ConvertedMetadata} oDataServiceAVT - complete service information, as returned by annotation vocabularies tool
110
119
  * @param {FioriElementsVersion} oDataVersion - OData version
111
120
  * @param {ExtensionLogger} logger - Logger class for logging messages
112
121
  */
113
- export declare function getObjectPageFacets(entityType: EntityType, oDataServiceAVT: ConverterOutput, oDataVersion?: FioriElementsVersion, logger?: ExtensionLogger): FacetConfigs | undefined;
122
+ export declare function getObjectPageFacets(entityType: EntityType, oDataServiceAVT: ConvertedMetadata, oDataVersion?: FioriElementsVersion, logger?: ExtensionLogger): FacetConfigs | undefined;
114
123
  /**
115
124
  * Returns the version of Fiori elements (v2/v4) from a given manifest
116
125
  * @param manifest - the manifest.json file
@@ -144,30 +153,30 @@ export declare function getTemplateTypeFromManifest(manifest: Manifest, fioriEle
144
153
  * @param section - section in the app schema
145
154
  * @param facetKey - key of the facet
146
155
  */
147
- export declare function addSectionTitleAndDescription(facet: FacetConfig, section: object, facetKey: string): void;
156
+ export declare function addSectionTitleAndDescription(facet: FacetConfig, section: Definition, facetKey: string): void;
148
157
  /**
149
158
  * Adds target title or description to a section or header section in an app schema
150
159
  * @param facet - intermediate facet structure comprising annotation information
151
160
  * @param section - section in the app schema
152
161
  * @param facetKey - key of the facet
153
162
  */
154
- export declare function addTargetTitleAndSectionDescription(facet: FacetConfig, section: object, facetKey: string): void;
163
+ export declare function addTargetTitleAndSectionDescription(facet: FacetConfig, section: Definition, facetKey: string): void;
155
164
  /**
156
165
  * Creates a default object for a new section or subsection, and adds the ID as title if present.
157
166
  * @param facet Facet configuration, to be analyzed
158
167
  * @returns the new section object
159
168
  */
160
- export declare function createSectionWithoutProperties(facet: FacetConfig, facetKey: string): object;
169
+ export declare function createDefaultSection(appSchema: Definition, facet: FacetConfig, facetKey: string): Definition;
161
170
  /**
162
171
  * Retrieve page section data(so far id/key and label/description).
163
172
  * @param {EntityType} entityType The actual entityType
164
- * @param {ConverterOutput} oDataServiceAVT - complete service information, as returned by annotation vocabularies tool
173
+ * @param {ConvertedMetadata} oDataServiceAVT - complete service information, as returned by annotation vocabularies tool
165
174
  * @param {ExtensionLogger} logger - Logger class for logging messages
166
175
  * @param {FioriElementsVersion} oDataVersion - OData version
167
176
  * @param {boolean} [checkUnresolvableFacets=false] - Check and avoid facets and sections without ID and Target.
168
177
  * @returns {FacetSection[]} - Array of facets or sections
169
178
  */
170
- export declare function getObjectPageFacetSection(entityType: EntityType, oDataServiceAVT: ConverterOutput, logger?: ExtensionLogger, oDataVersion?: FioriElementsVersion, checkUnresolvableFacets?: boolean): FacetSection[];
179
+ export declare function getObjectPageFacetSection(entityType: EntityType, oDataServiceAVT: ConvertedMetadata, logger?: ExtensionLogger, oDataVersion?: FioriElementsVersion, checkUnresolvableFacets?: boolean): FacetSection[];
171
180
  /**
172
181
  * Cleans empty sub-structures from the export result for manifest
173
182
  * @param manifest - manifest.json part of the export result
@@ -188,11 +197,10 @@ export declare const getSchemaFilePath: (schemaType: PageType | PageTypeV4 | Sch
188
197
  * @param appVersion - Fiori Elements version - V2 or V4.
189
198
  * @param pageType - Page type.
190
199
  * @param entitySet - Entity Set.
191
- * @param navigationProperty - Navigation property (optional).
192
200
  * @param viewId - Custom page's viewId (optional).
193
201
  * @returns {string} Generated page id
194
202
  */
195
- export declare function generatePageId(pageType: PageType | PageTypeV4, entitySet: string, navigationProperty?: string, viewId?: string): string;
203
+ export declare function generatePageId(pageType: PageType | PageTypeV4, entitySet: string, viewId?: string): string;
196
204
  export declare type NextDefinition = {
197
205
  configObject?: object;
198
206
  targetDefinition?: object;
@@ -209,7 +217,6 @@ export declare type NextDefinition = {
209
217
  * @param pageType - page type
210
218
  */
211
219
  export declare function getNextTargetDefinition(appSchema: object, title: string, currentConfigObject: object, propertyDefinition: object, key: string, factory: MetadataInstanceInterface, pageType: PageType | PageTypeV4): NextDefinition;
212
- export declare function prepareRef(refInput: string): string;
213
220
  /**
214
221
  * Custom array merge function called by deepmerge's merge function
215
222
  *
@@ -4,18 +4,18 @@ export declare const getAppSettingPathV2: (pageKeys: string[]) => string;
4
4
  export declare const getTableSettingPathV2: (pageKeys: string[]) => string;
5
5
  export declare const getChartSettingPathV2: (pageKeys: string[]) => string;
6
6
  export declare const getDataLoadSettingPathV2: (pageKeys: string[]) => string;
7
- export declare const getCreationFieldsPathV2: (pageKeys: string[], manifest: Manifest, key: string) => string;
7
+ export declare const getCreationFieldsPathV2: (pageKeys: string[], key: string) => string;
8
8
  export declare const getOVPsettingPath: () => string;
9
9
  export declare const getCardSettingsPath: (cardKey: string[]) => string;
10
10
  export declare const getGlobalSettingsPath: (cardKey: string[]) => string;
11
- export declare const getKPISettingsPath: (pageKeys: string[], manifest: Manifest, kpiKey: string) => string;
11
+ export declare const getKPISettingsPath: (pageKeys: string[], kpiKey: string) => string;
12
12
  export declare const getAppRootSettingOBJPath: (pageKeys: string[]) => string;
13
13
  export declare const getAppSettingOBJPathV2: (pageKeys: string[]) => string;
14
14
  export declare const getAppSettingOBJsectionPathV2: (pageKeys: string[], manifest: Manifest, sectionId: string) => string;
15
15
  export declare const getTableSettingsOBJsectionPathV2: (pageKeys: string[], manifest: Manifest, sectionId: string) => string;
16
16
  export declare const getChartSettingsOBJsectionPathV2: (pageKeys: string[], manifest: Manifest, sectionId: string) => string;
17
17
  export declare const getViewExtensionsPath: () => string;
18
- export declare const getObjectPageCustomSectionPath: (pageName: string[], manifest: Manifest, sectionId: string, ...pathParts: string[]) => string;
18
+ export declare const getObjectPageCustomSectionPath: (pageName: string[], _manifest: Manifest, sectionId: string, ...pathParts: string[]) => string;
19
19
  export declare class ApplicationV2 implements Application {
20
20
  id?: string;
21
21
  pages?: Pages;
@@ -1,5 +1,7 @@
1
- /// <reference types="@sapui5/ts-types" />
1
+ /// <reference types="@sapui5/ts-types-esm" />
2
2
  import type { Action as ActionConfig } from '../../../../specification/v2';
3
+ import type { ButtonType } from 'sap/m/library';
4
+ import type { URI } from 'sap/ui/core/library';
3
5
  /**
4
6
  * Create stable ID for Intent Based Action button
5
7
  *
@@ -11,19 +13,19 @@ import type { Action as ActionConfig } from '../../../../specification/v2';
11
13
  export declare const buildIntentBasedActionId: (baseId: string, _idBreadcrumbs: string[], breadcrumbs: string[]) => string;
12
14
  export declare class Action implements ActionConfig {
13
15
  tooltip?: string;
14
- icon?: sap.ui.core.URI;
15
- activeIcon?: sap.ui.core.URI;
16
- type?: sap.m.ButtonType;
16
+ icon?: URI;
17
+ activeIcon?: URI;
18
+ type?: ButtonType;
17
19
  }
18
20
  export declare class ToolBarAction implements ActionConfig {
19
21
  tooltip?: string;
20
- icon?: sap.ui.core.URI;
21
- activeIcon?: sap.ui.core.URI;
22
- type?: sap.m.ButtonType;
22
+ icon?: URI;
23
+ activeIcon?: URI;
24
+ type?: ButtonType;
23
25
  }
24
26
  export declare class FooterAction implements ActionConfig {
25
27
  tooltip?: string;
26
- icon?: sap.ui.core.URI;
27
- activeIcon?: sap.ui.core.URI;
28
- type?: sap.m.ButtonType;
28
+ icon?: URI;
29
+ activeIcon?: URI;
30
+ type?: ButtonType;
29
31
  }
@@ -1,16 +1,18 @@
1
- /// <reference types="@sapui5/ts-types" />
1
+ /// <reference types="@sapui5/ts-types-esm" />
2
2
  import type { FormAction as FormActionConfig } from '../../../../specification/v2';
3
+ import type { ButtonType } from 'sap/m/library';
4
+ import type { URI } from 'sap/ui/core/library';
3
5
  export declare class FormAction implements FormActionConfig {
4
6
  visible: boolean;
5
7
  tooltip?: string;
6
- icon?: sap.ui.core.URI;
7
- activeIcon?: sap.ui.core.URI;
8
- type?: sap.m.ButtonType;
8
+ icon?: URI;
9
+ activeIcon?: URI;
10
+ type?: ButtonType;
9
11
  }
10
12
  export declare class FieldForAction implements FormActionConfig {
11
13
  visible: boolean;
12
14
  tooltip?: string;
13
- icon?: sap.ui.core.URI;
14
- activeIcon?: sap.ui.core.URI;
15
- type?: sap.m.ButtonType;
15
+ icon?: URI;
16
+ activeIcon?: URI;
17
+ type?: ButtonType;
16
18
  }
@@ -1,9 +1,11 @@
1
- /// <reference types="@sapui5/ts-types" />
1
+ /// <reference types="@sapui5/ts-types-esm" />
2
2
  import type { ObjectPageFooterAction as FooterActionConfig } from '../../../../specification/v2';
3
+ import type { ButtonType } from 'sap/m/library';
4
+ import type { URI } from 'sap/ui/core/library';
3
5
  export declare class ObjectPageFooterAction implements FooterActionConfig {
4
6
  visible: boolean;
5
7
  tooltip?: string;
6
- icon?: sap.ui.core.URI;
7
- activeIcon?: sap.ui.core.URI;
8
- type?: sap.m.ButtonType;
8
+ icon?: URI;
9
+ activeIcon?: URI;
10
+ type?: ButtonType;
9
11
  }
@@ -1,9 +1,10 @@
1
- /// <reference types="@sapui5/ts-types" />
1
+ /// <reference types="@sapui5/ts-types-esm" />
2
2
  import type { ObjectPageHeader as ObjectPageHeaderConfig, GenericActions } from '../../../../specification/v2/controls/ObjectPageHeader';
3
+ import type AvatarShape from 'sap/m/AvatarShape';
3
4
  export declare class ObjectPageHeader<ACT = GenericActions> implements ObjectPageHeaderConfig<ACT> {
4
5
  showRelatedApps?: boolean;
5
6
  editableHeaderContent?: boolean;
6
7
  simpleHeaderFacets?: boolean;
7
- displayShape?: sap.m.AvatarShape;
8
+ displayShape?: AvatarShape;
8
9
  actions?: ACT;
9
10
  }
@@ -1,9 +1,11 @@
1
- /// <reference types="@sapui5/ts-types" />
1
+ /// <reference types="@sapui5/ts-types-esm" />
2
2
  import type { HeaderAction as HeaderActionConfig } from '../../../../specification/v2';
3
+ import type { ButtonType } from 'sap/m/library';
4
+ import type { URI } from 'sap/ui/core/library';
3
5
  export declare class HeaderAction implements HeaderActionConfig {
4
6
  visible: boolean;
5
7
  tooltip?: string;
6
- icon?: sap.ui.core.URI;
7
- activeIcon?: sap.ui.core.URI;
8
- type?: sap.m.ButtonType;
8
+ icon?: URI;
9
+ activeIcon?: URI;
10
+ type?: ButtonType;
9
11
  }
@@ -1,32 +1,44 @@
1
- import type { ObjectPageSectionFormV2 as ObjectPageSectionFormV2Config, ObjectPageSectionChartV2 as ObjectPageSectionChartV2Config, ObjectPageSectionTableV2 as ObjectPageSectionTableV2Config, ObjectPageSubSectionV2 as ObjectPageSubSectionV2Config } from '../../../../specification/v2/index';
1
+ import type { ObjectPageSectionFormV2 as ObjectPageSectionFormIF, ObjectPageSectionChartV2 as ObjectPageSectionChartIF, ObjectPageSectionTableV2 as ObjectPageSectionTableIF, ObjectPageSectionAddressV2 as ObjectPageSectionAddressIF, ObjectPageSectionContactV2 as ObjectPageSectionContactIF, ObjectPageSubSectionV2 as ObjectPageSubSectionIF } from '../../../../specification/v2/index';
2
2
  import type { ControlTypeFunction } from '../../../common';
3
3
  export declare const FacetTitlePrefix = "Facet ID: ";
4
- export declare const getTableSectionControlId: (baseId: string, idBreadcrumbs: string[], breadcrumbs: string[], controlType: ControlTypeFunction, facetId: string) => string;
5
- export declare const getFormSectionControlId: (baseId: string, idBreadcrumbs: string[], breadcrumbs: string[], controlType: ControlTypeFunction, facetId: string) => string;
6
- export declare const getChartSectionControlId: (baseId: string, idBreadcrumbs: string[], breadcrumbs: string[], controlType: ControlTypeFunction, facetID: string) => string;
7
- export declare const getSectionControlId: (baseId: string, idBreadcrumbs: string[], breadcrumbs: string[], controlType: ControlTypeFunction, facetId: string) => string;
8
- export declare const getSubSectionControlId: (baseId: string, idBreadcrumbs: string[], breadcrumbs: string[], controlType: ControlTypeFunction, facetId: string) => string;
9
- export declare class ObjectPageSectionV2 implements ObjectPageSubSectionV2Config {
4
+ export declare const getTableSectionControlId: (baseId: string, _idBreadcrumbs: string[], breadcrumbs: string[], _controlType: ControlTypeFunction, facetId: string) => string;
5
+ export declare const getFormSectionControlId: (baseId: string, _idBreadcrumbs: string[], breadcrumbs: string[], _controlType: ControlTypeFunction, facetId: string) => string;
6
+ export declare const getChartSectionControlId: (baseId: string, _idBreadcrumbs: string[], breadcrumbs: string[], _controlType: ControlTypeFunction, facetID: string) => string;
7
+ export declare const getSectionControlId: (baseId: string, _idBreadcrumbs: string[], breadcrumbs: string[], _controlType: ControlTypeFunction, facetId: string) => string;
8
+ export declare const getSubSectionControlId: (baseId: string, _idBreadcrumbs: string[], breadcrumbs: string[], _controlType: ControlTypeFunction, facetId: string) => string;
9
+ export declare class ObjectPageSectionV2 implements ObjectPageSubSectionIF {
10
10
  visible?: boolean;
11
11
  }
12
- export declare class ObjectPageSectionFormV2 implements ObjectPageSectionFormV2Config {
12
+ export declare class ObjectPageSectionFormV2 implements ObjectPageSectionFormIF {
13
13
  visible?: boolean;
14
14
  }
15
- export declare class ObjectPageSectionChartV2 implements ObjectPageSectionChartV2Config {
15
+ export declare class ObjectPageSectionChartV2 implements ObjectPageSectionChartIF {
16
16
  visible?: boolean;
17
17
  }
18
- export declare class ObjectPageSectionTableV2 implements ObjectPageSectionTableV2Config {
18
+ export declare class ObjectPageSectionTableV2 implements ObjectPageSectionTableIF {
19
19
  visible?: boolean;
20
20
  }
21
- export declare class ObjectPageSubSectionV2 implements ObjectPageSubSectionV2Config {
21
+ export declare class ObjectPageSectionAddressV2 implements ObjectPageSectionAddressIF {
22
22
  visible?: boolean;
23
23
  }
24
- export declare class ObjectPageSubSectionFormV2 implements ObjectPageSubSectionV2Config {
24
+ export declare class ObjectPageSectionContactV2 implements ObjectPageSectionContactIF {
25
25
  visible?: boolean;
26
26
  }
27
- export declare class ObjectPageSubSectionChartV2 implements ObjectPageSubSectionV2Config {
27
+ export declare class ObjectPageSubSectionV2 implements ObjectPageSubSectionIF {
28
28
  visible?: boolean;
29
29
  }
30
- export declare class ObjectPageSubSectionTableV2 implements ObjectPageSubSectionV2Config {
30
+ export declare class ObjectPageSubSectionFormV2 implements ObjectPageSubSectionIF {
31
+ visible?: boolean;
32
+ }
33
+ export declare class ObjectPageSubSectionChartV2 implements ObjectPageSubSectionIF {
34
+ visible?: boolean;
35
+ }
36
+ export declare class ObjectPageSubSectionAddressV2 implements ObjectPageSubSectionIF {
37
+ visible?: boolean;
38
+ }
39
+ export declare class ObjectPageSubSectionContactV2 implements ObjectPageSubSectionIF {
40
+ visible?: boolean;
41
+ }
42
+ export declare class ObjectPageSubSectionTableV2 implements ObjectPageSubSectionIF {
31
43
  visible?: boolean;
32
44
  }
@@ -1,7 +1,9 @@
1
- /// <reference types="@sapui5/ts-types" />
1
+ /// <reference types="@sapui5/ts-types-esm" />
2
2
  import type { GenericColumns, CreateMode, TableTypeV2, Fields4Dialog, QuickVariant, FieldPathOP as FieldPathOPInterface, CreationFieldKeys, ObjectPageToolBar } from '../../../../specification/v2';
3
3
  import type { ObjectPageCommonTableSettings as ObjectPageCommonTableConfig, ObjectPageResponsiveTable as ObjectPageResponsiveTableConfig, ObjectPageAnalyticalTable as ObjectPageAnalyticalTableConfig, ObjectPageGridTable as ObjectPageGridTableConfig, ObjectPageTreeTable as ObjectPageTreeTableConfig } from '../../../../specification/v2/controls/ObjectPageTable';
4
4
  import type { DeprecatedProperties } from '../../../common';
5
+ import type { PopinLayout } from 'sap/m/library';
6
+ import type { smarttable } from 'sap/ui/comp/library';
5
7
  export declare class QuickVariantSelectionOP {
6
8
  showCounts?: boolean;
7
9
  variants: {
@@ -23,7 +25,7 @@ export declare class ObjectPageCommonTableSettings<COLS = GenericColumns> implem
23
25
  selectionLimit?: number;
24
26
  quickVariantSelection?: QuickVariantSelectionOP;
25
27
  useExportToExcel?: boolean;
26
- exportType?: sap.ui.comp.smarttable.ExportType;
28
+ exportType?: smarttable.ExportType;
27
29
  createMode?: CreateMode;
28
30
  disableDefaultInlineCreateSort?: boolean;
29
31
  variantManagement?: boolean;
@@ -32,7 +34,7 @@ export declare class ObjectPageCommonTableSettings<COLS = GenericColumns> implem
32
34
  export declare class ObjectPageResponsiveTable extends ObjectPageCommonTableSettings implements ObjectPageResponsiveTableConfig {
33
35
  type?: TableTypeV2.ResponsiveTable;
34
36
  includeItemInSelection?: boolean;
35
- popinLayout?: sap.m.PopinLayout;
37
+ popinLayout?: PopinLayout;
36
38
  inlineDelete?: boolean;
37
39
  growingThreshold?: number;
38
40
  }
@@ -1,9 +1,11 @@
1
- /// <reference types="@sapui5/ts-types" />
1
+ /// <reference types="@sapui5/ts-types-esm" />
2
2
  import type { ObjectPageToolBarAction as ToolBarActionConfig } from '../../../../specification/v2';
3
+ import type { ButtonType } from 'sap/m/library';
4
+ import type { URI } from 'sap/ui/core/library';
3
5
  export declare class ObjectPageToolBarAction implements ToolBarActionConfig {
4
6
  visible: boolean;
5
7
  tooltip?: string;
6
- icon?: sap.ui.core.URI;
7
- activeIcon?: sap.ui.core.URI;
8
- type?: sap.m.ButtonType;
8
+ icon?: URI;
9
+ activeIcon?: URI;
10
+ type?: ButtonType;
9
11
  }
@@ -1,7 +1,9 @@
1
- /// <reference types="@sapui5/ts-types" />
1
+ /// <reference types="@sapui5/ts-types-esm" />
2
2
  import type { AnalyticalTable as AnalyticalTableConfig, TableALP as TableALPConfig, CommonTableSettings as CommonTableConfig, DefaultContentView, DefaultFilterMode, GenericColumns, GridTable as GridTableConfig, LoadDataOnAppLaunchSettings, QuickVariantSelectionX as QuickVariantSelectionXInterface, ResponsiveTable as ResponsiveTableConfig, TreeTable as TreeTableConfig, Strategy, FieldPath as FieldPathInterface, QuickVariant, QuickVariantX, CreationFieldKeys, ToolBar } from '../../../../specification/v2';
3
3
  import { TableTypeV2 } from '../../../../specification/v2';
4
4
  import type { ControlTypeFunction, DeprecatedProperties } from '../../../common';
5
+ import type { PopinLayout } from 'sap/m/library';
6
+ import type { smarttable } from 'sap/ui/comp/library';
5
7
  export declare const getSmartTableControlId: (baseId: string, idBreadcrumbs: string[], _breadcrumbs: string[], controlType: ControlTypeFunction) => string;
6
8
  export declare function importCreateParameters(manifestSection: object): object;
7
9
  export declare function exportCreateParameters(manifestSection: unknown, configPart: Fields4Dialog): void;
@@ -9,6 +11,7 @@ export declare class CreateWithFilters {
9
11
  strategy: Strategy;
10
12
  }
11
13
  export declare function exportType(manifestSection: unknown, configPart: object): void;
14
+ export declare function deleteType(manifestSection: unknown): void;
12
15
  export declare class DataLoadSettings {
13
16
  loadDataOnAppLaunch: LoadDataOnAppLaunchSettings;
14
17
  }
@@ -36,7 +39,7 @@ export declare class CommonTableSettings<COLS = GenericColumns> implements Commo
36
39
  createWithParameterDialog?: Fields4Dialog;
37
40
  showTablePersonalisation?: boolean;
38
41
  useExportToExcel?: boolean;
39
- exportType?: sap.ui.comp.smarttable.ExportType;
42
+ exportType?: smarttable.ExportType;
40
43
  fitContainer?: boolean;
41
44
  quickVariantSelection?: QuickVariantSelection;
42
45
  quickVariantSelectionX?: QuickVariantSelectionX;
@@ -51,7 +54,7 @@ export declare class CommonTableSettings<COLS = GenericColumns> implements Commo
51
54
  export declare class ResponsiveTable extends CommonTableSettings implements ResponsiveTableConfig {
52
55
  type?: TableTypeV2.ResponsiveTable;
53
56
  createWithFilters?: CreateWithFilters;
54
- popinLayout?: sap.m.PopinLayout;
57
+ popinLayout?: PopinLayout;
55
58
  includeItemInSelection?: boolean;
56
59
  inlineDelete?: boolean;
57
60
  showDraftToggle?: boolean;