@sap/cds-compiler 2.15.8 → 3.1.0

package/doc/CHANGELOG_BETA.md

@@ -8,12 +8,33 @@ Note: `beta` fixes, changes and features are listed in this ChangeLog just for i
 The compiler behavior concerning `beta` features can change at any time without notice.
 **Don't use `beta` fixes, changes and features in productive mode.**
 
-## Version 2.XX.YY
+## Version 3.1.0 - 2022-08-04
 
-### Removed `assocsWithParams`
+### Added `optionalActionFunctionParameters`
 
-Instead, of using the beta flag `assocsWithParams`, you can change the severity of the messages
-`def-unexpected-paramview-assoc` and `def-unexpected-calcview-assoc`.
+- to.edm(x): Annotate optional function/action parameters with `@Core.OptionalParameter` for OData V4.
+  An action/function parameter is optional if
+  1) it is already annotated with `@Core.OptionalParameter` regardless of its definition.
+  2) it has a default value (including null), regardless of it's nullability
+  3) it has NO default value but is nullable (the implicit default value is null)
+
+  If a mandatory parameter (not null and no default value) appears after an optional
+  parameter, a warning is raised, Core.OptionalParameter requires that all optional
+  parameters appear rightmost.
+
+### Added `odataOpenType`
+
+- to.edm(x): Support annotation `@open` on entity and structured type level to declare the corresponding entity/complex type to
+  be `OpenType=true`. If an open structured type is declared closed (with a falsy annotation value), the corresponding EDM type
+  is closed as well and suffixed with `_closed` (or `_open` vice versa).
+  No further checks are performed on possibly open foreign or primary key types nor on eventually bucket elements to store the
+  additional data.
+
+## Version 3.0.0 - 2022-06-23
+
+### Removed `addTextsLanguageAssoc`
+
+Instead, use the option `addTextsLanguageAssoc`, which is available since v2.8.0.
 
 ## Version 2.12.0 - 2022-01-25
 
@@ -135,7 +156,7 @@ When the beta option `subElemRedirections` is set to true,
 _all_ array (new!) and structure types are expanded when referenced:
 managed associations (and compositions to entities) in that array are
 implicitly redirected when necessary.
-See [below for details](#version-1300---20200612).
+See [below for details](#version-1300---2020-06-12).
 
 Nested array types (without intermediate structure types) are not supported.
 

package/doc/CHANGELOG_DEPRECATED.md

@@ -11,7 +11,61 @@ Note: `deprecated` features are listed in this ChangeLog just for information.
 **When the `deprecated` option is set, the `beta` option is ignored,
 and several new features are not available.**
 
-## Version 2.XX.YY - 2022-MM-DD
+## Version 3.1.0 - 2022-08-04
+
+### Added `autoCorrectOrderBySourceRefs`
+
+When this option is set, calling `compile` auto-corrects direct `order by`
+source element references without table alias for SELECT queries by adding the
+table alias to the `ref`.
+
+Using this option might lead to surprising results when elements are added to
+existing models: `order by` specifications might change their semantics without
+any extra messages.
+
+## Version 3.0.0 - 2022-06-23
+
+Version 3 of the cds-compiler removes all v2 deprecated flags.
+
+### Add `eagerPersistenceForGeneratedEntities`
+
+If enabled, the old behavior regarding `@cds.persistence.skip` and `@cds.persistence.exists`
+is restored, i.e. these annotations are not copied from parent to generated child entities, nor
+is `@cds.persistence.exists` copied to localized convenience views.
+
+### Removed `createLocalizedViews`
+
+### Removed `downgradableErrors`
+
+### Removed `generatedEntityNameWithUnderscore`
+
+### Removed `longAutoexposed`
+
+### Removed `noElementsExpansion`
+
+<!-- fully removed with 3.1.0 -->
+
+### Removed `noInheritedAutoexposeViaComposition`
+
+### Removed `noScopedRedirections`
+
+### Removed `oldVirtualNotNullPropagation`
+
+### Removed `parensAsStrings`
+
+### Removed `projectionAsQuery`
+
+### Removed `redirectInSubQueries`
+
+### Removed `renderVirtualElements`
+
+### Removed `shortAutoexposed`
+
+### Removed `unmanagedUpInComponent`
+
+### Removed `v1KeysForTemporal`
+
+## Version 2.13.0 - 2022-03-22
 
 ### Added `redirectInSubQueries`
 

package/doc/{DeprecatedOptions.md → DeprecatedOptions_v2.md}

@@ -1,8 +1,10 @@
 # Deprecated Options and How to Avoid Them
 
+__Important__: With compiler v3, these deprecated options were removed!
+
 To ease the migration to CDS Compiler Version 2,
 the compiler can be called with an option `deprecated`
-which make the compiler behave more like Compiler Version 1 for certain features.
+which makes the compiler behave more like Compiler Version 1 for certain features.
 
 As the name suggest, this option should be used only for a limited time.
 The support for certain v1 features might also be dropped after a while

package/doc/Versioning.md

@@ -5,6 +5,17 @@ The cds-compiler uses [Semantic Versioning][SemVer] for its version numbers.
 This document clarifies how we use [SemVer] and what you can and what you can‘t
 expect from version updates.
 
+<!-- toc: start -->
+
+1. [Public API](#public-api)
+2. [Patch Versions](#patch-versions)
+3. [Minor Versions](#minor-versions)
+4. [Beta Flags](#beta-flags)
+5. [Deprecated Flags](#deprecated-flags)
+6. [Command Line Tool `cdsc`](#command-line-tool-cdsc)
+
+<!-- toc: end -->
+
 ## Public API
 
 According to [§1] of SemVer, a public API must be made available.  Our public
@@ -41,7 +52,7 @@ we detect invalid CDS code.
 
 ## Beta Flags
 
-The compiler provides so called “beta flags” that enable or disable certain
+The compiler provides so-called “beta flags” that enable or disable certain
 features.  We do not guarantee that any such flags stay consistent between
 patch versions!  Beta flags may change any time.
 
@@ -57,6 +68,14 @@ period.
 Refer to [CHANGELOG_DEPRECATED.md](./CHANGELOG_DEPRECATED.md) for changes
 to deprecated flags.
 
+## Command Line Tool `cdsc`
+
+`bin/cdsc.js` as well as all other command line tools do _not_ guarantee any
+stability.  It is considered a compiler internal tool that only serves for
+debugging.  The official command line tool `cds` of the `@sap/cds` and
+`@sap/cds-dk` packages are to be used by users.  That means commands and
+options may change any time without prior notice.  Changes may still be listed
+in [CHANGELOG.md](../CHANGELOG.md).
 
 [SemVer]: https://semver.org/
 [§1]: https://semver.org/#spec-item-1

package/lib/api/.eslintrc.json

@@ -1,13 +1,13 @@
 {
   "root": true,
   "env": {
-    "es6": true,
+    "es2020": true,
     "node": true
   },
   // we actually do not extend airbnb-base, as it weakens some eslint:recommended rules
   "extends": ["../../.eslintrc-ydkjsi.json", "plugin:jsdoc/recommended"],
   "parserOptions": {
-    "ecmaVersion": 2018,
+    "ecmaVersion": 2020,
     "sourceType": "script"
   },
   "plugins":  [