@sap/cds-compiler 2.12.0 → 2.15.2

package/lib/edm/edm.js

@@ -1,23 +1,91 @@
-// @ts-nocheck
-
 'use strict'
 
 const edmUtils = require('./edmUtils.js');
 const { isBuiltinType } = require('../model/csnUtils.js');
-
-module.exports = function (options, error) {
+const { forEach } = require("../utils/objectUtils");
+
+// facet definitions, optional could either be true or array of edm types
+// remove indicates wether or not the canonic facet shall be removed when applying @odata.Type
+const EdmTypeFacetMap = {
+  'MaxLength': { v2: true, v4: true, remove: true, optional: true },
+  'Precision': { v2: true, v4: true, remove: true, optional: true },
+  'Scale': { v2: true, v4: true, remove: true, optional: true },
+  'SRID': { v4: true, remove: true, optional: true },
+  //'FixedLength': { v2: true },
+  //'Collation': { v2: true },
+  //'Unicode': { v2: true, v4: true },
+};
+const EdmTypeFacetNames = Object.keys(EdmTypeFacetMap);
+
+// Merged primitive type map with descriptions taken from V4 spec and filled up with V2 spec
+const EdmPrimitiveTypeMap = {
+  'Edm.Binary': { v2: true, v4: true, MaxLength: true, FixedLength: true, desc: 'Binary data' },
+  'Edm.Boolean': { v2: true, v4: true, desc: 'Binary-valued logic' },
+  'Edm.Byte': { v2: true, v4: true, desc: 'Unsigned 8-bit integer' },
+  'Edm.Date': { v4: true, desc: 'Date without a time-zone offset' },
+  'Edm.DateTime': { v2: true, Precision: true, desc: 'Date and time with values ranging from 12:00:00 midnight, January 1, 1753 A.D. through 11:59:59 P.M, December 31, 9999 A.D.' },
+  'Edm.DateTimeOffset': { v2: true, v4: true, Precision: true, desc: 'Date and time with a time-zone offset, no leap seconds' },
+  'Edm.Decimal': { v2: true, v4: true, Precision: true, Scale: true, desc: 'Numeric values with decimal representation' },
+  'Edm.Double': { v2: true, v4: true, desc: 'IEEE 754 binary64 floating-point number (15-17 decimal digits)' },
+  'Edm.Duration': { v4: true, Precision: true, desc: 'Signed duration in days, hours, minutes, and (sub)seconds' },
+  'Edm.Guid': { v2: true, v4: true, desc: '16-byte (128-bit) unique identifier' },
+  'Edm.Int16': { v2: true, v4: true, desc: 'Signed 16-bit integer' },
+  'Edm.Int32': { v2: true, v4: true, desc: 'Signed 32-bit integer' },
+  'Edm.Int64': { v2: true, v4: true, desc: 'Signed 64-bit integer' },
+  'Edm.SByte': { v2: true, v4: true, desc: 'Signed 8-bit integer' },
+  'Edm.Single': { v2: true, v4: true, desc: 'IEEE 754 binary32 floating-point number (6-9 decimal digits)' },
+  'Edm.Stream': { v4: true, MaxLength: true, desc: 'Binary data stream' },
+  'Edm.String': { v2: true, v4: true, MaxLength: true, FixedLength: true, Collation: true, Unicode: true, desc: 'Sequence of characters' },
+  'Edm.Time': { v2: true, Precision: true, desc: 'time of day with values ranging from 0:00:00.x to 23:59:59.y, where x and y depend upon the precision' },
+  'Edm.TimeOfDay': { v4: true, Precision: true, desc: 'Clock time 00:00-23:59:59.999999999999' },
+  'Edm.Geography': { v4: true, SRID: true, desc: 'Abstract base type for all Geography types' },
+  'Edm.GeographyPoint': { v4: true, SRID: true, desc: 'A point in a round-earth coordinate system' },
+  'Edm.GeographyLineString': { v4: true, SRID: true, desc: 'Line string in a round-earth coordinate system' },
+  'Edm.GeographyPolygon': { v4: true, SRID: true, desc: 'Polygon in a round-earth coordinate system' },
+  'Edm.GeographyMultiPoint': { v4: true, SRID: true, desc: 'Collection of points in a round-earth coordinate system' },
+  'Edm.GeographyMultiLineString': { v4: true, SRID: true, desc: 'Collection of line strings in a round-earth coordinate system' },
+  'Edm.GeographyMultiPolygon': { v4: true, SRID: true, desc: 'Collection of polygons in a round-earth coordinate system' },
+  'Edm.GeographyCollection': { v4: true, SRID: true, desc: 'Collection of arbitrary Geography values' },
+  'Edm.Geometry': { v4: true, SRID: true, desc: 'Abstract base type for all Geometry types' },
+  'Edm.GeometryPoint': { v4: true, SRID: true, desc: 'Point in a flat-earth coordinate system' },
+  'Edm.GeometryLineString': { v4: true, SRID: true, desc: 'Line string in a flat-earth coordinate system' },
+  'Edm.GeometryPolygon': { v4: true, SRID: true, descr: 'Polygon in a flat-earth coordinate system' },
+  'Edm.GeometryMultiPoint': { v4: true, SRID: true, desc: 'Collection of points in a flat-earth coordinate system' },
+  'Edm.GeometryMultiLineString': { v4: true, SRID: true, desc: 'Collection of line strings in a flat-earth coordinate system' },
+  'Edm.GeometryMultiPolygon': { v4: true, SRID: true, desc: 'Collection of polygons in a flat-earth coordinate system' },
+  'Edm.GeometryCollection': { v4: true, SRID: true, desc: 'Collection of arbitrary Geometry values' },
+  //'Edm.PrimitiveType': { v4: true, desc: 'Abstract meta type' },
+  //'Edm.Untyped': { v4: true, desc: 'Abstract void type' },
+};
+
+function getEdm(options, messageFunctions) {
+  const { error } = messageFunctions || { error: ()=>true, warning: ()=>true };
   class Node
   {
-    constructor(v, attributes=Object.create(null), csn=undefined)
+    /**
+     * @param {boolean[]} v Versions in the form of [<v2>, <v4>].
+     * @param {object} attributes
+     * @param {CSN.Model} csn
+     */
+    constructor(v, attributes = Object.create(null), csn=undefined)
     {
       if(!attributes || typeof attributes !== 'object')
         error(null, 'Please debug me: attributes must be a dictionary');
       if(!Array.isArray(v))
         error(null, 'Please debug me: v is either undefined or not an array: ' + v);
-      if(v.filter(v=>v).length != 1)
+      if(v.filter(v => v).length !== 1)
         error(null, 'Please debug me: exactly one version must be set');
-      Object.assign(this, attributes);
-      this.set({ _children: [], _xmlOnlyAttributes: Object.create(null), _jsonOnlyAttributes: Object.create(null), _v: v, _ignoreChildren: false });
+
+      // Common attributes of JSON and XML.
+      // Note: Can't assign attributes directly, due to the input object being modified.
+      //       The caller re-uses the object for other nodes.
+      this._edmAttributes = Object.assign(Object.create(null), attributes);
+      this._xmlOnlyAttributes = Object.create(null);
+      this._jsonOnlyAttributes = Object.create(null);
+
+      this._children = [];
+      this._ignoreChildren = false;
+      this._v = v;
 
       if(this.v2)
         this.setSapVocabularyAsAttributes(csn);
@@ -30,44 +98,53 @@ module.exports = function (options, error) {
       return this.constructor.name
     }
 
-    // set's additional properties that are invisible for the iterators
-    set(attributes)
-    {
-      if(!attributes || typeof attributes !== 'object')
-        error(null, 'Please debug me: attributes must be a dictionary');
-      let newAttributes = Object.create(null);
-      edmUtils.forAll(attributes, (value, p) => {
-        newAttributes[p] = {
-          value,
-          configurable: true,
-          enumerable: false,
-          writable: true
-        }
-      });
-      return Object.defineProperties(this, newAttributes)
+    /**
+     * Set the EDM(X) attribute on the Node.
+     * @param {string} key
+     * @param {any} value
+     */
+    setEdmAttribute(key, value) {
+      if(key !== undefined && key !== null && value !== undefined && value !== null)
+        this._edmAttributes[key] = value;
+    }
+
+    /**
+     * Remove the EDM(X) attribute on the Node.
+     * @param {string} name
+     */
+    removeEdmAttribute(name) {
+      if (name in this._edmAttributes)
+        delete this._edmAttributes[name];
     }
 
-    // set properties that should only appear in the XML representation
+    /**
+     * Set properties that should only appear in the XML representation
+     * @param {object} attributes
+     * @return {any}
+     */
     setXml(attributes)
     {
-      if(!attributes || typeof attributes !== 'object')
-        error(null, 'Please debug me: attributes must be a dictionary');
       return Object.assign(this._xmlOnlyAttributes, attributes);
     }
 
-    // set properties that should only appear in the JSON representation
-    // today JSON attributes are not rendered in toJSONattributes()
+    /**
+     * Set properties that should only appear in the JSON representation.
+     * Today JSON attributes are not rendered in toJSONattributes()
+     *
+     * @param {object} attributes
+     * @return {any}
+     */
     setJSON(attributes)
     {
-      if(!attributes || typeof attributes !== 'object')
-        error(null, 'Please debug me: attributes must be a dictionary');
       return Object.assign(this._jsonOnlyAttributes, attributes);
     }
 
     prepend(...children)
     {
       this._children.splice(0, 0, ...children.filter(c => c));
+      return this;
     }
+
     append(...children)
     {
       // remove undefined entries
@@ -78,9 +155,9 @@ module.exports = function (options, error) {
     // virtual
     toJSON()
     {
-      let json = Object.create(null);
+      const json = Object.create(null);
       // $kind Property MAY be omitted in JSON for performance reasons
-      if(![ 'Property', 'EntitySet', 'ActionImport', 'FunctionImport', 'Singleton', 'Schema' ].includes(this.kind))
+      if(!(this.kind in Node.noJsonKinds))
         json['$Kind'] = this.kind;
 
       this.toJSONattributes(json);
@@ -91,7 +168,7 @@ module.exports = function (options, error) {
     // virtual
     toJSONattributes(json)
     {
-      edmUtils.forAll(this, (v,p) => {
+      forEach(this._edmAttributes, (p, v) => {
         if (p !== 'Name')
           json[p[0] === '@' ? p : '$' + p] = v;
       });
@@ -101,9 +178,9 @@ module.exports = function (options, error) {
     // virtual
     toJSONchildren(json)
     {
-      // any child with a Name should be added by it's name into the JSON object
+      // any child with a Name should be added by its name into the JSON object
       // all others must overload toJSONchildren()
-      this._children.filter(c => c.Name).forEach(c => json[c.Name] = c.toJSON());
+      this._children.filter(c => c._edmAttributes.Name).forEach(c => json[c._edmAttributes.Name] = c.toJSON());
     }
 
     // virtual
@@ -112,9 +189,9 @@ module.exports = function (options, error) {
       let kind = this.kind;
       let head = indent + '<' + kind;
 
-      if(kind=='Parameter' && this.Collection) {
-        delete this.Collection;
-        this.Type=`Collection(${this.Type})`;
+      if(kind==='Parameter' && this._edmAttributes.Collection) {
+        delete this._edmAttributes.Collection;
+        this._edmAttributes.Type=`Collection(${this._edmAttributes.Type})`;
       }
 
       head += this.toXMLattributes();
@@ -135,13 +212,13 @@ module.exports = function (options, error) {
     toXMLattributes()
     {
       let tmpStr = '';
-      edmUtils.forAll(this, (v, p) => {
-        if (typeof this[p] !== 'object')
-          tmpStr += ' ' + p + '="' + edmUtils.escapeString(v) + '"'
+      forEach(this._edmAttributes, (p, v) => {
+        if (v !== undefined && typeof v !== 'object')
+          tmpStr += ' ' + p + '="' + edmUtils.escapeStringForAttributeValue(v) + '"'
       });
-      edmUtils.forAll(this._xmlOnlyAttributes, (v,p) => {
-        if (typeof v !== 'object')
-          tmpStr += ' ' + p + '="' + edmUtils.escapeString(v) + '"'
+      forEach(this._xmlOnlyAttributes, (p, v) => {
+        if (v !== undefined && typeof v !== 'object')
+          tmpStr += ' ' + p + '="' + edmUtils.escapeStringForAttributeValue(v) + '"'
       });
       return tmpStr;
     }
@@ -170,13 +247,16 @@ module.exports = function (options, error) {
     }
   }
 
+  // $kind Property MAY be omitted in JSON for performance reasons
+  Node.noJsonKinds = {'Property':1, 'EntitySet':1, 'ActionImport':1, 'FunctionImport':1, 'Singleton':1, 'Schema':1};
+
   class Reference extends Node
   {
     constructor(v, details)
     {
       super(v, details);
       if(this.v2)
-        this['xmlns:edmx'] = 'http://docs.oasis-open.org/odata/ns/edmx';
+        this._edmAttributes['xmlns:edmx'] = 'http://docs.oasis-open.org/odata/ns/edmx';
     }
 
     get kind() { return 'edmx:Reference' }
@@ -207,12 +287,12 @@ module.exports = function (options, error) {
   {
     constructor(v, ns, alias=undefined, serviceCsn=null, annotations=[], withEntityContainer=true)
     {
-      let props = Object.create(null);
-      props.Namespace = ns;
-      if(alias != undefined)
+      const props = { Namespace: ns };
+      if(alias !== undefined)
         props.Alias = alias;
       super(v, props);
-      this.set( { _annotations: annotations, _actions: Object.create(null) } );
+      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' } );
 
       if(this.v2 && serviceCsn)
@@ -227,17 +307,17 @@ module.exports = function (options, error) {
         // append for rendering, ok ec has Name
         this.append(ec);
         // set as attribute for later access...
-        this.set({ _ec : ec })
+        this._ec = ec;
       }
     }
 
     // hold actions and functions in V4
     addAction(action)
     {
-      if(this._actions[action.Name])
-        this._actions[action.Name].push(action);
+      if(this._actions[action._edmAttributes.Name])
+        this._actions[action._edmAttributes.Name].push(action);
       else
-        this._actions[action.Name] = [action];
+        this._actions[action._edmAttributes.Name] = [action];
     }
 
     setAnnotations(annotations)
@@ -249,7 +329,7 @@ module.exports = function (options, error) {
     innerXML(indent, what)
     {
       let xml = '';
-      if(what=='metadata' || what=='all')
+      if(what==='metadata' || what==='all')
       {
         xml += super.innerXML(indent);
         edmUtils.forAll(this._actions, actionArray => {
@@ -257,11 +337,11 @@ module.exports = function (options, error) {
             xml += action.toXML(indent, what) + '\n'; });
         });
       }
-      if(what=='annotations' || what=='all')
+      if(what==='annotations' || what==='all')
       {
         if(this._annotations.length > 0) {
-          this._annotations.filter(a => a.Term).forEach(a => xml += a.toXML(indent) + '\n');
-          this._annotations.filter(a => a.Target).forEach(a => xml += a.toXML(indent) + '\n');
+          this._annotations.filter(a => a._edmAttributes.Term).forEach(a => xml += a.toXML(indent) + '\n');
+          this._annotations.filter(a => a._edmAttributes.Target).forEach(a => xml += a.toXML(indent) + '\n');
         }
       }
       return xml;
@@ -270,7 +350,7 @@ module.exports = function (options, error) {
     // no $Namespace
     toJSONattributes(json)
     {
-      edmUtils.forAll(this, (v,p) => {
+      edmUtils.forAll(this._edmAttributes, (v,p) => {
         if (p !== 'Name' && p !== 'Namespace')
           json[p[0] === '@' ? p : '$' + p] = v;
       });
@@ -281,13 +361,13 @@ module.exports = function (options, error) {
       // 'edmx:DataServices' should not appear in JSON
       super.toJSONchildren(json);
       if(this._annotations.length > 0) {
-        this._annotations.filter(a => a.Term).forEach(a => {
+        this._annotations.filter(a => a._edmAttributes.Term).forEach(a => {
           Object.entries(a.toJSON()).forEach(([n, v]) => {
             json[n] = v;
           });
         });
         let json_Annotations = Object.create(null);
-        this._annotations.filter(a => a.Target).forEach(a => json_Annotations[a.Target] = a.toJSON());
+        this._annotations.filter(a => a._edmAttributes.Target).forEach(a => json_Annotations[a._edmAttributes.Target] = a.toJSON());
         if(Object.keys(json_Annotations).length)
           json['$Annotations'] = json_Annotations;
       }
@@ -308,7 +388,7 @@ module.exports = function (options, error) {
     constructor(v)
     {
       super(v);
-      this.set( { _schemas: Object.create(null) } );
+      this._schemas = Object.create(null);
 
       if(this.v2)
         this.setXml( { 'm:DataServiceVersion': '2.0' } )
@@ -327,7 +407,7 @@ module.exports = function (options, error) {
     toJSONchildren(json)
     {
       // 'edmx:DataServices' should not appear in JSON
-      this._children.forEach(s => json[s.Namespace] = s.toJSON());
+      this._children.forEach(s => json[s._edmAttributes.Namespace] = s.toJSON());
       return json;
     }
   }
@@ -347,12 +427,15 @@ module.exports = function (options, error) {
     constructor(v, service)
     {
       super(v, { Version : (v[1]) ? '4.0' : '1.0' });
-      this.set( { _service: service, _defaultRefs: [] } );
+      this._service = service;
+      this._defaultRefs = [];
 
-      let xmlProps = Object.create(null);
+      const xmlProps = Object.create(null);
       if(this.v4)
       {
-        xmlProps['xmlns:edmx']   = 'http://docs.oasis-open.org/odata/ns/edmx';
+        xmlProps['xmlns:edmx'] = 'http://docs.oasis-open.org/odata/ns/edmx';
+        xmlProps['xmlns:m']    =  undefined;
+        xmlProps['xmlns:sap']  =  undefined;
       }
       else
       {
@@ -365,19 +448,6 @@ module.exports = function (options, error) {
 
     get kind() { return 'edmx:Edmx' }
 
-    hasAnnotations()
-    {
-      let rc = false;
-      this._service._children.forEach(c =>
-        { if(c._annotations.length > 0) rc = true; } )
-      return rc;
-    }
-
-    getSchemaCount()
-    {
-      return this._service._children.length;
-    }
-
     getAnnotations(schemaIndex=0)
     {
       if(this._service && this._service._children[schemaIndex])
@@ -397,12 +467,12 @@ module.exports = function (options, error) {
       let schema = this._service._children[0];
 
       let json = Object.create(null);
-      json['$Version'] = this.Version;
-      json['$EntityContainer'] = schema.Namespace + '.' + schema._ec.Name;
+      json['$Version'] = this._edmAttributes.Version;
+      json['$EntityContainer'] = schema._edmAttributes.Namespace + '.' + schema._ec._edmAttributes.Name;
 
       let reference_json = Object.create(null);
-      this._defaultRefs.forEach(r => reference_json[r.Uri] = r.toJSON());
-      this._children.forEach(r => reference_json[r.Uri] = r.toJSON());
+      this._defaultRefs.forEach(r => reference_json[r._edmAttributes.Uri] = r.toJSON());
+      this._children.forEach(r => reference_json[r._edmAttributes.Uri] = r.toJSON());
 
       if(Object.keys(reference_json).length)
         json['$Reference'] = reference_json;
@@ -415,9 +485,7 @@ module.exports = function (options, error) {
     // all(default), metadata, annotations
     toXML(what='all')
     {
-      let rc = '<?xml version="1.0" encoding="utf-8"?>\n';
-      rc += `${super.toXML('', what)}`;
-      return rc;
+      return '<?xml version="1.0" encoding="utf-8"?>\n' + super.toXML('', what);
     }
 
     innerXML(indent, what)
@@ -434,33 +502,32 @@ module.exports = function (options, error) {
 
   class EntityContainer extends Node
   {
-    constructor() {
-      super(...arguments);
-      this.set( { _registry: Object.create(null) } );
+    constructor(v, attributes, csn) {
+      super(v, attributes, csn);
+      this._registry = Object.create(null);
     }
     // use the _SetAttributes
     setSapVocabularyAsAttributes(csn)
     {
       super.setSapVocabularyAsAttributes(csn, true);
     }
+
     register(entry) {
-      if(!this._registry[entry.Name])
-        this._registry[entry.Name] = [entry];
+      if(!this._registry[entry._edmAttributes.Name])
+        this._registry[entry._edmAttributes.Name] = [entry];
       else
-        this._registry[entry.Name].push(entry);
-      super.append(entry);
+        this._registry[entry._edmAttributes.Name].push(entry);
+      this.append(entry);
     }
   }
 
 
-
   class Singleton extends Node
   {
     toJSONattributes(json)
     {
-      edmUtils.forAll(this, (v,p) => {
-        if (p !== 'Name')
-        {
+      forEach(this._edmAttributes, (p, v) => {
+        if (p !== 'Name') {
           if(p === 'EntityType') // it's $Type in json
             json['$Type'] = v;
           else
@@ -473,7 +540,7 @@ module.exports = function (options, error) {
     toJSONchildren(json)
     {
       let json_navPropBinding = Object.create(null);
-      this._children.forEach(npb => json_navPropBinding[npb.Path] = npb.Target);
+      this._children.forEach(npb => json_navPropBinding[npb._edmAttributes.Path] = npb._edmAttributes.Target);
       if(Object.keys(json_navPropBinding).length > 0)
         json['$NavigationPropertyBinding'] = json_navPropBinding;
 
@@ -481,7 +548,7 @@ module.exports = function (options, error) {
     }
 
     getDuplicateMessage() {
-      return `EntityType "${this.EntityType}"`
+      return `EntityType "${this._edmAttributes.EntityType}"`
     }
   }
 
@@ -534,13 +601,13 @@ module.exports = function (options, error) {
     constructor(v, details)
     {
       super(v, details);
-      this.set( { _returnType: undefined });
+      this._returnType = undefined;
     }
 
     innerXML(indent)
     {
       let xml = super.innerXML(indent);
-      if(this._returnType != undefined)
+      if(this._returnType !== undefined)
         xml += this._returnType.toXML(indent) + '\n';
       return xml
     }
@@ -573,12 +640,12 @@ module.exports = function (options, error) {
   */
   class FunctionImport extends Node {
     getDuplicateMessage() {
-      return `Function "${this.Name}"`
+      return `Function "${this._edmAttributes.Name}"`
     }
   } //ActionFunctionBase {}
   class ActionImport extends Node {
     getDuplicateMessage() {
-      return `Action "${this.Name}"`
+      return `Action "${this._edmAttributes.Name}"`
     }
   }
 
@@ -586,75 +653,81 @@ module.exports = function (options, error) {
   {
     constructor(v, attributes, csn, typeName='Type')
     {
-      if(!(csn instanceof Object || (typeof csn === 'object' && csn !== null)))
-        error(null, 'Please debug me: csn must be an object');
-
       // ??? Is CSN still required? NavProp?
       super(v, attributes, csn);
-      this.set({ _typeName: typeName });
-
-      if(this[typeName] == undefined)
+      this._typeName = typeName;
+      this._scalarType = undefined;
+      if(this._edmAttributes[typeName] === undefined)
       {
         let typecsn = csn.type ? csn : (csn.items && csn.items.type ? csn.items : csn);
         // Complex/EntityType are derived from TypeBase
         // but have no type attribute in their CSN
         if(typecsn.type) { // this thing has a type
-          // check wether this is a scalar type (or array of scalar type) or a named type
-          let scalarType = undefined;
+          // check whether this is a scalar type (or array of scalar type) or a named type
           if(typecsn.items && typecsn.items.type &&
             isBuiltinType(typecsn.items.type)) {
-            scalarType = typecsn.items;
+            this._scalarType = typecsn.items;
           }
           else if(isBuiltinType(typecsn.type)) {
-            scalarType = typecsn;
+            this._scalarType = typecsn;
           }
-          if(scalarType) {
-            this[typeName] = csn._edmType;
+          if(this._scalarType) {
+            this._edmAttributes[typeName] = csn._edmType;
             // CDXCORE-CDXCORE-173 ignore type facets for Edm.Stream
             // cds-compiler/issues/7835: Only set length for Binary as long as it is
             // unclear how many bytes a string character represents.
             // We can't calculate an unambiguous byte stream length for DB dependent
             // multi-byte characters.
-            if(!(this[typeName] === 'Edm.Stream' &&
-               ![ /*'cds.String',*/ 'cds.Binary'].includes(scalarType.type)))
-              edmUtils.addTypeFacets(this, scalarType);
+            if(!(this._edmAttributes[typeName] === 'Edm.Stream' &&
+               !( /*scalarType.type === 'cds.String' ||*/ this._scalarType.type === 'cds.Binary')))
+              edmUtils.addTypeFacets(this, this._scalarType);
+            // CDXCORE-245:
+            // map type to @odata.Type
+            // optionally add @odata { MaxLength, Precision, Scale, SRID } but only in combination with @odata.Type
+            const odataType = csn['@odata.Type'];
+            if(odataType)
+            {
+              const td = EdmPrimitiveTypeMap[odataType];
+              // If type is known, it must be available in the current version
+              // Reason: EDMX Importer may set `@odata.Type: 'Edm.DateTime'` on imported V2 services
+              // Not filtering out this incompatible type here in case of a V4 rendering would
+              // produce an unrecoverable error.
+              if(td && (td.v2 === this.v2 || td.v4 === this.v4)) {
+                this.setEdmAttribute(typeName, odataType);
+                EdmTypeFacetNames.forEach(facet => {
+                  if(EdmTypeFacetMap[facet].remove)
+                    this.removeEdmAttribute(facet);
+                  if(td[facet] !== undefined && 
+                      (EdmTypeFacetMap[facet].v2 === this.v2 || 
+                      EdmTypeFacetMap[facet].v4 === this.v4)
+                    ) {
+                    this.setEdmAttribute(facet, csn['@odata.'+facet]);
+                  }
+                });
+              }
+            }
           }
           else {
-            this[typeName] = typecsn.type;
-          }
-          // CDXCORE-245:
-          // map type to @odata.Type
-          // optionally add @odata.MaxLength but only in combination with @odata.Type
-          // In absence of checks restrict @odata.Type to 'Edm.String' and 'Edm.Int[16,32,64]'
-          let odataType = csn['@odata.Type'];
-          if(odataType === 'Edm.String')
-          {
-            this[typeName] = odataType;
-            if(csn['@odata.MaxLength']) {
-              this['MaxLength'] = csn['@odata.MaxLength'];
-            }
-          } else if(['Edm.Int16', 'Edm.Int32', 'Edm.Int64'].includes(odataType)) {
-            this[typeName] = odataType;
+            this._edmAttributes[typeName] = typecsn.type;
           }
         }
       }
+
       // Set the collection property if this is either an element or a parameter
-      if(csn.kind === undefined) {
-        this.set({ _isCollection: csn._isCollection });
-      }
+      this._isCollection = (csn.kind === undefined) ? csn._isCollection : false;
 
-      if(options.whatsMySchemaName && this[typeName]) {
-        let schemaName = options.whatsMySchemaName(this[typeName]);
+      if(options.whatsMySchemaName && this._edmAttributes[typeName]) {
+        let schemaName = options.whatsMySchemaName(this._edmAttributes[typeName]);
         if(schemaName && schemaName !== options.serviceName) {
-          this[typeName] = this[typeName].replace(options.serviceName + '.', '');
+          this._edmAttributes[typeName] = this._edmAttributes[typeName].replace(options.serviceName + '.', '');
         }
       }
 
       // store undecorated type for JSON
-      this.set( { _type : this[typeName] });
+      this._type = this._edmAttributes[typeName];
       // decorate for XML (not for Complex/EntityType)
       if(this._isCollection)
-        this[typeName] = `Collection(${this[typeName]})`
+        this._edmAttributes[typeName] = `Collection(${this._edmAttributes[typeName]})`
     }
 
     toJSONattributes(json)
@@ -664,7 +737,7 @@ module.exports = function (options, error) {
       if(this._type !== 'Edm.String' && this._type)   // Edm.String is default)
         json['$'+this._typeName] = this._type;
 
-      edmUtils.forAll(this, (v,p) => {
+      edmUtils.forAll(this._edmAttributes, (v,p) => {
         if (p !== 'Name' && p !== this._typeName
           // remove this line if Nullable=true becomes default
           && !(p === 'Nullable' && v == false))
@@ -721,7 +794,9 @@ module.exports = function (options, error) {
       });
 
       if(csn.$edmKeyPaths && csn.$edmKeyPaths.length)
-        this.set( { _keys: new Key(v, csn.$edmKeyPaths) } );
+        this._keys = new Key(v, csn.$edmKeyPaths);
+      else
+        this._keys = undefined;
     }
 
     innerXML(indent)
@@ -788,7 +863,7 @@ module.exports = function (options, error) {
   {
     toJSONattributes(json)
     {
-      json[this.Name] = this.Value;
+      json[this._edmAttributes.Name] = this._edmAttributes.Value;
       return json;
     }
   }
@@ -798,7 +873,7 @@ module.exports = function (options, error) {
     constructor(v, attributes, csn)
     {
       super(v, attributes, csn);
-      this.set({ _csn: csn });
+      this._csn = csn;
       if(this.v2)
       {
         let typecsn = csn.items || csn;
@@ -806,7 +881,7 @@ module.exports = function (options, error) {
         // see edmUtils.mapsCdsToEdmType => add sap:display-format annotation
         // only if Edm.DateTime is the result of a cast from Edm.Date
         // but not if Edm.DateTime is the result of a regular cds type mapping
-        if(this.Type === 'Edm.DateTime'
+        if(this._edmAttributes.Type === 'Edm.DateTime'
         && (typecsn.type !== 'cds.DateTime' && typecsn.type !== 'cds.Timestamp'))
           this.setXml( { 'sap:display-format' : 'Date' } );
 
@@ -818,14 +893,14 @@ module.exports = function (options, error) {
     {
       // From the Spec: In OData 4.01 responses a collection-valued property MUST specify a value for the Nullable attribute.
       if(this._isCollection) {
-        this.Nullable = !this.isNotNullable();
+        this._edmAttributes.Nullable = !this.isNotNullable();
       }
       // Nullable=true is default, mention Nullable=false only in XML
       // Nullable=false is default for EDM JSON representation 4.01
       // When a key explicitly (!) has 'notNull = false', it stays nullable
       else if(this.isNotNullable())
       {
-        this.Nullable = false;
+        this._edmAttributes.Nullable = false;
       }
     }
 
@@ -842,7 +917,7 @@ module.exports = function (options, error) {
     {
       super.toJSONattributes(json);
       // mention all nullable elements explicitly, remove if Nullable=true becomes default
-      if(this.Nullable === undefined || this.Nullable === true)
+      if(this._edmAttributes.Nullable === undefined || this._edmAttributes.Nullable === true)
       {
         json['$Nullable'] = true;
       }
@@ -864,9 +939,6 @@ module.exports = function (options, error) {
     {
       let json = Object.create(null);
       this.toJSONattributes(json);
-      // !this._nullable if Nullable=true become default
-      if(this._nullable)
-        json['$Nullable'] = this._nullable;
       return json;
     }
   }
@@ -875,28 +947,16 @@ module.exports = function (options, error) {
   {
     constructor(v, attributes, csn)
     {
-      // the annotations in this array shall become exposed as Property attributes in
-      // the V2 metadata.xml
-      // @ts-ignore
-      Property.SAP_Annotation_Attribute_WhiteList = [
-        '@sap.hierarchy.node.for',                  //-> 	sap:hierarchy-node-for
-        '@sap.hierarchy.parent.node.for',           // -> 	sap:hierarchy-parent-node-for
-        '@sap.hierarchy.level.for',               	// -> 	sap:hierarchy-level-for
-        '@sap.hierarchy.drill.state.for',           // -> 	sap:hierarchy-drill-state-for
-        '@sap.hierarchy.node.descendant.count.for'	// -> 	sap:hierarchy-node-descendant-count-for
-      ];
-
       super(v, attributes, csn);
       // TIPHANACDS-4180
       if(this.v2)
       {
         if(csn['@odata.etag'] == true || csn['@cds.etag'] == true)
-          this.ConcurrencyMode='Fixed'
+          this._edmAttributes.ConcurrencyMode='Fixed'
 
         // translate the following @sap annos as xml attributes to the Property
-        edmUtils.forAll(csn, (v, p) => {
-          // @ts-ignore
-          if (Property.SAP_Annotation_Attribute_WhiteList.includes(p))
+        forEach(csn, (p, v) => {
+          if (p in Property.SAP_Annotation_Attributes)
             this.setXml( { ['sap:' + p.slice(5).replace(/\./g, '-')] : v });
         });
       }
@@ -906,7 +966,7 @@ module.exports = function (options, error) {
       // added a @Core.ComputedDefaultValue for complex defaults
       if (csn.default && !csn['@Core.ComputedDefaultValue']) {
 
-        let def = csn.default;
+        const def = csn.default;
         // if def has a value, it's a simple value
         let defVal = def.val;
         // if it's a simple value with signs, produce a string representation
@@ -927,9 +987,7 @@ module.exports = function (options, error) {
             Additionally: The attribute is named 'Default' in V2 and 'DefaultValue' in V4
           */
           if(this.v4)
-            this[`Default${this.v4 ? 'Value' : ''}`] = ['cds.Boolean', 'cds.Binary', 'cds.LargeBinary', 'cds.Integer64', 'cds.Integer'].includes(csn.type)
-          ? defVal
-          : edmUtils.escapeString(defVal);
+            this._edmAttributes[`Default${this.v4 ? 'Value' : ''}`] = defVal;
         }
       }
     }
@@ -938,6 +996,17 @@ module.exports = function (options, error) {
     // static get isProperty() { return true }
   }
 
+  // the annotations in this array shall become exposed as Property attributes in
+  // the V2 metadata.xml
+  Property.SAP_Annotation_Attributes = {
+    '@sap.hierarchy.node.for':1,                  // ->   sap:hierarchy-node-for
+    '@sap.hierarchy.parent.node.for':1,           // ->   sap:hierarchy-parent-node-for
+    '@sap.hierarchy.level.for':1,                 // ->   sap:hierarchy-level-for
+    '@sap.hierarchy.drill.state.for':1,           // ->   sap:hierarchy-drill-state-for
+    '@sap.hierarchy.node.descendant.count.for':1, // ->   sap:hierarchy-node-descendant-count-for
+    '@sap.parameter':1
+  };
+
   class PropertyRef extends Node
   {
     constructor(v, Name, Alias) {
@@ -945,7 +1014,7 @@ module.exports = function (options, error) {
     }
 
     toJSON() {
-      return this.Alias ? { [this.Alias]:this.Name } : this.Name;
+      return this._edmAttributes.Alias ? { [this._edmAttributes.Alias]:this._edmAttributes.Name } : this._edmAttributes.Name;
     }
   }
 
@@ -956,12 +1025,12 @@ module.exports = function (options, error) {
       super(v, attributes, csn);
 
       if(mode != null)
-        this.Mode = mode;
+        this._edmAttributes.Mode = mode;
 
       // V2 XML: Parameters that are not explicitly marked as Nullable or NotNullable in the CSN must become Nullable=true
       // V2 XML Spec does only mention default Nullable=true for Properties not for Parameters so omitting Nullable=true let
       // the client assume that Nullable is false.... Correct Nullable Handling is done inside Parameter constructor
-      if(this.v2 && this.Nullable === undefined)
+      if(this.v2 && this._edmAttributes.Nullable === undefined)
         this.setXml({Nullable: true});
     }
 
@@ -969,7 +1038,7 @@ module.exports = function (options, error) {
     {
       // we need Name but NO $kind, can't use standard to JSON()
       let json = Object.create(null);
-      json['$Name'] = this.Name;
+      json['$Name'] = this._edmAttributes.Name;
       return this.toJSONattributes(json);
     }
   }
@@ -985,28 +1054,34 @@ module.exports = function (options, error) {
       let [src, tgt] = edmUtils.determineMultiplicity(csn._constraints._partnerCsn || csn);
       csn._constraints._multiplicity = csn._constraints._partnerCsn ? [tgt, src] : [src, tgt];
 
-      this.set( {
-        _type: attributes.Type,
-        _isCollection: this.isToMany(),
-        _targetCsn: csn._target
-      } );
+      this._type = attributes.Type;
+      this._isCollection = this.isToMany();
+      this._targetCsn = csn._target;
 
       if (this.v4)
       {
+        if(options.isStructFormat && this._csn.key)
+          this._edmAttributes.Nullable = false;
+
         // either csn has multiplicity or we have to use the multiplicity of the backlink
         if(this._isCollection) {
-          this.Type = `Collection(${attributes.Type})`
+          this._edmAttributes.Type = `Collection(${attributes.Type})`
           // attribute Nullable is not allowed in combination with Collection (see Spec)
           // Even if min cardinality is > 0, remove Nullable, because the implicit OData contract
           // is that a navigation property must either return an empty collection or all collection
           // values are !null (with other words: a collection must never return [1,2,null,3])
-          delete this.Nullable;
+          delete this._edmAttributes.Nullable;
         }
         // we have exactly one selfReference or the default partner
-        let partner = (!csn.$noPartner && csn._selfReferences.length === 1) ? csn._selfReferences[0] : csn._constraints._partnerCsn;
+        let partner = 
+          !csn.$noPartner ? 
+            csn._selfReferences.length === 1
+              ? csn._selfReferences[0]
+              : csn._constraints._partnerCsn
+            : undefined;
         if(partner && partner['@odata.navigable'] !== false) {
           // $abspath[0] is main entity
-          this.Partner = partner.$abspath.slice(1).join(options.pathDelimiter);
+          this._edmAttributes.Partner = partner.$abspath.slice(1).join(options.pathDelimiter);
         }
 
         /*
@@ -1019,9 +1094,9 @@ module.exports = function (options, error) {
           2) ContainsTarget stems from the @odata.contained annotation
         */
         if(csn['@odata.contained'] == true || csn.containsTarget) {
-          this.ContainsTarget = true;
+          this._edmAttributes.ContainsTarget = true;
         }
-        if(this.ContainsTarget === undefined && csn.type === 'cds.Composition') {
+        if(this._edmAttributes.ContainsTarget === undefined && csn.type === 'cds.Composition') {
           // Delete is redundant in containment
           // TODO: to be specified via @sap.on.delete
           this.append(new OnDelete(v, { Action: 'Cascade' } ) );
@@ -1032,7 +1107,7 @@ module.exports = function (options, error) {
       if (this.v2 && this.isNotNullable()) {
           // in V2 not null must be expressed with target cardinality of 1 or more,
           // store Nullable=false and evaluate in determineMultiplicity()
-        delete this.Nullable;
+        delete this._edmAttributes.Nullable;
       }
 
       // store NavProp reference in the model for bidirectional $Partner tagging (done in getReferentialConstraints())
@@ -1076,10 +1151,10 @@ module.exports = function (options, error) {
         switch(c.kind) {
           case 'ReferentialConstraint':
             // collect ref constraints in dictionary
-            json_constraints[c.Property] = c.ReferencedProperty;
+            json_constraints[c._edmAttributes.Property] = c._edmAttributes.ReferencedProperty;
             break;
           case 'OnDelete':
-            json['$OnDelete'] = c.Action;
+            json['$OnDelete'] = c._edmAttributes.Action;
             break;
           default:
             error(null, 'Please debug me: Unhandled NavProp child: ' + c.kind);
@@ -1110,6 +1185,12 @@ module.exports = function (options, error) {
 
   class ReferentialConstraint extends Node
   {
+    constructor(v, attributes, csn) {
+      super(v, attributes, csn);
+      this._d = null;
+      this._p = null;
+    }
+
     innerXML(indent)
     {
       if(this._d && this._p)
@@ -1141,12 +1222,12 @@ module.exports = function (options, error) {
     {
       // short form: key: value
       const inlineConstExpr =
-        [ 'Edm.Binary', 'Edm.Boolean', 'Edm.Byte', 'Edm.Date', 'Edm.DateTimeOffset',  'Edm.Decimal', 'Edm.Double', 'Edm.Duration', 'Edm.Guid',
+        [ 'Edm.Binary', 'Edm.Boolean', 'Edm.Byte', 'Edm.Date', 'Edm.DateTimeOffset', 'Edm.Decimal', 'Edm.Double', 'Edm.Duration', 'Edm.Guid',
           'Edm.Int16', 'Edm.Int32', 'Edm.Int64', 'Edm.SByte','Edm.Single', /*'Edm.Stream',*/ 'Edm.String', 'Edm.TimeOfDay',
           /* UI.xml: defines Annotations with generic type 'Edm.PrimitiveType' */
-          'Edm.PrimitiveType', 'Bool'
-          // Official JSON V4.01 Spec defines these paths as constant inline expression (OKRA requires them as explicit exprs):
-          // 'AnnotationPath', 'ModelElementPath', 'NavigationPropertyPath', 'PropertyPath',
+          'Edm.PrimitiveType', 'Bool',
+          // Official JSON V4.01 Spec defines these paths as constant inline expression:
+          'AnnotationPath', 'ModelElementPath', 'NavigationPropertyPath', 'PropertyPath',
         ];
 
       const dict = this._jsonOnlyAttributes;
@@ -1157,20 +1238,13 @@ module.exports = function (options, error) {
         switch(inline[0])
         {
           /* short notation for Edm.Boolean, Edm.String and Edm.Float, see internal project:
-              edmx2csn-npm/edm-converters/blob/835d92a1aa6b0be25c56cef85e260c9188187429/lib/edmxV40ToJsonV40/README.md
-            */
+             edmx2csn-npm/edm-converters/blob/835d92a1aa6b0be25c56cef85e260c9188187429/lib/edmxV40ToJsonV40/README.md
+          */
           case 'Edm.Boolean':
             v = (v=='true'?true:(v=='false'?false:v));
             // eslint-no-fallthrough
-          case 'Edm.String':
-            // eslint-no-fallthrough
-          case 'Edm.Float':
-            // eslint-no-fallthrough
-            return v;
           default:
-            // OKRA requires this for JSON->XML mapping
-            // because they didn't want to lookup the type in the vocabulary
-            return { '$Cast': v, '$Type': inline[0] };
+            return v;
         }
       }
       else
@@ -1200,13 +1274,12 @@ module.exports = function (options, error) {
     constructor(v, target)
     {
       super(v, { Target: target });
-      if (this.v2)
-        this.setXml( { xmlns : 'http://docs.oasis-open.org/odata/ns/edm' } );
+      this.setXml( { xmlns : this.v2 ? 'http://docs.oasis-open.org/odata/ns/edm' : undefined } );
     }
 
     toJSONattributes(json)
     {
-      edmUtils.forAll(this, (v,p) => {
+      forEach(this._edmAttributes, (p, v) => {
         if (p !== 'Target')
           json[p[0] === '@' ? p : '$' + p] = v;
       });
@@ -1255,7 +1328,7 @@ module.exports = function (options, error) {
     }
 
     getJsonFQTermName() {
-      return '@' + this.Term + (this.Qualifier ? '#' + this.Qualifier : '');
+      return '@' + this._edmAttributes.Term + (this._edmAttributes.Qualifier ? '#' + this._edmAttributes.Qualifier : '');
     }
   }
 
@@ -1272,11 +1345,11 @@ module.exports = function (options, error) {
   {
     toJSONattributes(json)
     {
-      if(this.Type)
-        json['@type'] = this.Type;
-      let keys = Object.keys(this).filter(k => k !== 'Type');
+      if(this._edmAttributes.Type)
+        json['@type'] = this._edmAttributes.Type;
+      let keys = Object.keys(this._edmAttributes).filter(k => k !== 'Type');
       for(const key of keys)
-        json['$'+key] = this[key];
+        json['$'+key] = this._edmAttributes[key];
     }
 
     toJSONchildren(json)
@@ -1296,7 +1369,7 @@ module.exports = function (options, error) {
               json[n] = a;
             });
             // render property as const expr (or subnode)
-            json[c.Property] = c.toJSON();
+            json[c._edmAttributes.Property] = c.toJSON();
             break;
           }
           default:
@@ -1311,7 +1384,7 @@ module.exports = function (options, error) {
     constructor(v, property)
     {
       super(v);
-      this.Property = property;
+      this._edmAttributes.Property = property;
     }
 
     toJSON()
@@ -1325,7 +1398,7 @@ module.exports = function (options, error) {
       }
     }
     mergeJSONannotations() {
-      return super.mergeJSONAnnotations(this.Property);
+      return super.mergeJSONAnnotations(this._edmAttributes.Property);
     }
   }
 
@@ -1334,14 +1407,10 @@ module.exports = function (options, error) {
     constructor(v, kind, details)
     {
       super(v, details);
-      this.setKind(kind);
+      this._kind = kind;
     }
 
-    setKind(kind)
-    {
-      Object.defineProperty(this, 'kind',
-      { get: function() { return kind; }});
-    }
+    get kind() { return this._kind; }
   }
 
   class ValueThing extends Thing
@@ -1349,14 +1418,14 @@ module.exports = function (options, error) {
     constructor(v, kind, value)
     {
       super(v, kind, undefined);
-      this.set( { _value : value });
+      this._value = value;
     }
 
     toXML(indent='')
     {
       let kind = this.kind;
       let xml = indent + '<' + kind + this.toXMLattributes();
-      xml +=  (this._value !== undefined ? '>' + edmUtils.escapeString(this._value) + '</' + kind + '>' : '/>');
+      xml +=  (this._value !== undefined ? '>' + edmUtils.escapeStringForText(this._value) + '</' + kind + '>' : '/>');
       return xml;
     }
 
@@ -1411,10 +1480,11 @@ module.exports = function (options, error) {
   }
   class Cast extends AnnotationBase {
     toXMLattributes() {
+      // TODO: Why json?
       if(this._jsonOnlyAttributes['Collection'])
-        return ` Type="Collection(${this.Type})"`
+        return ` Type="Collection(${this._edmAttributes.Type})"`
       else
-        return ` Type="${this.Type}"`
+        return ` Type="${this._edmAttributes.Type}"`
     }
     toJSON() {
       const json = this.mergeJSONAnnotations();
@@ -1453,7 +1523,7 @@ module.exports = function (options, error) {
 
     toJSONattributes(json) // including Name
     {
-      edmUtils.forAll(this, (v,p) => {
+      forEach(this._edmAttributes, (p, v) => {
         json[p[0] === '@' ? p : '$' + p] = v;
       });
       return json;
@@ -1482,10 +1552,10 @@ module.exports = function (options, error) {
     constructor(v, details, navProp, fromRole, toRole, multiplicity)
     {
       super(v, details);
-      this.set( { _end: [] });
-      this._end.push(
+      this._end = [
         new End(v, { Role: fromRole[0], Type: fromRole[1], Multiplicity: multiplicity[0] } ),
-        new End(v, { Role: toRole[0], Type: toRole[1], Multiplicity: multiplicity[1] } ) );
+        new End(v, { Role: toRole[0], Type: toRole[1], Multiplicity: multiplicity[1] } )
+      ];
 
       // set Delete:Cascade on composition end
       if(navProp._csn.type === 'cds.Composition')
@@ -1516,7 +1586,7 @@ module.exports = function (options, error) {
         );
     }
     getDuplicateMessage() {
-      return `Association "${this.Association}"`
+      return `Association "${this._edmAttributes.Association}"`
     }
 }
 
@@ -1527,8 +1597,8 @@ module.exports = function (options, error) {
     function(v, from, to, c)
     {
       let node = new ReferentialConstraint(v, {});
-      node.set({ _d: new Dependent(v, { Role: from } ) });
-      node.set({ _p: new Principal(v, { Role: to } ) });
+      node._d = new Dependent(v, { Role: from } );
+      node._p = new Principal(v, { Role: to } );
 
       edmUtils.forAll(c, cv => {
         node._d.append(new PropertyRef(v, cv[0].join(options.pathDelimiter)));
@@ -1592,3 +1662,5 @@ module.exports = function (options, error) {
   }
 
 } // instance function
+
+module.exports = { EdmTypeFacetMap, EdmTypeFacetNames, EdmPrimitiveTypeMap, getEdm };