@sap/cds-compiler 2.15.8 → 3.1.0

package/lib/edm/edmUtils.js

@@ -8,31 +8,17 @@ function validateOptions(_options)
 {
   if(!_options.isV2 && !_options.isV4)
   {
-    // csn2edm expects "version" to be a top-level property of options
+    // csn2edm expects "odataVersion" to be a top-level property of options
     // set to 'v4' as default, override with value from incoming options
-    // (here version comes inside "toOdata")
-    const options = Object.assign({ version: 'v4'}, _options);
-    if (options.toOdata) {
-      if(options.toOdata.version)
-        options.version = options.toOdata.version;
-      if(options.toOdata.odataFormat)
-        options.odataFormat = options.toOdata.odataFormat;
-      if(options.toOdata.odataContainment)
-        options.odataContainment = options.toOdata.odataContainment;
-      if(options.toOdata.odataForeignKeys)
-        options.odataForeignKeys = options.toOdata.odataForeignKeys;
-      if(options.toOdata.odataV2PartialConstr)
-        options.odataV2PartialConstr = options.toOdata.odataV2PartialConstr;
-      // global flag that indicates whether or not FKs shall be rendered in general
-      // V2/V4 flat: yes
-      // V4/struct: depending on odataForeignKeys
-      options.renderForeignKeys =
-        options.version === 'v4' ? options.odataFormat === 'structured' &&  !!options.odataForeignKeys : true;
+    const options = Object.assign({ odataVersion: 'v4'}, _options);
+    // global flag that indicates whether or not FKs shall be rendered in general
+    // V2/V4 flat: yes
+    // V4/struct: depending on odataForeignKeys
+    options.renderForeignKeys =
+      options.odataVersion === 'v4' ? options.odataFormat === 'structured' &&  !!options.odataForeignKeys : true;
 
-    }
-
-    const v2 = options.version.match(/v2/i) !== null;
-    const v4 = options.version.match(/v4/i) !== null;
+    const v2 = options.odataVersion.match(/v2/i) !== null;
+    const v4 = options.odataVersion.match(/v4/i) !== null;
 
     options.v = [v2, v4];
     options.isStructFormat = options.odataFormat && options.odataFormat === 'structured';
@@ -41,8 +27,8 @@ function validateOptions(_options)
     if(options.v.filter(v=>v).length !== 1)
       throw Error(`Please debug me: EDM V2:${v2}, V4:${v4}`);
 
-    options.isV2 = function() { return this.v[0]; }
-    options.isV4 = function() { return this.v[1]; }
+    options.isV2 = () => v2;
+    options.isV4 = () => v4;
 
     options.pathDelimiter = options.isStructFormat ? '/' : '_';
 
@@ -70,22 +56,11 @@ function foreach(dictionary, filter, func) {
   });
 }
 
-// Call func(art, name) for each artifact 'art' with name 'name' in 'dictionary'
-function forAll(dictionary, func) {
-  foreach(dictionary, ()=>true, func);
-}
-
 // true if _containerEntity is unequal to artifact name (non-recursive containment association)
 //      or if artifact belongs to an artificial parameter entity
 function isContainee(artifact) {
-  // if _containerEntity is present, it is guaranteed that it has at least one entry
-  return (artifact._containerEntity && (artifact._containerEntity.length > 1 || artifact._containerEntity[0] != artifact.name));
-}
-
-// Return true if 'artifact' has an association type
-function isAssociation(artifact) {
-  return (artifact.type === 'cds.Association' || artifact.type === 'Association') &&  artifact.target != undefined;
-  //return artifact.target != undefined;
+  // if $containerNames is present, it is guaranteed that it has at least one entry
+  return (artifact.$containerNames && (artifact.$containerNames.length > 1 || artifact.$containerNames[0] != artifact.name));
 }
 
 function isComposition(artifact) {
@@ -93,16 +68,6 @@ function isComposition(artifact) {
     artifact.target != undefined;
 }
 
-function isAssociationOrComposition(artifact)
-{
-  return isAssociation(artifact) || isComposition(artifact);
-}
-
-function isManagedAssociation(artifact)
-{
-  return isAssociation(artifact) && artifact.on == undefined;
-}
-
 // Return true if the association 'assoc' has cardinality 'to-many'
 function isToMany(assoc) {
   if (!assoc.cardinality) {
@@ -122,13 +87,8 @@ function isSingleton(entityCsn) {
   return singleton || ((singleton === undefined || singleton === null) && hasNullable);
 }
 
-function isEntity(artifact)
-{
-  return artifact.kind === 'entity';
-}
-
 function isParameterizedEntity(artifact) {
-  return isEntity(artifact) && artifact.params;
+  return artifact.kind === 'entity' && artifact.params;
 }
 
 // Return true if 'artifact' is structured (i.e. has elements, like a structured type or an entity)
@@ -146,10 +106,6 @@ function isDerivedType(artifact) {
   return artifact.kind === 'type' && !isStructuredArtifact(artifact);
 }
 
-function isActionOrFunction(artifact) {
-  return artifact.kind === 'action' || artifact.kind === 'function';
-}
-
 function resolveOnConditionAndPrepareConstraints(csn, assocCsn, messageFunctions) {
   if(!assocCsn._constraints)
     throw Error('Please debug me: need _constraints');
@@ -189,7 +145,7 @@ function resolveOnConditionAndPrepareConstraints(csn, assocCsn, messageFunctions
           info(null, ['definitions', parentName, 'elements', assocCsn.name],
             `"${originParentName}:${partnerPath.join('.')}" with target "${originAssocCsn._target.name}" is compared with $self which represents "${parentName}"`);
         }
-        if(isAssociationOrComposition(originAssocCsn)) {
+        if(originAssocCsn.target) {
           // Mark this association as backlink if $self appears exactly once
           // to surpress edm:Association generation in V2 mode
           if(isBacklink) {
@@ -359,7 +315,7 @@ function finalizeReferentialConstraints(csn, assocCsn, options, info)
           // in structured mode only resolve top level element (path rewriting is done elsewhere)
           const depEltName = ( options.isFlatFormat ? c[0].join('_') : c[0][0] );
           const principalEltName = ( options.isFlatFormat ? c[1].join('_') : c[1][0] );
-          const fk = (isEntity(dependentEntity) && dependentEntity.elements[ depEltName ]) ||
+          const fk = (dependentEntity.kind === 'entity' && dependentEntity.elements[ depEltName ]) ||
             (localDepEntity && localDepEntity.elements && localDepEntity.elements[ depEltName ]);
           const pk = principalEntity.$keys && principalEntity.$keys[ principalEltName ];
           if(isConstraintCandidate(fk) && isConstraintCandidate(pk)) {
@@ -797,24 +753,97 @@ function resolveOriginAssoc(csn, env, path) {
   return env;
 }
 
+function mergeIntoNavPropRestrictions(annoPrefix, assocPath, props, navPropRestrictions) {
+  let navPropEntry;
+  let hasEntry = false;
+  let newEntry = false;
+  hasEntry = !!(navPropEntry = navPropRestrictions.find(p =>
+                p.NavigationProperty && p.NavigationProperty['='] === assocPath));
+
+  if(!hasEntry) {
+    navPropEntry =  { NavigationProperty: { '=': assocPath } };
+  }
+
+  const prop = annoPrefix.split('.')[1];
+  // Filter properties with prefix and reduce them into a new dictionary
+  const o = props.filter(p => p[0].startsWith(annoPrefix+'.')).reduce((a,c) => {
+    a[c[0].replace(annoPrefix+'.', '')] = c[1];
+    return a;
+  }, { });
+  // don't overwrite existing restrictions
+  if(!navPropEntry[prop]) {
+    // if dictionary has entries, add them to navPropEnty
+    if(Object.keys(o).length) {
+      // ReadRestrictions may have sub type ReadByKeyRestrictions { Description, LongDescription }
+      // chop annotations into dictionaries
+      if(annoPrefix === '@Capabilities.ReadRestrictions' &&
+                      Object.keys(o).some(k => k.startsWith('ReadByKeyRestrictions.'))) {
+        const no = {};
+        Object.entries(o).forEach(([k,v]) => {
+          const [head, ...tail] = k.split('.');
+          if(head === 'ReadByKeyRestrictions' && tail.length) {
+            if(!no['ReadByKeyRestrictions'])
+              no['ReadByKeyRestrictions'] = {};
+                        // Don't try to add entry into non object
+            if(typeof no['ReadByKeyRestrictions'] === 'object')
+              no['ReadByKeyRestrictions'][tail.join('.')] = v;
+          }
+          else {
+            no[k] = v;
+          }
+        });
+        navPropEntry[prop] = no;
+      }
+      else {
+        navPropEntry[prop] = o;
+      }
+      newEntry = true;
+    }
+  }
+  else {
+    // merge but don't overwrite into existing navprop
+    Object.entries(o).forEach(([k,v]) => {
+      if(!navPropEntry[prop][k])
+        navPropEntry[prop][k] = v;
+    });
+  }
+  if(newEntry && !hasEntry) {
+    navPropRestrictions.push(navPropEntry);
+  }
+}
+
+// Assign but not overwrite annotation
+function assignAnnotation(node, name, value) {
+  if(value !== undefined &&
+      name !== undefined && name[0] === '@' &&
+      (node[name] === undefined || node[name] === null)) {
+    node[name] = value;
+  }
+}
+
+// Set non enumerable property if it doesn't exist yet
+function assignProp(obj, prop, value) {
+  if(obj[prop] === undefined) {
+    setProp(obj, prop, value);
+  }
+}
+
+
+
 module.exports = {
+  assignAnnotation,
+  assignProp,
   validateOptions,
   intersect,
   foreach,
-  forAll,
   isContainee,
-  isAssociation,
-  isManagedAssociation,
   isComposition,
-  isAssociationOrComposition,
   isToMany,
   isSingleton,
-  isEntity,
   isStructuredType,
   isStructuredArtifact,
   isParameterizedEntity,
   isDerivedType,
-  isActionOrFunction,
   resolveOnConditionAndPrepareConstraints,
   finalizeReferentialConstraints,
   determineMultiplicity,
@@ -824,5 +853,6 @@ module.exports = {
   escapeStringForAttributeValue,
   escapeStringForText,
   getSchemaPrefix,
-  getBaseName
+  getBaseName,
+  mergeIntoNavPropRestrictions
 }

package/lib/gen/Dictionary.json

@@ -989,8 +989,7 @@
         "NavigationProperty",
         "Action",
         "Function"
-      ],
-      "$experimental": true
+      ]
     },
     "Common.DerivedDefaultValue": {
       "Type": "Edm.String",
@@ -1424,6 +1423,13 @@
       "Type": "Graph.DetailsType",
       "$experimental": true
     },
+    "Graph.CompositionRoot": {
+      "Type": "Core.Tag",
+      "AppliesTo": [
+        "EntityType"
+      ],
+      "$experimental": true
+    },
     "Hierarchy.RecursiveHierarchy": {
       "Type": "Hierarchy.RecursiveHierarchyType",
       "AppliesTo": [
@@ -2413,7 +2419,8 @@
         "CustomHeaders": "Collection(Capabilities.CustomParameter)",
         "CustomQueryOptions": "Collection(Capabilities.CustomParameter)",
         "Description": "Edm.String",
-        "LongDescription": "Edm.String"
+        "LongDescription": "Edm.String",
+        "ErrorResponses": "Collection(Capabilities.HttpResponse)"
       }
     },
     "Capabilities.PermissionType": {
@@ -2455,7 +2462,8 @@
         "CustomHeaders": "Collection(Capabilities.CustomParameter)",
         "CustomQueryOptions": "Collection(Capabilities.CustomParameter)",
         "Description": "Edm.String",
-        "LongDescription": "Edm.String"
+        "LongDescription": "Edm.String",
+        "ErrorResponses": "Collection(Capabilities.HttpResponse)"
       }
     },
     "Capabilities.DeepUpdateSupportType": {
@@ -2477,7 +2485,8 @@
         "CustomHeaders": "Collection(Capabilities.CustomParameter)",
         "CustomQueryOptions": "Collection(Capabilities.CustomParameter)",
         "Description": "Edm.String",
-        "LongDescription": "Edm.String"
+        "LongDescription": "Edm.String",
+        "ErrorResponses": "Collection(Capabilities.HttpResponse)"
       }
     },
     "Capabilities.CollectionPropertyRestrictionsType": {
@@ -2502,7 +2511,8 @@
         "FilterSegmentSupported": "Edm.Boolean",
         "Permissions": "Collection(Capabilities.PermissionType)",
         "CustomHeaders": "Collection(Capabilities.CustomParameter)",
-        "CustomQueryOptions": "Collection(Capabilities.CustomParameter)"
+        "CustomQueryOptions": "Collection(Capabilities.CustomParameter)",
+        "ErrorResponses": "Collection(Capabilities.HttpResponse)"
       }
     },
     "Capabilities.ModificationQueryOptionsType": {
@@ -2525,7 +2535,8 @@
         "CustomHeaders": "Collection(Capabilities.CustomParameter)",
         "CustomQueryOptions": "Collection(Capabilities.CustomParameter)",
         "Description": "Edm.String",
-        "LongDescription": "Edm.String"
+        "LongDescription": "Edm.String",
+        "ErrorResponses": "Collection(Capabilities.HttpResponse)"
       }
     },
     "Capabilities.ReadByKeyRestrictionsType": {
@@ -2537,7 +2548,8 @@
         "CustomHeaders": "Collection(Capabilities.CustomParameter)",
         "CustomQueryOptions": "Collection(Capabilities.CustomParameter)",
         "Description": "Edm.String",
-        "LongDescription": "Edm.String"
+        "LongDescription": "Edm.String",
+        "ErrorResponses": "Collection(Capabilities.HttpResponse)"
       }
     },
     "Capabilities.ReadRestrictionsType": {
@@ -2550,7 +2562,8 @@
         "CustomHeaders": "Collection(Capabilities.CustomParameter)",
         "CustomQueryOptions": "Collection(Capabilities.CustomParameter)",
         "Description": "Edm.String",
-        "LongDescription": "Edm.String"
+        "LongDescription": "Edm.String",
+        "ErrorResponses": "Collection(Capabilities.HttpResponse)"
       }
     },
     "Capabilities.CustomParameter": {
@@ -2563,6 +2576,13 @@
         "ExampleValues": "Collection(Core.PrimitiveExampleValue)"
       }
     },
+    "Capabilities.HttpResponse": {
+      "$kind": "ComplexType",
+      "Properties": {
+        "StatusCode": "Edm.String",
+        "Description": "Edm.String"
+      }
+    },
     "Capabilities.FilterExpressionType": {
       "$kind": "TypeDefinition",
       "UnderlyingType": "Edm.String"

package/lib/gen/language.checksum

@@ -1 +1 @@
-351a6ed427f91f2eef4d8e9a2e11dd17
+2067e213918678e2d85713a46e69d9cc