@sap/cds-compiler 2.4.4 → 2.10.2

package/CHANGELOG.md

@@ -7,12 +7,235 @@
 Note: `beta` fixes, changes and features are usually not listed in this ChangeLog but [here](doc/CHANGELOG_BETA.md).
 The compiler behavior concerning `beta` features can change at any time without notice.
 
+## Version 2.10.2 - 2021-10-29
+
+### Fixed
+
+- to.sql/hdi/hdbcds: Correctly handle `exists` in conjunction with mixin-associations
+
+## Version 2.10.0 - 2021-10-28
+
+### Added
+
+- Support arbitrary paths after `$user` - similar to `$session`.
+- Support scale `floating` and `variable` for `cds.Decimal` in CDL and CSN. Backend specific handling is descibed in their sections.
+- Allow select item wildcard (`*`) in a `select`/`projection` at any position, not just the first.
+
+- to.edm(x):
+  + In Odata V4 generate transitive navigation property binding paths along containment hierarchies and terminate on the
+    first non-containment association. The association target is either an explicit Edm.EntitySet in the same EntityContainer
+    or in a referred EntityContainer (cross service references) or an implicit EntitySet identified by the containment path
+    originating from an explicit EntitySet. This enhancement has an observable effect only in structured format with containment
+    turned on.
+  + Support for scales `variable` and `floating`:
+    + V4: `variable` and `floating` are rendered as `Scale="variable"`. Since V4 does not support `floating`, it is aproximated as `variable`.
+    + V2: `variable` and `floating` are announced via property annotation `sap:variable-scale="true"`
+  
+- to.sql/hdi/hdbcds:
+  + Reject scale `floating` and `variable`.
+  + Reject arbitrary `$user` or `$session` paths that cannot be translated to valid SQL.
+  + Following a valid `exists`, further `exists` can be used inside of the filter-expression: `exists assoc[exists another[1=1]]`
+  + `exists` can now be followed by more than one association step.
+  `exists assoc.anotherassoc.moreassoc` is semantically equivalent to `exists assoc[exists anotherassoc[exists moreassoc]]`
+
+### Removed
+
+### Changed
+
+- to.odata: Inform when overwriting draft action annotations like @Common.DraftRoot.ActivationAction.
+
+### Fixed
+
+## Version 2.9.0 - 2021-10-15
+
+### Changed
+
+- to.edm(x): Raise `odata-spec-violation-type` to a downgradable error.
+
+### Fixed
+
+- to.edm(x):
+  + Fix a bug in annotation propagation to foreign keys.
+  + Don't render annotations for not rendered stream element in V2.
+- to.hdi:
+  + for naming mode "hdbcds" and "quoted" parameter definitions are not quoted anymore.
+- to.hdi/sql/hdbcds:
+  + Correctly handle explicit and implicit alias during flattening.
+  + Raise an error for `@odata.draft.enabled` artifacts with elements without types - instead of crashing with internal assertions.
+
+## Version 2.8.0 - 2021-10-07
+
+### Added
+
+- Allow defining unmanaged associations in anonymous aspects of compositions.
+- Enable extensions of anonymous aspects for managed compositions of aspects.
+- When the option `addTextsLanguageAssoc` is set to true and
+  the model contains an entity `sap.common.Languages` with an element `code`,
+  all generated texts entities additionally contain an element `language`
+  which is an association to `sap.common.Languages` using element `local`.
+- for.odata:
+  + In `--odata-format=flat`, structured view parameters are flattened like elements.
+- to.hdbcds
+  + Use "smart quotes" for naming mode "plain" - automatically quote identifier which are reserved keywords or non-regular.
+
+### Changed
+
+- for.odata:
+  + In `--data-format=structured`, anonymous sub elements of primary keys and parameters are set to `notNull:true`,
+    an existing `notNull` attribute is _not_ overwritten. Referred named types are _not_ modified.
+- to.edm(x):
+  + Improve specification violation checks of (nested) keys:
+    + All (sub-)elements must be `Nullable: false` (error).
+    + Must represent a single value (error).
+    + In V4 must be a specification compliant Edm.PrimitiveType (warning).
+- to.hdi/hdbcds/sql: $user.\<xy\> now has \<xy\> added as alias - "$user.\<xy\> as \<xy\>"
+
+### Fixed
+
+- Properly generate auto-exposed entities for associations in parameters.
+- Correctly apply extensions to anonymous array item types.
+- Correctly apply/render annotations to anonymous action return types.
+- With CSN flavor `plain` (`gensrc`), correctly render annotations on elements
+  of referred structure types as `annotate` statements in the CSN's `extensions` property.
+- to.cdl:
+  + Correctly render extensions on array item types
+  + Correctly render annotations on action return types
+- to/for: Correctly handle CSN input where the prototype of objects is not the "default"
+- to.hdi:
+  + for naming mode "hdbcds" and "quoted" parameter definitions are now quoted.
+  + for naming mode "plain", smart quotation is applied to parameter definitions if they are reserved words.
+- to.hdi/hdbcds/sql:
+  + Ensure that cdl-style casts to localized types do not lose their localized property
+  + Fix a small memory leak during rendering of SQL/HDBCDS.
+- to.edm(x): Remove ambiguous `Partner` attribute from `NavigationProperty`. A forward association referred
+  to by multiple backlinks (`$self` comparisons) is no longer partner to an arbitrary backlink.
+
+## Version 2.7.0 - 2021-09-22
+
+### Added
+
+- to.hdi.migration:
+  + Support changes to HANA comments.
+
+### Changed
+
+- Updated OData vocabularies 'Common', 'Core'
+
+### Fixed
+
+- Fix memory issue: do not keep reference to last-compiled model.
+- Fix dump which occured when trying to report that the user has defined an element to be both `key` and `localized` if
+  `localized` was inherited via the provided type, or in the generated entity for a managed composition of aspect.
+- Properly auto-expose targets of associations in parameters and `many`.
+- for.Odata:
+  + Fix handling of annotation `@cds.odata.valuelist` in conjunction with associations in structures using flat-mode and sqlMapping set to plain.
+  + Set correctly the $localized property in the OData backend resulting CSN for artifacts that have localized convenience views.
+- to.edm(x):
+  + Fix rendering of structured referential constraints and nested partnerships in combination with `$self` comparisons.
+  + Fix merging of `@Capabilities` annotations while transforming them into `NavigationCapabilities` from the containee into the container.
+- to.sql/hdi/hdbcds:
+  + Fix a bug in Association to Join translation in multi-level association redirection in combination with `$self`.
+  + Correctly flatten paths with filters or parameters.
+  + Improve error message in case of invalid `exists`.
+
+## Version 2.6.2 - 2021-08-26
+
+### Fixed
+
+- to.sql/hdi/hdbcds/edm(x)/for.odata: Correctly handle tuple expansion in subqueries of Unions.
+
+## Version 2.6.0 - 2021-08-23
+
+### Added
+
+- Support managed associations without foreign keys. Associations targeting a definition without primary keys or with an
+  explicit empty foreign key tuple or with empty structured elements as foreign keys and their corresponding `$self`
+  comparisons do not describe the relationship between the source and the target entity.
+  These associations can be used to establish API navigations but cannot be used to access elements in the target
+  entity as they cannot be transformed into a valid JOIN expression.
+  Consequently, these associations are not added to the `WITH ASSOCIATIONS` clause or forwarded to HANA CDS.
+- to.sql/hdi/hdbcds/edm(x)/for.odata: Structure/managed association comparisons (tuple comparisons) are now
+  also expanded in infix filters, all expressions and all on-conditions.
+- to.hdbcds: Better locations for messages - mostly concerning keywords and duplicates
+
+### Changed
+
+- to.sql/hdi/hdbcds: Invalid (i.e. not expandable) usage of structures is now checked - an error is raised
+
+### Removed
+
+- The internal non-enumerable CSN property `$env` has been removed from the compiled CSN.
+
+### Fixed
+
+- Make `;` optional before `}` in all circumstances (was not the case with `many`).
+- to.sql/hdi/hdbcds/edm(x): More graceful handling of CSN input where associations do not have `keys` or an `on`-condition
+
+## Version 2.5.2 - 2021-08-10
+
+### Fixed
+
+- to.hdbcds: Fixed a bug introduced with 2.5.0 that caused virtual elements to be rendered in views.
+
+## Version 2.5.0 - 2021-07-28
+
+### Added
+
+- Allow to extend existing array annotation values via the ellipsis operator `...`.
+  An ellipsis may appear exactly once at an arbitrary position in the top level array
+  of an `annotate` directive. Only array values can be merged into arrays and unapplied
+  ellipses are removed from the final array value. Annotation layering rules remain unaffected.
+- to.sql/hdi/hdbcds:
+  + Doc comments are translated into HANA comments (or into `@Comment` annotation for `to.hdbcds`).
+  Such comments are possible on entities, views, elements of entities and `to.hdbcds` also supports comments on view columns.
+  Generation can be disabled via option `disableHanaComments`. Entites/views (and their elements/columns)
+  annotated with `@cds.persistence.journal` for `to.hdi`/`to.sql` will not have comments rendered.
+  + Generation of temporal `WHERE` clause can be suppressed by annotating the `validFrom`/`validTo` elements of the projection with `false` or `null`.
+- to.sql/hdi/hdbcds/edm(x)/for.odata: Structure/managed association comparisons (tuple comparisons) are now
+  also expanded in `WHERE` and `HAVING` - this was previously only supported in on-conditions.
+- `cdsc` now internally uses SNAPI.
+- to.hdi.migration:
+  + Validate that the two supplied CSNs are compatible.
+  + Improve delta-mechanism to not render superflous [ALTER|DROP|ADD] statements for unchanged SQL.
+
+### Changed
+
+- If the first source provided to the compile command has a `$sources` property
+  (whether enumerable or not) which is an array of strings,
+  use that instead of calculating one.
+- Updated OData vocabularies 'Aggregation', 'Analytics', 'Authorization', 'Capabilities',
+  'CodeList', 'Common', 'Communication', 'Core', 'Graph', 'HTML5', 'Measures', 'ODM', 'PersonalData',
+  'Repeatability', 'Session', 'UI', 'Validation'
+
+### Removed
+
+- Removed internal property `$viaTransform` from CSN produced by OData/HANA transformation
+
+### Fixed
+
+- Remove warnings 'Ignoring annotation “@odata.draft.enabled” as the artifact is not part of a service'
+  and 'Ignoring draft node for composition target ... because it is not part of a service'
+- Doc comments are no longer ignored after enum values and on view columns in parseCdl mode.
+- to.cdl:
+  + Doc comments for enum values are correctly rendered.
+  + Enum value and doc comments are now correctly rendered if the enum is called `doc`.
+  + Doc comments at type references are correctly rendered.
+  + Empty doc comments are correctly rendered and not left out.
+  + Doc comments on view columns are correctly rendered.
+- to.edm(x):
+  + OData V2: Ignore `@odata.singleton`.
+  + OData V4: Do not render an `edm:NavigationPropertyBinding` to a singleton if the association has
+    cardinality 'to-many'.
+- forOData:
+  + Fix automatic renaming of shortcut annotation (eg. `@label`) with value `null`.
+- CSN parser:
+  + Empty doc comments are correctly parsed and not complained about.
+
 ## Version 2.4.4 - 2021-07-02
 
 ### Fixed
 
 - Do not remove parentheses around single literals and references on the right-hand side of an `in` and `not in` operator.
-  of an `in` and `not in` operator.
 
 ## Version 2.4.2 - 2021-07-01
 
@@ -113,6 +336,11 @@ The compiler behavior concerning `beta` features can change at any time without
     caused regressions in mocking scenarios. With option `--odata-v2-partial-constr` partial constraint generation
     can be reactivated. A 'odata-spec-violation-constraints' warning is raised.
 
+### 2.5.0 Addendum to Changed
+
+- Replace outdated option `length` with `defaultStringLength` which is usable in `for.*` and `to.*` APIs.
+
+
 ## Version 2.2.4 - 2021-05-06
 
 No changes compared to Version 2.2.2; fixes latest NPM tag
@@ -419,6 +647,18 @@ synchronously.
 - to.hdi.migration: Don't generate `ALTER` for type change from association to composition or vice versa (if the rest stays the same),
   as the resulting SQL is  identical.
 
+## Version 1.50.10 - 2021-07-30
+
+### Fixed
+
+- to.hdi.migration: Check for incompatible CSN versions to avoid wrongly generated ALTER|DROP|ADD statements.
+
+## Version 1.50.8 - 2021-07-01
+
+### Fixed
+
+- to.hdi.migration: Don't generate `ALTER` for type change from association to composition or vice versa (if the rest stays the same), as the resulting SQL is identical.
+
 ## Version 1.50.6 - 2021-05-05
 
 ### Fixed

package/bin/.eslintrc.json

@@ -0,0 +1,17 @@
+{
+  "extends": ["../.eslintrc-ydkjsi.json"],
+  "rules": {
+    "prefer-const": "error",
+    "quotes": ["error", "single", "avoid-escape"],
+    "prefer-template": "error",
+    "no-trailing-spaces": "error",
+    "template-curly-spacing": ["error", "never"],
+    "max-len": "off",
+    "no-console": "off",
+    "no-process-exit": "off",
+    "camelcase": "off",
+    "radix": "off",
+    // should probably be on
+    "no-shadow": "off"
+  }
+}

package/bin/cds_update_identifiers.js

@@ -20,6 +20,7 @@
 //
 // Note that you need to update the path to this script in the commands above.
 //
+
 'use strict';
 
 const parseLanguage = require('../lib/language/antlrParser');
@@ -30,7 +31,7 @@ const path = require('path');
 const cliArgs = process.argv.slice(2);
 const filename = cliArgs[0];
 
-if (cliArgs.length != 1)
+if (cliArgs.length !== 1)
   exitError(`Expected exactly one argument, ${cliArgs.length} given`);
 
 if (!filename)
@@ -58,7 +59,7 @@ function modernizeIdentifierStyle(source, filename) {
   // To avoid spam, only report errors.
   // Users should use the compiler to get all messages.
   const errors = options.messages
-        .filter(msg => (msg.severity === 'Error' && msg.messageId !== 'syntax-deprecated-ident'));
+    .filter(msg => (msg.severity === 'Error' && msg.messageId !== 'syntax-deprecated-ident'));
   if (errors.length > 0) {
     errors.forEach((msg) => {
       console.error(msg.toString());
@@ -69,7 +70,7 @@ function modernizeIdentifierStyle(source, filename) {
 
   let currentOffset = 0;
 
-  const tokens = ast.tokenStream.tokens;
+  const { tokens } = ast.tokenStream;
   for (const token of tokens) {
     if (token.type === ast.tokenStream.Identifier && token.text.startsWith('"'))
       updateIdent(token);
@@ -83,10 +84,10 @@ function modernizeIdentifierStyle(source, filename) {
     const newIdentText = toNewIdentStyle(identToken.text);
 
     if (!identToken.stop)
-      throw new Error(`INTERNAL ERROR: Identifier at ${ identToken.start } has no end!`);
+      throw new Error(`INTERNAL ERROR: Identifier at ${identToken.start} has no end!`);
 
     const start = identToken.start + currentOffset;
-    const end =  identToken.stop + currentOffset + 1; // end points at the position *before* the character
+    const end = identToken.stop + currentOffset + 1; // end points at the position *before* the character
 
     source = replaceSliceInSource(source, start, end, newIdentText);
 
@@ -100,7 +101,7 @@ function modernizeIdentifierStyle(source, filename) {
     ident = ident.replace(/""/g, '"');
     ident = ident.replace(/]/g, ']]');
 
-    return `![${ ident }]`;
+    return `![${ident}]`;
   }
 }
 
@@ -129,6 +130,6 @@ function exitError(msg) {
 }
 
 function usage() {
-  console.error('')
+  console.error('');
   console.error(`usage: ${path.basename(process.argv[1])} <filename>`);
 }