@sap/cds-compiler 5.1.2 → 5.3.0

package/lib/edm/edm.js

@@ -31,6 +31,7 @@ function getEdm( options, messageFunctions ) {
       this._edmAttributes = Object.assign(Object.create(null), attributes);
       this._xmlOnlyAttributes = Object.create(null);
       this._jsonOnlyAttributes = Object.create(null);
+      this._openApiHints = Object.create(null);
 
       this._children = [];
       this._ignoreChildren = false;
@@ -38,6 +39,8 @@ function getEdm( options, messageFunctions ) {
 
       if (this.v2)
         this.setSapVocabularyAsAttributes(csn);
+
+      this.setOpenApiHints(csn);
     }
 
     get v2() {
@@ -103,6 +106,17 @@ function getEdm( options, messageFunctions ) {
       return this;
     }
 
+    setOpenApiHints(csn) {
+      if (csn && options.odataOpenapiHints) {
+        const jsonAttr = Object.create(null);
+        Object.entries(csn).filter(([ k, _v ] ) => k.startsWith('@OpenAPI.')).forEach(([ k, v ]) => {
+          jsonAttr[k] = v;
+        });
+        Object.assign(this._openApiHints, jsonAttr);
+      }
+      return this._openApiHints;
+    }
+
     // virtual
     toJSON() {
       const json = Object.create(null);
@@ -110,17 +124,24 @@ function getEdm( options, messageFunctions ) {
       if (!(this.kind in Node.noJsonKinds))
         json.$Kind = this.kind;
 
-      this.toJSONattributes(json);
-      this.toJSONchildren(json);
-      return json;
+      return this.toJSONchildren(this.toJSONattributes(json));
     }
 
     // virtual
-    toJSONattributes(json) {
+    toJSONattributes(json, withHints = true) {
       forEach(this._edmAttributes, (p, v) => {
         if (p !== 'Name')
           json[p[0] === '@' ? p : `$${p}`] = v;
       });
+      return (withHints ? this.toOpenApiHints(json) : json);
+    }
+
+    toOpenApiHints(json) {
+      if (options.odataOpenapiHints && this._openApiHints) {
+        Object.entries(this._openApiHints).forEach(([ p, v ]) => {
+          json[p[0] === '@' ? p : `$${p}`] = v;
+        });
+      }
       return json;
     }
 
@@ -131,6 +152,7 @@ function getEdm( options, messageFunctions ) {
       this._children.filter(c => c._edmAttributes.Name).forEach((c) => {
         json[c._edmAttributes.Name] = c.toJSON();
       });
+      return json;
     }
 
     // virtual
@@ -243,6 +265,10 @@ function getEdm( options, messageFunctions ) {
       super.setSapVocabularyAsAttributes(csn, true);
     }
 
+    toJSONattributes(json) {
+      return super.toJSONattributes(json, false);
+    }
+
     register(entry) {
       if (!this._registry[entry._edmAttributes.Name])
         this._registry[entry._edmAttributes.Name] = [ entry ];
@@ -258,6 +284,7 @@ function getEdm( options, messageFunctions ) {
       if (alias !== undefined)
         props.Alias = alias;
       super(version, props);
+      this.setOpenApiHints(serviceCsn);
       this._annotations = annotations;
       this._actions = Object.create(null);
       this.setXml( { xmlns: (this.v2) ? 'http://schemas.microsoft.com/ado/2008/09/edm' : 'http://docs.oasis-open.org/odata/ns/edm' } );
@@ -321,11 +348,17 @@ function getEdm( options, messageFunctions ) {
             json[p[0] === '@' ? p : `$${p}`] = v;
         });
       }
+      return this.toOpenApiHints(json);
     }
 
     toJSONchildren(json) {
       // 'edmx:DataServices' should not appear in JSON
-      super.toJSONchildren(json);
+      // Annotations first
+      this._children.filter(c => c._edmAttributes.Term).forEach((c) => {
+        json = { ...json, ...c.toJSON() };
+      });
+
+      json = super.toJSONchildren(json);
       if (this._annotations.length > 0) {
         this._annotations.filter(a => a._edmAttributes.Term).forEach((a) => {
           Object.entries(a.toJSON()).forEach(([ n, v ]) => {
@@ -445,8 +478,7 @@ function getEdm( options, messageFunctions ) {
         json.$Reference = referenceJson;
 
       this._service.toJSONattributes(json);
-      this._service.toJSONchildren(json);
-      return json;
+      return this._service.toJSONchildren(json);
     }
 
     // all(default), metadata, annotations
@@ -546,8 +578,8 @@ function getEdm( options, messageFunctions ) {
   */
 
   class ActionFunctionBase extends Node {
-    constructor(version, details) {
-      super(version, details);
+    constructor(version, details, csn) {
+      super(version, details, csn);
       this._returnType = undefined;
     }
 
@@ -698,7 +730,7 @@ function getEdm( options, messageFunctions ) {
       if (this.$isCollection)
         json.$Collection = this.$isCollection;
 
-      return json;
+      return this.toOpenApiHints(json);
     }
   }
 
@@ -749,11 +781,11 @@ function getEdm( options, messageFunctions ) {
       else
         this._keys = undefined;
 
-      if (options.odataOpenapiHints) {
+      if (this._openApiHints) {
         if (csn['@cds.autoexpose'])
-          this.setJSON({ '@cds.autoexpose': true });
+          this._openApiHints['@cds.autoexpose'] = true;
         if (csn['@cds.autoexposed'])
-          this.setJSON({ '@cds.autoexposed': true });
+          this._openApiHints['@cds.autoexposed'] = true;
       }
     }
 
@@ -802,7 +834,7 @@ function getEdm( options, messageFunctions ) {
   class Member extends Node {
     toJSONattributes(json) {
       json[this._edmAttributes.Name] = this._edmAttributes.Value;
-      return json;
+      return super.toOpenApiHints(json);
     }
   }
 
@@ -819,11 +851,6 @@ function getEdm( options, messageFunctions ) {
       }
     }
 
-    toJSONattributes(json) {
-      super.toJSONattributes(json);
-      return json;
-    }
-
     toJSONchildren(json) {
       this._children.forEach(c => c.toJSONattributes(json));
       return json;
@@ -1154,8 +1181,11 @@ function getEdm( options, messageFunctions ) {
     toJSON() {
       const json = Object.create(null);
       this.toJSONattributes(json);
-      this.toJSONchildren(json);
-      return json;
+      return this.toJSONchildren(json);
+    }
+
+    toJSONattributes(json) {
+      return super.toJSONattributes(json, false);
     }
 
     getConstantExpressionValue() {
@@ -1226,6 +1256,7 @@ function getEdm( options, messageFunctions ) {
           json[n] = v;
         });
       });
+      return json;
     }
   }
 
@@ -1242,8 +1273,9 @@ function getEdm( options, messageFunctions ) {
   // since it was discovered, that in JSON the EnumMember type must be
   // transported this is no longer the case....
   class Annotation extends AnnotationBase {
-    constructor(version, termName) {
+    constructor(version, termName, ...children) {
       super(version, { Term: termName } );
+      this.append(...children);
     }
 
     toJSON() {
@@ -1263,6 +1295,11 @@ function getEdm( options, messageFunctions ) {
   }
 
   class Collection extends AnnotationBase {
+    constructor(version, ...children) {
+      super(version);
+      this.append(...children);
+    }
+
     toJSON() {
       // EDM JSON doesn't mention annotations on collections
       return this._children.map(a => a.toJSON());
@@ -1270,12 +1307,17 @@ function getEdm( options, messageFunctions ) {
   }
 
   class Record extends AnnotationBase {
+    constructor(version, ...children) {
+      super(version);
+      this.append(...children);
+    }
     toJSONattributes(json) {
       if (this._jsonOnlyAttributes.Type)
         json['@type'] = this._jsonOnlyAttributes.Type;
       const keys = Object.keys(this._edmAttributes).filter(k => k !== 'Type');
       for (const key of keys)
         json[`$${key}`] = this._edmAttributes[key];
+      return json;
     }
 
     toJSONchildren(json) {
@@ -1300,6 +1342,7 @@ function getEdm( options, messageFunctions ) {
             error(null, `Pease debug me: Unhandled Record child: ${c.kind}`);
         }
       });
+      return json;
     }
   }
 
@@ -1382,8 +1425,7 @@ function getEdm( options, messageFunctions ) {
     toJSON() {
       const json = this.mergeJSONAnnotations();
       json[`$${this.kind}`] = this._children.filter(c => c.kind !== 'Annotation').map(c => c.toJSON());
-      this.toJSONattributes(json);
-      return json;
+      return this.toJSONattributes(json);
     }
   }
   class Cast extends AnnotationBase {
@@ -1402,8 +1444,7 @@ function getEdm( options, messageFunctions ) {
       // first expression only, if any
       const children = this._children.filter(child => child.kind !== 'Annotation');
       json[`$${this.kind}`] = children.length ? children[0].toJSON() : {};
-      this.toJSONattributes(json);
-      return json;
+      return this.toJSONattributes(json);
     }
     toJSONattributes(json) {
       super.toJSONattributes(json);
@@ -1430,8 +1471,7 @@ function getEdm( options, messageFunctions ) {
       // first expression only, if any
       const children = this._children.filter(child => child.kind !== 'Annotation');
       json[`$${this.kind}`] = children.length ? children[0].toJSON() : '';
-      this.toJSONattributes(json);
-      return json;
+      return this.toJSONattributes(json);
     }
 
     toJSONattributes(json) { // including Name

package/lib/edm/edmInboundChecks.js

@@ -3,7 +3,7 @@
 const { setProp, isBetaEnabled } = require('../base/model');
 const {
   forEachDefinition, forEachMemberRecursively, getUtils,
-  transformExpression, findAnnotationExpression,
+  transformAnnotationExpression,
 } = require('../model/csnUtils');
 const { isBuiltinType } = require('../base/builtins');
 const { assignAnnotation } = require('./edmUtils.js');
@@ -59,7 +59,6 @@ function inboundQualificationChecks( csn, options, messageFunctions,
         markBindingParamPaths(action, aLoc);
         forEachMemberRecursively(action, checkIfItemsOfItems, aLoc);
         checkIfItemsOfItems(action.returns, undefined, undefined, aLoc.concat('returns'));
-        markBindingParamPaths(action, aLoc);
       });
     }
 
@@ -144,14 +143,12 @@ function inboundQualificationChecks( csn, options, messageFunctions,
                 parent.$bparam = true;
             },
           };
-          let exprAnnos = Object.keys(action).filter(pn => findAnnotationExpression(action, pn));
-          exprAnnos.forEach((pn) => {
-            transformExpression(action, pn, markBindingParam, loc);
+          Object.keys(action).filter(pn => pn[0] === '@').forEach((pn) => {
+            transformAnnotationExpression(action, pn, markBindingParam, loc);
           });
           forEachMemberRecursively(action, (member, _memberName, _prop, path, _parent) => {
-            exprAnnos = Object.keys(member).filter(pn => findAnnotationExpression(member, pn));
-            exprAnnos.forEach((pn) => {
-              transformExpression(member, pn, markBindingParam, path);
+            Object.keys(member).filter(pn => pn[0] === '@').forEach((pn) => {
+              transformAnnotationExpression(member, pn, markBindingParam, path);
             });
           }, loc);
         }

package/lib/edm/edmPreprocessor.js

@@ -5,7 +5,7 @@ const { setProp, isDeprecatedEnabled, isBetaEnabled } = require('../base/model')
 const {
   forEachDefinition, forEachGeneric, forEachMemberRecursively,
   isEdmPropertyRendered, getUtils,
-  applyTransformations, transformExpression, findAnnotationExpression,
+  applyTransformations, transformAnnotationExpression, findAnnotationExpression,
   cardinality2str,
 } = require('../model/csnUtils');
 const { isBuiltinType, isMagicVariable } = require('../base/builtins');
@@ -160,6 +160,7 @@ function initializeModel( csn, _options, messageFunctions, requestedServiceNames
     forEachDefinition(reqDefs, [
       exposeTargetsAsProxiesOrSchemaRefs,
       determineEntitySet,
+      annotateOptionalActFuncParams,
     ]);
     // finalize proxy creation
     mergeProxiesIntoModel();
@@ -170,7 +171,6 @@ function initializeModel( csn, _options, messageFunctions, requestedServiceNames
       forEachDefinition(reqDefs, [
         initEdmNavPropBindingTargets,
         pullupCapabilitiesAnnotations,
-        annotateOptionalActFuncParams,
       ]);
     }
 
@@ -685,8 +685,8 @@ function initializeModel( csn, _options, messageFunctions, requestedServiceNames
       return;
 
     let keys = Object.create(null);
-    const validFrom = []; const
-      validKey = [];
+    const validFrom = [];
+    const validKey = [];
 
     // Iterate all struct elements
     forEachMemberRecursively(def.items || def, (element, elementName, prop, _path, construct) => {
@@ -796,7 +796,7 @@ function initializeModel( csn, _options, messageFunctions, requestedServiceNames
     Do not render (ignore) elements as properties
     In V4:
     1) If this is a foreign key of an association to a container which *is* used
-       to establish the containment via composition and $self comparison.
+       to establish the relation via composition and $self comparison.
        The $self comparison can only be evaluated after the ON conditions have been
        parsed in prepareConstraints().
     2) For all other foreign keys let isEdmPropertyRendered() decide.
@@ -1890,12 +1890,12 @@ function initializeModel( csn, _options, messageFunctions, requestedServiceNames
       mapCdsToEdmProp(def.returns);
       annotateAllowedValues(def.returns, [ ...defLocation, 'returns' ]);
     }
-    forEachMemberRecursively(def, (member, _memberName, _prop, location) => {
+    forEachMemberRecursively(def, (member, _memberName, prop, location) => {
       edmUtils.assignAnnotation(member, '@Core.Description', member.doc);
       markCollection(member);
       mapCdsToEdmProp(member);
       annotateAllowedValues(member, location);
-      ComputedDefaultValue(member);
+      ComputedDefaultValue(member, prop, location);
       rewriteAnnotationExpressions(member);
       if (member.returns) {
         edmUtils.assignAnnotation(member.returns, '@Core.Description', member.returns.doc);
@@ -2082,8 +2082,6 @@ function initializeModel( csn, _options, messageFunctions, requestedServiceNames
     parameters appear rightmost.
   */
   function annotateOptionalActFuncParams( def, defName ) {
-    if (!isBetaEnabled(options, 'optionalActionFunctionParameters'))
-      return;
     // return if there is nothing to do
     const loc = [ 'definitions', defName ];
     if (def.kind === 'function' || def.kind === 'action')
@@ -2097,33 +2095,57 @@ function initializeModel( csn, _options, messageFunctions, requestedServiceNames
 
     function iterateParams( action, location ) {
       let optPns = [];
+      const isBP = p => (p.items?.type || p.type) === special$self;
+
       if (action.params) {
-        Object.values(action.params).forEach((p) => {
-        // user assigned annotation, don't touch it
-          if (Object.keys(p).some(a => a.startsWith('@Core.OptionalParameter') && p[a] !== null)) {
-            optPns.push(p);
-          }
-          // default value automatically makes param optional
-          else if (p.default) {
-            if (p.default.val)
-              edmUtils.assignAnnotation(p, '@Core.OptionalParameter.DefaultValue', p.default.val);
-            else
-              edmUtils.assignAnnotation(p, '@Core.OptionalParameter.$Type', '');
-            optPns.push(p);
-          }
-          // if no default is available, nullable makes param optional
-          else if (!p.notNull) {
-            edmUtils.assignAnnotation(p, '@Core.OptionalParameter.$Type', '');
-            optPns.push(p);
+        Object.entries(action.params).forEach(([ pn, p ]) => {
+          // user assigned annotation, don't touch it
+          const defT = reqDefs.definitions[p.items?.type || p.type];
+          const isStructType = !!(defT?.items?.elements || defT?.elements);
+          const isItems = !!(p.items || defT?.items);
+
+          if (Object.keys(p).some(a => a.startsWith('@Core.OptionalParameter') && p[a] != null)) {
+            // expand short cut annotation for unspecified default value
+            if (typeof p['@Core.OptionalParameter'] === 'boolean') {
+              if (p['@Core.OptionalParameter'] && !isBP(p) && !options.isV2()) {
+                if (p.default?.val !== undefined) {
+                  if (p.default.val !== null && (isStructType || isItems))
+                    warning('odata-ignoring-param-default', location.concat(pn), { '#': 'colitem' });
+                  else
+                    p['@Core.OptionalParameter'] = { DefaultValue: p.default.val };
+                }
+                else {
+                  p['@Core.OptionalParameter'] = { $Type: '' };
+                }
+                optPns.push(p);
+              }
+              else { // reset falsy annotation, param is NOT optional
+                p['@Core.OptionalParameter'] = null;
+              }
+            }
+            else {
+              optPns.push(p);
+            }
           }
-          else {
-          // this is a mandatory parameter, warn about all previously collected optional parameters
-            optPns.forEach((op) => {
-              const type = op.items?.type || op.type;
-              if (type !== special$self)
-                error('odata-parameter-order', location.concat(op.name));
-            });
-            optPns = [];
+          else if (!isBP(p) && !options.isV2()) {
+            // default value automatically makes param optional
+            if (p.default?.val !== undefined) {
+              if (p.default.val !== null && (isStructType || isItems))
+                warning('odata-ignoring-param-default', location.concat(pn), { '#': 'colitem' });
+              else
+                edmUtils.assignAnnotation(p, '@Core.OptionalParameter.DefaultValue', p.default.val);
+              optPns.push(p);
+            }
+            // nullable action params are optional (implicit default null)
+            else if (!p.notNull && action.kind === 'action') {
+              optPns.push(p);
+            }
+            else if (action.kind === 'function') {
+              // this is a mandatory parameter, warn about all previously collected optional parameters
+              if (optPns.filter(op => (op.items?.type || op.type) !== special$self).length)
+                error('odata-parameter-order', location.concat(pn));
+              optPns = [];
+            }
           }
         });
       }
@@ -2152,7 +2174,7 @@ function initializeModel( csn, _options, messageFunctions, requestedServiceNames
     }
   }
 
-  function ComputedDefaultValue( member ) {
+  function ComputedDefaultValue( member, prop, location ) {
     if (member.default && !csn['@Core.ComputedDefaultValue']) {
       let def = member.default;
       let noTailExpr = false;
@@ -2166,8 +2188,12 @@ function initializeModel( csn, _options, messageFunctions, requestedServiceNames
         def = def.xpr[i];
       }
       // it is a computed value if it is not a simple value or an annotation
-      if (!((def.val !== undefined && !noTailExpr) || def['#']))
-        edmUtils.assignAnnotation(member, '@Core.ComputedDefaultValue', true);
+      if (!((def.val !== undefined && !noTailExpr) || def['#'])) {
+        if (prop === 'params')
+          warning('odata-ignoring-param-default', location, { '#': 'xpr' });
+        else
+          edmUtils.assignAnnotation(member, '@Core.ComputedDefaultValue', true);
+      }
     }
   }
 
@@ -2258,13 +2284,13 @@ function initializeModel( csn, _options, messageFunctions, requestedServiceNames
 
       xprANames.forEach((xprAName) => {
         isSubTreeSpan = true;
-        transformExpression(carrier, xprAName, subTreeSpan);
+        transformAnnotationExpression(carrier, xprAName, subTreeSpan);
         if (isSubTreeSpan) {
-          transformExpression(carrier, xprAName, relativize);
+          transformAnnotationExpression(carrier, xprAName, relativize);
         }
         else {
           absolutize.scope = scope;
-          transformExpression(carrier, xprAName, absolutize);
+          transformAnnotationExpression(carrier, xprAName, absolutize);
           if (!def[proxyDict])
             setProp(def, proxyDict, Object.create(null));
           let proxyCarrier = def[proxyDict][eltPath];

package/lib/edm/edmUtils.js

@@ -386,7 +386,7 @@ function finalizeReferentialConstraints( csn, assocCsn, options, info ) {
   // If this association points to a redirected Parameter EntityType, do not calculate any constraints,
   // continue with multiplicity
   if (assocCsn._target.$isParamEntity)
-    assocCsn._constraints.constraints = Object.create(null);
+    assocCsn._constraints.constraints = {};
 
   return assocCsn._constraints;