@sap/ux-specification 1.96.10 → 1.96.11

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 (34) hide show
  1. package/CHANGELOG.md +40 -15
  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/v4/ListReportConfig.json +22 -2
  12. package/dist/schemas/v4/ObjectPageConfig.json +36 -0
  13. package/dist/specification/v2/index-min.js +1 -1
  14. package/dist/src/apiTypes.d.ts +2 -1
  15. package/dist/src/specification/v4/controls/ObjectPageSection.d.ts +22 -1
  16. package/dist/src/specification/v4/controls/Table.d.ts +4 -0
  17. package/dist/src/sync/common/generate/utils.d.ts +39 -8
  18. package/dist/src/sync/common/types.d.ts +57 -8
  19. package/dist/src/sync/common/utils.d.ts +16 -11
  20. package/dist/src/sync/v2/export/controls/Table.d.ts +1 -0
  21. package/dist/src/sync/v2/export/export.d.ts +0 -1
  22. package/dist/src/sync/v2/export/manifest.d.ts +6 -0
  23. package/dist/src/sync/v2/export/pages/OverviewPage.d.ts +1 -1
  24. package/dist/src/sync/v2/generate/utils.d.ts +5 -4
  25. package/dist/src/sync/v2/import/app/appProvider.d.ts +9 -0
  26. package/dist/src/sync/v4/application.d.ts +22 -10
  27. package/dist/src/sync/v4/export/controls/Table.d.ts +5 -1
  28. package/dist/src/sync/v4/export/types.d.ts +5 -5
  29. package/dist/src/sync/v4/generate/objectPage.d.ts +1 -1
  30. package/dist/src/sync/v4/import/pages/objectPage.d.ts +13 -0
  31. package/dist/src/sync/v4/import/utils.d.ts +2 -1
  32. package/dist/src/sync/v4/types.d.ts +2 -0
  33. package/dist/src/sync/v4/utils/utils.d.ts +3 -4
  34. package/package.json +3 -3
@@ -6,16 +6,28 @@ export declare const getSettingsPathForPage: (pageName: string[]) => string;
6
6
  export declare const getSettingsPathForLRViewsPaths: (pageName: string[]) => string;
7
7
  export declare const getSettingsPathForHeaderOP: (pageName: string[]) => string;
8
8
  export declare const getControlConfigurationPath: (pageName: string[]) => string;
9
- export declare const getHeaderFacetSettingPath: (pageName: string[], manifest: Manifest, sectionId: string) => string;
10
- export declare const getTableSettingsPathForLR: (pageName: string[]) => string;
11
- export declare const getColumnsPathForLR: (pageName: string[], manifest: Manifest, sectionId: string, columnKey: string) => string;
12
- export declare const getColumnsPathForView: (pageName: string[], manifest: Manifest, targetAnnotationEncoded: string, columnKey: string, targetAnnotation: string) => string;
13
- export declare const getActionsPathForLR: (pageName: string[], manifest: Manifest, sectionId: string, columnKey: string) => string;
14
- export declare const getActionsPathForView: (pageName: string[], manifest: Manifest, targetAnnotationEncoded: string, columnKey: string, targetAnnotation: string) => string;
15
- export declare const getColumnsPathForOP: (pageName: string[], manifest: Manifest, sectionId: string, columnKey: string) => string;
16
- export declare const getActionsPathForOP: (pageName: string[], manifest: Manifest, sectionId: string, columnKey: string) => string;
17
- export declare const getTableSettingsPathForOP: (pageName: string[], manifest: Manifest, sectionId: string) => string;
18
- export declare const getCustomSectionPath: (pageName: string[], manifest: Manifest, sectionId: string, pathPart?: string) => string;
9
+ export declare const getHeaderFacetSettingPath: (pageName: string[], _manifest: Manifest, sectionId: string) => string;
10
+ /**
11
+ * Common function that calculates the path in manifest for table settings of a list report or ALP table view
12
+ * @param pageName - page name in manifest
13
+ * @param manifest - manifest (not used)
14
+ * @param targetAnnotationEncoded - encoded target annotation (not used)
15
+ * @param viewKey - view key (not used)
16
+ * @param targetAnnotation - target annotation, i.e. the line item (with or without qualifier)
17
+ * @returns - path as string
18
+ */
19
+ export declare const getTableSettingsPathForView: (pageName: string[], _manifest: Manifest, _targetAnnotationEncoded: string, _viewKey: string, targetAnnotation: string) => string;
20
+ export declare const getExportSectionId: (sectionId: any) => string;
21
+ export declare const getTableSettingsPathForLR: (pageName: string[], manifest: Manifest, targetAnnotationEncoded: string, columnKey: string, targetAnnotation: string) => string;
22
+ export declare const getQuickVariantPath: (pageName: string[], manifest: Manifest, targetAnnotationEncoded: string, columnKey: string, targetAnnotation: string) => string;
23
+ export declare const getColumnsPathForView: (pageName: string[], _manifest: Manifest, targetAnnotationEncoded: string, columnKey: string, targetAnnotation: string) => string;
24
+ export declare const getColumnsPathForLR: (pageName: string[], manifest: Manifest, targetAnnotationEncoded: string, columnKey: string, targetAnnotation: string) => string;
25
+ export declare const getActionsPathForView: (pageName: string[], _manifest: Manifest, _targetAnnotationEncoded: string, columnKey: string, targetAnnotation: string) => string;
26
+ export declare const getActionsPathForLR: (pageName: string[], manifest: Manifest, targetAnnotationEncoded: string, columnKey: string, targetAnnotation: string) => string;
27
+ export declare const getColumnsPathForOP: (pageName: string[], _manifest: Manifest, sectionId: string, columnKey: string) => string;
28
+ export declare const getActionsPathForOP: (pageName: string[], _manifest: Manifest, sectionId: string, columnKey: string) => string;
29
+ export declare const getTableSettingsPathForOP: (pageName: string[], _manifest: Manifest, sectionId: string) => string;
30
+ export declare const getCustomSectionPath: (pageName: string[], _manifest: Manifest, sectionId: string, pathPart?: string) => string;
19
31
  export declare class ApplicationV4 implements Application {
20
32
  $schema?: string;
21
33
  id?: string;
@@ -27,7 +27,7 @@ export declare function deleteCreationModeName(manifestSection: unknown, manifes
27
27
  * @param manifestSection - section in manifest comprising the table settings
28
28
  * @param manifestKey - key or property in manifest
29
29
  */
30
- export declare function deletePersonalizationProperty(manifestSection: unknown, manifestKey: string): void;
30
+ export declare function deletePersonalizationProperty(manifestSection: unknown, _configObject: object, _key: string, manifestKey: string): void;
31
31
  /**
32
32
  * sync rule function for export of creationMode.createAtEnd
33
33
  * @param manifestSection - section in manifest comprising the table settings
@@ -124,6 +124,8 @@ export declare class ALPTable extends TableViewSettings implements ALPTableIF {
124
124
  * Sync class for LRChartView
125
125
  */
126
126
  export declare class LRChartView implements LRChartViewIF {
127
+ key: string;
128
+ index: number;
127
129
  annotationPath: string;
128
130
  entitySet?: string;
129
131
  toolBar?: ViewChartToolBar;
@@ -132,6 +134,8 @@ export declare class LRChartView implements LRChartViewIF {
132
134
  * Sync class for LRTableView
133
135
  */
134
136
  export declare class LRTableView extends TableViewSettings implements LRTableViewIF {
137
+ key: string;
138
+ index: number;
135
139
  annotationPath: string;
136
140
  keepPreviousPersonalization?: boolean;
137
141
  entitySet?: string;
@@ -1,9 +1,8 @@
1
- import type { ExtensionLogger } from '../../..';
1
+ import type { Definition } from 'typescript-json-schema';
2
+ import type { ExtensionLogger, UI5Version } from '../../..';
2
3
  import type { PageType } from '../../../specification/common';
3
- import type { UI5Version } from '../../../v2';
4
- import type { TemplateType } from '../../common';
5
4
  import type { MetadataFactory } from '../../common/decoration/factory';
6
- import type { ExportResults, FlexAdapter } from '../../common/types';
5
+ import type { ExportResults, FlexAdapter, TemplateType } from '../../common';
7
6
  export declare type ManifestPathSection = (path: string, targetAnnotationPath: string) => string;
8
7
  export interface ManifestConverter4Section {
9
8
  path: ManifestPathSection;
@@ -16,7 +15,8 @@ export declare type TransferParameterTypeV4 = {
16
15
  exportResults: ExportResults;
17
16
  appId: string;
18
17
  baseId: string;
19
- appSchema: object;
18
+ appSchema: Definition;
19
+ config: object;
20
20
  ui5Version: UI5Version;
21
21
  factory: MetadataFactory;
22
22
  pageNameArray: string[];
@@ -1,4 +1,4 @@
1
- import type { GenerateAppSchemaParameters } from '../../../v4';
1
+ import type { GenerateAppSchemaParameters } from '../../..';
2
2
  /**
3
3
  * Generates an app specific schema out of the generic schema.
4
4
  * Generic types are replaced by information from the app specific annotations.
@@ -1,5 +1,18 @@
1
1
  import type { ObjectPageConfig as ObjectPageConfigV4 } from '../../../../specification/v4/';
2
2
  import type { ImportObjectPageV4Parameters } from '../../../../apiTypes';
3
+ /**
4
+ * Converts section ID to manifest ID (replaces '::' with ['/', '#'])
5
+ * @param sectionId - converted ID of the given object page section
6
+ * @param splitOnLt - split ID and get only part in <...>
7
+ * @returns manifest ID
8
+ */
9
+ export declare function getManifestId(sectionId: string, splitOnLt?: boolean): string;
10
+ /**
11
+ * Converts manifest ID to definition ID (replaces ['#', '/'] with '::')
12
+ * @param manifestId - ID of the given object page section in manifest
13
+ * @returns definition ID
14
+ */
15
+ export declare function getDefinitionId(manifestId: string): string;
3
16
  /**
4
17
  * External API: Create configuration (file content) for a V4 object page
5
18
  * @param {ImportObjectPageV4Parameters} importParameters - object comprising all input data
@@ -1,3 +1,4 @@
1
+ import type { Definition, DefinitionOrBoolean } from 'typescript-json-schema';
1
2
  import type { Manifest } from '../../../specification/common/webapp/manifest/Manifest';
2
3
  import type { ExtensionLogger } from '../../..';
3
4
  /**
@@ -11,4 +12,4 @@ import type { ExtensionLogger } from '../../..';
11
12
  */
12
13
  export declare function transferSettingsOfObject(configPart: {
13
14
  [key: string]: any;
14
- }, manifest: Manifest, appSchema: object, pageKey: string, breadcrumbs: string[], sectionId?: string, logger?: ExtensionLogger): void;
15
+ }, manifest: Manifest, appSchema: Definition | DefinitionOrBoolean, pageKey: string, breadcrumbs: string[], sectionId?: string, logger?: ExtensionLogger): void;
@@ -1,4 +1,6 @@
1
+ import type { Chart, LineItem } from '@sap-ux/vocabularies-types';
1
2
  import type * as v4controls from './export/controls';
2
3
  import type * as v4pages from './export/pages';
3
4
  export declare type V4Controls = typeof v4controls;
4
5
  export declare type V4Pages = typeof v4pages;
6
+ export declare type PresentationVariantV4 = Chart | LineItem;
@@ -1,7 +1,7 @@
1
- import type { AnnotationTerm, ConverterOutput, EntityType, LineItem, DataFieldForActionAbstractTypes } from '@sap-ux/vocabularies-types';
2
1
  import type { EntitySet } from '@sap-ux/annotation-converter';
3
- import type { ExtensionLogger } from '../../..';
4
2
  import type { GenerateAppSchemaParameters, SapUiAppPageV4 } from '../../../v4';
3
+ import type { ExtensionLogger } from '../../..';
4
+ import type { AnnotationTerm, ConverterOutput, EntityType, LineItem, DataFieldForActionAbstractTypes } from '@sap-ux/vocabularies-types';
5
5
  import { DefinitionName } from '../../../v4';
6
6
  import type { Definition } from 'typescript-json-schema';
7
7
  /**
@@ -23,14 +23,13 @@ export declare function addCustomColumnDefinition(appSchema: object, v4Page: Sap
23
23
  * @param lineItemRecord - actual record of the line item collection
24
24
  * @param recordIndex - record index in the collection
25
25
  */
26
- export declare function handleActionRecord(appSchema: Definition, entityType: EntityType, actions: Definition, lineItemPath: string, lineItemRecord: DataFieldForActionAbstractTypes, lineItemId: string, recordIndex: number): void;
26
+ export declare function handleActionRecord(appSchema: Definition, entityType: EntityType, actionsDefinition: Definition, lineItemPath: string, lineItemRecord: DataFieldForActionAbstractTypes, lineItemId: string, recordIndex: number): void;
27
27
  /**
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
31
  * @param entityType - the entity type as part of the AVT ConverterOutput
32
32
  * @param {ConverterOutput} oDataServiceAVT - complete service information, as returned by Annotation Vocabularies Tool
33
- * @param actionDefinitionName - indicates the prefix for the definition, dpending on the page type
34
33
  * @param lineItemId - in case of OP the paramter must be passed to distinguish the OP tables;
35
34
  * in case of LR or ALP 'LineItems' is passed.
36
35
  * @param columnDefinitionName - name of the column definition, i.e. TableColumn or ObjectPageTableColumn
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sap/ux-specification",
3
- "version": "1.96.10",
3
+ "version": "1.96.11",
4
4
  "displayName": "SAP Fiori tools - Specification",
5
5
  "description": "SAP Fiori tools - Specification",
6
6
  "files": [
@@ -46,7 +46,7 @@
46
46
  "publisher": "SAPSE",
47
47
  "license": "SEE LICENSE IN LICENSE",
48
48
  "dependencies": {
49
- "@sap-ux/fe-fpm-writer": "0.5.0"
49
+ "@sap-ux/fe-fpm-writer": "0.6.1"
50
50
  },
51
51
  "devDependencies": {
52
52
  "@sap-ux/annotation-converter": "0.3.39",
@@ -65,7 +65,7 @@
65
65
  "cpy-cli": "3.1.1",
66
66
  "d3": "7.1.1",
67
67
  "deepmerge": "4.2.2",
68
- "ejs": "3.1.6",
68
+ "ejs": "3.1.7",
69
69
  "eslint": "7.32.0",
70
70
  "eslint-formatter-multiple": "1.0.0",
71
71
  "eslint-plugin-prettier": "3.4.1",