@sap/cds-compiler 3.4.2 → 3.5.0

package/CHANGELOG.md

@@ -7,6 +7,86 @@
 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 3.5.0 - 2022-12-07
+
+### Added
+
+- grammar: `localized` is now allowed in select items as well, to force the creation of convenience views.
+- to.edm(x):
+  + Validate annotation values of OASIS/SAP vocabulary term definitions against `@Validation.AllowedValues`.
+  + Reveal dangling type references in produced EDM.
+  + `@Capabilities` 'pull up' introduced with [3.3.0](#version-330---2022-09-29) must now be switched
+    on with option `odataCapabilitiesPullup`.
+- If option `addTextsLanguageAssoc` is set but ignored by the compiler, an info message is emitted.
+  This can happen if, e.g., the `sap.common.Languages` entity is missing.
+- Add OData vocabularies 'Offline' and 'PDF'.
+- Two new aspects in the `sap.common` context get special meaning:
+  `sap.common.TextsAspect` and `sap.common.FioriTextsAspect`.  
+  If these aspects exist, the former will be included in all `.texts`
+  entities without `@fiori.draft.enabled` annotation.  The latter will be
+  included in all `.texts` aspects that are `@fiori.draft.enabled`.  
+  They allow to extend `.texts` entities by simply extending these aspects.  
+  Example:
+  ```
+  entity E {
+    key id : Integer;
+    content: localized String;
+  }
+  extend sap.common.TextsAspect with {
+    elem: String;
+  };
+  // from @sap/cds common.cds
+  aspect sap.common.TextsAspect {
+    key locale: String;
+  }
+  ```
+
+### Changed
+
+- to.edm(x):
+  + Vocabulary references to `Common` and `Core` are added to the generated EDM by default to allow
+    usage of these vocabularies in http messages even if the terms are not being used in the EDM itself.
+  + API representation of enum types as `@Validation.AllowedValues` has been shifted from `for.odata` to
+    `to.edm(x)`. This allows to reuse imported enum types in new APIs.
+  + Messages raised from the EDM annotation renderer have been reworked with message id and enhanced message
+    position including the annotation under investigation.
+  + `@Validation.AllowedValues` annotation as introduced for enum elements with
+    [1.44.2](./doc/CHANGELOG_ARCHIVE.md#version-1442---2020-10-09)
+    are now always rendered into the API regardless of `@assert.range`.
+- to.cdl: The input CSN is no longer cloned for client-CSN and parseCdl-CSN,
+  as the renderer does not modify it.
+- A new warning is emitted if compositions of anonymous aspects are used with the `Association`
+  keyword instead of `Composition`. Replace the former with the latter to fix the warning.
+
+### Removed
+
+- to.edm(x): 'Empty Schema' warning has been removed.
+
+### Fixed
+
+- Enums with a structured base type were accidentally not warned about if used in annotation definitions.
+- for.odata/for.hana: Instead of parenthesising tuple expansion with `()`, put
+  newly created expression in a `xpr` expression, if the term has more than one expansion.
+- Annotation on indirect or inferred enum values were sometimes lost
+- to.cdl:
+  + Certain keywords of special functions no longer add superfluous parentheses.
+  + Extension rendering now supports type extensions as well as `key` for elements.
+  + Builtins that clashed names with implicit contexts were not rendered with `cds.` prefix.
+  + Unknown artifacts (as can happen in parseCdl-style CSN) are now rendered as `USING` statements.
+  + Type extensions in `csn.extensions` (e.g. for `length`) are now rendered.
+- to.edm(x):
+  + Fix a bug in type exposure when using `@cds.external` complex types.
+  + Don't remove empty `Edm.EntityContainer`.
+  + Aspects with actions outside of services are no longer warned about.
+- for.hana: Fix a foreign key replacement bug during association to join translation.
+
+## Version 3.4.4 - 2022-11-25
+
+### Fixed
+
+- compiler: CSN flavor `gensrc` (known as `xtended` in `@sap/cds`) lost annotations
+  on enum values and projection columns.
+
 ## Version 3.4.2 - 2022-11-11
 
 ### Fixed

package/README.md

@@ -24,6 +24,7 @@ Or maintain your package.json dependencies as follows:
   }
 ```
 
+
 ## Documentation
 
 Please refer to the [official CDS documentation](https://cap.cloud.sap/docs/cds/).

package/bin/cds_update_identifiers.js

@@ -50,7 +50,7 @@ process.exit(0); // success
 
 // --------------------------------------------------------
 
-function modernizeIdentifierStyle(source, filename) {
+function modernizeIdentifierStyle( source, filename ) {
   const options = { messages: [], attachTokens: true };
   const messageFunctions = createMessageFunctions( options, 'parse', null );
 
@@ -82,7 +82,7 @@ function modernizeIdentifierStyle(source, filename) {
 
   // -----------------------------------------------
 
-  function updateIdent(identToken) {
+  function updateIdent( identToken ) {
     const newIdentText = toNewIdentStyle(identToken.text);
 
     if (!identToken.stop)
@@ -96,7 +96,7 @@ function modernizeIdentifierStyle(source, filename) {
     currentOffset += (newIdentText.length - identToken.text.length);
   }
 
-  function toNewIdentStyle(oldIdentText) {
+  function toNewIdentStyle( oldIdentText ) {
     let ident = oldIdentText.slice(1, oldIdentText.length - 1);
 
     // There are only two replacement rules we need to check for:
@@ -116,7 +116,7 @@ function modernizeIdentifierStyle(source, filename) {
  * @param {string} replaceWith
  * @return {string}
  */
-function replaceSliceInSource(source, startIndex, endIndex, replaceWith) {
+function replaceSliceInSource( source, startIndex, endIndex, replaceWith ) {
   return source.substring(0, startIndex) +
           replaceWith +
           source.substring(endIndex);
@@ -125,7 +125,7 @@ function replaceSliceInSource(source, startIndex, endIndex, replaceWith) {
 /**
  * @param {string} msg
  */
-function exitError(msg) {
+function exitError( msg ) {
   console.error(msg);
   usage();
   process.exit(1);

package/bin/cdsc.js

@@ -57,7 +57,7 @@ catch (err) {
     throw err;
 }
 
-function remapCmdOptions(options, command) {
+function remapCmdOptions( options, command ) {
   if (!command || !options[command])
     return;
 
@@ -208,7 +208,7 @@ function cdsc_main() {
  * @param {CSN.Options} options
  * @param {object} args
  */
-function validateDirectBackendOption(command, options, args) {
+function validateDirectBackendOption( command, options, args ) {
   if (![ 'toCdl', 'toOdata', 'toHana', 'toCsn', 'toSql' ].includes(command)) {
     displayUsage(`Option '--direct-backend' can't be used with command '${command}'`,
                  optionProcessor.helpText, 2);
@@ -225,7 +225,7 @@ function validateDirectBackendOption(command, options, args) {
 }
 
 // Display help text 'helpText' and 'error' (if any), then exit with exit code <code>
-function displayUsage(error, helpText, code) {
+function displayUsage( error, helpText, code ) {
   // Display non-error output (like help) to stdout
   const out = (code === 0 && !error) ? process.stdout : process.stderr;
   // Display help text first, error at the end (more readable, no scrolling)
@@ -240,7 +240,7 @@ function displayUsage(error, helpText, code) {
 }
 
 // Executes a command line that has been translated to 'command' (what to do), 'options' (how) and 'args' (which files)
-function executeCommandLine(command, options, args) {
+function executeCommandLine( command, options, args ) {
   const normalizeFilename = options.testMode && process.platform === 'win32';
   const messageLevels = {
     Error: 0, Warning: 1, Info: 2, Debug: 3,
@@ -428,7 +428,7 @@ function executeCommandLine(command, options, args) {
       console.log(explainMessage(args.messageId));
   }
 
-  function inspect(model) {
+  function inspect( model ) {
     const inspectModel = require('../lib/inspect');
 
     if (options.statistics) {
@@ -449,7 +449,7 @@ function executeCommandLine(command, options, args) {
   // Display error messages in `err` resulting from a compilation.  Also set
   // process.exitCode - process.exit() will force the process to exit as quickly
   // as possible = is problematic, since console.error() might be asynchronous
-  function displayErrors(err) {
+  function displayErrors( err ) {
     if (err instanceof main.CompilationError) {
       if (options.rawOutput)
         console.error( util.inspect( reveal( err.model, options.rawOutput ), false, null ));
@@ -505,7 +505,7 @@ function executeCommandLine(command, options, args) {
       let hasAtLeastOneExplanation = false;
       messages.filter(msg => messageLevels[msg.severity] <= options.warning).forEach((msg) => {
         hasAtLeastOneExplanation = hasAtLeastOneExplanation || main.hasMessageExplanation(msg.messageId);
-        const name = msg.location && msg.location.file;
+        const name = msg.$location && msg.$location.file;
         const fullFilePath = name ? path.resolve('', name) : undefined;
         log(main.messageStringMultiline(msg, {
           normalizeFilename,
@@ -514,9 +514,8 @@ function executeCommandLine(command, options, args) {
           hintExplanation: true,
           color: options.color,
         }));
-        if (fullFilePath && msg.location.col) {
-          // A message context only makes sense, if we have at least a medium precision,
-          // i.e. line and column for start position.
+        if (fullFilePath && msg.$location.line) {
+          // A message context only makes sense, if we have at least start line
           const context = sourceLines(fullFilePath);
           log(main.messageContext(context, msg, { color: options.color }));
         }
@@ -532,7 +531,7 @@ function executeCommandLine(command, options, args) {
   // or display it to stdout if 'options.out' is '-'.
   // Depending on 'options.rawOutput', the model is either compacted to 'name.json' or
   // written in raw form to '<name>_raw.txt'.
-  function displayNamedXsn(xsn, name) {
+  function displayNamedXsn( xsn, name ) {
     if (options.rawOutput) {
       writeToFileOrDisplay(options.out, `${name}_raw.txt`, util.inspect(reveal(xsn, options.rawOutput), false, null), true);
     }
@@ -553,7 +552,7 @@ function executeCommandLine(command, options, args) {
    * @param {CSN.Model} csn
    * @param {string} name
    */
-  function displayNamedCsn(csn, name) {
+  function displayNamedCsn( csn, name ) {
     if (!csn) // only print CSN if it is set.
       return;
     if (options.internalMsg) {
@@ -571,7 +570,7 @@ function executeCommandLine(command, options, args) {
   // If 'content' is not a string, JSON-stringify it
   // If displaying to stdout, prepend a headline containing 'filename', unless 'omitHeadline' is set.
   // For filenames, illegal characters (slash, backslash, colon) are replaced by '_'.
-  function writeToFileOrDisplay(dir, fileName, content, omitHeadline = false) {
+  function writeToFileOrDisplay( dir, fileName, content, omitHeadline = false ) {
     if (options.internalMsg)
       return;
     fileName = fileName.replace(/[:/\\]/g, '_');
@@ -605,7 +604,7 @@ function executeCommandLine(command, options, args) {
   }
 }
 
-function loadOptionsFromJson(cmdLine) {
+function loadOptionsFromJson( cmdLine ) {
   try {
     let opt = JSON.parse(fs.readFileSync(cmdLine.options.options, 'utf-8'));
     if (opt.cds)
@@ -621,7 +620,7 @@ function loadOptionsFromJson(cmdLine) {
   }
 }
 
-function catchErrors(err) {
+function catchErrors( err ) {
   // @ts-ignore
   if (err instanceof Error && err.hasBeenReported)
     return;
@@ -664,7 +663,7 @@ function parseSeverityOptions({ options }) {
     }
   }
 
-  function parseSeverityOption(list, severity) {
+  function parseSeverityOption( list, severity ) {
     const ids = list.split(',');
     for (let id of ids) {
       id = id.trim();

package/bin/cdshi.js

@@ -37,12 +37,25 @@ function highlight( err, buf ) {
     return;
   const chars = [ ...buf ];
   for (const tok of ts.tokens) {
-    const cat = tok.isIdentifier;
-    if (cat && tok.start >= 0) {
-      if (cat !== 'ref' || chars[tok.start] !== '$')
-        chars[tok.start] = categoryChars[cat] || cat.charAt(0);
-      if (tok.stop > tok.start) // stop in ANTLR at last char, not behind
-        chars[tok.start + 1] = '_';
+    if (tok.start < 0)
+      continue;
+    if (tok.$isSkipped) {
+      if (tok.stop > tok.start) {
+        chars[tok.start] = (tok.$isSkipped === true ? '\x0f' : '\x16');
+        chars[tok.stop] = '\x17';
+      }
+      else {
+        chars[tok.start] = (tok.$isSkipped === true ? '\x0e' : '\x15');
+      }
+    }
+    else {
+      const cat = tok.isIdentifier;
+      if (cat) {
+        if (cat !== 'ref' || chars[tok.start] !== '$')
+          chars[tok.start] = categoryChars[cat] || cat.charAt(0);
+        if (tok.stop > tok.start) // stop in ANTLR at last char, not behind
+          chars[tok.start + 1] = '_';
+      }
     }
   }
   for (const c of chars)

package/doc/CHANGELOG_ARCHIVE.md

@@ -154,7 +154,7 @@ The compiler behaviour concerning `beta` features can change at any time without
 - 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`.
+  which is an association to `sap.common.Languages` using element `locale`.
 - for.odata:
   + In `--odata-format=flat`, structured view parameters are flattened like elements.
 - to.hdbcds
@@ -2870,7 +2870,7 @@ Features
 
 Fixes
 * Issue an error, if an association element that is defined in a mixin of the
-  same view is explicitly redirected. Up to now this modelling error was not
+  same view is explicitly redirected. Up to now this modeling error was not
   recognized and led to the generation of incorrect HANA CDS models.
 * We now also allow query entities and their elements to use as type, relaxing
   a check introduces with v1.0.26.

package/doc/CHANGELOG_BETA.md

@@ -8,7 +8,15 @@ 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 3.4.0 - 2022-MM-DD
+## Version 3.5.0 - 2022-12-07
+
+### Added `odataTerms`
+
+Allows to introduce and use new `Edm.Term`s in an OData API
+based on CDS annotations. Annotations must be service members,
+they can't be autoexposed.
+
+## Version 3.4.0 - 2022-10-26
 
 ### Added `aspectWithoutElements`
 

package/doc/CHANGELOG_DEPRECATED.md

@@ -53,6 +53,8 @@ is `@cds.persistence.exists` copied to localized convenience views.
 
 ### Removed `parensAsStrings`
 
+<!-- fully removed with 3.5.0 -->
+
 ### Removed `projectionAsQuery`
 
 ### Removed `redirectInSubQueries`