@sap/cds-compiler 3.8.2 → 3.9.4

package/lib/json/from-csn.js

@@ -135,7 +135,18 @@ const xorGroups = {
   // quantifiers 'some' and 'any are 'xpr' token strings in CSN v1.0
 };
 
-// Functions reading properties which do no count for the message
+/**
+ * Properties that are required next to `=` to make an annotation value an actual expression
+ * and not some foreign structure.
+ *
+ * @type {string[]}
+ */
+const xprInAnnoProperties = [
+  'ref', 'xpr', 'list', 'literal', 'val',
+  '#', 'func', 'args', 'SELECT', 'SET',
+];
+
+// Functions reading properties which do not count for the message
 // 'Object in $(PROP) must have at least one property'
 const functionsOfIrrelevantProps = [ ignore, extra, explicitName ];
 
@@ -688,6 +699,10 @@ const schema = compileSchema( {
     vZeroFor: 'val',            // CSN v0.1.0 property for `val` in enum def
     // type: annoValue,
     inKind: [ 'element' ],
+    optional: exprProperties.concat([ 'stored' ]),
+  },
+  stored: {
+    type: boolOrNull,
   },
   // ignored: ----------------------------------------------------------------
   $location: {                  // special
@@ -1354,8 +1369,15 @@ function annoValue( val, spec ) {
     return retval;
   }
   else if (typeof val['='] === 'string') {
+    // An object with `=` is an expression if and only if:
+    //  - there is exactly one property ('=')
+    //  - there is at least one other expression property (e.g. "xpr")
+    // TODO: Have xprInAnnoProperties centrally for other backends to use as well (toCdl)
     const valKeys = Object.keys(val);
-    if (valKeys.length > 1 && isBetaEnabled(userOptions, 'annotationExpressions')) {
+    if (valKeys.length > 1 &&
+       (isBetaEnabled(userOptions, 'annotationExpressions') ||
+        isBetaEnabled(userOptions, 'v4preview')) &&
+        xprInAnnoProperties.some(prop => val[prop] !== undefined)) {
       const s = schema['@'].schema['-expr'];
       const r = { location: location() };
       Object.assign(r, object(val, s));
@@ -1367,6 +1389,7 @@ function annoValue( val, spec ) {
       ++virtualLine;
       return r;
     }
+    // fallthrough -> unchecked structure
   }
   if (typeof val['#'] === 'string') {
     if (Object.keys( val ).length === 1) {
@@ -1725,8 +1748,7 @@ function getSpec( parentSpec, csn, prop, xor, expected, kind ) {
            {
              '#': variant,
              prop,
-             parentprop:
-             parentSpec.msgProp,
+             parentprop: parentSpec.msgProp,
              kind,
            } );
   }
@@ -1859,10 +1881,10 @@ function refSplit( name, prop ) {
   return { path: path.map( id => ({ id, location: location() }) ), location: location() };
 }
 
-function replaceZeroValue( spec, msgVariant, otherprop ) {
+function replaceZeroValue( spec, msgVariant, newValue ) {
   if (!csnVersionZero && !spec.vZeroFor) {
     warning( 'syntax-deprecated-value', location(true),
-             { '#': msgVariant, prop: spec.msgProp, otherprop } );
+             { '#': msgVariant, prop: spec.msgProp, value: newValue } );
   }
 }
 

package/lib/json/to-csn.js

@@ -431,14 +431,15 @@ function i18n( i18nNode ) {
   return csn;
 }
 
-function sources( srcDict, csn ) {
-  const names = Object.keys( srcDict );
+function sources( srcDict, csn, model ) {
+  let names = model._sources || Object.keys( srcDict );
   const $sources = names.length && srcDict[names[0]].$sources;
   if ($sources) {
     setHidden( csn, '$sources', $sources );
     return undefined;
   }
-  // TODO: sort according to some layering order, see #6368
+  if (model._sortedSources)
+    names = model._sortedSources.map( s => s.realname );
   setHidden( csn, '$sources', (!strictMode) ? names : names.map( relativeName ) );
   return undefined;
 
@@ -1242,10 +1243,13 @@ function enumValueOrCalc( v, csn, node ) {
   if (v.$inferred && (universalCsn || gensrcFlavor))
     return undefined;
   // Enums can have values but if enums are extended, their kind is 'element'
-  if (node.kind === 'enum' || node.$syntax === 'enum')
+  if (node.kind === 'enum' || node.$syntax === 'enum') {
     Object.assign( csn, expression( v ) );
-  else if (node.$syntax === 'calc') // TODO: || node._parent?.kind === 'extend'
-    return expression( v );
+  }
+  else if (node.$syntax === 'calc') { // TODO: || node._parent?.kind === 'extend'
+    const stored = v.stored ? { stored: value(v.stored) } : {};
+    return Object.assign( stored, expression( v ) );
+  }
   return undefined;
 }
 

package/lib/language/antlrParser.js

@@ -11,6 +11,7 @@
 const antlr4 = require('antlr4');
 
 const { CompileMessage } = require('../base/messages');
+const { isBetaEnabled } = require('../base/model');
 const errorStrategy = require('./errorStrategy');
 
 const Parser = require('../gen/languageParser').default;
@@ -29,6 +30,11 @@ class ErrorListener extends antlr4.error.ErrorListener {
 }
 
 class RewriteTypeTokenStream extends antlr4.CommonTokenStream {
+  constructor(lexer, v4newKeyword) {
+    super(lexer);
+    this.v4newKeyword = v4newKeyword;
+  }
+
   LT( k ) {
     const t = super.LT(k);
     if (!t || !t.type)
@@ -49,9 +55,10 @@ class RewriteTypeTokenStream extends antlr4.CommonTokenStream {
     }
     else if (t.type === this.NEW) {
       const n = super.LT(k + 1);
-      if (n && n.type === this.Identifier && /^st_/i.test( n.text )) {
+      // TODO v4: rewrite token in grammar via `this.setLocalToken`
+      if (n?.type === this.Identifier && (this.v4newKeyword || /^st_/i.test( n.text ))) {
         const o = super.LT(k + 2);
-        if (o && o.type === this.PAREN)
+        if (o?.type === this.PAREN)
           return t;
       }
       t.type = this.Identifier;
@@ -111,7 +118,8 @@ function parse( source, filename = '<undefined>.cds',
                 options = {}, messageFunctions = null,
                 rule = 'cdl' ) {
   const lexer = new Lexer( new antlr4.InputStream(source) );
-  const tokenStream = new RewriteTypeTokenStream(lexer);
+  const v4newKeyword = isBetaEnabled(options, 'v4preview');
+  const tokenStream = new RewriteTypeTokenStream(lexer, v4newKeyword);
   /** @type {object} */
   const parser = new Parser( tokenStream );
   const errorListener = new ErrorListener();

package/lib/language/genericAntlrParser.js

@@ -1095,7 +1095,8 @@ function addExtension( ext, parent, kind, artName, elemPath ) {
 }
 
 function aspectWithoutElements( art ) {
-  // Empty dictionary to allow element extensions.
+  // Empty dictionary to allow element extensions. NO, please NO empty dict.
+  // TODO: Checking it here does not prevent aspect in CSN input having no elements!
   art.elements = this.createDict();
   if (!isBetaEnabled( this.options, 'aspectWithoutElements' )) {
     this.error( null, [ art.name.location ], {},

package/lib/language/language.g4

@@ -607,10 +607,14 @@ elementDefInner[ art, outer, mightBeEnum ]
       ':'
       elementType[ $art, $mightBeEnum ]
     |
-      '=' e=expression       // SQL has syntax variant using AS - we DO NOT
+      eq='=' e=expression       // SQL has syntax variant using AS - we DO NOT
+      stored=STORED?
       { $art.value = $e.expr;
         // this.setIntroLocation( eq );  -- future
-        if ($mightBeEnum && ($e.expr?.val !== undefined || $e.expr?.sym !== undefined) &&
+        if ($stored)
+          $art.value.stored = this.valueWithTokenLocation( true, $stored );
+        if ($mightBeEnum && !$stored &&
+            ($e.expr?.val !== undefined || $e.expr?.sym !== undefined) &&
             !$virtual && !$key && !$masked && !$art.elements && !$art.type)
           $art['$'+'syntax'] = 'enum';
       }
@@ -721,7 +725,12 @@ elementProperties[ elem ]
   :
     defaultAndNullablity[ $elem ]
   |
-    '=' e=expression { $elem.value = $e.expr; }
+    '=' e=expression
+    stored=STORED?
+    { $elem.value = $e.expr;
+      if ($stored)
+        $elem.value.stored = this.valueWithTokenLocation( true, $stored );
+    }
   ;
 
 defaultAndNullablity[ elem ]
@@ -2956,6 +2965,7 @@ ident[ category ] returns[ id ]
   | RIGHT
   | ROW
   | ROWS
+  | STORED
   | SERVICE
   | THEN
   | UNION
@@ -3155,6 +3165,7 @@ RIGHT : [rR][iI][gG][hH][tT] ;
 ROW : [rR][oO][wW] ;
 ROWS : [rR][oO][wW][sS] ;
 SERVICE : [sS][eE][rR][vV][iI][cC][eE] ;
+STORED : [sS][tT][oO][rR][eE][dD] ;
 THEN : [tT][hH][eE][nN] ;
 TO : [tT][oO] ;                 // or make reserved? (is in SQL-92)
 TYPE : [tT][yY][pP][eE] ;

package/lib/model/csnRefs.js

@@ -66,8 +66,11 @@
 // - function `initColumnElement`: issue with column which is neither `*` nor
 //   a `ref` with sibling `inline`, but still has no corresponding element
 
-// The functions in this module also use an internal cache.  The second call of
-// inspectRef() in the following example might lead to a wrong result or an
+// The functions in this module also use an internal cache, which can be dropped
+// for a single definition (main artifact) with function dropDefinitionCache().
+
+// When modifying the CSN, caches might need to be invalidated.  In the following
+// example, the second call of inspectRef() might lead to a wrong result or an
 // exception if the assignment to `inspectRef` is not uncommented:
 //
 //     let { inspectRef } = csnRefs( csn );
@@ -517,7 +520,7 @@ function csnRefs( csn, universalReady ) {
   /**
    * @param {CSN.Path} csnPath
    *
-   * - return value `art`: the “resulting” CSN of the reference
+   * - return value `art`: the “resulting” CSN node of the reference
    *
    * - return value `links`: array of { art, env } in length of ref.path where
    *   art = the definition or element reached by the ref path so far
@@ -992,6 +995,7 @@ function analyseCsnPath( csnPath, csn, resolve ) {
   /** @type {boolean|string|number} */
   let isName = false;
   let baseRef = null;
+  let baseCtx = null;
   let baseEnv = null;
   let {
     index, main, parent, art,
@@ -1049,13 +1053,13 @@ function analyseCsnPath( csnPath, csn, resolve ) {
     }
     else if (prop === 'where' && refCtx === 'ref') {
       if (resolve)
-        baseEnv = resolve.ref_where( obj, baseRef, refCtx, main, query, parent, baseEnv );
+        baseEnv = resolve.ref_where( obj, baseRef, baseCtx, main, query, parent, baseEnv );
       refCtx = 'ref_where';
     }
     else if (prop === 'expand' || prop === 'inline') {
       if (obj.ref) {
         if (resolve)
-          baseEnv = resolve.expandInline( obj, refCtx, main, query, parent, baseEnv );
+          baseEnv = resolve.expandInline( obj, baseCtx, main, query, parent, baseEnv );
         refCtx = prop;
       }
       isName = prop;
@@ -1070,6 +1074,7 @@ function analyseCsnPath( csnPath, csn, resolve ) {
     }
     else if (prop === 'ref') {
       baseRef = obj;            // needs to be inspected for filter conditions
+      baseCtx = refCtx;
       refCtx = prop;
     }
     else if (prop === 'orderBy') {

package/lib/model/csnUtils.js

@@ -47,13 +47,12 @@ function getUtils( model, universalReady ) {
   const special$self = !model?.definitions?.$self && '$self';
   const _csnRefs = csnRefs(model, universalReady);
   const { artifactRef } = _csnRefs;
-  /** Cache for getFinalBaseTypeWithProps(). Specific to the current model. */
+  /** Cache for getFinalTypeInfo(). Specific to the current model. */
   const finalBaseTypeCache = Object.create(null);
 
   return {
     getCsnDef,
     isStructured,
-    getFinalType,
     isManagedAssociation,
     isAssocOrComposition,
     isAssociation,
@@ -63,7 +62,7 @@ function getUtils( model, universalReady ) {
     addStringAnnotationTo,
     getServiceName,
     hasAnnotationValue,
-    getFinalBaseTypeWithProps,
+    getFinalTypeInfo,
     get$combined,
     getQueryPrimarySource,
     ..._csnRefs,
@@ -136,7 +135,7 @@ function getUtils( model, universalReady ) {
         elements = mergeElementsIntoMap(elements, art.elements, art.$location, arg.as || implicitAs(arg.ref), implicitAs(arg.ref) || arg.as);
       }
       else if (arg.SELECT || arg.SET) {
-        elements = mergeElementMaps(elements, getSources(arg));
+        elements = mergeElementMaps(elements, getSources(arg, true));
       }
     }
 
@@ -224,18 +223,7 @@ function getUtils( model, universalReady ) {
    * @returns {boolean}
    */
   function isStructured( obj ) {
-    return !!(obj.elements || (obj.type && getFinalBaseTypeWithProps(obj.type)?.elements));
-  }
-
-  /**
-   * Resolves typedefs to its final type (name) which is returned.
-   * @param {string|object} typeName Absolute type name or type ref ({ref: [...]}).
-   * @returns {string|object}
-   */
-  function getFinalType( typeName ) {
-    if (!typeName)
-      return typeName;
-    return getFinalBaseTypeWithProps(typeName)?.type || null;
+    return !!(obj.elements || (obj.type && getFinalTypeInfo(obj.type)?.elements));
   }
 
   // Return true if 'node' is a managed association element
@@ -247,30 +235,30 @@ function getUtils( model, universalReady ) {
   /**
    * Returns if a type is an association or a composition (possibly via type chain).
    *
-   * @param {string} typeName Absolute type name
+   * @param {object} artifact Element or other artifact.
    */
-  function isAssocOrComposition( typeName ) {
-    const finalType = getFinalType( typeName );
+  function isAssocOrComposition( artifact ) {
+    const finalType = artifact && getFinalTypeInfo( artifact.type )?.type;
     return (finalType === 'cds.Association' || finalType === 'cds.Composition');
   }
 
   /**
    * Returns true if a type is an association (possibly via type chain).
    *
-   * @param {string} typeName Absolute type name
+   * @param {object} artifact Element or other artifact.
    */
-  function isAssociation( typeName ) {
-    const finalType = getFinalType( typeName );
+  function isAssociation( artifact ) {
+    const finalType = artifact && getFinalTypeInfo( artifact.type )?.type;
     return (finalType === 'cds.Association');
   }
 
   /**
    * Returns if a type is a composition (possibly via type chain).
    *
-   * @param {string} typeName Absolute type name
+   * @param {object} artifact Element or other artifact.
    */
-  function isComposition( typeName ) {
-    const finalType = getFinalType( typeName );
+  function isComposition( artifact ) {
+    const finalType = artifact && getFinalTypeInfo( artifact.type )?.type;
     return (finalType === 'cds.Composition');
   }
 
@@ -340,7 +328,7 @@ function getUtils( model, universalReady ) {
    *
    * Notes:
    *   - Caches type lookups.  If the CSN changes drastically, you will need to re-call
-   *    `getUtils()` and use the newly returned `getFinalBaseTypeWithProps()`.
+   *    `getUtils()` and use the newly returned `getFinalTypeInfo()`.
    *   - Does _not_ return the underlying type definition!  It is an object with all relevant
    *     type properties collected while traversing the type chain!
    *
@@ -349,7 +337,7 @@ function getUtils( model, universalReady ) {
    * @param {string|object} type Type as string or type ref, i.e. `{ ref: [...] }`
    * @returns {object|null}
    */
-  function getFinalBaseTypeWithProps( type ) {
+  function getFinalTypeInfo( type ) {
     type = normalizeTypeRef(type);
     if (!type)
       return null;
@@ -392,7 +380,7 @@ function getUtils( model, universalReady ) {
     finalBaseTypeCache[resolvedKey] = true;
 
     // Continue the search
-    const finalBase = getFinalBaseTypeWithProps(type);
+    const finalBase = getFinalTypeInfo(type);
     if (!finalBase) // Reference has no proper type, e.g. due to `type of View:calculated`.
       return _cacheResolved(null);
 
@@ -561,28 +549,6 @@ function forEachMember( construct, callback, path = [], ignoreIgnore = true, ite
   }
 }
 
-/**
- * Call `forEachMember` and then apply `forEachMember` on queries.
- *
- * @param {CSN.Artifact} construct
- * @param {genericCallback|genericCallback[]} callback
- * @param {CSN.Path} [path]
- * @param {boolean} [ignoreIgnore]
- * @param {object} iterateOptions can be used to skip certain kinds from being iterated
- * @param {constructCallback|constructCallback[]} callback
- */
-function forEachMemberWithQuery( construct, callback, path = [], ignoreIgnore = true, iterateOptions = {},
-                                 constructCallback = (_construct, _prop, _path) => {} ) {
-  forEachMember(construct, callback, path, ignoreIgnore, iterateOptions, constructCallback);
-  if (construct.query) {
-    forAllQueries(construct.query, (q, p) => {
-      const s = q.SELECT;
-      if (s)
-        forEachMember(s, callback, p, ignoreIgnore, iterateOptions);
-    }, [ ...path, 'query' ]);
-  }
-}
-
 /**
  * Apply function `callback(member, memberName)` to each member in `construct`,
  * recursively (i.e. also for sub-elements of elements).
@@ -606,30 +572,6 @@ function forEachMemberRecursively( construct, callback, path = [], ignoreIgnore
   }, path, ignoreIgnore, iterateOptions, constructCallback);
 }
 
-/**
- * Apply function `callback(member, memberName)` to each member in `construct`,
- * recursively (i.e. also for sub-elements of elements).
- * Recursively iterate over elements of `construct` query.
- *
- * @param {CSN.Artifact} construct
- * @param {genericCallback|genericCallback[]} callback
- * @param {CSN.Path} [path]
- * @param {boolean} [ignoreIgnore]
- * @param {object} iterateOptions can be used to skip certain kinds from being iterated
- * @param {constructCallback|constructCallback[]} callback
- */
-function forEachMemberRecursivelyWithQuery( construct, callback, path = [], ignoreIgnore = true, iterateOptions = {},
-                                            constructCallback = (_construct, _prop, _path) => {} ) {
-  forEachMemberRecursively(construct, callback, path, ignoreIgnore, iterateOptions, constructCallback);
-  if (construct.query) {
-    forAllQueries(construct.query, (q, p) => {
-      const s = q.SELECT;
-      if (s)
-        forEachMemberRecursively(s, callback, p, ignoreIgnore, iterateOptions);
-    }, [ ...path, 'query' ]);
-  }
-}
-
 /**
  * Apply function `callback` to all objects in dictionary `dict`, including all
  * duplicates (found under the same name).  Function `callback` is called with
@@ -767,6 +709,8 @@ function isEdmPropertyRendered( elementCsn, options ) {
   // FKs are rendered in
   // V2/V4 flat: always on
   // V4 struct: on/off
+  if (elementCsn == null)
+    return false;
   const renderForeignKey = (options.odataVersion === 'v4' && options.odataFormat === 'structured') ? !!options.odataForeignKeys : true;
   const isNotIgnored = !elementCsn.target ? !elementCsn['@cds.api.ignore'] : true;
   const isNavigable = elementCsn.target
@@ -1398,6 +1342,28 @@ function isDeepEqual( obj, other, noExtendedProps ) {
   return true;
 }
 
+/**
+ * convert a cardinality object to string representation
+ * @param {object} node
+ * @param {boolean} withSrc
+ * @returns {string} cardinality as string
+ */
+function cardinality2str( node, withSrc = true ) {
+  const ofto = node.type === 'cds.Composition' ? 'of' : 'to';
+  if (node.cardinality == null || (node.cardinality.src == null || !withSrc) && node.cardinality.min == null && node.cardinality.max === 1)
+    return `${ ofto } one`;
+  if ((node.cardinality.src == null || !withSrc) && node.cardinality.min == null && node.cardinality.max === '*')
+    return `${ ofto } many`;
+  let s = '[';
+  if (node.cardinality.src != null && withSrc)
+    s += `${ node.cardinality.src },`;
+  if (node.cardinality.min != null)
+    s += `${ node.cardinality.min }..`;
+  if (node.cardinality.max != null)
+    s += `${ node.cardinality.max }]`;
+  return s;
+}
+
 /**
  * Returns a function that, if called, calls all functions inside
  * the given `functions` array with the same arguments.
@@ -1422,9 +1388,7 @@ module.exports = {
   forEachGeneric,
   forEachDefinition,
   forEachMember,
-  forEachMemberWithQuery,
   forEachMemberRecursively,
-  forEachMemberRecursivelyWithQuery,
   forAllQueries,
   hasAnnotationValue,
   isEdmPropertyRendered,
@@ -1457,4 +1421,5 @@ module.exports = {
   implicitAs,
   isDeepEqual,
   functionList,
+  cardinality2str,
 };

package/lib/modelCompare/utils/.eslintrc.json

@@ -17,6 +17,6 @@
     "no-shadow": "warn"
   },
   "env": {
-    "es2020": true
+    "es2022": true
   }
 }

package/lib/optionProcessor.js

@@ -108,7 +108,6 @@ optionProcessor
                               enableUniversalCsn
                               postgres
                               aspectWithoutElements
-                              odataOpenType
                               odataTerms
                               optionalActionFunctionParameters
        --deprecated <list>  Comma separated list of deprecated options.
@@ -222,11 +221,12 @@ optionProcessor.command('O, toOdata')
   .option('-j, --json')
   .option('    --odata-containment')
   .option('    --odata-capabilities-pullup')
+  .option('    --odata-openapi-hints')
   .option('    --odata-proxies')
   .option('    --odata-x-service-refs')
   .option('    --odata-foreign-keys')
   .option('    --odata-v2-partial-constr')
-  .option('    --odata-voc-refs <list>')
+  .option('    --odata-vocabularies <list>')
   .option('-c, --csn')
   .option('-f, --odata-format <format>', ['flat', 'structured'])
   .option('-n, --sql-mapping <style>', ['plain', 'quoted', 'hdbcds'], { aliases: [ '--names' ] })
@@ -250,13 +250,14 @@ optionProcessor.command('O, toOdata')
                                   structured : (V4 only) Render structured metadata
        --odata-containment         Generate Containment Navigation Properties for compositions (V4 only)
        --odata-capabilities-pullup Rewrite @Capabilities annotations (V4 containment only).
+       --odata-openapi-hints       Add various annotations to JSON API as input for OpenAPI generation.
        --odata-proxies             Generate Proxies for out-of-service navigation targets (V4 only).
        --odata-x-service-refs      Generate schema references (V4 only).
        --odata-foreign-keys        Render foreign keys in structured format (V4 only)
        --odata-v2-partial-constr   Render referential constraints also for partial principal key tuple
                                    (Not spec compliant and V2 only)
-       --odata-voc-refs <list>     JSON array of adhoc vocabulary definitions
-                                   [ { alias, ns, uri }, ... ]
+       --odata-vocabularies <list> JSON array of adhoc vocabulary definitions
+                                   { prefix: { alias, ns, uri }, ... }
    -n, --sql-mapping <style> Annotate artifacts and elements with "@cds.persistence.name", which is
                              the corresponding database name (see "--sql-mapping" for "toHana or "toSql")
                                plain   : (default) Names in uppercase and flattened with underscores
@@ -297,6 +298,7 @@ optionProcessor.command('Q, toSql')
   .option('    --pre2134ReferentialConstraintNames')
   .option('    --disable-hana-comments')
   .option('    --generated-by-comment')
+  .option('    --better-sqlite-session-variables')
   .help(`
   Usage: cdsc toSql [options] <files...>
 
@@ -348,6 +350,7 @@ optionProcessor.command('Q, toSql')
    --pre2134ReferentialConstraintNames   Do not prefix the constraint identifier with "c__"
    --disable-hana-comments    Disable rendering of doc comments as SAP HANA comments.
    --generated-by-comment     Enable rendering of the initial SQL comment for HDI-based artifacts
+   --better-sqlite-session-variables    Enable better-sqlite compatible rendering of $user. Only active if sqlDialect is \`sqlite\`
 
 `);
 

package/lib/render/.eslintrc.json

@@ -17,6 +17,6 @@
     "no-shadow": "warn"
   },
   "env": {
-    "es2020": true
+    "es2022": true
   }
 }