@sap/ux-specification 1.102.26 → 1.102.28

package/CHANGELOG.md

@@ -0,0 +1,609 @@
+# Change Log
+
+All notable changes to this project are documented in this file.
+
+This project adheres to [Semantic Versioning](http://semver.org/) and the changelog is formatted based on [Keep a Changelog](http://keepachangelog.com/).
+
+# Prerequisites
+
+[NodeJS](https://nodejs.org/en/download/) Version `18.18.0` or higher
+
+## [1.102.28] - 2023-10-19
+
+### Added
+
+### Changed
+
+### Removed
+
+### Deprecated
+
+### Fixed
+
+### Quality
+
+- Update transitive dependencies
+
+## [1.102.27] - 2023-10-05
+
+### Fixed
+
+- Fixed an issue with CHANGELOG.md file not being visible on npmjs
+- OData V2:
+  - A missing entitySet definition for a page in manifest was not indicated correctly in the returned log. Even worse, the export deleted the related page in such a scenario. This is fixed now, the schema generation as well as the import are more fault-tolerant now with regard to this situation
+  
+
+### Quality
+
+- Update transitive dependencies
+
+Upgrades:
+
+- eslint to 8.48.0
+- @typescript-eslint/eslint-plugin and @typescript-eslint/parser to 5.62.0
+- @sap-ux/vocabularies-types to 0.9.1
+- esbuild to "0.19.2",
+- eslint-config-prettier to 8.10.0
+- @sap-ux/fe-fpm-writer to v0.23.1
+- @types/jquery to 3.5.18
+- jquery to 3.7.1
+- @types/semver to v7.5.1
+- typescript-json-schema to v0.57.0
+
+## [1.102.26] - 2023-07-12
+
+### Quality
+
+- Update transitive dependencies
+
+Upgrades:
+
+- @sap-ux/fe-fpm-writer to 0.22.3
+- @typescript-eslint/eslint-plugin and @typescript-eslint/parser to 5.61.0
+- eslint to 8.44.0
+- eslint-formatter-multiple to 2.0.0
+- eslint-plugin-prettier" to 4.2.1
+- semver to 7.5.4
+
+## [1.102.25] - 2023-06-30
+
+### Quality
+
+- Update transitive dependencies
+
+Upgrades:
+
+- semver to 7.5.3
+- @typescript-eslint/eslint-plugin and @typescript-eslint/parser to 5.60.0
+- @sap-ux/vocabularies-types to 0.9.0
+- @sap-ux/edmx-parser to 0.6.0
+- @sapui5/ts-types-esm to 1.102.19
+- @sap-ux/fe-fpm-writer to 0.22.2
+
+## [1.102.24] - 2023-06-14
+
+### Changed
+
+- OData V4:
+  - Changed binding expression to use "isEditable" property instead of "editable". Thus we have binding expressions {ui>/isEditable} and {= !${ui>/isEditable}}.
+
+### Quality
+
+## [1.102.23] - 2023-05-04
+
+### Added
+
+- OData V4:
+  - OP: New value "InilneCreationRows" added to creationMode->name property
+
+### Fixed
+
+- OData V4:
+  - Parsing of commented contents in XML fragments, comments are now getting ignored during generation and import
+  - When adding new pages, the export calculates the route pattern for the new manifest entry.  
+Indeed, the previous logic did not consider the naming at parent pages, but defined the key name in the pattern as `key`(+ index). This led to navigation errors at run-time. Now, the key names of existing parent pages are taken over to the child page's pattern.
+
+### Quality
+
+- Update transitive dependencies
+
+Upgrades:
+- prettier to 2.8.8
+- typescript to 4.9.5
+- @types/nodes to 18.16.3
+- patch-package to 6.5.1
+- @typescript-eslint/eslint-plugin and @typescript-eslint/parser to 5.59.2
+- Update @sap-ux/vocabularies-types to 0.7.4
+- Update @sap-ux/annotation-converter to 0.5.22
+- Update @sap-ux/edmx-parser to 0.5.14
+
+## [1.102.22] - 2023-04-19
+
+### Fixed
+
+- OData V4:
+  - Fixed an issue with custom extensions running into an endless loop
+
+### Quality
+
+- Update transitive dependencies
+
+Upgrades:
+- @sapui5/ts-types-esm to 1.102.16
+- @typescript-eslint/eslint-plugin and @typescript-eslint/parser to 5.58.0
+- @types/mem-fs-editor to 7.0.3
+- semver to 7.5.0
+
+## [1.102.21] - 2023-04-05
+
+### Added
+
+- OData V4:
+  - Building blocks support for custom sections
+
+### Quality
+
+- Update transitive dependencies
+
+Upgrades:
+- excel4node to 1.8.1
+- eslint-config-prettier to 8.8.0
+- prettier to 2.8.7
+- @typescript-eslint/eslint-plugin and @typescript-eslint/parser to 5.57.0
+- d3 to 7.8.4
+
+## [1.102.20] - 2023-03-22
+
+### Added
+
+- OData V4: the schema App.json and config app.json that get generated now also comprise the information `routePattern` for each page, i.e. the route pattern of the page as comprised in the manifest.json.
+
+### Quality
+
+Upgrades:
+
+- chalk to 4.1.2
+- types/jest to 28.1.8
+- jQuery to 3.6.4
+- ejs to 3.1.9
+- deepmerge to 4.3.1
+- eslint-config-prettier to 8.7.0
+- prettier to 2.8.4
+
+## [1.102.19] - 2023-03-08
+
+### Fixed
+
+- OData V2:
+  - Fixed deletion issues for Custom Columns that appeared after positions were changed
+
+### Quality
+
+- Upgrade "typescript" to "4.9.4"
+- Upgrade "@typescript-eslint/eslint-plugin" and  "@typescript-eslint/parser" to "5.52.0"
+- Upgrade "ts-node" to "10.9.1" 
+- Upgrade "@sap-ux/fe-fpm-writer" to "0.18.7"
+- Upgrade "mem-fs-editor" to "9.7.0"
+- Revert "typescript-json-schema" to "0.53.0" in types package
+
+## [1.102.18] - 2023-02-22
+
+### Added
+
+- OData V2:
+  - Additional value `creationRows` of property `CreateMode` are supported now for object page tables.
+
+### Quality
+
+- Upgrade transitive dependencies
+- Upgrade "@types/jquery" to "3.5.16"
+- Upgrade "@types/mem-fs-editor" to "7.0.2"
+- Upgrade "excel4node" to "1.8.0"
+- Upgrade "i18next" to "20.6.1"
+- Upgrade "typescript-json-schema" to "0.55.0" in types package
+- Upgrade "@sap-ux/fe-fpm-writer` to "0.18.5"
+- Upgrade "d3" to "7.8.2"
+- Upgrade "@sapui5/ts-types-esm" to "1.102.13"
+- Upgrade "jest", "ts-jest", "@types/jest"
+- Upgrade "set-value"
+
+## [1.102.17] - 2023-02-09
+
+### Added
+
+- XML Property artifact type for building block properties
+
+### Changed
+
+- OData V4: enhancements on contextPath support
+
+### Fixed
+
+- OData V2:
+  - Resolved sync issue with unknown properties on fields for `Table > CreateWithParameterDialog`
+- OData V4:
+  - Fixed issue with missing schema and config for List report page in freestyle app
+
+### Quality
+
+- Upgrade transitive dependencies
+- Remove unused devDependencies
+- Upgrade ejs to `3.1.8`
+- Upgrade @types/jquery to `3.5.13`
+- Upgrade jQuery to 3.6.3.
+- Upgrade semver to 7.3.8
+- Upgrade axios to 0.27.2
+- Upgrade deepmerge to 4.3.0
+- Upgrade mem-fs-editor to 9.6.0
+
+## [1.102.16] - 2023-01-25
+
+### Added
+
+- OData V4:
+  - Generation of `propertyIndex` property in schemas for root properties
+
+- OData V2:
+  - Generation of `propertyIndex` property in schemas for root properties
+
+### Quality
+
+- Removed many unnecessary and obsolete resolutions
+- Upgrade fe-fpm-writer to 0.18.4
+
+## [1.102.15] - 2023-01-11
+
+### Added
+
+- General:
+  - New definitions for page types are delivered that allow a better distinction:
+    - PageTypeV2 for types that occur in OData V2
+    - PageTypeV4 for types that occur in OData V4
+    - PageType as a superset of all page types that may occur
+
+- OData V4:
+  - Support visual filters in toolbar on List report
+  - Support actions in header on List report
+  - Default annotationPath is added in schema even if LineItem annotation is not defined
+  - Added support for applications using `contextPath` in manifest.json
+
+### Changed
+
+- API for OData V2:
+  - Inner functions for the generation of app schemas have been adapted, i.e. generateAnalyticalListReportSchemaV2, generateListReportSchemaV2, generateObjectPageSchemaV2: the entityTypeName is not passed as an input parameter anymore, as the entity set cannot be uniquely determined from it. Instead, the functions now rely on generateParameters.entitySet, the entityType is derived from this information. The api version is increased to 7.
+
+### Removed
+
+- OData V2:
+  - Removed obsolete `showDraftToggle` property
+
+### Fixed
+
+- OData V4:
+  - Fixed toolbar action IDs by replacing special chars with double colon
+  - Fixed incorrect order of Custom Actions when multiple before anchors are used
+  - Not all meta characters of action keys had been converted to `::`, as a consequence existing actions in manifest may have not been considered, or new actions had not been written with the right syntax.
+- OData V2:
+  - Fixed deletion of fragment cells contents in case last element is deleted
+
+### Quality
+
+- Removed obsolete snapshots files
+- Removed unused and obsolete resolutions
+
+## [1.102.14] - 2022-11-30
+
+### Added
+
+- Missing i18n classification added to labels of custom views
+
+### Changed
+
+- UI adjustments of in-place documentation:
+  - moved label of specification and odata version to tree canvas
+  - aligned behavior of tree buttons to expand (+) and collapse (-) with given design
+  - removed all hard coded colors
+  - fixed hover on search results
+  - aligned tooltip with given design
+
+- OData V2:
+  - fields for `Table > CreateWithParameterDialog` are now shown as enum and the import/export is done implicitly in the background (adding `path` property).
+
+### Fixed
+
+- Fixed an issue with adding target namespace information for object page sections
+
+### Quality
+
+## [1.102.13] - 2022-11-17
+
+### Added
+
+- OData V4:
+  - Support custom actions for Header and Footer
+
+### Changed
+
+- All parameters in the specification API now are typed.
+- Export `ControllerExtensionPageType`, `CustomActionTargetControl` enums from `fpm-writer` as types.
+
+### Fixed
+
+- OData V2: Adjusted the values shown for `CreateWithParameterDialog` fields > `path` property.
+- OData V4: if the key of one view comprised the key of another view, the export of changes generated duplicate view entries in manifest. Activities like reordering of views did not work in this scenario.
+
+### Quality
+
+- Upgrade of "@sap-ux/vocabularies-types", "@sap-ux/annotation-converter", "@sap-ux/edmx-parser"
+- Upgrade node version to 16.18.0
+
+## [1.102.12] - 2022-11-03
+
+### Added
+
+- OData V4:
+  - Support afterExecution for
+    - List report toolbar actions
+    - Object page header actions
+    - Object page footer actions
+    - Object page form actions
+
+### Changed
+
+- OData V4:
+  - Refactored interfaces for custom actions
+- General: the schema tag `key` (concatenated string) got replaced by the schema tag `keys` that is defined as an array of objects with `name`and `value`.  Reasons are the support of different CSS styles for `name` and `value` as well as globalization (bi-directional languages).
+- API. Export `ControllerExtensionPageType`, `CustomActionTargetControl` enums from `fpm-writer`.
+
+### Fixed
+
+- OData V4:
+  - Fixed an issue with custom pages using an unknown template (not `sap.fe.core.fpm`).
+
+### Quality
+
+## [1.102.11] - 2022-10-20
+
+### Added
+
+- Applications that show content from schemas may want to also display the technical key - this simplifies identification of the corresponding element in the original source file. To this aim, the tag `key` is used for properties. `key` is a concatenated string that also sows a prefix following one of the patterns:
+  - Value for DataFields
+  - Key for custom columns etc. where it is a key in the manifest. Only exception are views: they have no prefix as there is logic that programs against the key.
+  - ID for facets
+  - Action for any action
+  - Instance-based navigation: Property + SemanticObject + Action
+  - Target for DataFieldForAnnotation.  
+In case of Target, an additional schema tag `target` is added: it not only represents the namespace but potentially also the target within the namespace (entity container, entity type, ...)
+- OData V4:
+  - Custom action support in Object Page forms
+  
+### Changed
+
+- Common dependencies have been moved to the root level.
+- Further type definitions have been moved from the specification package to the types package.
+
+### Fixed
+
+- OData V4:
+  - Fixed an issue with custom actions referencing each other
+
+## [1.102.10] - 2022-10-06
+
+### Changed
+
+- Upgrade fe-fpm-writer version to 0.17.6
+
+### Fixed
+
+- At Object Page sections, a missing consideration of potential qualifiers of UI.Identification led to an exception.
+- The API can be called with an empty array of annotations. By now this led to an exception, as it was not considered that the annotation vocabularies tools (AVT) return an empty instance.
+
+### Quality
+
+- Upgrade of d3 and d3-color
+- Upgrade of FPM writer
+
+## [1.102.9] - 2022-09-24
+
+### Quality
+
+- Changed settings to enable the SAP internal delivery of the types package
+
+## [1.102.8] - 2022-09-22
+
+### Added
+
+- OData V4:
+  - Added custom pages not using FPM library to pages view in Application Modeler Panel (limited functionality support)
+  - Controller Extension support in "app.json"
+  - Zero state support
+
+### Changed
+
+- Upgrade of fe-fpm-writer to version 0.17.2, increment of fpmWriter property returned by getApiVersion to 4.
+
+### Fixed
+
+- OData V4:
+  - Reordering of custom views for list report did not work. This was fixed, but consequently the logic for deleting custom views also had to be adapted.
+  - When adding new sub-pages to the app.json the export to manifest created wrong keys for the new navigation routes, and wrong query patterns for the targets.
+
+### Quality
+
+- Upgrade version of `typescript`, `ts-jest`, `jest`
+- Minify sources
+- Enhance test by removing dependency to typescript api
+- Increment of test coverage
+
+## [1.102.7] - 2022-09-21
+
+### Quality
+
+- Changed settings to enable the SAP internal delivery of the types package
+
+## [1.102.6] - 2022-09-08
+
+### Added
+
+- OData V4:
+  - API for custom extensions extended to call enableFPM prior to adding concrete extension using the FPM writer of open-ux-tools
+
+### Changed
+
+- For an easier consumption and size reduction, the types definitions now have been moved to a separate types package in the given mono repository. The definitions are still exposed along with the specification package, you can import them from "@sap/ux-specification/dist/src".
+- Only one common Manifest definition is exposed from the new types package, the virtual distinction between an OData V2 and an OData V4 version is resolved.
+
+### Removed
+
+- OData V4:
+  - Removed `End` value from Placement property for custom extensions
+
+## [1.102.5] - 2022-08-24
+
+### Added
+
+- API enhanced by a wrapper function for the creation of custom views (that delegates to the FPM writer of open-ux-tools)
+- OData V4:
+  - Added custom pages using FPM library to pages view in Application Modeler Panel
+
+### Changed
+
+- The specification module is now build with esbuild instead of webpack.
+The new build generates all type information into a types folder, which makes it easier to consume (but the consumption must be adapted). Examples:
+
+````
+import { PageType } from '@sap/ux-specification/dist/src/specification/common/'; 
+==>  import { PageType } from '@sap/ux-specification/types';
+
+import type { TableCustomColumns, TableCustomColumn } from '@sap/ux-specification/dist/src/v2';
+==> import type { TableCustomColumns, TableCustomColumn } from '@sap/ux-specification/types/v2';
+
+import { SectionPosition as SectionPositionV4 } from '@sap/ux-specification/dist/src/v4';
+==> import { SectionPosition as SectionPositionV4 } from '@sap/ux-specification/types/v4';
+````
+
+- OData V4:
+  - LR: Mark view properties `key`, `index` as hidden in schema
+
+### Fixed
+
+- OData V2:
+  - OP: Fixed incorrect generation of flexChanges in case of Form, Form Fields and Form Fields referenced from a navigation entity
+
+- OData V4:
+  - In some cases sections defined with PresentationVariants did not appear on the object page
+  - The resolution of alias definitions using the @SAP__ prefix was not correct, leading also to gaps in the elements that were considered
+  - LR: Schema now considers default visualation `UI.LineItem` if not defined in `SelectionPresentationVariant`
+
+## [1.102.4] - 2022-08-11
+
+### Added
+
+- OData V2:
+  - LR: Added enum with FieldGroup annotations to `annotationPath` property of tableSettings -> MultiEdit
+- OData V4: the schemas and configs of list report views now also show the visibility property and custom views.
+
+### Changed
+
+- OData V4: With API version 4 of specification - introduced with the given version - the way how routes are represented in the app.json changes: before the pattern was
+  `route: key`, now it follows the manifest syntax  
+
+  ````
+  key: {
+      route: route
+  }
+  ````
+
+  The switch to an object representation allows to also include other target information like "outbound".
+- OData V4: as long as no views are defined in manifest, the showCounts property is not part of the schema, except if it is already maintained.  
+- OData V2:
+  - Mark custom column 'columnIndex' property as hidden
+
+### Fixed
+
+- OData V4:
+  - LR: The export of property changes at the page editor led to a deletion of (custom) views in manifest; besides, outbound navigation entries could get deleted.
+  - Fixed an issue with missing custom action if an empty "press" is defined
+
+## [1.102.3] - 2022-07-28
+
+### Added
+
+- OData V4:
+  - Added support for custom actions for tables in LR and OP
+
+### Fixed
+
+- OData V4:
+  - Fixed an issue with custom column export where it was not possible to restore a deleted column
+
+### Quality
+
+- Upgrade of webpack and dependent modules
+- Upgrade of terser
+- Upgrade of glob-parent, mem-fs-editor
+- Upgrade of lerna
+- Upgrade of fe-fpm-writer
+
+## [1.102.2] - 2022-07-14
+
+### Changed
+
+- OData V4: In case of PresentationVariant definitions for charts or line items an intermediate node had originally been introduced in the Object Page schema that represents the PresentationVariant. This multi-level propagation of references caused issues in the consuming UI, thus the intermediate node got deleted again. The PresentationVariant must be determined by the consuming application if necessary.
+
+### Fixed
+
+- OData V4:
+  - Properties of custom columns on object page had not been exported correctly if the table is associated to another entity type via navigation path or is using a PresentationVariant.
+  The value help of the anchor in LSP (config JSON) also did not show the right values.
+  - Object Page: Fixed an issue with the schema that `annotationPath` for Object Page Table Sections did not contain `qualifier`;
+  wrong `annotationPath` and `isViewNode` settings are adjusted.
+  - Fixed an issue with export that multiple changes to view's `key` property created duplicated entries in manifest.json
+
+### Quality
+
+- Switch from nexus repository to artifactory
+
+## [1.102.1] - 2022-06-29
+
+### Added
+
+- OData V4:
+  - Extend pagemap support for freestyle apps using FPM library
+
+### Fixed
+
+- OData V2:
+  - OVP: LSP for `model` property of a card now lists models from sap.ui5 section of manifest.json
+  - Table type property is now set to blank in case not maintained in manifest.json
+  - If two sections of object page referred to an element (e.g. action, table column) of the same name, they had been sync'd by the program logic: changes of one property had also been refelected in the other.
+  - One UI adaptation or flexibility change may have been shown multiple times in the config, at different sections.
+  - No sorting by time took place before for flexibility changes, as a result an older change of the same property may have shown up instead of the newer one.
+  - If several flexibility changes existed for the same control property, secondary ones had not been imported correctly: you could find them under a wrong property name in the config JSON file.
+
+## [1.102.0] - 2022-06-16
+
+### Added
+
+- Missing exposure of type definitions was added.
+
+### Changed
+
+OData V2:
+
+- Custom column property "columnIndex". Schema enhancement by defining range using "minimum=0".
+
+### Removed
+
+OData V4:
+
+- In case of List Report views, non-applicable table properties are removed.
+
+### Fixed
+
+OData V4:
+
+- In case of List Report views, custom columns with navigation property are considered for the correct view.
+- Avoid creation of empty personalization object
+OData V2:
+- Custom column issue with Grid/Tree/Analytical table types - empty second custom column is added in xml files