@sap/ux-specification 1.96.12 → 1.96.15

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 (40) hide show
  1. package/CHANGELOG.md +90 -12
  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 +1 -0
  12. package/dist/schemas/v2/ListReportConfig.json +1 -0
  13. package/dist/schemas/v2/ObjectPageConfig.json +1 -0
  14. package/dist/schemas/v4/ListReportConfig.json +3 -3
  15. package/dist/src/apiTypes.d.ts +3 -3
  16. package/dist/src/specification/v2/controls/Facets.d.ts +2 -1
  17. package/dist/src/specification/v2/controls/ObjectPageSection.d.ts +4 -2
  18. package/dist/src/specification/v2/controls/Table.d.ts +1 -0
  19. package/dist/src/specification/v2/controls/index.d.ts +1 -0
  20. package/dist/src/specification/v4/controls/Table.d.ts +2 -2
  21. package/dist/src/specification/v4/pages/ListReportConfig.d.ts +1 -1
  22. package/dist/src/sync/common/appProvider.d.ts +1 -1
  23. package/dist/src/sync/common/decoration/decorators.d.ts +2 -2
  24. package/dist/src/sync/common/generate/objectPage.d.ts +8 -9
  25. package/dist/src/sync/common/generate/utils.d.ts +16 -8
  26. package/dist/src/sync/common/import/utils.d.ts +6 -0
  27. package/dist/src/sync/common/importProject.d.ts +2 -3
  28. package/dist/src/sync/common/types.d.ts +5 -2
  29. package/dist/src/sync/common/utils.d.ts +17 -15
  30. package/dist/src/sync/v2/application.d.ts +3 -3
  31. package/dist/src/sync/v2/export/controls/Fragment.d.ts +2 -1
  32. package/dist/src/sync/v2/generate/listReport.d.ts +3 -4
  33. package/dist/src/sync/v2/generate/utils.d.ts +7 -6
  34. package/dist/src/sync/v4/export/controls/Table.d.ts +1 -1
  35. package/dist/src/sync/v4/export/pages/ListReport.d.ts +1 -1
  36. package/dist/src/sync/v4/generate/listReport.d.ts +2 -2
  37. package/dist/src/sync/v4/types.d.ts +1 -1
  38. package/dist/src/sync/v4/utils/utils.d.ts +12 -11
  39. package/dist/test/test-utils/utils.d.ts +1 -2
  40. package/package.json +7 -7
@@ -586,6 +586,7 @@
586
586
  },
587
587
  "columnIndex": {
588
588
  "description": "The index of the column in the overall collection; if undefined, the custom column will be added at the end of the table.",
589
+ "minimum": 0,
589
590
  "type": "number"
590
591
  },
591
592
  "leadingProperty": {
@@ -590,6 +590,7 @@
590
590
  },
591
591
  "columnIndex": {
592
592
  "description": "The index of the column in the overall collection; if undefined, the custom column will be added at the end of the table.",
593
+ "minimum": 0,
593
594
  "type": "number"
594
595
  },
595
596
  "leadingProperty": {
@@ -875,6 +875,7 @@
875
875
  },
876
876
  "columnIndex": {
877
877
  "description": "The index of the column in the overall collection; if undefined, the custom column will be added at the end of the table.",
878
+ "minimum": 0,
878
879
  "type": "number"
879
880
  },
880
881
  "leadingProperty": {
@@ -8,7 +8,7 @@
8
8
  },
9
9
  "filterBar": {
10
10
  "$ref": "#/definitions/FilterBar",
11
- "description": "Filter bar"
11
+ "description": "Filter Bar"
12
12
  },
13
13
  "chart": {
14
14
  "$ref": "#/definitions/ALPChartView",
@@ -240,7 +240,7 @@
240
240
  "artifactType": "Manifest"
241
241
  },
242
242
  "createAtEnd": {
243
- "description": "In case of inline creation mode you can decide if the new row will be created at the end of the table, or direcly after the currently selected table. The default value is \"true\"",
243
+ "description": "In case of inline creation mode you can decide if the new row will be created at the end of the table, or directly after the currently selected table. The default value is \"true\"",
244
244
  "type": "boolean",
245
245
  "artifactType": "Manifest"
246
246
  }
@@ -595,7 +595,7 @@
595
595
  "artifactType": "Manifest"
596
596
  },
597
597
  "createAtEnd": {
598
- "description": "In case of inline creation mode you can decide if the new row will be created at the end of the table, or direcly after the currently selected table. The default value is \"true\"",
598
+ "description": "In case of inline creation mode you can decide if the new row will be created at the end of the table, or directly after the currently selected table. The default value is \"true\"",
599
599
  "type": "boolean",
600
600
  "artifactType": "Manifest"
601
601
  }
@@ -6,7 +6,7 @@ import type { Page as PageV4 } from './specification/v4/page';
6
6
  import type { FileData, File, ExportResults } from './sync/common/types';
7
7
  import type { ApplicationV2, ObjectPageConfig as ObjectPageConfigV2, ListReportConfig as ListReportConfigV2, OverviewPageConfig as OverviewPageConfigV2, AnalyticalListPageConfig as AnalyticalListPageConfigV2, Manifest as ManifestV2, FlexChangeLayer } from './v2';
8
8
  import type { ApplicationV4, ObjectPageConfig as ObjectPageConfigV4, ListReportConfig as ListReportConfigV4, Manifest as ManifestV4 } from './v4';
9
- import type { ConverterOutput } from '@sap-ux/vocabularies-types';
9
+ import type { ConvertedMetadata } from '@sap-ux/vocabularies-types';
10
10
  import type { CustomPage, CustomTableColumn, CustomSection } from '@sap-ux/fe-fpm-writer';
11
11
  import type { Editor } from 'mem-fs-editor';
12
12
  import type { TemplateType } from './sync/common';
@@ -240,7 +240,7 @@ export declare type ImportAnalyticalListPageV2 = {
240
240
  */
241
241
  export declare type ImportListReportV4Parameters = {
242
242
  manifest: object;
243
- jsonSchema: object;
243
+ jsonSchema: Definition;
244
244
  logger?: ExtensionLogger;
245
245
  };
246
246
  export declare type ImportListReportV4 = {
@@ -284,7 +284,7 @@ export interface ImportProjectParameters {
284
284
  export interface GenerateAppSchemaParameters {
285
285
  templateType: TemplateType;
286
286
  manifest: ManifestV2 | ManifestV4;
287
- serviceAVT: ConverterOutput;
287
+ serviceAVT: ConvertedMetadata;
288
288
  fioriElementsVersion: FioriElementsVersion;
289
289
  fragments?: FileData[];
290
290
  logger?: ExtensionLogger;
@@ -7,10 +7,11 @@ export declare type ObjectPageTableTypeV2 = ObjectPageResponsiveTable | ObjectPa
7
7
  export interface LineItemFacet {
8
8
  table: ObjectPageTableTypeV2;
9
9
  }
10
+ export declare type FormFacetType = boolean | number | string | object;
10
11
  /**
11
12
  * Form Facet
12
13
  * @isViewNode true
13
14
  */
14
15
  export interface FormFacet {
15
- [id: string]: boolean | number | string | object;
16
+ [id: string]: FormFacetType;
16
17
  }
@@ -17,12 +17,13 @@ export interface ObjectPageSectionV2 {
17
17
  export interface ObjectPageSectionFormV2 extends ObjectPageSectionV2 {
18
18
  form?: ObjectPageForm;
19
19
  }
20
+ export declare type AnyObjectPageTableType = ObjectPageResponsiveTableWithMultiSelect | ObjectPageResponsiveTableWithInlineDelete | ObjectPageAnalyticalTable | ObjectPageGridTable | ObjectPageTreeTable;
20
21
  /**
21
22
  * Table
22
23
  * @isViewNode true
23
24
  */
24
25
  export interface ObjectPageSectionTableV2 extends ObjectPageSectionV2 {
25
- table?: ObjectPageResponsiveTableWithMultiSelect | ObjectPageResponsiveTableWithInlineDelete | ObjectPageAnalyticalTable | ObjectPageGridTable | ObjectPageTreeTable;
26
+ table?: AnyObjectPageTableType;
26
27
  }
27
28
  /**
28
29
  * Chart
@@ -74,12 +75,13 @@ export declare type AnySectionType = ObjectPageSectionTableV2 | ObjectPageSectio
74
75
  export interface GenericSections {
75
76
  [key: string]: AnySectionType;
76
77
  }
78
+ export declare type CustomSectionTypeV2 = ObjectPageCustomSectionView | ObjectPageCustomSectionFragment;
77
79
  /**
78
80
  * Custom Sections
79
81
  * @isViewNode true
80
82
  */
81
83
  export interface CustomSections {
82
- custom?: (ObjectPageCustomSectionView | ObjectPageCustomSectionFragment)[];
84
+ custom?: CustomSectionTypeV2[];
83
85
  }
84
86
  export interface ObjectPageCustomSectionBase {
85
87
  relatedFacet: string;
@@ -45,6 +45,7 @@ export interface TableCustomColumn {
45
45
  columnKey: string;
46
46
  /**
47
47
  * The index of the column in the overall collection; if undefined, the custom column will be added at the end of the table.
48
+ * @minimum 0
48
49
  */
49
50
  columnIndex?: number;
50
51
  /**
@@ -7,6 +7,7 @@ export * from './Table';
7
7
  export * from './ToolBar';
8
8
  export * from './Footer';
9
9
  export * from './AnalyticalListPageChart';
10
+ export * from './AnalyticalListPageKPI';
10
11
  export * from './ObjectPageHeader';
11
12
  export * from './ObjectPageLayout';
12
13
  export * from './ObjectPageSection';
@@ -36,7 +36,7 @@ export interface TableCreationMode {
36
36
  */
37
37
  name?: TableCreationModeType;
38
38
  /**
39
- * In case of inline creation mode you can decide if the new row will be created at the end of the table, or direcly after the currently selected table. The default value is "true"
39
+ * In case of inline creation mode you can decide if the new row will be created at the end of the table, or directly after the currently selected table. The default value is "true"
40
40
  */
41
41
  createAtEnd?: boolean;
42
42
  }
@@ -50,7 +50,7 @@ export interface ViewTableCreationMode {
50
50
  */
51
51
  name?: TableCreationModeType;
52
52
  /**
53
- * In case of inline creation mode you can decide if the new row will be created at the end of the table, or direcly after the currently selected table. The default value is "true"
53
+ * In case of inline creation mode you can decide if the new row will be created at the end of the table, or directly after the currently selected table. The default value is "true"
54
54
  */
55
55
  createAtEnd?: boolean;
56
56
  }
@@ -13,7 +13,7 @@ export interface ListReportConfig extends PageConfig {
13
13
  */
14
14
  variantManagement?: VariantManagementTypeListReport;
15
15
  /**
16
- * Filter bar
16
+ * Filter Bar
17
17
  */
18
18
  filterBar?: FilterBar;
19
19
  /**
@@ -17,7 +17,7 @@ export declare abstract class AppProvider {
17
17
  * Create config files for app (app.json) and pages (pages/{name}.json).
18
18
  * This is basically a copy of createFiles optimized to be used in FTFS:
19
19
  * it always uses posix path notation with forward slash (/)
20
- * @param {ConverterOutput} oDataServiceAVT - Complete service information, as returned by annotation vocabularies tool
20
+ * @param {ConvertedMetadata} oDataServiceAVT - Complete service information, as returned by annotation vocabularies tool
21
21
  * @returns app and page files as separate objects
22
22
  */
23
23
  createConfigFiles(): {
@@ -2,11 +2,11 @@ import 'reflect-metadata';
2
2
  import type { SyncRule, PageLayoutInformation, ValidityInformation } from '../types';
3
3
  export declare const reflectMetadataKey: unique symbol;
4
4
  export declare const syncRule: (propSpec: SyncRule) => any;
5
- export declare function getReflectMetadata(target: any, propertyName: string): SyncRule;
5
+ export declare function getReflectMetadata(target: object, propertyName: string): SyncRule | undefined;
6
6
  export declare const pageLayoutInformation: (pageInfo: PageLayoutInformation) => (constructor: Function) => void;
7
7
  export declare const childId: (id: string) => any;
8
8
  export declare const getChildId: (target: any, propertyName: string) => string;
9
9
  export declare const getPageLayoutInformation: (target: any) => PageLayoutInformation;
10
10
  export declare const validityMetadataKey: unique symbol;
11
11
  export declare const validity: (propSpec: ValidityInformation) => any;
12
- export declare function getTextForDeprecated(key: string, validity?: ValidityInformation): string;
12
+ export declare function getTextForDeprecated(key: string, validityInformation?: ValidityInformation): string;
@@ -1,8 +1,7 @@
1
- import type { ConverterOutput, EntityType } from '@sap-ux/vocabularies-types';
1
+ import type { ConvertedMetadata, EntitySet, EntityType } from '@sap-ux/vocabularies-types';
2
2
  import { FioriElementsVersion } from '../../../specification/common';
3
3
  import type { FacetConfig } from '..';
4
4
  import { SectionType } from '..';
5
- import type { EntitySet } from '@sap-ux/annotation-converter';
6
5
  import type { Definition } from 'typescript-json-schema';
7
6
  /**
8
7
  * Adds definitions for forms in object page sections to the app schema
@@ -16,10 +15,10 @@ export declare function handleForm(sectionType: SectionType, section: FacetConfi
16
15
  /**
17
16
  * Replaces an alias in an annotation ID or reference, based on the AVT references' list
18
17
  * @param annotationIdentifier - annotation ID or reference
19
- * @param {ConverterOutput} oDataServiceAVT - complete service information, as returned by annotation vocabularies tool
18
+ * @param {ConvertedMetadata} oDataServiceAVT - complete service information, as returned by annotation vocabularies tool
20
19
  * @returns the converted string
21
20
  */
22
- export declare function replaceAlias(annotationIdentifier: string, oDataServiceAVT: ConverterOutput): string;
21
+ export declare function replaceAlias(annotationIdentifier: string, oDataServiceAVT: ConvertedMetadata): string;
23
22
  /**
24
23
  * Common routine to determine the name and the ID of a header action
25
24
  * @param action - action as given by AVT
@@ -35,16 +34,16 @@ export declare function getActionNameAndId(action: string, entityType: EntityTyp
35
34
  *
36
35
  * @param {object} appSchema Schema of the app
37
36
  * @param {EntityType} entityType - current entity type
38
- * @param {ConverterOutput} oDataServiceAVT - complete service information, as returned by annotation vocabularies tool
37
+ * @param {ConvertedMetadata} oDataServiceAVT - complete service information, as returned by annotation vocabularies tool
39
38
  */
40
- export declare function addFooterActions(appSchema: Definition, entityType: EntityType, oDataServiceAVT: ConverterOutput): void;
39
+ export declare function addFooterActions(appSchema: Definition, entityType: EntityType, oDataServiceAVT: ConvertedMetadata): void;
41
40
  /**
42
41
  * Add Object Page Header Action Buttons to app-specific schema
43
42
  * @param {object} appSchema Schema of the app
44
43
  * @param {EntityType} entityType - current entity type
45
- * @param {ConverterOutput} oDataServiceAVT - complete service information, as returned by annotation vocabularies tool
44
+ * @param {ConvertedMetadata} oDataServiceAVT - complete service information, as returned by annotation vocabularies tool
46
45
  */
47
- export declare function addHeaderActions(appSchema: Definition, entityType: EntityType, oDataServiceAVT: ConverterOutput, addHeaderActionCallBack: any): void;
46
+ export declare function addHeaderActions(appSchema: Definition, entityType: EntityType, oDataServiceAVT: ConvertedMetadata, addHeaderActionCallBack: any): void;
48
47
  /**
49
48
  * Adds common Object Page Header definitions to the app schema
50
49
  * @param appSchema - app-specific JSOn schema
@@ -57,4 +56,4 @@ export declare function addCommonHeaderSchema(appSchema: Definition, entityType:
57
56
  * @param serviceAVT - AVT converter output, comprising all annotation information
58
57
  * @returns the entity set as defined in AVT, if found
59
58
  */
60
- export declare function determineEntitySetOfFacet(facet: FacetConfig, serviceAVT: ConverterOutput): EntitySet | undefined;
59
+ export declare function determineEntitySetOfFacet(facet: FacetConfig, serviceAVT: ConvertedMetadata): EntitySet | undefined;
@@ -1,10 +1,10 @@
1
- import type { EntitySet, EntityType } from '@sap-ux/annotation-converter';
2
- import type { AnnotationTerm, ConverterOutput, LineItem } from '@sap-ux/vocabularies-types';
1
+ import type { AnnotationTerm, ConvertedMetadata, EntitySet, EntityType } from '@sap-ux/vocabularies-types';
2
+ import type { LineItem } from '@sap-ux/vocabularies-types/vocabularies/UI';
3
3
  import type { Definition } from 'typescript-json-schema';
4
4
  import type { FacetConfig, FacetSection, SectionType } from '..';
5
5
  import type { SectionTypeV2 } from '../../v2/types';
6
6
  import type { PresentationVariantV4 } from '../../v4/types';
7
- import { UIAnnotationTerms } from '@sap-ux/vocabularies-types';
7
+ import { UIAnnotationTerms } from '@sap-ux/vocabularies-types/vocabularies/UI';
8
8
  import { DefinitionName } from '..';
9
9
  /**
10
10
  * Adds an enum filled with existing UI annotations of the given list (validAnnotations)
@@ -29,11 +29,11 @@ export declare function addEnumForSingleTabVariant(entityType: EntityType, appSc
29
29
  export declare function addEnumForMultiTabVariant(appSchema: Definition, definitionName: string, entitySet: EntitySet): void;
30
30
  /**
31
31
  * Adds the enum values for entitySet as part of the multiple view scenario
32
- * @param {ConverterOutput} oDataServiceAVT - combined service metadata, as returned by annotation vocabularies tools
32
+ * @param {ConvertedMetadata} oDataServiceAVT - combined service metadata, as returned by annotation vocabularies tools
33
33
  * @param appSchema - app specific JSOn schema
34
34
  * @param definitionName - name of the definition in the app schema
35
35
  */
36
- export declare function addEnumForVariantEntitySet(oDataServiceAVT: ConverterOutput, appSchema: Definition, definitionName: string): void;
36
+ export declare function addEnumForVariantEntitySet(oDataServiceAVT: ConvertedMetadata, appSchema: Definition, definitionName: string): void;
37
37
  /**
38
38
  * Adds an enum filled with existing UI annotations for annotationPath property in FilterBar
39
39
  * @param {EntityType} entityType
@@ -54,7 +54,7 @@ export declare function addDefinitionForRelatedFacetKeys(appSchema: Definition,
54
54
  * Functions used both by V2 and V4 to add the common definitions for a line item to the app schema
55
55
  * @param appSchema - the app specific schema that shall get enhanced
56
56
  * @param lineItemAnnotation - the UI.LineItem annotation, comprising all records
57
- * @param entityType - the entity type as part of the AVT ConverterOutput
57
+ * @param entityType - the entity type as part of the AVT ConvertedMetadata
58
58
  * @param lineItemId - line item ID, as comprise in stable ID
59
59
  * @param customColumnDefinitionName - (optional) definition name of custom column.
60
60
  * Passed in the V4 case, then additional properties of this type will be allowed.
@@ -122,11 +122,19 @@ export declare function getFacetKeyInSchema(facetKey: string): string;
122
122
  export declare function parseSchemaDefinition(definition: DefinitionName | SectionTypeV2, facetKey: string, appSchema: Definition, useDefinitionAsKey?: boolean, subDefinitionName?: DefinitionName): Definition;
123
123
  /**
124
124
  * Creates a definition link for a facet and definition name
125
- * @param definition name of definition, as used in schema
126
- * @param facetKey - key of the facet, as used in annotation
125
+ * @param {DefinitionName} definition - name of definition, as used in schema
126
+ * @param {string} facetKey - key of the facet, as used in annotation
127
127
  * @returns definition link of facet, as used in definition
128
128
  */
129
129
  export declare function getFacetDefinitionLink(definition: DefinitionName | SectionTypeV2, facetKey: string): string;
130
+ /**
131
+ * Creates and adds a reference link to a definition
132
+ * @param {Definition} schemaPart - part of schema to add $ref to
133
+ * @param {string} schemaRef - reference to be added
134
+ * @param {string} schemaKey - key to be encapsulated within reference as `schemaRef<schemaKey>`
135
+ * @returns reference link of facet, as used in definition
136
+ */
137
+ export declare function addDefinitionRef(schemaPart: Definition, schemaRef: string, schemaKey?: string): void;
130
138
  /**
131
139
  * Extracts annotationPath from facet or Chart/LineItem fullyQualifiedName
132
140
  * @param facet facet or Chart/LineItem
@@ -35,3 +35,9 @@ export declare function getSectionTitle(schemaSection: Definition, jsonSchema: D
35
35
  * @returns {string | undefined} Resolved target.
36
36
  */
37
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,5 +1,6 @@
1
1
  import type { Manifest } from '../../specification/common/webapp/manifest';
2
- import type { AnnotationTerm, CollectionFacet, EntityType, ReferenceFacet, ReferenceURLFacet } 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';
4
5
  export declare type anyFacetType = AnnotationTerm<CollectionFacet> | AnnotationTerm<ReferenceFacet> | AnnotationTerm<ReferenceURLFacet>;
5
6
  export declare enum ExportArtifacts {
@@ -244,6 +245,7 @@ export declare enum DefinitionName {
244
245
  Field = "Field",
245
246
  Fields = "Fields",
246
247
  Fields4Dialog = "Fields4Dialog",
248
+ FilterBar = "FilterBar",
247
249
  Footer = "Footer",
248
250
  FooterActions = "FooterActions",
249
251
  Form = "Form",
@@ -302,7 +304,8 @@ export declare enum DefinitionName {
302
304
  ViewTableColumn = "ViewTableColumn",
303
305
  ViewCustomColumn = "ViewTableCustomColumn",
304
306
  ViewChartToolBar = "ViewChartToolBar",
305
- ViewToolBarAction = "ViewToolBarAction"
307
+ ViewToolBarAction = "ViewToolBarAction",
308
+ ViewPosition = "ViewPosition"
306
309
  }
307
310
  export declare enum PropertyName {
308
311
  actions = "actions",
@@ -3,9 +3,11 @@ import type { ExtensionLogger } from '../../apiTypes';
3
3
  import type { FacetConfigs, FileData, FacetConfig, FacetSection, SchemaFilePath, anyFacetType } from './types';
4
4
  import type { Manifest } from '../../specification/common';
5
5
  import type { MetadataInstanceInterface } from './decoration/factory';
6
- import type { ConverterOutput, DataFieldAbstractTypes, EntityType, PropertyAnnotations, PropertyPath } from '@sap-ux/vocabularies-types';
6
+ import type { DataFieldAbstractTypes } from '@sap-ux/vocabularies-types/vocabularies/UI';
7
+ import type { ConvertedMetadata, EntityType, PropertyPath } from '@sap-ux/vocabularies-types';
7
8
  import { FioriElementsVersion, PageType, PageTypeV4 } from '../../specification/common';
8
9
  import { SchemaType } from '../../specification/schemaAccess';
10
+ import type { PropertyAnnotations } from '@sap-ux/vocabularies-types/vocabularies/Edm_Types';
9
11
  export declare enum TemplateType {
10
12
  ListReportObjectPageV2 = "ListReportObjectPageV2",
11
13
  ListReportObjectPageV4 = "ListReportObjectPageV4",
@@ -27,7 +29,7 @@ export declare const createAnnotationPath: (entityTypeName: string, term: string
27
29
  * @param annotationFiles - The list of all annotation files, in JSON format
28
30
  * @returns the complete service information
29
31
  */
30
- export declare function parseAndMergeAndConvert(annotationFiles: FileData[], logger: ExtensionLogger): ConverterOutput;
32
+ export declare function parseAndMergeAndConvert(annotationFiles: FileData[], logger: ExtensionLogger): ConvertedMetadata;
31
33
  export declare const getAnnotationPropertyValue: (annotationProperty: any) => string;
32
34
  /**
33
35
  * Checks for Common.Label and overwrites the label from it if present
@@ -53,7 +55,7 @@ export declare function getLabelForDataField(field: DataFieldAbstractTypes, enti
53
55
  /**
54
56
  * Determines the description of a data field, e.g. for the column header
55
57
  * @param dataFieldAbstract - the given record of the line item annotation
56
- * @param entityType - the entity type as part of the AVT ConverterOutput
58
+ * @param entityType - the entity type as part of the AVT ConvertedMetadata
57
59
  */
58
60
  export declare function getDataFieldDescription(dataFieldAbstract: DataFieldAbstractTypes, entityType: EntityType): string;
59
61
  /**
@@ -75,24 +77,24 @@ export declare function getPageTypeV4(name: string): PageTypeV4 | undefined;
75
77
  /**
76
78
  * Finds the alias for a given namespace in the references' section of the converted service metadata
77
79
  * @param {string} namespace - complete namespace, e.g. 'com.sap.vocabularies.UI.v1'
78
- * @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
79
81
  * @returns alias for the given namespace
80
82
  */
81
- export declare function findAlias(namespace: string, oDataServiceAVT: ConverterOutput): string;
83
+ export declare function findAlias(namespace: string, oDataServiceAVT: ConvertedMetadata): string;
82
84
  /**
83
85
  * Resolve page section(get key and label->description).
84
86
  * @param facetDefinition - the actual annotation record
85
87
  * @param keyForRelatedFacetKeys - construct key for 'keyForRelatedFacetKeys' property(used to define custom sections) - we should not add '@' symbol there.
86
88
  * @param {FioriElementsVersion} oDataVersion - OData version
87
- * @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
88
90
  * @param {ExtensionLogger} logger - Logger class for logging messages
89
91
  * @returns {FacetSection} - object comprising the relevant facet information
90
92
  */
91
- export declare function getSectionFacet(facetDefinition: anyFacetType, 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;
92
94
  /**
93
95
  * Finds the alias for a given namespace in the references' section of the converted service metadata.
94
96
  * An empty object is created if the path element does not exist yet.
95
- * Exception: if an empty array is the next element of the 'path' definition, an empty array is created instaed of an empty object.
97
+ * Exception: if an empty array is the next element of the 'path' definition, an empty array is created instead of an empty object.
96
98
  * @param {object} manifest - manifest that is being modified during export
97
99
  * @param {string} path - path of the property in the manifest
98
100
  * @param {string} targetAnnotation - target annotation (optional)
@@ -105,19 +107,19 @@ export declare function getSchemaKeyOfLineItemRecord(lineItemRecord: DataFieldAb
105
107
  /**
106
108
  * Retrieve header facet configurations that can be used to generate ObjectPage schemas
107
109
  * @param {QualifiedName} entityTypeName - the name of the actual entity type
108
- * @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
109
111
  * @param {FioriElementsVersion} oDataVersion - OData version
110
112
  * @param {ExtensionLogger} logger - Logger class for logging messages
111
113
  */
112
- 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;
113
115
  /**
114
116
  * Retrieve facet configurations that can be used to generate ObjectPage schemas
115
117
  * @param {QualifiedName} entityTypeName - the name of the actual entity type
116
- * @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
117
119
  * @param {FioriElementsVersion} oDataVersion - OData version
118
120
  * @param {ExtensionLogger} logger - Logger class for logging messages
119
121
  */
120
- 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;
121
123
  /**
122
124
  * Returns the version of Fiori elements (v2/v4) from a given manifest
123
125
  * @param manifest - the manifest.json file
@@ -168,13 +170,13 @@ export declare function createDefaultSection(appSchema: Definition, facet: Facet
168
170
  /**
169
171
  * Retrieve page section data(so far id/key and label/description).
170
172
  * @param {EntityType} entityType The actual entityType
171
- * @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
172
174
  * @param {ExtensionLogger} logger - Logger class for logging messages
173
175
  * @param {FioriElementsVersion} oDataVersion - OData version
174
176
  * @param {boolean} [checkUnresolvableFacets=false] - Check and avoid facets and sections without ID and Target.
175
177
  * @returns {FacetSection[]} - Array of facets or sections
176
178
  */
177
- 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[];
178
180
  /**
179
181
  * Cleans empty sub-structures from the export result for manifest
180
182
  * @param manifest - manifest.json part of the export result
@@ -206,7 +208,7 @@ export declare type NextDefinition = {
206
208
  };
207
209
  /**
208
210
  * Recursive function to determine the next config part, next definition in the app schema and the title
209
- * @param appSchema - app-spcific JSON schema
211
+ * @param appSchema - app-specific JSON schema
210
212
  * @param title - default title
211
213
  * @param currentConfigObject - current part of the configuration that gets traversed
212
214
  * @param propertyDefinition - definition of a given property in the app schema
@@ -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;
@@ -7,9 +7,10 @@ export declare const SAP_UI_TABLE = "sap.ui.table";
7
7
  /**
8
8
  * Method which receives fragment definition node and reads root column definition.
9
9
  * @param {unknown} definition - Application or Page Config object.
10
+ * @param {unknown} fragment - fragment definition
10
11
  * @returns {unknown | undefined} Root column read from definition.
11
12
  */
12
- export declare function getRootCustomColumnFromFragmentJSON(definition: unknown): string | unknown | undefined;
13
+ export declare function getRootCustomColumnFromFragmentJSON(definition: unknown, fragment?: unknown): string | unknown | undefined;
13
14
  /**
14
15
  * Identifies the right extensions based on a pattern, then deletes all corresponding columns and cells
15
16
  * @param manifestSection - Section in manifest.json comprising the extensions
@@ -1,15 +1,14 @@
1
1
  import type { GenerateAppSchemaParameters } from '../../../v2';
2
- import type { ConverterOutput, EntityType } from '@sap-ux/vocabularies-types';
3
- import type { EntitySet } from '@sap-ux/annotation-converter';
2
+ import type { ConvertedMetadata, EntitySet, EntityType } from '@sap-ux/vocabularies-types';
4
3
  import type { Definition } from 'typescript-json-schema';
5
4
  /**
6
5
  * Adds the enum types for QuickVariant and QuickVariantX, based on the entity type annotations
7
6
  * @param {EntityType} entityType
8
7
  * @param {EntitySet} entitySet - current entity set of the page or view
9
8
  * @param {Definition} appSchema - app specific JSON schema
10
- * @param {ConverterOutput} oDataServiceAVT - combined service metadata, as returned by annotation vocabularies tools
9
+ * @param {ConvertedMetadata} oDataServiceAVT - combined service metadata, as returned by annotation vocabularies tools
11
10
  */
12
- export declare function addEnumForVariantPaths(entityType: EntityType, entitySet: EntitySet, appSchema: Definition, oDataServiceAVT: ConverterOutput): void;
11
+ export declare function addEnumForVariantPaths(entityType: EntityType, entitySet: EntitySet, appSchema: Definition, oDataServiceAVT: ConvertedMetadata): void;
13
12
  /**
14
13
  * Generates an app specific schema for the FE V2 Listreport from the generic schema.
15
14
  * Generic types are replaced by information from the app specific annotations.
@@ -3,12 +3,13 @@ import type { FileData } from '../../common';
3
3
  import type { MetadataInstanceInterface } from '../../common/decoration/factory';
4
4
  import type { PageType, PageTypeV4 } from '../../../specification/common';
5
5
  import type { SapUiAppPageV2 } from '../../../specification/v2';
6
- import type { AnnotationTerm, EntityType, LineItem, SelectionFields } from '@sap-ux/vocabularies-types';
6
+ import type { AnnotationTerm, EntityType } from '@sap-ux/vocabularies-types';
7
+ import type { LineItem, SelectionFields } from '@sap-ux/vocabularies-types/vocabularies/UI';
7
8
  import { ActionTypeV2 } from '../types';
8
9
  /**
9
10
  * Processes a LineItem record of type DataFieldForAction and DataFieldForIntentBasedNavigation during app schema generation
10
11
  * @param appSchema - the app specific schema that shall get enhanced
11
- * @param entityType - the entity type as part of the AVT ConverterOutput
12
+ * @param entityType - the entity type as part of the AVT ConvertedMetadata
12
13
  * @param actions - actions definition in schema, parent object
13
14
  * @param lineItemProperties - properties of the line item collection: lineItemPath, lineItemRecord, lineItemId
14
15
  * @param actionType - type of action
@@ -24,7 +25,7 @@ export declare function handleActionRecord(appSchema: object, actions: object, l
24
25
  * Adds the line item records to the app schema (for the list report or an object page section comprising a table)
25
26
  * @param appSchema - the app specific schema that shall get enhanced
26
27
  * @param lineItemAnnotation - the UI.LineItem annotation, comprising all records
27
- * @param entityType - the entity type as part of the AVT ConverterOutput
28
+ * @param entityType - the entity type as part of the AVT ConvertedMetadata
28
29
  * @param lineItemId - optional: in case of OP the parameter must be passed to distinguish the OP tables;
29
30
  * in case of LR or ALP no ID is passed, 'LineItems' is taken then.
30
31
  * @param customColumnRef - schema reference to custom column definition.
@@ -33,7 +34,7 @@ export declare function addLineItemsType(appSchema: Definition, lineItemAnnotati
33
34
  /**
34
35
  * Adds enum entries of possible leading properties for 'leadingProperty' property in TableCustomColumn properties.
35
36
  * @param appSchema - the app specific schema that shall get enhanced
36
- * @param entityType - the entity type as part of the AVT ConverterOutput
37
+ * @param entityType - the entity type as part of the AVT ConvertedMetadata
37
38
  * @param definitionName - definition name of CustomColumn definition
38
39
  */
39
40
  export declare function addListReportLeadingProperties(appSchema: object, entityType: EntityType, definitionName: string): void;
@@ -56,7 +57,7 @@ export declare function addFragmentEnum(appSchema: Definition, fragments: FileDa
56
57
  /**
57
58
  * Adds the custom columns to the line item records of the app schema (for the list report comprising a table).
58
59
  * @param {object} appSchema The app specific schema that shall get enhanced.
59
- * @param {EntityType} entityType The entity type as part of the AVT ConverterOutput.
60
+ * @param {EntityType} entityType The entity type as part of the AVT ConvertedMetadata.
60
61
  * @param {SapUiAppPageV2} page Sapui5 page object.
61
62
  * @param {object} manifest Application manifest.
62
63
  * @param {FileData[]} [fragments] Array of fragments.
@@ -82,7 +83,7 @@ export declare function processMetadata(schema: object, schemaDefinition: object
82
83
  export declare function removeElementsFromEnum(values: Array<unknown>, valuesToRemove: Array<unknown>): void;
83
84
  /**
84
85
  * Adds the selection fields to the app schema, as properties of the Filterbar
85
- * @param entityType - the entity type as part of the AVT ConverterOutput
86
+ * @param entityType - the entity type as part of the AVT ConvertedMetadata
86
87
  * @param appSchema - the app specific schema that shall get enhanced
87
88
  * @param selectionFieldsAnnotation - the UI.SelectionField annotation
88
89
  */
@@ -144,7 +144,7 @@ export declare class LRTableView extends TableViewSettings implements LRTableVie
144
144
  toolBar?: ToolBar;
145
145
  }
146
146
  /**
147
- * LR mulit-view: own class for properties on views' level
147
+ * LR multi-view: own class for properties on views' level
148
148
  */
149
149
  export declare class MultiTableModeV4 implements MultiTableModeIF {
150
150
  [key: string]: LRTableView | LRChartView | boolean;
@@ -9,5 +9,5 @@ export declare class ListReport implements ListReportConfigV4 {
9
9
  variantManagement?: VariantManagementTypeListReport;
10
10
  defaultPath?: DefaultPathType;
11
11
  defaultTemplateAnnotationPath?: string;
12
- filterbar?: FilterBar;
12
+ filterBar?: FilterBar;
13
13
  }
@@ -1,7 +1,7 @@
1
1
  import type { GenerateAppSchemaParameters } from '../../../apiTypes';
2
- import type { EntitySet } from '@sap-ux/annotation-converter';
2
+ import type { EntitySet } from '@sap-ux/vocabularies-types';
3
3
  /**
4
- * Generates an app specific schema for the FE V4 Listreport from the generic schema.
4
+ * Generates an app specific schema for the FE V4 ListReport from the generic schema.
5
5
  * Generic types are replaced by information from the app specific annotations.
6
6
  * @param {GenerateAppSchemaParameters} generateParameters - list of API input parameters
7
7
  * @param genericSchema - generic JSON schema of an object page
@@ -1,4 +1,4 @@
1
- import type { Chart, LineItem } from '@sap-ux/vocabularies-types';
1
+ import type { Chart, LineItem } from '@sap-ux/vocabularies-types/vocabularies/UI';
2
2
  import type * as v4controls from './export/controls';
3
3
  import type * as v4pages from './export/pages';
4
4
  export declare type V4Controls = typeof v4controls;