feat(map): Extend Type support

packages/concerto-core/api.txt

@@ -174,6 +174,8 @@ class MapKeyType extends Decorated {
    + MapDeclaration getParent() 
    + string getType() 
    + String toString() 
+   + boolean isKey() 
+   + boolean isValue() 
 }
 class MapValueType extends Decorated {
    + void constructor(MapDeclaration,Object) throws IllegalModelException
@@ -182,6 +184,8 @@ class MapValueType extends Decorated {
    + MapDeclaration getParent() 
    + string getType() 
    + String toString() 
+   + boolean isKey() 
+   + boolean isValue() 
 }
    + ModelManager newMetaModelManager() 
    + object validateMetaModel() 

packages/concerto-core/changelog.txt

@@ -24,6 +24,9 @@
 # Note that the latest public API is documented using JSDocs and is available in api.txt.
 #
 
+Version 3.8.1 {794268f69b81f05f711d38a9ef1a7833} 2023-08-1
+- Add To MapKeyType, MapValue functionality
+
 Version 3.7.0 {a97cb6ebd45679354ba4da1940d2bb8d} 2023-05-19
 - Add MapDeclaration, MapKeyType, AggregateValueType
 

packages/concerto-core/lib/introspect/mapkeytype.js

@@ -129,6 +129,24 @@ class MapKeyType extends Decorated {
     toString() {
         return 'MapKeyType {id=' + this.getType() + '}';
     }
+
+    /**
+     * Returns true if this class is the definition of a Map Key.
+     *
+     * @return {boolean} true if the class is a Map Key
+     */
+    isKey() {
+        return true;
+    }
+
+    /**
+     * Returns true if this class is the definition of a Map Value.
+     *
+     * @return {boolean} true if the class is a Map Value
+     */
+    isValue() {
+        return false;
+    }
 }
 
 module.exports = MapKeyType;

packages/concerto-core/lib/introspect/mapvaluetype.js

@@ -121,6 +121,24 @@ class MapValueType extends Decorated {
         return 'MapValueType {id=' + this.getType() + '}';
     }
 
+    /**
+     * Returns true if this class is the definition of a Map Key.
+     *
+     * @return {boolean} true if the class is a Map Key
+     */
+    isKey() {
+        return false;
+    }
+
+    /**
+     * Returns true if this class is the definition of a Map Value.
+     *
+     * @return {boolean} true if the class is a Map Value
+     */
+    isValue() {
+        return true;
+    }
+
 }
 
 module.exports = MapValueType;

packages/concerto-core/lib/serializer/jsongenerator.js

@@ -85,7 +85,40 @@ class JSONGenerator {
      */
     visitMapDeclaration(mapDeclaration, parameters) {
         const obj = parameters.stack.pop();
-        return Object.fromEntries(obj);
+
+        // initialise Map with $class property
+        let map = new Map([['$class',obj.get('$class')]]);
+
+        obj.forEach((value, key) => {
+
+            if (typeof key === 'object') {
+                let decl = mapDeclaration.getModelFile()
+                    .getAllDeclarations()
+                    .find(decl => decl.name === key.getType());
+
+                // convert declaration to JSON representation
+                parameters.stack.push(key);
+                const jsonKey = decl.accept(this, parameters);
+
+                key = JSON.stringify(jsonKey);
+            }
+
+            if (typeof value === 'object') {
+                let decl = mapDeclaration.getModelFile()
+                    .getAllDeclarations()
+                    .find(decl => decl.name === value.getType());
+
+                // convert declaration to JSON representation
+                parameters.stack.push(value);
+                const jsonValue = decl.accept(this, parameters);
+
+                value = JSON.stringify(jsonValue);
+            }
+
+            map.set(key, value);
+        });
+
+        return Object.fromEntries(map);
     }
 
     /**

packages/concerto-core/lib/serializer/jsonpopulator.js

@@ -170,13 +170,64 @@ class JSONPopulator {
      * @private
      */
     visitMapDeclaration(mapDeclaration, parameters) {
-        const jsonObj = parameters.jsonStack.pop();
+        let jsonObj = parameters.jsonStack.pop();
         parameters.path ?? (parameters.path = new TypedStack('$'));
 
-        // throws if Map contains private reserved properties as keys.
+        // Throws if Map contains reserved properties - a Map containing reserved Properties should not be serialized.
         getAssignableProperties(jsonObj, mapDeclaration);
 
-        return new Map(Object.entries(jsonObj));
+        jsonObj = new Map(Object.entries(jsonObj));
+
+        let map = new Map();
+
+        jsonObj.forEach((value, key) => {
+
+            if (key === '$class') {
+                map.set(key, value);
+                return;
+            }
+
+            // If its a Non-Primitive, its likely a ClassDeclaration which needs visiting.
+            if (!ModelUtil.isSystemProperty(key) && !ModelUtil.isPrimitiveType(mapDeclaration.getKey().getType())) {
+                // get the Key declaration.
+                let decl = mapDeclaration.getModelFile()
+                    .getAllDeclarations()
+                    .find(decl => decl.name === mapDeclaration.getKey().getType());
+
+                // parse the Object, and visit the declaration.
+                if (decl?.isClassDeclaration()) {
+                    let subResource = parameters.factory.newConcept(decl.getNamespace(),
+                        decl.getName(), decl.getIdentifierFieldName() );
+
+                    parameters.jsonStack.push(JSON.parse(key));
+                    parameters.resourceStack.push(subResource);
+
+                    key = decl.accept(this, parameters);
+                }
+            }
+
+            if (!ModelUtil.isPrimitiveType(mapDeclaration.getValue().getType())) {
+                // get the Value declaration.
+                let decl = mapDeclaration.getModelFile()
+                    .getAllDeclarations()
+                    .find(decl => decl.name === mapDeclaration.getValue().getType());
+
+                // parse the Object, and visit the declaration.
+                if (decl?.isClassDeclaration() ) {
+                    let subResource = parameters.factory.newConcept(decl.getNamespace(),
+                        decl.getName(), decl.getIdentifierFieldName() );
+
+                    parameters.jsonStack.push(JSON.parse(value));
+                    parameters.resourceStack.push(subResource);
+
+                    value = decl.accept(this, parameters);
+                }
+            }
+
+            map.set(key, value);
+        });
+
+        return map;
     }
 
     /**

packages/concerto-core/lib/serializer/resourcevalidator.js

@@ -22,6 +22,10 @@ const ModelUtil = require('../modelutil');
 const ValidationException = require('./validationexception');
 const Globalize = require('../globalize');
 
+const dayjs = require('dayjs');
+const utc = require('dayjs/plugin/utc');
+dayjs.extend(utc);
+
 /**
  * <p>
  * Validates a Resource or Field against the models defined in the ModelManager.
@@ -106,39 +110,99 @@ class ResourceValidator {
         return null;
     }
 
+
+    /**
+     * Check a Type that is declared as a Map Type.
+     * @param {Object} type - the type in scope for validation, can be MapTypeKey or MapTypeValue
+     * @param {Object} value - the object being validated
+     * @param {Object} parameters  - the parameter
+     * @param {Map} mapDeclaration - the object being visited
+     * @private
+     */
+    checkMapType(type, value, parameters, mapDeclaration, ) {
+
+        if (!ModelUtil.isPrimitiveType(type.getType())) {
+
+            // thing might be a Concept, Scalar String, Scalar DateTime
+            let thing = mapDeclaration.getModelFile()
+                .getAllDeclarations()
+                .find(decl => decl.name === type.getType());
+
+            // a ClassDeclaration used in the context of a Map Key must be identified.
+            if (type.isKey() && thing.isClassDeclaration() && !thing.isIdentified()) {
+                throw new Error('Map Key must be an Identified Class Declaration');
+            }
+
+            // if Key or Value is Scalar, get the Base Type of the Scalar for primitive validation.
+            if (ModelUtil.isScalar(mapDeclaration.getKey())) {
+                type = thing.getType();
+            }
+
+            if (thing.isClassDeclaration()) {
+                parameters.stack.push(value);
+                thing.accept(this, parameters);
+                return;
+            }
+        } else {
+            // otherwise its a primitive
+            type = type.getType();
+
+        }
+
+        // validate the primitive
+        switch(type) {
+        case 'String':
+            if (typeof value !== 'string') {
+                throw new Error(`Model violation in ${mapDeclaration.getFullyQualifiedName()}. Expected Type of String but found '${value}' instead.`);
+            }
+            break;
+        case 'DateTime':
+            if (!dayjs.utc(value).isValid()) {
+                throw new Error(`Model violation in ${mapDeclaration.getFullyQualifiedName()}. Expected Type of DateTime but found '${value}' instead.`);
+            }
+            break;
+        case 'Boolean':
+            if (typeof value !== 'boolean') {
+                const type = typeof value;
+                throw new Error(`Model violation in ${mapDeclaration.getFullyQualifiedName()}. Expected Type of Boolean but found ${type} instead, for value '${value}'.`);
+            }
+            break;
+        }
+    }
+
     /**
      * Visitor design pattern
      *
      * @param {MapDeclaration} mapDeclaration - the object being visited
      * @param {Object} parameters  - the parameter
+     * @return {Object} the result of visiting or null
+     *
      * @private
      */
     visitMapDeclaration(mapDeclaration, parameters) {
+
         const obj = parameters.stack.pop();
 
         if (!((obj instanceof Map))) {
             throw new Error('Expected a Map, but found ' + JSON.stringify(obj));
         }
 
-        if(!obj.has('$class')) {
+        if (!obj.has('$class')) {
             throw new Error('Invalid Map. Map must contain a properly formatted $class property');
         }
 
         if (obj.get('$class') !== mapDeclaration.getFullyQualifiedName()) {
             throw new Error(`$class value must match ${mapDeclaration.getFullyQualifiedName()}`);
         }
 
-
         obj.forEach((value, key) => {
-            if(!ModelUtil.isSystemProperty(key)) {
-                if (typeof key !== 'string') {
-                    ResourceValidator.reportInvalidMap(parameters.rootResourceIdentifier, mapDeclaration, obj);
-                }
-                if (typeof value !== 'string') {
-                    ResourceValidator.reportInvalidMap(parameters.rootResourceIdentifier, mapDeclaration, obj);
-                }
+            if (!ModelUtil.isSystemProperty(key)) {
+                this.checkMapType(mapDeclaration.getKey(), key, parameters, mapDeclaration);
+                this.checkMapType(mapDeclaration.getValue(), value, parameters, mapDeclaration);
             }
         });
+
+        return null;
     }
 
     /**
@@ -500,22 +564,6 @@ class ResourceValidator {
         }));
     }
 
-    /**
-     * Throw a new error for a model violation.
-     * @param {string} id - the identifier of this instance.
-     * @param {MapDeclaration} mapDeclaration - the declaration of the map
-     * @param {Object} value - the value of the field.
-     * @private
-     */
-    static reportInvalidMap(id, mapDeclaration, value) {
-        let formatter = Globalize.messageFormatter('resourcevalidator-invalidmap');
-        throw new ValidationException(formatter({
-            resourceId: id,
-            classFQN: mapDeclaration.getFullyQualifiedName(),
-            invalidValue: value.toString()
-        }));
-    }
-
     /**
      * Throw a new error for a model violation.
      * @param {string} id - the identifier of this instance.

packages/concerto-core/test/data/parser/mapdeclaration/mapdeclaration.goodkey.declaration.concept.cto

@@ -12,7 +12,7 @@
  * limitations under the License.
  */
 
-namespace [email protected] //todo makek sure namesapce is same for all test concepts
+namespace [email protected]
 
 concept Person identified {}