@sap/cds-compiler 4.7.6 → 4.9.0

package/lib/json/csnVersion.js

@@ -8,8 +8,10 @@
 // (Note: the SQL name mapping mode is not reflected in the content of the csn, the version only
 // signals which default name mapping a backend has to use)
 // Historic versions:
-//  0.0.1  : Used by HANA CDS for its CSN output (incomplete, not well defined, quite different from CDX ...)
-//  0.0.2  : CDX in the initial versions with old-style CSN, default for SQL name mapping is 'quoted'
+//  0.0.1  : Used by SAP HANA CDS for its CSN output
+//           (incomplete, not well defined, quite different from CDX ...)
+//  0.0.2  : CDX in the initial versions with old-style CSN, default for SQL
+//           name mapping is 'quoted'
 //  0.0.99 : Like 0.0.2, but with new-style CSN
 // Versions that are currently produced by compiler:
 //  0.1.0  : Like 0.0.2, default for SQL name mapping is 'plain'
@@ -21,15 +23,16 @@
 const newCSNVersions = [ '0.1.99', '0.2', '0.2.0', '1.0', '2.0' ];
 
 // Check if new-style CSN is requested, i.e. versions >= 0.1.99
-function isNewCSN(csn, options) {
+function isNewCSN( csn, options ) {
   return !( options?.newCsn === false ||
         (csn.version && !newCSNVersions.includes(csn.version.csn)) ||
         (csn.$version && !newCSNVersions.includes(csn.$version)));
 }
 
-function checkCSNVersion(csn, options) {
+function checkCSNVersion( csn, options ) {
   if (!isNewCSN(csn, options)) {
     // the new transformer works only with new CSN
+    // eslint-disable-next-line global-require
     const { makeMessageFunction } = require('../base/messages');
     const { error, throwWithAnyError } = makeMessageFunction(csn, options);
 

package/lib/json/from-csn.js

@@ -119,10 +119,11 @@
  */
 
 const { dictAdd } = require('../base/dictionaries');
-// TODO: move parts of lib/compiler/builtins to some lib/base/…:
-const { isAnnotationExpression, quotedLiteralPatterns } = require('../compiler/builtins');
+const { quotedLiteralPatterns } = require('../compiler/builtins');
+const { isAnnotationExpression } = require('../base/builtins');
 const { CompilerAssertion } = require('../base/error');
-const { XsnSource, CsnLocation } = require('../compiler/classes');
+const { Location } = require('../base/location');
+const { XsnSource } = require('../compiler/xsn-model');
 
 const $location = Symbol.for('cds.$location');
 
@@ -648,7 +649,8 @@ const schema = compileSchema( {
     noPrefix: false,            // just '@' is no CSN property
     prop: '@‹anno›',            // which property name do messages use for annotation assignments?
     type: annotation,
-    inKind: () => true,         // allowed in all definitions (including columns and extensions)
+    // allowed in all definitions except mixins (including columns and extensions)
+    inKind: _kind => true, // TODO(v5): (kind !== 'mixin')
     schema: {
       '-expr': { // '-expr' and '-' must not exist top-level
         prop: '@‹anno›',
@@ -744,7 +746,7 @@ const schema = compileSchema( {
     ignore: true, type: ignore, // TODO: do we need to do something?
   },
   namespace: {
-    type: stringRef,
+    type: namespace,
   },
   meta: {                       // meta information
     type: ignore,               // TODO: should we test s/th here?
@@ -1042,6 +1044,11 @@ function definition( def, spec, xsn, csn, name ) {
   }
 }
 
+function namespace( ref, spec ) {
+  const ns = stringRef(ref, spec);
+  return ns ? { kind: 'namespace', name: ns } : null;
+}
+
 function couldNotBeEnumProperty( prop ) {
   // returns true for `value` (which we allow with warning when extending an enum with `elements`)
   const inKind = schema[prop]?.inKind; // undefined for annotations, $location, …
@@ -1485,9 +1492,12 @@ function annoValue( val, spec ) {
 function annotation( val, spec, xsn, csn, name ) {
   // not used for the value
   const id = (xsn ? name.substring(1) : name);
-  if (!id) {              // `"@": …` is already syntax-unknown-property
+  if (!id)              // `"@": …` is already syntax-unknown-property
     message( 'syntax-invalid-name', location(true), { '#': '{}' } );
-  }
+
+  if (xsn && xsn.kind === 'mixin') // TODO(v5): Remove, adapt spec['@'].inKind
+    message('anno-unexpected-mixin', location(true));
+
   const n = { id, location: location() };
   const r = annoValue( val, spec );
   r.name = n;
@@ -1997,7 +2007,7 @@ function replaceZeroValue( spec, msgVariant, newValue ) {
 function location( enforceJsonPos ) {
   return !enforceJsonPos && dollarLocations.length &&
     dollarLocations[dollarLocations.length - 1] || {
-    __proto__: CsnLocation.prototype,
+    __proto__: Location.prototype,
     file: csnFilename,
     line: virtualLine,
     col: 0,
@@ -2010,7 +2020,7 @@ function pushLocation( obj ) {
   if (loc === undefined)
     return;
   if (loc && typeof loc === 'object' && !Array.isArray( loc )) {
-    dollarLocations.push( loc.line ? { __proto__: CsnLocation.prototype, ...loc } : null );
+    dollarLocations.push( loc.line ? { __proto__: Location.prototype, ...loc } : null );
     return;
   }
   else if (!loc || typeof loc !== 'string') {
@@ -2028,7 +2038,7 @@ function pushLocation( obj ) {
     const column = m[2] && Number( m[2] ) || 0;
     const file = loc.substring( 0, m.index );
     dollarLocations.push({
-      __proto__: CsnLocation.prototype, file, line, col: column,
+      __proto__: Location.prototype, file, line, col: column,
     } );
   }
 }
@@ -2123,7 +2133,7 @@ function parse( source, filename = 'csn.json', options = {}, messageFunctions =
       }
       column = end - eol + 1;
     }
-    const loc = new CsnLocation(
+    const loc = new Location(
       filename,
       line,
       column

package/lib/json/to-csn.js

@@ -236,8 +236,8 @@ function compactModel( model, options = model.options || {} ) {
   // (not a really useful property at all, avoids XSN inspection by Umbrella)
   for (const first in srcDict) {
     const { namespace } = srcDict[first];
-    if (namespace && namespace.path)
-      csn.namespace = pathName( namespace.path );
+    if (namespace?.name?.path)
+      csn.namespace = pathName( namespace.name.path );
     break;
   }
   set( 'definitions', csn, model );
@@ -1008,8 +1008,9 @@ function artifactRef( node, terse ) {
     return undefined;
   // Works also on XSN directly coming from parser and with XSN from CDL->CSN transformation
   // Shortcut for many cases:
-  if (terse && node._artifact && !node._artifact._main && terse !== '.path')
-    return node._artifact.name.id;
+  const art = node._artifact;
+  if (art && (!art._main || art.kind === '$self') && terse && terse !== '.path')
+    return art.name.id;
   let { path } = node;
   if (!path)
     return undefined;           // TODO: complain with strict
@@ -1408,6 +1409,9 @@ function addElementAsColumn( elem, cols ) {
       setHidden( col, '$parens', parens.length );
     addLocation( (parens ? parens[parens.length - 1] : elem.value.location), col );
   }
+  else if (elem.name && !elem.name.$inferred) {
+    addLocation( elem.name.location, col );
+  }
   cols.push( extra( col, elem ) );
 }
 

package/lib/language/antlrParser.js

@@ -12,7 +12,7 @@ const antlr4 = require('antlr4');
 
 const { CompileMessage } = require('../base/messages');
 const errorStrategy = require('./errorStrategy');
-const { XsnSource } = require('../compiler/classes');
+const { XsnSource } = require('../compiler/xsn-model');
 
 const Parser = require('../gen/languageParser').default;
 const Lexer = require('../gen/languageLexer').default;

package/lib/language/genericAntlrParser.js

@@ -14,14 +14,13 @@ const locUtils = require('../base/location');
 const { parseDocComment } = require('./docCommentParser');
 const { parseMultiLineStringLiteral } = require('./multiLineStringParser');
 const {
-  functionsWithoutParens,
   specialFunctions,
   quotedLiteralPatterns,
 } = require('../compiler/builtins');
+const { functionsWithoutParens } = require('../base/builtins');
+const { Location } = require('../base/location');
 const { pathName } = require('../compiler/utils');
-const {
-  XsnArtifact, XsnName, CsnLocation, XsnSource,
-} = require('../compiler/classes');
+const { XsnArtifact, XsnName, XsnSource } = require('../compiler/xsn-model');
 const { isBetaEnabled } = require('../base/model');
 const { weakLocation } = require('../base/location');
 const { normalizeNewLine, normalizeNumberString } = require('./textUtils');
@@ -500,10 +499,10 @@ function handleDuplicateExtension( ext, name, numDefines ) {
  * Return start location of `token`, or the first token matched by the current
  * rule if `token` is undefined
  *
- * @returns {CsnLocation}
+ * @returns {Location}
  */
 function startLocation( token = this._ctx.start ) {
-  return new CsnLocation(
+  return new Location(
     this.filename,
     token.line,
     token.column + 1
@@ -516,7 +515,7 @@ function startLocation( token = this._ctx.start ) {
  *
  * @param {object} token
  * @param {object} endToken
- * @return {CsnLocation}
+ * @return {Location}
  */
 function tokenLocation( token, endToken = null ) {
   if (!token)
@@ -528,7 +527,7 @@ function tokenLocation( token, endToken = null ) {
   const endLine = endToken.line;
   // after the last char (special for EOF?)
   const endCol = endToken.stop - endToken.start + endToken.column + 2;
-  const loc = new CsnLocation( this.filename, token.line, token.column + 1, endLine, endCol );
+  const loc = new Location( this.filename, token.line, token.column + 1, endLine, endCol );
 
   // This check is done for performance reason. No need to access a token's
   // data if we know that it spans only one single line.
@@ -629,7 +628,7 @@ function secureParens( expr ) {
   return {
     op: { val: 'xpr', location: this.startLocation() },
     args: [ expr ],
-    location: { __proto__: CsnLocation.prototype, ...expr.location },
+    location: { __proto__: Location.prototype, ...expr.location },
     $parens,
   };
 }
@@ -725,11 +724,11 @@ function fragileAlias( ast, safe = false ) {
     return ast;
   if (safe || ast.$delimited || !/^[a-zA-Z][a-zA-Z_]+$/.test( ast.id )) {
     this.warning( 'syntax-deprecated-auto-as', ast.location, { keyword: 'as' },
-                  'Please add the keyword $(KEYWORD) in front of the alias name' );
+                  'Add keyword $(KEYWORD) in front of the alias name' );
   }
   else {                         // configurable error
     this.message( 'syntax-missing-as', ast.location, { keyword: 'as' },
-                  'Please add the keyword $(KEYWORD) in front of the alias name' );
+                  'Add keyword $(KEYWORD) in front of the alias name' );
   }
   return ast;
 }
@@ -760,10 +759,16 @@ function identAst( token, category, noTokenTypeCheck = false ) {
 
     // $delimited is used to complain about ![$self] and other magic vars usage;
     // we might complain about that already here via @arg{category}
-    return { id, $delimited: true, location: this.tokenLocation( token ) };
+
+    const ast = { id, $delimited: true, location: this.tokenLocation( token ) };
+    ast.location.tokenIndex = token.tokenIndex;
+    return ast;
+  }
+  if (token.text[0] !== '"') {
+    const ast = { id, location: this.tokenLocation(token) };
+    ast.location.tokenIndex = token.tokenIndex;
+    return ast;
   }
-  if (token.text[0] !== '"')
-    return { id, location: this.tokenLocation( token ) };
   // delimited:
   id = id.slice( 1, -1 ).replace( /""/g, '"' );
   if (!id) {
@@ -774,7 +779,9 @@ function identAst( token, category, noTokenTypeCheck = false ) {
                   // eslint-disable-next-line max-len
                   'Deprecated delimited identifier syntax, use $(DELIMITED) - strings are delimited by single quotes' );
   }
-  return { id, $delimited: true, location: this.tokenLocation( token ) };
+  const ast = { id, $delimited: true, location: this.tokenLocation( token ) };
+  ast.location.tokenIndex = token.tokenIndex;
+  return ast;
 }
 
 function pushXprToken( args ) {
@@ -1346,7 +1353,7 @@ function argsExpression( args, nary ) {
     return args[0];
   const $parens = args[0]?.$parens;
   const loc = ($parens) ? $parens[$parens.length - 1] : args[0]?.location;
-  const location = loc ? { __proto__: CsnLocation.prototype, ...loc } : this.startLocation();
+  const location = loc ? { __proto__: Location.prototype, ...loc } : this.startLocation();
   // console.log('AE:',args);
   const op = {
     // eslint-disable-next-line no-nested-ternary

package/lib/language/multiLineStringParser.js

@@ -6,7 +6,7 @@ const {
   cdlNewLineRegEx,
 } = require('./textUtils');
 const { CompilerAssertion } = require('../base/error');
-const { CsnLocation } = require('../compiler/classes');
+const { Location } = require('../base/location');
 
 /**
  * Strips and counts the indentation from the given string.
@@ -463,7 +463,7 @@ class MultiLineStringParser {
    */
   _locationForCharacters(i, width) {
     return {
-      __proto__: CsnLocation.prototype,
+      __proto__: Location.prototype,
       file: this.parser.filename,
       line: this.token.line + this._lineInString,
       endLine: this.token.line + this._lineInString,

package/lib/language/textUtils.js

@@ -45,7 +45,7 @@ function isWhitespaceCharacterNoNewline( char ) {
  * @return {string}
  */
 function normalizeNewLine( str ) {
-  // Note: cdlNewLineRegEx does not have `g` flag and we can't use replaceAll in Node 14.
+  // Note: cdlNewLineRegEx does not have `g`.
   return str.replace(new RegExp(cdlNewLineRegEx, 'ug'), '\n');
 }
 

package/lib/main.d.ts

@@ -150,6 +150,22 @@ declare namespace compiler {
      * @since v2.12.1
      */
     $xsnObjects?: boolean
+    /**
+     * Internal option for LSP only!
+     * If set, each AST gets a `tokenStream` property containing all lexed tokens.
+     *
+     * @private
+     */
+    attachTokens?: boolean
+    /**
+     * Internal option for LSP only!
+     * If set, enables some extra checks/work for the CDS LSP.
+     * May be implicitly set by `$lsp.<api>` functions.
+     *
+     * @private
+     * @since v4.9
+     */
+    lspMode?: boolean
   }
 
   /**
@@ -246,18 +262,48 @@ declare namespace compiler {
      * @see service
      */
     serviceNames?: string[]
+    /**
+     * If set, certain OData errors that are not relevant for OpenAPI generation
+     * are downgraded to warnings when generating EDM JSON.
+     *
+     * @default true
+     * @since v4.8.0
+     * @private
+     */
+    edm4OpenAPI?: boolean
   }
 
   /**
    * Options used by the `for.effective()` CSN transformation.
    *
-   * WORK IN PROGRESS
-   *
    * @internal
    * @see _for.effective()
    */
   export interface EffectiveCsnOptions extends SqlOptions {
-    // TODO
+    /**
+     * If true, resolve simple type references to their simple base type.
+     *
+     * @default true
+     */
+    resolveSimpleTypes?: boolean
+    /**
+     * If true, transform projections into ordinary views with SELECT.
+     *
+     * @default true
+     */
+    resolveProjections?: boolean
+    /**
+     * If true, remap OData annotations to ABAP annotations.
+     *
+     * @default false
+     */
+    remapOdataAnnotations?: boolean
+    /**
+     * If true, keep '.localized' property in the CSN.
+     *
+     * @default false
+     */
+    keepLocalized?: boolean
   }
 
   /**
@@ -538,11 +584,6 @@ declare namespace compiler {
        * @internal
        */
       model?: CSN;
-      /**
-       * Used by `cdsc` to indicate whether the message was already printed to stderr.
-       * @private
-       */
-      hasBeenReported: boolean;
   }
 
   /**
@@ -657,16 +698,23 @@ declare namespace compiler {
    * @param config.noMessageId
    *     If true, will _not_ show the message ID (+ explanation hint) in the output.
    *
+   * @param config.idInBrackets
+   *     If true, the message ID (if there is one and noMessageId is falsey) will be put in brackets.
+   *     This will be the default in cds-compiler v5.
+   *
    * @param config.noHome
    *     If true, will _not_ show message's semantic location.
    *
-   * @param config.module
+   * @param config.moduleForMarker
    *     If set, downgradable error messages will get a '‹↓›' marker, depending on whether
-   *     the message can be downgraded for the given module.
+   *     the message can be downgraded for the given module.  A `‹↑›` is used if the message
+   *     will be an error in the next major cds-compiler release.
+   *     Was called `module` in v4.8.0 and earlier.
    */
   export function messageString(msg: CompileMessage, config?: {
     normalizeFilename?: boolean
     noMessageId?: boolean
+    idInBrackets?: boolean
     noHome?: boolean
     module?: string
   }): string;
@@ -704,9 +752,11 @@ declare namespace compiler {
    * @param config.hintExplanation
    *     If true, messages with explanations will get a "…" marker, see {@link hasMessageExplanation}.
    *
-   * @param config.module
+   * @param config.moduleForMarker
    *     If set, downgradable error messages will get a '‹↓›' marker, depending on whether
-   *     the message can be downgraded for the given module.
+   *     the message can be downgraded for the given module.  A `‹↑›` is used if the message
+   *     will be an error in the next major cds-compiler release.
+   *     Was called `module` in v4.8.0 and earlier.
    *
    * @param config.sourceMap
    *     A dictionary of filename<->source-code entries.  You can pass the fileCache that is used
@@ -733,7 +783,7 @@ declare namespace compiler {
     normalizeFilename?: boolean
     noMessageId?: boolean
     hintExplanation?: boolean
-    module?: string
+    moduleForMarker?: string
     sourceMap?: Record<string, string>
     sourceLineMap?: Record<string, number[]>
     cwd?: string
@@ -848,6 +898,12 @@ declare namespace compiler {
      * @internal
      */
     function effective(csn: CSN, options?: EffectiveCsnOptions): CSN;
+    /**
+     * Transform the given CSN into one that has the properties required for SEAL
+     *
+     * @internal
+     */
+    function seal(csn: CSN, options?: EffectiveCsnOptions): CSN;
   }
 
   export { _for as for };
@@ -951,6 +1007,20 @@ declare namespace compiler {
          */
         const keywords: string[];
       }
+      namespace h2 {
+        /**
+         * Immutable list of reserved keywords for H2. The list is used by {@link to.sql}.
+         * Taken from <http://www.h2database.com/html/advanced.html#keywords>.
+         */
+        const keywords: string[];
+      }
+      namespace postgres {
+        /**
+         * Immutable list of reserved keywords for PostgreSQL. The list is used by {@link to.sql}.
+         * Taken from <https://www.postgresql.org/docs/current/sql-keywords-appendix.html>.
+         */
+        const keywords: string[];
+      }
 
       /**
        * If the given `name` requires quoting for SQL dialect `dialect`,
@@ -1246,7 +1316,13 @@ declare namespace compiler {
    * The functions in `userFunctions` are usually transformer functions, which
    * change the input CSN destructively.
    */
-  export function traverseCsn(userFunctions: Record<string, Function>, csn: object|any[]): void;
+  export function traverseCsn(userFunctions: Record<string, TraverseCsnCallback>, csn: object|any[]): void;
+  export type TraverseCsnCallback = (
+    userFunctions: Record<string, TraverseCsnCallback>,
+    value: any,
+    csn: any,
+    prop: string
+  ) => any;
 
   /**
    * CSN Model related functions.

package/lib/main.js

@@ -26,7 +26,7 @@ const parseLanguage = lazyload('./language/antlrParser');
 const compiler = lazyload('./compiler');
 const shared = lazyload('./compiler/shared');
 const define = lazyload('./compiler/define');
-const builtins = lazyload('./compiler/builtins');
+const builtins = lazyload('./base/builtins');
 const base = lazyload('./compiler/base');
 const finalizeParseCdl = lazyload('./compiler/finalize-parse-cdl');
 
@@ -126,7 +126,9 @@ module.exports = {
   // SNAPI
   for: {
     odata: (...args) => snapi.odata(...args),
+    java: (...args) => snapi.java(...args),
     effective: (...args) => snapi.for_effective(...args),
+    seal: (...args) => snapi.for_seal(...args),
   },
   to: {
     cdl: Object.assign((...args) => snapi.cdl(...args), {
@@ -141,6 +143,12 @@ module.exports = {
       sqlite: {
         keywords: Object.freeze([ ...keywords.sqlite ] )
       },
+      postgres: {
+        keywords: Object.freeze([ ...keywords.postgres ] )
+      },
+      h2: {
+        keywords: Object.freeze([ ...keywords.h2 ] )
+      },
       smartId: (...args) => sqlIdentifier.smartId(...args),
       smartFunctionId: (...args) => sqlIdentifier.smartFuncId(...args),
       delimitedId: (...args) => sqlIdentifier.delimitedId(...args),

package/lib/model/cloneCsn.js

@@ -3,7 +3,7 @@
 const { csnPropertyOrder } = require('../json/to-csn');
 const { ModelError } = require('../base/error');
 const { setHidden } = require('../utils/objectUtils');
-const { isAnnotationExpression } = require('../compiler/builtins');
+const { isAnnotationExpression } = require('../base/builtins');
 
 const csnDictionaries = [
   'args',
@@ -21,16 +21,22 @@ function shallowCopy( val, _options, _sort ) {
 }
 
 const internalCsnProps = {
+  __proto__: null,
   $sources: shallowCopy,
   $location: shallowCopy,
   $path: shallowCopy,
   $paths: shallowCopy,
   elements: cloneCsnDict,
   $tableConstraints: shallowCopy,
+  $default: shallowCopy, // used for HANA CSN migrations
+  $notNull: shallowCopy, // used for HANA CSN migrations
+};
+const internalEnumerableCsnProps = {
+  __proto__: null,
+  $tableConstraints: shallowCopy, // enumerable for HANA CSN for migrations
 };
 const internalCsnPropertyNames = Object.keys(internalCsnProps);
 
-
 /**
  * Deeply clone the given CSN model and return it.
  * In testMode (or with testSortCsn), definitions are sorted.
@@ -41,9 +47,12 @@ const internalCsnPropertyNames = Object.keys(internalCsnProps);
  * @see cloneAnnotationValue()
  * @see cloneCsnDict()
  *
- * @param {object} csn Top-level CSN.  You can pass non-dictionary values.
- * @param {CSN.Options} options CSN Options, only used for `dictionaryPrototype`, `testMode`, and `testSortCsn`.
- * @param {boolean} sort Whether to sort CSN properties.
+ * @param {object} csn
+ *   Top-level CSN.  You can pass non-dictionary values.
+ * @param {CSN.Options} options
+ *   CSN Options, only used for `dictionaryPrototype`, `testMode`, and `testSortCsn`.
+ * @param {boolean} sort
+ *   Whether to sort CSN properties.
  */
 function cloneCsn( csn, options, sort ) {
   if (!csn || typeof csn !== 'object')
@@ -58,18 +67,21 @@ function cloneCsn( csn, options, sort ) {
   const r = {};
   for (const n of keys) {
     const val = csn[n];
-    if (!val || typeof val !== 'object') {
-      r[n] = val;
-    }
-    else if (n.charAt(0) === '@') {
+    if (n.charAt(0) === '@') {
       r[n] = cloneAnnotationValue(val, options, false); // TODO: pass 'sort'
     }
+    else if (!val || typeof val !== 'object') {
+      r[n] = val;
+    }
     else if (csnDictionaries.includes(n) && !Array.isArray(val)) {
       const sortDict = n === 'definitions' &&
         (!options || options.testMode || options.testSortCsn);
       // Array check for property `args` which may either be a dictionary or an array.
       r[n] = cloneCsnDict(val, options, sort, sortDict);
     }
+    else if (n in internalEnumerableCsnProps) {
+      r[n] = internalEnumerableCsnProps[n](val, options, sort);
+    }
     else {
       r[n] = cloneCsn(val, options, sort);
     }