@sap/cds-compiler 2.11.4 → 2.13.8

package/lib/edm/edmUtils.js

@@ -1,6 +1,7 @@
 'use strict';
 const { setProp } = require('../base/model');
 const { isBuiltinType, isEdmPropertyRendered } = require('../model/csnUtils');
+const { escapeString, hasControlCharacters, hasUnpairedUnicodeSurrogate } = require("../render/utils/stringEscapes");
 
 /* eslint max-statements-per-line:off */
 function validateOptions(_options)
@@ -22,7 +23,7 @@ function validateOptions(_options)
         options.odataForeignKeys = options.toOdata.odataForeignKeys;
       if(options.toOdata.odataV2PartialConstr)
         options.odataV2PartialConstr = options.toOdata.odataV2PartialConstr;
-      // global flag that indicates wether or not FKs shall be rendered in general
+      // global flag that indicates whether or not FKs shall be rendered in general
       // V2/V4 flat: yes
       // V4/struct: depending on odataForeignKeys
       options.renderForeignKeys =
@@ -30,18 +31,18 @@ function validateOptions(_options)
 
     }
 
-    const v2 = options.version.match(/v2/i) != undefined;
-    const v4 = options.version.match(/v4/i) != undefined;
+    const v2 = options.version.match(/v2/i) !== null;
+    const v4 = options.version.match(/v4/i) !== null;
 
     options.v = [v2, v4];
     options.isStructFormat = options.odataFormat && options.odataFormat === 'structured';
     options.isFlatFormat = !options.isStructFormat;
 
-    if(options.v.filter(v=>v).length != 1)
+    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] == true; }
-    options.isV4 = function() { return this.v[1] == true; }
+    options.isV2 = function() { return this.v[0]; }
+    options.isV4 = function() { return this.v[1]; }
 
     options.pathDelimiter = options.isStructFormat ? '/' : '_';
 
@@ -115,15 +116,15 @@ function isToMany(assoc) {
   return targetMax === '*' || Number(targetMax) > 1;
 }
 
-function isSingleton(entityCsn, v) {
+function isSingleton(entityCsn) {
   const singleton = entityCsn['@odata.singleton'];
   const hasNullable = entityCsn['@odata.singleton.nullable'] !== undefined && entityCsn['@odata.singleton.nullable'] !== null;
-  return v && singleton || ((singleton === undefined || singleton === null) && hasNullable);
+  return singleton || ((singleton === undefined || singleton === null) && hasNullable);
 }
 
 function isEntity(artifact)
 {
-  return ['entity'].includes(artifact.kind);
+  return artifact.kind === 'entity';
 }
 
 function isParameterizedEntity(artifact) {
@@ -138,15 +139,15 @@ function isStructuredArtifact(artifact) {
 
 // Return true if 'artifact' is a real structured type (not an entity)
 function isStructuredType(artifact) {
-  return ['type'].includes(artifact.kind) && isStructuredArtifact(artifact);
+  return artifact.kind === 'type' && isStructuredArtifact(artifact);
 }
 
 function isDerivedType(artifact) {
-  return ['type'].includes(artifact.kind) && !isStructuredArtifact(artifact);
+  return artifact.kind === 'type' && !isStructuredArtifact(artifact);
 }
 
 function isActionOrFunction(artifact) {
-  return ['action', 'function'].includes(artifact.kind);
+  return artifact.kind === 'action' || artifact.kind === 'function';
 }
 
 function resolveOnConditionAndPrepareConstraints(csn, assocCsn, messageFunctions) {
@@ -179,7 +180,7 @@ function resolveOnConditionAndPrepareConstraints(csn, assocCsn, messageFunctions
       const originAssocCsn = resolveOriginAssoc(csn, (assocCsn._originalTarget || assocCsn._target), partnerPath);
       const parentName = assocCsn.$abspath[0];
       const parent = csn.definitions[parentName];
-      if(originAssocCsn) {
+      if(originAssocCsn && originAssocCsn.$abspath) {
         const originParentName = originAssocCsn.$abspath[0];
         if(parent.$mySchemaName && originAssocCsn._originalTarget !== parent && originAssocCsn._target !== parent) {
           isBacklink = false;
@@ -253,7 +254,7 @@ function resolveOnConditionAndPrepareConstraints(csn, assocCsn, messageFunctions
       {
         let lhs = expr[pos-1];
         let rhs = expr[pos+1];
-        if(['='].includes(arg))
+        if(arg === '=')
         {
           assocCsn._constraints.termCount++;
           if(lhs.ref && rhs.ref) // ref is a path
@@ -358,7 +359,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 = (isEntity(dependentEntity) && dependentEntity.elements[ depEltName ]) ||
             (localDepEntity && localDepEntity.elements && localDepEntity.elements[ depEltName ]);
           const pk = principalEntity.$keys && principalEntity.$keys[ principalEltName ];
           if(isConstraintCandidate(fk) && isConstraintCandidate(pk)) {
@@ -463,12 +464,11 @@ function finalizeReferentialConstraints(csn, assocCsn, options, info)
    * The element must never be an association or composition and be renderable.
    */
   function isConstraintCandidate(elt) {
-    let rc= (elt &&
+    return (elt &&
             elt.type &&
             (!options.isFlatFormat || options.isFlatFormat && isBuiltinType(elt.type)) &&
             !['cds.Association', 'cds.Composition'].includes(elt.type) &&
             isEdmPropertyRendered(elt, options));
-    return rc;
   }
 }
 
@@ -557,7 +557,7 @@ function mapCdsToEdmType(csn, messageFunctions, isV2=false, isMediaType=false)
     // other: date/time, boolean
     'cds.Date': 'Edm.Date',
     'cds.Time': 'Edm.TimeOfDay',
-    // For a very long time it was unclear wether or not to map the Date types to a different Edm Type in V2,
+    // For a very long time it was unclear whether or not to map the Date types to a different Edm Type in V2,
     // no one has ever asked about it in the meantime. The falsy if is just there to remember the eventual mapping.
     'cds.DateTime': 'Edm.DateTimeOffset', // (isV2 && false) ? 'Edm.DateTime'
     'cds.Timestamp': 'Edm.DateTimeOffset', // (isV2 && false) ? 'Edm.DateTime'
@@ -665,19 +665,111 @@ function isODataSimpleIdentifier(identifier){
   return identifier && identifier.match(regex);
 }
 
-function escapeString(str) {
-  // first regex: replace & if not followed by apos; or quot; or gt; or lt; or amp; or #
-  // Do not always escape > as it is a marker for {i18n>...} translated string values
-  let result = str;
-  if (typeof str === 'string') {
-    result = str.replace(/&(?!(?:apos|quot|[gl]t|amp);|#)/g, '&')
-      .replace(/</g, '&lt;')
-      .replace(/"/g, '&quot;')
-      .replace(/\r\n|\n/g, '&#xa;');
-    if (!result.startsWith('{i18n>') && !result.startsWith('{bi18n'))
-      result = result.replace(/>/g, '&gt;')
-  }
-  return result;
+/**
+ * Escape the given string for attribute values.  We follow the spec as
+ * described in §2.3 <https://www.w3.org/TR/xml/#NT-AttValue>:
+ *
+ *   AttValue ::=  '"' ([^<&"] | Reference)* '"'
+ *               | "'" ([^<&'] | Reference)* "'"
+ *
+ * This function assumes that the attribute value is surrounded by double quotes ("),
+ * hence single quotes are not escaped.
+ *
+ * Note that even though certain special characters such as newline (LF) are allowed,
+ * they may be normalized to something different.  For example LF is normalized
+ * to a space.  Therefore we need to escape it.
+ * See §3.3.3 <https://www.w3.org/TR/xml/#AVNormalize>.
+ *
+ * Furthermore, control characters need to be escaped, see §2.2:
+ * <https://www.w3.org/TR/xml/#charsets>
+ * We also encode LF (#xA), etc. because of XML normalization in XML parsers.
+ *
+ * @param {string} str
+ * @returns {string}
+ */
+function escapeStringForAttributeValue(str) {
+  if (typeof str !== 'string')
+    return str;
+
+  if (!/[&<"]/.test(str) && !hasControlCharacters(str) && !hasUnpairedUnicodeSurrogate(str))
+    return str;
+
+  str = escapeString(str, {
+    '&': '&amp;',
+    '<': '&lt;',
+    '"': '&quot;',
+    control: encodeNonCharacters,
+    unpairedSurrogate: encodeNonCharacters,
+  });
+
+  // Notes
+  // -----
+  // According to the specification, "§2.11: End-of-Line Handling", we should normalize line endings:
+  //    > ... by translating both the two-character sequence #xD #xA and any #xD that is not
+  //    > followed by #xA to a single #xA character.
+  // However, line endings were already normalized in the CDL parser.
+  // If we were to normalize it again, it would be work done twice, possibly resulting in
+  // unwanted normalization (once is expected, twice is not).
+  // If we were to ever change this, use this RegEx:
+  //   /\r\n?|\n/g => '&#xA;'
+
+  return str;
+}
+
+/**
+ * Escape the given string for element content.  We follow the spec as
+ * described in §3.1 <https://www.w3.org/TR/xml/#NT-content>:
+ *
+ *   content  ::= CharData? ((element | Reference | CDSect | PI | Comment) CharData?)*
+ *   CharData ::= [^<&]* - ([^<&]* ']]>' [^<&]*)
+ *
+ * i.e., we need to escape '<', '&' as well as `>` if it is preceded by `]]`.
+ * See also $2.4: “'>' MUST be replaced for compatibility reasons if it appears as ]]>”
+ *
+ * Furthermore, control characters need to be escaped, see §2.2:
+ * <https://www.w3.org/TR/xml/#charsets>
+ * We also encode LF (#xA), etc. because of XML normalization in XML parsers.
+ *
+ * In contrast to `escapeStringForAttributeValue()`, newlines do
+ * not need to be escaped.
+ *
+ * @param {string} str
+ * @returns {string}
+ */
+function escapeStringForText(str) {
+  if (typeof str !== 'string')
+    return str;
+
+  if (!/[&<>]/.test(str) && !hasControlCharacters(str) && !hasUnpairedUnicodeSurrogate(str))
+    return str;
+
+  str = escapeString(str, {
+    '&': '&amp;',
+    '<': '&lt;',
+    control: encodeNonCharacters,
+    unpairedSurrogate: encodeNonCharacters,
+  });
+
+  // Note: You can test this with <https://www.w3schools.com/xml/xml_validator.asp>:
+  //       This sequence is allowed in attribute values but not element content.
+  str = str.replace(/]]>/g, ']]&gt;');
+
+  return str;
+}
+
+/**
+ * Control characters need to be escaped, see §2.2:
+ * <https://www.w3.org/TR/xml/#charsets>
+ *
+ *   Char  ::=  #x9 | #xA | #xD | [#x20-#xD7FF] | [#xE000-#xFFFD] | [#x10000-#x10FFFF]
+ *   --> any Unicode character, excluding the surrogate blocks, FFFE, and FFFF.
+ *
+ * @param {number} codePoint
+ * @returns {string}
+ */
+function encodeNonCharacters(codePoint) {
+  const hex = codePoint.toString(16).toUpperCase();
+  return `&#x${hex};`;
 }
 
 // return the path prefix of a given name or if no prefix available 'root'
@@ -694,10 +786,10 @@ function getBaseName(name) {
 
 // This is a poor mans path resolver for $self partner paths only
 function resolveOriginAssoc(csn, env, path) {
-  for(let i = 0; i < path.length; i++) {
+  for(const segment of path) {
     let elements = (env.items && env.items.elements || env.elements);
     if(elements)
-      env = env.elements[path[i]];
+      env = env.elements[segment];
     let type = (env.items && env.items.type || env.type);
     if(type && !isBuiltinType(type) && !(env.items && env.items.elements || env.elements))
       env = csn.definitions[env.type];
@@ -729,7 +821,8 @@ module.exports = {
   mapCdsToEdmType,
   addTypeFacets,
   isODataSimpleIdentifier,
-  escapeString,
+  escapeStringForAttributeValue,
+  escapeStringForText,
   getSchemaPrefix,
   getBaseName
 }

package/lib/gen/Dictionary.json

@@ -4,7 +4,8 @@
       "Type": "Aggregation.ApplySupportedType",
       "AppliesTo": [
         "EntitySet",
-        "Collection"
+        "Collection",
+        "EntityType"
       ]
     },
     "Aggregation.ApplySupportedDefaults": {
@@ -36,7 +37,8 @@
       "AppliesTo": [
         "EntitySet",
         "Collection",
-        "EntityContainer"
+        "EntityContainer",
+        "EntityType"
       ]
     },
     "Aggregation.ContextDefiningProperties": {
@@ -207,38 +209,44 @@
       "Type": "Capabilities.CountRestrictionsType",
       "AppliesTo": [
         "EntitySet",
-        "Singleton"
+        "Singleton",
+        "Collection"
       ]
     },
     "Capabilities.NavigationRestrictions": {
       "Type": "Capabilities.NavigationRestrictionsType",
       "AppliesTo": [
         "EntitySet",
-        "Singleton"
+        "Singleton",
+        "Collection"
       ]
     },
     "Capabilities.IndexableByKey": {
       "Type": "Core.Tag",
       "AppliesTo": [
-        "EntitySet"
+        "EntitySet",
+        "Collection"
       ]
     },
     "Capabilities.TopSupported": {
       "Type": "Core.Tag",
       "AppliesTo": [
-        "EntitySet"
+        "EntitySet",
+        "Collection"
       ]
     },
     "Capabilities.SkipSupported": {
       "Type": "Core.Tag",
       "AppliesTo": [
-        "EntitySet"
+        "EntitySet",
+        "Collection"
       ]
     },
     "Capabilities.ComputeSupported": {
       "Type": "Core.Tag",
       "AppliesTo": [
-        "EntitySet"
+        "EntitySet",
+        "Collection"
       ]
     },
     "Capabilities.SelectSupport": {
@@ -246,7 +254,8 @@
       "AppliesTo": [
         "EntityContainer",
         "EntitySet",
-        "Singleton"
+        "Singleton",
+        "Collection"
       ]
     },
     "Capabilities.BatchSupported": {
@@ -265,32 +274,37 @@
       "Type": "Collection(Edm.String)",
       "AppliesTo": [
         "EntityContainer",
-        "EntitySet"
+        "EntitySet",
+        "Collection"
       ]
     },
     "Capabilities.FilterRestrictions": {
       "Type": "Capabilities.FilterRestrictionsType",
       "AppliesTo": [
-        "EntitySet"
+        "EntitySet",
+        "Collection"
       ]
     },
     "Capabilities.SortRestrictions": {
       "Type": "Capabilities.SortRestrictionsType",
       "AppliesTo": [
-        "EntitySet"
+        "EntitySet",
+        "Collection"
       ]
     },
     "Capabilities.ExpandRestrictions": {
       "Type": "Capabilities.ExpandRestrictionsType",
       "AppliesTo": [
         "EntitySet",
-        "Singleton"
+        "Singleton",
+        "Collection"
       ]
     },
     "Capabilities.SearchRestrictions": {
       "Type": "Capabilities.SearchRestrictionsType",
       "AppliesTo": [
-        "EntitySet"
+        "EntitySet",
+        "Collection"
       ]
     },
     "Capabilities.KeyAsSegmentSupported": {
@@ -309,14 +323,15 @@
       "Type": "Capabilities.InsertRestrictionsType",
       "AppliesTo": [
         "EntitySet",
-        "EntityType"
+        "Collection"
       ]
     },
     "Capabilities.DeepInsertSupport": {
       "Type": "Capabilities.DeepInsertSupportType",
       "AppliesTo": [
         "EntityContainer",
-        "EntitySet"
+        "EntitySet",
+        "Collection"
       ]
     },
     "Capabilities.UpdateRestrictions": {
@@ -324,14 +339,15 @@
       "AppliesTo": [
         "EntitySet",
         "Singleton",
-        "EntityType"
+        "Collection"
       ]
     },
     "Capabilities.DeepUpdateSupport": {
       "Type": "Capabilities.DeepUpdateSupportType",
       "AppliesTo": [
         "EntityContainer",
-        "EntitySet"
+        "EntitySet",
+        "Collection"
       ]
     },
     "Capabilities.DeleteRestrictions": {
@@ -339,7 +355,7 @@
       "AppliesTo": [
         "EntitySet",
         "Singleton",
-        "EntityType"
+        "Collection"
       ]
     },
     "Capabilities.CollectionPropertyRestrictions": {
@@ -374,7 +390,8 @@
       "Type": "Capabilities.ReadRestrictionsType",
       "AppliesTo": [
         "EntitySet",
-        "Singleton"
+        "Singleton",
+        "Collection"
       ]
     },
     "Capabilities.CustomHeaders": {
@@ -392,6 +409,7 @@
     "Capabilities.MediaLocationUpdateSupported": {
       "Type": "Core.Tag",
       "AppliesTo": [
+        "EntityType",
         "Property"
       ]
     },
@@ -581,7 +599,7 @@
         "Property"
       ],
       "$deprecated": true,
-      "$deprecationText": "Use terms `MaskedValue` and `MaskedAlways` instead"
+      "$deprecationText": "Use terms `MaskedValue` instead"
     },
     "Common.MaskedValue": {
       "Type": "Edm.String",
@@ -590,8 +608,8 @@
       ],
       "$experimental": true
     },
-    "Common.MaskedAlways": {
-      "Type": "Core.Tag",
+    "Common.RevealOnDemand": {
+      "Type": "Edm.Boolean",
       "AppliesTo": [
         "Property"
       ],
@@ -602,7 +620,8 @@
       "AppliesTo": [
         "EntitySet",
         "EntityType",
-        "Property"
+        "Property",
+        "NavigationProperty"
       ]
     },
     "Common.SemanticObjectMapping": {
@@ -639,7 +658,8 @@
       "Type": "Common.FieldControlType",
       "AppliesTo": [
         "Property",
-        "Record"
+        "Record",
+        "EntityType"
       ]
     },
     "Common.ExceptionCategory": {
@@ -1048,7 +1068,8 @@
     "Common.mediaUploadLink": {
       "Type": "Edm.String",
       "AppliesTo": [
-        "Property"
+        "Property",
+        "EntityType"
       ],
       "$experimental": true
     },
@@ -1060,6 +1081,13 @@
       ],
       "$experimental": true
     },
+    "Common.WebSocketBaseURL": {
+      "Type": "Edm.String",
+      "AppliesTo": [
+        "EntityContainer"
+      ],
+      "$experimental": true
+    },
     "Communication.Contact": {
       "Type": "Communication.ContactType",
       "AppliesTo": [
@@ -1165,12 +1193,6 @@
         "Term"
       ]
     },
-    "Core.AppliesToTypeIfDynamic": {
-      "Type": "Core.Tag",
-      "AppliesTo": [
-        "Term"
-      ]
-    },
     "Core.AppliesViaContainer": {
       "Type": "Core.Tag",
       "AppliesTo": [
@@ -1260,6 +1282,7 @@
     "Core.MediaType": {
       "Type": "Edm.String",
       "AppliesTo": [
+        "EntityType",
         "Property",
         "Term",
         "TypeDefinition",
@@ -1277,6 +1300,7 @@
     "Core.ContentDisposition": {
       "Type": "Core.ContentDispositionType",
       "AppliesTo": [
+        "EntityType",
         "Property",
         "Term"
       ]
@@ -1297,6 +1321,7 @@
     "Core.AutoExpand": {
       "Type": "Core.Tag",
       "AppliesTo": [
+        "EntityType",
         "NavigationProperty",
         "Property"
       ]
@@ -1417,8 +1442,7 @@
       "Type": "PersonalData.EntitySemanticsType",
       "AppliesTo": [
         "EntitySet"
-      ],
-      "$experimental": true
+      ]
     },
     "PersonalData.DataSubjectRole": {
       "Type": "Edm.String",
@@ -1438,15 +1462,13 @@
       "Type": "PersonalData.FieldSemanticsType",
       "AppliesTo": [
         "Property"
-      ],
-      "$experimental": true
+      ]
     },
     "PersonalData.IsPotentiallyPersonal": {
       "Type": "Core.Tag",
       "AppliesTo": [
         "Property"
-      ],
-      "$experimental": true
+      ]
     },
     "PersonalData.IsPotentiallySensitive": {
       "Type": "Core.Tag",
@@ -1682,7 +1704,8 @@
     "UI.IsImage": {
       "Type": "Core.Tag",
       "AppliesTo": [
-        "Property"
+        "Property",
+        "EntityType"
       ],
       "$experimental": true
     },
@@ -2678,6 +2701,7 @@
         "EditAction": "Common.QualifiedName",
         "NewAction": "Common.QualifiedName",
         "AdditionalNewActions": "Collection(Common.QualifiedName)",
+        "ShareAction": "Common.QualifiedName",
         "PreparationAction": "Common.QualifiedName",
         "ValidationFunction": "Common.QualifiedName"
       }
@@ -3001,6 +3025,7 @@
     "Core.ContentDispositionType": {
       "$kind": "ComplexType",
       "Properties": {
+        "Type": "Edm.String",
         "Filename": "Edm.String"
       }
     },
@@ -3128,18 +3153,17 @@
     },
     "PersonalData.EntitySemanticsType": {
       "$kind": "TypeDefinition",
-      "UnderlyingType": "Edm.String",
-      "$experimental": true
+      "UnderlyingType": "Edm.String"
     },
     "PersonalData.FieldSemanticsType": {
       "$kind": "TypeDefinition",
-      "UnderlyingType": "Edm.String",
-      "$experimental": true
+      "UnderlyingType": "Edm.String"
     },
     "Session.StickySessionSupportedType": {
       "$kind": "ComplexType",
       "Properties": {
         "NewAction": "Common.QualifiedName",
+        "AdditionalNewActions": "Collection(Common.QualifiedName)",
         "EditAction": "Common.QualifiedName",
         "SaveAction": "Common.QualifiedName",
         "DiscardAction": "Common.SimpleIdentifier"
@@ -3583,6 +3607,18 @@
         "IconUrl": "Edm.String"
       }
     },
+    "UI.DataFieldForActionGroup": {
+      "$kind": "ComplexType",
+      "BaseType": "UI.DataFieldAbstract",
+      "Properties": {
+        "Actions": "Collection(UI.DataFieldForActionAbstract)",
+        "Label": "Edm.String",
+        "Criticality": "UI.CriticalityType",
+        "CriticalityRepresentation": "UI.CriticalityRepresentationType",
+        "IconUrl": "Edm.String"
+      },
+      "$experimental": true
+    },
     "UI.DataField": {
       "$kind": "ComplexType",
       "BaseType": "UI.DataFieldAbstract",
@@ -3645,6 +3681,19 @@
         "IconUrl": "Edm.String"
       }
     },
+    "UI.DataFieldWithActionGroup": {
+      "$kind": "ComplexType",
+      "BaseType": "UI.DataField",
+      "Properties": {
+        "Actions": "Collection(UI.DataField)",
+        "Value": "Edm.PrimitiveType",
+        "Label": "Edm.String",
+        "Criticality": "UI.CriticalityType",
+        "CriticalityRepresentation": "UI.CriticalityRepresentationType",
+        "IconUrl": "Edm.String"
+      },
+      "$experimental": true
+    },
     "UI.RecommendationListType": {
       "$kind": "ComplexType",
       "Properties": {

package/lib/gen/language.checksum

@@ -1 +1 @@
-cde5224056abde61cc2eb0b1b30bf694
+78ff41e0af1a8064856dea9850968eb6