@sap/ux-specification 1.96.16 → 1.96.19

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 (39) hide show
  1. package/CHANGELOG.md +72 -15
  2. package/dist/documentation/runDocu-min.js +1 -1
  3. package/dist/documentation/v2/v2-AnalyticalListPage.html +1 -1
  4. package/dist/documentation/v2/v2-ApplicationV2.html +1 -1
  5. package/dist/documentation/v2/v2-ListReport.html +1 -1
  6. package/dist/documentation/v2/v2-ObjectPage.html +1 -1
  7. package/dist/documentation/v2/v2-OverviewPage.html +1 -1
  8. package/dist/documentation/v4/v4-ApplicationV4.html +1 -1
  9. package/dist/documentation/v4/v4-FreestylePage.html +1 -1
  10. package/dist/documentation/v4/v4-ListReport.html +1 -1
  11. package/dist/documentation/v4/v4-ObjectPage.html +1 -1
  12. package/dist/index-min.js +1 -1
  13. package/dist/schemas/v2/AnalyticalListPageConfig.json +3 -2
  14. package/dist/schemas/v2/ApplicationV2.json +10 -1
  15. package/dist/schemas/v2/ListReportConfig.json +5 -4
  16. package/dist/schemas/v2/ObjectPageConfig.json +20 -19
  17. package/dist/schemas/v4/ApplicationV4.json +10 -1
  18. package/dist/schemas/v4/ListReportConfig.json +307 -38
  19. package/dist/schemas/v4/ObjectPageConfig.json +101 -1
  20. package/dist/specification/v4/index-min.js +1 -1
  21. package/dist/src/apiTypes.d.ts +6 -3
  22. package/dist/src/specification/common/page.d.ts +1 -1
  23. package/dist/src/specification/v2/controls/Table.d.ts +1 -0
  24. package/dist/src/specification/v4/controls/ObjectPageToolBar.d.ts +14 -2
  25. package/dist/src/specification/v4/controls/Table.d.ts +42 -1
  26. package/dist/src/specification/v4/controls/ToolBar.d.ts +59 -2
  27. package/dist/src/specification/v4/webapp/manifest/sapUi5.d.ts +1 -3
  28. package/dist/src/sync/common/generate/utils.d.ts +39 -18
  29. package/dist/src/sync/common/types.d.ts +10 -3
  30. package/dist/src/sync/common/utils.d.ts +7 -1
  31. package/dist/src/sync/v2/export/export.d.ts +2 -1
  32. package/dist/src/sync/v4/export/controls/ObjectPageToolBarAction.d.ts +16 -1
  33. package/dist/src/sync/v4/export/controls/Table.d.ts +12 -2
  34. package/dist/src/sync/v4/export/controls/ToolBar.d.ts +2 -2
  35. package/dist/src/sync/v4/export/controls/ToolBarAction.d.ts +31 -1
  36. package/dist/src/sync/v4/export/utils.d.ts +6 -0
  37. package/dist/src/sync/v4/generate/generate.d.ts +1 -1
  38. package/dist/src/sync/v4/utils/utils.d.ts +20 -3
  39. package/package.json +6 -6
@@ -1,7 +1,37 @@
1
- import type { ToolBarAction as ToolBarActionIF, ViewToolBarAction as ViewToolBarActionIF, SelectType } from '../../../../specification/v4';
1
+ import type { ToolBarAction as ToolBarActionIF, ViewToolBarAction as ViewToolBarActionIF, SelectType, CustomAction as CustomActionIF, CustomActionPosition as PositionIF, ViewTableCustomAction as ViewTableCustomActionIF, ViewCustomActionPosition as ViewCustomActionPositionIF, ActionPlacement } from '../../../../specification/v4';
2
2
  export declare class ToolBarAction implements ToolBarActionIF {
3
3
  enableOnSelect?: SelectType;
4
4
  }
5
5
  export declare class ViewToolBarAction implements ViewToolBarActionIF {
6
6
  enableOnSelect?: SelectType;
7
7
  }
8
+ /**
9
+ * Sync class for Position
10
+ */
11
+ export declare class CustomActionPosition implements PositionIF {
12
+ anchor?: string;
13
+ placement: ActionPlacement;
14
+ }
15
+ export declare class CustomAction implements CustomActionIF {
16
+ text: string;
17
+ position: CustomActionPosition;
18
+ press: string;
19
+ requiresSelection?: boolean;
20
+ visible?: boolean;
21
+ enabled?: boolean;
22
+ }
23
+ /**
24
+ * Sync class for Position
25
+ */
26
+ export declare class ViewCustomActionPosition implements ViewCustomActionPositionIF {
27
+ anchor?: string;
28
+ placement: ActionPlacement;
29
+ }
30
+ export declare class ViewTableCustomAction implements ViewTableCustomActionIF {
31
+ text: string;
32
+ position: CustomActionPosition;
33
+ press: string;
34
+ requiresSelection?: boolean;
35
+ visible?: boolean;
36
+ enabled?: boolean;
37
+ }
@@ -6,3 +6,9 @@ import type { SapUi5V4 } from '../../../specification/v4';
6
6
  * @param {boolean} [add=true] - Add or remove library.
7
7
  */
8
8
  export declare function updateDependencyLib(manifest: SapUi5V4, name: string, add?: boolean): void;
9
+ /**
10
+ * Looks for <...> pattern in the input string; if found, extracts this last part of the string
11
+ * @param longId - schema ID in its long format
12
+ * @returns the converted ID
13
+ */
14
+ export declare function extractLastIdPart(longId: string): string;
@@ -39,4 +39,4 @@ export declare function generateListReportInterfaceV4(templateType: TemplateType
39
39
  *
40
40
  * @returns the app specific JSON schema
41
41
  */
42
- export declare function generateFreestyleInterfaceV4(templateType: TemplateType, genericSchema: object, annotations: FileData[], manifest?: object, entitySetName?: string, logger?: ExtensionLogger): object;
42
+ export declare function generateFreestyleInterfaceV4(templateType: TemplateType, genericSchema: object, annotations: FileData[], manifest?: object, _entitySetName?: string, logger?: ExtensionLogger): object;
@@ -13,7 +13,7 @@ import type { Definition } from 'typescript-json-schema';
13
13
  * @param sectionId - identifier of the current object page section in schema
14
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, sectionIdInManifest?: string): void;
16
+ export declare function addCustomColumnDefinition(appSchema: Definition, 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
@@ -35,7 +35,7 @@ export declare function handleActionRecord(appSchema: Definition, entityType: En
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: ConvertedMetadata, 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, customActionDefinitionName?: 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
@@ -44,7 +44,14 @@ export declare function addLineItemsType(appSchema: Definition, lineItemAnnotati
44
44
  * @param positionName - ID of the definition of custom column position in schema
45
45
  * @param sectionIdInManifest - identifier of the current object page section in manifest
46
46
  */
47
- export declare function addFragmentEnumForAnchor(appSchema: Definition, lineItemId: string, v4Page: SapUiAppPageV4, positionName?: DefinitionName, sectionIdInManifest?: string): void;
47
+ export declare function addFragmentEnumForAnchor(appSchema: Definition, lineItemId: string, v4Page: SapUiAppPageV4, positionName?: string, sectionIdInManifest?: string): void;
48
+ /**
49
+ * Adds an enum or value help to position > anchor of custom column
50
+ * @param appSchema - app specific JSON schema
51
+ * @param definitionId - definition key of actions
52
+ * @param positionName - target definition to update
53
+ */
54
+ export declare function addEnumForActionAnchor(appSchema: Definition, definitionId: string, positionName?: string): void;
48
55
  /**
49
56
  * Find the relevant V4 page under the routing targets of manifest,json
50
57
  * @param pages - list of all pages in manifest
@@ -61,3 +68,13 @@ export declare function findPageV4(pages: SapUiAppPageV4[], pageName: string, en
61
68
  * @returns the right definition name for the table in the schema
62
69
  */
63
70
  export declare function alignSchemaWithTemplateType(appSchema: Definition, generateParameters: GenerateAppSchemaParameters): DefinitionName.Table | DefinitionName.ALPTableView;
71
+ /**
72
+ * Common function for enhancing the LineItems definition of app schema by custom columns
73
+ * @param appSchema - app-specific JSON schema
74
+ * @param v4Page - actual page in the manifest
75
+ * @param logger - logger for error messages
76
+ * @param customColumnDefinitionName - custom column definition name
77
+ * @param sectionId - identifier of the current object page section in schema
78
+ * @param sectionIdInManifest - identifier of the current object page section in manifest
79
+ */
80
+ export declare function addCustomActionDefinition(appSchema: Definition, v4Page: SapUiAppPageV4, logger: ExtensionLogger, customColumnDefinitionName?: string, sectionId?: string, sectionIdInManifest?: string): void;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sap/ux-specification",
3
- "version": "1.96.16",
3
+ "version": "1.96.19",
4
4
  "displayName": "SAP Fiori tools - Specification",
5
5
  "description": "SAP Fiori tools - Specification",
6
6
  "files": [
@@ -14,7 +14,7 @@
14
14
  },
15
15
  "engines": {
16
16
  "node": ">=14.16.0",
17
- "yarn": ">=1.22.18"
17
+ "yarn": ">=1.22.19"
18
18
  },
19
19
  "scripts": {
20
20
  "clean": "rimraf ./dist ./schemas",
@@ -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.11.0"
49
+ "@sap-ux/fe-fpm-writer": "0.13.4"
50
50
  },
51
51
  "devDependencies": {
52
52
  "@sap-ux/annotation-converter": "0.5.7",
@@ -77,21 +77,21 @@
77
77
  "jest-sonar-reporter": "2.0.0",
78
78
  "jquery": "3.6.0",
79
79
  "lodash.unset": "4.5.2",
80
- "mem-fs-editor": "9.3.0",
80
+ "mem-fs-editor": "9.4.0",
81
81
  "path": "0.12.7",
82
82
  "prettier": "2.5.1",
83
83
  "reflect-metadata": "0.1.13",
84
84
  "rimraf": "3.0.2",
85
85
  "sax": "1.2.4",
86
86
  "source-map-loader": "1.0.0",
87
- "terser-webpack-plugin": "4.2.3",
87
+ "terser-webpack-plugin": "5.3.3",
88
88
  "ts-jest": "26.5.6",
89
89
  "ts-json-schema-generator": "0.96.0",
90
90
  "ts-loader": "9.1.2",
91
91
  "ts-node": "9.1.1",
92
92
  "typescript": "3.8.3",
93
93
  "typescript-json-schema": "0.48.0",
94
- "webpack-cli": "4.7.2",
94
+ "webpack-cli": "4.10.0",
95
95
  "xml-js": "1.6.11"
96
96
  },
97
97
  "husky": {