@accordproject/concerto-core 3.1.0 → 3.2.0

package/lib/introspect/stringvalidator.js

@@ -21,6 +21,7 @@ const Validator = require('./validator');
 /* istanbul ignore next */
 if (global === undefined) {
     const Field = require('./field');
+    const ScalarDeclaration = require('./scalardeclaration');
 }
 /* eslint-enable no-unused-vars */
 
@@ -34,7 +35,7 @@ class StringValidator extends Validator{
 
     /**
      * Create a StringValidator.
-     * @param {Field} field - the field this validator is attached to
+     * @param {Object} field - the field or scalar declaration this validator is attached to
      * @param {Object} validator - The validation string. This must be a regex
      *
      * @throws {IllegalModelException}

package/lib/introspect/validator.js

@@ -19,6 +19,7 @@
 /* istanbul ignore next */
 if (global === undefined) {
     const Field = require('./field');
+    const ScalarDeclaration = require('./scalardeclaration');
 }
 /* eslint-enable no-unused-vars */
 
@@ -31,10 +32,9 @@ if (global === undefined) {
  * @memberof module:concerto-core
  */
 class Validator {
-
     /**
      * Create a Property.
-     * @param {Field} field - the field this validator is attached to
+     * @param {Object} field - the field or scalar declaration this validator is attached to
      * @param {Object} validator - The validation string
      * @throws {IllegalModelException}
      */
@@ -49,7 +49,7 @@ class Validator {
      * @throws {Error} throws an error to report the message
      */
     reportError(id, msg) {
-        throw new Error( 'Validator error for field `' + id + '`. ' + this.getField().getFullyQualifiedName() + ': ' + msg );
+        throw new Error( 'Validator error for field `' + id + '`. ' + this.getFieldOrScalarDeclaration().getFullyQualifiedName() + ': ' + msg );
     }
 
     /**
@@ -64,10 +64,10 @@ class Validator {
     }
 
     /**
-     * Returns the field that this validator applies to
-     * @return {Field} the field
+     * Returns the field or scalar declaration that this validator applies to
+     * @return {Object} the field
      */
-    getField() {
+    getFieldOrScalarDeclaration() {
         return this.field;
     }
 

package/lib/model/typed.js

@@ -143,27 +143,32 @@ class Typed {
 
         for (let n = 0; n < fields.length; n++) {
             let field = fields[n];
+            if(field.isTypeScalar?.()) {
+                field = field.getScalarField();
+            }
+            let defaultValue;
+            let type;
             if (field.isField?.()) {
-                let defaultValue = field.getDefaultValue();
-
-                if (defaultValue) {
-                    if (field.getType() === 'String') {
-                        this.setPropertyValue(field.getName(), defaultValue);
-                    } else if (field.getType() === 'Integer') {
-                        this.setPropertyValue(field.getName(), parseInt(defaultValue));
-                    } else if (field.getType() === 'Long') {
-                        this.setPropertyValue(field.getName(), parseInt(defaultValue));
-                    } else if (field.getType() === 'Double') {
-                        this.setPropertyValue(field.getName(), parseFloat(defaultValue));
-                    } else if (field.getType() === 'Boolean') {
-                        this.setPropertyValue(field.getName(), (defaultValue === true));
-                    } else if (field.getType() === 'DateTime') {
-                        const dateTime = dayjs.utc(defaultValue);
-                        this.setPropertyValue(field.getName(), dateTime);
-                    } else {
-                        // following precident set in jsonpopulator.js - if we get this far the field should be an enum
-                        this.setPropertyValue(field.getName(), defaultValue);
-                    }
+                defaultValue = field.getDefaultValue();
+                type = field.getType();
+            }
+            if (defaultValue) {
+                if (type === 'String') {
+                    this.setPropertyValue(field.getName(), defaultValue);
+                } else if (type === 'Integer') {
+                    this.setPropertyValue(field.getName(), parseInt(defaultValue));
+                } else if (type === 'Long') {
+                    this.setPropertyValue(field.getName(), parseInt(defaultValue));
+                } else if (type === 'Double') {
+                    this.setPropertyValue(field.getName(), parseFloat(defaultValue));
+                } else if (type === 'Boolean') {
+                    this.setPropertyValue(field.getName(), (defaultValue === true));
+                } else if (type === 'DateTime') {
+                    const dateTime = dayjs.utc(defaultValue);
+                    this.setPropertyValue(field.getName(), dateTime);
+                } else {
+                    // following precident set in jsonpopulator.js - if we get this far the field should be an enum
+                    this.setPropertyValue(field.getName(), defaultValue);
                 }
             }
         }

package/lib/modelutil.js

@@ -172,6 +172,18 @@ class ModelUtil {
         return (typeDeclaration !== null && typeDeclaration.isEnum());
     }
 
+    /**
+     * Returns the true if the given field is a Scalar type
+     * @param {Scalar} scalar - the string
+     * @return {boolean} true if the field is declared as an scalar
+     * @private
+     */
+    static isScalar(scalar) {
+        const modelFile = scalar.getParent().getModelFile();
+        const declaration = modelFile.getType(scalar.getType());
+        return (declaration !== null && declaration.isScalarDeclaration?.());
+    }
+
     /**
      * Get the fully qualified name of a type.
      * @param {string} namespace - namespace of the type.

package/lib/serializer/instancegenerator.js

@@ -14,7 +14,6 @@
 
 'use strict';
 
-const ModelUtil = require('../modelutil');
 const Util = require('../util');
 const Globalize = require('../globalize');
 
@@ -40,6 +39,8 @@ class InstanceGenerator {
             return this.visitClassDeclaration(thing, parameters);
         } else if (thing.isRelationship?.()) {
             return this.visitRelationshipDeclaration(thing, parameters);
+        } else if (thing.isTypeScalar?.()) {
+            return this.visitField(thing.getScalarField(), parameters);
         } else if (thing.isField?.()) {
             return this.visitField(thing, parameters);
         } else {
@@ -114,32 +115,35 @@ class InstanceGenerator {
      * @return {*} A value for the specified field.
      */
     getFieldValue(field, parameters) {
+        let fieldOrScalarDeclaration = field;
+        if (field.isTypeScalar?.()){
+            fieldOrScalarDeclaration = field.getScalarField();
+        }
         let type = field.getFullyQualifiedTypeName();
-
-        if (ModelUtil.isPrimitiveType(type)) {
+        if (field.isPrimitive()) {
             switch(type) {
             case 'DateTime':
                 return parameters.valueGenerator.getDateTime();
             case 'Integer':
-                if(field.validator){
-                    return parameters.valueGenerator.getRange(field.validator.lowerBound, field.validator.upperBound, type);
+                if(fieldOrScalarDeclaration.validator){
+                    return parameters.valueGenerator.getRange(fieldOrScalarDeclaration.validator.lowerBound, fieldOrScalarDeclaration.validator.upperBound, type);
                 }
                 return parameters.valueGenerator.getInteger();
             case 'Long':
-                if(field.validator){
-                    return parameters.valueGenerator.getRange(field.validator.lowerBound, field.validator.upperBound, type);
+                if(fieldOrScalarDeclaration.validator){
+                    return parameters.valueGenerator.getRange(fieldOrScalarDeclaration.validator.lowerBound, fieldOrScalarDeclaration.validator.upperBound, type);
                 }
                 return parameters.valueGenerator.getLong();
             case 'Double':
-                if(field.validator){
-                    return parameters.valueGenerator.getRange(field.validator.lowerBound, field.validator.upperBound, type);
+                if(fieldOrScalarDeclaration.validator){
+                    return parameters.valueGenerator.getRange(fieldOrScalarDeclaration.validator.lowerBound, fieldOrScalarDeclaration.validator.upperBound, type);
                 }
                 return parameters.valueGenerator.getDouble();
             case 'Boolean':
                 return parameters.valueGenerator.getBoolean();
             default:
-                if(field.validator){
-                    return parameters.valueGenerator.getRegex(field.validator.regex);
+                if(fieldOrScalarDeclaration.validator){
+                    return parameters.valueGenerator.getRegex(fieldOrScalarDeclaration.validator.regex);
                 }
                 return parameters.valueGenerator.getString();
             }

package/lib/serializer/jsongenerator.js

@@ -66,6 +66,8 @@ class JSONGenerator {
             return this.visitClassDeclaration(thing, parameters);
         } else if (thing.isRelationship?.()) {
             return this.visitRelationshipDeclaration(thing, parameters);
+        } else if (thing.isTypeScalar?.()) {
+            return this.visitField(thing.getScalarField(), parameters);
         } else if (thing.isField?.()) {
             return this.visitField(thing, parameters);
         } else {

package/lib/serializer/jsonpopulator.js

@@ -108,6 +108,8 @@ class JSONPopulator {
             return this.visitClassDeclaration(thing, parameters);
         } else if (thing.isRelationship?.()) {
             return this.visitRelationshipDeclaration(thing, parameters);
+        } else if (thing.isTypeScalar?.()) {
+            return this.visitField(thing.getScalarField(), parameters);
         } else if (thing.isField?.()) {
             return this.visitField(thing, parameters);
         } else {
@@ -175,8 +177,7 @@ class JSONPopulator {
                 result.push(this.convertItem(field,jsonItem, parameters));
                 parameters.path.pop();
             }
-        }
-        else {
+        } else {
             result = this.convertItem(field,jsonObj, parameters);
         }
 

package/lib/serializer/objectvalidator.js

@@ -74,6 +74,8 @@ class ObjectValidator {
             return this.visitClassDeclaration(thing, parameters);
         } else if (thing.isRelationship?.()) {
             return this.visitRelationshipDeclaration(thing, parameters);
+        } else if (thing.isTypeScalar?.()) {
+            return this.visitField(thing.getScalarField(), parameters);
         } else if (thing.isField?.()) {
             return this.visitField(thing, parameters);
         }

package/lib/serializer/resourcevalidator.js

@@ -69,6 +69,8 @@ class ResourceValidator {
             return this.visitClassDeclaration(thing, parameters);
         } else if (thing.isRelationship?.()) {
             return this.visitRelationshipDeclaration(thing, parameters);
+        } else if (thing.isTypeScalar?.()) {
+            return this.visitField(thing.getScalarField(), parameters);
         } else if (thing.isField?.()) {
             return this.visitField(thing, parameters);
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@accordproject/concerto-core",
-  "version": "3.1.0",
+  "version": "3.2.0",
   "description": "Core Implementation for the Concerto Modeling Language",
   "homepage": "https://github.com/accordproject/concerto",
   "engines": {
@@ -11,18 +11,20 @@
   "browser": "dist/concerto-core.js",
   "typings": "types/index.d.ts",
   "scripts": {
-    "prepublishOnly": "webpack --config webpack.config.js --mode production",
+    "prepublishOnly": "npm run webpack",
     "pretest": "npm run lint",
     "lint": "eslint .",
     "postlint": "npm run licchk",
     "licchk": "license-check-and-add",
     "postlicchk": "npm run doc",
     "doc": "jsdoc --pedantic --recurse -c jsdoc.json",
-    "postdoc": "npm run build:types",
     "test": "node ./scripts/api-changelog.js && nyc mocha --recursive -t 10000",
     "test:watch": "nyc mocha --watch --recursive -t 10000",
     "mocha": "mocha --recursive -t 10000",
     "nyc": "nyc mocha --recursive -t 10000",
+    "build": "npm run build:types",
+    "postbuild": "npm run webpack",
+    "webpack": "webpack --config webpack.config.js --mode production",
     "build:types": "tsc index.js --declaration --allowJs --emitDeclarationOnly --outDir types"
   },
   "repository": {
@@ -68,9 +70,9 @@
     "yargs": "17.3.1"
   },
   "dependencies": {
-    "@accordproject/concerto-cto": "3.1.0",
-    "@accordproject/concerto-metamodel": "3.1.0",
-    "@accordproject/concerto-util": "3.1.0",
+    "@accordproject/concerto-cto": "3.2.0",
+    "@accordproject/concerto-metamodel": "3.2.0",
+    "@accordproject/concerto-util": "3.2.0",
     "dayjs": "1.10.8",
     "debug": "4.3.1",
     "lorem-ipsum": "2.0.3",
@@ -140,7 +142,7 @@
     "all": true,
     "check-coverage": true,
     "statements": 99,
-    "branches": 98,
+    "branches": 97,
     "functions": 98,
     "lines": 99
   }

package/types/lib/introspect/field.d.ts

@@ -10,7 +10,8 @@ export = Field;
  * @memberof module:concerto-core
  */
 declare class Field extends Property {
-    validator: NumberValidator | StringValidator;
+    scalarField: any;
+    validator: StringValidator | NumberValidator;
     defaultValue: any;
     /**
      * Returns the validator string for this field
@@ -28,8 +29,20 @@ declare class Field extends Property {
      * @return {boolean} true if the class is a field
      */
     isField(): boolean;
+    /**
+     * Returns true if the field's type is a scalar
+     * @returns {boolean} true if the field is a scalar type
+     */
+    isTypeScalar(): boolean;
+    /**
+     * Unboxes a field that references a scalar type to an
+     * underlying Field definition.
+     * @throws {Error} throws an error if this field is not a scalar type.
+     * @returns {Field} the primitive field for this scalar
+     */
+    getScalarField(): Field;
 }
 import Property = require("./property");
-import NumberValidator = require("./numbervalidator");
 import StringValidator = require("./stringvalidator");
+import NumberValidator = require("./numbervalidator");
 import Validator = require("./validator");

package/types/lib/introspect/modelfile.d.ts

@@ -211,12 +211,17 @@ declare class ModelFile extends Decorated {
      * @return {EnumDeclaration[]} the EnumDeclaration defined in the model file
      */
     getEnumDeclarations(): EnumDeclaration[];
+    /**
+     * Get the ScalarDeclaration defined in this ModelFile
+     * @return {ScalarDeclaration[]} the ScalarDeclaration defined in the model file
+     */
+    getScalarDeclarations(): ScalarDeclaration[];
     /**
      * Get the instances of a given type in this ModelFile
      * @param {Function} type - the type of the declaration
-     * @return {ClassDeclaration[]} the ClassDeclaration defined in the model file
+     * @return {Object[]} the ClassDeclaration defined in the model file
      */
-    getDeclarations(type: Function): ClassDeclaration[];
+    getDeclarations(type: Function): any[];
     /**
      * Get all declarations in this ModelFile
      * @return {ClassDeclaration[]} the ClassDeclarations defined in the model file
@@ -264,3 +269,4 @@ import EventDeclaration = require("./eventdeclaration");
 import ParticipantDeclaration = require("./participantdeclaration");
 import ConceptDeclaration = require("./conceptdeclaration");
 import EnumDeclaration = require("./enumdeclaration");
+import ScalarDeclaration = require("./scalardeclaration");

package/types/lib/introspect/scalardeclaration.d.ts

@@ -0,0 +1,162 @@
+export = ScalarDeclaration;
+/**
+ * ScalarDeclaration defines the structure (model/schema) of composite data.
+ * It is composed of a set of Properties, may have an identifying field, and may
+ * have a super-type.
+ * A ScalarDeclaration is conceptually owned by a ModelFile which
+ * defines all the classes that are part of a namespace.
+ *
+ * @abstract
+ * @class
+ * @memberof module:concerto-core
+ */
+declare class ScalarDeclaration extends Decorated {
+    /**
+     * Create a ScalarDeclaration from an Abstract Syntax Tree. The AST is the
+     * result of parsing.
+     *
+     * @param {ModelFile} modelFile - the ModelFile for this class
+     * @param {Object} ast - the AST created by the parser
+     * @throws {IllegalModelException}
+     */
+    constructor(modelFile: ModelFile, ast: any);
+    modelFile: ModelFile;
+    name: any;
+    superType: any;
+    superTypeDeclaration: any;
+    idField: any;
+    timestamped: boolean;
+    abstract: boolean;
+    validator: StringValidator | NumberValidator;
+    type: string;
+    defaultValue: any;
+    fqn: string;
+    /**
+     * Semantic validation of the structure of this class. Subclasses should
+     * override this method to impose additional semantic constraints on the
+     * contents/relations of fields.
+     *
+     * @throws {IllegalModelException}
+     * @protected
+     */
+    protected validate(): void;
+    /**
+     * Returns the short name of a class. This name does not include the
+     * namespace from the owning ModelFile.
+     *
+     * @return {string} the short name of this class
+     */
+    getName(): string;
+    /**
+     * Return the namespace of this class.
+     * @return {string} namespace - a namespace.
+     */
+    getNamespace(): string;
+    /**
+     * Returns the fully qualified name of this class.
+     * The name will include the namespace if present.
+     *
+     * @return {string} the fully-qualified name of this class
+     */
+    getFullyQualifiedName(): string;
+    /**
+     * Returns false as scalars are never identified.
+     * @returns {Boolean} false as scalars are never identified
+     */
+    isIdentified(): boolean;
+    /**
+     * Returns false as scalars are never identified.
+     * @returns {Boolean} false as scalars are never identified
+     */
+    isSystemIdentified(): boolean;
+    /**
+     * Returns null as scalars are never identified.
+     * @return {null} null, as scalars are never identified
+     */
+    getIdentifierFieldName(): null;
+    /**
+     * Returns the FQN of the super type for this class or null if this
+     * class does not have a super type.
+     *
+     * @return {string} the FQN name of the super type or null
+     */
+    getType(): string;
+    /**
+     * Throws an error as scalars do not have supertypes.
+     */
+    getSuperType(): void;
+    /**
+     * Get the super type class declaration for this class.
+     * @return {ScalarDeclaration | null} the super type declaration, or null if there is no super type.
+     */
+    getSuperTypeDeclaration(): ScalarDeclaration | null;
+    /**
+     * Returns the validator string for this scalar definition
+     * @return {Validator} the validator for the field or null
+     */
+    getValidator(): Validator;
+    /**
+       * Returns the default value for the field or null
+       * @return {string | number | null} the default value for the field or null
+       */
+    getDefaultValue(): string | number | null;
+    /**
+     * Returns true if this class is abstract.
+     *
+     * @return {boolean} true if the class is abstract
+     */
+    isAbstract(): boolean;
+    /**
+     * Returns true if this class is the definition of an asset.
+     *
+     * @return {boolean} true if the class is an asset
+     */
+    isAsset(): boolean;
+    /**
+     * Returns true if this class is the definition of a participant.
+     *
+     * @return {boolean} true if the class is a participant
+     */
+    isParticipant(): boolean;
+    /**
+     * Returns true if this class is the definition of a transaction.
+     *
+     * @return {boolean} true if the class is a transaction
+     */
+    isTransaction(): boolean;
+    /**
+     * Returns true if this class is the definition of an event.
+     *
+     * @return {boolean} true if the class is an event
+     */
+    isEvent(): boolean;
+    /**
+     * Returns true if this class is the definition of a concept.
+     *
+     * @return {boolean} true if the class is a concept
+     */
+    isConcept(): boolean;
+    /**
+     * Returns true if this class is the definition of an enum.
+     *
+     * @return {boolean} true if the class is an enum
+     */
+    isEnum(): boolean;
+    /**
+     * Returns true if this class is the definition of a class declaration.
+     *
+     * @return {boolean} true if the class is a class
+     */
+    isClassDeclaration(): boolean;
+    /**
+     * Returns true if this class is the definition of a scalar declaration.
+     *
+     * @return {boolean} true if the class is a scalar
+     */
+    isScalarDeclaration(): boolean;
+}
+import Decorated = require("./decorated");
+import ModelFile = require("./modelfile");
+import StringValidator = require("./stringvalidator");
+import NumberValidator = require("./numbervalidator");
+import Validator = require("./validator");

package/types/lib/introspect/validator.d.ts

@@ -10,13 +10,13 @@ export = Validator;
 declare class Validator {
     /**
      * Create a Property.
-     * @param {Field} field - the field this validator is attached to
+     * @param {Object} field - the field or scalar declaration this validator is attached to
      * @param {Object} validator - The validation string
      * @throws {IllegalModelException}
      */
-    constructor(field: Field, validator: any);
+    constructor(field: any, validator: any);
     validator: any;
-    field: Field;
+    field: any;
     /**
      * @param {string} id the identifier of the instance
      * @param {string} msg the exception message
@@ -32,10 +32,10 @@ declare class Validator {
      */
     private accept;
     /**
-     * Returns the field that this validator applies to
-     * @return {Field} the field
+     * Returns the field or scalar declaration that this validator applies to
+     * @return {Object} the field
      */
-    getField(): Field;
+    getFieldOrScalarDeclaration(): any;
     /**
      * Validate the property against a value
      * @param {string} identifier the identifier of the instance being validated
@@ -54,4 +54,3 @@ declare class Validator {
      */
     compatibleWith(other: Validator): boolean;
 }
-import Field = require("./field");

package/types/lib/modelutil.d.ts

@@ -91,6 +91,13 @@ declare class ModelUtil {
      * @private
      */
     private static isEnum;
+    /**
+     * Returns the true if the given field is a Scalar type
+     * @param {Scalar} scalar - the string
+     * @return {boolean} true if the field is declared as an scalar
+     * @private
+     */
+    private static isScalar;
     /**
      * Get the fully qualified name of a type.
      * @param {string} namespace - namespace of the type.