@sap/cds-compiler 3.9.2 → 4.0.0

package/lib/edm/edmPreprocessor.js

@@ -38,7 +38,7 @@ function initializeModel(csn, _options, messageFunctions, requestedServiceNames=
 
   // proxies are merged into the final model after all proxy elements are collected
   const proxyCache = [];
-  // iterarte only over those definitions that need to be preprocessed
+  // iterate only over those definitions that need to be preprocessed
   // instead of mangling through the whole model each time
   // preprocess steps removing adding to the model must co-modify this map
   const reqDefs = { definitions: Object.create(null) };
@@ -398,7 +398,7 @@ function initializeModel(csn, _options, messageFunctions, requestedServiceNames=
   //   non-containment rendering. If containment rendering is active, the containee has no
   //   entity set. Instead try to rewrite the annotation in such a way that it is effective
   //   on the containment navigation property.
-  // $containeeAssoications stores the containees (children/outbound edges)
+  // $containeeAssociations stores the containees (children/outbound edges)
   // $containerNames stores the containers (parents/inbound edges)
 
   function initContainments(container) {
@@ -410,7 +410,7 @@ function initializeModel(csn, _options, messageFunctions, requestedServiceNames=
     }
 
     function initContainments(elt, _memberName, _prop, path) {
-      if(elt.target && elt['@odata.contained'] && !elt._ignore) {
+      if(elt.target && elt['@odata.contained']) {
         // store all containment associations, required to create the containment paths later on
         container.$containeeAssociations.push( { assoc: elt, path });
         // Let the containee know its container
@@ -829,7 +829,7 @@ function initializeModel(csn, _options, messageFunctions, requestedServiceNames=
           }
         }
         // Only in containment:
-        // Ignore this (foreign key) elment if renderForeignKeys is false
+        // Ignore this (foreign key) element if renderForeignKeys is false
         if(options.odataContainment && element['@odata.containment.ignore']) {
           if(!options.renderForeignKeys)
             edmUtils.assignAnnotation(element, '@cds.api.ignore', true);
@@ -859,7 +859,7 @@ function initializeModel(csn, _options, messageFunctions, requestedServiceNames=
     forEachMemberRecursively(def.items || def, finalizeConstraintsOnAssoc, [], true, { elementsOnly: true });
   }
   function finalizeConstraintsOnAssoc(element) {
-    if (element.target && !element._ignore && element._constraints) {
+    if (element.target && element._constraints) {
       edmUtils.finalizeReferentialConstraints(csn, element, options, info);
 
       if(element._constraints?._partnerCsn) {
@@ -958,14 +958,14 @@ function initializeModel(csn, _options, messageFunctions, requestedServiceNames=
     // if this artifact is a service member check its associations
     if(globalSchemaPrefix) {
       forEachGeneric(struct.items || struct, 'elements', element => {
-        if(!element.target || element['@odata.navigable'] === false)
+        if(!edmUtils.isNavigable(element))
           return;
         /*
          * Consider everything @cds.autoexpose: falsy to be a proxy candidate for now
          */
         /*
         if(element._target['@cds.autoexpose'] === false) {
-          // :TODO: Also _ignore foreign keys to association?
+          // :TODO: Also ignore foreign keys to association?
           edmUtils.foreach(struct.elements,
             e =>
               e['@odata.foreignKey4'] === element.name,
@@ -985,7 +985,7 @@ function initializeModel(csn, _options, messageFunctions, requestedServiceNames=
         // proxy required.
         // association must be managed and not unmanaged
 
-        // odataProxies (P) and odataXServiceRefs (X) are evalutated as follows:
+        // odataProxies (P) and odataXServiceRefs (X) are evaluated as follows:
         // P | X | Action
         // 0 | 0 | No out bound navigation
         // 0 | 1 | Cross service references are generated
@@ -1211,7 +1211,7 @@ function initializeModel(csn, _options, messageFunctions, requestedServiceNames=
               if(typeClone) {
                 // Recurse into elements of 'type' (if any)
                 typeClone.elements && Object.entries(typeClone.elements).forEach(([elemName, elem]) => {
-                  // if this is a foreign key elment, we must check whether or not the association
+                  // if this is a foreign key element, we must check whether or not the association
                   // has been exposed as proxy. If it has not been exposed, no further structured
                   // types must be exposed as 'Proxy_' types.
 
@@ -1494,7 +1494,7 @@ function initializeModel(csn, _options, messageFunctions, requestedServiceNames=
 
     function finalizeProxyContainments(proxy) {
       // initialise containments after all exposed types are collected
-      // AND remove unfullfillable NavRestrictions
+      // AND remove unfulfillable NavRestrictions
       initContainments(proxy);
       const assocPaths = proxy.$containeeAssociations.map(entry => entry.path.join('.'));
       const newNpr = [];
@@ -1643,7 +1643,7 @@ function initializeModel(csn, _options, messageFunctions, requestedServiceNames=
         csn.definitions[elt.type] &&
         csnUtils.getFinalTypeInfo(elt.type).items);
       if(type ||
-        (options.odataFormat !== 'flat' && !options.odataForeignKeys) && 
+        (options.odataFormat !== 'flat' && !options.odataForeignKeys) &&
          elt.cardinality?.max && elt.cardinality.max !== 1) {
         // many primary key can be induced by a many parameter of a view
         message('odata-spec-violation-key-array', location,
@@ -1857,6 +1857,7 @@ function initializeModel(csn, _options, messageFunctions, requestedServiceNames=
       annotateAllowedValues(member, path);
       ComputedDefaultValue(member);
       if (member.returns) {
+        edmUtils.assignAnnotation(member.returns, '@Core.Description', member.returns.doc);
         markCollection(member.returns);
         mapCdsToEdmProp(member.returns);
         annotateAllowedValues(member.returns, [...path, 'returns']);
@@ -1910,7 +1911,7 @@ function initializeModel(csn, _options, messageFunctions, requestedServiceNames=
               else if(node.kind !== 'annotation') {
                 // omit the entry and warn
                 warning('odata-enum-missing-value', path,
-                  { name: enumSymbol, anno: '@Valiation.AllowedValues', type: typeDef.type },
+                  { name: enumSymbol, anno: '@Validation.AllowedValues', type: typeDef.type },
                   'Expected enum element $(NAME) of type $(TYPE) to have a value, not added to $(ANNO)');
               }
             }
@@ -1918,13 +1919,13 @@ function initializeModel(csn, _options, messageFunctions, requestedServiceNames=
           else { // enumSymbolDef not found
             // omit the entry and warn
             warning('odata-enum-missing-value', path,
-              { name: enumSymbol, anno: '@Valiation.AllowedValues', type: typeDef.type },
+              { name: enumSymbol, anno: '@Validation.AllowedValues', type: typeDef.type },
               'Expected enum element $(NAME) of type $(TYPE) to have a value, not added to $(ANNO)');
           }
 
           // Can't rely that @description has already been renamed to @Core.Description
           // Eval description according to precedence (doc comment must be considered already in Odata transformer
-          // as in contrast to the other doc commments as it is used to annotate the @Validation.AllowedValues)
+          // as in contrast to the other doc comments as it is used to annotate the @Validation.AllowedValues)
           const desc = enumSymbolDef ? enumSymbolDef['@Core.Description'] || enumSymbolDef['@description'] || enumSymbolDef.doc : undefined;
           if (desc)
             result['@Core.Description'] = desc;
@@ -1945,8 +1946,8 @@ function initializeModel(csn, _options, messageFunctions, requestedServiceNames=
 
     if(!options.odataCapabilitiesPullup)
       return;
-    // meaningless for non-entities and proxies
-    if(rootContainer.kind !== 'entity' || rootContainer.$proxy)
+    // @Capabilities is applicable to EntitySet/Collection only
+    if(!rootContainer.$hasEntitySet)
       return;
 
     const isRecursiveContainment =
@@ -1994,7 +1995,7 @@ function initializeModel(csn, _options, messageFunctions, requestedServiceNames=
           const { assoc, path } = entry;
           const containee = assoc._target;
 
-          if(isMyServiceRequested(containee.name) || containee.$proxy) {
+          if(edmUtils.isNavigable(assoc) && isMyServiceRequested(containee.name) || containee.$proxy) {
             const localAssocPath = path.join('.');
             let navPropEntry= localRestrictions.find(p =>
                 p.NavigationProperty && p.NavigationProperty['='] === prefix.concat(localAssocPath).join('.'));

package/lib/edm/edmUtils.js

@@ -74,10 +74,13 @@ function isToMany(assoc) {
   return targetMax === '*' || Number(targetMax) > 1;
 }
 
+function isNavigable(assoc) {
+  return (assoc.target && (assoc['@odata.navigable'] == null || assoc['@odata.navigable']));
+}
 function isSingleton(entityCsn) {
   const singleton = entityCsn['@odata.singleton'];
-  const hasNullable = entityCsn['@odata.singleton.nullable'] !== undefined && entityCsn['@odata.singleton.nullable'] !== null;
-  return singleton || ((singleton === undefined || singleton === null) && hasNullable);
+  const hasNullable = entityCsn['@odata.singleton.nullable'] != null;
+  return singleton || (singleton == null && hasNullable);
 }
 
 function isParameterizedEntity(artifact) {
@@ -137,7 +140,7 @@ function resolveOnConditionAndPrepareConstraints(csn, assocCsn, messageFunctions
         }
         if(originAssocCsn.target) {
           // Mark this association as backlink if $self appears exactly once
-          // to surpress edm:Association generation in V2 mode
+          // to suppress edm:Association generation in V2 mode
           if(isBacklink) {
             // establish partnership with origin assoc but only if this association is the first one
             if(originAssocCsn._selfReferences.length === 0) {
@@ -639,7 +642,7 @@ function addTypeFacets(node, csn)
    * @param {string} identifier
    */
 function isODataSimpleIdentifier(identifier){
-  // this regular expression reflects the specifiation from above
+  // this regular expression reflects the specification from above
   const regex = /^[\p{Letter}\p{Nl}_][_\p{Letter}\p{Nl}\p{Nd}\p{Mn}\p{Mc}\p{Pc}\p{Cf}]{0,127}$/gu
   return identifier && identifier.match(regex);
 }
@@ -898,6 +901,7 @@ module.exports = {
   foreach,
   isContainee,
   isToMany,
+  isNavigable,
   isSingleton,
   isStructuredType,
   isStructuredArtifact,

package/lib/gen/Dictionary.json

@@ -1844,6 +1844,13 @@
         "EntityType"
       ]
     },
+    "UI.Note": {
+      "Type": "UI.NoteType",
+      "AppliesTo": [
+        "EntityType"
+      ],
+      "$experimental": true
+    },
     "UI.Importance": {
       "Type": "UI.ImportanceType",
       "AppliesTo": [
@@ -3931,6 +3938,17 @@
         "High": "Edm.PrimitiveType"
       }
     },
+    "UI.NoteType": {
+      "$kind": "ComplexType",
+      "Properties": {
+        "Title": "Edm.String",
+        "Content": "Edm.String",
+        "Type": "Edm.String",
+        "MaximalLength": "Edm.Int32",
+        "MultipleNotes": "Edm.Boolean"
+      },
+      "$experimental": true
+    },
     "UI.DataFieldAbstract": {
       "$kind": "ComplexType",
       "Abstract": "true",

package/lib/gen/language.checksum

@@ -1 +1 @@
-78bdabed1311fe8b3b0921bfc5300ece
+8c23b0ea94048e8e7a54d2ed4a4e4707