@sap/cds-compiler 3.4.4 → 3.5.2

package/lib/inspect/inspectModelStatistics.js

@@ -10,7 +10,7 @@ const { term } = require('../utils/term');
  * @param {CSN.Options} options
  * @returns {string}
  */
-function inspectModelStatistics(xsn, options) {
+function inspectModelStatistics( xsn, options ) {
   let result = '';
 
   // Default color mode is 'auto'
@@ -45,7 +45,7 @@ ${ color.underline('vocabularies') }: ${ Object.keys(xsn.vocabularies || {}).len
   return result;
 }
 
-function countDefinitionKinds(xsn) {
+function countDefinitionKinds( xsn ) {
   const result = {
     definitions: 0,
     entity: 0,

package/lib/inspect/inspectPropagation.js

@@ -11,7 +11,7 @@ const { term } = require('../utils/term');
  * @param {string} artifactName
  * @returns {string|null}
  */
-function inspectPropagation(xsn, options, artifactName) {
+function inspectPropagation( xsn, options, artifactName ) {
   const { error } = createMessageFunctions(options, 'inspect', xsn);
   const result = [];
 
@@ -56,7 +56,7 @@ function inspectPropagation(xsn, options, artifactName) {
  @param {string} indent
  * @returns {string[]}
  */
-function _indent(lines, indent = '    ') {
+function _indent( lines, indent = '    ' ) {
   return lines.map(str => `${ indent }${ str }`);
 }
 
@@ -65,7 +65,7 @@ function _indent(lines, indent = '    ') {
  * @returns {string[]}
  * @private
  */
-function _inspectAnnotations(artifactXsn) {
+function _inspectAnnotations( artifactXsn ) {
   const result = [];
   const annos = Object.keys(artifactXsn).filter(str => str.startsWith('@')).sort();
 
@@ -114,7 +114,7 @@ function _inspectAnnotations(artifactXsn) {
  * @returns {string[]}
  * @private
 */
-function _inspectElements(artifactXsn) {
+function _inspectElements( artifactXsn ) {
   if (!artifactXsn.elements)
     return [ 'does not have elements' ];
 
@@ -173,7 +173,7 @@ function _inspectElements(artifactXsn) {
   return result;
 }
 
-function _origin(elementXsn) {
+function _origin( elementXsn ) {
   while (elementXsn._origin)
     elementXsn = elementXsn._origin;
   return elementXsn;
@@ -186,7 +186,7 @@ function _origin(elementXsn) {
  * @param parent
  * @returns {boolean}
  */
-function isContainedInParentLocation(art, parent) {
+function isContainedInParentLocation( art, parent ) {
   const artLoc = art.location;
   const parentLoc = parent.location;
   if (artLoc.file !== parentLoc.file)

package/lib/inspect/inspectUtils.js

@@ -5,7 +5,7 @@
  * @param str
  * @returns {*[]|*}
  */
-function stringRefToPath(str) {
+function stringRefToPath( str ) {
   // e.g. `ns.service.E:sub.elem.structured`
   const path = str.split(':');
   if (path.length === 1)
@@ -20,7 +20,7 @@ function stringRefToPath(str) {
  * @param {string} path
  * @private
  */
-function findArtifact(xsn, path) {
+function findArtifact( xsn, path ) {
   const segments = [ ...path ];
   const topLevelName = segments[0];
   let art = (xsn.definitions && xsn.definitions[topLevelName]) ||

package/lib/json/from-csn.js

@@ -73,6 +73,8 @@
  * @property {string}         [vZeroIgnore] Marks the property as a CSN 0.1.0 property. The
  *                                          property is ignored and a warning may be issues about
  *                                          it.
+ * @property {string}        [xorException] A property name that is allowed besides another property
+ *                                          of an xorGroup (as an exception to the rule).
  */
 
 /**
@@ -585,7 +587,7 @@ const schema = compileSchema( {
     inKind: () => true,         // allowed in all definitions (including columns and extensions)
   },
   abstract: {                   // v1: with 'abstract', an entity becomes an aspect
-    type: ( val, spec ) => boolOrNull( val, spec ) && undefined,
+    type: abstract,
     inKind: [ 'entity', 'aspect' ], // 'aspect' because 'entity' is replaced by 'aspect' early
   },
   key: {
@@ -633,7 +635,7 @@ const schema = compileSchema( {
     inKind: [ 'entity' ],
   },
   $syntax: {
-    type: string,
+    type: dollarSyntax,
     ignore: true,
     inKind: [ 'entity', 'type', 'aspect' ],
   },
@@ -719,7 +721,7 @@ let arrayLevelCount = 0;
  * @param {object} [proto]
  * @returns {Object.<string, SchemaSpec>}
  */
-function compileSchema( specs, proto = null) {
+function compileSchema( specs, proto = null ) {
   // no prototype to protect against evil-CSN properties 'toString' etc.
   const r = Object.assign( Object.create( proto ), specs );
   for (const p of Object.keys( specs )) {
@@ -978,7 +980,8 @@ function keys( array, spec, xsn ) {
     return;
   const r = Object.create(null);
   r[$location] = location();
-  ++virtualLine;
+  if (array.length)
+    ++virtualLine; // possibly empty array
   for (const def of array) {
     const id = def.as || implicitName( def.ref );
     const name = (typeof id === 'string') ? id : '';
@@ -1033,6 +1036,39 @@ function explicitName( id, spec, xsn ) {
     xsn.name = { id, location: location() };
 }
 
+function abstract( val, spec, xsn, csn ) {
+  const strange = csn.kind !== 'entity';
+  if (strange || !csnVersionZero) {
+    warning( 'syntax-deprecated-abstract', location(true),
+             { '#': strange ? 'strange-kind' : 'std', prop: 'abstract', kind: 'entity' } );
+  }
+  boolOrNull( val, spec );
+}
+
+function dollarSyntax( val, spec, xsn, csn ) {
+  if (csn.kind === 'type' && val === 'aspect') {
+    warning( 'syntax-deprecated-dollar-syntax', location(true),
+             { '#': 'aspect', prop: '$syntax', kind: 'aspect' } );
+    return ignore( val );
+  }
+  else if (xsn.kind === 'entity') {
+    if (val === 'projection') {
+      warning( 'syntax-deprecated-dollar-syntax', location(true),
+               {
+                 '#': 'projection',
+                 prop: '$syntax',
+                 siblingprop: 'projection',
+                 otherprop: 'query',
+               } );
+      return string( val, spec );
+    }
+    if (val === 'entity' || val === 'view')
+      return string( val, spec );
+  }
+  warning( 'syntax-deprecated-dollar-syntax', location(true), { prop: '$syntax' } );
+  return ignore( val );
+}
+
 function validKind( val, spec, xsn ) {
   if (val === xsn.kind)         // has been set in definition - the same = ok!
     return undefined;           // already set in definition
@@ -1040,17 +1076,7 @@ function validKind( val, spec, xsn ) {
     warning( 'syntax-deprecated-value', location(true),
              { '#': 'replace', prop: spec.msgProp, value: 'entity' } );
   }
-  // TODO: rather issue info at `abstract` and `$syntax`, i.e. current location is strange
-  // change message id in a later change
-  else if ((val === 'entity' || val === 'type') && xsn.kind === 'aspect') {
-    info( 'syntax-aspect', location(true), { kind: 'aspect', '#': val },
-          {
-            std: 'Use the dedicated kind $(KIND) for aspect definitions',
-            // eslint-disable-next-line max-len
-            entity: 'Abstract entity definitions are deprecated; use aspect definitions (having kind $(KIND)) instead',
-          } );
-  }
-  else {
+  else if (val !== 'entity' && val !== 'type' || xsn.kind !== 'aspect') {
     error( 'syntax-invalid-kind', location(true), { prop: spec.msgProp },
            'Invalid value for property $(PROP)' );
   }
@@ -1145,14 +1171,14 @@ function scalenum( val, spec ) {
 }
 
 function natnum( val, spec ) {
-  if (typeof val === 'number' && val >= 0)
+  if (typeof val === 'number' && val >= 0 && Number.isSafeInteger( val ))
     //  XSN TODO: do not require literal
     return { val, literal: 'number', location: location() };
   const loc = location(true);
   if (spec.msgId)
     error( spec.msgId, loc, { prop: spec.msgProp } );
   else
-    error( 'syntax-expecting-natnum', loc, { prop: spec.msgProp } );
+    error( 'syntax-expecting-unsigned-int', loc, { '#': 'csn', prop: spec.msgProp } );
   return ignore( val );
 }
 
@@ -1322,14 +1348,16 @@ function xpr( exprs, spec, xsn, csn ) {
     xsn.suffix = exprArgs( exprs, spec );
   }
   else {
+    // setting $parens here would not always be correct; thus, keep distinction
+    // between 'xpr' and 'ixpr' (”internal” `xpr` = without implicit parens)
     xsn.op = { val: 'xpr', location: location() };
-    xsn.args = exprArgs( exprs, spec, xsn );
+    xsn.args = exprArgs( exprs, spec );
   }
 }
 
 function list( exprs, spec, xsn ) {
-  xsn.op = { val: ',', location: location() };
-  xsn.args = arrayOf( exprOrString )( exprs, spec, xsn );
+  xsn.op = { val: 'list', location: location() };
+  xsn.args = arrayOf( exprOrString )( exprs, spec );
 }
 
 function xprInValue( exprs, spec, xsn, csn ) {
@@ -1369,20 +1397,30 @@ function args( exprs, spec ) {
 }
 
 function expr( e, spec ) {
-  if (Array.isArray( e ) && e.length === 1) { // CSN v.0.1.0 way for parentheses
-    const loc = location();
-    if (e[0] && !e[0].op)       // do not complain with 'op' (for which we complain)
-      replaceZeroValue( spec, 'zero-parens' );
-    ++virtualLine;
-    const r = expr( e[0], spec );
-    if (!r)
+  if (Array.isArray( e )) {
+    if (e.length > 1) {         // struct-xpr
+      const loc = location();
+      return {
+        op: { val: 'ixpr', location: loc },
+        args: exprArgs( e, spec ),
+        location: loc,
+      };
+    }
+    else if (e.length === 1) { // CSN v.0.1.0 way for parentheses
+      const loc = location();
+      if (e[0] && !e[0].op)       // do not complain with 'op' (for which we complain)
+        replaceZeroValue( spec, 'zero-parens' );
+      ++virtualLine;
+      const r = expr( e[0], spec );
+      if (!r)
+        return r;
+      if (r.$parens)
+        r.$parens.push( loc );
+      else
+        r.$parens = [ loc ];
+      ++virtualLine;
       return r;
-    if (r.$parens)
-      r.$parens.push( loc );
-    else
-      r.$parens = [ loc ];
-    ++virtualLine;
-    return r;
+    }
   }
   else if (e === null || [ 'string', 'number', 'boolean' ].includes( typeof e )) {
     //  && spec.optional.includes( 'val' )) ?
@@ -1392,16 +1430,19 @@ function expr( e, spec ) {
   return object( e, spec );
 }
 
-function exprOrString( e, spec ) {
-  return (typeof e === 'string' && !csnVersionZero) ? e : expr( e, spec );
+function exprOrString( val, spec ) {
+  return (typeof val === 'string' && !csnVersionZero)
+    ? { val, literal: 'token', location: location() }
+    : expr( val, spec );
 }
 
 // mark path argument of 'exits' predicate with $expected:'exists'
-function exprArgs( cond, spec, xsn, csn ) {
-  const rxsn = arrayOf( exprOrString )( cond, spec, xsn, csn );
-  if (Array.isArray( rxsn ) && rxsn.some( x => x === 'exists' )) {
+function exprArgs( cond, spec ) {
+  const rxsn = arrayOf( exprOrString )( cond, spec );
+  // TODO: do that in definer.js, neither here nor in CDL parser
+  if (Array.isArray( rxsn )) {
     for (let i = 0; i < rxsn.length - 1; i++) {
-      if (rxsn[i] === 'exists' && rxsn[i + 1].path)
+      if (rxsn[i]?.val === 'exists' && rxsn[i].literal === 'token' && rxsn[i + 1].path)
         rxsn[++i].$expected = 'exists';
     }
   }
@@ -1448,7 +1489,8 @@ function excluding( array, spec, xsn ) {
     return;
   const r = Object.create(null);
   r[$location] = location();
-  ++virtualLine;
+  if (array.length)
+    ++virtualLine; // possibly empty array
   for (const ex of array) {
     const id = string( ex, spec ) || '';
     dictAdd( r, id, { name: { id, location: location() }, location: location() },