@sap/ux-specification 1.96.11 → 1.96.14

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 (54) hide show
  1. package/CHANGELOG.md +63 -6
  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 +3 -3
  15. package/dist/src/apiTypes.d.ts +3 -3
  16. package/dist/src/project.d.ts +1 -0
  17. package/dist/src/specification/v2/controls/Action.d.ts +6 -4
  18. package/dist/src/specification/v2/controls/Facets.d.ts +2 -1
  19. package/dist/src/specification/v2/controls/ObjectPageHeader.d.ts +3 -2
  20. package/dist/src/specification/v2/controls/ObjectPageSection.d.ts +44 -9
  21. package/dist/src/specification/v2/controls/ObjectPageTable.d.ts +5 -3
  22. package/dist/src/specification/v2/controls/Table.d.ts +7 -4
  23. package/dist/src/specification/v4/controls/Table.d.ts +2 -2
  24. package/dist/src/specification/v4/pages/ListReportConfig.d.ts +1 -1
  25. package/dist/src/sync/common/appProvider.d.ts +1 -1
  26. package/dist/src/sync/common/decoration/control.d.ts +1 -1
  27. package/dist/src/sync/common/decoration/decorators.d.ts +2 -2
  28. package/dist/src/sync/common/generate/objectPage.d.ts +8 -9
  29. package/dist/src/sync/common/generate/utils.d.ts +28 -10
  30. package/dist/src/sync/common/import/utils.d.ts +9 -2
  31. package/dist/src/sync/common/importProject.d.ts +2 -3
  32. package/dist/src/sync/common/types.d.ts +9 -2
  33. package/dist/src/sync/common/utils.d.ts +19 -17
  34. package/dist/src/sync/v2/application.d.ts +3 -3
  35. package/dist/src/sync/v2/export/controls/Action.d.ts +12 -10
  36. package/dist/src/sync/v2/export/controls/FormAction.d.ts +9 -7
  37. package/dist/src/sync/v2/export/controls/ObjectPageFooterAction.d.ts +6 -4
  38. package/dist/src/sync/v2/export/controls/ObjectPageHeader.d.ts +3 -2
  39. package/dist/src/sync/v2/export/controls/ObjectPageHeaderAction.d.ts +6 -4
  40. package/dist/src/sync/v2/export/controls/ObjectPageSectionsV2.d.ts +26 -14
  41. package/dist/src/sync/v2/export/controls/ObjectPageTable.d.ts +5 -3
  42. package/dist/src/sync/v2/export/controls/ObjectPageToolBarAction.d.ts +6 -4
  43. package/dist/src/sync/v2/export/controls/Table.d.ts +5 -3
  44. package/dist/src/sync/v2/export/controls/TableColumn.d.ts +12 -10
  45. package/dist/src/sync/v2/generate/listReport.d.ts +3 -4
  46. package/dist/src/sync/v2/generate/utils.d.ts +7 -6
  47. package/dist/src/sync/v2/types.d.ts +8 -3
  48. package/dist/src/sync/v4/export/controls/Table.d.ts +3 -1
  49. package/dist/src/sync/v4/export/pages/ListReport.d.ts +1 -1
  50. package/dist/src/sync/v4/generate/listReport.d.ts +2 -2
  51. package/dist/src/sync/v4/types.d.ts +1 -1
  52. package/dist/src/sync/v4/utils/utils.d.ts +12 -11
  53. package/dist/test/test-utils/utils.d.ts +1 -2
  54. package/package.json +8 -8
@@ -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;
@@ -37,7 +39,7 @@ export declare class CommonTableSettings<COLS = GenericColumns> implements Commo
37
39
  createWithParameterDialog?: Fields4Dialog;
38
40
  showTablePersonalisation?: boolean;
39
41
  useExportToExcel?: boolean;
40
- exportType?: sap.ui.comp.smarttable.ExportType;
42
+ exportType?: smarttable.ExportType;
41
43
  fitContainer?: boolean;
42
44
  quickVariantSelection?: QuickVariantSelection;
43
45
  quickVariantSelectionX?: QuickVariantSelectionX;
@@ -52,7 +54,7 @@ export declare class CommonTableSettings<COLS = GenericColumns> implements Commo
52
54
  export declare class ResponsiveTable extends CommonTableSettings implements ResponsiveTableConfig {
53
55
  type?: TableTypeV2.ResponsiveTable;
54
56
  createWithFilters?: CreateWithFilters;
55
- popinLayout?: sap.m.PopinLayout;
57
+ popinLayout?: PopinLayout;
56
58
  includeItemInSelection?: boolean;
57
59
  inlineDelete?: boolean;
58
60
  showDraftToggle?: boolean;
@@ -1,25 +1,27 @@
1
- /// <reference types="@sapui5/ts-types" />
1
+ /// <reference types="@sapui5/ts-types-esm" />
2
2
  import type { TableColumn as TableColumnConfig, TableColumnAction as TableColumnActionConfig, TableCustomColumn as TableCustomColumnConfig, TableColumnExtensionTypeV2 } from '../../../../specification/v2';
3
3
  import type { SAPUI5_FRAGMENT_CLASS } from '../../../../specification/common/webapp/manifest';
4
+ import type { TextAlign, URI } from 'sap/ui/core/library';
5
+ import type { ButtonType } from 'sap/m/library';
4
6
  export declare class TableColumn implements TableColumnConfig {
5
7
  width?: string;
6
- hAlign?: sap.ui.core.TextAlign;
8
+ hAlign?: TextAlign;
7
9
  }
8
10
  export declare class TableColumnAction implements TableColumnActionConfig {
9
11
  width?: string;
10
- hAlign?: sap.ui.core.TextAlign;
12
+ hAlign?: TextAlign;
11
13
  tooltip?: string;
12
- icon?: sap.ui.core.URI;
13
- activeIcon?: sap.ui.core.URI;
14
- type?: sap.m.ButtonType;
14
+ icon?: URI;
15
+ activeIcon?: URI;
16
+ type?: ButtonType;
15
17
  }
16
18
  export declare class TableColumnActionIntentBased extends TableColumnAction {
17
19
  width?: string;
18
- hAlign?: sap.ui.core.TextAlign;
20
+ hAlign?: TextAlign;
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
  /**
25
27
  * No sync rules are defined for table custom columns, as they are transferred altogether, by function exportToFragment.
@@ -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
  */
@@ -5,6 +5,7 @@ import type { MetadataFactory, MetadataInstanceInterface } from '../common/decor
5
5
  import type { ExportResults } from '../common';
6
6
  import type * as v2controls from './export/controls';
7
7
  import type * as v2pages from './export/pages';
8
+ import type { Definition } from 'typescript-json-schema';
8
9
  export declare type V2Controls = typeof v2controls;
9
10
  export declare type V2Pages = typeof v2pages;
10
11
  export declare type TransferParameterTypeV2 = {
@@ -27,13 +28,17 @@ export declare const TREETABLE = "TreeTable<LineItems>";
27
28
  export declare const ANALYTICALTABLE = "AnalyticalTable<LineItems>";
28
29
  export declare const GRIDTABLE = "GridTable<LineItems>";
29
30
  export declare enum SectionTypeV2 {
31
+ SectionAddress = "ObjectPageSectionAddressV2",
32
+ SectionChart = "ObjectPageSectionChartV2",
33
+ SectionContact = "ObjectPageSectionContactV2",
34
+ SectionForm = "ObjectPageSectionFormV2",
30
35
  Section = "ObjectPageSectionV2",
31
36
  SubSection = "ObjectPageSubSectionV2",
32
- SectionForm = "ObjectPageSectionFormV2",
33
37
  SectionTable = "ObjectPageSectionTableV2",
34
- SectionChart = "ObjectPageSectionChartV2",
35
38
  SubSectionForm = "ObjectPageSubSectionFormV2",
36
39
  SubSectionTable = "ObjectPageSubSectionTableV2",
40
+ SubSectionAddress = "ObjectPageSubSectionAddressV2",
41
+ SubSectionContact = "ObjectPageSubSectionContactV2",
37
42
  SubSectionChart = "ObjectPageSubSectionChartV2"
38
43
  }
39
44
  export declare enum ActionTypeV2 {
@@ -59,5 +64,5 @@ export declare type ObjectPageV2ConfigParameters = {
59
64
  export declare type SectionPartProperties = {
60
65
  id: string;
61
66
  type: SectionTypeV2;
62
- schema: object;
67
+ schema: Definition;
63
68
  };
@@ -25,6 +25,8 @@ export declare function deleteCreationModeName(manifestSection: unknown, manifes
25
25
  /**
26
26
  * common sync rule function for the deletion of any property of personalization
27
27
  * @param manifestSection - section in manifest comprising the table settings
28
+ * @param _configObject - page config object
29
+ * @param _key - key or property in page config object
28
30
  * @param manifestKey - key or property in manifest
29
31
  */
30
32
  export declare function deletePersonalizationProperty(manifestSection: unknown, _configObject: object, _key: string, manifestKey: string): void;
@@ -142,7 +144,7 @@ export declare class LRTableView extends TableViewSettings implements LRTableVie
142
144
  toolBar?: ToolBar;
143
145
  }
144
146
  /**
145
- * LR mulit-view: own class for properties on views' level
147
+ * LR multi-view: own class for properties on views' level
146
148
  */
147
149
  export declare class MultiTableModeV4 implements MultiTableModeIF {
148
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;
@@ -1,23 +1,23 @@
1
- import type { EntitySet } from '@sap-ux/annotation-converter';
2
1
  import type { GenerateAppSchemaParameters, SapUiAppPageV4 } from '../../../v4';
3
2
  import type { ExtensionLogger } from '../../..';
4
- import type { AnnotationTerm, ConverterOutput, EntityType, LineItem, DataFieldForActionAbstractTypes } from '@sap-ux/vocabularies-types';
3
+ import type { LineItem, DataFieldForActionAbstractTypes } from '@sap-ux/vocabularies-types/vocabularies/UI';
4
+ import type { AnnotationTerm, ConvertedMetadata, EntitySet, EntityType } from '@sap-ux/vocabularies-types';
5
5
  import { DefinitionName } from '../../../v4';
6
6
  import type { Definition } from 'typescript-json-schema';
7
7
  /**
8
- * Common function for enhancing the LineItems definiton of app schema by custom columns
8
+ * Common function for enhancing the LineItems definition of app schema by custom columns
9
9
  * @param appSchema - app-specific JSON schema
10
10
  * @param v4Page - actual page in the manifest
11
11
  * @param logger - logger for error messages
12
12
  * @param customColumnDefinitionName - custom column definition name
13
13
  * @param sectionId - identifier of the current object page section in schema
14
- * @param sectionIdInManfest - identifier of the current object page section in manifest
14
+ * @param sectionIdInManifest - identifier of the current object page section in manifest
15
15
  */
16
- export declare function addCustomColumnDefinition(appSchema: object, v4Page: SapUiAppPageV4, logger: ExtensionLogger, customColumnDefinitionName?: string, sectionId?: string, sectionIdInManfest?: string): void;
16
+ export declare function addCustomColumnDefinition(appSchema: object, v4Page: SapUiAppPageV4, logger: ExtensionLogger, customColumnDefinitionName?: string, sectionId?: string, sectionIdInManifest?: string): void;
17
17
  /**
18
18
  * Processes a LineItem record of type DataFieldForAction during app schema generation
19
19
  * @param appSchema - the app specific schema that shall get enhanced
20
- * @param entityType - the entity type as part of the AVT ConverterOutput
20
+ * @param entityType - the entity type as part of the AVT ConvertedMetadata
21
21
  * @param actions - actions definition in schema, parent object
22
22
  * @param lineItemPath - annotation path to the line item
23
23
  * @param lineItemRecord - actual record of the line item collection
@@ -28,20 +28,21 @@ export declare function handleActionRecord(appSchema: Definition, entityType: En
28
28
  * Adds the line item definition, columns and actions to the app schema (for the list report or an object page section comprising a table)
29
29
  * @param appSchema - the app specific schema that shall get enhanced
30
30
  * @param lineItemAnnotation - the UI.LineItem annotation, comprising all records
31
- * @param entityType - the entity type as part of the AVT ConverterOutput
32
- * @param {ConverterOutput} oDataServiceAVT - complete service information, as returned by Annotation Vocabularies Tool
33
- * @param lineItemId - in case of OP the paramter must be passed to distinguish the OP tables;
31
+ * @param entityType - the entity type as part of the AVT ConvertedMetadata
32
+ * @param {ConvertedMetadata} oDataServiceAVT - complete service information, as returned by Annotation Vocabularies Tool
33
+ * @param lineItemId - in case of OP the parameter must be passed to distinguish the OP tables;
34
34
  * in case of LR or ALP 'LineItems' is passed.
35
35
  * @param columnDefinitionName - name of the column definition, i.e. TableColumn or ObjectPageTableColumn
36
36
  * @param customColumnDefinitionName - name of the custom column definition
37
37
  */
38
- export declare function addLineItemsType(appSchema: Definition, lineItemAnnotation: AnnotationTerm<LineItem>, entityType: EntityType, oDataServiceAVT: ConverterOutput, lineItemId: string, columnDefinitionName?: string, customColumnDefinitionName?: string): void;
38
+ export declare function addLineItemsType(appSchema: Definition, lineItemAnnotation: AnnotationTerm<LineItem>, entityType: EntityType, oDataServiceAVT: ConvertedMetadata, lineItemId: string, columnDefinitionName?: string, customColumnDefinitionName?: string): void;
39
39
  /**
40
40
  * Adds an enum or value help to position > anchor of custom column
41
41
  * @param appSchema - app specific JSON schema
42
42
  * @param lineItemId - ID of the current line item in schema
43
43
  * @param v4Page - current page in manifest
44
44
  * @param positionName - ID of the definition of custom column position in schema
45
+ * @param sectionIdInManifest - identifier of the current object page section in manifest
45
46
  */
46
47
  export declare function addFragmentEnumForAnchor(appSchema: Definition, lineItemId: string, v4Page: SapUiAppPageV4, positionName?: DefinitionName, sectionIdInManifest?: string): void;
47
48
  /**
@@ -59,4 +60,4 @@ export declare function findPageV4(pages: SapUiAppPageV4[], pageName: string, en
59
60
  * @param {GenerateAppSchemaParameters} generateParameters - object comprising all input parameters
60
61
  * @returns the right definition name for the table in the schema
61
62
  */
62
- export declare function alignSchemaWithTemplateType(appSchema: Definition, generateParameters: GenerateAppSchemaParameters): string;
63
+ export declare function alignSchemaWithTemplateType(appSchema: Definition, generateParameters: GenerateAppSchemaParameters): DefinitionName.Table | DefinitionName.ALPTableView;
@@ -1,5 +1,4 @@
1
- import type { FileData } from '../../src';
2
- import type { ExtensionLogger } from '../../src';
1
+ import type { FileData, ExtensionLogger } from '../../src';
3
2
  import type { Location } from '../../src/extensionLogger';
4
3
  import type { ExportResults } from '../../src/sync/common';
5
4
  export declare class Logger implements ExtensionLogger {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sap/ux-specification",
3
- "version": "1.96.11",
3
+ "version": "1.96.14",
4
4
  "displayName": "SAP Fiori tools - Specification",
5
5
  "description": "SAP Fiori tools - Specification",
6
6
  "files": [
@@ -13,8 +13,8 @@
13
13
  "v4": "dist/specification/v4/index-min.js"
14
14
  },
15
15
  "engines": {
16
- "node": ">=12.22.5",
17
- "yarn": ">=1.22.5"
16
+ "node": ">=14.16.0",
17
+ "yarn": ">=1.22.18"
18
18
  },
19
19
  "scripts": {
20
20
  "clean": "rimraf ./dist ./schemas",
@@ -49,10 +49,10 @@
49
49
  "@sap-ux/fe-fpm-writer": "0.6.1"
50
50
  },
51
51
  "devDependencies": {
52
- "@sap-ux/annotation-converter": "0.3.39",
53
- "@sap-ux/edmx-parser": "0.3.39",
54
- "@sap-ux/vocabularies-types": "0.3.39",
55
- "@sapui5/ts-types": "1.96.4",
52
+ "@sap-ux/annotation-converter": "0.5.7",
53
+ "@sap-ux/edmx-parser": "0.5.4",
54
+ "@sap-ux/vocabularies-types": "0.5.4",
55
+ "@sapui5/ts-types-esm": "1.96.8",
56
56
  "@types/d3": "7.1.0",
57
57
  "@types/jest": "26.0.23",
58
58
  "@types/jquery": "3.5.6",
@@ -122,4 +122,4 @@
122
122
  }
123
123
  ]
124
124
  }
125
- }
125
+ }